Class ResourceController`Abstract`

An abstract class to inherit to manage API requests (AWS API Gateway) in an AWS Lambda function.

Hierarchy (View Summary)

GenericController
- ResourceController

Index

Constructors

constructor

Constructors

constructor

new ResourceController(
event: APIGatewayProxyEventV2 | APIGatewayProxyEvent,
options?: ResourceControllerOptions,
): ResourceController
Parameters
- event: APIGatewayProxyEventV2 | APIGatewayProxyEvent
- options: ResourceControllerOptions = {}
Returns ResourceController
Overrides GenericController.constructor
- Defined in src/resourceController.ts:64

Properties

`Protected`auth0User

auth0User: Auth0User

`Protected`authorization

authorization: string

`Protected`body

body: any

`Protected`claims

claims: any

`Protected`clientBundle

clientBundle: string = null

`Protected`clientPlatform

clientPlatform: string = '?'

`Protected`clientVersion

clientVersion: string = '?'

`Protected`cognitoUser

cognitoUser: CognitoUser

`Protected`currentLang

currentLang: string

`Protected`defaultLang

defaultLang: string

`Protected`event

event: APIGatewayProxyEventV2 | APIGatewayProxyEvent

`Protected`httpMethod

httpMethod: string

`Protected` `Optional`initError

initError?: Error

`Protected`logger

logger: LambdaLogger = ...

`Protected`logRequestsWithKey

logRequestsWithKey: string

`Protected`metrics

metrics: CloudWatchMetrics

`Protected`path

path: string

`Protected`pathParameters

pathParameters: any

`Protected`principalId

principalId: string

`Protected`project

project: string = PROJECT

`Protected`queryParams

queryParams: any

`Protected`resource

resource: string = RESOURCE

`Protected`resourceId

resourceId: string

`Protected`resourcePath

resourcePath: string

`Protected`returnHeaders

returnHeaders: Record<string, string> = ...

`Protected` `Optional`returnStatusCode

returnStatusCode?: number

`Protected`stage

stage: string = STAGE

`Protected`templateMatcher

templateMatcher: RegExp = ...

`Protected`tracer

tracer: Tracer

`Protected`tracerLambdaSegment

tracerLambdaSegment: any

`Protected`tracerRCSegment

tracerRCSegment: any

`Protected`translations

translations: any

Methods

`Protected`checkAuthBeforeRequest

checkAuthBeforeRequest(): Promise<void>
To

Returns Promise<void>
- Defined in src/resourceController.ts:285

comesFromInternalRequest

comesFromInternalRequest(): boolean
Whether the current request comes from an internal API request, i.e. it was invoked by another controller.

Returns boolean
Deprecated
don't run a Lambda from another Lambda (bad practice)
- Defined in src/resourceController.ts:503

`Protected`deleteResource

deleteResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:309

`Protected`deleteResources

deleteResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:351

`Protected`done

done(
    error?: any,
    rawResult?: any,
    statusCode?: number,
    headers?: Record<string, string>,
): ResourceControllerResult
Default ending function for the Lambda.
Parameters
- Optionalerror: any
- OptionalrawResult: any
- statusCode: number = ...
- headers: Record<string, string> = ...
Returns ResourceControllerResult
Overrides GenericController.done
- Defined in src/resourceController.ts:251

`Protected`getEventSummary

getEventSummary(limitBodyArrayDisplay?: boolean): Record<string, any>
Parameters
- limitBodyArrayDisplay: boolean = false
Returns Record<string, any>
- Defined in src/resourceController.ts:141

getLambdaLogLevel

getLambdaLogLevel(): "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
Get the current log level for the current Lambda function's logger. Note: "FATAL" means that no log will be printed.

Returns "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
Inherited from GenericController.getLambdaLogLevel
- Defined in src/genericController.ts:63

`Protected`getQueryParamAsArray

getQueryParamAsArray(paramName: string): string[]
Force the parsing of a query parameter as an array of strings.
Parameters
- paramName: string
Returns string[]
- Defined in src/resourceController.ts:157

`Protected`getQueryParamAsBoolean

getQueryParamAsBoolean(paramName: string): boolean
Force the parsing of a query parameter as a boolean.
Parameters
- paramName: string
Returns boolean
- Defined in src/resourceController.ts:165

`Protected`getResource

getResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:291

`Protected`getResources

getResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:321

`Protected`handleControllerError

handleControllerError(
    err: any,
    interceptedInContext: string,
    replaceWithMessage: string,
): UnhandledError | HandledError
Remap an error to manage the logging and make sure no unhandled error is returned to the requester.
Parameters
- err: any
- interceptedInContext: string
- replaceWithMessage: string
Returns UnhandledError | HandledError
Inherited from GenericController.handleControllerError
- Defined in src/genericController.ts:46

handleRequest

handleRequest(): Promise<ResourceControllerResult>
The main function (to override), that handles the request and must terminate invoking the method done.

Returns Promise<ResourceControllerResult>
Overrides GenericController.handleRequest
- Defined in src/resourceController.ts:173

`Protected`headResource

headResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:315

`Protected`headResources

headResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:357

invokeInternalAPIRequest

invokeInternalAPIRequest(params: InternalAPIRequestParams): Promise<any>
Simulate an internal API request, invoking directly the lambda and therefore saving resources.
Parameters
- params: InternalAPIRequestParams
Returns Promise<any>
the body of the response

Deprecated
don't run a Lambda from another Lambda (bad practice)
- Defined in src/resourceController.ts:447

`Protected`loadSharedResource

loadSharedResource(filePath: string): string
Load a shared resource in the back-end (translation, template, etc.). Search for the specified file path in both the Lambda function's main folder and the layers folder.
Parameters
- filePath: string
Returns string
- Defined in src/resourceController.ts:399

