@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
@@ -0,0 +1,105 @@
1
+ {
2
+ "$id": "canon:HitlApprovalRequestRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "approval_request"
9
+ },
10
+ "approvalId": {
11
+ "type": "string"
12
+ },
13
+ "responseUserId": {
14
+ "type": "string"
15
+ },
16
+ "toolName": {
17
+ "type": "string"
18
+ },
19
+ "toolSummary": {
20
+ "type": "string"
21
+ },
22
+ "category": {
23
+ "type": "string",
24
+ "enum": [
25
+ "command",
26
+ "file",
27
+ "network",
28
+ "browser",
29
+ "mcp",
30
+ "plugin",
31
+ "canon",
32
+ "tool"
33
+ ]
34
+ },
35
+ "risk": {
36
+ "type": "string",
37
+ "enum": [
38
+ "low",
39
+ "normal",
40
+ "high",
41
+ "destructive"
42
+ ]
43
+ },
44
+ "riskLevel": {
45
+ "type": "string",
46
+ "enum": [
47
+ "normal",
48
+ "destructive"
49
+ ]
50
+ },
51
+ "runtimeId": {
52
+ "type": "string"
53
+ },
54
+ "turnId": {
55
+ "type": "string"
56
+ },
57
+ "native": {
58
+ "type": "object",
59
+ "propertyNames": {
60
+ "type": "string"
61
+ },
62
+ "additionalProperties": {}
63
+ },
64
+ "details": {
65
+ "type": "array",
66
+ "items": {
67
+ "type": "object",
68
+ "properties": {
69
+ "label": {
70
+ "type": "string"
71
+ },
72
+ "value": {
73
+ "type": "string"
74
+ },
75
+ "monospace": {
76
+ "type": "boolean"
77
+ }
78
+ },
79
+ "required": [
80
+ "label",
81
+ "value"
82
+ ],
83
+ "additionalProperties": false
84
+ }
85
+ },
86
+ "diff": {
87
+ "type": "object",
88
+ "propertyNames": {
89
+ "type": "string"
90
+ },
91
+ "additionalProperties": {}
92
+ },
93
+ "expiresAt": {
94
+ "type": "string"
95
+ }
96
+ },
97
+ "required": [
98
+ "type",
99
+ "approvalId",
100
+ "toolName",
101
+ "toolSummary",
102
+ "expiresAt"
103
+ ],
104
+ "additionalProperties": {}
105
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ "$id": "canon:HitlApprovalRiskSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "low",
7
+ "normal",
8
+ "high",
9
+ "destructive"
10
+ ]
11
+ }
@@ -0,0 +1,48 @@
1
+ {
2
+ "$id": "canon:HitlCardOutcomeRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_card_outcome"
9
+ },
10
+ "cardId": {
11
+ "type": "string"
12
+ },
13
+ "status": {
14
+ "type": "string",
15
+ "enum": [
16
+ "submitted",
17
+ "cancelled",
18
+ "timeout"
19
+ ]
20
+ },
21
+ "reason": {
22
+ "type": "string",
23
+ "enum": [
24
+ "submitted",
25
+ "cancelled",
26
+ "timeout",
27
+ "expired",
28
+ "interrupted"
29
+ ]
30
+ },
31
+ "turnSemantics": {
32
+ "type": "string",
33
+ "const": "control"
34
+ },
35
+ "replyBehavior": {
36
+ "type": "string",
37
+ "const": "suppress_auto_reply"
38
+ }
39
+ },
40
+ "required": [
41
+ "type",
42
+ "cardId",
43
+ "status",
44
+ "turnSemantics",
45
+ "replyBehavior"
46
+ ],
47
+ "additionalProperties": {}
48
+ }
@@ -0,0 +1,46 @@
1
+ {
2
+ "$id": "canon:HitlCardReplyRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_card_reply"
9
+ },
10
+ "cardId": {
11
+ "type": "string"
12
+ },
13
+ "status": {
14
+ "type": "string",
15
+ "enum": [
16
+ "submitted",
17
+ "cancelled"
18
+ ]
19
+ },
20
+ "actionId": {
21
+ "type": "string"
22
+ },
23
+ "answerSummary": {
24
+ "type": "string"
25
+ },
26
+ "sensitive": {
27
+ "type": "boolean"
28
+ },
29
+ "turnSemantics": {
30
+ "type": "string",
31
+ "const": "control"
32
+ },
33
+ "replyBehavior": {
34
+ "type": "string",
35
+ "const": "suppress_auto_reply"
36
+ }
37
+ },
38
+ "required": [
39
+ "type",
40
+ "cardId",
41
+ "status",
42
+ "turnSemantics",
43
+ "replyBehavior"
44
+ ],
45
+ "additionalProperties": {}
46
+ }
@@ -0,0 +1,73 @@
1
+ {
2
+ "$id": "canon:HitlCardRequestRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_card_request"
9
+ },
10
+ "cardId": {
11
+ "type": "string"
12
+ },
13
+ "cardKind": {
14
+ "type": "string"
15
+ },
16
+ "schemaVersion": {
17
+ "type": "string",
18
+ "const": "canon.card.v1"
19
+ },
20
+ "fallbackText": {
21
+ "type": "string"
22
+ },
23
+ "responseUserId": {
24
+ "type": "string"
25
+ },
26
+ "expiresAt": {
27
+ "type": "string"
28
+ },
29
+ "runtimeId": {
30
+ "type": "string"
31
+ },
32
+ "turnId": {
33
+ "type": "string"
34
+ },
35
+ "native": {
36
+ "type": "object",
37
+ "propertyNames": {
38
+ "type": "string"
39
+ },
40
+ "additionalProperties": {}
41
+ },
42
+ "interactive": {
43
+ "type": "boolean"
44
+ },
45
+ "cardPreview": {
46
+ "type": "object",
47
+ "propertyNames": {
48
+ "type": "string"
49
+ },
50
+ "additionalProperties": {}
51
+ },
52
+ "turnSemantics": {
53
+ "type": "string",
54
+ "const": "control"
55
+ },
56
+ "replyBehavior": {
57
+ "type": "string",
58
+ "const": "suppress_auto_reply"
59
+ }
60
+ },
61
+ "required": [
62
+ "type",
63
+ "cardId",
64
+ "cardKind",
65
+ "schemaVersion",
66
+ "fallbackText",
67
+ "expiresAt",
68
+ "cardPreview",
69
+ "turnSemantics",
70
+ "replyBehavior"
71
+ ],
72
+ "additionalProperties": {}
73
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "$id": "canon:HitlInputAnswersSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "propertyNames": {
6
+ "type": "string"
7
+ },
8
+ "additionalProperties": {
9
+ "type": "object",
10
+ "properties": {
11
+ "answers": {
12
+ "type": "array",
13
+ "items": {
14
+ "type": "string"
15
+ }
16
+ }
17
+ },
18
+ "required": [
19
+ "answers"
20
+ ],
21
+ "additionalProperties": false
22
+ }
23
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "$id": "canon:HitlInputKindSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "clarify",
7
+ "sudo",
8
+ "secret"
9
+ ]
10
+ }
@@ -0,0 +1,46 @@
1
+ {
2
+ "$id": "canon:HitlInputOutcomeRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_input_outcome"
9
+ },
10
+ "inputId": {
11
+ "type": "string"
12
+ },
13
+ "kind": {
14
+ "type": "string",
15
+ "enum": [
16
+ "clarify",
17
+ "sudo",
18
+ "secret"
19
+ ]
20
+ },
21
+ "status": {
22
+ "type": "string",
23
+ "enum": [
24
+ "submitted",
25
+ "cancelled",
26
+ "timeout"
27
+ ]
28
+ },
29
+ "reason": {
30
+ "type": "string",
31
+ "enum": [
32
+ "submitted",
33
+ "cancelled",
34
+ "timeout",
35
+ "expired",
36
+ "interrupted"
37
+ ]
38
+ }
39
+ },
40
+ "required": [
41
+ "type",
42
+ "inputId",
43
+ "status"
44
+ ],
45
+ "additionalProperties": {}
46
+ }
@@ -0,0 +1,54 @@
1
+ {
2
+ "$id": "canon:HitlInputQuestionSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "id": {
7
+ "type": "string"
8
+ },
9
+ "question": {
10
+ "type": "string"
11
+ },
12
+ "header": {
13
+ "type": "string"
14
+ },
15
+ "choices": {
16
+ "type": "array",
17
+ "items": {
18
+ "type": "object",
19
+ "properties": {
20
+ "label": {
21
+ "type": "string"
22
+ },
23
+ "value": {
24
+ "type": "string"
25
+ },
26
+ "description": {
27
+ "type": "string"
28
+ },
29
+ "preview": {
30
+ "type": "string"
31
+ }
32
+ },
33
+ "required": [
34
+ "label"
35
+ ],
36
+ "additionalProperties": false
37
+ }
38
+ },
39
+ "allowOther": {
40
+ "type": "boolean"
41
+ },
42
+ "isSecret": {
43
+ "type": "boolean"
44
+ },
45
+ "multiSelect": {
46
+ "type": "boolean"
47
+ }
48
+ },
49
+ "required": [
50
+ "id",
51
+ "question"
52
+ ],
53
+ "additionalProperties": false
54
+ }
@@ -0,0 +1,44 @@
1
+ {
2
+ "$id": "canon:HitlInputReplyRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_input_reply"
9
+ },
10
+ "inputId": {
11
+ "type": "string"
12
+ },
13
+ "kind": {
14
+ "type": "string",
15
+ "enum": [
16
+ "clarify",
17
+ "sudo",
18
+ "secret"
19
+ ]
20
+ },
21
+ "status": {
22
+ "type": "string",
23
+ "enum": [
24
+ "submitted",
25
+ "cancelled"
26
+ ]
27
+ },
28
+ "answerSummary": {
29
+ "type": "string"
30
+ },
31
+ "answersSummary": {
32
+ "type": "string"
33
+ },
34
+ "sensitive": {
35
+ "type": "boolean"
36
+ }
37
+ },
38
+ "required": [
39
+ "type",
40
+ "inputId",
41
+ "status"
42
+ ],
43
+ "additionalProperties": {}
44
+ }
@@ -0,0 +1,134 @@
1
+ {
2
+ "$id": "canon:HitlInputRequestRecordSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "type": {
7
+ "type": "string",
8
+ "const": "runtime_input_request"
9
+ },
10
+ "inputId": {
11
+ "type": "string"
12
+ },
13
+ "responseUserId": {
14
+ "type": "string"
15
+ },
16
+ "kind": {
17
+ "type": "string",
18
+ "enum": [
19
+ "clarify",
20
+ "sudo",
21
+ "secret"
22
+ ]
23
+ },
24
+ "prompt": {
25
+ "type": "string"
26
+ },
27
+ "title": {
28
+ "type": "string"
29
+ },
30
+ "choices": {
31
+ "type": "array",
32
+ "items": {
33
+ "type": "object",
34
+ "properties": {
35
+ "label": {
36
+ "type": "string"
37
+ },
38
+ "value": {
39
+ "type": "string"
40
+ },
41
+ "description": {
42
+ "type": "string"
43
+ },
44
+ "preview": {
45
+ "type": "string"
46
+ }
47
+ },
48
+ "required": [
49
+ "label"
50
+ ],
51
+ "additionalProperties": false
52
+ }
53
+ },
54
+ "questions": {
55
+ "type": "array",
56
+ "items": {
57
+ "type": "object",
58
+ "properties": {
59
+ "id": {
60
+ "type": "string"
61
+ },
62
+ "question": {
63
+ "type": "string"
64
+ },
65
+ "header": {
66
+ "type": "string"
67
+ },
68
+ "choices": {
69
+ "type": "array",
70
+ "items": {
71
+ "type": "object",
72
+ "properties": {
73
+ "label": {
74
+ "type": "string"
75
+ },
76
+ "value": {
77
+ "type": "string"
78
+ },
79
+ "description": {
80
+ "type": "string"
81
+ },
82
+ "preview": {
83
+ "type": "string"
84
+ }
85
+ },
86
+ "required": [
87
+ "label"
88
+ ],
89
+ "additionalProperties": false
90
+ }
91
+ },
92
+ "allowOther": {
93
+ "type": "boolean"
94
+ },
95
+ "isSecret": {
96
+ "type": "boolean"
97
+ },
98
+ "multiSelect": {
99
+ "type": "boolean"
100
+ }
101
+ },
102
+ "required": [
103
+ "id",
104
+ "question"
105
+ ],
106
+ "additionalProperties": false
107
+ }
108
+ },
109
+ "secretName": {
110
+ "type": "string"
111
+ },
112
+ "native": {
113
+ "type": "object",
114
+ "propertyNames": {
115
+ "type": "string"
116
+ },
117
+ "additionalProperties": {}
118
+ },
119
+ "expiresAt": {
120
+ "type": "string"
121
+ },
122
+ "sensitive": {
123
+ "type": "boolean"
124
+ }
125
+ },
126
+ "required": [
127
+ "type",
128
+ "inputId",
129
+ "kind",
130
+ "prompt",
131
+ "expiresAt"
132
+ ],
133
+ "additionalProperties": {}
134
+ }
@@ -0,0 +1,31 @@
1
+ {
2
+ "$id": "canon:HitlPendingSchema",
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
+ "conversationId": {
18
+ "type": "string"
19
+ },
20
+ "expiresAt": {
21
+ "type": "string"
22
+ }
23
+ },
24
+ "required": [
25
+ "requestId",
26
+ "kind",
27
+ "conversationId",
28
+ "expiresAt"
29
+ ],
30
+ "additionalProperties": false
31
+ }
@@ -0,0 +1,18 @@
1
+ {
2
+ "$id": "canon:HitlRequestAcceptedSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "object",
5
+ "properties": {
6
+ "requestId": {
7
+ "type": "string"
8
+ },
9
+ "expiresAt": {
10
+ "type": "string"
11
+ }
12
+ },
13
+ "required": [
14
+ "requestId",
15
+ "expiresAt"
16
+ ],
17
+ "additionalProperties": false
18
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "$id": "canon:HitlRequestKindSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "approval",
7
+ "input",
8
+ "card"
9
+ ]
10
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "$id": "canon:HitlResolutionStatusSchema",
3
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4
+ "type": "string",
5
+ "enum": [
6
+ "submitted",
7
+ "cancelled",
8
+ "timeout"
9
+ ]
10
+ }