@canonmsg/backend-contracts 1.8.1 → 2.0.0

package/dist/endpointRegistry.js

@@ -1,261 +0,0 @@
-import { ContactsResponseSchema, ConversationsResponseSchema, CreateContactRequestRequestSchema, CreateContactRequestResponseSchema, CreateConversationRequestSchema, CreateConversationResponseSchema, ForwardMessageRequestSchema, ForwardMessageResponseSchema, GetMessagesQuerySchema, MessagesPageResponseSchema, ReactRequestSchema, ReactResponseSchema, ResolveAdmissionRequestSchema, ResolveAdmissionResponseSchema, RestContactSchema, SendMessageRequestSchema, SendMessageResponseSchema, SetStreamingRequestSchema, SetTypingRequestSchema, UpdateDispositionRequestSchema, UploadMediaRequestSchema, UploadMediaResponseSchema, } from './restEndpoints.js';
-import { SendContextualRequestSchema, SendContextualResponseSchema, } from './sendContextual.js';
-export const CANON_REST_ENDPOINTS = [
-    // ── Identity ─────────────────────────────────────────────────────────
-    {
-        method: 'POST',
-        path: '/agents/register',
-        section: 'identity',
-        note: 'Public registration request. No API key required.',
-    },
-    {
-        method: 'GET',
-        path: '/agents/status/:requestId',
-        section: 'identity',
-        note: 'Poll approval status. Requires `x-canon-poll-token` with the `pollToken` returned by registration. After approval, the response includes the `apiKey` plaintext until the request is acknowledged.',
-    },
-    {
-        method: 'POST',
-        path: '/agents/status/:requestId/ack',
-        section: 'identity',
-        note: 'Acknowledge delivery. Requires `x-canon-poll-token`; clears the plaintext key from the registration request record so subsequent GET reads return `apiKeyDelivered: true`. Unacked plaintext keys are also auto-scrubbed 48 hours after approval; subsequent GET reads then return `apiKeyExpired: true` and the registrant must re-register (or the owner re-issues via key rotation).',
-    },
-    {
-        method: 'GET',
-        path: '/agents/me',
-        section: 'identity',
-        note: 'Authenticated agent identity and context.',
-    },
-    {
-        method: 'PATCH',
-        path: '/agents/profile',
-        section: 'identity',
-        note: 'Update agent profile fields.',
-    },
-    {
-        method: 'POST',
-        path: '/agents/auth-token',
-        section: 'identity',
-        note: 'Exchange API key for live agent-channel access when needed.',
-    },
-    {
-        method: 'POST',
-        path: '/agents/keys/rotate',
-        section: 'identity',
-        note: 'Agent-initiated key rotation. Returns the new plaintext key once.',
-    },
-    // ── Messaging ────────────────────────────────────────────────────────
-    {
-        method: 'POST',
-        path: '/messages/send',
-        section: 'messaging',
-        note: 'Send a durable message into a conversation.',
-        request: SendMessageRequestSchema,
-        response: SendMessageResponseSchema,
-    },
-    {
-        method: 'POST',
-        path: '/messages/send-contextual',
-        section: 'messaging',
-        note: 'Cross-conversation message with private agent self-context.',
-        request: SendContextualRequestSchema,
-        response: SendContextualResponseSchema,
-    },
-    {
-        method: 'POST',
-        path: '/messages/react',
-        section: 'messaging',
-        note: 'Toggle an emoji reaction.',
-        request: ReactRequestSchema,
-        response: ReactResponseSchema,
-    },
-    {
-        method: 'POST',
-        path: '/messages/forward',
-        section: 'messaging',
-        note: 'Forward an existing message.',
-        request: ForwardMessageRequestSchema,
-        response: ForwardMessageResponseSchema,
-    },
-    {
-        method: 'DELETE',
-        path: '/conversations/:conversationId/messages/:messageId',
-        section: 'messaging',
-        note: "Soft-delete the agent's own message.",
-    },
-    {
-        method: 'PATCH',
-        path: '/conversations/:conversationId/messages/:messageId/disposition',
-        section: 'messaging',
-        note: 'Update message disposition metadata.',
-        request: UpdateDispositionRequestSchema,
-    },
-    {
-        method: 'POST',
-        path: '/typing',
-        section: 'messaging',
-        note: 'Publish typing state.',
-        request: SetTypingRequestSchema,
-    },
-    {
-        method: 'POST',
-        path: '/streaming',
-        section: 'messaging',
-        note: 'Publish live streaming/progress state through REST. Most current runtimes prefer shared live-state helpers.',
-        request: SetStreamingRequestSchema,
-    },
-    // ── Conversations ────────────────────────────────────────────────────
-    {
-        method: 'GET',
-        path: '/conversations',
-        section: 'conversations',
-        note: 'List conversations the agent participates in.',
-        response: ConversationsResponseSchema,
-    },
-    {
-        method: 'GET',
-        path: '/conversations/:conversationId/messages',
-        section: 'conversations',
-        note: 'Fetch recent messages.',
-        request: GetMessagesQuerySchema,
-        response: MessagesPageResponseSchema,
-    },
-    {
-        method: 'POST',
-        path: '/conversations/create',
-        section: 'conversations',
-        note: 'Create or find a direct/group conversation when allowed.',
-        request: CreateConversationRequestSchema,
-        response: CreateConversationResponseSchema,
-    },
-    {
-        method: 'PATCH',
-        path: '/conversations/:conversationId/topic',
-        section: 'conversations',
-        note: 'Update the topic.',
-    },
-    {
-        method: 'PATCH',
-        path: '/conversations/:conversationId/name',
-        section: 'conversations',
-        note: 'Update group name when allowed.',
-    },
-    {
-        method: 'PATCH',
-        path: '/conversations/:conversationId/avatar',
-        section: 'conversations',
-        note: 'Update group avatar when allowed.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/read',
-        section: 'conversations',
-        note: 'Mark read.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/mute',
-        section: 'conversations',
-        note: 'Mute for the agent.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/unmute',
-        section: 'conversations',
-        note: 'Unmute for the agent.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/hide',
-        section: 'conversations',
-        note: 'Hide until new inbound activity.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/leave',
-        section: 'conversations',
-        note: 'Leave a group.',
-    },
-    {
-        method: 'POST',
-        path: '/conversations/:conversationId/members',
-        section: 'conversations',
-        note: 'Add a member when allowed.',
-    },
-    {
-        method: 'DELETE',
-        path: '/conversations/:conversationId/members/:userId',
-        section: 'conversations',
-        note: 'Remove a member when allowed.',
-    },
-    // ── Contacts and access ──────────────────────────────────────────────
-    {
-        method: 'POST',
-        path: '/contacts/request',
-        section: 'contacts',
-        note: 'Agent-side request for access.',
-        request: CreateContactRequestRequestSchema,
-        response: CreateContactRequestResponseSchema,
-    },
-    {
-        method: 'GET',
-        path: '/contacts/requests',
-        section: 'contacts',
-        note: 'Read-only awareness surface for requests involving the agent.',
-    },
-    {
-        method: 'GET',
-        path: '/contacts',
-        section: 'contacts',
-        note: "List the authenticated agent's contacts.",
-        response: ContactsResponseSchema,
-    },
-    {
-        method: 'GET',
-        path: '/contacts/:contactId',
-        section: 'contacts',
-        note: 'Fetch a single contact entry; 404 if missing.',
-        response: RestContactSchema,
-    },
-    {
-        method: 'DELETE',
-        path: '/contacts/:contactId',
-        section: 'contacts',
-        note: 'Remove a contact.',
-    },
-    {
-        method: 'POST',
-        path: '/users/block',
-        section: 'contacts',
-        note: 'Block a user.',
-    },
-    {
-        method: 'POST',
-        path: '/users/unblock',
-        section: 'contacts',
-        note: 'Unblock a user.',
-    },
-    {
-        method: 'POST',
-        path: '/admission/resolve',
-        section: 'contacts',
-        note: 'Resolve live admission state for a target user (used by `agent.reachOut` and contact-card CTAs to avoid acting on stale snapshots).',
-        request: ResolveAdmissionRequestSchema,
-        response: ResolveAdmissionResponseSchema,
-    },
-    {
-        method: 'POST',
-        path: '/admission/resolve-group',
-        section: 'contacts',
-        note: 'Resolve live group-join admission state (reads `groupJoinPolicy`).',
-    },
-];
-// Referenced for completeness of the registry import surface.
-export const CANON_MEDIA_UPLOAD_ENDPOINT = {
-    method: 'POST',
-    path: '/media/upload',
-    section: 'messaging',
-    note: 'Upload media; returns a Storage URL plus a normalized attachment.',
-    request: UploadMediaRequestSchema,
-    response: UploadMediaResponseSchema,
-};

