@lastshotlabs/slingshot-interactions

npm install @lastshotlabs/slingshot-interactions

Functions

`buttonSchema`

Button component schema.

Source: packages/slingshot-interactions/src/components/schema.ts

`compileHandlers`

Compile declarative handler templates into runtime dispatchers.

function compileHandlers(handlers: Record<string, HandlerTemplate>, deps: { app: Hono<AppEnv>; bus: SlingshotEventBus },): CompiledHandlerTable

Source: packages/slingshot-interactions/src/handlers/compile.ts

`createInteractionsPackage`

Create the interactions package.

Validates rawConfig via interactionsPluginConfigSchema, compiles all declarative handler templates into dispatchers, and exposes:

POST {mountPath}/dispatch — the bespoke interaction dispatch endpoint.
GET /interactionEvents / GET /interactionEvents/:id — entity-generated read routes for the user-scoped audit log (provided by the entity module).

function createInteractionsPackage(rawConfig: unknown): SlingshotPackageDefinition

Source: packages/slingshot-interactions/src/plugin.ts

`dispatchInteraction`

Dispatch a user interaction against the owning message peer.

async function dispatchInteraction(deps: DispatchDeps, request: DispatchRequest, userId: string, requestTenantId: string | null,): Promise<DispatchOutcome>

Source: packages/slingshot-interactions/src/handlers/dispatch.ts

`validateComponentTree`

Validate an arbitrary value as a component tree.

function validateComponentTree(input: unknown): ComponentTree

Source: packages/slingshot-interactions/src/components/validate.ts

`verifyWebhookSignature`

Verify a webhook signature and timestamp to prevent replay attacks.

function verifyWebhookSignature(body: string, signature: string, timestamp: string, secret: string, toleranceMs = TIMESTAMP_TOLERANCE_MS,): boolean

Source: packages/slingshot-interactions/src/handlers/dispatchers/webhook.ts

Constants

`actionRowSchema`

Action-row schema.

Source: packages/slingshot-interactions/src/components/schema.ts

`componentTreeSchema`

Component-tree schema attached to a message.

Source: packages/slingshot-interactions/src/components/schema.ts

`dispatchRequestSchema`

Request schema for the bespoke interactions dispatch route.

Source: packages/slingshot-interactions/src/routes/dispatchRoute.schema.ts

`dispatchResultSchema`

Dispatcher response schema shared by all handler kinds.

Source: packages/slingshot-interactions/src/routes/dispatchRoute.schema.ts

`handlerTemplateSchema`

Declarative handler template used by the interactions package config.

Source: packages/slingshot-interactions/src/handlers/template.ts

`InteractionEvent`

Entity definition for persisted interaction-dispatch audit rows.

Source: packages/slingshot-interactions/src/entities/interactionEvent.ts

`interactionEventFactories`

Store-type keyed factories for the InteractionEvent audit entity.

Source: packages/slingshot-interactions/src/entities/factories.ts

`interactionEventOperations`

Generated query operations for interaction audit reads.

Source: packages/slingshot-interactions/src/entities/interactionEvent.ts

`Interactions`

Provider-owned package contract for slingshot-interactions.

Source: packages/slingshot-interactions/src/public.ts

`INTERACTIONS_PLUGIN_STATE_KEY`

Stable plugin-state key used in ctx.pluginState.

Source: packages/slingshot-interactions/src/state.ts

`interactionsPluginConfigSchema`

Config schema for createInteractionsPackage().

Source: packages/slingshot-interactions/src/config/schema.ts

`InteractionsRuntimeCap`

Capability handle for the interactions runtime state.

Cross-package consumers resolve it via ctx.capabilities.require(InteractionsRuntimeCap). The legacy INTERACTIONS_PLUGIN_STATE_KEY plugin-state slot is still published in parallel during the bridge period; new consumers should prefer the cap.

Source: packages/slingshot-interactions/src/public.ts

`modalSchema`

Modal payload schema returned by handlers.

Source: packages/slingshot-interactions/src/components/schema.ts

`selectMenuSchema`

Select-menu component schema.

Source: packages/slingshot-interactions/src/components/schema.ts

`textInputSchema`

Modal text-input schema.

Source: packages/slingshot-interactions/src/components/schema.ts

Interfaces

`ActionRow`

Horizontal layout row containing one or more interactive children.

Source: packages/slingshot-interactions/src/components/types.ts

`Button`

Clickable button component embedded in a message.

Source: packages/slingshot-interactions/src/components/types.ts

`ChatInteractionsPeer`

Chat peer implementation contract.

Source: packages/slingshot-interactions/src/peers/types.ts

`CommunityInteractionsPeer`

Community peer implementation contract.

Source: packages/slingshot-interactions/src/peers/types.ts

`CompiledHandlerTable`

Runtime table used to resolve action IDs by longest matching prefix.

Source: packages/slingshot-interactions/src/handlers/contracts.ts

`Dispatcher`

Dispatcher contract implemented by webhook, route, and queue handlers.

Source: packages/slingshot-interactions/src/handlers/contracts.ts

`DispatchOutcome`

Structured dispatch outcome returned to the route layer and audit writer.

Source: packages/slingshot-interactions/src/handlers/dispatch.ts

`InteractionsPeer`

Peer contract implemented by chat/community owners of component trees.

Source: packages/slingshot-interactions/src/peers/types.ts

`InteractionsPluginState`

Runtime state published by createInteractionsPackage().

Source: packages/slingshot-interactions/src/state.ts

`Modal`

Modal payload returned by a handler.

Source: packages/slingshot-interactions/src/components/types.ts

`SelectMenu`

Select-menu component embedded in a message.

Source: packages/slingshot-interactions/src/components/types.ts

`TextInput`

Text input used inside modal submissions.

Source: packages/slingshot-interactions/src/components/types.ts

Types

`ButtonStyle`

Button presentation styles supported by the component schema.

Source: packages/slingshot-interactions/src/components/types.ts

`ComponentTree`

Full component tree attached to a message.

Source: packages/slingshot-interactions/src/components/types.ts

`DispatchRequest`

Parsed dispatch request payload.

Source: packages/slingshot-interactions/src/routes/dispatchRoute.schema.ts

`DispatchResult`

Parsed dispatch response payload.

Source: packages/slingshot-interactions/src/routes/dispatchRoute.schema.ts

`HandlerTemplate`

Union of all declarative handler kinds.

Source: packages/slingshot-interactions/src/handlers/template.ts

`InteractionResponseStatus`

Semantic statuses recorded in the interaction audit trail.

Source: packages/slingshot-interactions/src/entities/interactionEvent.ts

`InteractionsPluginConfig`

Parsed interactions plugin config with defaults applied.

Source: packages/slingshot-interactions/src/config/types.ts

`MessageKind`

Message kinds that can own an interactive component tree.

Source: packages/slingshot-interactions/src/components/types.ts

`QueueHandlerTemplate`

Event-bus queue handler configuration.

Source: packages/slingshot-interactions/src/handlers/template.ts

`RouteHandlerTemplate`

Internal route handler configuration.

Source: packages/slingshot-interactions/src/handlers/template.ts

`SelectMenuKind`

Select-menu variants supported in v1.

Source: packages/slingshot-interactions/src/components/types.ts

`WebhookHandlerTemplate`

Remote webhook handler configuration.

Source: packages/slingshot-interactions/src/handlers/template.ts