@canonmsg/backend-contracts 1.7.1 → 1.8.1

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 +86 -45
  2. package/dist/agentBehaviorPolicy.js +53 -0
  3. package/dist/bridgeLocal.d.ts +1729 -0
  4. package/dist/bridgeLocal.js +673 -0
  5. package/dist/cjs/agentBehaviorPolicy.js +54 -1
  6. package/dist/cjs/bridgeLocal.js +676 -0
  7. package/dist/cjs/contactRequest.js +30 -0
  8. package/dist/cjs/controlSignals.js +44 -0
  9. package/dist/cjs/endpointRegistry.js +264 -0
  10. package/dist/cjs/hitl.js +0 -0
  11. package/dist/cjs/inboundFrame.js +92 -0
  12. package/dist/cjs/index.js +8 -0
  13. package/dist/cjs/media.js +13 -0
  14. package/dist/cjs/message.js +64 -0
  15. package/dist/cjs/restEndpoints.js +237 -0
  16. package/dist/cjs/runtimeCardFields.js +58 -1
  17. package/dist/cjs/sendContextual.js +92 -0
  18. package/dist/cjs/sseEvents.js +298 -0
  19. package/dist/cjs/turnProtocol.js +41 -1
  20. package/dist/contactRequest.d.ts +42 -23
  21. package/dist/contactRequest.js +29 -0
  22. package/dist/controlSignals.d.ts +55 -0
  23. package/dist/controlSignals.js +41 -0
  24. package/dist/endpointRegistry.d.ts +13 -0
  25. package/dist/endpointRegistry.js +261 -0
  26. package/dist/hitl.d.ts +303 -0
  27. package/dist/hitl.js +168 -0
  28. package/dist/inboundFrame.d.ts +229 -0
  29. package/dist/inboundFrame.js +89 -0
  30. package/dist/index.d.ts +8 -0
  31. package/dist/index.js +8 -0
  32. package/dist/media.d.ts +24 -11
  33. package/dist/media.js +12 -0
  34. package/dist/message.d.ts +133 -50
  35. package/dist/message.js +64 -1
  36. package/dist/restEndpoints.d.ts +531 -0
  37. package/dist/restEndpoints.js +234 -0
  38. package/dist/runtimeCardFields.d.ts +112 -39
  39. package/dist/runtimeCardFields.js +57 -0
  40. package/dist/schemas/agent-behavior-settings-record.schema.json +48 -0
  41. package/dist/schemas/bridge-connection-state-notification.schema.json +19 -0
  42. package/dist/schemas/bridge-get-attachment-params.schema.json +24 -0
  43. package/dist/schemas/bridge-get-attachment-result.schema.json +20 -0
  44. package/dist/schemas/bridge-hello-params.schema.json +42 -0
  45. package/dist/schemas/bridge-hello-result.schema.json +105 -0
  46. package/dist/schemas/bridge-hitl-state.schema.json +38 -0
  47. package/dist/schemas/bridge-ok-result.schema.json +15 -0
  48. package/dist/schemas/bridge-ready-notification.schema.json +79 -0
  49. package/dist/schemas/bridge-resync-reason.schema.json +9 -0
  50. package/dist/schemas/bridge-resync.schema.json +18 -0
  51. package/dist/schemas/bridge-rpc-error.schema.json +19 -0
  52. package/dist/schemas/bridge-rpc-id.schema.json +12 -0
  53. package/dist/schemas/bridge-rpc-notification.schema.json +20 -0
  54. package/dist/schemas/bridge-rpc-request.schema.json +31 -0
  55. package/dist/schemas/bridge-rpc-response.schema.json +81 -0
  56. package/dist/schemas/bridge-status-result.schema.json +76 -0
  57. package/dist/schemas/bridge-upload-media-params.schema.json +28 -0
  58. package/dist/schemas/bridge-upstream-state.schema.json +10 -0
  59. package/dist/schemas/contacts-response.schema.json +52 -0
  60. package/dist/schemas/control-channel-key.schema.json +10 -0
  61. package/dist/schemas/control-primitive-event.schema.json +30 -0
  62. package/dist/schemas/control-primitive-map.schema.json +15 -0
  63. package/dist/schemas/control-session-event.schema.json +26 -0
  64. package/dist/schemas/control-session-node.schema.json +11 -0
  65. package/dist/schemas/control-signal-event.schema.json +35 -0
  66. package/dist/schemas/control-signal-node.schema.json +22 -0
  67. package/dist/schemas/control-signal-type.schema.json +10 -0
  68. package/dist/schemas/conversations-response.schema.json +167 -0
  69. package/dist/schemas/create-contact-request-request.schema.json +17 -0
  70. package/dist/schemas/create-contact-request-response.schema.json +51 -0
  71. package/dist/schemas/create-conversation-request.schema.json +82 -0
  72. package/dist/schemas/create-conversation-response.schema.json +29 -0
  73. package/dist/schemas/delete-message-response.schema.json +11 -0
  74. package/dist/schemas/delivery-intent.schema.json +11 -0
  75. package/dist/schemas/forward-message-request.schema.json +25 -0
  76. package/dist/schemas/forward-message-response.schema.json +35 -0
  77. package/dist/schemas/forwarded-from.schema.json +18 -0
  78. package/dist/schemas/get-messages-query.schema.json +17 -0
  79. package/dist/schemas/hitl-approval-category.schema.json +15 -0
  80. package/dist/schemas/hitl-approval-detail.schema.json +21 -0
  81. package/dist/schemas/hitl-approval-outcome-record.schema.json +33 -0
  82. package/dist/schemas/hitl-approval-reply-record.schema.json +57 -0
  83. package/dist/schemas/hitl-approval-request-record.schema.json +105 -0
  84. package/dist/schemas/hitl-approval-risk.schema.json +11 -0
  85. package/dist/schemas/hitl-card-outcome-record.schema.json +48 -0
  86. package/dist/schemas/hitl-card-reply-record.schema.json +46 -0
  87. package/dist/schemas/hitl-card-request-record.schema.json +73 -0
  88. package/dist/schemas/hitl-input-answers.schema.json +23 -0
  89. package/dist/schemas/hitl-input-kind.schema.json +10 -0
  90. package/dist/schemas/hitl-input-outcome-record.schema.json +46 -0
  91. package/dist/schemas/hitl-input-question.schema.json +54 -0
  92. package/dist/schemas/hitl-input-reply-record.schema.json +44 -0
  93. package/dist/schemas/hitl-input-request-record.schema.json +134 -0
  94. package/dist/schemas/hitl-pending.schema.json +31 -0
  95. package/dist/schemas/hitl-request-accepted.schema.json +18 -0
  96. package/dist/schemas/hitl-request-kind.schema.json +10 -0
  97. package/dist/schemas/hitl-resolution-status.schema.json +10 -0
  98. package/dist/schemas/hitl-resolution.schema.json +38 -0
  99. package/dist/schemas/hitl-session-rule.schema.json +32 -0
  100. package/dist/schemas/inbound-disposition.schema.json +13 -0
  101. package/dist/schemas/inbound-frame-attachment-v1.schema.json +94 -0
  102. package/dist/schemas/inbound-frame-contact-card-v1.schema.json +59 -0
  103. package/dist/schemas/inbound-frame-group-context-v1.schema.json +96 -0
  104. package/dist/schemas/inbound-frame-reply-context-v1.schema.json +261 -0
  105. package/dist/schemas/inbound-frame-shape-v1.schema.json +12 -0
  106. package/dist/schemas/inbound-frame-v1.schema.json +506 -0
  107. package/dist/schemas/mark-read-response.schema.json +11 -0
  108. package/dist/schemas/media-attachment-kind.schema.json +11 -0
  109. package/dist/schemas/media-attachment.schema.json +42 -0
  110. package/dist/schemas/messages-page-response.schema.json +290 -0
  111. package/dist/schemas/participation-decision-input.schema.json +44 -0
  112. package/dist/schemas/participation-history-message.schema.json +23 -0
  113. package/dist/schemas/participation-history-snapshot.schema.json +37 -0
  114. package/dist/schemas/participation-style.schema.json +13 -0
  115. package/dist/schemas/react-request.schema.json +22 -0
  116. package/dist/schemas/react-response.schema.json +35 -0
  117. package/dist/schemas/resolve-admission-request.schema.json +30 -0
  118. package/dist/schemas/resolve-admission-response.schema.json +129 -0
  119. package/dist/schemas/resolved-agent-behavior-policy-record.schema.json +81 -0
  120. package/dist/schemas/rest-contact.schema.json +40 -0
  121. package/dist/schemas/rest-conversation-last-message.schema.json +77 -0
  122. package/dist/schemas/rest-conversation.schema.json +155 -0
  123. package/dist/schemas/rest-message.schema.json +252 -0
  124. package/dist/schemas/rest-ok-response.schema.json +11 -0
  125. package/dist/schemas/rest-session-selection.schema.json +40 -0
  126. package/dist/schemas/runtime-card-field-choice.schema.json +23 -0
  127. package/dist/schemas/runtime-card-field-type.schema.json +17 -0
  128. package/dist/schemas/runtime-card-field.schema.json +180 -0
  129. package/dist/schemas/runtime-card-line-item-column-type.schema.json +12 -0
  130. package/dist/schemas/runtime-card-line-item-column.schema.json +74 -0
  131. package/dist/schemas/send-contextual-deferred-response.schema.json +39 -0
  132. package/dist/schemas/send-contextual-messaged-response.schema.json +42 -0
  133. package/dist/schemas/send-contextual-request.schema.json +103 -0
  134. package/dist/schemas/send-contextual-response.schema.json +105 -0
  135. package/dist/schemas/send-contextual-self-context.schema.json +19 -0
  136. package/dist/schemas/send-contextual-state-response.schema.json +24 -0
  137. package/dist/schemas/send-message-request.schema.json +106 -0
  138. package/dist/schemas/send-message-response.schema.json +14 -0
  139. package/dist/schemas/sender-type.schema.json +9 -0
  140. package/dist/schemas/serialize-message-input.schema.json +29 -0
  141. package/dist/schemas/serialized-agent-client-type.schema.json +12 -0
  142. package/dist/schemas/serialized-contact-card.schema.json +65 -0
  143. package/dist/schemas/serialized-contact-request-status.schema.json +11 -0
  144. package/dist/schemas/serialized-contact-request.schema.json +157 -0
  145. package/dist/schemas/serialized-content-type.schema.json +13 -0
  146. package/dist/schemas/serialized-message.schema.json +249 -0
  147. package/dist/schemas/serialized-reactions.schema.json +14 -0
  148. package/dist/schemas/serialized-sender-type.schema.json +9 -0
  149. package/dist/schemas/set-streaming-request.schema.json +67 -0
  150. package/dist/schemas/set-typing-request.schema.json +25 -0
  151. package/dist/schemas/sse-access-policy.schema.json +10 -0
  152. package/dist/schemas/sse-agent-context-payload.schema.json +57 -0
  153. package/dist/schemas/sse-connected-payload.schema.json +18 -0
  154. package/dist/schemas/sse-contact-payload.schema.json +40 -0
  155. package/dist/schemas/sse-contact-removed-payload.schema.json +14 -0
  156. package/dist/schemas/sse-contact-request-payload.schema.json +157 -0
  157. package/dist/schemas/sse-conversation-updated-payload.schema.json +48 -0
  158. package/dist/schemas/sse-error-payload.schema.json +23 -0
  159. package/dist/schemas/sse-event-envelope.schema.json +42 -0
  160. package/dist/schemas/sse-event-family.schema.json +12 -0
  161. package/dist/schemas/sse-event-type.schema.json +28 -0
  162. package/dist/schemas/sse-heartbeat-payload.schema.json +14 -0
  163. package/dist/schemas/sse-membership-change.schema.json +28 -0
  164. package/dist/schemas/sse-message-created-payload.schema.json +414 -0
  165. package/dist/schemas/sse-message-deleted-payload.schema.json +18 -0
  166. package/dist/schemas/sse-message-updated-payload.schema.json +46 -0
  167. package/dist/schemas/sse-presence-payload.schema.json +21 -0
  168. package/dist/schemas/sse-provenance.schema.json +64 -0
  169. package/dist/schemas/sse-replay-expired-payload.schema.json +21 -0
  170. package/dist/schemas/sse-runtime-control-kind.schema.json +13 -0
  171. package/dist/schemas/sse-runtime-control-payload.schema.json +44 -0
  172. package/dist/schemas/sse-runtime-updated-payload.schema.json +78 -0
  173. package/dist/schemas/sse-self-context.schema.json +45 -0
  174. package/dist/schemas/sse-turn-dispatch.schema.json +29 -0
  175. package/dist/schemas/sse-turn-updated-payload.schema.json +33 -0
  176. package/dist/schemas/sse-typing-payload.schema.json +32 -0
  177. package/dist/schemas/sse-voice-session-event-payload.schema.json +170 -0
  178. package/dist/schemas/sse-voice-session.schema.json +157 -0
  179. package/dist/schemas/trigger-decision.schema.json +27 -0
  180. package/dist/schemas/turn-lifecycle-state.schema.json +14 -0
  181. package/dist/schemas/turn-message-semantics.schema.json +10 -0
  182. package/dist/schemas/turn-metadata.schema.json +56 -0
  183. package/dist/schemas/turn-state-like.schema.json +39 -0
  184. package/dist/schemas/update-disposition-request.schema.json +22 -0
  185. package/dist/schemas/upload-media-request.schema.json +25 -0
  186. package/dist/schemas/upload-media-response.schema.json +55 -0
  187. package/dist/sendContextual.d.ts +114 -0
  188. package/dist/sendContextual.js +89 -0
  189. package/dist/sseEvents.d.ts +494 -0
  190. package/dist/sseEvents.js +295 -0
  191. package/dist/turnProtocol.d.ts +91 -24
  192. package/dist/turnProtocol.js +40 -0
  193. package/package.json +8 -5
package/dist/schemas/hitl-resolution.schema.json ADDED
@@ -0,0 +1,38 @@
1
+ {
2
+ "$id": "canon:HitlResolutionSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "requestId": {
7
+ "type": "string"
8
+ },
9
+ "kind": {
10
+ "type": "string",
11
+ "enum": [
12
+ "approval",
13
+ "input",
14
+ "card"
15
+ ]
16
+ },
17
+ "status": {
18
+ "type": "string",
19
+ "enum": [
20
+ "submitted",
21
+ "cancelled",
22
+ "timeout"
23
+ ]
24
+ },
25
+ "answer": {
26
+ "type": "object",
27
+ "propertyNames": {
28
+ "type": "string"
29
+ },
30
+ "additionalProperties": {}
31
+ }
32
+ },
33
+ "required": [
34
+ "requestId",
35
+ "status"
36
+ ],
37
+ "additionalProperties": false
38
+ }
package/dist/schemas/hitl-session-rule.schema.json ADDED
@@ -0,0 +1,32 @@
1
+ {
2
+ "$id": "canon:HitlSessionRuleSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "enum": [
9
+ "approve-all",
10
+ "approve-tool",
11
+ "deny-tool"
12
+ ]
13
+ },
14
+ "toolPattern": {
15
+ "type": "string"
16
+ },
17
+ "expiresAt": {
18
+ "anyOf": [
19
+ {
20
+ "type": "string"
21
+ },
22
+ {
23
+ "type": "null"
24
+ }
25
+ ]
26
+ }
27
+ },
28
+ "required": [
29
+ "type"
30
+ ],
31
+ "additionalProperties": false
32
+ }
package/dist/schemas/inbound-disposition.schema.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "$id": "canon:InboundDispositionSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "queued",
7
+ "accepted_now",
8
+ "interleaved",
9
+ "trigger_suppressed",
10
+ "rejected",
11
+ "cancelled"
12
+ ]
13
+ }
package/dist/schemas/inbound-frame-attachment-v1.schema.json ADDED
@@ -0,0 +1,94 @@
1
+ {
2
+ "$id": "canon:InboundFrameAttachmentV1Schema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "index": {
7
+ "type": "number"
8
+ },
9
+ "kind": {
10
+ "type": "string",
11
+ "enum": [
12
+ "image",
13
+ "audio",
14
+ "video",
15
+ "file"
16
+ ]
17
+ },
18
+ "placeholder": {
19
+ "type": "string"
20
+ },
21
+ "fileName": {
22
+ "anyOf": [
23
+ {
24
+ "type": "string"
25
+ },
26
+ {
27
+ "type": "null"
28
+ }
29
+ ]
30
+ },
31
+ "mimeType": {
32
+ "anyOf": [
33
+ {
34
+ "type": "string"
35
+ },
36
+ {
37
+ "type": "null"
38
+ }
39
+ ]
40
+ },
41
+ "sizeBytes": {
42
+ "anyOf": [
43
+ {
44
+ "type": "number"
45
+ },
46
+ {
47
+ "type": "null"
48
+ }
49
+ ]
50
+ },
51
+ "width": {
52
+ "anyOf": [
53
+ {
54
+ "type": "number"
55
+ },
56
+ {
57
+ "type": "null"
58
+ }
59
+ ]
60
+ },
61
+ "height": {
62
+ "anyOf": [
63
+ {
64
+ "type": "number"
65
+ },
66
+ {
67
+ "type": "null"
68
+ }
69
+ ]
70
+ },
71
+ "durationMs": {
72
+ "anyOf": [
73
+ {
74
+ "type": "number"
75
+ },
76
+ {
77
+ "type": "null"
78
+ }
79
+ ]
80
+ }
81
+ },
82
+ "required": [
83
+ "index",
84
+ "kind",
85
+ "placeholder",
86
+ "fileName",
87
+ "mimeType",
88
+ "sizeBytes",
89
+ "width",
90
+ "height",
91
+ "durationMs"
92
+ ],
93
+ "additionalProperties": false
94
+ }
package/dist/schemas/inbound-frame-contact-card-v1.schema.json ADDED
@@ -0,0 +1,59 @@
1
+ {
2
+ "$id": "canon:InboundFrameContactCardV1Schema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "userId": {
7
+ "type": "string"
8
+ },
9
+ "canonContactId": {
10
+ "anyOf": [
11
+ {
12
+ "type": "string"
13
+ },
14
+ {
15
+ "type": "null"
16
+ }
17
+ ]
18
+ },
19
+ "displayName": {
20
+ "type": "string"
21
+ },
22
+ "userType": {
23
+ "type": "string",
24
+ "enum": [
25
+ "human",
26
+ "ai_agent"
27
+ ]
28
+ },
29
+ "ownerName": {
30
+ "anyOf": [
31
+ {
32
+ "type": "string"
33
+ },
34
+ {
35
+ "type": "null"
36
+ }
37
+ ]
38
+ },
39
+ "about": {
40
+ "anyOf": [
41
+ {
42
+ "type": "string"
43
+ },
44
+ {
45
+ "type": "null"
46
+ }
47
+ ]
48
+ }
49
+ },
50
+ "required": [
51
+ "userId",
52
+ "canonContactId",
53
+ "displayName",
54
+ "userType",
55
+ "ownerName",
56
+ "about"
57
+ ],
58
+ "additionalProperties": false
59
+ }
package/dist/schemas/inbound-frame-group-context-v1.schema.json ADDED
@@ -0,0 +1,96 @@
1
+ {
2
+ "$id": "canon:InboundFrameGroupContextV1Schema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "memberCount": {
7
+ "type": "number"
8
+ },
9
+ "memberIds": {
10
+ "type": "array",
11
+ "items": {
12
+ "type": "string"
13
+ }
14
+ },
15
+ "ownerId": {
16
+ "type": "string"
17
+ },
18
+ "ownerName": {
19
+ "type": "string"
20
+ },
21
+ "ownerPresent": {
22
+ "type": "boolean"
23
+ },
24
+ "knownRecentParticipants": {
25
+ "type": "array",
26
+ "items": {
27
+ "type": "object",
28
+ "properties": {
29
+ "id": {
30
+ "type": "string"
31
+ },
32
+ "name": {
33
+ "type": "string"
34
+ },
35
+ "userType": {
36
+ "type": "string",
37
+ "enum": [
38
+ "human",
39
+ "ai_agent",
40
+ "unknown"
41
+ ]
42
+ },
43
+ "isOwner": {
44
+ "type": "boolean"
45
+ },
46
+ "isSelf": {
47
+ "type": "boolean"
48
+ }
49
+ },
50
+ "required": [
51
+ "id",
52
+ "name",
53
+ "userType",
54
+ "isOwner",
55
+ "isSelf"
56
+ ],
57
+ "additionalProperties": false
58
+ }
59
+ },
60
+ "membershipChange": {
61
+ "type": "object",
62
+ "properties": {
63
+ "addedMemberIds": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "string"
67
+ }
68
+ },
69
+ "removedMemberIds": {
70
+ "type": "array",
71
+ "items": {
72
+ "type": "string"
73
+ }
74
+ },
75
+ "memberCount": {
76
+ "type": "number"
77
+ }
78
+ },
79
+ "required": [
80
+ "addedMemberIds",
81
+ "removedMemberIds",
82
+ "memberCount"
83
+ ],
84
+ "additionalProperties": false
85
+ }
86
+ },
87
+ "required": [
88
+ "memberCount",
89
+ "memberIds",
90
+ "ownerId",
91
+ "ownerName",
92
+ "ownerPresent",
93
+ "knownRecentParticipants"
94
+ ],
95
+ "additionalProperties": false
96
+ }
package/dist/schemas/inbound-frame-reply-context-v1.schema.json ADDED
@@ -0,0 +1,261 @@
1
+ {
2
+ "$id": "canon:InboundFrameReplyContextV1Schema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "messageId": {
7
+ "type": "string"
8
+ },
9
+ "found": {
10
+ "type": "boolean"
11
+ },
12
+ "senderId": {
13
+ "anyOf": [
14
+ {
15
+ "type": "string"
16
+ },
17
+ {
18
+ "type": "null"
19
+ }
20
+ ]
21
+ },
22
+ "senderName": {
23
+ "anyOf": [
24
+ {
25
+ "type": "string"
26
+ },
27
+ {
28
+ "type": "null"
29
+ }
30
+ ]
31
+ },
32
+ "senderType": {
33
+ "anyOf": [
34
+ {
35
+ "type": "string",
36
+ "enum": [
37
+ "human",
38
+ "ai_agent"
39
+ ]
40
+ },
41
+ {
42
+ "type": "null"
43
+ }
44
+ ]
45
+ },
46
+ "contentType": {
47
+ "anyOf": [
48
+ {
49
+ "type": "string",
50
+ "enum": [
51
+ "text",
52
+ "image",
53
+ "audio",
54
+ "video",
55
+ "file",
56
+ "contact_card"
57
+ ]
58
+ },
59
+ {
60
+ "type": "null"
61
+ }
62
+ ]
63
+ },
64
+ "text": {
65
+ "anyOf": [
66
+ {
67
+ "type": "string"
68
+ },
69
+ {
70
+ "type": "null"
71
+ }
72
+ ]
73
+ },
74
+ "body": {
75
+ "type": "string"
76
+ },
77
+ "replyToPosition": {
78
+ "anyOf": [
79
+ {
80
+ "type": "number"
81
+ },
82
+ {
83
+ "type": "null"
84
+ }
85
+ ]
86
+ },
87
+ "attachments": {
88
+ "type": "array",
89
+ "items": {
90
+ "type": "object",
91
+ "properties": {
92
+ "index": {
93
+ "type": "number"
94
+ },
95
+ "kind": {
96
+ "type": "string",
97
+ "enum": [
98
+ "image",
99
+ "audio",
100
+ "video",
101
+ "file"
102
+ ]
103
+ },
104
+ "placeholder": {
105
+ "type": "string"
106
+ },
107
+ "fileName": {
108
+ "anyOf": [
109
+ {
110
+ "type": "string"
111
+ },
112
+ {
113
+ "type": "null"
114
+ }
115
+ ]
116
+ },
117
+ "mimeType": {
118
+ "anyOf": [
119
+ {
120
+ "type": "string"
121
+ },
122
+ {
123
+ "type": "null"
124
+ }
125
+ ]
126
+ },
127
+ "sizeBytes": {
128
+ "anyOf": [
129
+ {
130
+ "type": "number"
131
+ },
132
+ {
133
+ "type": "null"
134
+ }
135
+ ]
136
+ },
137
+ "width": {
138
+ "anyOf": [
139
+ {
140
+ "type": "number"
141
+ },
142
+ {
143
+ "type": "null"
144
+ }
145
+ ]
146
+ },
147
+ "height": {
148
+ "anyOf": [
149
+ {
150
+ "type": "number"
151
+ },
152
+ {
153
+ "type": "null"
154
+ }
155
+ ]
156
+ },
157
+ "durationMs": {
158
+ "anyOf": [
159
+ {
160
+ "type": "number"
161
+ },
162
+ {
163
+ "type": "null"
164
+ }
165
+ ]
166
+ }
167
+ },
168
+ "required": [
169
+ "index",
170
+ "kind",
171
+ "placeholder",
172
+ "fileName",
173
+ "mimeType",
174
+ "sizeBytes",
175
+ "width",
176
+ "height",
177
+ "durationMs"
178
+ ],
179
+ "additionalProperties": false
180
+ }
181
+ },
182
+ "contactCard": {
183
+ "anyOf": [
184
+ {
185
+ "type": "object",
186
+ "properties": {
187
+ "userId": {
188
+ "type": "string"
189
+ },
190
+ "canonContactId": {
191
+ "anyOf": [
192
+ {
193
+ "type": "string"
194
+ },
195
+ {
196
+ "type": "null"
197
+ }
198
+ ]
199
+ },
200
+ "displayName": {
201
+ "type": "string"
202
+ },
203
+ "userType": {
204
+ "type": "string",
205
+ "enum": [
206
+ "human",
207
+ "ai_agent"
208
+ ]
209
+ },
210
+ "ownerName": {
211
+ "anyOf": [
212
+ {
213
+ "type": "string"
214
+ },
215
+ {
216
+ "type": "null"
217
+ }
218
+ ]
219
+ },
220
+ "about": {
221
+ "anyOf": [
222
+ {
223
+ "type": "string"
224
+ },
225
+ {
226
+ "type": "null"
227
+ }
228
+ ]
229
+ }
230
+ },
231
+ "required": [
232
+ "userId",
233
+ "canonContactId",
234
+ "displayName",
235
+ "userType",
236
+ "ownerName",
237
+ "about"
238
+ ],
239
+ "additionalProperties": false
240
+ },
241
+ {
242
+ "type": "null"
243
+ }
244
+ ]
245
+ }
246
+ },
247
+ "required": [
248
+ "messageId",
249
+ "found",
250
+ "senderId",
251
+ "senderName",
252
+ "senderType",
253
+ "contentType",
254
+ "text",
255
+ "body",
256
+ "replyToPosition",
257
+ "attachments",
258
+ "contactCard"
259
+ ],
260
+ "additionalProperties": false
261
+ }
package/dist/schemas/inbound-frame-shape-v1.schema.json ADDED
@@ -0,0 +1,12 @@
1
+ {
2
+ "$id": "canon:InboundFrameShapeV1Schema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "direct_owner",
7
+ "direct_human",
8
+ "direct_agent",
9
+ "group",
10
+ "unknown"
11
+ ]
12
+ }