@canonmsg/backend-contracts 1.7.0 → 1.8.0

package/dist/schemas/sse-message-created-payload.schema.json

@@ -0,0 +1,414 @@
+{
+  "$id": "canon:SseMessageCreatedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "behavior": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "activeSelfContextId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "selfContexts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string",
+            "const": "cross_session"
+          },
+          "context": {
+            "type": "string"
+          },
+          "createdAt": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "updatedAt": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "type",
+          "context",
+          "createdAt",
+          "updatedAt"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "provenance": {
+      "type": "object",
+      "properties": {
+        "conversation": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "direct",
+                "group",
+                "unknown"
+              ]
+            }
+          },
+          "required": [
+            "id",
+            "type"
+          ],
+          "additionalProperties": {}
+        },
+        "sender": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "human",
+                "ai_agent"
+              ]
+            },
+            "isOwner": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "id",
+            "type",
+            "isOwner"
+          ],
+          "additionalProperties": {}
+        },
+        "mentionedAgent": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "conversation",
+        "sender",
+        "mentionedAgent"
+      ],
+      "additionalProperties": {}
+    },
+    "turnDispatch": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "run_turn",
+            "observe_only"
+          ]
+        },
+        "reason": {
+          "type": "string"
+        },
+        "addressed": {
+          "type": "boolean"
+        },
+        "policyVersion": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "kind",
+        "reason",
+        "addressed"
+      ],
+      "additionalProperties": {}
+    },
+    "message": {
+      "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
+    }
+  },
+  "required": [
+    "conversationId",
+    "message"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/sse-message-deleted-payload.schema.json

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

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

@@ -0,0 +1,46 @@
+{
+  "$id": "canon:SseMessageUpdatedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "messageId": {
+      "type": "string"
+    },
+    "actorId": {
+      "type": "string"
+    },
+    "updatedAt": {
+      "type": "string"
+    },
+    "changes": {
+      "type": "object",
+      "properties": {
+        "reactions": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "required": [
+        "reactions"
+      ],
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "conversationId",
+    "messageId",
+    "changes"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,21 @@
+{
+  "$id": "canon:SsePresencePayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "userId": {
+      "type": "string"
+    },
+    "online": {
+      "type": "boolean"
+    },
+    "lastSeen": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "userId",
+    "online"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-provenance.schema.json

@@ -0,0 +1,64 @@
+{
+  "$id": "canon:SseProvenanceSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "direct",
+            "group",
+            "unknown"
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "type"
+      ],
+      "additionalProperties": {}
+    },
+    "sender": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "human",
+            "ai_agent"
+          ]
+        },
+        "isOwner": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "isOwner"
+      ],
+      "additionalProperties": {}
+    },
+    "mentionedAgent": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "conversation",
+    "sender",
+    "mentionedAgent"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/sse-replay-expired-payload.schema.json

@@ -0,0 +1,21 @@
+{
+  "$id": "canon:SseReplayExpiredPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "lastAvailableId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "message": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": {}
+}

package/dist/schemas/sse-runtime-control-kind.schema.json

@@ -0,0 +1,13 @@
+{
+  "$id": "canon:SseRuntimeControlKindSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "session",
+    "signal",
+    "primitive",
+    "runtimeInput",
+    "runtimeCard",
+    "runtimeApproval"
+  ]
+}

package/dist/schemas/sse-runtime-control-payload.schema.json

@@ -0,0 +1,44 @@
+{
+  "$id": "canon:SseRuntimeControlPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "agentId": {
+      "type": "string"
+    },
+    "kind": {
+      "type": "string",
+      "enum": [
+        "session",
+        "signal",
+        "primitive",
+        "runtimeInput",
+        "runtimeCard",
+        "runtimeApproval"
+      ]
+    },
+    "requestId": {
+      "type": "string"
+    },
+    "updatedAt": {
+      "type": "number"
+    },
+    "value": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "conversationId",
+    "agentId",
+    "kind",
+    "value"
+  ],
+  "additionalProperties": false
+}