@nexus-code/remote-protocol 0.0.0-stage → 0.2.0

package/dist/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,6FAA6F;AAC7F,eAAO,MAAM,cAAc;;IAEzB,sCAAsC;;;;;;;;EAEtC,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAItD,eAAO,MAAM,cAAc;;;;;;QAPzB,sCAAsC;;;;;;;;;IAYtC,gEAAgE;;IAEhE,2EAA2E;;;;;;;;;;;;;;;;;;;;;;;;;EAG3E,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;IAI/B,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAM9B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEpE,eAAO,MAAM,gBAAgB;;;IAG3B,wFAAwF;;;;;;;;;;;;;;;;EAIxF,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,8FAA8F;AAC9F,eAAO,MAAM,kBAAkB;;;;;;;QAO3B,8EAA8E;;;;;;;;;;;QAE9E,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK1C,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW5B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;EAO1B,CAAC;AAEH,yCAAyC;AACzC,eAAO,MAAM,UAAU,EAAE,WAAW,CAAC,MAAM,CAOzC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;gCAEd,CAAC;AAEjB,eAAO,MAAM,cAAc;;;;;;QAhHzB,sCAAsC;;;;;;;;;IAYtC,gEAAgE;;IAEhE,2EAA2E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuB3E,wFAAwF;;;;;;;;;;;;;;;;;;;;;;;QA0BtF,8EAA8E;;;;;;;;;;;QAE9E,wCAAwC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAuD1C,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,mFAAmF;AACnF,eAAO,MAAM,eAAe,QAAY,CAAC;AAEzC,eAAO,MAAM,kBAAkB;;;;;IAK7B,wDAAwD;;;;;QAMpD,wEAAwE;;;;YAzI5E,sCAAsC;;;;;;;;;QA4IlC,iEAAiE;;;;;;;;;;;;;;;;;;;;;IAIrE,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7D,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,uEAAuE;AACvE,eAAO,MAAM,oBAAoB;;;;;;;;IAQ/B,4BAA4B;;IAE5B,+EAA+E;;;;;;QA7B/E,wDAAwD;;;;;YAMpD,wEAAwE;;;;gBAzI5E,sCAAsC;;;;;;;;;YA4IlC,iEAAiE;;;;;;;;;;;;;;;;;;;;;QAIrE,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAkB7D;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,6EAA6E;AAC7E,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUzB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,qFAAqF;AACrF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAS9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,oDAAoD;AACpD,eAAO,MAAM,gBAAgB;;;IAG3B,kDAAkD;;;;IAIlD,2BAA2B;;;;;;QAOvB,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAvDlC,4BAA4B;;QAE5B,+EAA+E;;;;;;YA7B/E,wDAAwD;;;;;gBAMpD,wEAAwE;;;;oBAzI5E,sCAAsC;;;;;;;;;gBA4IlC,iEAAiE;;;;;;;;;;;;;;;;;;;;;YAIrE,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAkB7D;;;;WAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqDH,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,0CAA0C;AAC1C,eAAO,MAAM,cAAc;;IAEzB,yCAAyC;;;;;;;;EAEzC,CAAC;AAEH,uDAAuD;AACvD,eAAO,MAAM,kBAAkB;;;IAG7B,6CAA6C;;;;;;;;;;;;;;;;EAI7C,CAAC;AAEH,iEAAiE;AACjE,eAAO,MAAM,cAAc;;IAEzB,qCAAqC;;;IAGrC,6CAA6C;;IAE7C,0BAA0B;;;;;;;;;;;;;;EAE1B,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;QAhC1B,yCAAyC;;;;;;;;;IAkCzC,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA1BzF,6CAA6C;;;;;;;;;;;;;;;;;;QA+BzC,yEAAyE;;;;;;;;;;;;;IAM7E,6FAA6F;;;;;;;;;;;IAO7F,mFAAmF;;;;QAnCnF,qCAAqC;;;QAGrC,6CAA6C;;QAE7C,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiC1B,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/view.js

