@gizmo-ai/client 0.2.2

package/dist/subscribe.d.ts

@@ -0,0 +1,18 @@
+/**
+ * SSE Subscription
+ *
+ * Opens an EventSource to the agent's stream endpoint, maintains local state,
+ * applies JSON Patches (RFC 6902), and calls back with the full patched state
+ * plus the triggering event.
+ */
+import type { SubscribeCallback, SubscribeOptions, Unsubscribe } from "./types.ts";
+/**
+ * Subscribe to an agent's SSE stream.
+ *
+ * Maintains a local state object, applies incoming patches, and fires
+ * the callback with a consistent snapshot after every event.
+ *
+ * @returns An unsubscribe function that closes the EventSource.
+ */
+export declare function subscribe(baseUrl: string, callback: SubscribeCallback, options?: SubscribeOptions): Unsubscribe;
+//# sourceMappingURL=subscribe.d.ts.map

package/dist/subscribe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscribe.d.ts","sourceRoot":"","sources":["../src/subscribe.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAOV,iBAAiB,EACjB,gBAAgB,EAChB,WAAW,EACZ,MAAM,YAAY,CAAC;AAEpB;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,CAAC,EAAE,gBAAgB,GACzB,WAAW,CAqDb"}

package/dist/types.d.ts

@@ -0,0 +1,218 @@
+/**
+ * @gizmo-ai/client — Standalone type definitions
+ *
+ * All types are redeclared here — no imports from @gizmo-ai/server or @gizmo-ai/runtime.
+ * This keeps the client zero-coupling with the server packages.
+ */
+import type { Operation } from "fast-json-patch";
+export interface GizmoManifest {
+    manifestVersion: string;
+    identity: {
+        agentId: string;
+        name: string;
+        version: string;
+        description?: string;
+        documentationUrl?: string;
+    };
+    auth?: {
+        type?: string;
+        scopes?: string[];
+    };
+    endpoints: {
+        invoke: string;
+        state: string;
+        runs: string;
+        streams: {
+            state: string;
+            actions: string;
+            events: string;
+        };
+        control?: {
+            cancel: string;
+            continue: string;
+        };
+        plugins?: Record<string, string>;
+    };
+    state: {
+        slices: string[];
+        schemaVersion: string;
+        schemaRef?: string;
+        schema?: {
+            type: "object";
+            properties: Record<string, unknown>;
+            $defs?: Record<string, unknown>;
+        };
+    };
+    actions?: {
+        publicContractsRef: string;
+    };
+    capabilities: {
+        tools?: string[];
+        skills?: Array<{
+            name: string;
+            description?: string;
+            source?: string;
+        }>;
+        models?: string[];
+        features?: string[];
+        plugins?: string[];
+    };
+}
+export interface InitialStateEvent {
+    type: "state.initial";
+    slices: Record<string, unknown>;
+    timestamp: number;
+}
+export interface StateUpdateEvent {
+    type: "state.update";
+    slice: string;
+    patches?: Operation[];
+    value?: unknown;
+    cause?: {
+        type: string;
+        id?: string;
+        payload?: unknown;
+    };
+    timestamp: number;
+}
+export interface ExecutionStatusEvent {
+    type: "execution.status";
+    status: "started" | "completed" | "failed" | "aborted" | "interrupted";
+    executionId?: string;
+    turnId?: string;
+    error?: string;
+    timestamp: number;
+}
+export interface HeartbeatEvent {
+    type: "heartbeat";
+    timestamp: number;
+}
+export interface CustomEvent {
+    type: "custom-event";
+    data: unknown;
+    timestamp: number;
+}
+export type SSEEvent = InitialStateEvent | StateUpdateEvent | ExecutionStatusEvent | HeartbeatEvent | CustomEvent;
+export interface InvokeResponse {
+    executionId: string;
+    turnId: string;
+}
+export interface AbortResponse {
+    status: "aborted";
+    executionId: string;
+}
+export interface RunSummary {
+    executionId: string;
+    startTime: number;
+    endTime?: number;
+    status: "running" | "completed" | "failed" | "aborted";
+    actionCount: number;
+    error?: string;
+    digest?: string;
+}
+export interface RunDetails extends RunSummary {
+    actions: Array<{
+        type: string;
+        payload?: unknown;
+    }>;
+}
+export interface RunsResponse {
+    runs: RunSummary[];
+}
+export interface RunListParams {
+    after?: number;
+    before?: number;
+    status?: "running" | "completed" | "failed" | "aborted";
+    limit?: number;
+}
+export interface HydrateOptions {
+    upToSeq?: number;
+    upToTurn?: number;
+    thenExecute?: string;
+    hydrateMode?: "full" | "slim";
+}
+export interface HydrateResponse {
+    status: "hydrated";
+    actionCount: number;
+    state: {
+        conversationLength: number;
+        loopCount: number;
+    };
+    execution?: {
+        executionId: string;
+        turnId: string;
+    };
+}
+export interface HealthResponse {
+    status: "ok";
+}
+export interface DispatchRequest {
+    type: string;
+    payload?: unknown;
+}
+export type ApprovalStatus = "pending" | "approved" | "rejected" | "expired";
+export interface Approval {
+    id: string;
+    executionId: string;
+    toolCall: {
+        name: string;
+        args: Record<string, unknown>;
+    };
+    status: ApprovalStatus;
+    requestedAt: number;
+    expiresAt?: number;
+    decidedAt?: number;
+    reason?: string;
+}
+export interface ApprovalsListResponse {
+    approvals: Approval[];
+}
+export interface ApprovalResponse {
+    approval: Approval;
+}
+export interface HistoryResponse {
+    history: Approval[];
+}
+export interface StateSnapshot {
+    slices: Record<string, unknown>;
+    event: SSEEvent;
+}
+export type SubscribeCallback = (snapshot: StateSnapshot) => void;
+export type Unsubscribe = () => void;
+export interface SubscribeOptions {
+    /** SSE endpoint path (default: "/events") */
+    endpoint?: string;
+}
+export interface ClientOptions {
+    /** Custom fetch implementation (for testing or environments without global fetch) */
+    fetch?: typeof globalThis.fetch;
+    /** Default headers to include on every request (e.g., auth tokens) */
+    headers?: Record<string, string>;
+}
+export interface GizmoClient {
+    discover(): Promise<GizmoManifest>;
+    invoke(input: string): Promise<InvokeResponse>;
+    abort(): Promise<AbortResponse>;
+    state(slice?: string): Promise<unknown>;
+    subscribe(callback: SubscribeCallback, options?: SubscribeOptions): Unsubscribe;
+    health(): Promise<HealthResponse>;
+    dispatch(action: DispatchRequest): Promise<unknown>;
+    runs: {
+        list(params?: RunListParams): Promise<RunSummary[]>;
+        get(executionId: string): Promise<RunDetails>;
+        actions(executionId: string): Promise<RunDetails["actions"]>;
+        cancel(executionId: string): Promise<{
+            status: string;
+            executionId: string;
+        }>;
+        hydrate(executionId: string, options?: HydrateOptions): Promise<HydrateResponse>;
+    };
+    approvals: {
+        list(): Promise<Approval[]>;
+        history(): Promise<Approval[]>;
+        get(id: string): Promise<Approval>;
+        approve(id: string, reason?: string): Promise<Approval>;
+        reject(id: string, reason?: string): Promise<Approval>;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAMjD,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,SAAS,EAAE;QACT,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,CAAC;YAChB,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,OAAO,CAAC,EAAE;YACR,MAAM,EAAE,MAAM,CAAC;YACf,QAAQ,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,CAAC;IACF,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE;YACP,IAAI,EAAE,QAAQ,CAAC;YACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACpC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACjC,CAAC;KACH,CAAC;IACF,OAAO,CAAC,EAAE;QACR,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,YAAY,EAAE;QACZ,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;CACH;AAMD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC;IACvE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,QAAQ,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,cAAc,GACd,WAAW,CAAC;AAMhB,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,SAAS,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,kBAAkB,EAAE,MAAM,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,SAAS,CAAC,EAAE;QACV,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,IAAI,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAMD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC/B,CAAC;IACF,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC;CACrB;AAMD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,KAAK,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,aAAa,KAAK,IAAI,CAAC;AAElE,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC;AAErC,MAAM,WAAW,gBAAgB;IAC/B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD,MAAM,WAAW,aAAa;IAC5B,qFAAqF;IACrF,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IACnC,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC/C,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAChC,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,WAAW,CAAC;IAChF,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpD,IAAI,EAAE;QACJ,IAAI,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACpD,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9C,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7D,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAC9E,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;KAClF,CAAC;IAEF,SAAS,EAAE;QACT,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5B,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/B,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;KACxD,CAAC;CACH"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@gizmo-ai/client",
+  "version": "0.2.2",
+  "description": "Typed SDK for Gizmo agents — discover, invoke, subscribe, and manage runs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js",
+      "types": "./src/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "bun test",
+    "build": "rm -rf dist && bun build src/index.ts --outdir dist --target bun && bun run build:types",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir dist --noEmit false"
+  },
+  "dependencies": {
+    "fast-json-patch": "^3.1.1"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  }
+}