Class BrowserAdapter

Browser Adapter for Stone.js.

The BrowserAdapter provides seamless integration between Stone.js applications and the Browser environment. It processes incoming events from Browser, transforms them into IncomingBrowserEvent instances, and returns a BrowserResponse.

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

Template: BrowserEvent

The type of the raw event received from Browser.

Template: BrowserResponse

The type of the response to send back to Browser.

Template: BrowserContext

The Browser execution context type.

Template: IncomingBrowserEvent

The type of the processed incoming event.

Template: IncomingBrowserEventOptions

Options used to create an incoming event.

Template: OutgoingBrowserResponse

The type of the outgoing response after processing.

Template: BrowserAdapterContext

Context type specific to the adapter.

Example

import { BrowserAdapter } from '@stone-js/browser-adapter';

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

await adapter.run();

See

Stone.js Documentation

Hierarchy

Adapter<
    BrowserEvent,
    BrowserResponse,
    BrowserContext,
    IncomingBrowserEvent,
    IncomingBrowserEventOptions,
    OutgoingBrowserResponse,
    BrowserAdapterContext,
>
- BrowserAdapter

Constructors

`Protected`constructor

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

Inherited from Adapter< BrowserEvent, BrowserResponse, BrowserContext, IncomingBrowserEvent, IncomingBrowserEventOptions, OutgoingBrowserResponse, BrowserAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<BrowserAdapterContext, unknown>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<BrowserAdapterContext, unknown>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

buildRawResponse(
    context: BrowserAdapterContext,
    eventHandler?: AdapterEventHandlerType<
        IncomingBrowserEvent,
        OutgoingBrowserResponse,
    >,
): Promise<unknown>
Build the raw response.
Parameters
- context: BrowserAdapterContext
  The event context.
- OptionaleventHandler: AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
  The event handler to be run.
Returns Promise<unknown>
The raw response wrapper.

Inherited from Adapter.buildRawResponse

`Protected`eventListener

eventListener(
    eventHandler: AdapterEventHandlerType<
        IncomingBrowserEvent,
        OutgoingBrowserResponse,
    >,
    rawEvent: BrowserEvent,
    executionContext: Window & typeof globalThis,
): Promise<unknown>
Processes an incoming Browser event.

This method transforms the raw Browser event into a Stone.js IncomingBrowserEvent, processes it through the pipeline, and generates a RawResponse to send back.
Parameters
- eventHandler: AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
- rawEvent: BrowserEvent
  The raw Browser event to be processed.
- executionContext: Window & typeof globalThis
  The Browser execution context for the event.
Returns Promise<unknown>
A promise resolving to the processed RawResponse.

`Protected`executeEventHandlerHooks

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

Inherited from Adapter.executeEventHandlerHooks

`Protected`executeHooks

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

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: BrowserAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingBrowserEvent,
        OutgoingBrowserResponse,
    >,
): Promise<
    IAdapterEventBuilder<RawResponseOptions, IRawResponseWrapper<unknown>>,
>
Handle the event.
Parameters
- context: BrowserAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
  The event handler to be run.
Returns Promise<IAdapterEventBuilder<RawResponseOptions, IRawResponseWrapper<unknown>>>
The raw response wrapper.

Inherited from Adapter.handleEvent

`Protected`makePipelineOptions

makePipelineOptions(): PipelineOptions<
BrowserAdapterContext,
AdapterEventBuilderType<unknown>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<BrowserAdapterContext, AdapterEventBuilderType<unknown>>
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 a Browser environment. If not, it throws an error to prevent misuse.

Returns Promise<void>

Throws
If executed outside a Browser context (e.g., node).

`Protected`resolveErrorHandler

resolveErrorHandler(
error: Error,
): IAdapterErrorHandler<BrowserEvent, unknown, Window & typeof globalThis>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<BrowserEvent, unknown, Window & typeof globalThis>
The error handler.

