@peers-app/peers-sdk 0.23.14 → 0.25.0

package/dist/invites/invite-messages.d.ts

@@ -0,0 +1,1354 @@
+import { z } from "zod";
+import { type IPublicPrivateKeys } from "../keys";
+/** Recipient accepted a contact token; carries their identity back to the inviter. */
+export declare const contactReplySchema: z.ZodObject<{
+    kind: z.ZodLiteral<"contact-reply">;
+    /** Nonce and epoch of the token that was accepted. */
+    inviteNonce: z.ZodString;
+    inviteEpoch: z.ZodNumber;
+    responder: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    responderDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "contact-reply";
+    responder: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    inviteNonce: string;
+    inviteEpoch: number;
+    responderDeviceId: string;
+}, {
+    kind: "contact-reply";
+    responder: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    inviteNonce: string;
+    inviteEpoch: number;
+    responderDeviceId: string;
+}>;
+/** Recipient accepted a contact token. */
+export type ContactReply = z.infer<typeof contactReplySchema>;
+/** Joiner asks to be admitted under a group token (approve or open mode). */
+export declare const groupJoinRequestSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"group-join-request">;
+    token: z.ZodObject<{
+        v: z.ZodLiteral<1>;
+        type: z.ZodEnum<["contact", "group"]>;
+        inviter: z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        }, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        }>;
+        expiresAt: z.ZodString;
+        nonce: z.ZodString;
+        epoch: z.ZodNumber;
+        uses: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<"unlimited">]>;
+        group: z.ZodOptional<z.ZodObject<{
+            groupId: z.ZodEffects<z.ZodString, string, string>;
+            name: z.ZodString;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+            mode: z.ZodEnum<["approve", "open"]>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        }, {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        }>>;
+        signature: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    }, {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    }>;
+    requester: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    requesterDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "group-join-request";
+    token: {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    };
+    requester: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    requesterDeviceId: string;
+}, {
+    kind: "group-join-request";
+    token: {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    };
+    requester: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    requesterDeviceId: string;
+}>;
+/** Joiner asks to be admitted under a group token. */
+export type GroupJoinRequest = z.infer<typeof groupJoinRequestSchema>;
+/**
+ * Everything a joiner needs to enter a group: the group record, their signed membership,
+ * Admin+ seed rows, the approver's identity, and the group secret boxed to the joiner.
+ */
+export declare const groupApprovalSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"group-approval">;
+    /** Nonce of the token or direct invite this approval answers, when there is one. */
+    inviteNonce: z.ZodOptional<z.ZodString>;
+    group: z.ZodLazy<z.ZodObject<{
+        groupId: z.ZodEffects<z.ZodString, string, string>;
+        name: z.ZodString;
+        description: z.ZodString;
+        iconClassName: z.ZodOptional<z.ZodString>;
+        publicRole: z.ZodOptional<z.ZodNativeEnum<typeof import("../data").GroupMemberRole>>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        founderUserId: z.ZodEffects<z.ZodString, string, string>;
+        signature: z.ZodString;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    }, {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    }>>;
+    membership: z.ZodLazy<z.ZodObject<{
+        groupMemberId: z.ZodEffects<z.ZodString, string, string>;
+        groupId: z.ZodEffects<z.ZodString, string, string>;
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+        signature: z.ZodString;
+        deleted: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    }, {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    }>>;
+    seed: z.ZodObject<{
+        groupMembers: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            groupMemberId: z.ZodEffects<z.ZodString, string, string>;
+            groupId: z.ZodEffects<z.ZodString, string, string>;
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+            signature: z.ZodString;
+            deleted: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }, {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }>>, "many">;
+        users: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            name: z.ZodString;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            signature: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }, {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }>>, "many">;
+        devices: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            deviceId: z.ZodEffects<z.ZodString, string, string>;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            userName: z.ZodOptional<z.ZodString>;
+            deviceName: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }>>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    }, {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    }>;
+    approver: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    approverDeviceId: z.ZodEffects<z.ZodString, string, string>;
+    /** Group encryption secret boxed to the joiner's `publicBoxKey`. */
+    boxedSecret: z.ZodObject<{
+        contents: z.ZodString;
+        nonce: z.ZodString;
+        fromPublicKey: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    group: {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    };
+    kind: "group-approval";
+    membership: {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    };
+    seed: {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    };
+    approver: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    approverDeviceId: string;
+    boxedSecret: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+    inviteNonce?: string | undefined;
+}, {
+    group: {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    };
+    kind: "group-approval";
+    membership: {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    };
+    seed: {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    };
+    approver: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    approverDeviceId: string;
+    boxedSecret: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+    inviteNonce?: string | undefined;
+}>;
+/** Payload that admits a joiner to a group. */
+export type GroupApproval = z.infer<typeof groupApprovalSchema>;
+/** A party declined or denied an invite or join request. */
+export declare const inviteDeclineSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"invite-decline">;
+    inviteNonce: z.ZodString;
+    groupId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    by: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    reason: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    kind: "invite-decline";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    reason?: string | undefined;
+    groupId?: string | undefined;
+}, {
+    kind: "invite-decline";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    reason?: string | undefined;
+    groupId?: string | undefined;
+}>;
+/** A party declined or denied an invite or join request. */
+export type InviteDecline = z.infer<typeof inviteDeclineSchema>;
+/**
+ * The recipient of a direct group invite or a profile-QR reply completed their side, so the
+ * other party can move its row from pending to accepted.
+ */
+export declare const inviteAcceptedSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"invite-accepted">;
+    inviteNonce: z.ZodString;
+    groupId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    by: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    byDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "invite-accepted";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    byDeviceId: string;
+    groupId?: string | undefined;
+}, {
+    kind: "invite-accepted";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    byDeviceId: string;
+    groupId?: string | undefined;
+}>;
+/** A party completed their side of a direct invite or profile reply. */
+export type InviteAccepted = z.infer<typeof inviteAcceptedSchema>;
+/** Any message that travels inside an invite envelope. */
+export declare const inviteMessageSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+    kind: z.ZodLiteral<"contact-reply">;
+    /** Nonce and epoch of the token that was accepted. */
+    inviteNonce: z.ZodString;
+    inviteEpoch: z.ZodNumber;
+    responder: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    responderDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "contact-reply";
+    responder: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    inviteNonce: string;
+    inviteEpoch: number;
+    responderDeviceId: string;
+}, {
+    kind: "contact-reply";
+    responder: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    inviteNonce: string;
+    inviteEpoch: number;
+    responderDeviceId: string;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"group-join-request">;
+    token: z.ZodObject<{
+        v: z.ZodLiteral<1>;
+        type: z.ZodEnum<["contact", "group"]>;
+        inviter: z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, "strict", z.ZodTypeAny, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        }, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        }>;
+        expiresAt: z.ZodString;
+        nonce: z.ZodString;
+        epoch: z.ZodNumber;
+        uses: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<"unlimited">]>;
+        group: z.ZodOptional<z.ZodObject<{
+            groupId: z.ZodEffects<z.ZodString, string, string>;
+            name: z.ZodString;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+            mode: z.ZodEnum<["approve", "open"]>;
+        }, "strict", z.ZodTypeAny, {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        }, {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        }>>;
+        signature: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    }, {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    }>;
+    requester: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    requesterDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "group-join-request";
+    token: {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    };
+    requester: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    requesterDeviceId: string;
+}, {
+    kind: "group-join-request";
+    token: {
+        type: "group" | "contact";
+        nonce: string;
+        signature: string;
+        expiresAt: string;
+        v: 1;
+        inviter: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            displayName?: string | undefined;
+        };
+        epoch: number;
+        uses: 1 | "unlimited";
+        group?: {
+            name: string;
+            role: import("../data").GroupMemberRole;
+            publicKey: string;
+            groupId: string;
+            publicBoxKey: string;
+            mode: "open" | "approve";
+        } | undefined;
+    };
+    requester: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    requesterDeviceId: string;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"group-approval">;
+    /** Nonce of the token or direct invite this approval answers, when there is one. */
+    inviteNonce: z.ZodOptional<z.ZodString>;
+    group: z.ZodLazy<z.ZodObject<{
+        groupId: z.ZodEffects<z.ZodString, string, string>;
+        name: z.ZodString;
+        description: z.ZodString;
+        iconClassName: z.ZodOptional<z.ZodString>;
+        publicRole: z.ZodOptional<z.ZodNativeEnum<typeof import("../data").GroupMemberRole>>;
+        disabled: z.ZodOptional<z.ZodBoolean>;
+        founderUserId: z.ZodEffects<z.ZodString, string, string>;
+        signature: z.ZodString;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    }, {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    }>>;
+    membership: z.ZodLazy<z.ZodObject<{
+        groupMemberId: z.ZodEffects<z.ZodString, string, string>;
+        groupId: z.ZodEffects<z.ZodString, string, string>;
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+        signature: z.ZodString;
+        deleted: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    }, {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    }>>;
+    seed: z.ZodObject<{
+        groupMembers: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            groupMemberId: z.ZodEffects<z.ZodString, string, string>;
+            groupId: z.ZodEffects<z.ZodString, string, string>;
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            role: z.ZodNativeEnum<typeof import("../data").GroupMemberRole>;
+            signature: z.ZodString;
+            deleted: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }, {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }>>, "many">;
+        users: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            name: z.ZodString;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            signature: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }, {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }>>, "many">;
+        devices: z.ZodArray<z.ZodLazy<z.ZodObject<{
+            userId: z.ZodEffects<z.ZodString, string, string>;
+            deviceId: z.ZodEffects<z.ZodString, string, string>;
+            publicKey: z.ZodString;
+            publicBoxKey: z.ZodString;
+            userName: z.ZodOptional<z.ZodString>;
+            deviceName: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }, {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }>>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    }, {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    }>;
+    approver: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    approverDeviceId: z.ZodEffects<z.ZodString, string, string>;
+    /** Group encryption secret boxed to the joiner's `publicBoxKey`. */
+    boxedSecret: z.ZodObject<{
+        contents: z.ZodString;
+        nonce: z.ZodString;
+        fromPublicKey: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    group: {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    };
+    kind: "group-approval";
+    membership: {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    };
+    seed: {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    };
+    approver: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    approverDeviceId: string;
+    boxedSecret: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+    inviteNonce?: string | undefined;
+}, {
+    group: {
+        name: string;
+        description: string;
+        publicKey: string;
+        signature: string;
+        groupId: string;
+        founderUserId: string;
+        publicBoxKey: string;
+        disabled?: boolean | undefined;
+        iconClassName?: string | undefined;
+        publicRole?: import("../data").GroupMemberRole | undefined;
+    };
+    kind: "group-approval";
+    membership: {
+        role: import("../data").GroupMemberRole;
+        signature: string;
+        groupId: string;
+        userId: string;
+        groupMemberId: string;
+        deleted?: boolean | undefined;
+    };
+    seed: {
+        users: {
+            name: string;
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            signature?: string | undefined;
+        }[];
+        devices: {
+            publicKey: string;
+            publicBoxKey: string;
+            userId: string;
+            deviceId: string;
+            deviceName?: string | undefined;
+            userName?: string | undefined;
+        }[];
+        groupMembers: {
+            role: import("../data").GroupMemberRole;
+            signature: string;
+            groupId: string;
+            userId: string;
+            groupMemberId: string;
+            deleted?: boolean | undefined;
+        }[];
+    };
+    approver: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    approverDeviceId: string;
+    boxedSecret: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+    inviteNonce?: string | undefined;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"invite-decline">;
+    inviteNonce: z.ZodString;
+    groupId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    by: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    reason: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    kind: "invite-decline";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    reason?: string | undefined;
+    groupId?: string | undefined;
+}, {
+    kind: "invite-decline";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    reason?: string | undefined;
+    groupId?: string | undefined;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"invite-accepted">;
+    inviteNonce: z.ZodString;
+    groupId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    by: z.ZodObject<{
+        userId: z.ZodEffects<z.ZodString, string, string>;
+        publicKey: z.ZodString;
+        publicBoxKey: z.ZodString;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }, {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    }>;
+    byDeviceId: z.ZodEffects<z.ZodString, string, string>;
+}, "strict", z.ZodTypeAny, {
+    kind: "invite-accepted";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    byDeviceId: string;
+    groupId?: string | undefined;
+}, {
+    kind: "invite-accepted";
+    inviteNonce: string;
+    by: {
+        publicKey: string;
+        publicBoxKey: string;
+        userId: string;
+        displayName?: string | undefined;
+    };
+    byDeviceId: string;
+    groupId?: string | undefined;
+}>]>;
+/** Any message that travels inside an invite envelope. */
+export type InviteMessage = z.infer<typeof inviteMessageSchema>;
+/**
+ * Wire format for invite traffic over the mesh (`dataContextId: "invite"`) and the mailbox.
+ * The message is signed by the sender's user key, then boxed to the recipient's user box key,
+ * so any of the recipient's devices can open it and the relay learns only the recipient id.
+ */
+export declare const inviteEnvelopeSchema: z.ZodObject<{
+    v: z.ZodLiteral<1>;
+    to: z.ZodEffects<z.ZodString, string, string>;
+    box: z.ZodObject<{
+        contents: z.ZodString;
+        nonce: z.ZodString;
+        fromPublicKey: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }, {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    }>;
+}, "strict", z.ZodTypeAny, {
+    v: 1;
+    to: string;
+    box: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+}, {
+    v: 1;
+    to: string;
+    box: {
+        nonce: string;
+        contents: string;
+        fromPublicKey: string;
+    };
+}>;
+/** Signed-then-boxed invite message addressed to one user. */
+export type InviteEnvelope = z.infer<typeof inviteEnvelopeSchema>;
+/** Opened envelope with the verified sender identity keys. */
+export interface OpenedInviteEnvelope {
+    message: InviteMessage;
+    senderPublicKey: string;
+    senderPublicBoxKey: string;
+}
+/** Signs a message with the sender's user key and boxes it to the recipient's user box key. */
+export declare function sealInviteEnvelope(message: InviteMessage, senderKeys: IPublicPrivateKeys, recipient: {
+    userId: string;
+    publicBoxKey: string;
+}): InviteEnvelope;
+/**
+ * Opens an envelope addressed to this user and verifies the inner signature.
+ *
+ * @throws when the box cannot be opened, the signature is invalid, or the message is malformed
+ */
+export declare function openInviteEnvelope(envelope: unknown, recipient: {
+    userId: string;
+    secretKey: string;
+}): OpenedInviteEnvelope;
+/** Returns the identity a message claims for its sender, for cross-checking against the envelope. */
+export declare function inviteMessageSender(message: InviteMessage): {
+    publicKey: string;
+    publicBoxKey: string;
+    userId: string;
+};