@@ -0,0 +1,260 @@
+/**
+ * A chat as another device draws it: the conversation the serving device's
+ * app already made of its program's log, trimmed of what only that app
+ * uses. The shapes follow the desktop app's chat model, so its chat view can
+ * draw a remote one as it draws its own; Claude Code's and Codex's own
+ * formats stay on the serving device, which keeps up with their versions.
+ *
+ * An item or call of a kind this version does not know stays parseable
+ * (UnknownItemSchema): a newer device may send more, and an older one skips it.
+ */
+import { z } from "zod";
+/** An image a message or a tool result holds. Its bytes stay on the serving device in v1. */
+export const ImageRefSchema = z.object({
+    mediaType: z.string(),
+    /** How many bytes the image takes. */
+    bytes: z.number().int().nonnegative(),
+});
+const at = z.number().optional();
+export const UserItemSchema = z.object({
+    kind: z.literal("user"),
+    key: z.string(),
+    text: z.string(),
+    images: z.array(ImageRefSchema),
+    /** sent: written to the program; taken: the program read it. */
+    state: z.enum(["sent", "taken"]),
+    /** Written during a turn and not read yet: it waits above the composer. */
+    queued: z.boolean().optional(),
+    at,
+});
+export const AssistantBlockSchema = z.discriminatedUnion("type", [
+    z.object({ type: z.literal("text"), text: z.string() }),
+    z.object({ type: z.literal("thinking"), text: z.string() }),
+    z.object({ type: z.literal("tool"), toolUseId: z.string() }),
+]);
+export const AssistantItemSchema = z.object({
+    kind: z.literal("assistant"),
+    key: z.string(),
+    messageId: z.string(),
+    blocks: z.array(AssistantBlockSchema),
+    at,
+});
+export const NoticeItemSchema = z.object({
+    kind: z.literal("notice"),
+    key: z.string(),
+    /** interrupted, exited, restarted, compacted, cleared, error…: a code the app names. */
+    code: z.string(),
+    detail: z.string().optional(),
+    at,
+});
+/**
+ * Where an agent that sent a message can be answered: its tab, on the
+ * device `deviceId` (absent: the device this chat runs on). `nexus chat
+ * send` takes it as it is.
+ */
+export const ReplyAddressSchema = z.object({
+    deviceId: z.string().optional(),
+    workspaceId: z.string(),
+    tabId: z.string(),
+});
+/** A message the program took that the user did not write: another session's, a channel's. */
+export const ReceivedItemSchema = z.object({
+    kind: z.literal("received"),
+    key: z.string(),
+    from: z.object({
+        kind: z.string(),
+        name: z.string().optional(),
+        agent: z.string().optional(),
+        /** Sent from another device of the account: which one, as it names itself. */
+        device: z.object({ id: z.string(), name: z.string() }).optional(),
+        /** Where the sender takes an answer. */
+        replyTo: ReplyAddressSchema.optional(),
+    }),
+    text: z.string(),
+    at,
+});
+export const TaskEndItemSchema = z.object({
+    kind: z.literal("task_end"),
+    key: z.string(),
+    taskId: z.string(),
+    status: z.string(),
+    description: z.string().optional(),
+    taskType: z.string().optional(),
+    summary: z.string().optional(),
+    toolUseId: z.string().optional(),
+    wakes: z.boolean().optional(),
+    at,
+});
+export const ShellItemSchema = z.object({
+    kind: z.literal("shell"),
+    key: z.string(),
+    command: z.string(),
+    stdout: z.string().optional(),
+    stderr: z.string().optional(),
+    at,
+});
+/** The item kinds this version knows. */
+export const ITEM_KINDS = new Set([
+    "user",
+    "assistant",
+    "notice",
+    "received",
+    "task_end",
+    "shell",
+]);
+/**
+ * An item of a kind this version does not know: kept so the list stays
+ * whole, and not drawn. A known kind that does not fit its shape is no such item.
+ */
+export const UnknownItemSchema = z
+    .object({ kind: z.string().refine((kind) => !ITEM_KINDS.has(kind)), key: z.string() })
+    .passthrough();
+export const ViewItemSchema = z.union([
+    UserItemSchema,
+    AssistantItemSchema,
+    NoticeItemSchema,
+    ReceivedItemSchema,
+    TaskEndItemSchema,
+    ShellItemSchema,
+    UnknownItemSchema,
+]);
+/** Most characters of a tool's result text sent; the rest is cut (`truncated`). */
+export const MAX_RESULT_TEXT = 64 * 1024;
+export const ViewToolCallSchema = z.object({
+    id: z.string(),
+    name: z.string(),
+    displayName: z.string().optional(),
+    input: z.unknown(),
+    /** streaming, running, done, error, denied, stopped. */
+    status: z.string(),
+    result: z
+        .object({
+        text: z.string(),
+        isError: z.boolean(),
+        /** The program's structured result: a run's stdout, an edit's patch. */
+        structured: z.unknown().optional(),
+        images: z.array(ImageRefSchema),
+        /** The text was longer than MAX_RESULT_TEXT and is cut there. */
+        truncated: z.boolean().optional(),
+    })
+        .optional(),
+    /** The agent call it runs under; null on the main thread. */
+    parentToolUseId: z.string().nullable(),
+});
+/** A tool the program asks to run, which the user allows or denies. */
+export const ViewPermissionSchema = z.object({
+    requestId: z.string(),
+    toolName: z.string(),
+    displayName: z.string().optional(),
+    input: z.record(z.unknown()),
+    description: z.string().optional(),
+    decisionReason: z.string().optional(),
+    toolUseId: z.string().optional(),
+    /** A subagent's request. */
+    agentId: z.string().optional(),
+    /** The call as the card previews it, when the input alone does not tell it. */
+    preview: ViewToolCallSchema.optional(),
+    /**
+     * What "always allow" would add, one choice each, in the serving
+     * device's words ("Allow Bash(npm test:*) in this folder"): chat.answer
+     * picks them by index.
+     */
+    suggestions: z.array(z.object({ label: z.string() })).optional(),
+});
+/** A task the program runs beside the turn: a background run, a subagent. */
+export const ViewTaskSchema = z.object({
+    taskId: z.string(),
+    type: z.string(),
+    description: z.string(),
+    status: z.string(),
+    toolUseId: z.string().optional(),
+    startedAt: z.number().optional(),
+    endedAt: z.number().optional(),
+    summary: z.string().optional(),
+    activity: z.string().optional(),
+});
+/** The reply being written: what the program streamed of its next message so far. */
+export const ViewStreamingSchema = z.object({
+    messageId: z.string(),
+    blocks: z.array(z.object({
+        type: z.enum(["text", "thinking", "tool_use"]),
+        text: z.string(),
+        toolUseId: z.string().optional(),
+    })),
+});
+/** Where a chat stands, apart from its messages. */
+export const ChatStatusSchema = z.object({
+    agent: z.enum(["claude", "codex"]),
+    title: z.string(),
+    /** The model it runs, as its program names it. */
+    model: z.string().optional(),
+    effort: z.string().optional(),
+    permissionMode: z.string().optional(),
+    /** A turn is under way. */
+    running: z.boolean(),
+    process: z.enum(["none", "running", "exited"]),
+    turn: z
+        .object({
+        startedAt: z.number().optional(),
+        outputTokens: z.number(),
+        /** requesting, compacting… */
+        status: z.string().optional(),
+    })
+        .nullable(),
+    streaming: ViewStreamingSchema.nullable(),
+    permissions: z.array(ViewPermissionSchema),
+});
+/** One step of the agent's to-do list. */
+export const ViewTodoSchema = z.object({
+    content: z.string(),
+    /** pending, in_progress or completed. */
+    status: z.string(),
+});
+/** A subagent the turn called (an Agent tool call). */
+export const ViewAgentRowSchema = z.object({
+    toolUseId: z.string(),
+    description: z.string(),
+    /** running, completed, failed or stopped. */
+    status: z.string(),
+    startedAt: z.number().optional(),
+    endedAt: z.number().optional(),
+});
+/** A goal the chat works toward (/goal), and where it stands. */
+export const ViewGoalSchema = z.object({
+    condition: z.string(),
+    /** active, paused, met or failed. */
+    status: z.string(),
+    setAt: z.number().optional(),
+    /** How many checks found it unmet so far. */
+    checks: z.number().int().nonnegative(),
+    /** Once it ended: why. */
+    reason: z.string().optional(),
+});
+/**
+ * What the chat's side panel shows beside the conversation: the to-do
+ * list, the tasks and subagents, the files it changed, the context it
+ * fills, what it cost, and its goal.
+ */
+export const ChatPanelSchema = z.object({
+    todos: z.array(ViewTodoSchema),
+    /** Background runs and the like, by the program's task ids (chat.stopTask stops one). */
+    tasks: z.array(ViewTaskSchema),
+    agents: z.array(ViewAgentRowSchema),
+    changedFiles: z.array(z.object({
+        /** Absolute, on the serving device, as the chat's tool calls name it. */
+        path: z.string(),
+        added: z.number().int().nonnegative().optional(),
+        removed: z.number().int().nonnegative().optional(),
+    })),
+    /** The context window: tokens in it, and how many it takes; null before the program said. */
+    context: z
+        .object({
+        usedTokens: z.number().int().nonnegative(),
+        maxTokens: z.number().int().positive(),
+    })
+        .nullable(),
+    /** What the conversation cost so far, in US dollars, when the program tells it. */
+    costUsd: z.number().nonnegative().optional(),
+    goal: ViewGoalSchema.nullable(),
+});
+//# sourceMappingURL=view.js.map

