@joe-broadhead/messaging 0.8.0 → 0.9.0

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

@@ -86,8 +86,48 @@ export declare const GrantSetParams: z.ZodObject<{
     }, z.core.$strict>]>;
 }, z.core.$strict>;
 export type GrantSetParams = z.infer<typeof GrantSetParams>;
+/**
+ * For an ask: `once` delivers it, guarded; `always` sets the sender's grant to `ask: "open"` (keeping its other
+ * levels), then delivers it, guarded. For a message request: `accept` sets the sender's grant to `chat: "open"`
+ * (keeping its other levels), files the request as their first line and sends them a card. For both: `decline`
+ * refuses it (`declined`); `block` sets the sender's grant to `chat: "blocked"` (keeping its other levels), then
+ * declines it. For a suggestion: `decline` dismisses it.
+ */
+export declare const RequestAnswer: z.ZodEnum<{
+    accept: "accept";
+    decline: "decline";
+    once: "once";
+    always: "always";
+    block: "block";
+}>;
+export type RequestAnswer = z.infer<typeof RequestAnswer>;
+/**
+ * A source-issued action on a held request (spec §8.2, "Action tokens"): `name` is the answer it gives, redeemed with
+ * `request.answer {id, answer: name, token}` on the connection that read it.
+ */
+export declare const RequestAction: z.ZodObject<{
+    name: z.ZodEnum<{
+        accept: "accept";
+        decline: "decline";
+        once: "once";
+        always: "always";
+        block: "block";
+    }>;
+    token: z.ZodString;
+}, z.core.$strict>;
+export type RequestAction = z.infer<typeof RequestAction>;
 /** A request this device holds for its person to answer (spec §6.9, "Holds"): mail or a task to one of their agents. */
 export declare const AskRequest: z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodEnum<{
         message: "message";
@@ -111,6 +151,16 @@ export type AskRequest = z.infer<typeof AskRequest>;
  * write to them. `name`, `email` and `org` are the realm's verified profile of the sender, never the request's text.
  */
 export declare const ContactRequestView: z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodLiteral<"contact">;
     cid: z.ZodOptional<z.ZodString>;
@@ -138,6 +188,16 @@ export declare const ContactRequestView: z.ZodObject<{
 }, z.core.$strip>;
 export type ContactRequestView = z.infer<typeof ContactRequestView>;
 export declare const AgentInvitationRequest: z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     kind: z.ZodLiteral<"agent-invitation">;
     id: z.ZodString;
     cid: z.ZodString;
@@ -152,6 +212,16 @@ export type AgentInvitationRequest = z.infer<typeof AgentInvitationRequest>;
  * dismisses it.
  */
 export declare const ContactSuggestion: z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodLiteral<"suggestion">;
     agent: z.ZodString;
@@ -161,6 +231,16 @@ export declare const ContactSuggestion: z.ZodObject<{
 export type ContactSuggestion = z.infer<typeof ContactSuggestion>;
 /** What `request.list` lists: asks to the person's agents, message requests, and contacts their agents suggest. */
 export declare const HeldRequest: z.ZodUnion<readonly [z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodEnum<{
         message: "message";
@@ -178,6 +258,16 @@ export declare const HeldRequest: z.ZodUnion<readonly [z.ZodObject<{
     at: z.ZodNumber;
     exp: z.ZodNumber;
 }, z.core.$strip>, z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodLiteral<"contact">;
     cid: z.ZodOptional<z.ZodString>;
@@ -203,12 +293,32 @@ export declare const HeldRequest: z.ZodUnion<readonly [z.ZodObject<{
     at: z.ZodNumber;
     exp: z.ZodNumber;
 }, z.core.$strip>, z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     id: z.ZodString;
     kind: z.ZodLiteral<"suggestion">;
     agent: z.ZodString;
     email: z.ZodString;
     at: z.ZodNumber;
 }, z.core.$strip>, z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodEnum<{
+            accept: "accept";
+            decline: "decline";
+            once: "once";
+            always: "always";
+            block: "block";
+        }>;
+        token: z.ZodString;
+    }, z.core.$strict>>>;
     kind: z.ZodLiteral<"agent-invitation">;
     id: z.ZodString;
     cid: z.ZodString;
@@ -217,21 +327,6 @@ export declare const HeldRequest: z.ZodUnion<readonly [z.ZodObject<{
     at: z.ZodNumber;
 }, z.core.$strict>]>;
 export type HeldRequest = z.infer<typeof HeldRequest>;
-/**
- * For an ask: `once` delivers it, guarded; `always` sets the sender's grant to `ask: "open"` (keeping its other
- * levels), then delivers it, guarded. For a message request: `accept` sets the sender's grant to `chat: "open"`
- * (keeping its other levels), files the request as their first line and sends them a card. For both: `decline`
- * refuses it (`declined`); `block` sets the sender's grant to `chat: "blocked"` (keeping its other levels), then
- * declines it. For a suggestion: `decline` dismisses it.
- */
-export declare const RequestAnswer: z.ZodEnum<{
-    accept: "accept";
-    decline: "decline";
-    once: "once";
-    always: "always";
-    block: "block";
-}>;
-export type RequestAnswer = z.infer<typeof RequestAnswer>;
 /** A message request's text: 1 to `LIMITS.requestChars` UTF-16 code units. */
 export declare const RequestText: z.ZodString;
 /**
@@ -263,6 +358,10 @@ export declare const PersonReach: z.ZodObject<{
 }, z.core.$strip>;
 export type PersonReach = z.infer<typeof PersonReach>;
 /** `request.answer`'s params, which `request.answer.preview` takes too (spec §8.2, "Previews"). */
+/**
+ * `request.answer`'s params. `token` is the request's action for this `answer` (`RequestAction`); it answers that one
+ * request, so it never comes with `all`. Under a Jelly host it is required.
+ */
 export declare const RequestAnswerParams: z.ZodObject<{
     id: z.ZodString;
     answer: z.ZodEnum<{
@@ -273,6 +372,7 @@ export declare const RequestAnswerParams: z.ZodObject<{
         block: "block";
     }>;
     all: z.ZodOptional<z.ZodBoolean>;
+    token: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 /** `contact.request`'s params; its preview takes them with `text` optional (it reads only `email`). */
 export declare const ContactRequestParams: z.ZodObject<{
@@ -280,7 +380,227 @@ export declare const ContactRequestParams: z.ZodObject<{
     text: z.ZodString;
     suggestion: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
+/** A reach question (spec §6.9, "Reach choices"): `message` is "Who can message you", `ask` "How agents may ask yours". */
+export declare const ReachGroupId: z.ZodEnum<{
+    message: "message";
+    ask: "ask";
+}>;
+export type ReachGroupId = z.infer<typeof ReachGroupId>;
+/** An answer: Open, Ask me first (the default), Never. */
+export declare const ReachValue: z.ZodEnum<{
+    never: "never";
+    ask: "ask";
+    open: "open";
+}>;
+export type ReachValue = z.infer<typeof ReachValue>;
+export declare const ReachOption: z.ZodObject<{
+    value: z.ZodEnum<{
+        never: "never";
+        ask: "ask";
+        open: "open";
+    }>;
+    label: z.ZodString;
+    description: z.ZodString;
+}, z.core.$strip>;
+export type ReachOption = z.infer<typeof ReachOption>;
+/**
+ * One question with its options. `value` is the person's choice, or null while they have made none and the relation
+ * defaults apply. `lapsed` is a choice a removed device of the person made, which lapsed with it (§6.9, "Signers")
+ * and waits for the person to choose again.
+ */
+export declare const ReachGroup: z.ZodObject<{
+    id: z.ZodEnum<{
+        message: "message";
+        ask: "ask";
+    }>;
+    label: z.ZodString;
+    options: z.ZodArray<z.ZodObject<{
+        value: z.ZodEnum<{
+            never: "never";
+            ask: "ask";
+            open: "open";
+        }>;
+        label: z.ZodString;
+        description: z.ZodString;
+    }, z.core.$strip>>;
+    value: z.ZodNullable<z.ZodEnum<{
+        never: "never";
+        ask: "ask";
+        open: "open";
+    }>>;
+    lapsed: z.ZodOptional<z.ZodEnum<{
+        never: "never";
+        ask: "ask";
+        open: "open";
+    }>>;
+}, z.core.$strip>;
+export type ReachGroup = z.infer<typeof ReachGroup>;
+/** `reach.get`'s result, and `reach.set`'s: both questions, and a `revision` that changes whenever either choice does. */
+export declare const ReachSnapshot: z.ZodObject<{
+    revision: z.ZodString;
+    available: z.ZodBoolean;
+    groups: z.ZodArray<z.ZodObject<{
+        id: z.ZodEnum<{
+            message: "message";
+            ask: "ask";
+        }>;
+        label: z.ZodString;
+        options: z.ZodArray<z.ZodObject<{
+            value: z.ZodEnum<{
+                never: "never";
+                ask: "ask";
+                open: "open";
+            }>;
+            label: z.ZodString;
+            description: z.ZodString;
+        }, z.core.$strip>>;
+        value: z.ZodNullable<z.ZodEnum<{
+            never: "never";
+            ask: "ask";
+            open: "open";
+        }>>;
+        lapsed: z.ZodOptional<z.ZodEnum<{
+            never: "never";
+            ask: "ask";
+            open: "open";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ReachSnapshot = z.infer<typeof ReachSnapshot>;
+/** `reach.set`'s params, which `reach.set.preview` takes too: the `revision` read, and only the declared answers that change. */
+export declare const ReachSetParams: z.ZodObject<{
+    revision: z.ZodString;
+    changes: z.ZodObject<{
+        message: z.ZodOptional<z.ZodEnum<{
+            never: "never";
+            ask: "ask";
+            open: "open";
+        }>>;
+        ask: z.ZodOptional<z.ZodEnum<{
+            never: "never";
+            ask: "ask";
+            open: "open";
+        }>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type ReachSetParams = z.infer<typeof ReachSetParams>;
+/** The fixed words of the two questions, in `reach.get`'s order. */
+export declare const REACH_QUESTIONS: readonly {
+    id: ReachGroupId;
+    label: string;
+    options: readonly ReachOption[];
+}[];
 export declare const CONSENT_METHODS: {
+    /**
+     * The person's two reach choices (spec §6.9, "Reach choices"), each with its options and the current value (null:
+     * none made, the defaults apply), and a revision. Read-only.
+     */
+    readonly "reach.get": {
+        readonly params: z.ZodObject<{}, z.core.$strict>;
+        readonly result: z.ZodObject<{
+            revision: z.ZodString;
+            available: z.ZodBoolean;
+            groups: z.ZodArray<z.ZodObject<{
+                id: z.ZodEnum<{
+                    message: "message";
+                    ask: "ask";
+                }>;
+                label: z.ZodString;
+                options: z.ZodArray<z.ZodObject<{
+                    value: z.ZodEnum<{
+                        never: "never";
+                        ask: "ask";
+                        open: "open";
+                    }>;
+                    label: z.ZodString;
+                    description: z.ZodString;
+                }, z.core.$strip>>;
+                value: z.ZodNullable<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+                lapsed: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    };
+    /**
+     * Records the declared answers in `changes` as the person's relation grants, signed by this device and sent to
+     * their other devices, in one transaction; returns the new snapshot. `conflict` when `revision` is not the current
+     * one: nothing is changed, and the caller reads again.
+     */
+    readonly "reach.set": {
+        readonly params: z.ZodObject<{
+            revision: z.ZodString;
+            changes: z.ZodObject<{
+                message: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+                ask: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+            }, z.core.$strict>;
+        }, z.core.$strict>;
+        readonly result: z.ZodObject<{
+            revision: z.ZodString;
+            available: z.ZodBoolean;
+            groups: z.ZodArray<z.ZodObject<{
+                id: z.ZodEnum<{
+                    message: "message";
+                    ask: "ask";
+                }>;
+                label: z.ZodString;
+                options: z.ZodArray<z.ZodObject<{
+                    value: z.ZodEnum<{
+                        never: "never";
+                        ask: "ask";
+                        open: "open";
+                    }>;
+                    label: z.ZodString;
+                    description: z.ZodString;
+                }, z.core.$strip>>;
+                value: z.ZodNullable<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+                lapsed: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    };
+    /** What `reach.set` with these params would do, in one fixed sentence; checks them the same way (`conflict` too); changes nothing. */
+    readonly "reach.set.preview": {
+        readonly params: z.ZodObject<{
+            revision: z.ZodString;
+            changes: z.ZodObject<{
+                message: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+                ask: z.ZodOptional<z.ZodEnum<{
+                    never: "never";
+                    ask: "ask";
+                    open: "open";
+                }>>;
+            }, z.core.$strict>;
+        }, z.core.$strict>;
+        readonly result: z.ZodObject<{
+            sentence: z.ZodString;
+        }, z.core.$strip>;
+    };
     /** This person's grants, newest first, and the review list. With `subject`, only that subject's. */
     readonly "grant.list": {
         readonly params: z.ZodObject<{
@@ -430,6 +750,16 @@ export declare const CONSENT_METHODS: {
         readonly params: z.ZodObject<{}, z.core.$strict>;
         readonly result: z.ZodObject<{
             requests: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+                actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodEnum<{
+                        accept: "accept";
+                        decline: "decline";
+                        once: "once";
+                        always: "always";
+                        block: "block";
+                    }>;
+                    token: z.ZodString;
+                }, z.core.$strict>>>;
                 id: z.ZodString;
                 kind: z.ZodEnum<{
                     message: "message";
@@ -447,6 +777,16 @@ export declare const CONSENT_METHODS: {
                 at: z.ZodNumber;
                 exp: z.ZodNumber;
             }, z.core.$strip>, z.ZodObject<{
+                actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodEnum<{
+                        accept: "accept";
+                        decline: "decline";
+                        once: "once";
+                        always: "always";
+                        block: "block";
+                    }>;
+                    token: z.ZodString;
+                }, z.core.$strict>>>;
                 id: z.ZodString;
                 kind: z.ZodLiteral<"contact">;
                 cid: z.ZodOptional<z.ZodString>;
@@ -472,12 +812,32 @@ export declare const CONSENT_METHODS: {
                 at: z.ZodNumber;
                 exp: z.ZodNumber;
             }, z.core.$strip>, z.ZodObject<{
+                actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodEnum<{
+                        accept: "accept";
+                        decline: "decline";
+                        once: "once";
+                        always: "always";
+                        block: "block";
+                    }>;
+                    token: z.ZodString;
+                }, z.core.$strict>>>;
                 id: z.ZodString;
                 kind: z.ZodLiteral<"suggestion">;
                 agent: z.ZodString;
                 email: z.ZodString;
                 at: z.ZodNumber;
             }, z.core.$strip>, z.ZodObject<{
+                actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    name: z.ZodEnum<{
+                        accept: "accept";
+                        decline: "decline";
+                        once: "once";
+                        always: "always";
+                        block: "block";
+                    }>;
+                    token: z.ZodString;
+                }, z.core.$strict>>>;
                 kind: z.ZodLiteral<"agent-invitation">;
                 id: z.ZodString;
                 cid: z.ZodString;
@@ -503,6 +863,7 @@ export declare const CONSENT_METHODS: {
                 block: "block";
             }>;
             all: z.ZodOptional<z.ZodBoolean>;
+            token: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>;
         readonly result: z.ZodObject<{
             answered: z.ZodArray<z.ZodString>;
@@ -526,6 +887,7 @@ export declare const CONSENT_METHODS: {
                 block: "block";
             }>;
             all: z.ZodOptional<z.ZodBoolean>;
+            token: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>;
         readonly result: z.ZodObject<{
             kind: z.ZodEnum<{