package/dist/hitl.d.ts

@@ -1,303 +0,0 @@
-import { z } from 'zod';
-export declare const HitlRequestKindSchema: z.ZodEnum<{
-    input: "input";
-    approval: "approval";
-    card: "card";
-}>;
-export type HitlRequestKind = z.infer<typeof HitlRequestKindSchema>;
-export declare const HitlResolutionStatusSchema: z.ZodEnum<{
-    cancelled: "cancelled";
-    submitted: "submitted";
-    timeout: "timeout";
-}>;
-export type HitlResolutionStatus = z.infer<typeof HitlResolutionStatusSchema>;
-export declare const HitlApprovalRiskSchema: z.ZodEnum<{
-    low: "low";
-    normal: "normal";
-    high: "high";
-    destructive: "destructive";
-}>;
-export type HitlApprovalRisk = z.infer<typeof HitlApprovalRiskSchema>;
-export declare const HitlApprovalCategorySchema: z.ZodEnum<{
-    tool: "tool";
-    file: "file";
-    command: "command";
-    network: "network";
-    browser: "browser";
-    mcp: "mcp";
-    plugin: "plugin";
-    canon: "canon";
-}>;
-export type HitlApprovalCategory = z.infer<typeof HitlApprovalCategorySchema>;
-export declare const HitlApprovalDetailSchema: z.ZodObject<{
-    label: z.ZodString;
-    value: z.ZodString;
-    monospace: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type HitlApprovalDetail = z.infer<typeof HitlApprovalDetailSchema>;
-export declare const HitlSessionRuleSchema: z.ZodObject<{
-    type: z.ZodEnum<{
-        "approve-all": "approve-all";
-        "approve-tool": "approve-tool";
-        "deny-tool": "deny-tool";
-    }>;
-    toolPattern: z.ZodOptional<z.ZodString>;
-    expiresAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-export type HitlSessionRule = z.infer<typeof HitlSessionRuleSchema>;
-export declare const HitlApprovalRequestRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"approval_request">;
-    approvalId: z.ZodString;
-    responseUserId: z.ZodOptional<z.ZodString>;
-    toolName: z.ZodString;
-    toolSummary: z.ZodString;
-    category: z.ZodOptional<z.ZodEnum<{
-        tool: "tool";
-        file: "file";
-        command: "command";
-        network: "network";
-        browser: "browser";
-        mcp: "mcp";
-        plugin: "plugin";
-        canon: "canon";
-    }>>;
-    risk: z.ZodOptional<z.ZodEnum<{
-        low: "low";
-        normal: "normal";
-        high: "high";
-        destructive: "destructive";
-    }>>;
-    riskLevel: z.ZodOptional<z.ZodEnum<{
-        normal: "normal";
-        destructive: "destructive";
-    }>>;
-    runtimeId: z.ZodOptional<z.ZodString>;
-    turnId: z.ZodOptional<z.ZodString>;
-    native: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    details: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        value: z.ZodString;
-        monospace: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>>>;
-    diff: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    expiresAt: z.ZodString;
-}, z.core.$loose>;
-export type HitlApprovalRequestRecord = z.infer<typeof HitlApprovalRequestRecordSchema>;
-export declare const HitlApprovalReplyRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"approval_reply">;
-    approvalId: z.ZodString;
-    decision: z.ZodEnum<{
-        allow: "allow";
-        deny: "deny";
-    }>;
-    sessionRule: z.ZodOptional<z.ZodObject<{
-        type: z.ZodEnum<{
-            "approve-all": "approve-all";
-            "approve-tool": "approve-tool";
-            "deny-tool": "deny-tool";
-        }>;
-        toolPattern: z.ZodOptional<z.ZodString>;
-        expiresAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, z.core.$strip>>;
-}, z.core.$loose>;
-export type HitlApprovalReplyRecord = z.infer<typeof HitlApprovalReplyRecordSchema>;
-export declare const HitlApprovalOutcomeRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"approval_outcome">;
-    approvalId: z.ZodOptional<z.ZodString>;
-    decision: z.ZodOptional<z.ZodEnum<{
-        allow: "allow";
-        deny: "deny";
-    }>>;
-    reason: z.ZodOptional<z.ZodEnum<{
-        timeout: "timeout";
-        replied: "replied";
-        "session-rule": "session-rule";
-    }>>;
-}, z.core.$loose>;
-export type HitlApprovalOutcomeRecord = z.infer<typeof HitlApprovalOutcomeRecordSchema>;
-export declare const HitlInputKindSchema: z.ZodEnum<{
-    clarify: "clarify";
-    sudo: "sudo";
-    secret: "secret";
-}>;
-export type HitlInputKind = z.infer<typeof HitlInputKindSchema>;
-export declare const HitlInputQuestionSchema: z.ZodObject<{
-    id: z.ZodString;
-    question: z.ZodString;
-    header: z.ZodOptional<z.ZodString>;
-    choices: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        value: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
-        preview: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>>;
-    allowOther: z.ZodOptional<z.ZodBoolean>;
-    isSecret: z.ZodOptional<z.ZodBoolean>;
-    multiSelect: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type HitlInputQuestion = z.infer<typeof HitlInputQuestionSchema>;
-/** questionId → selected/typed answers. */
-export declare const HitlInputAnswersSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
-    answers: z.ZodArray<z.ZodString>;
-}, z.core.$strip>>;
-export type HitlInputAnswers = z.infer<typeof HitlInputAnswersSchema>;
-export declare const HitlInputRequestRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_input_request">;
-    inputId: z.ZodString;
-    responseUserId: z.ZodOptional<z.ZodString>;
-    kind: z.ZodEnum<{
-        clarify: "clarify";
-        sudo: "sudo";
-        secret: "secret";
-    }>;
-    prompt: z.ZodString;
-    title: z.ZodOptional<z.ZodString>;
-    choices: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        label: z.ZodString;
-        value: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
-        preview: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>>;
-    questions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        id: z.ZodString;
-        question: z.ZodString;
-        header: z.ZodOptional<z.ZodString>;
-        choices: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            label: z.ZodString;
-            value: z.ZodOptional<z.ZodString>;
-            description: z.ZodOptional<z.ZodString>;
-            preview: z.ZodOptional<z.ZodString>;
-        }, z.core.$strip>>>;
-        allowOther: z.ZodOptional<z.ZodBoolean>;
-        isSecret: z.ZodOptional<z.ZodBoolean>;
-        multiSelect: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>>>;
-    secretName: z.ZodOptional<z.ZodString>;
-    native: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    expiresAt: z.ZodString;
-    sensitive: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$loose>;
-export type HitlInputRequestRecord = z.infer<typeof HitlInputRequestRecordSchema>;
-export declare const HitlInputReplyRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_input_reply">;
-    inputId: z.ZodString;
-    kind: z.ZodOptional<z.ZodEnum<{
-        clarify: "clarify";
-        sudo: "sudo";
-        secret: "secret";
-    }>>;
-    status: z.ZodEnum<{
-        cancelled: "cancelled";
-        submitted: "submitted";
-    }>;
-    answerSummary: z.ZodOptional<z.ZodString>;
-    answersSummary: z.ZodOptional<z.ZodString>;
-    sensitive: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$loose>;
-export type HitlInputReplyRecord = z.infer<typeof HitlInputReplyRecordSchema>;
-export declare const HitlInputOutcomeRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_input_outcome">;
-    inputId: z.ZodString;
-    kind: z.ZodOptional<z.ZodEnum<{
-        clarify: "clarify";
-        sudo: "sudo";
-        secret: "secret";
-    }>>;
-    status: z.ZodEnum<{
-        cancelled: "cancelled";
-        submitted: "submitted";
-        timeout: "timeout";
-    }>;
-    reason: z.ZodOptional<z.ZodEnum<{
-        interrupted: "interrupted";
-        cancelled: "cancelled";
-        expired: "expired";
-        submitted: "submitted";
-        timeout: "timeout";
-    }>>;
-}, z.core.$loose>;
-export type HitlInputOutcomeRecord = z.infer<typeof HitlInputOutcomeRecordSchema>;
-export declare const HitlCardRequestRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_card_request">;
-    cardId: z.ZodString;
-    cardKind: z.ZodString;
-    schemaVersion: z.ZodLiteral<"canon.card.v1">;
-    fallbackText: z.ZodString;
-    responseUserId: z.ZodOptional<z.ZodString>;
-    expiresAt: z.ZodString;
-    runtimeId: z.ZodOptional<z.ZodString>;
-    turnId: z.ZodOptional<z.ZodString>;
-    native: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    interactive: z.ZodOptional<z.ZodBoolean>;
-    cardPreview: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-    turnSemantics: z.ZodLiteral<"control">;
-    replyBehavior: z.ZodLiteral<"suppress_auto_reply">;
-}, z.core.$loose>;
-export type HitlCardRequestRecord = z.infer<typeof HitlCardRequestRecordSchema>;
-export declare const HitlCardReplyRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_card_reply">;
-    cardId: z.ZodString;
-    status: z.ZodEnum<{
-        cancelled: "cancelled";
-        submitted: "submitted";
-    }>;
-    actionId: z.ZodOptional<z.ZodString>;
-    answerSummary: z.ZodOptional<z.ZodString>;
-    sensitive: z.ZodOptional<z.ZodBoolean>;
-    turnSemantics: z.ZodLiteral<"control">;
-    replyBehavior: z.ZodLiteral<"suppress_auto_reply">;
-}, z.core.$loose>;
-export type HitlCardReplyRecord = z.infer<typeof HitlCardReplyRecordSchema>;
-export declare const HitlCardOutcomeRecordSchema: z.ZodObject<{
-    type: z.ZodLiteral<"runtime_card_outcome">;
-    cardId: z.ZodString;
-    status: z.ZodEnum<{
-        cancelled: "cancelled";
-        submitted: "submitted";
-        timeout: "timeout";
-    }>;
-    reason: z.ZodOptional<z.ZodEnum<{
-        interrupted: "interrupted";
-        cancelled: "cancelled";
-        expired: "expired";
-        submitted: "submitted";
-        timeout: "timeout";
-    }>>;
-    turnSemantics: z.ZodLiteral<"control">;
-    replyBehavior: z.ZodLiteral<"suppress_auto_reply">;
-}, z.core.$loose>;
-export type HitlCardOutcomeRecord = z.infer<typeof HitlCardOutcomeRecordSchema>;
-/** Immediate result of requestApproval/requestInput/requestCard. */
-export declare const HitlRequestAcceptedSchema: z.ZodObject<{
-    requestId: z.ZodString;
-    expiresAt: z.ZodString;
-}, z.core.$strip>;
-export type HitlRequestAccepted = z.infer<typeof HitlRequestAcceptedSchema>;
-/** `onHitlResolved` — matches an earlier requestId. */
-export declare const HitlResolutionSchema: z.ZodObject<{
-    requestId: z.ZodString;
-    kind: z.ZodOptional<z.ZodEnum<{
-        input: "input";
-        approval: "approval";
-        card: "card";
-    }>>;
-    status: z.ZodEnum<{
-        cancelled: "cancelled";
-        submitted: "submitted";
-        timeout: "timeout";
-    }>;
-    answer: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strip>;
-export type HitlResolution = z.infer<typeof HitlResolutionSchema>;
-/** `onHitlPending` — replayed on reconnect for still-open requests. */
-export declare const HitlPendingSchema: z.ZodObject<{
-    requestId: z.ZodString;
-    kind: z.ZodEnum<{
-        input: "input";
-        approval: "approval";
-        card: "card";
-    }>;
-    conversationId: z.ZodString;
-    expiresAt: z.ZodString;
-}, z.core.$strip>;
-export type HitlPending = z.infer<typeof HitlPendingSchema>;