@canonmsg/backend-contracts 1.7.1 → 1.8.0

package/dist/schemas/send-message-response.schema.json

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

package/dist/schemas/sender-type.schema.json

@@ -0,0 +1,9 @@
+{
+  "$id": "canon:SenderTypeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "human",
+    "ai_agent"
+  ]
+}

package/dist/schemas/serialize-message-input.schema.json

@@ -0,0 +1,29 @@
+{
+  "$id": "canon:SerializeMessageInputSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "data": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "senderName": {
+      "type": "string"
+    },
+    "isOwner": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "id",
+    "data",
+    "isOwner"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/serialized-agent-client-type.schema.json

@@ -0,0 +1,12 @@
+{
+  "$id": "canon:SerializedAgentClientTypeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "claude-code",
+    "openclaw",
+    "codex",
+    "hermes",
+    "generic"
+  ]
+}

package/dist/schemas/serialized-contact-card.schema.json

@@ -0,0 +1,65 @@
+{
+  "$id": "canon:SerializedContactCardSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string"
+    },
+    "canonContactId": {
+      "type": "string"
+    },
+    "displayName": {
+      "type": "string"
+    },
+    "avatarUrl": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "userType": {
+      "type": "string",
+      "enum": [
+        "human",
+        "ai_agent"
+      ]
+    },
+    "clientType": {
+      "type": "string",
+      "enum": [
+        "claude-code",
+        "openclaw",
+        "codex",
+        "hermes",
+        "generic"
+      ]
+    },
+    "about": {
+      "type": "string"
+    },
+    "isActive": {
+      "type": "boolean"
+    },
+    "ownerId": {
+      "type": "string"
+    },
+    "ownerName": {
+      "type": "string"
+    },
+    "lifecycleState": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "userId",
+    "displayName",
+    "avatarUrl",
+    "userType"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/serialized-contact-request-status.schema.json

@@ -0,0 +1,11 @@
+{
+  "$id": "canon:SerializedContactRequestStatusSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "pending",
+    "approved",
+    "rejected",
+    "expired"
+  ]
+}

package/dist/schemas/serialized-contact-request.schema.json

@@ -0,0 +1,157 @@
+{
+  "$id": "canon:SerializedContactRequestSchema",
+  "$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/serialized-content-type.schema.json

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

package/dist/schemas/serialized-message.schema.json

@@ -0,0 +1,249 @@
+{
+  "$id": "canon:SerializedMessageSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "senderId": {
+      "type": "string"
+    },
+    "senderName": {
+      "type": "string"
+    },
+    "senderType": {
+      "type": "string",
+      "enum": [
+        "human",
+        "ai_agent"
+      ]
+    },
+    "isOwner": {
+      "type": "boolean"
+    },
+    "contentType": {
+      "type": "string",
+      "enum": [
+        "text",
+        "image",
+        "audio",
+        "video",
+        "file",
+        "contact_card"
+      ]
+    },
+    "text": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "attachments": {
+      "type": "array",
+      "items": {
+        "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
+      }
+    },
+    "mentions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "replyTo": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "replyToPosition": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "forwarded": {
+      "type": "boolean"
+    },
+    "forwardedFrom": {
+      "type": "object",
+      "properties": {
+        "sourceConversationId": {
+          "type": "string"
+        },
+        "messageId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "sourceConversationId",
+        "messageId"
+      ],
+      "additionalProperties": false
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "sent",
+        "read"
+      ]
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "metadata": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "contactCard": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        },
+        "canonContactId": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "avatarUrl": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "userType": {
+          "type": "string",
+          "enum": [
+            "human",
+            "ai_agent"
+          ]
+        },
+        "clientType": {
+          "type": "string",
+          "enum": [
+            "claude-code",
+            "openclaw",
+            "codex",
+            "hermes",
+            "generic"
+          ]
+        },
+        "about": {
+          "type": "string"
+        },
+        "isActive": {
+          "type": "boolean"
+        },
+        "ownerId": {
+          "type": "string"
+        },
+        "ownerName": {
+          "type": "string"
+        },
+        "lifecycleState": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "userId",
+        "displayName",
+        "avatarUrl",
+        "userType"
+      ],
+      "additionalProperties": false
+    },
+    "runtimeCard": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "reactions": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "required": [
+    "id",
+    "senderId",
+    "senderType",
+    "isOwner",
+    "contentType",
+    "text",
+    "attachments",
+    "mentions",
+    "replyTo",
+    "replyToPosition",
+    "status",
+    "createdAt"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/serialized-reactions.schema.json

@@ -0,0 +1,14 @@
+{
+  "$id": "canon:SerializedReactionsSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "propertyNames": {
+    "type": "string"
+  },
+  "additionalProperties": {
+    "type": "array",
+    "items": {
+      "type": "string"
+    }
+  }
+}

package/dist/schemas/serialized-sender-type.schema.json

@@ -0,0 +1,9 @@
+{
+  "$id": "canon:SerializedSenderTypeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "human",
+    "ai_agent"
+  ]
+}

package/dist/schemas/set-streaming-request.schema.json

@@ -0,0 +1,67 @@
+{
+  "$id": "canon:SetStreamingRequestSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "anyOf": [
+    {
+      "type": "object",
+      "properties": {
+        "conversationId": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string"
+        },
+        "messageId": {
+          "type": "string"
+        },
+        "turnId": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "blocks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {}
+          }
+        }
+      },
+      "required": [
+        "conversationId",
+        "text",
+        "status",
+        "messageId"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "conversationId": {
+          "type": "string"
+        },
+        "streaming": {
+          "type": "boolean",
+          "const": false
+        }
+      },
+      "required": [
+        "conversationId",
+        "streaming"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/dist/schemas/set-typing-request.schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "canon:SetTypingRequestSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "typing": {
+      "type": "boolean"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "thinking",
+        "typing"
+      ]
+    }
+  },
+  "required": [
+    "conversationId",
+    "typing"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-access-policy.schema.json

@@ -0,0 +1,10 @@
+{
+  "$id": "canon:SseAccessPolicySchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "open",
+    "approval-required",
+    "owner-only"
+  ]
+}