@meetopenbot/plugin-sdk 0.1.6 → 0.1.7

package/README.md

@@ -26,21 +26,25 @@ OpenBot plugins operate as the **agent runtime** on an event-driven architecture
 A plugin is defined by the `Plugin` or `PluginModule` interface. Use `definePlugin` to get full OpenBot typing.
 
 ```typescript
-import { definePlugin } from '@meetopenbot/plugin-sdk';
+import { definePlugin } from "@meetopenbot/plugin-sdk";
 
 export default definePlugin({
-  id: 'my-agent',
-  name: 'My Agent',
-  description: 'A custom AI agent',
+  id: "my-agent",
+  name: "My Agent",
+  description: "A custom AI agent",
   configSchema: {
-    type: 'object',
+    type: "object",
     properties: {
-      apiKey: { type: 'string', description: 'Your API Key', format: 'password' },
+      apiKey: {
+        type: "string",
+        description: "Your API Key",
+        format: "password",
+      },
     },
-    required: ['apiKey'],
+    required: ["apiKey"],
   },
   factory: (context) => (builder) => {
-    builder.on('agent:invoke', async function* (event) {
+    builder.on("agent:invoke", async function* (event) {
       // Handle agent logic here
     });
   },
@@ -57,6 +61,81 @@ Plugins communicate via an event bus. Core events include:
 - `client:ui:widget:response`: Dispatched when a user interacts with a widget (e.g., submits a form or clicks a choice).
 - `action:<toolName>`: Dispatched when a tool call is requested.
 - `action:<toolName>:result`: Emitted when a tool handler finishes. Must include `data.output: string` to be fed back to the model.
+- `action:webhook`: Dispatched when a third-party provider POSTs to `/api/webhooks/:provider`.
+- `action:webhook:http-response`: Yield from a webhook handler to control the HTTP response (challenges, acks, errors).
+
+### Inbound webhooks
+
+The OpenBot host exposes `POST /api/webhooks/:provider` for third-party integrations (Slack, Linear, GitHub, etc.). The route is intentionally thin: it forwards the request onto the event bus and lets **existing plugins** handle verification, transforms, and HTTP responses.
+
+**Host behavior:**
+
+1. Preserves the **raw request body** (base64 in the event) for HMAC signature checks.
+2. Dispatches `action:webhook` to the `system` agent on the `uncategorized` channel.
+3. **Awaits** the plugin run and uses the first `action:webhook:http-response` yield as the HTTP reply (defaults to `200 {}`).
+4. Fans out subsequent events (`agent:invoke`, etc.) over SSE like `/api/publish`.
+
+**Plugin responsibilities:**
+
+- Filter on `event.data.provider` (matches the `:provider` URL segment).
+- Verify signatures using `event.data.headers` and `decodeWebhookRawBody(event)`.
+- Yield `webhookHttpResponse(...)` for URL challenges, 401s, or custom acks.
+- Transform into normal bus events (typically `agent:invoke`).
+
+```typescript
+import {
+  definePlugin,
+  decodeWebhookRawBody,
+  getWebhookHeader,
+  webhookHttpResponse,
+  type WebhookEvent,
+} from "@meetopenbot/plugin-sdk";
+
+export default definePlugin({
+  name: "Slack",
+  description: "Inbound Slack Events API webhooks",
+  configSchema: {
+    type: "object",
+    properties: {
+      signingSecret: {
+        type: "string",
+        description: "Slack signing secret",
+        format: "password",
+      },
+    },
+    required: ["signingSecret"],
+  },
+  factory:
+    ({ config }) =>
+    (builder) => {
+      builder.on("action:webhook", async function* (event) {
+        const webhook = event as WebhookEvent;
+        if (webhook.data.provider !== "slack") return;
+
+        const rawBody = decodeWebhookRawBody(webhook);
+        const payload = JSON.parse(rawBody.toString("utf8"));
+
+        if (payload.type === "url_verification") {
+          yield webhookHttpResponse({
+            status: 200,
+            body: { challenge: payload.challenge },
+          });
+          return;
+        }
+
+        // verify signature, then ack + transform...
+        yield webhookHttpResponse({ status: 200, body: {} });
+        yield {
+          type: "agent:invoke",
+          data: { role: "user", content: payload.event?.text ?? "" },
+          meta: { threadId: payload.event?.thread_ts ?? payload.event?.ts },
+        };
+      });
+    },
+});
+```
+
+Register the plugin on your webhook agent (usually `system`) in `AGENT.md`, then point the provider at `https://<host>/api/webhooks/slack`.
 
 ### Output and Communication
 
