@termlink/protocol 0.1.0

package/dist/items.d.ts

@@ -0,0 +1,224 @@
+import { z } from "zod";
+export declare const ItemStatus: z.ZodEnum<{
+    completed: "completed";
+    declined: "declined";
+    failed: "failed";
+    in_progress: "in_progress";
+    interrupted: "interrupted";
+}>;
+export type ItemStatus = z.infer<typeof ItemStatus>;
+export declare const MessageItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"message">;
+    role: z.ZodEnum<{
+        assistant: "assistant";
+        user: "user";
+    }>;
+    text: z.ZodString;
+}, z.core.$strip>;
+export type MessageItem = z.infer<typeof MessageItem>;
+export declare const ReasoningItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"reasoning">;
+    text: z.ZodString;
+}, z.core.$strip>;
+export type ReasoningItem = z.infer<typeof ReasoningItem>;
+export declare const CommandItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"command">;
+    command: z.ZodString;
+    display: z.ZodOptional<z.ZodString>;
+    cwd: z.ZodOptional<z.ZodString>;
+    output: z.ZodOptional<z.ZodString>;
+    exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export type CommandItem = z.infer<typeof CommandItem>;
+export declare const FileChange: z.ZodObject<{
+    path: z.ZodString;
+    action: z.ZodEnum<{
+        add: "add";
+        delete: "delete";
+        modify: "modify";
+        rename: "rename";
+    }>;
+    movePath: z.ZodOptional<z.ZodString>;
+    diff: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type FileChange = z.infer<typeof FileChange>;
+export declare const FileChangeItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"file_change">;
+    changes: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        action: z.ZodEnum<{
+            add: "add";
+            delete: "delete";
+            modify: "modify";
+            rename: "rename";
+        }>;
+        movePath: z.ZodOptional<z.ZodString>;
+        diff: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type FileChangeItem = z.infer<typeof FileChangeItem>;
+/** Any tool call that is not a shell command or a file edit (MCP, web search, ...). */
+export declare const ToolItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"tool">;
+    name: z.ZodString;
+    input: z.ZodOptional<z.ZodUnknown>;
+    output: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+export type ToolItem = z.infer<typeof ToolItem>;
+export declare const TodoItem: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"todo">;
+    entries: z.ZodArray<z.ZodObject<{
+        text: z.ZodString;
+        done: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TodoItem = z.infer<typeof TodoItem>;
+export declare const Item: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"message">;
+    role: z.ZodEnum<{
+        assistant: "assistant";
+        user: "user";
+    }>;
+    text: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"reasoning">;
+    text: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"command">;
+    command: z.ZodString;
+    display: z.ZodOptional<z.ZodString>;
+    cwd: z.ZodOptional<z.ZodString>;
+    output: z.ZodOptional<z.ZodString>;
+    exitCode: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"file_change">;
+    changes: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        action: z.ZodEnum<{
+            add: "add";
+            delete: "delete";
+            modify: "modify";
+            rename: "rename";
+        }>;
+        movePath: z.ZodOptional<z.ZodString>;
+        diff: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"tool">;
+    name: z.ZodString;
+    input: z.ZodOptional<z.ZodUnknown>;
+    output: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        completed: "completed";
+        declined: "declined";
+        failed: "failed";
+        in_progress: "in_progress";
+        interrupted: "interrupted";
+    }>;
+    kind: z.ZodLiteral<"todo">;
+    entries: z.ZodArray<z.ZodObject<{
+        text: z.ZodString;
+        done: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "kind">;
+export type Item = z.infer<typeof Item>;
+export type ItemKind = Item["kind"];
+/** Which string field an item.delta appends to. */
+export declare const DeltaField: z.ZodEnum<{
+    output: "output";
+    text: "text";
+}>;
+export type DeltaField = z.infer<typeof DeltaField>;
+/** Applies an item.delta to an item. Shared by host and clients so both accumulate the same way. */
+export declare function applyDelta(item: Item, field: DeltaField, delta: string): Item;
+//# sourceMappingURL=items.d.ts.map

package/dist/items.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.d.ts","sourceRoot":"","sources":["../src/items.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,UAAU;;;;;;EAA4E,CAAC;AACpG,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAOpD,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;iBAKtB,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,aAAa;;;;;;;;;;;iBAIxB,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;iBAYtB,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,UAAU;;;;;;;;;;iBAMrB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;iBAIzB,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE5D,uFAAuF;AACvF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;iBAMnB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;iBAInB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAOf,CAAC;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;AACxC,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AAEpC,mDAAmD;AACnD,eAAO,MAAM,UAAU;;;EAA6B,CAAC;AACrD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD,oGAAoG;AACpG,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAQ7E"}

package/dist/items.js

@@ -0,0 +1,76 @@
+import { z } from "zod";
+export const ItemStatus = z.enum(["in_progress", "completed", "failed", "declined", "interrupted"]);
+const itemBase = {
+    id: z.string(),
+    status: ItemStatus,
+};
+export const MessageItem = z.object({
+    ...itemBase,
+    kind: z.literal("message"),
+    role: z.enum(["user", "assistant"]),
+    text: z.string(),
+});
+export const ReasoningItem = z.object({
+    ...itemBase,
+    kind: z.literal("reasoning"),
+    text: z.string(),
+});
+export const CommandItem = z.object({
+    ...itemBase,
+    kind: z.literal("command"),
+    command: z.string(),
+    /**
+     * Short form for the timeline, e.g. without a PowerShell or `sh -lc` wrapper.
+     * Absent when the command is already plain. Approvals always carry the full command.
+     */
+    display: z.string().optional(),
+    cwd: z.string().optional(),
+    output: z.string().optional(),
+    exitCode: z.number().int().nullable().optional(),
+});
+export const FileChange = z.object({
+    path: z.string(),
+    action: z.enum(["add", "modify", "delete", "rename"]),
+    movePath: z.string().optional(),
+    /** Unified diff. Hosts compute it when the provider only reports old/new text. */
+    diff: z.string().optional(),
+});
+export const FileChangeItem = z.object({
+    ...itemBase,
+    kind: z.literal("file_change"),
+    changes: z.array(FileChange),
+});
+/** Any tool call that is not a shell command or a file edit (MCP, web search, ...). */
+export const ToolItem = z.object({
+    ...itemBase,
+    kind: z.literal("tool"),
+    name: z.string(),
+    input: z.unknown().optional(),
+    output: z.unknown().optional(),
+});
+export const TodoItem = z.object({
+    ...itemBase,
+    kind: z.literal("todo"),
+    entries: z.array(z.object({ text: z.string(), done: z.boolean() })),
+});
+export const Item = z.discriminatedUnion("kind", [
+    MessageItem,
+    ReasoningItem,
+    CommandItem,
+    FileChangeItem,
+    ToolItem,
+    TodoItem,
+]);
+/** Which string field an item.delta appends to. */
+export const DeltaField = z.enum(["text", "output"]);
+/** Applies an item.delta to an item. Shared by host and clients so both accumulate the same way. */
+export function applyDelta(item, field, delta) {
+    if (field === "text" && (item.kind === "message" || item.kind === "reasoning")) {
+        return { ...item, text: item.text + delta };
+    }
+    if (field === "output" && item.kind === "command") {
+        return { ...item, output: (item.output ?? "") + delta };
+    }
+    return item;
+}
+//# sourceMappingURL=items.js.map

package/dist/items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"items.js","sourceRoot":"","sources":["../src/items.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;AAGpG,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,UAAU;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACrD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,kFAAkF;IAClF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;CAC7B,CAAC,CAAC;AAGH,uFAAuF;AACvF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B,GAAG,QAAQ;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;CACpE,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC/C,WAAW;IACX,aAAa;IACb,WAAW;IACX,cAAc;IACd,QAAQ;IACR,QAAQ;CACT,CAAC,CAAC;AAIH,mDAAmD;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGrD,oGAAoG;AACpG,MAAM,UAAU,UAAU,CAAC,IAAU,EAAE,KAAiB,EAAE,KAAa;IACrE,IAAI,KAAK,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE,CAAC;QAC/E,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC;IAC9C,CAAC;IACD,IAAI,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAClD,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC;IAC1D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@termlink/protocol",
+  "version": "0.1.0",
+  "description": "TermLink agent protocol: command, response and event schemas shared by host and clients",
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "test": "node --conditions=source --import tsx --test \"test/**/*.test.ts\"",
+    "prepublishOnly": "tsc -b"
+  },
+  "dependencies": {
+    "zod": "^4.6.2"
+  },
+  "license": "MIT",
+  "author": "Bert Shim",
+  "homepage": "https://getterm.link",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "termlink",
+    "protocol"
+  ]
+}