@evokegroup/aws v3.0.3

@evokegroup/aws

AWS utilities

Requires NodeJS 18+

Class: LambdaEvent

Properties

Class: ApiGatewayEvent

extends LambdaEvent

Properties

Methods

getBody()

Returns the event request body.

setBody(value)

Overwrite the event request body.

getBodyJSON()

Returns the event request body as JSON or Error if the data cannot be parsed.

isJsonRequest()

Returns true if the Content-Type header is set to application/json

getHeader(name)

Gets a header by a case-insensitive name.

setHeader(name, value)

Sets a header.

getStage()

Gets the stage sent by API Gateway

getStageVariable(name)

Gets a stage variable by name. Returns null if not found.

setStageVariable(name, value)

Overrides a stage variable.

Class: Config

Base class for configurations classes that can pass their configuration values via an object

Methods

init(config = this)

Initializes the configuration properties.

set(config = {})

Sets properties.

initProperty(name, value)

Initializes a single property

getTypedEnvValueOrDefault(value, defaultValue)

Attempts to convert value to the defaultValue type. If defaultValue is a function, value will be passed as the argument and the result will be returned.

Class: EnvironmentConfig

extends Config

Base class for configurations classes using environment variables (process.env)

Class: LambdaConfig

extends EnvironmentConfig

Base class for configurations classes within a Lambda function

constructor(event)

const { LambdaConfig, SuccessResponse } = require('@evokegroup/aws');

class MyConfig extends LambdaConfig {
  site = null;
  environment = null;

  constructor(event) {
    super(event); 
    this.init();
  }
}

export const handler = async (event) => {
  return new Promise((resolve, reject) => {
    const config = new MyConfig(event);
    // do stuff
    resolve(SuccessResponse.json());
  });
};

Properties

event

The EvokeAws.LambdaEvent created from the event data passed to the function

Class: ApiGatewayConfig

extends EnvironmentConfig

Base class for configurations classes within a Lambda function being exexuted via API Gateway and using stage variables

Class: LambdaResponse

A basic Lambda response object.

{
  statusCode: 200,
  headers: {
    "Access-Control-Allow-Origin": "*"
  },
  body: "Hello world",
  isBase64Encoded: false
}

constructor(object)

// Return a base64 encoded Buffer
import { LambdaResponse } from '@evokegroup/aws';
export const handler = async (event) => {
  return new Promise((resolve, reject) => {
    resolve(LambdaResponse.json({ body: Buffer.from('data', 'ascii'), isBase64Encoded: true }));
  });
}

Methods

serialize()

Serializes the response.

toJSON()

See serialize.

Class: JsonResponse

extends LambdaResponse

Base class for JSON-based responses.

{
  statusCode: 200,
  headers: {
    "Access-Control-Allow-Origin": "*",
    "Content-Type": "application/json"
  },
  body: "{\"success\":true,\"message\":\"OK\",\"data\":{}}",
  isBase64Encoded: false
}

constructor(object)

Class: SuccessResponse

extends JsonResponse

Creates a JsonResponse with a default statusCode = 200 and body success = true.

constructor(object)

const { SuccessResponse } = require('@evokegroup/aws');

export const handler = async (event) => {
  return new Promise((resolve, reject) => {
    resolve(SuccessResponse.json());
  });
};

Class: ErrorResponse

extends JsonResponse

Creates a JsonResponse with a default statusCode = 400 and body success = false.

{
  statusCode: 400,
  headers: {
    "Access-Control-Allow-Origin": "*",
    "Content-Type": "application/json"
  },
  body: "{\"success\":false,\"message\":\"An error has occurred.\",\"data\":null}",
  isBase64Encoded: false
}

constructor(object)

const { ErrorResponse } = require('@evokegroup/aws');

export const handler = async (event) => {
  return new Promise((resolve, reject) => {
    resolve(ErrorResponse.json({ statusCode: 403, message: 'Unauthorized' }));
  });
};