Class ApiGatewayWsAdapter

AWS API Gateway WebSocket adapter for Stone.js.

API Gateway invokes a fresh Lambda per socket event, so this adapter maps requestContext.eventType (CONNECT / DISCONNECT / MESSAGE) into a keyed IncomingEvent and runs it through the kernel, where the light key-router from @stone-js/router routes it to the matching @On* gateway method, the same pattern as every adapter. It maintains the shared connection store (DynamoDB in production); replies to clients go through the API Gateway Management API (see ApiGatewayWsBroadcaster), the management endpoint taken from each event.

Hierarchy

Adapter<
    ApiGatewayWsEvent,
    RawWsResponse,
    LambdaContext,
    IncomingEvent,
    IncomingEventOptions,
    OutgoingResponse,
    ApiGatewayWsAdapterContext,
>
- ApiGatewayWsAdapter

Constructors

`Protected`constructor

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

Inherited from Adapter< ApiGatewayWsEvent, RawWsResponse, LambdaContext, IncomingEvent, IncomingEventOptions, OutgoingResponse, ApiGatewayWsAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<ApiGatewayWsAdapterContext, RawWsResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<ApiGatewayWsAdapterContext, RawWsResponse>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

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

Inherited from Adapter.buildRawResponse

`Protected`dispatch

dispatch(
    context: LambdaContext,
    connection: Connection,
    key: string,
    payload?: unknown,
): Promise<RawWsResponse>
Normalize a socket event into an IncomingEvent and route it through the kernel.
Parameters
- context: LambdaContext
  The Lambda execution context.
- connection: Connection
  The connection.
- key: string
  The routing key (a lifecycle key or event:<channel>:<event>).
- Optionalpayload: unknown
  The payload carried to the handler.
Returns Promise<RawWsResponse>
The raw response.

`Protected`eventListener

eventListener(
event: ApiGatewayWsEvent,
context: LambdaContext,
): Promise<RawWsResponse>
Route one API Gateway WebSocket event by its lifecycle type.
Parameters
- event: ApiGatewayWsEvent
  The raw event.
- context: LambdaContext
  The Lambda execution context.
Returns Promise<RawWsResponse>
The raw response (an ack for API Gateway).

`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?: ApiGatewayWsAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: ApiGatewayWsAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

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

Inherited from Adapter.handleEvent

`Protected`handleMessage

handleMessage(
    event: ApiGatewayWsEvent,
    context: LambdaContext,
    connection: Connection,
): Promise<RawWsResponse>
Handle a MESSAGE event: control frames update presence; every frame is routed through the kernel.
Parameters
- event: ApiGatewayWsEvent
  The raw event.
- context: LambdaContext
  The Lambda execution context.
- connection: Connection
  The connection.
Returns Promise<RawWsResponse>
The raw response.

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
    ApiGatewayWsAdapterContext,
    AdapterEventBuilderType<RawWsResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    ApiGatewayWsAdapterContext,
    AdapterEventBuilderType<RawWsResponse>,
>
The pipeline options for transforming the event.

Inherited from Adapter.makePipelineOptions

`Protected`onStart

onStart(): Promise<void>

Validate the runtime context and run the start hooks.

Returns Promise<void>

Throws
When used outside a Node.js/Lambda context.

`Protected`resolveErrorHandler

resolveErrorHandler(
error: Error,
): IAdapterErrorHandler<ApiGatewayWsEvent, RawWsResponse, LambdaContext>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<ApiGatewayWsEvent, RawWsResponse, LambdaContext>
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 = ApiGatewayWsHandlerFunction>(): Promise<
ExecutionResultType,
>
Initialize and return the Lambda handler API Gateway invokes.
Type Parameters
- ExecutionResultType = ApiGatewayWsHandlerFunction
Returns Promise<ExecutionResultType>
The handler.

Overrides Adapter.run

`Protected`sendEventThroughDestination

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

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

`Protected`store

store(): ConnectionStore

The shared connection store the broadcaster reads, if realtime is enabled.

Returns ConnectionStore
The store, or undefined.

`Protected`useEndpoint

useEndpoint(event: ApiGatewayWsEvent): void
Point the broadcaster at this event's management endpoint (when it supports it).
Parameters
- event: ApiGatewayWsEvent
  The raw event.
Returns void

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
context: ApiGatewayWsAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): void
Validate the context and event handler.
Parameters
- context: ApiGatewayWsAdapterContext
  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): ApiGatewayWsAdapter
Create an ApiGatewayWsAdapter.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns ApiGatewayWsAdapter
A new instance.

Class ApiGatewayWsAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns ApiGatewayWsAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<RawWsResponse>

Protecteddispatch

Parameters

Returns Promise<RawWsResponse>

ProtectedeventListener

Parameters

Returns Promise<RawWsResponse>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<RawWsResponse>>

ProtectedhandleEvent

Parameters

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

ProtectedhandleMessage

Parameters

Returns Promise<RawWsResponse>

ProtectedmakePipelineOptions

Returns PipelineOptions< ApiGatewayWsAdapterContext, AdapterEventBuilderType<RawWsResponse>,>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler<ApiGatewayWsEvent, RawWsResponse, LambdaContext>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingEvent, OutgoingResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

ProtectedsendEventThroughDestination

Parameters

Returns Promise<RawWsResponse>

Throws

Protectedstore

Returns ConnectionStore

ProtecteduseEndpoint

Parameters

Returns void

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns ApiGatewayWsAdapter

Settings

On This Page

`Protected`constructor

`Protected` `Readonly`blueprint

`Protected` `Readonly`hooks

`Protected` `Readonly`middleware

`Protected` `Readonly`resolvedErrorHandlers

`Protected`buildRawResponse

`Protected`dispatch

`Protected`eventListener

`Protected`executeEventHandlerHooks

`Protected`executeHooks

`Protected`handleError

`Protected`handleEvent

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

`Protected`handleMessage

`Protected`makePipelineOptions

Returns PipelineOptions<
ApiGatewayWsAdapterContext,
AdapterEventBuilderType<RawWsResponse>,
>

`Protected`onStart

`Protected`resolveErrorHandler

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`store

`Protected`useEndpoint

`Protected`validateContextAndEventHandler

`Static`create