@ixo/topic-protocol 1.0.0-rc.4 → 1.0.0-rc.6

package/dist/schemas/v2/capsule.schema.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/capsule.schema.json",
+    "title": "Topic capsule (Protocol 2.0)",
+    "description": "The bounded context handed to an agent: the current projection, the most recent thread messages, and one plain-language hint about what would move the Topic forward.",
+    "type": "object",
+    "required": ["version", "topic", "messages", "hint"],
+    "properties": {
+        "version": { "const": 2 },
+        "topic": { "$ref": "projection.schema.json" },
+        "messages": {
+            "type": "array",
+            "maxItems": 50,
+            "items": {
+                "type": "object",
+                "required": ["eventId", "sender", "body", "at"],
+                "properties": {
+                    "eventId": { "$ref": "common.schema.json#/$defs/eventId" },
+                    "sender": { "$ref": "common.schema.json#/$defs/actor" },
+                    "body": { "type": "string" },
+                    "at": { "$ref": "common.schema.json#/$defs/dateTime" }
+                },
+                "additionalProperties": false
+            }
+        },
+        "hint": { "type": "string", "minLength": 1 }
+    },
+    "additionalProperties": false
+}

package/dist/schemas/v2/common.schema.json

@@ -0,0 +1,68 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/common.schema.json",
+    "title": "Topic Protocol 2.0 shared definitions",
+    "$defs": {
+        "topicId": { "type": "string", "pattern": "^ixo:topic:[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
+        "eventId": { "type": "string", "minLength": 1 },
+        "actor": { "type": "string", "minLength": 1 },
+        "dateTime": { "type": "string", "format": "date-time" },
+        "text": { "type": "string", "minLength": 1, "maxLength": 2000 },
+        "title": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "kind": {
+            "type": "string",
+            "oneOf": [
+                { "enum": ["discussion", "question", "task", "project"] },
+                { "pattern": "^(?!ixo\\.)[a-z][a-z0-9-]*(\\.[a-z][a-z0-9-]*)+$" }
+            ]
+        },
+        "baseKind": { "type": "string", "enum": ["discussion", "question", "task", "project"] },
+        "status": { "type": "string", "enum": ["open", "active", "waiting", "done", "dropped"] },
+        "recordType": { "type": "string", "enum": ["decision", "outcome", "artifact", "receipt"] },
+        "relation": { "type": "string", "enum": ["branches_from", "merged_into", "redirects_to", "references"] },
+        "ref": {
+            "type": "object",
+            "required": ["type", "id"],
+            "properties": {
+                "type": { "type": "string", "pattern": "^[a-z][a-z0-9-]*(\\.[a-z][a-z0-9-]*)+$" },
+                "id": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": false
+        },
+        "file": {
+            "type": "object",
+            "required": ["provider", "resource", "fileId", "version", "cid", "name"],
+            "properties": {
+                "provider": { "const": "ixo.vfs" },
+                "resource": { "type": "string", "minLength": 1 },
+                "fileId": { "type": "string", "minLength": 1 },
+                "version": { "type": "integer", "minimum": 1 },
+                "cid": { "type": "string", "minLength": 1 },
+                "name": { "type": "string", "minLength": 1 },
+                "mimeType": { "type": "string", "minLength": 1 },
+                "size": { "type": "integer", "minimum": 0 }
+            },
+            "additionalProperties": false
+        },
+        "block": {
+            "type": "object",
+            "required": ["reason", "by", "since"],
+            "properties": {
+                "reason": { "$ref": "#/$defs/text" },
+                "on": { "type": "string", "minLength": 1 },
+                "by": { "$ref": "#/$defs/actor" },
+                "since": { "$ref": "#/$defs/dateTime" }
+            },
+            "additionalProperties": false
+        },
+        "anchor": {
+            "type": "object",
+            "required": ["roomId", "rootEventId"],
+            "properties": {
+                "roomId": { "type": "string", "pattern": "^!.+" },
+                "rootEventId": { "type": "string", "pattern": "^\\$.+" }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/dist/schemas/v2/operation.schema.json

@@ -0,0 +1,308 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/operation.schema.json",
+    "title": "Topic operation (Protocol 2.0)",
+    "description": "An append-only change to a Topic. Operations carry no revision pointer; the projector orders them by createdAt then id and applies last-writer-wins per field.",
+    "type": "object",
+    "required": [
+        "version",
+        "id",
+        "topicId",
+        "type",
+        "actor",
+        "createdAt"
+    ],
+    "properties": {
+        "version": {
+            "const": 2
+        },
+        "id": {
+            "type": "string",
+            "pattern": "^ixo:topic-op:[A-Za-z0-9._-]{8,128}$",
+            "description": "Writers SHOULD use a UUIDv7 suffix."
+        },
+        "topicId": {
+            "$ref": "common.schema.json#/$defs/topicId"
+        },
+        "type": {
+            "type": "string",
+            "enum": [
+                "update",
+                "set-status",
+                "block",
+                "unblock",
+                "link",
+                "unlink",
+                "attach",
+                "detach",
+                "relate",
+                "unrelate",
+                "bind-flow",
+                "unbind-flow"
+            ]
+        },
+        "actor": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "createdAt": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "fields": {
+            "type": "object",
+            "minProperties": 1,
+            "properties": {
+                "title": {
+                    "$ref": "common.schema.json#/$defs/title"
+                },
+                "owner": {
+                    "oneOf": [
+                        {
+                            "$ref": "common.schema.json#/$defs/actor"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                },
+                "due": {
+                    "oneOf": [
+                        {
+                            "$ref": "common.schema.json#/$defs/dateTime"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                },
+                "intent": {
+                    "oneOf": [
+                        {
+                            "$ref": "common.schema.json#/$defs/text"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                },
+                "outcome": {
+                    "oneOf": [
+                        {
+                            "$ref": "common.schema.json#/$defs/text"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": false
+        },
+        "status": {
+            "$ref": "common.schema.json#/$defs/status"
+        },
+        "reason": {
+            "$ref": "common.schema.json#/$defs/text"
+        },
+        "on": {
+            "type": "string",
+            "minLength": 1
+        },
+        "ref": {
+            "$ref": "common.schema.json#/$defs/ref"
+        },
+        "file": {
+            "$ref": "common.schema.json#/$defs/file"
+        },
+        "resource": {
+            "type": "string",
+            "minLength": 1
+        },
+        "fileId": {
+            "type": "string",
+            "minLength": 1
+        },
+        "relation": {
+            "$ref": "common.schema.json#/$defs/relation"
+        },
+        "targetTopicId": {
+            "$ref": "common.schema.json#/$defs/topicId"
+        },
+        "flowUri": {
+            "type": "string",
+            "minLength": 1
+        }
+    },
+    "allOf": [
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "update"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "fields": true
+                },
+                "required": [
+                    "fields"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "set-status"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "status": true
+                },
+                "required": [
+                    "status"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "block"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "reason": true
+                },
+                "required": [
+                    "reason"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "enum": [
+                            "link",
+                            "unlink"
+                        ]
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "ref": true
+                },
+                "required": [
+                    "ref"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "attach"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "file": true
+                },
+                "required": [
+                    "file"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "detach"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "resource": true,
+                    "fileId": true
+                },
+                "required": [
+                    "resource",
+                    "fileId"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "enum": [
+                            "relate",
+                            "unrelate"
+                        ]
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "relation": true,
+                    "targetTopicId": true
+                },
+                "required": [
+                    "relation",
+                    "targetTopicId"
+                ]
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "type": {
+                        "const": "bind-flow"
+                    }
+                },
+                "required": [
+                    "type"
+                ]
+            },
+            "then": {
+                "properties": {
+                    "flowUri": true
+                },
+                "required": [
+                    "flowUri"
+                ]
+            }
+        }
+    ],
+    "additionalProperties": false
+}

package/dist/schemas/v2/projection.schema.json

@@ -0,0 +1,205 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/projection.schema.json",
+    "title": "Topic projection (Protocol 2.0)",
+    "description": "The deterministic fold of a manifest, its operations, and its records. Derived data; never authoritative on its own.",
+    "type": "object",
+    "required": [
+        "version",
+        "id",
+        "anchor",
+        "title",
+        "kind",
+        "baseKind",
+        "status",
+        "createdBy",
+        "createdAt",
+        "updatedBy",
+        "updatedAt",
+        "links",
+        "files",
+        "relations",
+        "records",
+        "etag",
+        "rejected"
+    ],
+    "properties": {
+        "version": {
+            "const": 2
+        },
+        "id": {
+            "$ref": "common.schema.json#/$defs/topicId"
+        },
+        "anchor": {
+            "$ref": "common.schema.json#/$defs/anchor"
+        },
+        "title": {
+            "$ref": "common.schema.json#/$defs/title"
+        },
+        "kind": {
+            "$ref": "common.schema.json#/$defs/kind"
+        },
+        "baseKind": {
+            "$ref": "common.schema.json#/$defs/baseKind"
+        },
+        "status": {
+            "$ref": "common.schema.json#/$defs/status"
+        },
+        "owner": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "due": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "intent": {
+            "$ref": "common.schema.json#/$defs/text"
+        },
+        "outcome": {
+            "$ref": "common.schema.json#/$defs/text"
+        },
+        "blocked": {
+            "$ref": "common.schema.json#/$defs/block"
+        },
+        "createdBy": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "createdAt": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "updatedBy": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "updatedAt": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "links": {
+            "type": "array",
+            "items": {
+                "$ref": "common.schema.json#/$defs/ref"
+            }
+        },
+        "files": {
+            "type": "array",
+            "items": {
+                "$ref": "common.schema.json#/$defs/file"
+            }
+        },
+        "relations": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "relation",
+                    "topicId",
+                    "by",
+                    "at"
+                ],
+                "properties": {
+                    "relation": {
+                        "$ref": "common.schema.json#/$defs/relation"
+                    },
+                    "topicId": {
+                        "$ref": "common.schema.json#/$defs/topicId"
+                    },
+                    "by": {
+                        "$ref": "common.schema.json#/$defs/actor"
+                    },
+                    "at": {
+                        "$ref": "common.schema.json#/$defs/dateTime"
+                    }
+                },
+                "additionalProperties": false
+            }
+        },
+        "flow": {
+            "type": "object",
+            "required": [
+                "flowUri",
+                "by",
+                "at"
+            ],
+            "properties": {
+                "flowUri": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "by": {
+                    "$ref": "common.schema.json#/$defs/actor"
+                },
+                "at": {
+                    "$ref": "common.schema.json#/$defs/dateTime"
+                }
+            },
+            "additionalProperties": false
+        },
+        "records": {
+            "type": "object",
+            "required": [
+                "decisions",
+                "outcomes",
+                "artifacts",
+                "receipts"
+            ],
+            "properties": {
+                "decisions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "record.schema.json"
+                    }
+                },
+                "outcomes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "record.schema.json"
+                    }
+                },
+                "artifacts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "record.schema.json"
+                    }
+                },
+                "receipts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "record.schema.json"
+                    }
+                }
+            },
+            "additionalProperties": false
+        },
+        "etag": {
+            "type": "string",
+            "pattern": "^sha256:[0-9a-f]{64}$",
+            "description": "SHA-256 of the canonical projected state, excluding etag and rejected."
+        },
+        "rejected": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "reason"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string",
+                        "minLength": 1
+                    },
+                    "reason": {
+                        "type": "string",
+                        "enum": [
+                            "conflict",
+                            "duplicate",
+                            "topic-mismatch",
+                            "unauthorized",
+                            "unknown-supersedes"
+                        ]
+                    }
+                },
+                "additionalProperties": false
+            }
+        }
+    },
+    "additionalProperties": false
+}

