@smooai/smooth-extension-sdk 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smooai/smooth-extension-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "TypeScript SDK for building Smooth Extension Protocol (SEP) extensions: `defineExtension`, `defineTool`, a stdio JSON-RPC transport, an in-process test host, and a conformance runner. Extensions are subprocesses speaking JSON-RPC 2.0 ndjson to any SEP host (smooth-operator-core and its polyglot servers).",
   "license": "MIT",
   "type": "module",

package/src/extension.ts

@@ -12,10 +12,14 @@
  */
 import { Peer } from './jsonrpc.js';
 import { PROTOCOL_VERSION, method } from './protocol.js';
-import type { Context, EventParams, InitializeParams, InitializeResult, ToolExecuteParams, ToolExecuteResult, ToolUpdateParams } from './protocol.js';
+import type { Context, EventParams, HookOutcome, HookParams, InitializeParams, InitializeResult, ToolExecuteParams, ToolExecuteResult, ToolUpdateParams } from './protocol.js';
 import { toJsonSchema, type ParameterSchema } from './schema.js';
 import { stdioTransport, type Transport } from './transport.js';
 
+/** The intercept hooks (awaited, host-orchestrated); every other `on(...)` name
+ *  is a fire-and-forget observe event. Kept in sync with the engine's HookType. */
+const HOOK_NAMES = new Set(['tool_call', 'tool_result', 'before_agent_start', 'message_end', 'context', 'before_provider_request', 'input', 'user_bash']);
+
 /** Progress + cancellation handed to a tool while it runs. */
 export interface ToolContext {
     /** Correlates `onUpdate` calls with this execution. */
@@ -44,8 +48,14 @@ export function defineTool<TArgs = Record<string, unknown>>(def: ToolDef<TArgs>)
     return def;
 }
 
-/** Handler for an observe `event`. Fire-and-forget; return value ignored. */
-export type EventHandler = (payload: Record<string, unknown> | undefined, ctx: Context) => void | Promise<void>;
+/** A hook handler's friendly return: veto the operation, or replace its input
+ *  with a patch (shallow-merged onto the input). Returning nothing = continue. */
+export type HookResult = { block: true; reason?: string } | { patch: Record<string, unknown> };
+
+/** Handler for an `on(name, ...)` registration. For an observe event the return
+ *  is ignored; for an intercept hook (see {@link HOOK_NAMES}) return a
+ *  {@link HookResult} to veto or patch. Mirrors pi's single `on`. */
+export type EventHandler = (data: Record<string, unknown> | undefined, ctx: Context) => void | HookResult | Promise<void | HookResult>;
 
 /** The builder passed to `defineExtension`'s setup. Mirrors pi's `ExtensionAPI`. */
 export interface SmoothApi {
@@ -114,6 +124,7 @@ export class Extension {
             return {};
         });
         peer.setRequestHandler(method.TOOL_EXECUTE, (params, signal) => this.executeTool(params as ToolExecuteParams, peer, signal));
+        peer.setRequestHandler(method.HOOK, (params) => this.dispatchHook(params as HookParams));
         peer.setNotificationHandler(method.EVENT, (params) => this.dispatchEvent(params as EventParams));
 
         transport.start((frame) => peer.receive(frame));
@@ -141,10 +152,13 @@ export class Extension {
             parameters: toJsonSchema(t.parameters),
             ...(t.deferred ? { deferred: true } : {}),
         }));
+        // Only observe events go in `subscriptions` — hook names are intercepts
+        // the host always calls, not events it filters by subscription.
+        const subscriptions = [...this.events.keys()].filter((name) => !HOOK_NAMES.has(name));
         return {
             protocol_version: PROTOCOL_VERSION,
             extension: { name: this.name, version: this.version },
-            registrations: { tools, subscriptions: [...this.events.keys()] },
+            registrations: { tools, subscriptions },
         };
     }
 
@@ -166,6 +180,23 @@ export class Extension {
             void handler(params.payload, params.context);
         }
     }
