@joe-broadhead/messaging 0.7.1 → 0.9.0

package/dist/types/core/schema/conv-frames.d.ts

@@ -0,0 +1,1204 @@
+/**
+ * Conversation frames (spec §7, "Conversation frames"; spec §16): the frames a relay speaks after `hello` to carry
+ * conversation logs, in a roster realm and in a directory realm alike. They follow the frame rules of §7: one JSON
+ * object per text frame, discriminated by `t`; requests carry `req`, replies echo it, and a refusal is the relay
+ * binding's `nack {id: req, code, message}` (with `retryAfterMs` for `rate_limited`). Every frame is strict.
+ *
+ *   conv.append {req, event}                     → conv.ok {req, cid, seq, hash}        an op or a msg, sequenced
+ *   conv.share {req, events}                     → conv.shared {req, cid, count}        key shares, one recipient each
+ *   conv.fetch {req, cid, after, limit?, sharesAfter?} → conv.entries {req, cid, head, entries, shares, more}
+ *   conv.head {req, cids? | after?}              → conv.heads {req, heads, more}
+ *   conv.caps {req, persons}                     → conv.capabilities {req, outdated, unknown?}   who cannot read conversations yet
+ *   relay → conv.push {cid, entry} | {cid, share}   a new entry to the members' online devices; a share to its recipient
+ *
+ * The relay sequences and filters; members verify everything (spec §16.4, §16.7). It never signs an entry.
+ */
+import { z } from "zod";
+/** Appends an op or a msg to its conversation (`event.cid`). The relay answers `conv.ok` once the entry is stored. */
+export declare const ConvAppendFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.append">;
+    req: z.ZodString;
+    event: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        class: z.ZodLiteral<"op">;
+        body: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            op: z.ZodLiteral<"create">;
+            kind: z.ZodEnum<{
+                self: "self";
+                channel: "channel";
+                group: "group";
+                dm: "dm";
+            }>;
+            visibility: z.ZodOptional<z.ZodEnum<{
+                public: "public";
+                private: "private";
+            }>>;
+            history: z.ZodEnum<{
+                none: "none";
+                shared: "shared";
+            }>;
+            retainDays: z.ZodNumber;
+            org: z.ZodOptional<z.ZodString>;
+            participants: z.ZodArray<z.ZodObject<{
+                p: z.ZodString;
+                role: z.ZodEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                    guest: "guest";
+                }>;
+                device: z.ZodOptional<z.ZodString>;
+                respondTo: z.ZodOptional<z.ZodEnum<{
+                    self: "self";
+                    none: "none";
+                    members: "members";
+                }>>;
+            }, z.core.$strict>>;
+            post: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+            invite: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+            pins: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+            sealedMeta: z.ZodOptional<z.ZodString>;
+            admission: z.ZodOptional<z.ZodLiteral<"request">>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"add">;
+            participants: z.ZodArray<z.ZodObject<{
+                p: z.ZodString;
+                role: z.ZodEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                    guest: "guest";
+                }>;
+                device: z.ZodOptional<z.ZodString>;
+                respondTo: z.ZodOptional<z.ZodEnum<{
+                    self: "self";
+                    none: "none";
+                    members: "members";
+                }>>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"accept">;
+            invitation: z.ZodOptional<z.ZodObject<{
+                v: z.ZodLiteral<"messaging/1">;
+                realm: z.ZodString;
+                cid: z.ZodString;
+                id: z.ZodString;
+                to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                inviter: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                by: z.ZodString;
+                head: z.ZodObject<{
+                    seq: z.ZodNumber;
+                    hash: z.ZodString;
+                }, z.core.$strict>;
+                issuedAt: z.ZodNumber;
+                expiresAt: z.ZodNumber;
+                kind: z.ZodEnum<{
+                    channel: "channel";
+                    group: "group";
+                }>;
+                history: z.ZodEnum<{
+                    none: "none";
+                    shared: "shared";
+                }>;
+                agentContext: z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    seats: "seats";
+                }>;
+                bridges: z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    admins: "admins";
+                }>;
+                audience: z.ZodArray<z.ZodObject<{
+                    p: z.ZodString;
+                    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    role: z.ZodEnum<{
+                        admin: "admin";
+                        member: "member";
+                        owner: "owner";
+                        guest: "guest";
+                    }>;
+                    state: z.ZodEnum<{
+                        member: "member";
+                        invited: "invited";
+                    }>;
+                }, z.core.$strict>>;
+                sig: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"activate">;
+            proof: z.ZodUnion<readonly [z.ZodObject<{
+                descriptor: z.ZodObject<{
+                    id: z.ZodString;
+                    issuedAt: z.ZodNumber;
+                    expiresAt: z.ZodNumber;
+                    commitment: z.ZodString;
+                    by: z.ZodString;
+                    sig: z.ZodString;
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                }, z.core.$strict>;
+                decision: z.ZodObject<{
+                    id: z.ZodString;
+                    descriptor: z.ZodString;
+                    answer: z.ZodEnum<{
+                        accept: "accept";
+                        decline: "decline";
+                    }>;
+                    at: z.ZodNumber;
+                    by: z.ZodString;
+                    sig: z.ZodString;
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                }, z.core.$strict>;
+            }, z.core.$strict>, z.ZodObject<{
+                contacts: z.ZodTuple<[z.ZodObject<{
+                    at: z.ZodNumber;
+                    by: z.ZodString;
+                    sig: z.ZodString;
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                }, z.core.$strict>, z.ZodObject<{
+                    at: z.ZodNumber;
+                    by: z.ZodString;
+                    sig: z.ZodString;
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                }, z.core.$strict>], null>;
+            }, z.core.$strict>]>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"request.complete">;
+            request: z.ZodString;
+            seq: z.ZodNumber;
+            digest: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"join">;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"leave">;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"remove">;
+            participants: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"role">;
+            p: z.ZodString;
+            role: z.ZodEnum<{
+                admin: "admin";
+                member: "member";
+                owner: "owner";
+                guest: "guest";
+            }>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"seat">;
+            p: z.ZodString;
+            device: z.ZodOptional<z.ZodString>;
+            respondTo: z.ZodOptional<z.ZodEnum<{
+                self: "self";
+                none: "none";
+                members: "members";
+            }>>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"settings">;
+            visibility: z.ZodOptional<z.ZodEnum<{
+                public: "public";
+                private: "private";
+            }>>;
+            history: z.ZodOptional<z.ZodEnum<{
+                none: "none";
+                shared: "shared";
+            }>>;
+            retainDays: z.ZodOptional<z.ZodNumber>;
+            post: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+            invite: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+            pins: z.ZodOptional<z.ZodEnum<{
+                admins: "admins";
+                all: "all";
+            }>>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"archive">;
+            on: z.ZodBoolean;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"rekey">;
+            epoch: z.ZodNumber;
+            cause: z.ZodEnum<{
+                device: "device";
+                removed: "removed";
+                added: "added";
+                settings: "settings";
+                schedule: "schedule";
+            }>;
+            device: z.ZodOptional<z.ZodString>;
+            until: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"policy">;
+            agentContext: z.ZodOptional<z.ZodEnum<{
+                none: "none";
+                members: "members";
+                seats: "seats";
+            }>>;
+            bridges: z.ZodOptional<z.ZodEnum<{
+                none: "none";
+                members: "members";
+                admins: "admins";
+            }>>;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"meta">;
+            epoch: z.ZodNumber;
+            idx: z.ZodNumber;
+            sealed: z.ZodString;
+        }, z.core.$strict>, z.ZodObject<{
+            op: z.ZodLiteral<"setting">;
+            kind: z.ZodEnum<{
+                link: "link";
+                prefs: "prefs";
+                grant: "grant";
+                context: "context";
+                localRetention: "localRetention";
+            }>;
+            epoch: z.ZodNumber;
+            idx: z.ZodNumber;
+            sealed: z.ZodString;
+        }, z.core.$strict>], "op">;
+        sig: z.ZodString;
+        v: z.ZodLiteral<"messaging/1">;
+        realm: z.ZodString;
+        cid: z.ZodString;
+        id: z.ZodString;
+        by: z.ZodObject<{
+            person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+            device: z.ZodString;
+            agent: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        ts: z.ZodNumber;
+        opHead: z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>;
+        seen: z.ZodOptional<z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>, z.ZodObject<{
+        class: z.ZodLiteral<"msg">;
+        epoch: z.ZodNumber;
+        idx: z.ZodNumber;
+        wake: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        request: z.ZodOptional<z.ZodString>;
+        body: z.ZodString;
+        sig: z.ZodString;
+        v: z.ZodLiteral<"messaging/1">;
+        realm: z.ZodString;
+        cid: z.ZodString;
+        id: z.ZodString;
+        by: z.ZodObject<{
+            person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+            device: z.ZodString;
+            agent: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        ts: z.ZodNumber;
+        opHead: z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>;
+        seen: z.ZodOptional<z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>], "class">;
+}, z.core.$strict>;
+export type ConvAppendFrame = z.infer<typeof ConvAppendFrame>;
+/**
+ * Stores key shares (spec §16.6): each event to one recipient device, all of one conversation and by the sending
+ * device. All or none are stored; the relay answers `conv.shared` once they are.
+ */
+export declare const ConvShareFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.share">;
+    req: z.ZodString;
+    events: z.ZodArray<z.ZodObject<{
+        class: z.ZodLiteral<"keys">;
+        body: z.ZodObject<{
+            to: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+            }, z.core.$strict>;
+            epk: z.ZodString;
+            nonce: z.ZodString;
+            ct: z.ZodString;
+        }, z.core.$strict>;
+        sig: z.ZodString;
+        v: z.ZodLiteral<"messaging/1">;
+        realm: z.ZodString;
+        cid: z.ZodString;
+        id: z.ZodString;
+        by: z.ZodObject<{
+            person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+            device: z.ZodString;
+            agent: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        ts: z.ZodNumber;
+        opHead: z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>;
+        seen: z.ZodOptional<z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type ConvShareFrame = z.infer<typeof ConvShareFrame>;
+/**
+ * The entries of `cid` after `after`, in seq order, at most `limit` (and `LIMITS.convFetchEntries`) and as many as
+ * fit in a frame. `sharesAfter`: also the shares to this device after that `n`; absent, no shares.
+ */
+export declare const ConvFetchFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.fetch">;
+    req: z.ZodString;
+    cid: z.ZodString;
+    after: z.ZodNumber;
+    limit: z.ZodOptional<z.ZodNumber>;
+    sharesAfter: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type ConvFetchFrame = z.infer<typeof ConvFetchFrame>;
+/**
+ * The heads of the named conversations, or, without `cids`, of every conversation this device's person takes part in,
+ * by cid after `after`, at most `LIMITS.convHeads`.
+ */
+export declare const ConvHeadFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.head">;
+    req: z.ZodString;
+    cids: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    after: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ConvHeadFrame = z.infer<typeof ConvHeadFrame>;
+/**
+ * Which of these persons cannot read conversations yet: every current device of theirs whose latest presence the
+ * relay holds names no `conversations` feature (a daemon before the cut-over). A person with no such presence is not
+ * named. A hint from the relay: it can only make a sender refuse, never admit anything.
+ */
+export declare const ConvCapsFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.caps">;
+    req: z.ZodString;
+    persons: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>;
+}, z.core.$strict>;
+export type ConvCapsFrame = z.infer<typeof ConvCapsFrame>;
+/** `conv.append` stored: the entry's seq and h(seq), which the author recomputes. */
+export declare const ConvOkFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.ok">;
+    req: z.ZodString;
+    cid: z.ZodString;
+    seq: z.ZodNumber;
+    hash: z.ZodString;
+}, z.core.$strict>;
+export type ConvOkFrame = z.infer<typeof ConvOkFrame>;
+/** `conv.share` stored: how many shares. */
+export declare const ConvSharedFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.shared">;
+    req: z.ZodString;
+    cid: z.ZodString;
+    count: z.ZodNumber;
+}, z.core.$strict>;
+export type ConvSharedFrame = z.infer<typeof ConvSharedFrame>;
+/**
+ * `conv.fetch`'s answer: the relay's head, the entries (an expired `msg` as its digest, `ConvExpiredEntry`) and this
+ * device's shares. `more`: ask again after the last entry (and the last share).
+ */
+export declare const ConvEntriesFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.entries">;
+    req: z.ZodString;
+    cid: z.ZodString;
+    head: z.ZodObject<{
+        seq: z.ZodNumber;
+        hash: z.ZodString;
+    }, z.core.$strict>;
+    entries: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        seq: z.ZodNumber;
+        prev: z.ZodString;
+        event: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            class: z.ZodLiteral<"op">;
+            body: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                op: z.ZodLiteral<"create">;
+                kind: z.ZodEnum<{
+                    self: "self";
+                    channel: "channel";
+                    group: "group";
+                    dm: "dm";
+                }>;
+                visibility: z.ZodOptional<z.ZodEnum<{
+                    public: "public";
+                    private: "private";
+                }>>;
+                history: z.ZodEnum<{
+                    none: "none";
+                    shared: "shared";
+                }>;
+                retainDays: z.ZodNumber;
+                org: z.ZodOptional<z.ZodString>;
+                participants: z.ZodArray<z.ZodObject<{
+                    p: z.ZodString;
+                    role: z.ZodEnum<{
+                        admin: "admin";
+                        member: "member";
+                        owner: "owner";
+                        guest: "guest";
+                    }>;
+                    device: z.ZodOptional<z.ZodString>;
+                    respondTo: z.ZodOptional<z.ZodEnum<{
+                        self: "self";
+                        none: "none";
+                        members: "members";
+                    }>>;
+                }, z.core.$strict>>;
+                post: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                invite: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                pins: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                sealedMeta: z.ZodOptional<z.ZodString>;
+                admission: z.ZodOptional<z.ZodLiteral<"request">>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"add">;
+                participants: z.ZodArray<z.ZodObject<{
+                    p: z.ZodString;
+                    role: z.ZodEnum<{
+                        admin: "admin";
+                        member: "member";
+                        owner: "owner";
+                        guest: "guest";
+                    }>;
+                    device: z.ZodOptional<z.ZodString>;
+                    respondTo: z.ZodOptional<z.ZodEnum<{
+                        self: "self";
+                        none: "none";
+                        members: "members";
+                    }>>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"accept">;
+                invitation: z.ZodOptional<z.ZodObject<{
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    id: z.ZodString;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    inviter: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    by: z.ZodString;
+                    head: z.ZodObject<{
+                        seq: z.ZodNumber;
+                        hash: z.ZodString;
+                    }, z.core.$strict>;
+                    issuedAt: z.ZodNumber;
+                    expiresAt: z.ZodNumber;
+                    kind: z.ZodEnum<{
+                        channel: "channel";
+                        group: "group";
+                    }>;
+                    history: z.ZodEnum<{
+                        none: "none";
+                        shared: "shared";
+                    }>;
+                    agentContext: z.ZodEnum<{
+                        none: "none";
+                        members: "members";
+                        seats: "seats";
+                    }>;
+                    bridges: z.ZodEnum<{
+                        none: "none";
+                        members: "members";
+                        admins: "admins";
+                    }>;
+                    audience: z.ZodArray<z.ZodObject<{
+                        p: z.ZodString;
+                        person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        role: z.ZodEnum<{
+                            admin: "admin";
+                            member: "member";
+                            owner: "owner";
+                            guest: "guest";
+                        }>;
+                        state: z.ZodEnum<{
+                            member: "member";
+                            invited: "invited";
+                        }>;
+                    }, z.core.$strict>>;
+                    sig: z.ZodString;
+                }, z.core.$strict>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"activate">;
+                proof: z.ZodUnion<readonly [z.ZodObject<{
+                    descriptor: z.ZodObject<{
+                        id: z.ZodString;
+                        issuedAt: z.ZodNumber;
+                        expiresAt: z.ZodNumber;
+                        commitment: z.ZodString;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>;
+                    decision: z.ZodObject<{
+                        id: z.ZodString;
+                        descriptor: z.ZodString;
+                        answer: z.ZodEnum<{
+                            accept: "accept";
+                            decline: "decline";
+                        }>;
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>;
+                }, z.core.$strict>, z.ZodObject<{
+                    contacts: z.ZodTuple<[z.ZodObject<{
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>, z.ZodObject<{
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>], null>;
+                }, z.core.$strict>]>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"request.complete">;
+                request: z.ZodString;
+                seq: z.ZodNumber;
+                digest: z.ZodString;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"join">;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"leave">;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"remove">;
+                participants: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"role">;
+                p: z.ZodString;
+                role: z.ZodEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                    guest: "guest";
+                }>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"seat">;
+                p: z.ZodString;
+                device: z.ZodOptional<z.ZodString>;
+                respondTo: z.ZodOptional<z.ZodEnum<{
+                    self: "self";
+                    none: "none";
+                    members: "members";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"settings">;
+                visibility: z.ZodOptional<z.ZodEnum<{
+                    public: "public";
+                    private: "private";
+                }>>;
+                history: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    shared: "shared";
+                }>>;
+                retainDays: z.ZodOptional<z.ZodNumber>;
+                post: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                invite: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                pins: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"archive">;
+                on: z.ZodBoolean;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"rekey">;
+                epoch: z.ZodNumber;
+                cause: z.ZodEnum<{
+                    device: "device";
+                    removed: "removed";
+                    added: "added";
+                    settings: "settings";
+                    schedule: "schedule";
+                }>;
+                device: z.ZodOptional<z.ZodString>;
+                until: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"policy">;
+                agentContext: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    seats: "seats";
+                }>>;
+                bridges: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    admins: "admins";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"meta">;
+                epoch: z.ZodNumber;
+                idx: z.ZodNumber;
+                sealed: z.ZodString;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"setting">;
+                kind: z.ZodEnum<{
+                    link: "link";
+                    prefs: "prefs";
+                    grant: "grant";
+                    context: "context";
+                    localRetention: "localRetention";
+                }>;
+                epoch: z.ZodNumber;
+                idx: z.ZodNumber;
+                sealed: z.ZodString;
+            }, z.core.$strict>], "op">;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>, z.ZodObject<{
+            class: z.ZodLiteral<"msg">;
+            epoch: z.ZodNumber;
+            idx: z.ZodNumber;
+            wake: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            request: z.ZodOptional<z.ZodString>;
+            body: z.ZodString;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>], "class">;
+    }, z.core.$strict>, z.ZodObject<{
+        seq: z.ZodNumber;
+        prev: z.ZodString;
+        digest: z.ZodString;
+    }, z.core.$strict>]>>;
+    shares: z.ZodArray<z.ZodObject<{
+        n: z.ZodNumber;
+        event: z.ZodObject<{
+            class: z.ZodLiteral<"keys">;
+            body: z.ZodObject<{
+                to: z.ZodObject<{
+                    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    device: z.ZodString;
+                }, z.core.$strict>;
+                epk: z.ZodString;
+                nonce: z.ZodString;
+                ct: z.ZodString;
+            }, z.core.$strict>;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    more: z.ZodBoolean;
+}, z.core.$strict>;
+export type ConvEntriesFrame = z.infer<typeof ConvEntriesFrame>;
+/** One conversation's position at the relay: its head, its op head, and the last share `n` for this device (0: none). */
+export declare const ConvHeadView: z.ZodObject<{
+    cid: z.ZodString;
+    head: z.ZodObject<{
+        seq: z.ZodNumber;
+        hash: z.ZodString;
+    }, z.core.$strict>;
+    opHead: z.ZodObject<{
+        seq: z.ZodNumber;
+        hash: z.ZodString;
+    }, z.core.$strict>;
+    shares: z.ZodNumber;
+}, z.core.$strict>;
+export type ConvHeadView = z.infer<typeof ConvHeadView>;
+/** `conv.head`'s answer. A named conversation this device's person is not in is left out, as one that does not exist. */
+export declare const ConvHeadsFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.heads">;
+    req: z.ZodString;
+    heads: z.ZodArray<z.ZodObject<{
+        cid: z.ZodString;
+        head: z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>;
+        opHead: z.ZodObject<{
+            seq: z.ZodNumber;
+            hash: z.ZodString;
+        }, z.core.$strict>;
+        shares: z.ZodNumber;
+    }, z.core.$strict>>;
+    more: z.ZodBoolean;
+}, z.core.$strict>;
+export type ConvHeadsFrame = z.infer<typeof ConvHeadsFrame>;
+/**
+ * `conv.caps`'s answer: the named persons that cannot read conversations yet, and, only when there are any, the
+ * persons it says nothing about (`unknown`: unrelated persons past the asker's daily budget).
+ */
+export declare const ConvCapabilitiesFrame: z.ZodObject<{
+    t: z.ZodLiteral<"conv.capabilities">;
+    req: z.ZodString;
+    outdated: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>;
+    unknown: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>>;
+}, z.core.$strict>;
+export type ConvCapabilitiesFrame = z.infer<typeof ConvCapabilitiesFrame>;
+/** A new entry, to the online devices of the conversation's participant persons; or a new share, to its recipient. */
+export declare const ConvPushFrame: z.ZodUnion<readonly [z.ZodObject<{
+    t: z.ZodLiteral<"conv.push">;
+    cid: z.ZodString;
+    entry: z.ZodObject<{
+        seq: z.ZodNumber;
+        prev: z.ZodString;
+        event: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            class: z.ZodLiteral<"op">;
+            body: z.ZodDiscriminatedUnion<[z.ZodObject<{
+                op: z.ZodLiteral<"create">;
+                kind: z.ZodEnum<{
+                    self: "self";
+                    channel: "channel";
+                    group: "group";
+                    dm: "dm";
+                }>;
+                visibility: z.ZodOptional<z.ZodEnum<{
+                    public: "public";
+                    private: "private";
+                }>>;
+                history: z.ZodEnum<{
+                    none: "none";
+                    shared: "shared";
+                }>;
+                retainDays: z.ZodNumber;
+                org: z.ZodOptional<z.ZodString>;
+                participants: z.ZodArray<z.ZodObject<{
+                    p: z.ZodString;
+                    role: z.ZodEnum<{
+                        admin: "admin";
+                        member: "member";
+                        owner: "owner";
+                        guest: "guest";
+                    }>;
+                    device: z.ZodOptional<z.ZodString>;
+                    respondTo: z.ZodOptional<z.ZodEnum<{
+                        self: "self";
+                        none: "none";
+                        members: "members";
+                    }>>;
+                }, z.core.$strict>>;
+                post: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                invite: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                pins: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                sealedMeta: z.ZodOptional<z.ZodString>;
+                admission: z.ZodOptional<z.ZodLiteral<"request">>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"add">;
+                participants: z.ZodArray<z.ZodObject<{
+                    p: z.ZodString;
+                    role: z.ZodEnum<{
+                        admin: "admin";
+                        member: "member";
+                        owner: "owner";
+                        guest: "guest";
+                    }>;
+                    device: z.ZodOptional<z.ZodString>;
+                    respondTo: z.ZodOptional<z.ZodEnum<{
+                        self: "self";
+                        none: "none";
+                        members: "members";
+                    }>>;
+                }, z.core.$strict>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"accept">;
+                invitation: z.ZodOptional<z.ZodObject<{
+                    v: z.ZodLiteral<"messaging/1">;
+                    realm: z.ZodString;
+                    cid: z.ZodString;
+                    id: z.ZodString;
+                    to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    inviter: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    by: z.ZodString;
+                    head: z.ZodObject<{
+                        seq: z.ZodNumber;
+                        hash: z.ZodString;
+                    }, z.core.$strict>;
+                    issuedAt: z.ZodNumber;
+                    expiresAt: z.ZodNumber;
+                    kind: z.ZodEnum<{
+                        channel: "channel";
+                        group: "group";
+                    }>;
+                    history: z.ZodEnum<{
+                        none: "none";
+                        shared: "shared";
+                    }>;
+                    agentContext: z.ZodEnum<{
+                        none: "none";
+                        members: "members";
+                        seats: "seats";
+                    }>;
+                    bridges: z.ZodEnum<{
+                        none: "none";
+                        members: "members";
+                        admins: "admins";
+                    }>;
+                    audience: z.ZodArray<z.ZodObject<{
+                        p: z.ZodString;
+                        person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        role: z.ZodEnum<{
+                            admin: "admin";
+                            member: "member";
+                            owner: "owner";
+                            guest: "guest";
+                        }>;
+                        state: z.ZodEnum<{
+                            member: "member";
+                            invited: "invited";
+                        }>;
+                    }, z.core.$strict>>;
+                    sig: z.ZodString;
+                }, z.core.$strict>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"activate">;
+                proof: z.ZodUnion<readonly [z.ZodObject<{
+                    descriptor: z.ZodObject<{
+                        id: z.ZodString;
+                        issuedAt: z.ZodNumber;
+                        expiresAt: z.ZodNumber;
+                        commitment: z.ZodString;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>;
+                    decision: z.ZodObject<{
+                        id: z.ZodString;
+                        descriptor: z.ZodString;
+                        answer: z.ZodEnum<{
+                            accept: "accept";
+                            decline: "decline";
+                        }>;
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>;
+                }, z.core.$strict>, z.ZodObject<{
+                    contacts: z.ZodTuple<[z.ZodObject<{
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>, z.ZodObject<{
+                        at: z.ZodNumber;
+                        by: z.ZodString;
+                        sig: z.ZodString;
+                        v: z.ZodLiteral<"messaging/1">;
+                        realm: z.ZodString;
+                        cid: z.ZodString;
+                        from: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                        to: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    }, z.core.$strict>], null>;
+                }, z.core.$strict>]>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"request.complete">;
+                request: z.ZodString;
+                seq: z.ZodNumber;
+                digest: z.ZodString;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"join">;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"leave">;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"remove">;
+                participants: z.ZodArray<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"role">;
+                p: z.ZodString;
+                role: z.ZodEnum<{
+                    admin: "admin";
+                    member: "member";
+                    owner: "owner";
+                    guest: "guest";
+                }>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"seat">;
+                p: z.ZodString;
+                device: z.ZodOptional<z.ZodString>;
+                respondTo: z.ZodOptional<z.ZodEnum<{
+                    self: "self";
+                    none: "none";
+                    members: "members";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"settings">;
+                visibility: z.ZodOptional<z.ZodEnum<{
+                    public: "public";
+                    private: "private";
+                }>>;
+                history: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    shared: "shared";
+                }>>;
+                retainDays: z.ZodOptional<z.ZodNumber>;
+                post: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                invite: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+                pins: z.ZodOptional<z.ZodEnum<{
+                    admins: "admins";
+                    all: "all";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"archive">;
+                on: z.ZodBoolean;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"rekey">;
+                epoch: z.ZodNumber;
+                cause: z.ZodEnum<{
+                    device: "device";
+                    removed: "removed";
+                    added: "added";
+                    settings: "settings";
+                    schedule: "schedule";
+                }>;
+                device: z.ZodOptional<z.ZodString>;
+                until: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"policy">;
+                agentContext: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    seats: "seats";
+                }>>;
+                bridges: z.ZodOptional<z.ZodEnum<{
+                    none: "none";
+                    members: "members";
+                    admins: "admins";
+                }>>;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"meta">;
+                epoch: z.ZodNumber;
+                idx: z.ZodNumber;
+                sealed: z.ZodString;
+            }, z.core.$strict>, z.ZodObject<{
+                op: z.ZodLiteral<"setting">;
+                kind: z.ZodEnum<{
+                    link: "link";
+                    prefs: "prefs";
+                    grant: "grant";
+                    context: "context";
+                    localRetention: "localRetention";
+                }>;
+                epoch: z.ZodNumber;
+                idx: z.ZodNumber;
+                sealed: z.ZodString;
+            }, z.core.$strict>], "op">;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>, z.ZodObject<{
+            class: z.ZodLiteral<"msg">;
+            epoch: z.ZodNumber;
+            idx: z.ZodNumber;
+            wake: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            request: z.ZodOptional<z.ZodString>;
+            body: z.ZodString;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>], "class">;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    t: z.ZodLiteral<"conv.push">;
+    cid: z.ZodString;
+    share: z.ZodObject<{
+        n: z.ZodNumber;
+        event: z.ZodObject<{
+            class: z.ZodLiteral<"keys">;
+            body: z.ZodObject<{
+                to: z.ZodObject<{
+                    person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                    device: z.ZodString;
+                }, z.core.$strict>;
+                epk: z.ZodString;
+                nonce: z.ZodString;
+                ct: z.ZodString;
+            }, z.core.$strict>;
+            sig: z.ZodString;
+            v: z.ZodLiteral<"messaging/1">;
+            realm: z.ZodString;
+            cid: z.ZodString;
+            id: z.ZodString;
+            by: z.ZodObject<{
+                person: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                device: z.ZodString;
+                agent: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            ts: z.ZodNumber;
+            opHead: z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>;
+            seen: z.ZodOptional<z.ZodObject<{
+                seq: z.ZodNumber;
+                hash: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+}, z.core.$strict>]>;
+export type ConvPushFrame = z.infer<typeof ConvPushFrame>;
+/** The conversation frames' types, for the relay's dispatch and `/metrics`. */
+export declare const CONV_FRAMES: readonly ["conv.append", "conv.share", "conv.fetch", "conv.head", "conv.caps"];
+export declare const CONV_REPLIES: readonly ["conv.ok", "conv.shared", "conv.entries", "conv.heads", "conv.capabilities", "conv.push"];