@canonmsg/backend-contracts 1.8.1 → 2.0.0

package/dist/sseEvents.d.ts

@@ -1,494 +0,0 @@
-import { z } from 'zod';
-export declare const SseAccessPolicySchema: z.ZodEnum<{
-    open: "open";
-    "approval-required": "approval-required";
-    "owner-only": "owner-only";
-}>;
-export type SseAccessPolicy = z.infer<typeof SseAccessPolicySchema>;
-export declare const SseConnectedPayloadSchema: z.ZodObject<{
-    connectionId: z.ZodString;
-    agentId: z.ZodString;
-}, z.core.$strip>;
-export type SseConnectedPayload = z.infer<typeof SseConnectedPayloadSchema>;
-/** Trusted, server-injected identity & access info (stream.ts `agent.context`). */
-export declare const SseAgentContextPayloadSchema: z.ZodObject<{
-    agentId: z.ZodString;
-    canonContactId: z.ZodOptional<z.ZodString>;
-    clientType: z.ZodOptional<z.ZodString>;
-    ownerId: z.ZodString;
-    ownerName: z.ZodString;
-    defaultBehavior: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    inboundPolicy: z.ZodEnum<{
-        open: "open";
-        "approval-required": "approval-required";
-        "owner-only": "owner-only";
-    }>;
-    groupJoinPolicy: z.ZodEnum<{
-        open: "open";
-        "approval-required": "approval-required";
-        "owner-only": "owner-only";
-    }>;
-    discoverable: z.ZodBoolean;
-}, z.core.$loose>;
-export type SseAgentContextPayload = z.infer<typeof SseAgentContextPayloadSchema>;
-export declare const SseHeartbeatPayloadSchema: z.ZodObject<{
-    timestamp: z.ZodString;
-}, z.core.$strip>;
-export type SseHeartbeatPayload = z.infer<typeof SseHeartbeatPayloadSchema>;
-export declare const SseReplayExpiredPayloadSchema: z.ZodObject<{
-    lastAvailableId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    message: z.ZodOptional<z.ZodString>;
-}, z.core.$loose>;
-export type SseReplayExpiredPayload = z.infer<typeof SseReplayExpiredPayloadSchema>;
-export declare const SseErrorPayloadSchema: z.ZodObject<{
-    code: z.ZodOptional<z.ZodString>;
-    message: z.ZodOptional<z.ZodString>;
-    retryAfterMs: z.ZodOptional<z.ZodNumber>;
-    activeConnections: z.ZodOptional<z.ZodNumber>;
-    maxConnections: z.ZodOptional<z.ZodNumber>;
-}, z.core.$loose>;
-export type SseErrorPayload = z.infer<typeof SseErrorPayloadSchema>;
-export declare const SseSelfContextSchema: z.ZodObject<{
-    id: z.ZodString;
-    type: z.ZodLiteral<"cross_session">;
-    context: z.ZodString;
-    createdAt: z.ZodNullable<z.ZodString>;
-    updatedAt: z.ZodNullable<z.ZodString>;
-}, z.core.$strip>;
-export type SseSelfContext = z.infer<typeof SseSelfContextSchema>;
-export declare const SseTurnDispatchSchema: z.ZodObject<{
-    kind: z.ZodEnum<{
-        run_turn: "run_turn";
-        observe_only: "observe_only";
-    }>;
-    reason: z.ZodString;
-    addressed: z.ZodBoolean;
-    policyVersion: z.ZodOptional<z.ZodString>;
-}, z.core.$loose>;
-export type SseTurnDispatch = z.infer<typeof SseTurnDispatchSchema>;
-export declare const SseProvenanceSchema: z.ZodObject<{
-    conversation: z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodEnum<{
-            unknown: "unknown";
-            direct: "direct";
-            group: "group";
-        }>;
-    }, z.core.$loose>;
-    sender: z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        type: z.ZodEnum<{
-            human: "human";
-            ai_agent: "ai_agent";
-        }>;
-        isOwner: z.ZodBoolean;
-    }, z.core.$loose>;
-    mentionedAgent: z.ZodBoolean;
-}, z.core.$loose>;
-export type SseProvenance = z.infer<typeof SseProvenanceSchema>;
-/**
- * `message.created` — the inbound message envelope. `message` is exactly the
- * SerializedMessage the shared serializer emits (the E2EE S1 slot).
- */
-export declare const SseMessageCreatedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    behavior: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    activeSelfContextId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    selfContexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodLiteral<"cross_session">;
-        context: z.ZodString;
-        createdAt: z.ZodNullable<z.ZodString>;
-        updatedAt: z.ZodNullable<z.ZodString>;
-    }, z.core.$strip>>>;
-    provenance: z.ZodOptional<z.ZodObject<{
-        conversation: z.ZodObject<{
-            id: z.ZodString;
-            type: z.ZodEnum<{
-                unknown: "unknown";
-                direct: "direct";
-                group: "group";
-            }>;
-        }, z.core.$loose>;
-        sender: z.ZodObject<{
-            id: z.ZodString;
-            name: z.ZodOptional<z.ZodString>;
-            type: z.ZodEnum<{
-                human: "human";
-                ai_agent: "ai_agent";
-            }>;
-            isOwner: z.ZodBoolean;
-        }, z.core.$loose>;
-        mentionedAgent: z.ZodBoolean;
-    }, z.core.$loose>>;
-    turnDispatch: z.ZodOptional<z.ZodObject<{
-        kind: z.ZodEnum<{
-            run_turn: "run_turn";
-            observe_only: "observe_only";
-        }>;
-        reason: z.ZodString;
-        addressed: z.ZodBoolean;
-        policyVersion: z.ZodOptional<z.ZodString>;
-    }, z.core.$loose>>;
-    message: 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>>>;
-    }, z.core.$strip>;
-}, z.core.$loose>;
-export type SseMessageCreatedPayload = z.infer<typeof SseMessageCreatedPayloadSchema>;
-export declare const SseMessageUpdatedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    messageId: z.ZodString;
-    actorId: z.ZodOptional<z.ZodString>;
-    updatedAt: z.ZodOptional<z.ZodString>;
-    changes: z.ZodObject<{
-        reactions: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
-    }, z.core.$loose>;
-}, z.core.$strip>;
-export type SseMessageUpdatedPayload = z.infer<typeof SseMessageUpdatedPayloadSchema>;
-export declare const SseMessageDeletedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    messageId: z.ZodString;
-}, z.core.$strip>;
-export type SseMessageDeletedPayload = z.infer<typeof SseMessageDeletedPayloadSchema>;
-export declare const SseMembershipChangeSchema: z.ZodObject<{
-    addedMemberIds: z.ZodArray<z.ZodString>;
-    removedMemberIds: z.ZodArray<z.ZodString>;
-    memberCount: z.ZodNumber;
-}, z.core.$strip>;
-export type SseMembershipChange = z.infer<typeof SseMembershipChangeSchema>;
-export declare const SseConversationUpdatedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    changes: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    membershipChange: z.ZodOptional<z.ZodObject<{
-        addedMemberIds: z.ZodArray<z.ZodString>;
-        removedMemberIds: z.ZodArray<z.ZodString>;
-        memberCount: z.ZodNumber;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-export type SseConversationUpdatedPayload = z.infer<typeof SseConversationUpdatedPayloadSchema>;
-/** `contact.request` / `contact.approved` carry the serialized contact request. */
-export declare const SseContactRequestPayloadSchema: z.ZodObject<{
-    id: z.ZodString;
-    requesterId: z.ZodString;
-    requesterName: z.ZodString;
-    requesterAvatarUrl: z.ZodNullable<z.ZodString>;
-    targetId: z.ZodString;
-    targetName: z.ZodString;
-    targetAvatarUrl: z.ZodNullable<z.ZodString>;
-    targetUserType: z.ZodEnum<{
-        human: "human";
-        ai_agent: "ai_agent";
-    }>;
-    targetOwnerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    approverId: z.ZodString;
-    message: z.ZodNullable<z.ZodString>;
-    status: z.ZodEnum<{
-        rejected: "rejected";
-        pending: "pending";
-        approved: "approved";
-        expired: "expired";
-    }>;
-    kind: z.ZodEnum<{
-        dm: "dm";
-        group_invite: "group_invite";
-    }>;
-    groupContext: z.ZodOptional<z.ZodObject<{
-        conversationId: z.ZodString;
-        groupName: z.ZodNullable<z.ZodString>;
-    }, z.core.$strip>>;
-    createdAt: z.ZodNullable<z.ZodString>;
-    resolvedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    expiresAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-export type SseContactRequestPayload = z.infer<typeof SseContactRequestPayloadSchema>;
-/**
- * `contact.added` / `contact.updated`. `source` is a pass-through string —
- * canonical values today: direct_add, phone_book, contact_request, link, qr,
- * group, open_inbound_message, unknown.
- */
-export declare const SseContactPayloadSchema: z.ZodObject<{
-    id: z.ZodString;
-    source: z.ZodString;
-    addedAt: z.ZodNullable<z.ZodString>;
-    displayNameOverride: z.ZodNullable<z.ZodString>;
-}, z.core.$strip>;
-export type SseContactPayload = z.infer<typeof SseContactPayloadSchema>;
-export declare const SseContactRemovedPayloadSchema: z.ZodObject<{
-    id: z.ZodString;
-}, z.core.$strip>;
-export type SseContactRemovedPayload = z.infer<typeof SseContactRemovedPayloadSchema>;
-export declare const SseTypingPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    userId: z.ZodString;
-    isTyping: z.ZodBoolean;
-    status: z.ZodOptional<z.ZodEnum<{
-        thinking: "thinking";
-        typing: "typing";
-    }>>;
-    timestamp: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-export type SseTypingPayload = z.infer<typeof SseTypingPayloadSchema>;
-export declare const SsePresencePayloadSchema: z.ZodObject<{
-    userId: z.ZodString;
-    online: z.ZodBoolean;
-    lastSeen: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type SsePresencePayload = z.infer<typeof SsePresencePayloadSchema>;
-/** Aggregated RTDB runtime snapshot — nodes are passed through opaquely. */
-export declare const SseRuntimeUpdatedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    agentId: z.ZodString;
-    runtime: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    runtimeInfo: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    sessionState: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    sessionConfig: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strip>;
-export type SseRuntimeUpdatedPayload = z.infer<typeof SseRuntimeUpdatedPayloadSchema>;
-export declare const SseTurnUpdatedPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    agentId: z.ZodString;
-    turn: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strip>;
-export type SseTurnUpdatedPayload = z.infer<typeof SseTurnUpdatedPayloadSchema>;
-export declare const SseRuntimeControlKindSchema: z.ZodEnum<{
-    session: "session";
-    signal: "signal";
-    primitive: "primitive";
-    runtimeCard: "runtimeCard";
-    runtimeInput: "runtimeInput";
-    runtimeApproval: "runtimeApproval";
-}>;
-export type SseRuntimeControlKind = z.infer<typeof SseRuntimeControlKindSchema>;
-export declare const SseRuntimeControlPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    agentId: z.ZodString;
-    kind: z.ZodEnum<{
-        session: "session";
-        signal: "signal";
-        primitive: "primitive";
-        runtimeCard: "runtimeCard";
-        runtimeInput: "runtimeInput";
-        runtimeApproval: "runtimeApproval";
-    }>;
-    requestId: z.ZodOptional<z.ZodString>;
-    updatedAt: z.ZodOptional<z.ZodNumber>;
-    value: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-}, z.core.$strip>;
-export type SseRuntimeControlPayload = z.infer<typeof SseRuntimeControlPayloadSchema>;
-export declare const SseVoiceSessionSchema: z.ZodObject<{
-    id: z.ZodString;
-    conversationId: z.ZodString;
-    roomName: z.ZodString;
-    mode: z.ZodEnum<{
-        human: "human";
-        runtime_voice: "runtime_voice";
-    }>;
-    status: z.ZodEnum<{
-        error: "error";
-        active: "active";
-        ended: "ended";
-    }>;
-    createdBy: z.ZodString;
-    participantIds: z.ZodArray<z.ZodString>;
-    participants: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        userId: z.ZodString;
-        userType: z.ZodEnum<{
-            human: "human";
-            ai_agent: "ai_agent";
-            system: "system";
-        }>;
-        displayName: z.ZodNullable<z.ZodString>;
-        joinedAt: z.ZodNullable<z.ZodString>;
-        leftAt: z.ZodNullable<z.ZodString>;
-    }, z.core.$loose>>>;
-    targetAgentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    updatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$loose>;
-export type SseVoiceSession = z.infer<typeof SseVoiceSessionSchema>;
-export declare const SseVoiceSessionEventPayloadSchema: z.ZodObject<{
-    conversationId: z.ZodString;
-    session: z.ZodObject<{
-        id: z.ZodString;
-        conversationId: z.ZodString;
-        roomName: z.ZodString;
-        mode: z.ZodEnum<{
-            human: "human";
-            runtime_voice: "runtime_voice";
-        }>;
-        status: z.ZodEnum<{
-            error: "error";
-            active: "active";
-            ended: "ended";
-        }>;
-        createdBy: z.ZodString;
-        participantIds: z.ZodArray<z.ZodString>;
-        participants: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            userId: z.ZodString;
-            userType: z.ZodEnum<{
-                human: "human";
-                ai_agent: "ai_agent";
-                system: "system";
-            }>;
-            displayName: z.ZodNullable<z.ZodString>;
-            joinedAt: z.ZodNullable<z.ZodString>;
-            leftAt: z.ZodNullable<z.ZodString>;
-        }, z.core.$loose>>>;
-        targetAgentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        updatedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        endedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, z.core.$loose>;
-}, z.core.$strip>;
-export type SseVoiceSessionEventPayload = z.infer<typeof SseVoiceSessionEventPayloadSchema>;
-/**
- * Every SSE `event:` name stream-service emits today (stream.ts + listeners.ts;
- * mirrored by CanonStream's dispatch switch in core). NOTE: `contact.updated`
- * is emitted by stream-service but not yet consumed by CanonStream.
- */
-export declare const SSE_EVENT_TYPES: readonly ["connected", "agent.context", "heartbeat", "message.created", "message.updated", "message.deleted", "conversation.updated", "contact.request", "contact.approved", "contact.added", "contact.updated", "contact.removed", "typing", "presence", "runtime.updated", "turn.updated", "runtime.control", "voice.session.started", "voice.session.ended", "replay.expired", "error"];
-export declare const SseEventTypeSchema: z.ZodEnum<{
-    typing: "typing";
-    error: "error";
-    connected: "connected";
-    "agent.context": "agent.context";
-    heartbeat: "heartbeat";
-    "message.created": "message.created";
-    "message.updated": "message.updated";
-    "message.deleted": "message.deleted";
-    "conversation.updated": "conversation.updated";
-    "contact.request": "contact.request";
-    "contact.approved": "contact.approved";
-    "contact.added": "contact.added";
-    "contact.updated": "contact.updated";
-    "contact.removed": "contact.removed";
-    presence: "presence";
-    "runtime.updated": "runtime.updated";
-    "turn.updated": "turn.updated";
-    "runtime.control": "runtime.control";
-    "voice.session.started": "voice.session.started";
-    "voice.session.ended": "voice.session.ended";
-    "replay.expired": "replay.expired";
-}>;
-export type SseEventType = z.infer<typeof SseEventTypeSchema>;
-/** Payload schema for every event type — the machine-readable event registry. */
-export declare const SSE_EVENT_PAYLOAD_SCHEMAS: Record<SseEventType, z.ZodType>;
-/**
- * Subscription families (`?events=` filter). Lifecycle events (`connected`,
- * `agent.context`, `heartbeat`, `replay.expired`, `error`) are always sent.
- */
-export declare const SSE_EVENT_FAMILIES: readonly ["messages", "contacts", "typing_presence", "runtime_turn", "voice"];
-export declare const SseEventFamilySchema: z.ZodEnum<{
-    messages: "messages";
-    contacts: "contacts";
-    typing_presence: "typing_presence";
-    runtime_turn: "runtime_turn";
-    voice: "voice";
-}>;
-export type SseEventFamily = z.infer<typeof SseEventFamilySchema>;
-export declare const SSE_EVENT_FAMILY_BY_TYPE: Record<SseEventType, SseEventFamily | 'lifecycle'>;
-/**
- * A parsed SSE frame: `id:` (replay cursor), `event:`, and the JSON-decoded
- * `data:` payload. Validate `data` with SSE_EVENT_PAYLOAD_SCHEMAS[event].
- */
-export declare const SseEventEnvelopeSchema: z.ZodObject<{
-    id: z.ZodOptional<z.ZodString>;
-    event: z.ZodEnum<{
-        typing: "typing";
-        error: "error";
-        connected: "connected";
-        "agent.context": "agent.context";
-        heartbeat: "heartbeat";
-        "message.created": "message.created";
-        "message.updated": "message.updated";
-        "message.deleted": "message.deleted";
-        "conversation.updated": "conversation.updated";
-        "contact.request": "contact.request";
-        "contact.approved": "contact.approved";
-        "contact.added": "contact.added";
-        "contact.updated": "contact.updated";
-        "contact.removed": "contact.removed";
-        presence: "presence";
-        "runtime.updated": "runtime.updated";
-        "turn.updated": "turn.updated";
-        "runtime.control": "runtime.control";
-        "voice.session.started": "voice.session.started";
-        "voice.session.ended": "voice.session.ended";
-        "replay.expired": "replay.expired";
-    }>;
-    data: z.ZodUnknown;
-}, z.core.$strip>;
-export type SseEventEnvelope = z.infer<typeof SseEventEnvelopeSchema>;