package/dist/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,6FAA6F;AAC7F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,sCAAsC;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CACtC,CAAC,CAAC;AAGH,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC;AAEjC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC/B,gEAAgE;IAChE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,2EAA2E;IAC3E,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,EAAE;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC/D,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IACvD,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IAC3D,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;CAC7D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACrC,EAAE;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACzB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,wFAAwF;IACxF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE;CACH,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAGH,8FAA8F;AAC9F,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC3B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,8EAA8E;QAC9E,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE;QACjE,wCAAwC;QACxC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;KACvC,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,EAAE;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC3B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACxB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE;CACH,CAAC,CAAC;AAEH,yCAAyC;AACzC,MAAM,CAAC,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC;IACrD,MAAM;IACN,WAAW;IACX,QAAQ;IACR,UAAU;IACV,UAAU;IACV,OAAO;CACR,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;KACrF,WAAW,EAAE,CAAC;AAEjB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC;IACpC,cAAc;IACd,mBAAmB;IACnB,gBAAgB;IAChB,kBAAkB;IAClB,iBAAiB;IACjB,eAAe;IACf,iBAAiB;CAClB,CAAC,CAAC;AAGH,mFAAmF;AACnF,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,GAAG,IAAI,CAAC;AAEzC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;IAClB,wDAAwD;IACxD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;QACpB,wEAAwE;QACxE,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;QAC/B,iEAAiE;QACjE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC;SACD,QAAQ,EAAE;IACb,6DAA6D;IAC7D,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAGH,uEAAuE;AACvE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,4BAA4B;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,+EAA+E;IAC/E,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACtC;;;;OAIG;IACH,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC;AAGH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAGH,qFAAqF;AACrF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,MAAM,EAAE,CAAC,CAAC,KAAK,CACb,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAC9C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACjC,CAAC,CACH;CACF,CAAC,CAAC;AAGH,oDAAoD;AACpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,kDAAkD;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,2BAA2B;IAC3B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC9C,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC;QACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,8BAA8B;QAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,QAAQ,EAAE;IACb,SAAS,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACzC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;CAC3C,CAAC,CAAC;AAGH,0CAA0C;AAC1C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,yCAAyC;IACzC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAEH,uDAAuD;AACvD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,6CAA6C;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,iEAAiE;AACjE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,qCAAqC;IACrC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,6CAA6C;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACtC,0BAA0B;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC9B,yFAAyF;IACzF,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IACnC,YAAY,EAAE,CAAC,CAAC,KAAK,CACnB,CAAC,CAAC,MAAM,CAAC;QACP,yEAAyE;QACzE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;QAChD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;KACnD,CAAC,CACH;IACD,6FAA6F;IAC7F,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;QAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,QAAQ,EAAE;IACb,mFAAmF;IACnF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC5C,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC"}

