Class default

This is a generic class to provide middleware for Browse/Read/Edit/Add/Delete operations and forms. It comes with some baked-in pre-flight checks but needs to be extended to do useful work. All default actions except reads require being logged in.

Use the bakery method to create standard BREAD routes. :)

Hierarchy (View Summary)

default
- default

Indexable

[key: string]: unknown

Constructors

constructor

new default(
    req: HandlerRequest,
    res: HandlerResponse,
    next: NextFunction,
    options?: Record<string, unknown>,
): default
Parameters
- req: HandlerRequest
- res: HandlerResponse
- next: NextFunction
- Optionaloptions: Record<string, unknown>
Returns default
Overrides default.constructor
- Defined in routes/handlers/review-provider.ts:317

Properties

`Protected`action

action: string

`Protected` `Readonly`actions

actions: Record<string, BreadAction<unknown>>

`Protected`editing

editing: boolean = false

`Protected`getResourceErrorHandler

getResourceErrorHandler: (
messageKeyPrefix: string,
bodyParam: string,
) => (error: unknown) => void

`Protected` `Optional`id

id?: string

`Protected`isPreview

isPreview: boolean = false

`Protected`messageKeyPrefix

messageKeyPrefix: string

`Protected`method

method: string

`Protected` `Readonly`next

next: NextFunction

`Protected`renderPermissionError

renderPermissionError: BoundRenderFunction

`Protected`renderResourceError

renderResourceError: BoundRenderFunction

`Protected`renderSigninRequired

renderSigninRequired: BoundRenderFunction

`Protected`renderTemplate

renderTemplate: BoundTemplateRenderer

`Protected` `Readonly`req

req: ProviderRequest

`Protected` `Readonly`res

res: ProviderResponse

Methods

add_GET

add_GET(formValues?: ReviewFormValues, thing?: ThingInstance): Promise<void>
Parameters
- OptionalformValues: ReviewFormValues
- Optionalthing: ThingInstance
Returns Promise<void>
Overrides default.add_GET
- Defined in routes/handlers/review-provider.ts:371

add_POST

add_POST(thing?: ThingInstance): Promise<void>
Parameters
- Optionalthing: ThingInstance
Returns Promise<void>
Overrides default.add_POST
- Defined in routes/handlers/review-provider.ts:483

addFromTeam_GET

addFromTeam_GET(team: TeamInstance): Promise<void>
Parameters
- team: TeamInstance
Returns Promise<void>
- Defined in routes/handlers/review-provider.ts:459

addFromTeam_POST

addFromTeam_POST(_team: TeamInstance): Promise<void>
Parameters
- _team: TeamInstance
Returns Promise<void>
- Defined in routes/handlers/review-provider.ts:476

addFromThing_GET

addFromThing_GET(thing: any): Promise<void>
Parameters
- thing: any
Returns Promise<void>
- Defined in routes/handlers/review-provider.ts:446

addPreFlightCheck

addPreFlightCheck(actions: string[], check: PreFlightCheck): void
Parameters
- actions: string[]
- check: PreFlightCheck
Returns void
Inherited from default.addPreFlightCheck
- Defined in routes/handlers/abstract-bread-provider.ts:374

browse_GET

browse_GET(_data?: unknown): void | Promise<void>
Parameters
- Optional_data: unknown
Returns void | Promise<void>
Inherited from default.browse_GET
- Defined in routes/handlers/abstract-bread-provider.ts:297

delete_GET

delete_GET(review: ReviewInstance): Promise<void>
Parameters
- review: ReviewInstance
Returns Promise<void>
Overrides default.delete_GET
- Defined in routes/handlers/review-provider.ts:755

delete_POST

delete_POST(review: ReviewInstance): Promise<void>
Parameters
- review: ReviewInstance
Returns Promise<void>
Overrides default.delete_POST
- Defined in routes/handlers/review-provider.ts:775

edit_GET

