Class GcpCloudFunctionsAdapter

GCP Cloud Functions Adapter for Stone.js.

The GcpCloudFunctionsAdapter provides seamless integration between Stone.js applications and the GCP Cloud Functions environment. It processes incoming events from GCP Cloud Functions, transforms them into IncomingEvent instances, and returns a RawResponse.

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

Template: GcpCloudFunctionsEvent

The type of the raw event received from GCP Cloud Functions.

Template: RawResponse

The type of the response to send back to GCP Cloud Functions.

Template: GcpCloudFunctionsContext

The GCP Cloud Functions 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: GcpCloudFunctionsAdapterContext

Context type specific to the adapter.

Example

import { GcpCloudFunctionsAdapter } from '@stone-js/gcp-cloud-functions-adapter';

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

const handler = await adapter.run();

export { handler };

See

Hierarchy

Adapter<
    GcpCloudFunctionsEvent,
    RawResponse,
    GcpCloudFunctionsContext,
    IncomingEvent,
    IncomingEventOptions,
    OutgoingResponse,
    GcpCloudFunctionsAdapterContext,
>
- GcpCloudFunctionsAdapter

Constructors

`Protected`constructor

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

Inherited from Adapter< GcpCloudFunctionsEvent, RawResponse, GcpCloudFunctionsContext, IncomingEvent, IncomingEventOptions, OutgoingResponse, GcpCloudFunctionsAdapterContext >.constructor

Properties

`Protected` `Readonly`blueprint

blueprint: IBlueprint

`Protected` `Readonly`hooks

hooks: AdapterHookType<GcpCloudFunctionsAdapterContext, RawResponse>

`Protected` `Readonly`middleware

middleware: AdapterMixedPipeType<GcpCloudFunctionsAdapterContext, RawResponse>[]

`Protected` `Readonly`resolvedErrorHandlers

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

Methods

`Protected`buildRawResponse

buildRawResponse(
context: GcpCloudFunctionsAdapterContext,
eventHandler?: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Build the raw response.
Parameters
- context: GcpCloudFunctionsAdapterContext
  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: GcpCloudFunctionsEvent,
executionContext?: GcpCloudFunctionsContext,
): Promise<RawResponse>
Processes an incoming GCP Cloud Functions event.

This method transforms the raw GCP Cloud Functions event into a Stone.js IncomingEvent, processes it through the pipeline, and generates a RawResponse to send back.
Parameters
- rawEvent: GcpCloudFunctionsEvent
  The raw GCP Cloud Functions event to be processed.
- OptionalexecutionContext: GcpCloudFunctionsContext
  The GCP Cloud Functions 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?: GcpCloudFunctionsAdapterContext,
    error?: any,
): Promise<void>
Execute adapter lifecycle hooks.
Parameters
- name: AdapterHookName
  The hook's name.
- Optionalcontext: GcpCloudFunctionsAdapterContext
  The event context.
- Optionalerror: any
  The error to handle.
Returns Promise<void>

Inherited from Adapter.executeHooks

`Protected`handleError

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

Inherited from Adapter.handleError

`Protected`handleEvent

handleEvent(
    context: GcpCloudFunctionsAdapterContext,
    eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<
    IAdapterEventBuilder<
        RawResponseOptions,
        IRawResponseWrapper<RawResponse>,
    >,
>
Handle the event.
Parameters
- context: GcpCloudFunctionsAdapterContext
  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<
    GcpCloudFunctionsAdapterContext,
    AdapterEventBuilderType<RawResponse>,
>

Create pipeline options for the Adapter.

Returns PipelineOptions<
    GcpCloudFunctionsAdapterContext,
    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 GCP Cloud Functions environment. If not, it throws an error to prevent misuse.

Returns Promise<void>

Throws
If executed outside an GCP Cloud Functions context (e.g., browser).

`Protected`resolveErrorHandler

resolveErrorHandler(
    error: Error,
): IAdapterErrorHandler<
    GcpCloudFunctionsEvent,
    RawResponse,
    GcpCloudFunctionsContext,
>
Get the error handler for the given error.
Parameters
- error: Error
  The error to get the handler for.
Returns IAdapterErrorHandler<
    GcpCloudFunctionsEvent,
    RawResponse,
    GcpCloudFunctionsContext,
>
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 = GcpCloudFunctionsEventHandlerFunction>(): Promise<
ExecutionResultType,
>
Executes the adapter and provides an GCP Cloud Functions-compatible handler function.

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

Throws
If used outside the GCP Cloud Functions environment.

Overrides Adapter.run

`Protected`sendEventThroughDestination

sendEventThroughDestination(
context: GcpCloudFunctionsAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): Promise<RawResponse>
Send the raw event through the destination.
Parameters
- context: GcpCloudFunctionsAdapterContext
  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: GcpCloudFunctionsAdapterContext,
eventHandler: AdapterEventHandlerType<IncomingEvent, OutgoingResponse>,
): void
Validate the context and event handler.
Parameters
- context: GcpCloudFunctionsAdapterContext
  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): GcpCloudFunctionsAdapter
Creates an instance of the GcpCloudFunctionsAdapter.
Parameters
- blueprint: IBlueprint
  The application blueprint.
Returns GcpCloudFunctionsAdapter
A new instance of GcpCloudFunctionsAdapter.
Example
```
const adapter = GcpCloudFunctionsAdapter.create(blueprint);
await adapter.run();
```

Class GcpCloudFunctionsAdapter

Template: GcpCloudFunctionsEvent

Template: RawResponse

Template: GcpCloudFunctionsContext

Template: IncomingEvent

Template: IncomingEventOptions

Template: OutgoingResponse

Template: GcpCloudFunctionsAdapterContext

Example

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns GcpCloudFunctionsAdapter

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< GcpCloudFunctionsAdapterContext, AdapterEventBuilderType<RawResponse>,>

ProtectedonStart

Returns Promise<void>

Throws

ProtectedresolveErrorHandler

Parameters

Returns IAdapterErrorHandler< GcpCloudFunctionsEvent, RawResponse, GcpCloudFunctionsContext,>

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 GcpCloudFunctionsAdapter

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

Returns PipelineOptions<
GcpCloudFunctionsAdapterContext,
AdapterEventBuilderType<RawResponse>,
>

`Protected`onStart

`Protected`resolveErrorHandler

Returns IAdapterErrorHandler<
GcpCloudFunctionsEvent,
RawResponse,
GcpCloudFunctionsContext,
>

`Protected`resolveEventHandler

`Protected`sendEventThroughDestination

`Protected`validateContextAndEventHandler

`Static`create