package/dist/voice.d.ts

@@ -0,0 +1,139 @@
+/**
+ * The voice socket: what a device says goes to the server as audio and
+ * comes back as text while it speaks (streaming speech to text).
+ *
+ * GET /voice?v=1&lang=<language> upgrades to a WebSocket, signed in as
+ * /relay is (a Bearer header, or ?ticket= from POST /relay/ticket). Then:
+ * - server: `ready`, naming the audio format and sample rate to send, and
+ *   the most seconds this session may take;
+ * - client: binary frames of audio in that format, about 100 ms each, then
+ *   `end` when the user stops;
+ * - server, as they come: `partial` (the words so far of the segment being
+ *   spoken; each replaces the last) and `final` (a finished segment, to
+ *   append; it clears the partial). Every partial and final after the
+ *   session's first final starts with the space its language puts between
+ *   segments (none for ja or zh): the text is the finals joined as they
+ *   came, then the partial, with nothing trimmed or added between;
+ * - server: `limit` if the audio ran past what the session or the
+ *   account's quota allows (audio past it is dropped; finals still come);
+ * - server: `done` with the seconds counted, once every final is out; then
+ *   it closes (1000). An `error` ends the session; it closes after.
+ */
+import { z } from "zod";
+export declare const VOICE_VERSION = 1;
+/** Most bytes in one audio frame (2 s of 16 kHz 16-bit mono); an even count. */
+export declare const MAX_AUDIO_FRAME_BYTES: number;
+/** The language to hear, BCP 47-ish: "ko", "en", "en-US", or "multi" to detect it. */
+export declare const VoiceLanguageSchema: z.ZodString;
+/** What a device sends besides audio: that the user stopped speaking. */
+export declare const VoiceClientMessageSchema: z.ZodObject<{
+    t: z.ZodLiteral<"end">;
+}, "strip", z.ZodTypeAny, {
+    t: "end";
+}, {
+    t: "end";
+}>;
+export type VoiceClientMessage = z.infer<typeof VoiceClientMessageSchema>;
+export declare const VoiceReadySchema: z.ZodObject<{
+    t: z.ZodLiteral<"ready">;
+    format: z.ZodLiteral<"pcm_s16le">;
+    /** The rate to send at; it may change with the provider, so it is not to be assumed. */
+    sampleRate: z.ZodNumber;
+    /** The fewer of the session's limit and what is left of the month's quota. */
+    maxSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    t: "ready";
+    format: "pcm_s16le";
+    sampleRate: number;
+    maxSeconds: number;
+}, {
+    t: "ready";
+    format: "pcm_s16le";
+    sampleRate: number;
+    maxSeconds: number;
+}>;
+export declare const VoiceServerMessageSchema: z.ZodDiscriminatedUnion<"t", [z.ZodObject<{
+    t: z.ZodLiteral<"ready">;
+    format: z.ZodLiteral<"pcm_s16le">;
+    /** The rate to send at; it may change with the provider, so it is not to be assumed. */
+    sampleRate: z.ZodNumber;
+    /** The fewer of the session's limit and what is left of the month's quota. */
+    maxSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    t: "ready";
+    format: "pcm_s16le";
+    sampleRate: number;
+    maxSeconds: number;
+}, {
+    t: "ready";
+    format: "pcm_s16le";
+    sampleRate: number;
+    maxSeconds: number;
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"partial">;
+    text: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "partial";
+    text: string;
+}, {
+    t: "partial";
+    text: string;
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"final">;
+    text: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "final";
+    text: string;
+}, {
+    t: "final";
+    text: string;
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"limit">;
+    reason: z.ZodEnum<["session", "quota"]>;
+}, "strip", z.ZodTypeAny, {
+    t: "limit";
+    reason: "session" | "quota";
+}, {
+    t: "limit";
+    reason: "session" | "quota";
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"done">;
+    seconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    t: "done";
+    seconds: number;
+}, {
+    t: "done";
+    seconds: number;
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"error">;
+    /** unauthorized: the device's sign-in ended (the socket closes 4001 after it). */
+    code: z.ZodEnum<["bad-frame", "provider-error", "unauthorized"]>;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: "bad-frame" | "unauthorized" | "provider-error";
+    message: string;
+    t: "error";
+}, {
+    code: "bad-frame" | "unauthorized" | "provider-error";
+    message: string;
+    t: "error";
+}>]>;
+export type VoiceServerMessage = z.infer<typeof VoiceServerMessageSchema>;
+/** GET /voice/usage: this month's seconds, used and allowed. */
+export declare const VoiceUsageSchema: z.ZodObject<{
+    /** The month, as YYYY-MM. */
+    period: z.ZodString;
+    usedSeconds: z.ZodNumber;
+    limitSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    period: string;
+    usedSeconds: number;
+    limitSeconds: number;
+}, {
+    period: string;
+    usedSeconds: number;
+    limitSeconds: number;
+}>;
+export type VoiceUsage = z.infer<typeof VoiceUsageSchema>;
+//# sourceMappingURL=voice.d.ts.map

