npm - @canonmsg/backend-contracts - Versions diffs - 1.7.0 → 1.8.0 - Mend

@canonmsg/backend-contracts 1.7.0 → 1.8.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 (192) hide show

package/dist/agentBehaviorPolicy.d.ts +86 -45
package/dist/agentBehaviorPolicy.js +53 -0
package/dist/bridgeLocal.d.ts +1729 -0
package/dist/bridgeLocal.js +673 -0
package/dist/cjs/agentBehaviorPolicy.js +54 -1
package/dist/cjs/bridgeLocal.js +676 -0
package/dist/cjs/contactRequest.js +30 -0
package/dist/cjs/controlSignals.js +44 -0
package/dist/cjs/endpointRegistry.js +264 -0
package/dist/cjs/hitl.js +171 -0
package/dist/cjs/inboundFrame.js +92 -0
package/dist/cjs/index.js +8 -0
package/dist/cjs/media.js +13 -0
package/dist/cjs/message.js +64 -0
package/dist/cjs/restEndpoints.js +220 -0
package/dist/cjs/runtimeCardFields.js +58 -1
package/dist/cjs/sendContextual.js +92 -0
package/dist/cjs/sseEvents.js +298 -0
package/dist/cjs/turnProtocol.js +41 -2
package/dist/contactRequest.d.ts +42 -23
package/dist/contactRequest.js +29 -0
package/dist/controlSignals.d.ts +55 -0
package/dist/controlSignals.js +41 -0
package/dist/endpointRegistry.d.ts +13 -0
package/dist/endpointRegistry.js +261 -0
package/dist/hitl.d.ts +303 -0
package/dist/hitl.js +168 -0
package/dist/inboundFrame.d.ts +229 -0
package/dist/inboundFrame.js +89 -0
package/dist/index.d.ts +8 -0
package/dist/index.js +8 -0
package/dist/media.d.ts +24 -11
package/dist/media.js +12 -0
package/dist/message.d.ts +133 -50
package/dist/message.js +64 -1
package/dist/restEndpoints.d.ts +496 -0
package/dist/restEndpoints.js +217 -0
package/dist/runtimeCardFields.d.ts +112 -39
package/dist/runtimeCardFields.js +57 -0
package/dist/schemas/agent-behavior-settings-record.schema.json +48 -0
package/dist/schemas/bridge-connection-state-notification.schema.json +19 -0
package/dist/schemas/bridge-get-attachment-params.schema.json +24 -0
package/dist/schemas/bridge-get-attachment-result.schema.json +20 -0
package/dist/schemas/bridge-hello-params.schema.json +42 -0
package/dist/schemas/bridge-hello-result.schema.json +105 -0
package/dist/schemas/bridge-hitl-state.schema.json +38 -0
package/dist/schemas/bridge-ok-result.schema.json +15 -0
package/dist/schemas/bridge-ready-notification.schema.json +79 -0
package/dist/schemas/bridge-resync-reason.schema.json +9 -0
package/dist/schemas/bridge-resync.schema.json +18 -0
package/dist/schemas/bridge-rpc-error.schema.json +19 -0
package/dist/schemas/bridge-rpc-id.schema.json +12 -0
package/dist/schemas/bridge-rpc-notification.schema.json +20 -0
package/dist/schemas/bridge-rpc-request.schema.json +31 -0
package/dist/schemas/bridge-rpc-response.schema.json +81 -0
package/dist/schemas/bridge-status-result.schema.json +76 -0
package/dist/schemas/bridge-upload-media-params.schema.json +28 -0
package/dist/schemas/bridge-upstream-state.schema.json +10 -0
package/dist/schemas/contacts-response.schema.json +52 -0
package/dist/schemas/control-channel-key.schema.json +10 -0
package/dist/schemas/control-primitive-event.schema.json +30 -0
package/dist/schemas/control-primitive-map.schema.json +15 -0
package/dist/schemas/control-session-event.schema.json +26 -0
package/dist/schemas/control-session-node.schema.json +11 -0
package/dist/schemas/control-signal-event.schema.json +35 -0
package/dist/schemas/control-signal-node.schema.json +22 -0
package/dist/schemas/control-signal-type.schema.json +10 -0
package/dist/schemas/conversations-response.schema.json +127 -0
package/dist/schemas/create-contact-request-request.schema.json +17 -0
package/dist/schemas/create-contact-request-response.schema.json +51 -0
package/dist/schemas/create-conversation-request.schema.json +82 -0
package/dist/schemas/create-conversation-response.schema.json +29 -0
package/dist/schemas/delete-message-response.schema.json +11 -0
package/dist/schemas/delivery-intent.schema.json +11 -0
package/dist/schemas/forward-message-request.schema.json +25 -0
package/dist/schemas/forward-message-response.schema.json +35 -0
package/dist/schemas/forwarded-from.schema.json +18 -0
package/dist/schemas/get-messages-query.schema.json +17 -0
package/dist/schemas/hitl-approval-category.schema.json +15 -0
package/dist/schemas/hitl-approval-detail.schema.json +21 -0
package/dist/schemas/hitl-approval-outcome-record.schema.json +33 -0
package/dist/schemas/hitl-approval-reply-record.schema.json +57 -0
package/dist/schemas/hitl-approval-request-record.schema.json +105 -0
package/dist/schemas/hitl-approval-risk.schema.json +11 -0
package/dist/schemas/hitl-card-outcome-record.schema.json +48 -0
package/dist/schemas/hitl-card-reply-record.schema.json +46 -0
package/dist/schemas/hitl-card-request-record.schema.json +73 -0
package/dist/schemas/hitl-input-answers.schema.json +23 -0
package/dist/schemas/hitl-input-kind.schema.json +10 -0
package/dist/schemas/hitl-input-outcome-record.schema.json +46 -0
package/dist/schemas/hitl-input-question.schema.json +54 -0
package/dist/schemas/hitl-input-reply-record.schema.json +44 -0
package/dist/schemas/hitl-input-request-record.schema.json +134 -0
package/dist/schemas/hitl-pending.schema.json +31 -0
package/dist/schemas/hitl-request-accepted.schema.json +18 -0
package/dist/schemas/hitl-request-kind.schema.json +10 -0
package/dist/schemas/hitl-resolution-status.schema.json +10 -0
package/dist/schemas/hitl-resolution.schema.json +38 -0
package/dist/schemas/hitl-session-rule.schema.json +32 -0
package/dist/schemas/inbound-disposition.schema.json +13 -0
package/dist/schemas/inbound-frame-attachment-v1.schema.json +94 -0
package/dist/schemas/inbound-frame-contact-card-v1.schema.json +59 -0
package/dist/schemas/inbound-frame-group-context-v1.schema.json +96 -0
package/dist/schemas/inbound-frame-reply-context-v1.schema.json +261 -0
package/dist/schemas/inbound-frame-shape-v1.schema.json +12 -0
package/dist/schemas/inbound-frame-v1.schema.json +506 -0
package/dist/schemas/mark-read-response.schema.json +11 -0
package/dist/schemas/media-attachment-kind.schema.json +11 -0
package/dist/schemas/media-attachment.schema.json +42 -0
package/dist/schemas/messages-page-response.schema.json +290 -0
package/dist/schemas/participation-decision-input.schema.json +44 -0
package/dist/schemas/participation-history-message.schema.json +23 -0
package/dist/schemas/participation-history-snapshot.schema.json +37 -0
package/dist/schemas/participation-style.schema.json +13 -0
package/dist/schemas/react-request.schema.json +22 -0
package/dist/schemas/react-response.schema.json +35 -0
package/dist/schemas/resolve-admission-request.schema.json +30 -0
package/dist/schemas/resolve-admission-response.schema.json +129 -0
package/dist/schemas/resolved-agent-behavior-policy-record.schema.json +81 -0
package/dist/schemas/rest-contact.schema.json +40 -0
package/dist/schemas/rest-conversation.schema.json +115 -0
package/dist/schemas/rest-message.schema.json +252 -0
package/dist/schemas/rest-ok-response.schema.json +11 -0
package/dist/schemas/rest-session-selection.schema.json +40 -0
package/dist/schemas/runtime-card-field-choice.schema.json +23 -0
package/dist/schemas/runtime-card-field-type.schema.json +17 -0
package/dist/schemas/runtime-card-field.schema.json +180 -0
package/dist/schemas/runtime-card-line-item-column-type.schema.json +12 -0
package/dist/schemas/runtime-card-line-item-column.schema.json +74 -0
package/dist/schemas/send-contextual-deferred-response.schema.json +39 -0
package/dist/schemas/send-contextual-messaged-response.schema.json +42 -0
package/dist/schemas/send-contextual-request.schema.json +103 -0
package/dist/schemas/send-contextual-response.schema.json +105 -0
package/dist/schemas/send-contextual-self-context.schema.json +19 -0
package/dist/schemas/send-contextual-state-response.schema.json +24 -0
package/dist/schemas/send-message-request.schema.json +106 -0
package/dist/schemas/send-message-response.schema.json +14 -0
package/dist/schemas/sender-type.schema.json +9 -0
package/dist/schemas/serialize-message-input.schema.json +29 -0
package/dist/schemas/serialized-agent-client-type.schema.json +12 -0
package/dist/schemas/serialized-contact-card.schema.json +65 -0
package/dist/schemas/serialized-contact-request-status.schema.json +11 -0
package/dist/schemas/serialized-contact-request.schema.json +157 -0
package/dist/schemas/serialized-content-type.schema.json +13 -0
package/dist/schemas/serialized-message.schema.json +249 -0
package/dist/schemas/serialized-reactions.schema.json +14 -0
package/dist/schemas/serialized-sender-type.schema.json +9 -0
package/dist/schemas/set-streaming-request.schema.json +67 -0
package/dist/schemas/set-typing-request.schema.json +25 -0
package/dist/schemas/sse-access-policy.schema.json +10 -0
package/dist/schemas/sse-agent-context-payload.schema.json +57 -0
package/dist/schemas/sse-connected-payload.schema.json +18 -0
package/dist/schemas/sse-contact-payload.schema.json +40 -0
package/dist/schemas/sse-contact-removed-payload.schema.json +14 -0
package/dist/schemas/sse-contact-request-payload.schema.json +157 -0
package/dist/schemas/sse-conversation-updated-payload.schema.json +48 -0
package/dist/schemas/sse-error-payload.schema.json +23 -0
package/dist/schemas/sse-event-envelope.schema.json +42 -0
package/dist/schemas/sse-event-family.schema.json +12 -0
package/dist/schemas/sse-event-type.schema.json +28 -0
package/dist/schemas/sse-heartbeat-payload.schema.json +14 -0
package/dist/schemas/sse-membership-change.schema.json +28 -0
package/dist/schemas/sse-message-created-payload.schema.json +414 -0
package/dist/schemas/sse-message-deleted-payload.schema.json +18 -0
package/dist/schemas/sse-message-updated-payload.schema.json +46 -0
package/dist/schemas/sse-presence-payload.schema.json +21 -0
package/dist/schemas/sse-provenance.schema.json +64 -0
package/dist/schemas/sse-replay-expired-payload.schema.json +21 -0
package/dist/schemas/sse-runtime-control-kind.schema.json +13 -0
package/dist/schemas/sse-runtime-control-payload.schema.json +44 -0
package/dist/schemas/sse-runtime-updated-payload.schema.json +78 -0
package/dist/schemas/sse-self-context.schema.json +45 -0
package/dist/schemas/sse-turn-dispatch.schema.json +29 -0
package/dist/schemas/sse-turn-updated-payload.schema.json +33 -0
package/dist/schemas/sse-typing-payload.schema.json +32 -0
package/dist/schemas/sse-voice-session-event-payload.schema.json +170 -0
package/dist/schemas/sse-voice-session.schema.json +157 -0
package/dist/schemas/trigger-decision.schema.json +27 -0
package/dist/schemas/turn-lifecycle-state.schema.json +14 -0
package/dist/schemas/turn-message-semantics.schema.json +10 -0
package/dist/schemas/turn-metadata.schema.json +56 -0
package/dist/schemas/turn-state-like.schema.json +39 -0
package/dist/schemas/update-disposition-request.schema.json +22 -0
package/dist/schemas/upload-media-request.schema.json +25 -0
package/dist/schemas/upload-media-response.schema.json +55 -0
package/dist/sendContextual.d.ts +114 -0
package/dist/sendContextual.js +89 -0
package/dist/sseEvents.d.ts +494 -0
package/dist/sseEvents.js +295 -0
package/dist/turnProtocol.d.ts +91 -24
package/dist/turnProtocol.js +40 -1
package/package.json +8 -5

package/dist/schemas/inbound-frame-v1.schema.json ADDED Viewed

@@ -0,0 +1,506 @@
+{
+  "$id": "canon:InboundFrameV1Schema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "type": "string",
+      "const": "canon.inbound_frame.v1"
+    },
+    "shape": {
+      "type": "string",
+      "enum": [
+        "direct_owner",
+        "direct_human",
+        "direct_agent",
+        "group",
+        "unknown"
+      ]
+    },
+    "sender": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "human",
+            "ai_agent"
+          ]
+        },
+        "isOwner": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "isOwner"
+      ],
+      "additionalProperties": false
+    },
+    "conversation": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "direct",
+            "group",
+            "unknown"
+          ]
+        },
+        "memberCount": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "type",
+        "memberCount"
+      ],
+      "additionalProperties": false
+    },
+    "addressed": {
+      "type": "boolean"
+    },
+    "message": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "contentType": {
+          "anyOf": [
+            {
+              "type": "string",
+              "enum": [
+                "text",
+                "image",
+                "audio",
+                "video",
+                "file",
+                "contact_card"
+              ]
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "text",
+        "contentType"
+      ],
+      "additionalProperties": false
+    },
+    "replyContext": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "messageId": {
+              "type": "string"
+            },
+            "found": {
+              "type": "boolean"
+            },
+            "senderId": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "senderName": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "senderType": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "enum": [
+                    "human",
+                    "ai_agent"
+                  ]
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "contentType": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "enum": [
+                    "text",
+                    "image",
+                    "audio",
+                    "video",
+                    "file",
+                    "contact_card"
+                  ]
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "text": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "body": {
+              "type": "string"
+            },
+            "replyToPosition": {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "attachments": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "index": {
+                    "type": "number"
+                  },
+                  "kind": {
+                    "type": "string",
+                    "enum": [
+                      "image",
+                      "audio",
+                      "video",
+                      "file"
+                    ]
+                  },
+                  "placeholder": {
+                    "type": "string"
+                  },
+                  "fileName": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "mimeType": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "sizeBytes": {
+                    "anyOf": [
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "width": {
+                    "anyOf": [
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "height": {
+                    "anyOf": [
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "durationMs": {
+                    "anyOf": [
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "required": [
+                  "index",
+                  "kind",
+                  "placeholder",
+                  "fileName",
+                  "mimeType",
+                  "sizeBytes",
+                  "width",
+                  "height",
+                  "durationMs"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "contactCard": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "userId": {
+                      "type": "string"
+                    },
+                    "canonContactId": {
+                      "anyOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    },
+                    "displayName": {
+                      "type": "string"
+                    },
+                    "userType": {
+                      "type": "string",
+                      "enum": [
+                        "human",
+                        "ai_agent"
+                      ]
+                    },
+                    "ownerName": {
+                      "anyOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    },
+                    "about": {
+                      "anyOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    }
+                  },
+                  "required": [
+                    "userId",
+                    "canonContactId",
+                    "displayName",
+                    "userType",
+                    "ownerName",
+                    "about"
+                  ],
+                  "additionalProperties": false
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          },
+          "required": [
+            "messageId",
+            "found",
+            "senderId",
+            "senderName",
+            "senderType",
+            "contentType",
+            "text",
+            "body",
+            "replyToPosition",
+            "attachments",
+            "contactCard"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "groupContext": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "memberCount": {
+              "type": "number"
+            },
+            "memberIds": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "ownerId": {
+              "type": "string"
+            },
+            "ownerName": {
+              "type": "string"
+            },
+            "ownerPresent": {
+              "type": "boolean"
+            },
+            "knownRecentParticipants": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "userType": {
+                    "type": "string",
+                    "enum": [
+                      "human",
+                      "ai_agent",
+                      "unknown"
+                    ]
+                  },
+                  "isOwner": {
+                    "type": "boolean"
+                  },
+                  "isSelf": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "id",
+                  "name",
+                  "userType",
+                  "isOwner",
+                  "isSelf"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "membershipChange": {
+              "type": "object",
+              "properties": {
+                "addedMemberIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "removedMemberIds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "memberCount": {
+                  "type": "number"
+                }
+              },
+              "required": [
+                "addedMemberIds",
+                "removedMemberIds",
+                "memberCount"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "memberCount",
+            "memberIds",
+            "ownerId",
+            "ownerName",
+            "ownerPresent",
+            "knownRecentParticipants"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "groupContextMode": {
+      "type": "string",
+      "enum": [
+        "initial",
+        "membership_change"
+      ]
+    },
+    "selfContexts": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "behaviorInstructions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "schema",
+    "shape",
+    "sender",
+    "conversation",
+    "addressed",
+    "message",
+    "replyContext",
+    "groupContext",
+    "selfContexts",
+    "behaviorInstructions"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/mark-read-response.schema.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "$id": "canon:MarkReadResponseSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "success": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": {}
+}

package/dist/schemas/media-attachment-kind.schema.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "$id": "canon:MediaAttachmentKindSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "image",
+    "audio",
+    "video",
+    "file"
+  ]
+}

package/dist/schemas/media-attachment.schema.json ADDED Viewed

@@ -0,0 +1,42 @@
+{
+  "$id": "canon:MediaAttachmentSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "kind": {
+      "type": "string",
+      "enum": [
+        "image",
+        "audio",
+        "video",
+        "file"
+      ]
+    },
+    "url": {
+      "type": "string"
+    },
+    "mimeType": {
+      "type": "string"
+    },
+    "fileName": {
+      "type": "string"
+    },
+    "sizeBytes": {
+      "type": "number"
+    },
+    "width": {
+      "type": "number"
+    },
+    "height": {
+      "type": "number"
+    },
+    "durationMs": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "kind",
+    "url"
+  ],
+  "additionalProperties": false
+}