@canonmsg/backend-contracts 1.7.0 → 1.8.0

package/dist/restEndpoints.d.ts

@@ -0,0 +1,496 @@
+import { z } from 'zod';
+export declare const RestOkResponseSchema: z.ZodObject<{
+    success: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export type RestOkResponse = z.infer<typeof RestOkResponseSchema>;
+/** GET …/messages items — the serialized message plus the soft-delete flag. */
+export declare const RestMessageSchema: z.ZodObject<{
+    id: z.ZodString;
+    senderId: z.ZodString;
+    senderName: z.ZodOptional<z.ZodString>;
+    senderType: z.ZodEnum<{
+        human: "human";
+        ai_agent: "ai_agent";
+    }>;
+    isOwner: z.ZodBoolean;
+    contentType: z.ZodEnum<{
+        file: "file";
+        image: "image";
+        audio: "audio";
+        video: "video";
+        text: "text";
+        contact_card: "contact_card";
+    }>;
+    text: z.ZodNullable<z.ZodString>;
+    attachments: z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            audio: "audio";
+            video: "video";
+        }>;
+        url: z.ZodString;
+        mimeType: z.ZodOptional<z.ZodString>;
+        fileName: z.ZodOptional<z.ZodString>;
+        sizeBytes: z.ZodOptional<z.ZodNumber>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        durationMs: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    mentions: z.ZodArray<z.ZodString>;
+    replyTo: z.ZodNullable<z.ZodString>;
+    replyToPosition: z.ZodNullable<z.ZodNumber>;
+    forwarded: z.ZodOptional<z.ZodBoolean>;
+    forwardedFrom: z.ZodOptional<z.ZodObject<{
+        sourceConversationId: z.ZodString;
+        messageId: z.ZodString;
+    }, z.core.$strip>>;
+    status: z.ZodEnum<{
+        sent: "sent";
+        read: "read";
+    }>;
+    createdAt: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    contactCard: z.ZodOptional<z.ZodObject<{
+        userId: z.ZodString;
+        canonContactId: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodString;
+        avatarUrl: z.ZodNullable<z.ZodString>;
+        userType: z.ZodEnum<{
+            human: "human";
+            ai_agent: "ai_agent";
+        }>;
+        clientType: z.ZodOptional<z.ZodEnum<{
+            "claude-code": "claude-code";
+            openclaw: "openclaw";
+            codex: "codex";
+            hermes: "hermes";
+            generic: "generic";
+        }>>;
+        about: z.ZodOptional<z.ZodString>;
+        isActive: z.ZodOptional<z.ZodBoolean>;
+        ownerId: z.ZodOptional<z.ZodString>;
+        ownerName: z.ZodOptional<z.ZodString>;
+        lifecycleState: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    runtimeCard: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    reactions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+    deleted: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type RestMessage = z.infer<typeof RestMessageSchema>;
+export declare const RestConversationSchema: z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodEnum<{
+        direct: "direct";
+        group: "group";
+    }>;
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    memberIds: z.ZodArray<z.ZodString>;
+    isAgentChat: z.ZodOptional<z.ZodBoolean>;
+    behavior: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    hasUnread: z.ZodOptional<z.ZodBoolean>;
+    lastMessage: z.ZodNullable<z.ZodObject<{
+        text: z.ZodString;
+        messageId: z.ZodOptional<z.ZodString>;
+        senderId: z.ZodString;
+        senderType: z.ZodEnum<{
+            human: "human";
+            ai_agent: "ai_agent";
+        }>;
+        contentType: z.ZodOptional<z.ZodEnum<{
+            file: "file";
+            image: "image";
+            audio: "audio";
+            video: "video";
+            text: "text";
+            contact_card: "contact_card";
+        }>>;
+        timestamp: z.ZodString;
+    }, z.core.$loose>>;
+    createdAt: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+export type RestConversation = z.infer<typeof RestConversationSchema>;
+export declare const RestContactSchema: z.ZodObject<{
+    id: z.ZodString;
+    source: z.ZodString;
+    addedAt: z.ZodNullable<z.ZodString>;
+    displayNameOverride: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type RestContact = z.infer<typeof RestContactSchema>;
+export declare const RestSessionSelectionSchema: z.ZodUnion<readonly [z.ZodObject<{
+    mode: z.ZodEnum<{
+        new: "new";
+        continue_latest: "continue_latest";
+        continue_or_create: "continue_or_create";
+    }>;
+}, z.core.$strip>, z.ZodObject<{
+    mode: z.ZodLiteral<"specific">;
+    conversationId: z.ZodString;
+}, z.core.$strip>]>;
+export type RestSessionSelection = z.infer<typeof RestSessionSelectionSchema>;
+export declare const SendMessageRequestSchema: z.ZodObject<{
+    conversationId: z.ZodString;
+    text: z.ZodOptional<z.ZodString>;
+    messageId: z.ZodOptional<z.ZodString>;
+    contentType: z.ZodOptional<z.ZodEnum<{
+        file: "file";
+        image: "image";
+        audio: "audio";
+        video: "video";
+        text: "text";
+        contact_card: "contact_card";
+    }>>;
+    replyTo: z.ZodOptional<z.ZodString>;
+    replyToPosition: z.ZodOptional<z.ZodNumber>;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            audio: "audio";
+            video: "video";
+        }>;
+        url: z.ZodString;
+        mimeType: z.ZodOptional<z.ZodString>;
+        fileName: z.ZodOptional<z.ZodString>;
+        sizeBytes: z.ZodOptional<z.ZodNumber>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        durationMs: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>>;
+    contactCardUserId: z.ZodOptional<z.ZodString>;
+    mentions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    selfContextId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type SendMessageRequest = z.infer<typeof SendMessageRequestSchema>;
+export declare const SendMessageResponseSchema: z.ZodObject<{
+    messageId: z.ZodString;
+}, z.core.$strip>;
+export type SendMessageResponse = z.infer<typeof SendMessageResponseSchema>;
+export declare const ReactRequestSchema: z.ZodObject<{
+    conversationId: z.ZodString;
+    messageId: z.ZodString;
+    emoji: z.ZodString;
+}, z.core.$strip>;
+export type ReactRequest = z.infer<typeof ReactRequestSchema>;
+export declare const ReactResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    action: z.ZodEnum<{
+        added: "added";
+        removed: "removed";
+    }>;
+    reactions: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export type ReactResponse = z.infer<typeof ReactResponseSchema>;
+export declare const ForwardMessageRequestSchema: z.ZodObject<{
+    sourceConversationId: z.ZodString;
+    targetConversationId: z.ZodString;
+    messageId: z.ZodString;
+    text: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ForwardMessageRequest = z.infer<typeof ForwardMessageRequestSchema>;
+export declare const ForwardMessageResponseSchema: z.ZodObject<{
+    messageId: z.ZodString;
+    targetConversationId: z.ZodString;
+    forwardedFrom: z.ZodObject<{
+        sourceConversationId: z.ZodString;
+        messageId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ForwardMessageResponse = z.infer<typeof ForwardMessageResponseSchema>;
+export declare const DeleteMessageResponseSchema: z.ZodObject<{
+    success: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export declare const MarkReadResponseSchema: z.ZodObject<{
+    success: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export declare const UpdateDispositionRequestSchema: z.ZodObject<{
+    inboundDisposition: z.ZodEnum<{
+        queued: "queued";
+        accepted_now: "accepted_now";
+        interleaved: "interleaved";
+        trigger_suppressed: "trigger_suppressed";
+        rejected: "rejected";
+        cancelled: "cancelled";
+    }>;
+}, z.core.$strip>;
+export type UpdateDispositionRequest = z.infer<typeof UpdateDispositionRequestSchema>;
+export declare const ConversationsResponseSchema: z.ZodObject<{
+    conversations: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodEnum<{
+            direct: "direct";
+            group: "group";
+        }>;
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        memberIds: z.ZodArray<z.ZodString>;
+        isAgentChat: z.ZodOptional<z.ZodBoolean>;
+        behavior: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        hasUnread: z.ZodOptional<z.ZodBoolean>;
+        lastMessage: z.ZodNullable<z.ZodObject<{
+            text: z.ZodString;
+            messageId: z.ZodOptional<z.ZodString>;
+            senderId: z.ZodString;
+            senderType: z.ZodEnum<{
+                human: "human";
+                ai_agent: "ai_agent";
+            }>;
+            contentType: z.ZodOptional<z.ZodEnum<{
+                file: "file";
+                image: "image";
+                audio: "audio";
+                video: "video";
+                text: "text";
+                contact_card: "contact_card";
+            }>>;
+            timestamp: z.ZodString;
+        }, z.core.$loose>>;
+        createdAt: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;
+export type ConversationsResponse = z.infer<typeof ConversationsResponseSchema>;
+/** Query params: limit, before, includeBehavior. */
+export declare const GetMessagesQuerySchema: z.ZodObject<{
+    limit: z.ZodOptional<z.ZodString>;
+    before: z.ZodOptional<z.ZodString>;
+    includeBehavior: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type GetMessagesQuery = z.infer<typeof GetMessagesQuerySchema>;
+export declare const MessagesPageResponseSchema: z.ZodObject<{
+    messages: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        senderId: z.ZodString;
+        senderName: z.ZodOptional<z.ZodString>;
+        senderType: z.ZodEnum<{
+            human: "human";
+            ai_agent: "ai_agent";
+        }>;
+        isOwner: z.ZodBoolean;
+        contentType: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            audio: "audio";
+            video: "video";
+            text: "text";
+            contact_card: "contact_card";
+        }>;
+        text: z.ZodNullable<z.ZodString>;
+        attachments: z.ZodArray<z.ZodObject<{
+            kind: z.ZodEnum<{
+                file: "file";
+                image: "image";
+                audio: "audio";
+                video: "video";
+            }>;
+            url: z.ZodString;
+            mimeType: z.ZodOptional<z.ZodString>;
+            fileName: z.ZodOptional<z.ZodString>;
+            sizeBytes: z.ZodOptional<z.ZodNumber>;
+            width: z.ZodOptional<z.ZodNumber>;
+            height: z.ZodOptional<z.ZodNumber>;
+            durationMs: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        mentions: z.ZodArray<z.ZodString>;
+        replyTo: z.ZodNullable<z.ZodString>;
+        replyToPosition: z.ZodNullable<z.ZodNumber>;
+        forwarded: z.ZodOptional<z.ZodBoolean>;
+        forwardedFrom: z.ZodOptional<z.ZodObject<{
+            sourceConversationId: z.ZodString;
+            messageId: z.ZodString;
+        }, z.core.$strip>>;
+        status: z.ZodEnum<{
+            sent: "sent";
+            read: "read";
+        }>;
+        createdAt: z.ZodString;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        contactCard: z.ZodOptional<z.ZodObject<{
+            userId: z.ZodString;
+            canonContactId: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodString;
+            avatarUrl: z.ZodNullable<z.ZodString>;
+            userType: z.ZodEnum<{
+                human: "human";
+                ai_agent: "ai_agent";
+            }>;
+            clientType: z.ZodOptional<z.ZodEnum<{
+                "claude-code": "claude-code";
+                openclaw: "openclaw";
+                codex: "codex";
+                hermes: "hermes";
+                generic: "generic";
+            }>>;
+            about: z.ZodOptional<z.ZodString>;
+            isActive: z.ZodOptional<z.ZodBoolean>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            ownerName: z.ZodOptional<z.ZodString>;
+            lifecycleState: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        runtimeCard: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        reactions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>>;
+        deleted: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    behavior: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    activeSelfContextIdByMessageId: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    selfContexts: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$loose>;
+export type MessagesPageResponse = z.infer<typeof MessagesPageResponseSchema>;
+export declare const CreateConversationRequestSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        direct: "direct";
+        group: "group";
+    }>;
+    targetUserId: z.ZodOptional<z.ZodString>;
+    memberIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    name: z.ZodOptional<z.ZodString>;
+    sessionConfig: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    sessionSelection: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        mode: z.ZodEnum<{
+            new: "new";
+            continue_latest: "continue_latest";
+            continue_or_create: "continue_or_create";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        mode: z.ZodLiteral<"specific">;
+        conversationId: z.ZodString;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
+export type CreateConversationRequest = z.infer<typeof CreateConversationRequestSchema>;
+export declare const CreateConversationResponseSchema: z.ZodObject<{
+    conversationId: z.ZodString;
+    created: z.ZodOptional<z.ZodBoolean>;
+    reused: z.ZodOptional<z.ZodBoolean>;
+    sessionSelection: z.ZodOptional<z.ZodEnum<{
+        new: "new";
+        continue_latest: "continue_latest";
+        continue_or_create: "continue_or_create";
+        specific: "specific";
+    }>>;
+}, z.core.$strip>;
+export type CreateConversationResponse = z.infer<typeof CreateConversationResponseSchema>;
+export declare const CreateContactRequestRequestSchema: z.ZodObject<{
+    targetId: z.ZodString;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CreateContactRequestRequest = z.infer<typeof CreateContactRequestRequestSchema>;
+export declare const CreateContactRequestResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
+    status: z.ZodLiteral<"open">;
+}, z.core.$loose>, z.ZodObject<{
+    status: z.ZodEnum<{
+        created: "created";
+        duplicate: "duplicate";
+    }>;
+    requestId: z.ZodString;
+}, z.core.$loose>, z.ZodObject<{
+    message: z.ZodString;
+}, z.core.$loose>]>;
+export type CreateContactRequestResponse = z.infer<typeof CreateContactRequestResponseSchema>;
+export declare const ContactsResponseSchema: z.ZodObject<{
+    contacts: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        source: z.ZodString;
+        addedAt: z.ZodNullable<z.ZodString>;
+        displayNameOverride: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ContactsResponse = z.infer<typeof ContactsResponseSchema>;
+export declare const ResolveAdmissionRequestSchema: z.ZodUnion<readonly [z.ZodObject<{
+    targetUserId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    canonContactId: z.ZodString;
+}, z.core.$strip>]>;
+export type ResolveAdmissionRequest = z.infer<typeof ResolveAdmissionRequestSchema>;
+export declare const ResolveAdmissionResponseSchema: z.ZodObject<{
+    resolvedTargetUserId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    target: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        canonContactId: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+        avatarUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        about: z.ZodOptional<z.ZodString>;
+        userType: z.ZodOptional<z.ZodEnum<{
+            human: "human";
+            ai_agent: "ai_agent";
+        }>>;
+        discoverable: z.ZodOptional<z.ZodBoolean>;
+        inboundPolicy: z.ZodOptional<z.ZodEnum<{
+            open: "open";
+            "approval-required": "approval-required";
+            "owner-only": "owner-only";
+        }>>;
+        groupJoinPolicy: z.ZodOptional<z.ZodEnum<{
+            open: "open";
+            "approval-required": "approval-required";
+            "owner-only": "owner-only";
+        }>>;
+    }, z.core.$loose>>;
+    admission: z.ZodObject<{
+        state: z.ZodEnum<{
+            "owner-only": "owner-only";
+            self: "self";
+            "not-found": "not-found";
+            allowed: "allowed";
+            "request-required": "request-required";
+            "pending-outbound": "pending-outbound";
+            blocked: "blocked";
+            inactive: "inactive";
+        }>;
+        canMessage: z.ZodBoolean;
+        canRequestContact: z.ZodBoolean;
+        isContact: z.ZodBoolean;
+        pendingRequestId: z.ZodOptional<z.ZodString>;
+        blockedByViewer: z.ZodOptional<z.ZodBoolean>;
+        blockedByTarget: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export type ResolveAdmissionResponse = z.infer<typeof ResolveAdmissionResponseSchema>;
+export declare const SetTypingRequestSchema: z.ZodObject<{
+    conversationId: z.ZodString;
+    typing: z.ZodBoolean;
+    status: z.ZodOptional<z.ZodEnum<{
+        thinking: "thinking";
+        typing: "typing";
+    }>>;
+}, z.core.$strip>;
+export type SetTypingRequest = z.infer<typeof SetTypingRequestSchema>;
+/** POST /streaming — the legacy REST facade over the RTDB streaming bubble. */
+export declare const SetStreamingRequestSchema: z.ZodUnion<readonly [z.ZodObject<{
+    conversationId: z.ZodString;
+    text: z.ZodString;
+    status: z.ZodString;
+    messageId: z.ZodString;
+    turnId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    blocks: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, z.core.$strip>, z.ZodObject<{
+    conversationId: z.ZodString;
+    streaming: z.ZodLiteral<false>;
+}, z.core.$strip>]>;
+export type SetStreamingRequest = z.infer<typeof SetStreamingRequestSchema>;
+export declare const UploadMediaRequestSchema: z.ZodObject<{
+    conversationId: z.ZodString;
+    mimeType: z.ZodString;
+    data: z.ZodString;
+    fileName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type UploadMediaRequest = z.infer<typeof UploadMediaRequestSchema>;
+export declare const UploadMediaResponseSchema: z.ZodObject<{
+    url: z.ZodString;
+    attachment: z.ZodObject<{
+        kind: z.ZodEnum<{
+            file: "file";
+            image: "image";
+            audio: "audio";
+            video: "video";
+        }>;
+        url: z.ZodString;
+        mimeType: z.ZodOptional<z.ZodString>;
+        fileName: z.ZodOptional<z.ZodString>;
+        sizeBytes: z.ZodOptional<z.ZodNumber>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+        durationMs: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type UploadMediaResponse = z.infer<typeof UploadMediaResponseSchema>;