@joe-broadhead/messaging 0.0.0-stage → 0.7.0

package/dist/types/core/schema/ipc/shapes.d.ts

@@ -0,0 +1,411 @@
+/**
+ * Shapes the local API's methods share (spec §8.2): session keys, inbox items, task records, send
+ * results, directory entries, conversation entries and chat lines. Each lane's method file under
+ * `schema/ipc/` imports them from here, and `schema/ipc.ts` re-exports them, so no method file
+ * imports `ipc.ts` (which spreads their tables).
+ */
+import { z } from "zod";
+/** Opaque, client-chosen session key, stable for the life of a client session, e.g. "opencode:<sessionID>". */
+export declare const SessionKey: z.ZodString;
+export type SessionKey = z.infer<typeof SessionKey>;
+/**
+ * When the recipient will likely see a message (spec §8.2): a hint from its machine's last presence
+ * at send time, never a promise.
+ * - `next_turn`: a live push session that is busy; its client shows the message after its next tool call or at its next turn.
+ * - `wake`: an idle push session, or a kept one its host can load again, whose machine acts on wake hints; the
+ *   client may start a turn for it, within its own budget.
+ * - `next_prompt`: a live push session that is idle and will not be woken; it sees the message when next prompted.
+ * - `on_read`: a pull session; its agent sees the message when it checks its inbox.
+ * - `kept`: no client holds the session; the message waits for one to register it again.
+ * - `offline`: the recipient machine is not connected; the relay holds the envelope until it connects or it expires.
+ */
+export declare const SendExpect: z.ZodEnum<{
+    kept: "kept";
+    next_turn: "next_turn";
+    wake: "wake";
+    next_prompt: "next_prompt";
+    on_read: "on_read";
+    offline: "offline";
+}>;
+export type SendExpect = z.infer<typeof SendExpect>;
+/** One agent session of a person, as this device knows it: `agent` is its name, `client` its client kind. */
+export declare const DirectoryEntry: z.ZodObject<{
+    address: z.ZodString;
+    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+    agent: z.ZodString;
+    device: z.ZodString;
+    label: z.ZodString;
+    client: z.ZodString;
+    repo: z.ZodOptional<z.ZodString>;
+    branch: z.ZodOptional<z.ZodString>;
+    state: z.ZodEnum<{
+        idle: "idle";
+        busy: "busy";
+    }>;
+    doing: z.ZodOptional<z.ZodString>;
+    tier: z.ZodEnum<{
+        push: "push";
+        pull: "pull";
+    }>;
+    online: z.ZodBoolean;
+    lastSeen: z.ZodNumber;
+    self: z.ZodBoolean;
+    expect: z.ZodOptional<z.ZodEnum<{
+        kept: "kept";
+        next_turn: "next_turn";
+        wake: "wake";
+        next_prompt: "next_prompt";
+        on_read: "on_read";
+        offline: "offline";
+    }>>;
+}, z.core.$strip>;
+export type DirectoryEntry = z.infer<typeof DirectoryEntry>;
+/** Chat text, at most `LIMITS.chatChars` UTF-16 code units (`max` would count code points). */
+export declare const ChatText: z.ZodString;
+/**
+ * A position in this machine's chat order (spec §6.8): every filed line and every chat change takes
+ * the next one. Local: another machine numbers the same line differently. 0 is before the first.
+ */
+export declare const ChatSeq: z.ZodNumber;
+export type ChatSeq = z.infer<typeof ChatSeq>;
+/** One transcript line (spec §6.8). `id` is the line's `messageId`, the same on every machine. */
+export declare const ChatLine: z.ZodObject<{
+    id: z.ZodString;
+    seq: z.ZodNumber;
+    at: z.ZodNumber;
+    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+    agent: z.ZodOptional<z.ZodString>;
+    direction: z.ZodEnum<{
+        out: "out";
+        in: "in";
+    }>;
+    body: z.ZodString;
+    thread: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodEnum<{
+        delivered: "delivered";
+        held: "held";
+        refused: "refused";
+        sent: "sent";
+    }>>;
+    refused: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>>;
+    notice: z.ZodOptional<z.ZodLiteral<true>>;
+}, z.core.$strip>;
+export type ChatLine = z.infer<typeof ChatLine>;
+/** The other end of an item or a task: a person's device and, when an agent wrote it, the agent. */
+export declare const PeerRef: z.ZodObject<{
+    address: z.ZodString;
+    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+    agent: z.ZodOptional<z.ZodString>;
+    device: z.ZodString;
+    label: z.ZodString;
+}, z.core.$strip>;
+export type PeerRef = z.infer<typeof PeerRef>;
+export declare const InboxItem: z.ZodObject<{
+    id: z.ZodString;
+    key: z.ZodString;
+    from: z.ZodObject<{
+        address: z.ZodString;
+        person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+        agent: z.ZodOptional<z.ZodString>;
+        device: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>;
+    kind: z.ZodEnum<{
+        message: "message";
+        task: "task";
+    }>;
+    messageId: z.ZodString;
+    taskId: z.ZodOptional<z.ZodString>;
+    contextId: z.ZodOptional<z.ZodString>;
+    replyTo: z.ZodOptional<z.ZodString>;
+    receivedAt: z.ZodNumber;
+    stage: z.ZodEnum<{
+        delivered: "delivered";
+        handed_to_agent: "handed_to_agent";
+        read: "read";
+    }>;
+    bytes: z.ZodNumber;
+    preview: z.ZodString;
+    wake: z.ZodBoolean;
+    chain: z.ZodOptional<z.ZodObject<{
+        addresses: z.ZodArray<z.ZodString>;
+        depth: z.ZodNumber;
+        maxDepth: z.ZodNumber;
+        scope: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        exp: z.ZodNumber;
+    }, z.core.$strip>>;
+    consent: z.ZodOptional<z.ZodEnum<{
+        self: "self";
+        guarded: "guarded";
+        trusted: "trusted";
+    }>>;
+}, z.core.$strip>;
+export type InboxItem = z.infer<typeof InboxItem>;
+/**
+ * A message this side sent to continue a task it requested (`msg.send` with `kind: "message"`
+ * and the `taskId`), and how far it got, from this daemon's own delivery records (spec §6.3).
+ */
+export declare const TaskFollowUp: z.ZodObject<{
+    envelopeId: z.ZodString;
+    messageId: z.ZodString;
+    sentAt: z.ZodNumber;
+    stage: z.ZodEnum<{
+        accepted: "accepted";
+        relayed: "relayed";
+        delivered: "delivered";
+        held: "held";
+        handed_to_agent: "handed_to_agent";
+        read: "read";
+        replied: "replied";
+        rejected: "rejected";
+        expired: "expired";
+    }>;
+    at: z.ZodNumber;
+}, z.core.$strip>;
+export type TaskFollowUp = z.infer<typeof TaskFollowUp>;
+export declare const TaskRecord: z.ZodObject<{
+    task: z.ZodObject<{
+        contextId: z.ZodOptional<z.ZodString>;
+        status: z.ZodObject<{
+            state: z.ZodEnum<{
+                TASK_STATE_SUBMITTED: "TASK_STATE_SUBMITTED";
+                TASK_STATE_WORKING: "TASK_STATE_WORKING";
+                TASK_STATE_COMPLETED: "TASK_STATE_COMPLETED";
+                TASK_STATE_FAILED: "TASK_STATE_FAILED";
+                TASK_STATE_CANCELED: "TASK_STATE_CANCELED";
+                TASK_STATE_INPUT_REQUIRED: "TASK_STATE_INPUT_REQUIRED";
+                TASK_STATE_REJECTED: "TASK_STATE_REJECTED";
+                TASK_STATE_AUTH_REQUIRED: "TASK_STATE_AUTH_REQUIRED";
+            }>;
+            message: z.ZodOptional<z.ZodObject<{
+                messageId: z.ZodString;
+                contextId: z.ZodOptional<z.ZodString>;
+                taskId: z.ZodOptional<z.ZodString>;
+                role: z.ZodEnum<{
+                    ROLE_USER: "ROLE_USER";
+                    ROLE_AGENT: "ROLE_AGENT";
+                }>;
+                parts: z.ZodArray<z.ZodObject<{
+                    text: z.ZodOptional<z.ZodString>;
+                    raw: z.ZodOptional<z.ZodString>;
+                    url: z.ZodOptional<z.ZodString>;
+                    data: z.ZodOptional<z.ZodUnknown>;
+                    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                    filename: z.ZodOptional<z.ZodString>;
+                    mediaType: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                extensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                referenceTaskIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>>;
+            timestamp: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        artifacts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            artifactId: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            parts: z.ZodArray<z.ZodObject<{
+                text: z.ZodOptional<z.ZodString>;
+                raw: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                data: z.ZodOptional<z.ZodUnknown>;
+                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                filename: z.ZodOptional<z.ZodString>;
+                mediaType: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            extensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>>;
+        history: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            messageId: z.ZodString;
+            contextId: z.ZodOptional<z.ZodString>;
+            taskId: z.ZodOptional<z.ZodString>;
+            role: z.ZodEnum<{
+                ROLE_USER: "ROLE_USER";
+                ROLE_AGENT: "ROLE_AGENT";
+            }>;
+            parts: z.ZodArray<z.ZodObject<{
+                text: z.ZodOptional<z.ZodString>;
+                raw: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                data: z.ZodOptional<z.ZodUnknown>;
+                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                filename: z.ZodOptional<z.ZodString>;
+                mediaType: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            extensions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            referenceTaskIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    role: z.ZodEnum<{
+        requester: "requester";
+        executor: "executor";
+    }>;
+    key: z.ZodString;
+    peer: z.ZodObject<{
+        address: z.ZodString;
+        person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+        agent: z.ZodOptional<z.ZodString>;
+        device: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    chain: z.ZodOptional<z.ZodObject<{
+        addresses: z.ZodArray<z.ZodString>;
+        depth: z.ZodNumber;
+        maxDepth: z.ZodNumber;
+        scope: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        exp: z.ZodNumber;
+    }, z.core.$strip>>;
+    followUps: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        envelopeId: z.ZodString;
+        messageId: z.ZodString;
+        sentAt: z.ZodNumber;
+        stage: z.ZodEnum<{
+            accepted: "accepted";
+            relayed: "relayed";
+            delivered: "delivered";
+            held: "held";
+            handed_to_agent: "handed_to_agent";
+            read: "read";
+            replied: "replied";
+            rejected: "rejected";
+            expired: "expired";
+        }>;
+        at: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type TaskRecord = z.infer<typeof TaskRecord>;
+/**
+ * Where a send went (`msg.send`, spec §8.2): an agent session `person/agent@label`, a person (a line
+ * from an agent to them) or `#<channel>` (a post).
+ */
+export declare const SendTarget: z.ZodUnion<readonly [z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodString]>, z.ZodString]>;
+export type SendTarget = z.infer<typeof SendTarget>;
+export declare const SendResult: z.ZodObject<{
+    to: z.ZodUnion<readonly [z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodString]>, z.ZodString]>;
+    envelopeId: z.ZodString;
+    messageId: z.ZodString;
+    taskId: z.ZodOptional<z.ZodString>;
+    contextId: z.ZodString;
+    stage: z.ZodEnum<{
+        accepted: "accepted";
+        relayed: "relayed";
+        delivered: "delivered";
+        held: "held";
+        handed_to_agent: "handed_to_agent";
+        read: "read";
+        replied: "replied";
+        rejected: "rejected";
+        expired: "expired";
+    }>;
+    code: z.ZodOptional<z.ZodEnum<{
+        expired: "expired";
+        invalid_request: "invalid_request";
+        not_member: "not_member";
+        bad_signature: "bad_signature";
+        unknown_session: "unknown_session";
+        ambiguous_address: "ambiguous_address";
+        no_recipients: "no_recipients";
+        unknown_address: "unknown_address";
+        refused: "refused";
+        declined: "declined";
+        request_required: "request_required";
+        rate_limited: "rate_limited";
+        loop_guard: "loop_guard";
+        too_large: "too_large";
+        secret_refused: "secret_refused";
+        duplicate: "duplicate";
+        relay_unavailable: "relay_unavailable";
+        not_found: "not_found";
+        invalid_state: "invalid_state";
+        forbidden: "forbidden";
+        guarded_turn: "guarded_turn";
+        roster_conflict: "roster_conflict";
+        invite_invalid: "invite_invalid";
+        no_identity: "no_identity";
+        binding_invalid: "binding_invalid";
+        jelly_unavailable: "jelly_unavailable";
+        log_conflict: "log_conflict";
+        device_limit: "device_limit";
+        admission_required: "admission_required";
+        admission_invalid: "admission_invalid";
+        directory_inconsistent: "directory_inconsistent";
+        unknown_device: "unknown_device";
+        directory_unavailable: "directory_unavailable";
+        login_unsupported: "login_unsupported";
+        login_denied: "login_denied";
+        grant_required: "grant_required";
+        grant_invalid: "grant_invalid";
+        ticket_required: "ticket_required";
+        ticket_invalid: "ticket_invalid";
+        daemon_unavailable: "daemon_unavailable";
+        daemon_mismatch: "daemon_mismatch";
+        internal: "internal";
+    }>>;
+    expect: z.ZodOptional<z.ZodEnum<{
+        kept: "kept";
+        next_turn: "next_turn";
+        wake: "wake";
+        next_prompt: "next_prompt";
+        on_read: "on_read";
+        offline: "offline";
+    }>>;
+}, z.core.$strip>;
+export type SendResult = z.infer<typeof SendResult>;
+/** A place in a conversation page (`conv.read`): an entry's time and id. */
+export declare const ConvCursor: z.ZodObject<{
+    at: z.ZodNumber;
+    id: z.ZodString;
+}, z.core.$strict>;
+export type ConvCursor = z.infer<typeof ConvCursor>;
+/**
+ * One entry of a conversation between a local session and one other session (spec §8.2
+ * `conv.read`): mail either way, or a task either way. `text` is untrusted peer text for incoming
+ * mail and for a task the other side asked for; clients frame it as data.
+ */
+export declare const ConvEntry: z.ZodObject<{
+    id: z.ZodString;
+    kind: z.ZodEnum<{
+        task: "task";
+        mail: "mail";
+    }>;
+    direction: z.ZodEnum<{
+        out: "out";
+        in: "in";
+    }>;
+    peer: z.ZodString;
+    at: z.ZodNumber;
+    text: z.ZodOptional<z.ZodString>;
+    taskId: z.ZodOptional<z.ZodString>;
+    stage: z.ZodOptional<z.ZodEnum<{
+        accepted: "accepted";
+        relayed: "relayed";
+        delivered: "delivered";
+        held: "held";
+        handed_to_agent: "handed_to_agent";
+        read: "read";
+        replied: "replied";
+        rejected: "rejected";
+        expired: "expired";
+    }>>;
+    role: z.ZodOptional<z.ZodEnum<{
+        requester: "requester";
+        executor: "executor";
+    }>>;
+    state: z.ZodOptional<z.ZodEnum<{
+        TASK_STATE_SUBMITTED: "TASK_STATE_SUBMITTED";
+        TASK_STATE_WORKING: "TASK_STATE_WORKING";
+        TASK_STATE_COMPLETED: "TASK_STATE_COMPLETED";
+        TASK_STATE_FAILED: "TASK_STATE_FAILED";
+        TASK_STATE_CANCELED: "TASK_STATE_CANCELED";
+        TASK_STATE_INPUT_REQUIRED: "TASK_STATE_INPUT_REQUIRED";
+        TASK_STATE_REJECTED: "TASK_STATE_REJECTED";
+        TASK_STATE_AUTH_REQUIRED: "TASK_STATE_AUTH_REQUIRED";
+    }>>;
+}, z.core.$strip>;
+export type ConvEntry = z.infer<typeof ConvEntry>;