@sayknow-cli/bridge-client 0.4.1 → 0.4.3

package/dist/types/client.d.ts

@@ -0,0 +1,44 @@
+export type SdkErrorCode = "invalid_input" | "unknown_operation" | "not_found" | "unavailable" | "timeout" | "connection_closed" | "endpoint_credential_forbidden" | (string & {});
+export declare class SdkClientError extends Error {
+    readonly code: SdkErrorCode;
+    readonly details: unknown;
+    constructor(code: SdkErrorCode, message: string, details?: unknown);
+}
+export interface SdkClientOptions {
+    timeoutMs?: number;
+    /** Absolute wall-clock deadline shared by connect, hello, retry, and request work. */
+    deadline?: number;
+    reconnectAttempts?: number;
+    reconnectBackoffMs?: number;
+}
+export interface SdkRequestOptions {
+    timeoutMs?: number;
+    idempotencyKey?: string;
+    confirm?: boolean;
+}
+export type SdkFrame = Record<string, unknown>;
+export type SdkFrameHandler = (frame: SdkFrame) => void;
+export type SdkReconnectHandler = () => void;
+export type SdkReconnectFailedHandler = (error: SdkClientError) => void;
+/** A transport-only v3 SDK WebSocket client with no host or session authority. */
+export declare class SdkClient {
+    #private;
+    connectionId?: string;
+    constructor(url: string, token: string, options?: SdkClientOptions);
+    static connect(url: string, token: string, options?: SdkClientOptions): Promise<SdkClient>;
+    connect(): Promise<void>;
+    /** Resolves once the current WebSocket has received its server hello frame. */
+    awaitHello(): Promise<void>;
+    onFrame(handler: SdkFrameHandler): () => void;
+    onReconnect(handler: SdkReconnectHandler): () => void;
+    onReconnectFailed(handler: SdkReconnectFailedHandler): () => void;
+    send(frame: SdkFrame): void;
+    request(frame: SdkFrame, timeout?: number | {
+        timeoutMs?: number;
+        idempotencyKey?: string;
+    }): Promise<SdkFrame>;
+    close(): Promise<void>;
+    control(operation: string, input?: Record<string, unknown>, options?: SdkRequestOptions): Promise<unknown>;
+    query(query: string, input?: Record<string, unknown>, cursor?: string, options?: SdkRequestOptions): Promise<unknown>;
+    global(operation: string, input?: Record<string, unknown>, options?: SdkRequestOptions): Promise<unknown>;
+}

package/dist/types/commands.d.ts