+
+    /** Fold this extension's handlers for one `hook` into a single outcome: the
+     *  first `block` short-circuits; `patch`es shallow-merge onto the input and
+     *  thread to the next handler; no result = continue. The host chains the
+     *  outcome across extensions in load order. */
+    private async dispatchHook(params: HookParams): Promise<HookOutcome> {
+        let input = params.input;
+        let modified = false;
+        for (const handler of this.events.get(params.hook) ?? []) {
+            const result = await handler(input, params.context);
+            if (!result) continue;
+            if ('block' in result) return { action: 'block', ...(result.reason ? { reason: result.reason } : {}) };
+            input = { ...input, ...result.patch };
+            modified = true;
+        }
+        return modified ? { action: 'modify', patch: input } : { action: 'continue' };
+    }
 }
 
 /** Define an extension. Set `smooth.name`/`smooth.version` and register tools. */

package/src/index.ts

@@ -9,7 +9,7 @@
  * `runConformance`.
  */
 export { defineExtension, defineTool, Extension } from './extension.js';
-export type { ExtensionSetup, SmoothApi, ToolDef, ToolContext, ToolReturn, EventHandler, ConnectHandle } from './extension.js';
+export type { ExtensionSetup, SmoothApi, ToolDef, ToolContext, ToolReturn, EventHandler, HookResult, ConnectHandle } from './extension.js';
 export { createTestHost } from './test-host.js';
 export type { TestHost, CallToolOptions } from './test-host.js';
 export { runConformance, DEFAULT_SPEC_DIR } from './conformance.js';
@@ -31,4 +31,6 @@ export type {
     ToolExecuteResult,
     ToolUpdateParams,
     EventParams,
+    HookParams,
+    HookOutcome,
 } from './protocol.js';

package/src/protocol.ts

@@ -112,6 +112,21 @@ export interface ToolUpdateParams {
 
 export interface EventParams {
     event: string;
+    /** Per-connection monotonic sequence; absent on the `events_lost` marker. */
+    seq?: number;
     context: Context;
     payload?: Record<string, unknown>;
 }
+
+/** Host → ext `hook` request: an awaited intercept the extension can veto/patch. */
+export interface HookParams {
+    hook: string;
+    context: Context;
+    input: Record<string, unknown>;
+}
+
+/** The extension's reply to a `hook`, tagged by `action`. */
+export type HookOutcome =
+    | { action: 'continue' }
+    | { action: 'block'; reason?: string }
+    | { action: 'modify'; patch: Record<string, unknown> };

package/src/test-host.ts

@@ -7,7 +7,7 @@
  */
 import { Peer } from './jsonrpc.js';
 import { PROTOCOL_VERSION, method } from './protocol.js';
-import type { Context, InitializeParams, InitializeResult, ToolExecuteResult, ToolUpdateParams } from './protocol.js';
+import type { Context, HookOutcome, InitializeParams, InitializeResult, ToolExecuteResult, ToolUpdateParams } from './protocol.js';
 import type { Extension } from './extension.js';
 import { linkedPair } from './transport.js';
 
@@ -25,6 +25,8 @@ export interface CallToolOptions {
 export interface TestHost {
     initialize(overrides?: Partial<InitializeParams>): Promise<InitializeResult>;
     callTool(tool: string, args: Record<string, unknown>, opts?: CallToolOptions): Promise<ToolExecuteResult>;
+    /** Drive a `hook` request and get back the extension's folded outcome. */
+    callHook(hook: string, input: Record<string, unknown>, context?: Context): Promise<HookOutcome>;
     ping(): Promise<Record<string, unknown>>;
     sendEvent(event: string, payload?: Record<string, unknown>, context?: Context): void;
     shutdown(): Promise<void>;
@@ -74,6 +76,9 @@ export function createTestHost(extension: Extension): TestHost {
                 updateSinks.delete(call_id);
             }
         },
+        callHook(hook, input, context) {
+            return host.request<HookOutcome>(method.HOOK, { hook, input, context: context ?? DEFAULT_CONTEXT });
+        },
         ping() {
             return host.request<Record<string, unknown>>(method.PING, {});
         },