package/dist/voice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice.d.ts","sourceRoot":"","sources":["../src/voice.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,gFAAgF;AAChF,eAAO,MAAM,qBAAqB,QAAY,CAAC;AAE/C,sFAAsF;AACtF,eAAO,MAAM,mBAAmB,aAAuD,CAAC;AAExF,yEAAyE;AACzE,eAAO,MAAM,wBAAwB;;;;;;EAAoC,CAAC;AAC1E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,gBAAgB;;;IAG3B,wFAAwF;;IAExF,8EAA8E;;;;;;;;;;;;EAE9E,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;IANnC,wFAAwF;;IAExF,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAY5E,kFAAkF;;;;;;;;;;;IAIpF,CAAC;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,gEAAgE;AAChE,eAAO,MAAM,gBAAgB;IAC3B,6BAA6B;;;;;;;;;;;;EAI7B,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/voice.js

@@ -0,0 +1,58 @@
+/**
+ * The voice socket: what a device says goes to the server as audio and
+ * comes back as text while it speaks (streaming speech to text).
+ *
+ * GET /voice?v=1&lang=<language> upgrades to a WebSocket, signed in as
+ * /relay is (a Bearer header, or ?ticket= from POST /relay/ticket). Then:
+ * - server: `ready`, naming the audio format and sample rate to send, and
+ *   the most seconds this session may take;
+ * - client: binary frames of audio in that format, about 100 ms each, then
+ *   `end` when the user stops;
+ * - server, as they come: `partial` (the words so far of the segment being
+ *   spoken; each replaces the last) and `final` (a finished segment, to
+ *   append; it clears the partial). Every partial and final after the
+ *   session's first final starts with the space its language puts between
+ *   segments (none for ja or zh): the text is the finals joined as they
+ *   came, then the partial, with nothing trimmed or added between;
+ * - server: `limit` if the audio ran past what the session or the
+ *   account's quota allows (audio past it is dropped; finals still come);
+ * - server: `done` with the seconds counted, once every final is out; then
+ *   it closes (1000). An `error` ends the session; it closes after.
+ */
+import { z } from "zod";
+export const VOICE_VERSION = 1;
+/** Most bytes in one audio frame (2 s of 16 kHz 16-bit mono); an even count. */
+export const MAX_AUDIO_FRAME_BYTES = 64 * 1024;
+/** The language to hear, BCP 47-ish: "ko", "en", "en-US", or "multi" to detect it. */
+export const VoiceLanguageSchema = z.string().regex(/^([a-z]{2,3}(-[A-Z]{2})?|multi)$/);
+/** What a device sends besides audio: that the user stopped speaking. */
+export const VoiceClientMessageSchema = z.object({ t: z.literal("end") });
+export const VoiceReadySchema = z.object({
+    t: z.literal("ready"),
+    format: z.literal("pcm_s16le"),
+    /** The rate to send at; it may change with the provider, so it is not to be assumed. */
+    sampleRate: z.number().int().positive(),
+    /** The fewer of the session's limit and what is left of the month's quota. */
+    maxSeconds: z.number().nonnegative(),
+});
+export const VoiceServerMessageSchema = z.discriminatedUnion("t", [
+    VoiceReadySchema,
+    z.object({ t: z.literal("partial"), text: z.string() }),
+    z.object({ t: z.literal("final"), text: z.string() }),
+    z.object({ t: z.literal("limit"), reason: z.enum(["session", "quota"]) }),
+    z.object({ t: z.literal("done"), seconds: z.number().nonnegative() }),
+    z.object({
+        t: z.literal("error"),
+        /** unauthorized: the device's sign-in ended (the socket closes 4001 after it). */
+        code: z.enum(["bad-frame", "provider-error", "unauthorized"]),
+        message: z.string(),
+    }),
+]);
+/** GET /voice/usage: this month's seconds, used and allowed. */
+export const VoiceUsageSchema = z.object({
+    /** The month, as YYYY-MM. */
+    period: z.string(),
+    usedSeconds: z.number().nonnegative(),
+    limitSeconds: z.number().nonnegative(),
+});
+//# sourceMappingURL=voice.js.map

package/dist/voice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice.js","sourceRoot":"","sources":["../src/voice.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,gFAAgF;AAChF,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE/C,sFAAsF;AACtF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;AAExF,yEAAyE;AACzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC9B,wFAAwF;IACxF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,8EAA8E;IAC9E,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;IAChE,gBAAgB;IAChB,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IACvD,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;IACrD,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;IACrE,CAAC,CAAC,MAAM,CAAC;QACP,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QACrB,kFAAkF;QAClF,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAC7D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,CAAC;AAGH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,6BAA6B;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE;CACvC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@nexus-code/remote-protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "NexusCode's remote protocol: the relay's frames and the end-to-end RPC between a user's devices",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moreih29/nexus-code.git",
+    "directory": "packages/remote-protocol"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "ACCOUNT_KEYS.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "zod": "^3.25.0"
+  }
+}

package/src/account.ts

@@ -0,0 +1,69 @@
+/**
+ * The account key, locked with the account password: the server keeps the
+ * locked bundle and hands it to the account's devices, which open it on
+ * their own (see ../ACCOUNT_KEYS.md). The server never sees the password,
+ * the key, or anything made from them; it only checks the bundle's shape.
+ */
+import { z } from "zod";
+import { Base64UrlSchema } from "./relay.js";
+
+/** The associated data the key is sealed with: the user's id and the key's version, so a bundle cannot pass for another's. */
+export function bundleAadOf(userId: string, kid: number): string {
+  return `nexus-remote/account-key/v1|${userId}|${kid}`;
+}
+
+/** Argon2id's settings, as libsodium's crypto_pwhash takes them (ALG_ARGON2ID13). */
+export const KdfSchema = z.object({
+  alg: z.literal("argon2id13"),
+  /** crypto_pwhash's opslimit. */
+  ops: z.number().int().min(1).max(10),
+  /** crypto_pwhash's memlimit, in bytes. */
+  mem: z
+    .number()
+    .int()
+    .min(16 * 1024 * 1024)
+    .max(1024 * 1024 * 1024),
+  /** 16 random bytes. */
+  salt: Base64UrlSchema,
+});
+export type Kdf = z.infer<typeof KdfSchema>;
+
+/** The settings a new bundle is locked with; a bundle keeps its own, so these can grow. */
+export const DEFAULT_KDF = { alg: "argon2id13", ops: 3, mem: 64 * 1024 * 1024 } as const;
+
+/**
+ * The account key (32 bytes) sealed with XChaCha20-Poly1305 under the key
+ * the password makes with `kdf`, with bundleAadOf(userId, kid) as the
+ * associated data. `kid` is the account key's version, which sealed frames
+ * name; it goes up when the key is made anew.
+ */
+export const KeyBundleSchema = z.object({
+  v: z.literal(1),
+  kid: z.number().int().positive(),
+  kdf: KdfSchema,
+  /** 24 random bytes. */
+  nonce: Base64UrlSchema,
+  box: Base64UrlSchema,
+});
+export type KeyBundle = z.infer<typeof KeyBundleSchema>;
+
+/** GET /account/key-bundle: the bundle and its version on the server, or 404 before there is one. */
+export const KeyBundleResponseSchema = z.object({
+  bundle: KeyBundleSchema,
+  /** Counts the bundle's writes, for the next PUT to say which one it replaces. */
+  version: z.number().int().positive(),
+});
+export type KeyBundleResponse = z.infer<typeof KeyBundleResponseSchema>;
+
+/**
+ * PUT /account/key-bundle. `expected` is the version it replaces, or null
+ * for the first bundle; the server answers 409 when another write came
+ * first. A new password locks the same key (same kid); a reset puts a new
+ * key (kid + 1), which the account's other devices take once they are told
+ * the new password.
+ */
+export const KeyBundlePutSchema = z.object({
+  bundle: KeyBundleSchema,
+  expected: z.number().int().positive().nullable(),
+});
+export type KeyBundlePut = z.infer<typeof KeyBundlePutSchema>;

