Class ResourceControllerAbstract

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

Hierarchy (view full)

Constructors

constructor

Properties

auth0User authorization body callback claims clientBundle clientPlatform clientVersion cognitoUser currentLang defaultLang event httpMethod initError logRequestsWithKey logger metrics path pathParameters principalId project queryParams resource resourceId resourcePath returnStatusCode? stage templateMatcher tracer tracerLambdaSegment tracerRCSegment translations

Methods

checkAuthBeforeRequest comesFromInternalRequest deleteResource deleteResources done getEventSummary getLambdaLogLevel getQueryParamAsArray getQueryParamAsBoolean getResource getResources handleControllerError handleRequest headResource headResources invokeInternalAPIRequest loadSharedResource loadTranslations patchResource patchResources postResource postResources prepareMetrics publishMetrics putResource putResources setLambdaLogLevel sharedResourceExists silentLambdaLogs storeLog t

Constructors

constructor

Properties

Protectedauth0User

auth0User: Auth0User

Protectedauthorization

authorization: string

Protectedbody

body: any

Protectedcallback

callback: Callback

Protectedclaims

claims: any

ProtectedclientBundle

clientBundle: string = null

ProtectedclientPlatform

clientPlatform: string = '?'

ProtectedclientVersion

clientVersion: string = '?'

ProtectedcognitoUser

cognitoUser: CognitoUser

ProtectedcurrentLang

currentLang: string

ProtecteddefaultLang

defaultLang: string

Protectedevent

event: APIGatewayProxyEventV2 | APIGatewayProxyEvent

ProtectedhttpMethod

httpMethod: string

ProtectedinitError

initError: boolean = false

ProtectedlogRequestsWithKey

logRequestsWithKey: string

Protectedlogger

logger: LambdaLogger = ...

Protectedmetrics

metrics: CloudWatchMetrics

Protectedpath

path: string

ProtectedpathParameters

pathParameters: any

ProtectedprincipalId

principalId: string

Protectedproject

project: string = PROJECT

ProtectedqueryParams

queryParams: any

Protectedresource

resource: string = RESOURCE

ProtectedresourceId

resourceId: string

ProtectedresourcePath

resourcePath: string

Protected OptionalreturnStatusCode

returnStatusCode?: number

Protectedstage

stage: string = STAGE

ProtectedtemplateMatcher

templateMatcher: RegExp = ...

Protectedtracer

tracer: Tracer

ProtectedtracerLambdaSegment

tracerLambdaSegment: any

ProtectedtracerRCSegment

tracerRCSegment: any

Protectedtranslations

translations: any

Methods

ProtectedcheckAuthBeforeRequest

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)

ProtecteddeleteResource

ProtecteddeleteResources

Protecteddone

ProtectedgetEventSummary

  • getEventSummary(limitBodyArrayDisplay?): Record<string, any>

  • Parameters

    • limitBodyArrayDisplay: boolean = false

    Returns Record<string, any>

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"

ProtectedgetQueryParamAsArray

  • getQueryParamAsArray(paramName): string[]

  • Force the parsing of a query parameter as an array of strings.

    Parameters

    • paramName: string

    Returns string[]

ProtectedgetQueryParamAsBoolean

  • getQueryParamAsBoolean(paramName): boolean

  • Force the parsing of a query parameter as a boolean.

    Parameters

    • paramName: string

    Returns boolean

ProtectedgetResource

ProtectedgetResources

ProtectedhandleControllerError

handleRequest

ProtectedheadResource

ProtectedheadResources

invokeInternalAPIRequest

  • invokeInternalAPIRequest(params): Promise<any>

  • Simulate an internal API request, invoking directly the lambda and therefore saving resources.

    Parameters

    Returns Promise<any>

    the body of the response

    Deprecated

    don't run a Lambda from another Lambda (bad practice)

ProtectedloadSharedResource

  • loadSharedResource(filePath): 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

loadTranslations

  • loadTranslations(lang, defLang?): void

  • Load the translations from the shared resources and set them with a fallback language.

    Parameters

    • lang: string
    • OptionaldefLang: string

    Returns void

ProtectedpatchResource

ProtectedpatchResources

ProtectedpostResource

ProtectedpostResources

ProtectedprepareMetrics

ProtectedpublishMetrics

  • publishMetrics(statusCode, error?): void

  • Publish the CloudWatch metrics (default and custom-defined) at the end of a reqeust.

    Parameters

    • statusCode: number
    • Optionalerror: any

    Returns void

ProtectedputResource

ProtectedputResources

setLambdaLogLevel

  • setLambdaLogLevel(logLevel): void

  • Set the log level for the current Lambda function's logger.

    Parameters

    • logLevel:
          | "TRACE"
          | "DEBUG"
          | "INFO"
          | "WARN"
          | "ERROR"
          | "FATAL"

    Returns void

ProtectedsharedResourceExists

  • sharedResourceExists(filePath): 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

silentLambdaLogs

ProtectedstoreLog

  • storeLog(succeeded): Promise<void>

  • Store the log associated to the request (no response/error handling).

    Parameters

    • succeeded: boolean

    Returns Promise<void>

t

  • t(key, interpolateParams?): 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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods