@canonmsg/backend-contracts 1.7.0 → 1.8.0

package/dist/schemas/sse-agent-context-payload.schema.json

@@ -0,0 +1,57 @@
+{
+  "$id": "canon:SseAgentContextPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "agentId": {
+      "type": "string"
+    },
+    "canonContactId": {
+      "type": "string"
+    },
+    "clientType": {
+      "type": "string"
+    },
+    "ownerId": {
+      "type": "string"
+    },
+    "ownerName": {
+      "type": "string"
+    },
+    "defaultBehavior": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "inboundPolicy": {
+      "type": "string",
+      "enum": [
+        "open",
+        "approval-required",
+        "owner-only"
+      ]
+    },
+    "groupJoinPolicy": {
+      "type": "string",
+      "enum": [
+        "open",
+        "approval-required",
+        "owner-only"
+      ]
+    },
+    "discoverable": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "agentId",
+    "ownerId",
+    "ownerName",
+    "inboundPolicy",
+    "groupJoinPolicy",
+    "discoverable"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/sse-connected-payload.schema.json

@@ -0,0 +1,18 @@
+{
+  "$id": "canon:SseConnectedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "connectionId": {
+      "type": "string"
+    },
+    "agentId": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "connectionId",
+    "agentId"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-contact-payload.schema.json

@@ -0,0 +1,40 @@
+{
+  "$id": "canon:SseContactPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "source": {
+      "type": "string"
+    },
+    "addedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "displayNameOverride": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "source",
+    "addedAt",
+    "displayNameOverride"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-contact-removed-payload.schema.json

@@ -0,0 +1,14 @@
+{
+  "$id": "canon:SseContactRemovedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-contact-request-payload.schema.json

@@ -0,0 +1,157 @@
+{
+  "$id": "canon:SseContactRequestPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "requesterId": {
+      "type": "string"
+    },
+    "requesterName": {
+      "type": "string"
+    },
+    "requesterAvatarUrl": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "targetId": {
+      "type": "string"
+    },
+    "targetName": {
+      "type": "string"
+    },
+    "targetAvatarUrl": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "targetUserType": {
+      "type": "string",
+      "enum": [
+        "human",
+        "ai_agent"
+      ]
+    },
+    "targetOwnerId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "approverId": {
+      "type": "string"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "approved",
+        "rejected",
+        "expired"
+      ]
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "dm",
+        "group_invite"
+      ]
+    },
+    "groupContext": {
+      "type": "object",
+      "properties": {
+        "conversationId": {
+          "type": "string"
+        },
+        "groupName": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "conversationId",
+        "groupName"
+      ],
+      "additionalProperties": false
+    },
+    "createdAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "resolvedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "expiresAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "requesterId",
+    "requesterName",
+    "requesterAvatarUrl",
+    "targetId",
+    "targetName",
+    "targetAvatarUrl",
+    "targetUserType",
+    "approverId",
+    "message",
+    "status",
+    "kind",
+    "createdAt"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-conversation-updated-payload.schema.json

@@ -0,0 +1,48 @@
+{
+  "$id": "canon:SseConversationUpdatedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "changes": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "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": [
+    "conversationId",
+    "changes"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-error-payload.schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "canon:SseErrorPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "retryAfterMs": {
+      "type": "number"
+    },
+    "activeConnections": {
+      "type": "number"
+    },
+    "maxConnections": {
+      "type": "number"
+    }
+  },
+  "additionalProperties": {}
+}

package/dist/schemas/sse-event-envelope.schema.json

@@ -0,0 +1,42 @@
+{
+  "$id": "canon:SseEventEnvelopeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "event": {
+      "type": "string",
+      "enum": [
+        "connected",
+        "agent.context",
+        "heartbeat",
+        "message.created",
+        "message.updated",
+        "message.deleted",
+        "conversation.updated",
+        "contact.request",
+        "contact.approved",
+        "contact.added",
+        "contact.updated",
+        "contact.removed",
+        "typing",
+        "presence",
+        "runtime.updated",
+        "turn.updated",
+        "runtime.control",
+        "voice.session.started",
+        "voice.session.ended",
+        "replay.expired",
+        "error"
+      ]
+    },
+    "data": {}
+  },
+  "required": [
+    "event",
+    "data"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-event-family.schema.json

@@ -0,0 +1,12 @@
+{
+  "$id": "canon:SseEventFamilySchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "messages",
+    "contacts",
+    "typing_presence",
+    "runtime_turn",
+    "voice"
+  ]
+}

package/dist/schemas/sse-event-type.schema.json

@@ -0,0 +1,28 @@
+{
+  "$id": "canon:SseEventTypeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "connected",
+    "agent.context",
+    "heartbeat",
+    "message.created",
+    "message.updated",
+    "message.deleted",
+    "conversation.updated",
+    "contact.request",
+    "contact.approved",
+    "contact.added",
+    "contact.updated",
+    "contact.removed",
+    "typing",
+    "presence",
+    "runtime.updated",
+    "turn.updated",
+    "runtime.control",
+    "voice.session.started",
+    "voice.session.ended",
+    "replay.expired",
+    "error"
+  ]
+}

package/dist/schemas/sse-heartbeat-payload.schema.json

@@ -0,0 +1,14 @@
+{
+  "$id": "canon:SseHeartbeatPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "timestamp": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "timestamp"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-membership-change.schema.json

@@ -0,0 +1,28 @@
+{
+  "$id": "canon:SseMembershipChangeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "addedMemberIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "removedMemberIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "memberCount": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "addedMemberIds",
+    "removedMemberIds",
+    "memberCount"
+  ],
+  "additionalProperties": false
+}