edit_GET(review: ReviewInstance): Promise<void>
Parameters
- review: ReviewInstance
Returns Promise<void>
Overrides default.edit_GET
- Defined in routes/handlers/review-provider.ts:596

edit_POST

edit_POST(review: ReviewInstance): Promise<void>
Parameters
- review: ReviewInstance
Returns Promise<void>
Overrides default.edit_POST
- Defined in routes/handlers/review-provider.ts:601

`Protected`ensureMlString

ensureMlString(value: unknown): MultilingualString
Parameters
- value: unknown
Returns MultilingualString
Inherited from default.ensureMlString
- Defined in routes/handlers/abstract-bread-provider.ts:242

execute

execute(): void
Returns void
Inherited from default.execute
- Defined in routes/handlers/abstract-bread-provider.ts:254

getWebHookData

getWebHookData(
    review: ReviewInstance,
    user: User,
): {
    author: string;
    authorURL: string;
    createdOn: Date;
    html: Record<string, string>;
    reviewURL: string;
    starRating: number;
    text: Record<string, string>;
    thingLabel: Record<string, string>;
    thingURL: string;
    thingURLs: string[];
    title: Record<string, string>;
}
Parameters
- review: ReviewInstance
- user: User
Returns {
    author: string;
    authorURL: string;
    createdOn: Date;
    html: Record<string, string>;
    reviewURL: string;
    starRating: number;
    text: Record<string, string>;
    thingLabel: Record<string, string>;
    thingURL: string;
    thingURLs: string[];
    title: Record<string, string>;
}
- Defined in routes/handlers/review-provider.ts:823

`Protected`handleMissingResource

handleMissingResource(
    resourceKeyPrefix: string,
    resourceID?: string,
    message?: string,
): void
Parameters
- resourceKeyPrefix: string
- OptionalresourceID: string
- Optionalmessage: string
Returns void
Inherited from default.handleMissingResource
- Defined in routes/handlers/abstract-bread-provider.ts:211

loadData

loadData(): Promise<ReviewInstance>
Returns Promise<ReviewInstance>
Overrides default.loadData
- Defined in routes/handlers/review-provider.ts:574

loadTeam

loadTeam(): Promise<TeamInstance>
Returns Promise<TeamInstance>
- Defined in routes/handlers/review-provider.ts:591

loadThing

loadThing(): Promise<ThingInstance>
Returns Promise<ThingInstance>
- Defined in routes/handlers/review-provider.ts:584

`Protected`normalizeMlString

normalizeMlString(value: unknown): MultilingualString
Parameters
- value: unknown
Returns MultilingualString
Inherited from default.normalizeMlString
- Defined in routes/handlers/abstract-bread-provider.ts:227

read_GET

read_GET(review: ReviewInstance): void
Parameters
- review: ReviewInstance
Returns void
Overrides default.read_GET
- Defined in routes/handlers/review-provider.ts:346

`Protected`resolveMlString

resolveMlString(language: string, value: unknown): ResolveResult
Parameters
- language: string
- value: unknown
Returns ResolveResult
Inherited from default.resolveMlString
- Defined in routes/handlers/abstract-bread-provider.ts:246

resolveTeamData

resolveTeamData(formValues: ReviewFormValues): Promise<void>
Parameters
- formValues: ReviewFormValues
Returns Promise<void>
- Defined in routes/handlers/review-provider.ts:720

saveNewRevisionAndFiles

saveNewRevisionAndFiles(newRev: ReviewInstance, files: string[]): Promise<void>
Parameters
- newRev: ReviewInstance
- files: string[]
Returns Promise<void>
- Defined in routes/handlers/review-provider.ts:708

userCan

userCan(action: string, data: any): boolean
Parameters
- action: string
- data: any
Returns boolean
Inherited from default.userCan
- Defined in routes/handlers/abstract-bread-provider.ts:352

userCanDelete