@@ -0,0 +1,62 @@
+export declare const BRIDGE_CLIENT_COMMAND_TYPES: readonly ["prompt", "steer", "follow_up", "abort", "abort_and_prompt", "new_session", "get_state", "set_todos", "set_host_tools", "set_host_uri_schemes", "get_pending_workflow_gates", "set_capabilities", "workflow_gate_response", "set_model", "set_default_model_selection", "cycle_model", "get_available_models", "set_thinking_level", "cycle_thinking_level", "set_steering_mode", "set_follow_up_mode", "set_interrupt_mode", "compact", "set_auto_compaction", "set_auto_retry", "abort_retry", "bash", "abort_bash", "get_session_stats", "export_html", "switch_session", "branch", "get_branch_messages", "get_last_assistant_text", "set_session_name", "handoff", "get_messages", "get_login_providers", "login", "negotiate_unattended"];
+export type BridgeClientCommandType = (typeof BRIDGE_CLIENT_COMMAND_TYPES)[number];
+export type BridgeClientCommand<TType extends BridgeClientCommandType = BridgeClientCommandType> = {
+    id?: string;
+    type: TType;
+} & Record<string, unknown>;
+export interface BridgeCommandOptions {
+    id?: string;
+    idempotencyKey?: string;
+}
+export interface BridgeImageCommandOptions extends BridgeCommandOptions {
+    images?: unknown[];
+}
+export interface BridgeCommandHelpers {
+    prompt(sessionId: string, message: string, options?: BridgeImageCommandOptions & {
+        streamingBehavior?: "steer" | "followUp";
+    }): Promise<unknown>;
+    steer(sessionId: string, message: string, options?: BridgeImageCommandOptions): Promise<unknown>;
+    followUp(sessionId: string, message: string, options?: BridgeImageCommandOptions): Promise<unknown>;
+    abort(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    abortAndPrompt(sessionId: string, message: string, options?: BridgeImageCommandOptions): Promise<unknown>;
+    newSession(sessionId: string, options?: BridgeCommandOptions & {
+        parentSession?: string;
+    }): Promise<unknown>;
+    getState(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    setTodos(sessionId: string, phases: unknown[], options?: BridgeCommandOptions): Promise<unknown>;
+    setHostTools(sessionId: string, tools: unknown[], options?: BridgeCommandOptions): Promise<unknown>;
+    setHostUriSchemes(sessionId: string, schemes: unknown[], options?: BridgeCommandOptions): Promise<unknown>;
+    getPendingWorkflowGates(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    setModel(sessionId: string, provider: string, modelId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    cycleModel(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    getAvailableModels(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    setThinkingLevel(sessionId: string, level: string, options?: BridgeCommandOptions): Promise<unknown>;
+    cycleThinkingLevel(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    setSteeringMode(sessionId: string, mode: "all" | "one-at-a-time", options?: BridgeCommandOptions): Promise<unknown>;
+    setFollowUpMode(sessionId: string, mode: "all" | "one-at-a-time", options?: BridgeCommandOptions): Promise<unknown>;
+    setInterruptMode(sessionId: string, mode: "immediate" | "wait", options?: BridgeCommandOptions): Promise<unknown>;
+    compact(sessionId: string, options?: BridgeCommandOptions & {
+        customInstructions?: string;
+    }): Promise<unknown>;
+    setAutoCompaction(sessionId: string, enabled: boolean, options?: BridgeCommandOptions): Promise<unknown>;
+    setAutoRetry(sessionId: string, enabled: boolean, options?: BridgeCommandOptions): Promise<unknown>;
+    abortRetry(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    bash(sessionId: string, command: string, options?: BridgeCommandOptions): Promise<unknown>;
+    abortBash(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    getSessionStats(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    exportHtml(sessionId: string, options?: BridgeCommandOptions & {
+        outputPath?: string;
+    }): Promise<unknown>;
+    switchSession(sessionId: string, sessionPath: string, options?: BridgeCommandOptions): Promise<unknown>;
+    branch(sessionId: string, entryId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    getBranchMessages(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    getLastAssistantText(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    setSessionName(sessionId: string, name: string, options?: BridgeCommandOptions): Promise<unknown>;
+    handoff(sessionId: string, options?: BridgeCommandOptions & {
+        customInstructions?: string;
+    }): Promise<unknown>;
+    getMessages(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    getLoginProviders(sessionId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    login(sessionId: string, providerId: string, options?: BridgeCommandOptions): Promise<unknown>;
+    respondGate(sessionId: string, gateId: string, ownerToken: string, answer: unknown, options?: BridgeCommandOptions): Promise<unknown>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/dist/types/reference-consumer.d.ts

@@ -0,0 +1,20 @@
+export interface BridgeFrame<TPayload = unknown> {
+    protocol_version: number;
+    session_id: string;
+    seq: number;
+    frame_id: string;
+    correlation_id?: string;
+    type: string;
+    payload: TPayload;
+}
+export interface RenderedBridgeFrame {
+    seq: number;
+    type: string;
+    html: string;
+}
+export declare function renderBridgeFrame(frame: BridgeFrame): RenderedBridgeFrame;
+export declare class ReferenceBridgeConsumer {
+    #private;
+    consume(frame: BridgeFrame): RenderedBridgeFrame;
+    renderDocument(): string;
+}

package/dist/types/workflow-gate.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Typed `workflow_gate` client helpers (#322).
+ *
+ * Mirrors the server-side workflow-gate contract for bridge consumers: a typed
+ * gate frame, the response shape, a frame type-guard, and a headless policy that
+ * routes received gates to an agent callback and posts answers back through the
+ * existing owner-token ui-response flow.
+ */
+import type { BridgeFrame } from "./reference-consumer";
+export type WorkflowGateStage = "deep-interview" | "ralplan" | "ultragoal";
+export type WorkflowGateKind = "question" | "approval" | "execution";
+export interface WorkflowGateOption {
+    value: unknown;
+    label: string;
+    description?: string;
+}
+export interface WorkflowGate {
+    type: "workflow_gate";
+    gate_id: string;
+    stage: WorkflowGateStage;
+    kind: WorkflowGateKind;
+    schema: unknown;
+    schema_hash: string;
+    options?: WorkflowGateOption[];
+    context: Record<string, unknown>;
+    created_at: string;
+    required: true;
+}
+export interface WorkflowGateResponse {
+    gate_id: string;
+    answer: unknown;
+    idempotency_key?: string;
+}
+/** Unattended declaration carried on the bridge handshake (#318/#319). */
+export interface UnattendedDeclaration {
+    actor: string;
+    budget: {
+        max_tokens: number;
+        max_tool_calls: number;
+        max_wall_time_ms: number;
+        max_cost_usd: number;
+    };
+    scopes: string[];
+    action_allowlist: string[];
+}
+/** Type guard: is this bridge frame a fully-formed workflow_gate frame? */
+export declare function isWorkflowGateFrame(frame: BridgeFrame): frame is BridgeFrame<WorkflowGate>;
+/** A callback that produces an answer for a received gate (the agent's "memory"). */
+export type WorkflowGateResolver = (gate: WorkflowGate) => unknown | Promise<unknown>;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"type": "module",
 	"name": "@sayknow-cli/bridge-client",
-	"version": "0.4.1",
+	"version": "0.4.3",
 	"description": "Transport-only v3 SDK WebSocket client",
 	"homepage": "https://sayknow-cli.com",
 	"author": "jaybeyond and Sayknow-CLI Contributors",
@@ -21,7 +21,7 @@
 		"client"
 	],
 	"main": "./src/index.ts",
-	"types": "./src/index.ts",
+	"types": "./dist/types/index.d.ts",
 	"scripts": {
 		"check": "biome check . && bun run check:types",
 		"check:types": "tsc -p tsconfig.json --noEmit",
@@ -37,11 +37,12 @@
 		"bun": ">=1.3.14"
 	},
 	"files": [
-		"src"
+		"src",
+		"dist/types"
 	],
 	"exports": {
 		".": {
-			"types": "./src/index.ts",
+			"types": "./dist/types/index.d.ts",
 			"import": "./src/index.ts"
 		}
 	}