Throws
IntegrationError

Inherited from Adapter.resolveErrorHandler

`Protected`resolveEventHandler

resolveEventHandler(): AdapterEventHandlerType<
IncomingBrowserEvent,
OutgoingBrowserResponse,
>

Get the event handler for the adapter.

Returns AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
The event handler for the adapter.

Throws
If the event handler is missing.

Inherited from Adapter.resolveEventHandler

run

run<ExecutionResultType = undefined>(): Promise<ExecutionResultType>
Executes the adapter and provides an Browser-compatible handler function.

The run method initializes the adapter and listens for incoming Browser events. It processes these events, generates a response, and sends it back to the Browser.

Idempotent: calling run() again tears down the previous listeners first, so HMR reloads and tests never accumulate duplicate handlers.
Type Parameters
- ExecutionResultType = undefined
Returns Promise<ExecutionResultType>

Throws
If used outside the Browser environment.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
    context: BrowserAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingBrowserEvent,
        OutgoingBrowserResponse,
    >,
): Promise<unknown>
Send the raw event through the destination.
Parameters
- context: BrowserAdapterContext
  The event context.
- eventHandler: AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
  The event handler to be run.
Returns Promise<unknown>
Platform-specific response.

Throws
IntegrationError

Inherited from Adapter.sendEventThroughDestination

stop

stop(): Promise<void>

Tear down the adapter: remove all registered window listeners and run onStop hooks.

Safe to call multiple times and when the adapter was never started.

Returns Promise<void>

`Protected`validateContextAndEventHandler

validateContextAndEventHandler(
    context: BrowserAdapterContext,
    eventHandler: AdapterEventHandlerType<
        IncomingBrowserEvent,
        OutgoingBrowserResponse,
    >,
): void
Validate the context and event handler.
Parameters
- context: BrowserAdapterContext
  The context to validate.
- eventHandler: AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>
  The event handler to validate.
Returns void

Throws
IntegrationError

Inherited from Adapter.validateContextAndEventHandler

`Static`create

create(blueprint: IBlueprint): BrowserAdapter
Parameters
- blueprint: IBlueprint
Returns BrowserAdapter

Class BrowserAdapter

Template: BrowserEvent

Template: BrowserResponse

Template: BrowserContext

Template: IncomingBrowserEvent

Template: IncomingBrowserEventOptions

Template: OutgoingBrowserResponse

Template: BrowserAdapterContext

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns BrowserAdapter

Properties

Protected Readonlyblueprint

Protected Readonlyhooks

Protected Readonlymiddleware

Protected ReadonlyresolvedErrorHandlers

Methods

ProtectedbuildRawResponse

Parameters

Returns Promise<unknown>

ProtectedeventListener

Parameters

Returns Promise<unknown>

ProtectedexecuteEventHandlerHooks

Parameters

Returns Promise<void>

ProtectedexecuteHooks

Parameters

Returns Promise<void>

ProtectedhandleError

Parameters

Returns Promise<AdapterEventBuilderType<unknown>>

ProtectedhandleEvent

Parameters

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

ProtectedmakePipelineOptions

Returns PipelineOptions<BrowserAdapterContext, AdapterEventBuilderType<unknown>>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler<BrowserEvent, unknown, Window & typeof globalThis>

Throws

ProtectedresolveEventHandler

Returns AdapterEventHandlerType<IncomingBrowserEvent, OutgoingBrowserResponse>

Throws

run

Type Parameters

Returns Promise<ExecutionResultType>

Throws

ProtectedsendEventThroughDestination

Parameters

Returns Promise<unknown>

Throws

stop

Returns Promise<void>

ProtectedvalidateContextAndEventHandler

Parameters

Returns void

Throws

Staticcreate

Parameters

Returns BrowserAdapter

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

`Protected`makePipelineOptions

`Protected`onStart

`Protected`resolveErrorHandler

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create