Class ResponseUtil

constructor

• new ResponseUtil(): ResponseUtil

  Returns ResponseUtil

StaticcognitoErrorMap

Staticarray2Object

• array2Object<T>(
      collection: T[],
      abacRestrictions?: string[],
      key?: string,
  ): Record<string, T>

  transforms an array of resource definitions to a keyed json object by given key (default of id attribute) mutates the response object given context aware attribute access restrictions

  Type Parameters

  • T

  Parameters

  • collection: T[]

    collection/array of the api responses objects
  • OptionalabacRestrictions: string[]

    attributes that should be redacted from output
  • key: string = "id"

    attribute to use for key in json object.

  Returns Record<string, T>

StaticcreateResponse

• createResponse(
      statusCode: number,
      body: any,
  ): {
      body: string;
      headers: {
          "Access-Control-Allow-Credentials": boolean;
          "Access-Control-Allow-Origin": string;
          "Content-Type": string;
      };
      statusCode: number;
  }

  Parameters

  • statusCode: number
  • body: any

  Returns {
      body: string;
      headers: {
          "Access-Control-Allow-Credentials": boolean;
          "Access-Control-Allow-Origin": string;
          "Content-Type": string;
      };
      statusCode: number;
  }

StaticgenerateResponse

• generateResponse<T>(
      data: CollectionData<T>,
  ): PageObjectResponse<T> | PageArrayResponse<T>

  Type Parameters

  • T

  Parameters

  • data: CollectionData<T>

  Returns PageObjectResponse<T> | PageArrayResponse<T>

StatichandleCognitoError

• handleCognitoError(error: unknown): never

  Parameters

  • error: unknown

  Returns never

StaticpruneEmpty

• pruneEmpty<T>(obj: T): T

  Type Parameters

  • T

  Parameters

  • obj: T

  Returns T

StaticremoveAttributes

• removeAttributes<T>(collection: T[], abacRestrictions?: string[]): any[]

  verifies if object keys should be excluded from API response mutates the response collection given context aware attribute access restrictions

  Type Parameters

  • T

  Parameters

  • collection: T[]

    collection/array of the api responses objects
  • OptionalabacRestrictions: string[]

    attribute access control restrictions

  Returns any[]