@ixo/topic-protocol 1.0.0-rc.3 → 1.0.0-rc.5

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
+}

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

@@ -0,0 +1,84 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/v2/topic.schema.json",
+    "title": "Topic manifest (Protocol 2.0)",
+    "description": "The immutable content of a Topic root event. Status is not stored here: a new Topic is open, and status changes are operations.",
+    "type": "object",
+    "required": [
+        "version",
+        "id",
+        "title",
+        "kind",
+        "createdBy",
+        "createdAt"
+    ],
+    "properties": {
+        "version": {
+            "const": 2
+        },
+        "id": {
+            "$ref": "common.schema.json#/$defs/topicId"
+        },
+        "title": {
+            "$ref": "common.schema.json#/$defs/title"
+        },
+        "kind": {
+            "$ref": "common.schema.json#/$defs/kind"
+        },
+        "baseKind": {
+            "$ref": "common.schema.json#/$defs/baseKind"
+        },
+        "createdBy": {
+            "$ref": "common.schema.json#/$defs/actor"
+        },
+        "createdAt": {
+            "$ref": "common.schema.json#/$defs/dateTime"
+        },
+        "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"
+        }
+    },
+    "if": {
+        "properties": {
+            "kind": {
+                "enum": [
+                    "discussion",
+                    "question",
+                    "task",
+                    "project"
+                ]
+            }
+        },
+        "required": [
+            "kind"
+        ]
+    },
+    "then": {
+        "not": {
+            "properties": {
+                "baseKind": true
+            },
+            "required": [
+                "baseKind"
+            ]
+        }
+    },
+    "else": {
+        "properties": {
+            "baseKind": true
+        },
+        "required": [
+            "baseKind"
+        ]
+    },
+    "additionalProperties": false
+}

package/dist/src/contracts/schemas.d.ts

@@ -4933,6 +4933,10 @@ export declare const SCHEMA_REGISTRY: Readonly<{
                         lastOperationId: {
                             type: string;
                         };
+                        waiverReason: {
+                            type: string;
+                            minLength: number;
+                        };
                     };
                     additionalProperties: boolean;
                 };
@@ -7433,6 +7437,10 @@ export declare const SCHEMA_REGISTRY: Readonly<{
                                 finality: {
                                     enum: string[];
                                 };
+                                status: {
+                                    type: string;
+                                    minLength: number;
+                                };
                             };
                             additionalProperties: boolean;
                         };