package/src/index.ts

@@ -0,0 +1,18 @@
+/**
+ * NexusCode's remote protocol, in two layers, and the account key's bundle:
+ * - ./relay: the frames between a device and its account's room on the
+ *   relay, which the relay reads and routes;
+ * - ./sealed, ./rpc, ./view: what a sealed frame carries between two
+ *   devices of the account, which only they can open;
+ * - ./account: the account key, locked with the account password, as the
+ *   server keeps it;
+ * - ./voice: the voice socket, speech to text while the user speaks;
+ * - ./info: what the server offers (GET /info).
+ */
+export * from "./account.js";
+export * from "./info.js";
+export * from "./relay.js";
+export * from "./rpc.js";
+export * from "./sealed.js";
+export * from "./view.js";
+export * from "./voice.js";

package/src/info.ts

@@ -0,0 +1,18 @@
+/**
+ * GET /info, signed in or not: what the server offers, so a device shows
+ * only what works there.
+ */
+import { z } from "zod";
+
+export const ServerInfoSchema = z.object({
+  /**
+   * The sign-ins the server has, each its own /auth/<name>/start: "google",
+   * "github", and "dev" only on a server at localhost. A device offers one
+   * button for each it knows.
+   */
+  signIn: z.array(z.string()),
+  relay: z.object({ version: z.number().int() }).nullable(),
+  /** Null where the server has no speech-to-text provider: no microphone then. */
+  voice: z.object({ version: z.number().int() }).nullable(),
+});
+export type ServerInfo = z.infer<typeof ServerInfoSchema>;