Class AwsLambdaAdapter

AWS Lambda Adapter for Stone.js.

The AwsLambdaAdapter provides seamless integration between Stone.js applications and the AWS Lambda environment. It processes incoming events from AWS Lambda, transforms them into IncomingEvent instances, and returns a RawResponse.

This adapter ensures compatibility with AWS Lambda's execution model and abstracts the event handling process for Stone.js developers.

Template: AwsLambdaEvent

The type of the raw event received from AWS Lambda.

Template: RawResponse

The type of the response to send back to AWS Lambda.

Template: AwsLambdaContext

The AWS Lambda execution context type.

Template: IncomingEvent

The type of the processed incoming event.

Template: IncomingEventOptions

Options used to create an incoming event.

Template: OutgoingResponse

The type of the outgoing response after processing.

Template: AwsLambdaAdapterContext

Context type specific to the adapter.

Example

import { AwsLambdaAdapter } from '@stone-js/aws-lambda-adapter';

const adapter = AwsLambdaAdapter.create({...});

const handler = await adapter.run();

export { handler };

See

Hierarchy

Adapter<
    AwsLambdaEvent,
    RawResponse,
    AwsLambdaContext,
    IncomingEvent,
    IncomingEventOptions,
    OutgoingResponse,
    AwsLambdaAdapterContext,
>
- AwsLambdaAdapter

Constructors

`Protected`constructor

new AwsLambdaAdapter(blueprint: IBlueprint): AwsLambdaAdapter
Create an Adapter.
Parameters
- blueprint: IBlueprint
  The blueprint to create the adapter.
Returns AwsLambdaAdapter

Inherited from Adapter< AwsLambdaEvent, RawResponse, AwsLambdaContext, IncomingEvent, IncomingEventOptions, OutgoingResponse, AwsLambdaAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<AwsLambdaAdapterContext, RawResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<AwsLambdaAdapterContext, RawResponse>[]

`Protected` `Readonly`resolvedErrorHandlers

resolvedErrorHandlers: Record<
string,
IAdapterErrorHandler<RawEventType, RawResponseType, ExecutionContextType>,
>

Methods

`Protected`buildRawResponse

buildRawResponse(
context: AwsLambdaAdapterContext,
eventHandler?: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Build the raw response.
Parameters
- context: AwsLambdaAdapterContext
  The event context.
- OptionaleventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<RawResponse>
The raw response wrapper.

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
rawEvent: AwsLambdaEvent,
executionContext: AwsLambdaContext,
): Promise<RawResponse>
Processes an incoming AWS Lambda event.

This method transforms the raw AWS Lambda event into a Stone.js IncomingEvent, processes it through the pipeline, and generates a RawResponse to send back.
Parameters
- rawEvent: AwsLambdaEvent
  The raw AWS Lambda event to be processed.
- executionContext: AwsLambdaContext
  The AWS Lambda execution context for the event.
Returns Promise<RawResponse>
A promise resolving to the processed RawResponse.

`Protected`executeEventHandlerHooks

executeEventHandlerHooks(
hook: KernelHookName,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<void>
Execute the event handler lifecycle hooks.
Parameters
- hook: KernelHookName
  The hook to execute.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<void>

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

executeHooks(
    name: AdapterHookName,
    context?: AwsLambdaAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: AwsLambdaAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

handleError(
error: Error,
context: AwsLambdaAdapterContext,
): Promise<AdapterEventBuilderType<RawResponse>>
Handle error.
Parameters
- error: Error
  The error to handle.
- context: AwsLambdaAdapterContext
  The event context.
Returns Promise<AdapterEventBuilderType<RawResponse>>
The raw response.

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: AwsLambdaAdapterContext,
    eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponse>,
    >,
>
Handle the event.
Parameters
- context: AwsLambdaAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponse>,
    >,
>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
AwsLambdaAdapterContext,
AdapterEventBuilderType<RawResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<AwsLambdaAdapterContext, AdapterEventBuilderType<RawResponse>>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Initializes the adapter and validates its execution context.

Ensures the adapter is running in an AWS Lambda environment. If not, it throws an error to prevent misuse.

Returns Promise<void>

Throws
If executed outside an AWS Lambda context (e.g., browser).

`Protected`resolveErrorHandler

resolveErrorHandler(
error: Error,
): IAdapterErrorHandler<AwsLambdaEvent, RawResponse, AwsLambdaContext>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<AwsLambdaEvent, RawResponse, AwsLambdaContext>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = AwsLambdaEventHandlerFunction>(): Promise<
ExecutionResultType,
>
Executes the adapter and provides an AWS Lambda-compatible handler function.

The run method initializes the adapter and returns a handler function that AWS Lambda can invoke. This handler processes events, manages context, and returns the appropriate response.
Type Parameters
- ExecutionResultType = AwsLambdaEventHandlerFunction
  The type representing the AWS Lambda event handler function.
Returns Promise<ExecutionResultType>
A promise resolving to the AWS Lambda handler function.

Throws
If used outside the AWS Lambda environment.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
context: AwsLambdaAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Send the raw event through the destination.
Parameters
- context: AwsLambdaAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to be run.
Returns Promise<RawResponse>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
context: AwsLambdaAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): void
Validate the context and event handler.
Parameters
- context: AwsLambdaAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): AwsLambdaAdapter
Creates an instance of the AwsLambdaAdapter.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns AwsLambdaAdapter
A new instance of AwsLambdaAdapter.
Example
```
const adapter = AwsLambdaAdapter.create(blueprint);
await adapter.run();
```

Class AwsLambdaAdapter

Template: AwsLambdaEvent

Template: RawResponse

Template: AwsLambdaContext

Template: IncomingEvent

Template: IncomingEventOptions

Template: OutgoingResponse

Template: AwsLambdaAdapterContext

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns AwsLambdaAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<RawResponse>

ProtectedeventListener

Parameters

Returns Promise<RawResponse>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<RawResponse>>

ProtectedhandleEvent

Parameters

Returns Promise< IAdapterEventBuilder< RawResponseOptions, IRawResponseWrapper<RawResponse>, >,>

ProtectedmakePipelineOptions

Returns PipelineOptions<AwsLambdaAdapterContext, AdapterEventBuilderType<RawResponse>>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler<AwsLambdaEvent, RawResponse, AwsLambdaContext>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

Throws

ProtectedsendEventThroughDestination

Parameters

Returns Promise<RawResponse>

Throws

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns AwsLambdaAdapter

Example

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`eventListener

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

Returns Promise<
IAdapterEventBuilder<
RawResponseOptions,
IRawResponseWrapper<RawResponse>,
>,
>

`Protected`makePipelineOptions

`Protected`onStart

`Protected`resolveErrorHandler

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create