@camerontaylor/paseo-client 0.8.0-fork.1

package/dist/terminals/index.d.ts

@@ -0,0 +1,69 @@
+import { z } from "zod";
+import type { DaemonClient } from "../daemon-client.js";
+declare const TerminalSchema: z.ZodObject<{
+    id: z.ZodString;
+    workspaceId: z.ZodString;
+    cwd: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+export type PaseoTerminal = z.infer<typeof TerminalSchema>;
+export interface PaseoTerminalCreateOptions {
+    workspaceId: string;
+    /** Process working directory; defaults to the workspace directory. */
+    cwd?: string;
+    name?: string;
+    command?: string;
+    args?: string[];
+    size?: {
+        rows: number;
+        cols: number;
+    };
+    requestId?: string;
+}
+export interface PaseoTerminalListOptions {
+    /** Ownership filter. When supplied, cwd does not restrict the results. */
+    workspaceId?: string;
+    /** Workspace root directory filter for unscoped listings. */
+    cwd?: string;
+    requestId?: string;
+}
+export interface PaseoTerminalListResult {
+    entries: PaseoTerminal[];
+    requestId: string;
+}
+export interface PaseoTerminalCaptureOptions {
+    start?: number;
+    end?: number;
+    stripAnsi?: boolean;
+    requestId?: string;
+}
+export type PaseoTerminalCaptureResult = Awaited<ReturnType<DaemonClient["captureTerminal"]>>;
+export interface PaseoTerminalHandle {
+    readonly id: string;
+    current(): PaseoTerminal | null;
+    refresh(options?: {
+        requestId?: string;
+    }): Promise<PaseoTerminal | null>;
+    /** Sends literal input and returns its UTF-16 length. Does not await command execution. */
+    write(data: string): number;
+    /** Expands CLI key tokens; other strings are literal. Returns the input's UTF-16 length. */
+    sendKeys(keys: readonly string[]): number;
+    capture(options?: PaseoTerminalCaptureOptions): Promise<PaseoTerminalCaptureResult>;
+    kill(requestId?: string): Promise<void>;
+}
+export interface PaseoTerminalActions {
+    create(options: PaseoTerminalCreateOptions): Promise<PaseoTerminalHandle>;
+    list(options?: PaseoTerminalListOptions): Promise<PaseoTerminalListResult>;
+    ref(terminal: string | PaseoTerminal): PaseoTerminalHandle;
+}
+export interface PaseoWorkspaceTerminalActions {
+    create(options?: Omit<PaseoTerminalCreateOptions, "workspaceId">): Promise<PaseoTerminalHandle>;
+    list(options?: {
+        requestId?: string;
+    }): Promise<PaseoTerminalListResult>;
+}
+type TerminalClient = Pick<DaemonClient, "ensureConnected" | "getLastServerInfoMessage" | "createTerminal" | "listTerminals" | "sendTerminalInput" | "captureTerminal" | "killTerminal">;
+/** @package */
+export declare function createTerminalActions(daemonClient: TerminalClient, resolveWorkspaceDirectory: (workspaceId: string) => Promise<string>): PaseoTerminalActions;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/terminals/index.js

@@ -0,0 +1,103 @@
+import { z } from "zod";
+const TerminalSchema = z.object({
+    id: z.string(),
+    workspaceId: z.string(),
+    cwd: z.string(),
+    name: z.string(),
+});
+/** @package */
+export function createTerminalActions(daemonClient, resolveWorkspaceDirectory) {
+    function client() {
+        daemonClient.ensureConnected();
+        // COMPAT(workspaceTerminals): added in v0.7.3, remove gate after 2027-09-05.
+        if (daemonClient.getLastServerInfoMessage()?.features?.workspaceTerminals !== true) {
+            throw new Error("Update the host to use workspace terminals through the SDK.");
+        }
+        return daemonClient;
+    }
+    const list = async (options = {}) => {
+        const result = await client().listTerminals(options.cwd, options.requestId, {
+            workspaceId: options.workspaceId,
+        });
+        return {
+            entries: result.terminals.map((terminal) => TerminalSchema.parse(terminal)),
+            requestId: result.requestId,
+        };
+    };
+    const ref = (terminal) => {
+        const id = typeof terminal === "string" ? terminal : terminal.id;
+        let current = typeof terminal === "string" ? null : terminal;
+        const write = (data) => {
+            client().sendTerminalInput(id, { type: "input", data });
+            return data.length;
+        };
+        return {
+            id,
+            current: () => current,
+            refresh: async (options) => {
+                const result = await list(options);
+                current = result.entries.find((entry) => entry.id === id) ?? null;
+                return current;
+            },
+            write,
+            sendKeys: (keys) => write(keys.map(resolveKeyToken).join("")),
+            capture: (options = {}) => {
+                const { requestId, ...captureOptions } = options;
+                return client().captureTerminal(id, captureOptions, requestId);
+            },
+            kill: async (requestId) => {
+                const result = await client().killTerminal(id, requestId);
+                if (!result.success)
+                    throw new Error(`Failed to kill terminal ${id}`);
+                current = null;
+            },
+        };
+    };
+    return {
+        create: async ({ workspaceId, cwd, name, requestId, ...options }) => {
+            const driver = client();
+            if (!workspaceId)
+                throw new Error("workspaceId is required");
+            const directory = cwd ?? (await resolveWorkspaceDirectory(workspaceId));
+            const result = await driver.createTerminal(directory, name, requestId, {
+                ...options,
+                workspaceId,
+            });
+            if (result.error || !result.terminal) {
+                throw new Error(result.error ?? "The daemon did not create a terminal");
+            }
+            return ref(TerminalSchema.parse(result.terminal));
+        },
+        list,
+        ref,
+    };
+}
+function resolveKeyToken(key) {
+    switch (key) {
+        case "Enter":
+            return "\r";
+        case "Tab":
+            return "\t";
+        case "Escape":
+            return "\u001b";
+        case "Space":
+            return " ";
+        case "BSpace":
+            return "\u007f";
+        case "C-c":
+            return "\u0003";
+        case "C-d":
+            return "\u0004";
+        case "C-z":
+            return "\u001a";
+        case "C-l":
+            return "\u000c";
+        case "C-a":
+            return "\u0001";
+        case "C-e":
+            return "\u0005";
+        default:
+            return key;
+    }
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@camerontaylor/paseo-client",
+  "version": "0.8.0-fork.1",
+  "description": "Paseo client SDK package",
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./internal/daemon-client": {
+      "types": "./dist/daemon-client.d.ts",
+      "default": "./dist/daemon-client.js"
+    },
+    "./internal/daemon-client-transport-types": {
+      "types": "./dist/daemon-client-transport-types.d.ts",
+      "default": "./dist/daemon-client-transport-types.js"
+    },
+    "./internal/daemon-client-websocket-transport": {
+      "types": "./dist/daemon-client-websocket-transport.d.ts",
+      "default": "./dist/daemon-client-websocket-transport.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "node ../../scripts/clean-package-dist.mjs",
+    "build": "npm run build --workspace=@camerontaylor/paseo-protocol && tsc -p tsconfig.json --incremental false",
+    "build:clean": "npm run clean && npm run build",
+    "prepack": "npm run build:clean",
+    "typecheck": "tsgo --noEmit",
+    "typecheck:examples": "tsgo -p tsconfig.examples.json --noEmit",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@camerontaylor/paseo-protocol": "0.8.0-fork.1",
+    "@camerontaylor/paseo-relay": "0.8.0-fork.1",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0",
+    "typescript": "^5.2.2",
+    "vitest": "^4.1.6"
+  }
+}