@canonmsg/backend-contracts 1.8.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. package/dist/agentBehaviorPolicy.d.ts +45 -86
  2. package/dist/agentBehaviorPolicy.js +0 -53
  3. package/dist/cjs/agentBehaviorPolicy.js +1 -54
  4. package/dist/cjs/contactRequest.js +0 -30
  5. package/dist/cjs/index.js +0 -8
  6. package/dist/cjs/media.js +0 -13
  7. package/dist/cjs/message.js +0 -64
  8. package/dist/cjs/runtimeCardFields.js +1 -58
  9. package/dist/cjs/turnProtocol.js +1 -41
  10. package/dist/contactRequest.d.ts +23 -42
  11. package/dist/contactRequest.js +0 -29
  12. package/dist/index.d.ts +0 -8
  13. package/dist/index.js +0 -8
  14. package/dist/media.d.ts +11 -24
  15. package/dist/media.js +0 -12
  16. package/dist/message.d.ts +50 -133
  17. package/dist/message.js +1 -64
  18. package/dist/runtimeCardFields.d.ts +39 -112
  19. package/dist/runtimeCardFields.js +0 -57
  20. package/dist/turnProtocol.d.ts +24 -91
  21. package/dist/turnProtocol.js +0 -40
  22. package/package.json +5 -8
  23. package/dist/bridgeLocal.d.ts +0 -1729
  24. package/dist/bridgeLocal.js +0 -673
  25. package/dist/cjs/bridgeLocal.js +0 -676
  26. package/dist/cjs/controlSignals.js +0 -44
  27. package/dist/cjs/endpointRegistry.js +0 -264
  28. package/dist/cjs/hitl.js +0 -0
  29. package/dist/cjs/inboundFrame.js +0 -92
  30. package/dist/cjs/restEndpoints.js +0 -237
  31. package/dist/cjs/sendContextual.js +0 -92
  32. package/dist/cjs/sseEvents.js +0 -298
  33. package/dist/controlSignals.d.ts +0 -55
  34. package/dist/controlSignals.js +0 -41
  35. package/dist/endpointRegistry.d.ts +0 -13
  36. package/dist/endpointRegistry.js +0 -261
  37. package/dist/hitl.d.ts +0 -303
  38. package/dist/hitl.js +0 -168
  39. package/dist/inboundFrame.d.ts +0 -229
  40. package/dist/inboundFrame.js +0 -89
  41. package/dist/restEndpoints.d.ts +0 -531
  42. package/dist/restEndpoints.js +0 -234
  43. package/dist/schemas/agent-behavior-settings-record.schema.json +0 -48
  44. package/dist/schemas/bridge-connection-state-notification.schema.json +0 -19
  45. package/dist/schemas/bridge-get-attachment-params.schema.json +0 -24
  46. package/dist/schemas/bridge-get-attachment-result.schema.json +0 -20
  47. package/dist/schemas/bridge-hello-params.schema.json +0 -42
  48. package/dist/schemas/bridge-hello-result.schema.json +0 -105
  49. package/dist/schemas/bridge-hitl-state.schema.json +0 -38
  50. package/dist/schemas/bridge-ok-result.schema.json +0 -15
  51. package/dist/schemas/bridge-ready-notification.schema.json +0 -79
  52. package/dist/schemas/bridge-resync-reason.schema.json +0 -9
  53. package/dist/schemas/bridge-resync.schema.json +0 -18
  54. package/dist/schemas/bridge-rpc-error.schema.json +0 -19
  55. package/dist/schemas/bridge-rpc-id.schema.json +0 -12
  56. package/dist/schemas/bridge-rpc-notification.schema.json +0 -20
  57. package/dist/schemas/bridge-rpc-request.schema.json +0 -31
  58. package/dist/schemas/bridge-rpc-response.schema.json +0 -81
  59. package/dist/schemas/bridge-status-result.schema.json +0 -76
  60. package/dist/schemas/bridge-upload-media-params.schema.json +0 -28
  61. package/dist/schemas/bridge-upstream-state.schema.json +0 -10
  62. package/dist/schemas/contacts-response.schema.json +0 -52
  63. package/dist/schemas/control-channel-key.schema.json +0 -10
  64. package/dist/schemas/control-primitive-event.schema.json +0 -30
  65. package/dist/schemas/control-primitive-map.schema.json +0 -15
  66. package/dist/schemas/control-session-event.schema.json +0 -26
  67. package/dist/schemas/control-session-node.schema.json +0 -11
  68. package/dist/schemas/control-signal-event.schema.json +0 -35
  69. package/dist/schemas/control-signal-node.schema.json +0 -22
  70. package/dist/schemas/control-signal-type.schema.json +0 -10
  71. package/dist/schemas/conversations-response.schema.json +0 -167
  72. package/dist/schemas/create-contact-request-request.schema.json +0 -17
  73. package/dist/schemas/create-contact-request-response.schema.json +0 -51
  74. package/dist/schemas/create-conversation-request.schema.json +0 -82
  75. package/dist/schemas/create-conversation-response.schema.json +0 -29
  76. package/dist/schemas/delete-message-response.schema.json +0 -11
  77. package/dist/schemas/delivery-intent.schema.json +0 -11
  78. package/dist/schemas/forward-message-request.schema.json +0 -25
  79. package/dist/schemas/forward-message-response.schema.json +0 -35
  80. package/dist/schemas/forwarded-from.schema.json +0 -18
  81. package/dist/schemas/get-messages-query.schema.json +0 -17
  82. package/dist/schemas/hitl-approval-category.schema.json +0 -15
  83. package/dist/schemas/hitl-approval-detail.schema.json +0 -21
  84. package/dist/schemas/hitl-approval-outcome-record.schema.json +0 -33
  85. package/dist/schemas/hitl-approval-reply-record.schema.json +0 -57
  86. package/dist/schemas/hitl-approval-request-record.schema.json +0 -105
  87. package/dist/schemas/hitl-approval-risk.schema.json +0 -11
  88. package/dist/schemas/hitl-card-outcome-record.schema.json +0 -48
  89. package/dist/schemas/hitl-card-reply-record.schema.json +0 -46
  90. package/dist/schemas/hitl-card-request-record.schema.json +0 -73
  91. package/dist/schemas/hitl-input-answers.schema.json +0 -23
  92. package/dist/schemas/hitl-input-kind.schema.json +0 -10
  93. package/dist/schemas/hitl-input-outcome-record.schema.json +0 -46
  94. package/dist/schemas/hitl-input-question.schema.json +0 -54
  95. package/dist/schemas/hitl-input-reply-record.schema.json +0 -44
  96. package/dist/schemas/hitl-input-request-record.schema.json +0 -134
  97. package/dist/schemas/hitl-pending.schema.json +0 -31
  98. package/dist/schemas/hitl-request-accepted.schema.json +0 -18
  99. package/dist/schemas/hitl-request-kind.schema.json +0 -10
  100. package/dist/schemas/hitl-resolution-status.schema.json +0 -10
  101. package/dist/schemas/hitl-resolution.schema.json +0 -38
  102. package/dist/schemas/hitl-session-rule.schema.json +0 -32
  103. package/dist/schemas/inbound-disposition.schema.json +0 -13
  104. package/dist/schemas/inbound-frame-attachment-v1.schema.json +0 -94
  105. package/dist/schemas/inbound-frame-contact-card-v1.schema.json +0 -59
  106. package/dist/schemas/inbound-frame-group-context-v1.schema.json +0 -96
  107. package/dist/schemas/inbound-frame-reply-context-v1.schema.json +0 -261
  108. package/dist/schemas/inbound-frame-shape-v1.schema.json +0 -12
  109. package/dist/schemas/inbound-frame-v1.schema.json +0 -506
  110. package/dist/schemas/mark-read-response.schema.json +0 -11
  111. package/dist/schemas/media-attachment-kind.schema.json +0 -11
  112. package/dist/schemas/media-attachment.schema.json +0 -42
  113. package/dist/schemas/messages-page-response.schema.json +0 -290
  114. package/dist/schemas/participation-decision-input.schema.json +0 -44
  115. package/dist/schemas/participation-history-message.schema.json +0 -23
  116. package/dist/schemas/participation-history-snapshot.schema.json +0 -37
  117. package/dist/schemas/participation-style.schema.json +0 -13
  118. package/dist/schemas/react-request.schema.json +0 -22
  119. package/dist/schemas/react-response.schema.json +0 -35
  120. package/dist/schemas/resolve-admission-request.schema.json +0 -30
  121. package/dist/schemas/resolve-admission-response.schema.json +0 -129
  122. package/dist/schemas/resolved-agent-behavior-policy-record.schema.json +0 -81
  123. package/dist/schemas/rest-contact.schema.json +0 -40
  124. package/dist/schemas/rest-conversation-last-message.schema.json +0 -77
  125. package/dist/schemas/rest-conversation.schema.json +0 -155
  126. package/dist/schemas/rest-message.schema.json +0 -252
  127. package/dist/schemas/rest-ok-response.schema.json +0 -11
  128. package/dist/schemas/rest-session-selection.schema.json +0 -40
  129. package/dist/schemas/runtime-card-field-choice.schema.json +0 -23
  130. package/dist/schemas/runtime-card-field-type.schema.json +0 -17
  131. package/dist/schemas/runtime-card-field.schema.json +0 -180
  132. package/dist/schemas/runtime-card-line-item-column-type.schema.json +0 -12
  133. package/dist/schemas/runtime-card-line-item-column.schema.json +0 -74
  134. package/dist/schemas/send-contextual-deferred-response.schema.json +0 -39
  135. package/dist/schemas/send-contextual-messaged-response.schema.json +0 -42
  136. package/dist/schemas/send-contextual-request.schema.json +0 -103
  137. package/dist/schemas/send-contextual-response.schema.json +0 -105
  138. package/dist/schemas/send-contextual-self-context.schema.json +0 -19
  139. package/dist/schemas/send-contextual-state-response.schema.json +0 -24
  140. package/dist/schemas/send-message-request.schema.json +0 -106
  141. package/dist/schemas/send-message-response.schema.json +0 -14
  142. package/dist/schemas/sender-type.schema.json +0 -9
  143. package/dist/schemas/serialize-message-input.schema.json +0 -29
  144. package/dist/schemas/serialized-agent-client-type.schema.json +0 -12
  145. package/dist/schemas/serialized-contact-card.schema.json +0 -65
  146. package/dist/schemas/serialized-contact-request-status.schema.json +0 -11
  147. package/dist/schemas/serialized-contact-request.schema.json +0 -157
  148. package/dist/schemas/serialized-content-type.schema.json +0 -13
  149. package/dist/schemas/serialized-message.schema.json +0 -249
  150. package/dist/schemas/serialized-reactions.schema.json +0 -14
  151. package/dist/schemas/serialized-sender-type.schema.json +0 -9
  152. package/dist/schemas/set-streaming-request.schema.json +0 -67
  153. package/dist/schemas/set-typing-request.schema.json +0 -25
  154. package/dist/schemas/sse-access-policy.schema.json +0 -10
  155. package/dist/schemas/sse-agent-context-payload.schema.json +0 -57
  156. package/dist/schemas/sse-connected-payload.schema.json +0 -18
  157. package/dist/schemas/sse-contact-payload.schema.json +0 -40
  158. package/dist/schemas/sse-contact-removed-payload.schema.json +0 -14
  159. package/dist/schemas/sse-contact-request-payload.schema.json +0 -157
  160. package/dist/schemas/sse-conversation-updated-payload.schema.json +0 -48
  161. package/dist/schemas/sse-error-payload.schema.json +0 -23
  162. package/dist/schemas/sse-event-envelope.schema.json +0 -42
  163. package/dist/schemas/sse-event-family.schema.json +0 -12
  164. package/dist/schemas/sse-event-type.schema.json +0 -28
  165. package/dist/schemas/sse-heartbeat-payload.schema.json +0 -14
  166. package/dist/schemas/sse-membership-change.schema.json +0 -28
  167. package/dist/schemas/sse-message-created-payload.schema.json +0 -414
  168. package/dist/schemas/sse-message-deleted-payload.schema.json +0 -18
  169. package/dist/schemas/sse-message-updated-payload.schema.json +0 -46
  170. package/dist/schemas/sse-presence-payload.schema.json +0 -21
  171. package/dist/schemas/sse-provenance.schema.json +0 -64
  172. package/dist/schemas/sse-replay-expired-payload.schema.json +0 -21
  173. package/dist/schemas/sse-runtime-control-kind.schema.json +0 -13
  174. package/dist/schemas/sse-runtime-control-payload.schema.json +0 -44
  175. package/dist/schemas/sse-runtime-updated-payload.schema.json +0 -78
  176. package/dist/schemas/sse-self-context.schema.json +0 -45
  177. package/dist/schemas/sse-turn-dispatch.schema.json +0 -29
  178. package/dist/schemas/sse-turn-updated-payload.schema.json +0 -33
  179. package/dist/schemas/sse-typing-payload.schema.json +0 -32
  180. package/dist/schemas/sse-voice-session-event-payload.schema.json +0 -170
  181. package/dist/schemas/sse-voice-session.schema.json +0 -157
  182. package/dist/schemas/trigger-decision.schema.json +0 -27
  183. package/dist/schemas/turn-lifecycle-state.schema.json +0 -14
  184. package/dist/schemas/turn-message-semantics.schema.json +0 -10
  185. package/dist/schemas/turn-metadata.schema.json +0 -56
  186. package/dist/schemas/turn-state-like.schema.json +0 -39
  187. package/dist/schemas/update-disposition-request.schema.json +0 -22
  188. package/dist/schemas/upload-media-request.schema.json +0 -25
  189. package/dist/schemas/upload-media-response.schema.json +0 -55
  190. package/dist/sendContextual.d.ts +0 -114
  191. package/dist/sendContextual.js +0 -89
  192. package/dist/sseEvents.d.ts +0 -494
  193. package/dist/sseEvents.js +0 -295