userCanDelete(data: any): boolean
Parameters
- data: any
Returns boolean
Inherited from default.userCanDelete
- Defined in routes/handlers/abstract-bread-provider.ts:368

userCanEdit

userCanEdit(data: any): boolean
Parameters
- data: any
Returns boolean
Inherited from default.userCanEdit
- Defined in routes/handlers/abstract-bread-provider.ts:364

userIsSignedIn

userIsSignedIn(): boolean
Returns boolean
Inherited from default.userIsSignedIn
- Defined in routes/handlers/abstract-bread-provider.ts:333

userIsTrusted

userIsTrusted(): boolean
Returns boolean
Inherited from default.userIsTrusted
- Defined in routes/handlers/abstract-bread-provider.ts:342

`Static`bakeRoutes

bakeRoutes(
    this: typeof default,
    resource: string,
    routes?: BakeRouteMap,
): Router
Parameters
- this: typeof default
- resource: string
- Optionalroutes: BakeRouteMap
Returns Router
Inherited from default.bakeRoutes
- Defined in routes/handlers/abstract-bread-provider.ts:412

`Static`getDefaultRoutes

getDefaultRoutes(resource: string): BakeRouteMap
Parameters
- resource: string
Returns BakeRouteMap
Inherited from default.getDefaultRoutes
- Defined in routes/handlers/abstract-bread-provider.ts:380

Class default

Hierarchy (View Summary)

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Protectedaction

Protected Readonlyactions

Protectedediting

ProtectedgetResourceErrorHandler

Protected Optionalid

ProtectedisPreview

ProtectedmessageKeyPrefix

Protectedmethod

Protected Readonlynext

ProtectedrenderPermissionError

ProtectedrenderResourceError

ProtectedrenderSigninRequired

ProtectedrenderTemplate

Protected Readonlyreq

Protected Readonlyres

Methods

add_GET

Parameters

Returns Promise<void>

add_POST

Parameters

Returns Promise<void>

addFromTeam_GET

Parameters

Returns Promise<void>

addFromTeam_POST

Parameters

Returns Promise<void>

addFromThing_GET

Parameters

Returns Promise<void>

addPreFlightCheck

Parameters

Returns void

browse_GET

Parameters

Returns void | Promise<void>

delete_GET

Parameters

Returns Promise<void>

delete_POST

Parameters

Returns Promise<void>

edit_GET

Parameters

Returns Promise<void>

edit_POST

Parameters

Returns Promise<void>

ProtectedensureMlString

Parameters

Returns MultilingualString

execute

Returns void

getWebHookData

Parameters

Returns { author: string; authorURL: string; createdOn: Date; html: Record<string, string>; reviewURL: string; starRating: number; text: Record<string, string>; thingLabel: Record<string, string>; thingURL: string; thingURLs: string[]; title: Record<string, string>;}

ProtectedhandleMissingResource

Parameters

Returns void

loadData

Returns Promise<ReviewInstance>

loadTeam

Returns Promise<TeamInstance>

loadThing

Returns Promise<ThingInstance>

ProtectednormalizeMlString

Parameters

`Protected`action

`Protected` `Readonly`actions

`Protected`editing

`Protected`getResourceErrorHandler

`Protected` `Optional`id

`Protected`isPreview

`Protected`messageKeyPrefix

`Protected`method

`Protected` `Readonly`next

`Protected`renderPermissionError

`Protected`renderResourceError

`Protected`renderSigninRequired

`Protected`renderTemplate

`Protected` `Readonly`req

`Protected` `Readonly`res

`Protected`ensureMlString

Returns {
author: string;
authorURL: string;
createdOn: Date;
html: Record<string, string>;
reviewURL: string;
starRating: number;
text: Record<string, string>;
thingLabel: Record<string, string>;
thingURL: string;
thingURLs: string[];
title: Record<string, string>;
}

`Protected`handleMissingResource

`Protected`normalizeMlString

`Protected`resolveMlString

`Static`bakeRoutes

`Static`getDefaultRoutes