@@ -96,18 +175,22 @@ Plugins can render interactive UI widgets using the `uiWidget` helper and handle
 This agent responds to any message with "Hello, World!".
 
 ```typescript
-import { definePlugin, shouldHandleInvoke, agentOutput } from '@meetopenbot/plugin-sdk';
+import {
+  definePlugin,
+  shouldHandleInvoke,
+  agentOutput,
+} from "@meetopenbot/plugin-sdk";
 
 export default definePlugin({
-  id: 'hello-world',
-  name: 'Hello World',
-  description: 'Responds with Hello World',
+  id: "hello-world",
+  name: "Hello World",
+  description: "Responds with Hello World",
   factory: (context) => (builder) => {
-    builder.on('agent:invoke', async function* (event) {
+    builder.on("agent:invoke", async function* (event) {
       if (shouldHandleInvoke(event, context.agentId)) {
         yield agentOutput({
           agentId: context.agentId,
-          content: 'Hello, World!',
+          content: "Hello, World!",
           threadId: event.meta?.threadId,
         });
       }
@@ -122,7 +205,7 @@ export default definePlugin({
 - [Events & State](./src/events.ts)
 - [Storage Interface](./src/storage.ts)
 - [UI Widget Specs](./src/ui.ts)
-- [Helpers](./src/helpers.ts)
+- [Helpers](./src/helpers.ts) (`decodeWebhookRawBody`, `getWebhookHeader`, `webhookHttpResponse`)
 
 ## License
 

package/dist/events.d.ts

@@ -1,5 +1,5 @@
-import type { AgentDetails, ChannelDetails, ThreadDetails } from './storage.js';
-import type { RenderUIWidgetData } from './ui.js';
+import type { AgentDetails, ChannelDetails, ThreadDetails } from "./storage.js";
+import type { RenderUIWidgetData } from "./ui.js";
 export type EventMeta = {
     agentId?: string;
     threadId?: string;
@@ -12,15 +12,15 @@ export type BaseEvent = {
     meta?: EventMeta;
 };
 export type AgentInvokeEvent = BaseEvent & {
-    type: 'agent:invoke';
+    type: "agent:invoke";
     data: {
-        role?: 'user' | 'assistant' | 'system';
+        role?: "user" | "assistant" | "system";
         content: string;
         agentId?: string;
     };
 };
 export type AgentOutputEvent = BaseEvent & {
-    type: 'agent:output';
+    type: "agent:output";
     data: {
         content: string;
     };
@@ -29,14 +29,14 @@ export type AgentOutputEvent = BaseEvent & {
     };
 };
 export type UIWidgetEvent = BaseEvent & {
-    type: 'client:ui:widget';
+    type: "client:ui:widget";
     data: RenderUIWidgetData;
     meta: EventMeta & {
         agentId: string;
     };
 };
 export type UIWidgetResponseEvent = BaseEvent & {
-    type: 'client:ui:widget:response';
+    type: "client:ui:widget:response";
     data: {
         widgetId: string;
         actionId: string;
@@ -56,26 +56,49 @@ export type ToolResultEvent<TData = unknown> = BaseEvent & {
     data: TData;
     meta?: EventMeta;
 };
+/** Inbound third-party webhook forwarded from `POST /api/webhooks/:provider`. */
+export type WebhookEvent = BaseEvent & {
+    type: "action:webhook";
+    data: {
+        provider: string;
+        /** Request body encoded as base64 so plugins can verify HMACs on the raw bytes. */
+        rawBody: string;
+        headers: Record<string, string | string[] | undefined>;
+        query: Record<string, unknown>;
+    };
+};
+/**
+ * Yield this from a webhook handler to control the HTTP response
+ * (URL challenges, signature failures, provider-specific acks).
+ */
+export type WebhookHttpResponseEvent = BaseEvent & {
+    type: "action:webhook:http-response";
+    data: {
+        status: number;
+        body?: unknown;
+        headers?: Record<string, string>;
+    };
+};
 /**
  * Narrow event union for common plugin authoring paths.
  * The host bus accepts additional event types at runtime.
  */
-export type PluginEvent = AgentInvokeEvent | AgentOutputEvent | UIWidgetEvent | UIWidgetResponseEvent | ToolActionEvent | ToolResultEvent;
+export type PluginEvent = AgentInvokeEvent | AgentOutputEvent | UIWidgetEvent | UIWidgetResponseEvent | ToolActionEvent | ToolResultEvent | WebhookEvent | WebhookHttpResponseEvent;
 export type OpenBotEvent = PluginEvent | (BaseEvent & {
     data?: unknown;
 });
 export type ShortTermMessage = {
-    role: 'system';
+    role: "system";
     content: string;
 } | {
-    role: 'user';
+    role: "user";
     content: string;
 } | {
-    role: 'assistant';
+    role: "assistant";
     content: string;
     toolCalls?: unknown[];
 } | {
-    role: 'tool';
+    role: "tool";
     content: string;
     toolCallId: string;
     toolName: string;

package/dist/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAgB,MAAM,SAAS,CAAC;AAEhE,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,IAAI,EAAE,SAAS,GAAG;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG;IACtC,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,SAAS,GAAG;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG;IAC9C,IAAI,EAAE,2BAA2B,CAAC;IAClC,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,0EAA0E;AAC1E,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IAAI,SAAS,GAAG;IACzD,IAAI,EAAE,UAAU,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IAAI,SAAS,GAAG;IACzD,IAAI,EAAE,UAAU,MAAM,SAAS,CAAC;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,qBAAqB,GACrB,eAAe,GACf,eAAe,CAAC;AAEpB,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,CAAC,SAAS,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE1E,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACxC"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAgB,MAAM,SAAS,CAAC;AAEhE,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG;IACzC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,IAAI,EAAE,SAAS,GAAG;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG;IACtC,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE,SAAS,GAAG;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG;IAC9C,IAAI,EAAE,2BAA2B,CAAC;IAClC,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,0EAA0E;AAC1E,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IAAI,SAAS,GAAG;IACzD,IAAI,EAAE,UAAU,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IAAI,SAAS,GAAG;IACzD,IAAI,EAAE,UAAU,MAAM,SAAS,CAAC;IAChC,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG;IACrC,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,mFAAmF;QACnF,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;QACvD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAChC,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG;IACjD,IAAI,EAAE,8BAA8B,CAAC;IACrC,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,qBAAqB,GACrB,eAAe,GACf,eAAe,GACf,YAAY,GACZ,wBAAwB,CAAC;AAE7B,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,CAAC,SAAS,GAAG;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE1E,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;CAAE,GAC7D;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5E,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACxC"}

package/dist/helpers.d.ts

@@ -1,5 +1,5 @@
-import type { AgentInvokeEvent, AgentOutputEvent, EventMeta, ToolResultEvent, UIWidgetEvent } from './events.js';
-import type { RenderUIWidgetData } from './ui.js';
+import type { AgentInvokeEvent, AgentOutputEvent, EventMeta, ToolResultEvent, UIWidgetEvent, WebhookEvent, WebhookHttpResponseEvent } from "./events.js";
+import type { RenderUIWidgetData } from "./ui.js";
 /** Return true when this agent should handle an `agent:invoke` event. */
 export declare function shouldHandleInvoke(event: AgentInvokeEvent, agentId: string): boolean;
 /** Build an `agent:output` event. */
@@ -28,4 +28,14 @@ export declare function withMeta<T extends {
 }, event: T): T & {
     meta?: EventMeta;
 };
+/** Decode `action:webhook` raw body bytes from base64. */
+export declare function decodeWebhookRawBody(event: WebhookEvent): Buffer;
+/** Read a single header value from a webhook event (case-insensitive). */
+export declare function getWebhookHeader(event: WebhookEvent, name: string): string | undefined;
+/** Build an `action:webhook:http-response` event for the host HTTP reply. */
+export declare function webhookHttpResponse(args: {
+    status: number;
+    body?: unknown;
+    headers?: Record<string, string>;
+}): WebhookHttpResponseEvent;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,aAAa,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,kBAAkB,EAAG,MAAM,SAAS,CAAC;AAEnD,yEAAyE;AACzE,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAGpF;AAED,qCAAqC;AACrC,wBAAgB,WAAW,CAAC,IAAI,EAAE;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,GAAG,gBAAgB,CAUnB;AAED,+EAA+E;AAC/E,wBAAgB,UAAU,CAAC,KAAK,EAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EAC7B,IAAI,EAAE,KAAK,GACV,eAAe,CAAC,KAAK,CAAC,CAMxB;AAED,wCAAwC;AACxC,wBAAgB,QAAQ,CAAC,IAAI,EAAE;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,GAAG,aAAa,CAUhB;AAED,oEAAoE;AACpE,wBAAgB,QAAQ,CAAC,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EACrD,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EAC5B,KAAK,EAAE,CAAC,GACP,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAS1B"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACT,eAAe,EACf,aAAa,EACb,YAAY,EACZ,wBAAwB,EACzB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,yEAAyE;AACzE,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,MAAM,GACd,OAAO,CAGT;AAED,qCAAqC;AACrC,wBAAgB,WAAW,CAAC,IAAI,EAAE;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,GAAG,gBAAgB,CAUnB;AAED,+EAA+E;AAC/E,wBAAgB,UAAU,CAAC,KAAK,EAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EAC7B,IAAI,EAAE,KAAK,GACV,eAAe,CAAC,KAAK,CAAC,CAMxB;AAED,wCAAwC;AACxC,wBAAgB,QAAQ,CAAC,IAAI,EAAE;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB,GAAG,aAAa,CAUhB;AAED,oEAAoE;AACpE,wBAAgB,QAAQ,CAAC,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EACrD,MAAM,EAAE;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,EAC5B,KAAK,EAAE,CAAC,GACP,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAS1B;AAED,0DAA0D;AAC1D,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,CAEhE;AAED,0EAA0E;AAC1E,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,YAAY,EACnB,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAKpB;AAED,6EAA6E;AAC7E,wBAAgB,mBAAmB,CAAC,IAAI,EAAE;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,GAAG,wBAAwB,CAK3B"}

package/dist/helpers.js

@@ -1,12 +1,12 @@
 /** Return true when this agent should handle an `agent:invoke` event. */
 export function shouldHandleInvoke(event, agentId) {
     const routedTo = event.data?.agentId;
-    return !(typeof routedTo === 'string' && routedTo && routedTo !== agentId);
+    return !(typeof routedTo === "string" && routedTo && routedTo !== agentId);
 }
 /** Build an `agent:output` event. */
 export function agentOutput(args) {
     return {
-        type: 'agent:output',
+        type: "agent:output",
         data: { content: args.content },
         meta: {
             ...(args.meta ?? {}),
@@ -26,7 +26,7 @@ export function toolResult(toolName, request, data) {
 /** Build a `client:ui:widget` event. */
 export function uiWidget(args) {
     return {
-        type: 'client:ui:widget',
+        type: "client:ui:widget",
         data: args.widget,
         meta: {
             ...(args.meta ?? {}),
@@ -47,4 +47,23 @@ export function withMeta(source, event) {
         },
     };
 }
+/** Decode `action:webhook` raw body bytes from base64. */
+export function decodeWebhookRawBody(event) {
+    return Buffer.from(event.data.rawBody, "base64");
+}
+/** Read a single header value from a webhook event (case-insensitive). */
+export function getWebhookHeader(event, name) {
+    const headers = event.data.headers;
+    const direct = headers[name] ?? headers[name.toLowerCase()];
+    if (Array.isArray(direct))
+        return direct[0];
+    return typeof direct === "string" ? direct : undefined;
+}
+/** Build an `action:webhook:http-response` event for the host HTTP reply. */
+export function webhookHttpResponse(args) {
+    return {
+        type: "action:webhook:http-response",
+        data: args,
+    };
+}
 //# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AASA,yEAAyE;AACzE,MAAM,UAAU,kBAAkB,CAAC,KAAuB,EAAE,OAAe;IACzE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC;IACrC,OAAO,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC;AAC7E,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,WAAW,CAAC,IAK3B;IACC,OAAO;QACL,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;QAC/B,IAAI,EAAE;YACJ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD;KACF,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,UAAU,CACxB,QAAgB,EAChB,OAA6B,EAC7B,IAAW;IAEX,OAAO;QACL,IAAI,EAAE,UAAU,QAAQ,SAAS;QACjC,IAAI;QACJ,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC;AACJ,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,QAAQ,CAAC,IAKxB;IACC,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,IAAI,EAAE;YACJ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD;KACF,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,QAAQ,CACtB,MAA4B,EAC5B,KAAQ;IAER,IAAI,CAAC,MAAM,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAC/B,OAAO;QACL,GAAG,KAAK;QACR,IAAI,EAAE;YACJ,GAAG,MAAM,CAAC,IAAI;YACd,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;SACtB;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAWA,yEAAyE;AACzE,MAAM,UAAU,kBAAkB,CAChC,KAAuB,EACvB,OAAe;IAEf,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC;IACrC,OAAO,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC;AAC7E,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,WAAW,CAAC,IAK3B;IACC,OAAO;QACL,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;QAC/B,IAAI,EAAE;YACJ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD;KACF,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,UAAU,CACxB,QAAgB,EAChB,OAA6B,EAC7B,IAAW;IAEX,OAAO;QACL,IAAI,EAAE,UAAU,QAAQ,SAAS;QACjC,IAAI;QACJ,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC;AACJ,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,QAAQ,CAAC,IAKxB;IACC,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,IAAI,EAAE;YACJ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD;KACF,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,QAAQ,CACtB,MAA4B,EAC5B,KAAQ;IAER,IAAI,CAAC,MAAM,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IAC/B,OAAO;QACL,GAAG,KAAK;QACR,IAAI,EAAE;YACJ,GAAG,MAAM,CAAC,IAAI;YACd,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;SACtB;KACF,CAAC;AACJ,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,oBAAoB,CAAC,KAAmB;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,gBAAgB,CAC9B,KAAmB,EACnB,IAAY;IAEZ,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC5C,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,mBAAmB,CAAC,IAInC;IACC,OAAO;QACL,IAAI,EAAE,8BAA8B;QACpC,IAAI,EAAE,IAAI;KACX,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meetopenbot/plugin-sdk",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Types and helpers for building OpenBot plugins on the event bus.",
   "type": "module",
   "main": "./dist/index.js",