@@ -1,92 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SEND_CONTEXTUAL_HTTP_STATUS = exports.SendContextualResponseSchema = exports.SendContextualStateResponseSchema = exports.SendContextualDeferredResponseSchema = exports.SendContextualMessagedResponseSchema = exports.SendContextualRequestSchema = exports.SendContextualSelfContextSchema = void 0;
4
- // Wire contract v1 — POST /messages/send-contextual as a FIRST-CLASS contract
5
- // (bridge-execution-plan Phase 3; owner decision 2026-07-03: the re-spec rides
6
- // contract v1, the transport stays as-is and the Bridge proxies it unchanged
7
- // in Phase 4).
8
- //
9
- // Grounded in functions/src/api/sendContextualMessage.ts (the handler's actual
10
- // parse + emissions) and @canonmsg/core's SendContextualMessageOptions/Result.
11
- // This mirrors CURRENT behavior — a re-spec, not a redesign.
12
- const zod_1 = require("zod");
13
- const restEndpoints_js_1 = require("./restEndpoints.js");
14
- exports.SendContextualSelfContextSchema = zod_1.z.object({
15
- type: zod_1.z.literal('cross_session'),
16
- /** Private agent self-context; server caps at 1000 chars. */
17
- context: zod_1.z.string(),
18
- });
19
- /**
20
- * Request body. Exactly ONE of targetConversationId (existing conversation) or
21
- * targetUserId (open/reuse a direct conversation, contact-request fallback)
22
- * must be present — the refinement enforces the handler's rule.
23
- */
24
- exports.SendContextualRequestSchema = zod_1.z.object({
25
- sourceConversationId: zod_1.z.string(),
26
- /** Target arm 1: send into an existing conversation. */
27
- targetConversationId: zod_1.z.string().optional(),
28
- /** Target arm 2: resolve/create a direct conversation with this user. */
29
- targetUserId: zod_1.z.string().optional(),
30
- text: zod_1.z.string().optional(),
31
- selfContext: exports.SendContextualSelfContextSchema,
32
- /** Initial agent session config (agent targets) — opaque pass-through. */
33
- sessionConfig: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable().optional(),
34
- sessionSelection: restEndpoints_js_1.RestSessionSelectionSchema.optional(),
35
- /** Contact-request message when admission requires approval. */
36
- requestMessage: zod_1.z.string().optional(),
37
- /**
38
- * SendMessageOptions passthrough (attachments, replyTo, metadata, …).
39
- * May NOT carry selfContextId/selfContext — the handler rejects overrides
40
- * of the self-context linkage fields.
41
- */
42
- messageOptions: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
43
- }).refine((body) => (body.targetConversationId ? 1 : 0) + (body.targetUserId ? 1 : 0) === 1, { message: 'Provide exactly one targetConversationId or targetUserId' }).refine((body) => !body.messageOptions
44
- || (!('selfContextId' in body.messageOptions) && !('selfContext' in body.messageOptions)), { message: 'messageOptions may not override self-context linkage fields' });
45
- // ── Response arms (exactly what the handler emits today) ───────────────
46
- /** HTTP 201 — message persisted (or idempotent replay) with self-context linked. */
47
- exports.SendContextualMessagedResponseSchema = zod_1.z.object({
48
- status: zod_1.z.literal('messaged'),
49
- messageId: zod_1.z.string(),
50
- conversationId: zod_1.z.string(),
51
- selfContextId: zod_1.z.string(),
52
- /** Present when the target conversation was opened by this call. */
53
- created: zod_1.z.boolean().optional(),
54
- reused: zod_1.z.boolean().optional(),
55
- sessionSelection: zod_1.z.enum(['new', 'continue_latest', 'continue_or_create', 'specific']).optional(),
56
- });
57
- /**
58
- * HTTP 202 — admission requires approval: a contact request was created
59
- * (`requested`) or already pending (`pending`); the message is deferred as a
60
- * contextual intent when a request id exists.
61
- */
62
- exports.SendContextualDeferredResponseSchema = zod_1.z.object({
63
- status: zod_1.z.enum(['requested', 'pending']),
64
- requestId: zod_1.z.string().nullable(),
65
- deferredIntentId: zod_1.z.string().nullable().optional(),
66
- });
67
- /**
68
- * Terminal / retryable states:
69
- * - setup_required (HTTP 202) — agent session setup must complete first.
70
- * - blocked (HTTP 200) — admission denied (block or policy).
71
- * - unavailable (HTTP 200) — target cannot be reached right now.
72
- * - no_session (HTTP 404) — session selection matched nothing.
73
- */
74
- exports.SendContextualStateResponseSchema = zod_1.z.object({
75
- status: zod_1.z.enum(['setup_required', 'blocked', 'unavailable', 'no_session']),
76
- reason: zod_1.z.string(),
77
- });
78
- exports.SendContextualResponseSchema = zod_1.z.union([
79
- exports.SendContextualMessagedResponseSchema,
80
- exports.SendContextualDeferredResponseSchema,
81
- exports.SendContextualStateResponseSchema,
82
- ]);
83
- /** HTTP status the handler pairs with each response status. */
84
- exports.SEND_CONTEXTUAL_HTTP_STATUS = {
85
- messaged: 201,
86
- requested: 202,
87
- pending: 202,
88
- setup_required: 202,
89
- blocked: 200,
90
- unavailable: 200,
91
- no_session: 404,
92
- };
@@ -1,298 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SseEventEnvelopeSchema = exports.SSE_EVENT_FAMILY_BY_TYPE = exports.SseEventFamilySchema = exports.SSE_EVENT_FAMILIES = exports.SSE_EVENT_PAYLOAD_SCHEMAS = exports.SseEventTypeSchema = exports.SSE_EVENT_TYPES = exports.SseVoiceSessionEventPayloadSchema = exports.SseVoiceSessionSchema = exports.SseRuntimeControlPayloadSchema = exports.SseRuntimeControlKindSchema = exports.SseTurnUpdatedPayloadSchema = exports.SseRuntimeUpdatedPayloadSchema = exports.SsePresencePayloadSchema = exports.SseTypingPayloadSchema = exports.SseContactRemovedPayloadSchema = exports.SseContactPayloadSchema = exports.SseContactRequestPayloadSchema = exports.SseConversationUpdatedPayloadSchema = exports.SseMembershipChangeSchema = exports.SseMessageDeletedPayloadSchema = exports.SseMessageUpdatedPayloadSchema = exports.SseMessageCreatedPayloadSchema = exports.SseProvenanceSchema = exports.SseTurnDispatchSchema = exports.SseSelfContextSchema = exports.SseErrorPayloadSchema = exports.SseReplayExpiredPayloadSchema = exports.SseHeartbeatPayloadSchema = exports.SseAgentContextPayloadSchema = exports.SseConnectedPayloadSchema = exports.SseAccessPolicySchema = void 0;
4
- // Wire contract v1 — SSE event envelope + per-family payload schemas.
5
- //
6
- // Grounded in what stream-service ACTUALLY emits (stream-service/src/stream.ts
7
- // + listeners.ts) and what @canonmsg/core's CanonStream consumes — not in
8
- // design-doc prose. Payload slots that stream-service passes through opaquely
9
- // (behavior policies, runtime snapshots, raw RTDB values) stay loose objects;
10
- // slots stream-service constructs field-by-field are closed.
11
- //
12
- // The golden fixtures in @canonmsg/test-fixtures parse under these schemas;
13
- // the future Python framework must pass the same fixtures.
14
- const zod_1 = require("zod");
15
- const contactRequest_js_1 = require("./contactRequest.js");
16
- const message_js_1 = require("./message.js");
17
- exports.SseAccessPolicySchema = zod_1.z.enum(['open', 'approval-required', 'owner-only']);
18
- // ── Lifecycle events ───────────────────────────────────────────────────
19
- exports.SseConnectedPayloadSchema = zod_1.z.object({
20
- connectionId: zod_1.z.string(),
21
- agentId: zod_1.z.string(),
22
- });
23
- /** Trusted, server-injected identity & access info (stream.ts `agent.context`). */
24
- exports.SseAgentContextPayloadSchema = zod_1.z.looseObject({
25
- agentId: zod_1.z.string(),
26
- canonContactId: zod_1.z.string().optional(),
27
- clientType: zod_1.z.string().optional(),
28
- ownerId: zod_1.z.string(),
29
- ownerName: zod_1.z.string(),
30
- /** Resolved agent behavior policy — passed through opaquely. */
31
- defaultBehavior: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
32
- inboundPolicy: exports.SseAccessPolicySchema,
33
- groupJoinPolicy: exports.SseAccessPolicySchema,
34
- discoverable: zod_1.z.boolean(),
35
- });
36
- exports.SseHeartbeatPayloadSchema = zod_1.z.object({
37
- timestamp: zod_1.z.string(),
38
- });
39
- exports.SseReplayExpiredPayloadSchema = zod_1.z.looseObject({
40
- lastAvailableId: zod_1.z.string().nullable().optional(),
41
- message: zod_1.z.string().optional(),
42
- });
43
- exports.SseErrorPayloadSchema = zod_1.z.looseObject({
44
- code: zod_1.z.string().optional(),
45
- message: zod_1.z.string().optional(),
46
- retryAfterMs: zod_1.z.number().optional(),
47
- activeConnections: zod_1.z.number().optional(),
48
- maxConnections: zod_1.z.number().optional(),
49
- });
50
- // ── Messages family ────────────────────────────────────────────────────
51
- exports.SseSelfContextSchema = zod_1.z.object({
52
- id: zod_1.z.string(),
53
- type: zod_1.z.literal('cross_session'),
54
- context: zod_1.z.string(),
55
- createdAt: zod_1.z.string().nullable(),
56
- updatedAt: zod_1.z.string().nullable(),
57
- });
58
- exports.SseTurnDispatchSchema = zod_1.z.looseObject({
59
- kind: zod_1.z.enum(['run_turn', 'observe_only']),
60
- reason: zod_1.z.string(),
61
- addressed: zod_1.z.boolean(),
62
- policyVersion: zod_1.z.string().optional(),
63
- });
64
- exports.SseProvenanceSchema = zod_1.z.looseObject({
65
- conversation: zod_1.z.looseObject({
66
- id: zod_1.z.string(),
67
- type: zod_1.z.enum(['direct', 'group', 'unknown']),
68
- }),
69
- sender: zod_1.z.looseObject({
70
- id: zod_1.z.string(),
71
- name: zod_1.z.string().optional(),
72
- type: zod_1.z.enum(['human', 'ai_agent']),
73
- isOwner: zod_1.z.boolean(),
74
- }),
75
- mentionedAgent: zod_1.z.boolean(),
76
- });
77
- /**
78
- * `message.created` — the inbound message envelope. `message` is exactly the
79
- * SerializedMessage the shared serializer emits (the E2EE S1 slot).
80
- */
81
- exports.SseMessageCreatedPayloadSchema = zod_1.z.looseObject({
82
- conversationId: zod_1.z.string(),
83
- /** Resolved agent behavior policy — passed through opaquely. */
84
- behavior: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
85
- activeSelfContextId: zod_1.z.string().nullable().optional(),
86
- selfContexts: zod_1.z.array(exports.SseSelfContextSchema).optional(),
87
- provenance: exports.SseProvenanceSchema.optional(),
88
- turnDispatch: exports.SseTurnDispatchSchema.optional(),
89
- message: message_js_1.SerializedMessageSchema,
90
- });
91
- exports.SseMessageUpdatedPayloadSchema = zod_1.z.object({
92
- conversationId: zod_1.z.string(),
93
- messageId: zod_1.z.string(),
94
- actorId: zod_1.z.string().optional(),
95
- updatedAt: zod_1.z.string().optional(),
96
- changes: zod_1.z.looseObject({
97
- reactions: message_js_1.SerializedReactionsSchema,
98
- }),
99
- });
100
- exports.SseMessageDeletedPayloadSchema = zod_1.z.object({
101
- conversationId: zod_1.z.string(),
102
- messageId: zod_1.z.string(),
103
- });
104
- exports.SseMembershipChangeSchema = zod_1.z.object({
105
- addedMemberIds: zod_1.z.array(zod_1.z.string()),
106
- removedMemberIds: zod_1.z.array(zod_1.z.string()),
107
- memberCount: zod_1.z.number(),
108
- });
109
- exports.SseConversationUpdatedPayloadSchema = zod_1.z.object({
110
- conversationId: zod_1.z.string(),
111
- changes: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
112
- membershipChange: exports.SseMembershipChangeSchema.optional(),
113
- });
114
- // ── Contacts family ────────────────────────────────────────────────────
115
- /** `contact.request` / `contact.approved` carry the serialized contact request. */
116
- exports.SseContactRequestPayloadSchema = contactRequest_js_1.SerializedContactRequestSchema;
117
- /**
118
- * `contact.added` / `contact.updated`. `source` is a pass-through string —
119
- * canonical values today: direct_add, phone_book, contact_request, link, qr,
120
- * group, open_inbound_message, unknown.
121
- */
122
- exports.SseContactPayloadSchema = zod_1.z.object({
123
- id: zod_1.z.string(),
124
- source: zod_1.z.string(),
125
- addedAt: zod_1.z.string().nullable(),
126
- displayNameOverride: zod_1.z.string().nullable(),
127
- });
128
- exports.SseContactRemovedPayloadSchema = zod_1.z.object({
129
- id: zod_1.z.string(),
130
- });
131
- // ── Typing / presence family ───────────────────────────────────────────
132
- exports.SseTypingPayloadSchema = zod_1.z.object({
133
- conversationId: zod_1.z.string(),
134
- userId: zod_1.z.string(),
135
- isTyping: zod_1.z.boolean(),
136
- status: zod_1.z.enum(['thinking', 'typing']).optional(),
137
- timestamp: zod_1.z.number().optional(),
138
- });
139
- exports.SsePresencePayloadSchema = zod_1.z.object({
140
- userId: zod_1.z.string(),
141
- online: zod_1.z.boolean(),
142
- lastSeen: zod_1.z.string().optional(),
143
- });
144
- // ── Runtime / turn family ──────────────────────────────────────────────
145
- /** Aggregated RTDB runtime snapshot — nodes are passed through opaquely. */
146
- exports.SseRuntimeUpdatedPayloadSchema = zod_1.z.object({
147
- conversationId: zod_1.z.string(),
148
- agentId: zod_1.z.string(),
149
- runtime: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
150
- runtimeInfo: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
151
- sessionState: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
152
- sessionConfig: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
153
- });
154
- exports.SseTurnUpdatedPayloadSchema = zod_1.z.object({
155
- conversationId: zod_1.z.string(),
156
- agentId: zod_1.z.string(),
157
- turn: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
158
- });
159
- exports.SseRuntimeControlKindSchema = zod_1.z.enum([
160
- 'session',
161
- 'signal',
162
- 'primitive',
163
- 'runtimeInput',
164
- 'runtimeCard',
165
- 'runtimeApproval',
166
- ]);
167
- exports.SseRuntimeControlPayloadSchema = zod_1.z.object({
168
- conversationId: zod_1.z.string(),
169
- agentId: zod_1.z.string(),
170
- kind: exports.SseRuntimeControlKindSchema,
171
- requestId: zod_1.z.string().optional(),
172
- updatedAt: zod_1.z.number().optional(),
173
- value: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
174
- });
175
- // ── Voice family ───────────────────────────────────────────────────────
176
- exports.SseVoiceSessionSchema = zod_1.z.looseObject({
177
- id: zod_1.z.string(),
178
- conversationId: zod_1.z.string(),
179
- roomName: zod_1.z.string(),
180
- mode: zod_1.z.enum(['human', 'runtime_voice']),
181
- status: zod_1.z.enum(['active', 'ended', 'error']),
182
- createdBy: zod_1.z.string(),
183
- participantIds: zod_1.z.array(zod_1.z.string()),
184
- participants: zod_1.z.array(zod_1.z.looseObject({
185
- userId: zod_1.z.string(),
186
- userType: zod_1.z.enum(['human', 'ai_agent', 'system']),
187
- displayName: zod_1.z.string().nullable(),
188
- joinedAt: zod_1.z.string().nullable(),
189
- leftAt: zod_1.z.string().nullable(),
190
- })).optional(),
191
- targetAgentId: zod_1.z.string().nullable().optional(),
192
- createdAt: zod_1.z.string().nullable().optional(),
193
- updatedAt: zod_1.z.string().nullable().optional(),
194
- endedAt: zod_1.z.string().nullable().optional(),
195
- error: zod_1.z.string().nullable().optional(),
196
- });
197
- exports.SseVoiceSessionEventPayloadSchema = zod_1.z.object({
198
- conversationId: zod_1.z.string(),
199
- session: exports.SseVoiceSessionSchema,
200
- });
201
- // ── Envelope + registry ────────────────────────────────────────────────
202
- /**
203
- * Every SSE `event:` name stream-service emits today (stream.ts + listeners.ts;
204
- * mirrored by CanonStream's dispatch switch in core). NOTE: `contact.updated`
205
- * is emitted by stream-service but not yet consumed by CanonStream.
206
- */
207
- exports.SSE_EVENT_TYPES = [
208
- 'connected',
209
- 'agent.context',
210
- 'heartbeat',
211
- 'message.created',
212
- 'message.updated',
213
- 'message.deleted',
214
- 'conversation.updated',
215
- 'contact.request',
216
- 'contact.approved',
217
- 'contact.added',
218
- 'contact.updated',
219
- 'contact.removed',
220
- 'typing',
221
- 'presence',
222
- 'runtime.updated',
223
- 'turn.updated',
224
- 'runtime.control',
225
- 'voice.session.started',
226
- 'voice.session.ended',
227
- 'replay.expired',
228
- 'error',
229
- ];
230
- exports.SseEventTypeSchema = zod_1.z.enum(exports.SSE_EVENT_TYPES);
231
- /** Payload schema for every event type — the machine-readable event registry. */
232
- exports.SSE_EVENT_PAYLOAD_SCHEMAS = {
233
- 'connected': exports.SseConnectedPayloadSchema,
234
- 'agent.context': exports.SseAgentContextPayloadSchema,
235
- 'heartbeat': exports.SseHeartbeatPayloadSchema,
236
- 'message.created': exports.SseMessageCreatedPayloadSchema,
237
- 'message.updated': exports.SseMessageUpdatedPayloadSchema,
238
- 'message.deleted': exports.SseMessageDeletedPayloadSchema,
239
- 'conversation.updated': exports.SseConversationUpdatedPayloadSchema,
240
- 'contact.request': exports.SseContactRequestPayloadSchema,
241
- 'contact.approved': exports.SseContactRequestPayloadSchema,
242
- 'contact.added': exports.SseContactPayloadSchema,
243
- 'contact.updated': exports.SseContactPayloadSchema,
244
- 'contact.removed': exports.SseContactRemovedPayloadSchema,
245
- 'typing': exports.SseTypingPayloadSchema,
246
- 'presence': exports.SsePresencePayloadSchema,
247
- 'runtime.updated': exports.SseRuntimeUpdatedPayloadSchema,
248
- 'turn.updated': exports.SseTurnUpdatedPayloadSchema,
249
- 'runtime.control': exports.SseRuntimeControlPayloadSchema,
250
- 'voice.session.started': exports.SseVoiceSessionEventPayloadSchema,
251
- 'voice.session.ended': exports.SseVoiceSessionEventPayloadSchema,
252
- 'replay.expired': exports.SseReplayExpiredPayloadSchema,
253
- 'error': exports.SseErrorPayloadSchema,
254
- };
255
- /**
256
- * Subscription families (`?events=` filter). Lifecycle events (`connected`,
257
- * `agent.context`, `heartbeat`, `replay.expired`, `error`) are always sent.
258
- */
259
- exports.SSE_EVENT_FAMILIES = [
260
- 'messages',
261
- 'contacts',
262
- 'typing_presence',
263
- 'runtime_turn',
264
- 'voice',
265
- ];
266
- exports.SseEventFamilySchema = zod_1.z.enum(exports.SSE_EVENT_FAMILIES);
267
- exports.SSE_EVENT_FAMILY_BY_TYPE = {
268
- 'connected': 'lifecycle',
269
- 'agent.context': 'lifecycle',
270
- 'heartbeat': 'lifecycle',
271
- 'message.created': 'messages',
272
- 'message.updated': 'messages',
273
- 'message.deleted': 'messages',
274
- 'conversation.updated': 'messages',
275
- 'contact.request': 'contacts',
276
- 'contact.approved': 'contacts',
277
- 'contact.added': 'contacts',
278
- 'contact.updated': 'contacts',
279
- 'contact.removed': 'contacts',
280
- 'typing': 'typing_presence',
281
- 'presence': 'typing_presence',
282
- 'runtime.updated': 'runtime_turn',
283
- 'turn.updated': 'runtime_turn',
284
- 'runtime.control': 'runtime_turn',
285
- 'voice.session.started': 'voice',
286
- 'voice.session.ended': 'voice',
287
- 'replay.expired': 'lifecycle',
288
- 'error': 'lifecycle',
289
- };
290
- /**
291
- * A parsed SSE frame: `id:` (replay cursor), `event:`, and the JSON-decoded
292
- * `data:` payload. Validate `data` with SSE_EVENT_PAYLOAD_SCHEMAS[event].
293
- */
294
- exports.SseEventEnvelopeSchema = zod_1.z.object({
295
- id: zod_1.z.string().optional(),
296
- event: exports.SseEventTypeSchema,
297
- data: zod_1.z.unknown(),
298
- });
@@ -1,55 +0,0 @@
1
- import { z } from 'zod';
2
- export declare const ControlSignalTypeSchema: z.ZodEnum<{
3
- interrupt: "interrupt";
4
- stop_and_drop: "stop_and_drop";
5
- new_session: "new_session";
6
- }>;
7
- export type ControlSignalType = z.infer<typeof ControlSignalTypeSchema>;
8
- export declare const ControlChannelKeySchema: z.ZodEnum<{
9
- session: "session";
10
- signal: "signal";
11
- primitive: "primitive";
12
- }>;
13
- export type ControlChannelKey = z.infer<typeof ControlChannelKeySchema>;
14
- /** `/control/{convo}/{agent}/signal` node. Consumed by writing null. */
15
- export declare const ControlSignalNodeSchema: z.ZodObject<{
16
- type: z.ZodEnum<{
17
- interrupt: "interrupt";
18
- stop_and_drop: "stop_and_drop";
19
- new_session: "new_session";
20
- }>;
21
- updatedAt: z.ZodOptional<z.ZodNumber>;
22
- }, z.core.$loose>;
23
- export type ControlSignalNode = z.infer<typeof ControlSignalNodeSchema>;
24
- /** `/control/{convo}/{agent}/session` node — the session-control primitive record. */
25
- export declare const ControlSessionNodeSchema: z.ZodObject<{
26
- updatedAt: z.ZodOptional<z.ZodNumber>;
27
- }, z.core.$loose>;
28
- export type ControlSessionNode = z.infer<typeof ControlSessionNodeSchema>;
29
- /** `/control/{convo}/{agent}/primitive` — map of requestId → request value. */
30
- export declare const ControlPrimitiveMapSchema: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>;
31
- export type ControlPrimitiveMap = z.infer<typeof ControlPrimitiveMapSchema>;
32
- export declare const ControlSignalEventSchema: z.ZodObject<{
33
- conversationId: z.ZodString;
34
- type: z.ZodEnum<{
35
- interrupt: "interrupt";
36
- stop_and_drop: "stop_and_drop";
37
- new_session: "new_session";
38
- }>;
39
- updatedAt: z.ZodNumber;
40
- raw: z.ZodRecord<z.ZodString, z.ZodUnknown>;
41
- }, z.core.$strip>;
42
- export type ControlSignalEventRecord = z.infer<typeof ControlSignalEventSchema>;
43
- export declare const ControlSessionEventSchema: z.ZodObject<{
44
- conversationId: z.ZodString;
45
- updatedAt: z.ZodNumber;
46
- control: z.ZodRecord<z.ZodString, z.ZodUnknown>;
47
- }, z.core.$strip>;
48
- export type ControlSessionEventRecord = z.infer<typeof ControlSessionEventSchema>;
49
- export declare const ControlPrimitiveEventSchema: z.ZodObject<{
50
- conversationId: z.ZodString;
51
- requestId: z.ZodString;
52
- updatedAt: z.ZodNumber;
53
- value: z.ZodRecord<z.ZodString, z.ZodUnknown>;
54
- }, z.core.$strip>;
55
- export type ControlPrimitiveEventRecord = z.infer<typeof ControlPrimitiveEventSchema>;
@@ -1,41 +0,0 @@
1
- // Wire contract v1 — RTDB control-channel signal + session-control records.
2
- //
3
- // Grounded in @canonmsg/core's ControlChannelPoller (the consumer every host
4
- // uses for `/control/{conversationId}/{agentId}` reads) and stream-service's
5
- // `runtime.control` mirror. Three channel keys, read in order:
6
- // session — human changed a runtime control (model/effort/permission …)
7
- // signal — interrupt / stop_and_drop / new_session
8
- // primitive — keyed request map (requestId → value)
9
- import { z } from 'zod';
10
- export const ControlSignalTypeSchema = z.enum(['interrupt', 'stop_and_drop', 'new_session']);
11
- export const ControlChannelKeySchema = z.enum(['session', 'signal', 'primitive']);
12
- // ── RTDB node records (what is written at /control/{convo}/{agent}/…) ──
13
- /** `/control/{convo}/{agent}/signal` node. Consumed by writing null. */
14
- export const ControlSignalNodeSchema = z.looseObject({
15
- type: ControlSignalTypeSchema,
16
- updatedAt: z.number().optional(),
17
- });
18
- /** `/control/{convo}/{agent}/session` node — the session-control primitive record. */
19
- export const ControlSessionNodeSchema = z.looseObject({
20
- updatedAt: z.number().optional(),
21
- });
22
- /** `/control/{convo}/{agent}/primitive` — map of requestId → request value. */
23
- export const ControlPrimitiveMapSchema = z.record(z.string(), z.record(z.string(), z.unknown()));
24
- // ── Dispatched events (what a runtime's handler receives) ──────────────
25
- export const ControlSignalEventSchema = z.object({
26
- conversationId: z.string(),
27
- type: ControlSignalTypeSchema,
28
- updatedAt: z.number(),
29
- raw: z.record(z.string(), z.unknown()),
30
- });
31
- export const ControlSessionEventSchema = z.object({
32
- conversationId: z.string(),
33
- updatedAt: z.number(),
34
- control: z.record(z.string(), z.unknown()),
35
- });
36
- export const ControlPrimitiveEventSchema = z.object({
37
- conversationId: z.string(),
38
- requestId: z.string(),
39
- updatedAt: z.number(),
40
- value: z.record(z.string(), z.unknown()),
41
- });
@@ -1,13 +0,0 @@
1
- import type { z } from 'zod';
2
- export type CanonEndpointSection = 'identity' | 'messaging' | 'conversations' | 'contacts';
3
- export interface CanonEndpointDescriptor {
4
- method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
5
- path: string;
6
- section: CanonEndpointSection;
7
- /** Public one-line contract note (rendered into docs/agents/contracts.md). */
8
- note: string;
9
- request?: z.ZodType;
10
- response?: z.ZodType;
11
- }
12
- export declare const CANON_REST_ENDPOINTS: CanonEndpointDescriptor[];
13
- export declare const CANON_MEDIA_UPLOAD_ENDPOINT: CanonEndpointDescriptor;