loadTranslations

loadTranslations(lang: string, defLang?: string): void
Load the translations from the shared resources and set them with a fallback language.
Parameters
- lang: string
- OptionaldefLang: string
Returns void
- Defined in src/resourceController.ts:514

`Protected`patchResource

patchResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:339

`Protected`patchResources

patchResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:345

`Protected`postResource

postResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:297

`Protected`postResources

postResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:327

`Protected`prepareMetrics

prepareMetrics(): void
Prepare the CloudWatch metrics at the beginning of a request.

Returns void
- Defined in src/resourceController.ts:411

`Protected`publishMetrics

publishMetrics(statusCode: number, error?: any): void
Publish the CloudWatch metrics (default and custom-defined) at the end of a reqeust.
Parameters
- statusCode: number
- Optionalerror: any
Returns void
- Defined in src/resourceController.ts:427

`Protected`putResource

putResource(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:303

`Protected`putResources

putResources(): Promise<any>
To

Returns Promise<any>
- Defined in src/resourceController.ts:333

setLambdaLogLevel

setLambdaLogLevel(
logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL",
): void
Set the log level for the current Lambda function's logger.
Parameters
- logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"
Returns void
Inherited from GenericController.setLambdaLogLevel
- Defined in src/genericController.ts:69

`Protected`sharedResourceExists

sharedResourceExists(filePath: string): boolean
Check whether shared resource exists in the back-end (translation, template, etc.). Search for the specified file path in both the Lambda function's main folder and the layers folder.
Parameters
- filePath: string
Returns boolean
- Defined in src/resourceController.ts:392

silentLambdaLogs

silentLambdaLogs(): void
Raise the log level of the current Lambda function's logger to "FATAL", hence avoiding printing any log.

Returns void
Inherited from GenericController.silentLambdaLogs
- Defined in src/genericController.ts:75

`Protected`storeLog

storeLog(succeeded: boolean): Promise<void>
Store the log associated to the request (no response/error handling).
Parameters
- succeeded: boolean
Returns Promise<void>
- Defined in src/resourceController.ts:368

t

t(key: string, interpolateParams?: any): string
Get a translated term by key, optionally interpolating variables (e.g. {{user}}). If the term doesn't exist in the current language, it is searched in the default language.
Parameters
- key: string
- OptionalinterpolateParams: any
Returns string
- Defined in src/resourceController.ts:535

Class ResourceControllerAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ResourceController

Properties

Protectedauth0User

Protectedauthorization

Protectedbody

Protectedclaims

ProtectedclientBundle

ProtectedclientPlatform

ProtectedclientVersion

ProtectedcognitoUser

ProtectedcurrentLang

ProtecteddefaultLang

Protectedevent

ProtectedhttpMethod

Protected OptionalinitError

Protectedlogger

ProtectedlogRequestsWithKey

Protectedmetrics

Protectedpath

ProtectedpathParameters

ProtectedprincipalId

Protectedproject

ProtectedqueryParams

Protectedresource

ProtectedresourceId

ProtectedresourcePath

ProtectedreturnHeaders

Protected OptionalreturnStatusCode

Protectedstage

ProtectedtemplateMatcher

Protectedtracer

ProtectedtracerLambdaSegment

ProtectedtracerRCSegment

Protectedtranslations

Methods

ProtectedcheckAuthBeforeRequest

Returns Promise<void>

comesFromInternalRequest

Returns boolean

Deprecated

ProtecteddeleteResource

Returns Promise<any>

ProtecteddeleteResources

Returns Promise<any>

Protecteddone

Parameters

Returns ResourceControllerResult

ProtectedgetEventSummary

Parameters

Returns Record<string, any>

getLambdaLogLevel

Returns "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL"

ProtectedgetQueryParamAsArray

Parameters

Returns string[]

ProtectedgetQueryParamAsBoolean

Parameters

Returns boolean

ProtectedgetResource

Returns Promise<any>

ProtectedgetResources

Returns Promise<any>

ProtectedhandleControllerError

Parameters

Returns UnhandledError | HandledError

handleRequest

Returns Promise<ResourceControllerResult>

ProtectedheadResource

Returns Promise<any>

ProtectedheadResources

Returns Promise<any>

Class ResourceController`Abstract`

`Protected`auth0User

`Protected`authorization

`Protected`body

`Protected`claims

`Protected`clientBundle

`Protected`clientPlatform

`Protected`clientVersion

`Protected`cognitoUser

`Protected`currentLang

`Protected`defaultLang

`Protected`event

`Protected`httpMethod

`Protected` `Optional`initError

`Protected`logger

`Protected`logRequestsWithKey

`Protected`metrics

`Protected`path

`Protected`pathParameters

`Protected`principalId

`Protected`project

`Protected`queryParams

`Protected`resource

`Protected`resourceId

`Protected`resourcePath

`Protected`returnHeaders

`Protected` `Optional`returnStatusCode

`Protected`stage

`Protected`templateMatcher

`Protected`tracer

`Protected`tracerLambdaSegment

`Protected`tracerRCSegment

`Protected`translations

`Protected`checkAuthBeforeRequest

`Protected`deleteResource

`Protected`deleteResources

`Protected`done

`Protected`getEventSummary

`Protected`getQueryParamAsArray

`Protected`getQueryParamAsBoolean

`Protected`getResource

`Protected`getResources

`Protected`handleControllerError

`Protected`headResource

`Protected`headResources

`Protected`loadSharedResource

`Protected`patchResource

`Protected`patchResources

`Protected`postResource

`Protected`postResources

`Protected`prepareMetrics

`Protected`publishMetrics

`Protected`putResource

`Protected`putResources

`Protected`sharedResourceExists

`Protected`storeLog