package/dist/schemas/v2/record.schema.json

@@ -0,0 +1,56 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/record.schema.json",
+    "title": "Topic record (Protocol 2.0)",
+    "description": "An accepted fact posted into a Topic thread: a decision, an outcome, an artifact reference, or an execution receipt. A record may supersede an earlier record of the same type.",
+    "type": "object",
+    "required": [
+        "version",
+        "id",
+        "topicId",
+        "type",
+        "text",
+        "author",
+        "createdAt"
+    ],
+    "properties": {
+        "version": {
+            "const": 2
+        },
+        "id": {
+            "type": "string",
+            "pattern": "^ixo:topic-record:[A-Za-z0-9._-]{8,128}$",
+            "description": "Writers SHOULD use a UUIDv7 suffix."
+        },
+        "topicId": {
+            "$ref": "common.schema.json#/$defs/topicId"
+        },
+        "type": {
+            "$ref": "common.schema.json#/$defs/recordType"
+        },
+        "text": {
+            "$ref": "common.schema.json#/$defs/text"
+        },
+        "author": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "createdAt": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "refs": {
+            "type": "array",
+            "items": {
+                "$ref": "common.schema.json#/$defs/ref"
+            },
+            "maxItems": 20
+        },
+        "data": {
+            "type": "object"
+        },
+        "supersedes": {
+            "type": "string",
+            "pattern": "^ixo:topic-record:[A-Za-z0-9._-]{8,128}$"
+        }
+    },
+    "additionalProperties": false
+}