@ixo/topic-protocol 0.5.0 → 0.7.0

package/dist/schemas/topic-operation.schema.json

@@ -8,7 +8,7 @@
         "version": { "enum": [1, 2] },
         "operationId": { "type": "string", "minLength": 1 },
         "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}$" },
-        "type": { "type": "string", "enum": ["rename", "change-status", "update-overview", "link-context", "unlink-context", "attach-files", "detach-files", "record-decision", "propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "redirect", "branch", "merge", "resolve-conflict"] },
+        "type": { "type": "string", "enum": ["rename", "change-status", "update-overview", "link-context", "unlink-context", "attach-files", "detach-files", "record-decision", "propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement", "redirect", "branch", "merge", "resolve-conflict"] },
         "previousRevision": { "type": "string", "minLength": 1 },
         "actor": { "type": "string", "minLength": 1 },
         "createdAt": { "type": "string", "format": "date-time" },
@@ -20,7 +20,7 @@
         {
             "if": {
                 "properties": {
-                    "type": { "enum": ["propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation"] }
+                    "type": { "enum": ["propose-contract", "update-contract", "accept-contract", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement"] }
                 },
                 "required": ["type"]
             },

package/dist/schemas/topic-state.schema.json

@@ -33,6 +33,20 @@
                 ]
             }
         },
+        "workBridge": {
+            "type": "object",
+            "required": ["bindings", "deliveryPackets", "deliveryDecisions", "evaluations", "approvals", "claims", "settlements"],
+            "properties": {
+                "bindings": { "type": "array", "items": { "type": "object", "required": ["bindingId", "topicId", "workState", "health", "lastOperationId"], "properties": { "bindingId": { "type": "string" }, "topicId": { "type": "string" }, "workState": { "type": "string" }, "health": { "type": "string" }, "lastOperationId": { "type": "string" } } } },
+                "deliveryPackets": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/delivery-packet.schema.json" } },
+                "deliveryDecisions": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/delivery-decision.schema.json" } },
+                "evaluations": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/evaluation-assertion.schema.json" } },
+                "approvals": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/approval-decision.schema.json" } },
+                "claims": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/claim-record.schema.json" } },
+                "settlements": { "type": "array", "items": { "$ref": "https://topic-protocol.ixo.world/schemas/settlement-receipt.schema.json" } }
+            },
+            "additionalProperties": false
+        },
         "basedOnEvents": { "type": "array", "items": { "type": "string", "pattern": "^\\$" } },
         "conflicts": { "type": "array", "items": { "type": "string" } }
     },

package/dist/schemas/work-item-snapshot.schema.json

@@ -0,0 +1,73 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/work-item-snapshot.schema.json",
+    "title": "External work item snapshot v1",
+    "type": "object",
+    "required": ["version", "snapshotId", "bindingId", "topicId", "source", "title", "workflowState", "planning", "relations", "attachments", "promotedComments", "sourceCreatedAt", "sourceUpdatedAt", "retrievedAt", "digest"],
+    "properties": {
+        "version": { "const": 1 },
+        "snapshotId": { "$ref": "#/$defs/uuidV7" },
+        "bindingId": { "$ref": "#/$defs/uuidV7" },
+        "topicId": { "$ref": "#/$defs/topicId" },
+        "source": {
+            "type": "object",
+            "required": ["provider", "organizationId", "resourceId", "identifier", "url"],
+            "properties": {
+                "provider": { "type": "string", "pattern": "^[a-z][a-z0-9.-]{0,63}$" },
+                "organizationId": { "type": "string", "minLength": 1 },
+                "teamId": { "type": "string", "minLength": 1 },
+                "resourceId": { "type": "string", "minLength": 1 },
+                "identifier": { "type": "string", "minLength": 1 },
+                "url": { "type": "string", "format": "uri" }
+            },
+            "additionalProperties": false
+        },
+        "title": { "type": "string", "minLength": 1, "maxLength": 512 },
+        "descriptionMarkdown": { "type": "string", "maxLength": 200000 },
+        "workflowState": {
+            "type": "object",
+            "required": ["id", "name", "category", "mappedWorkState", "mappingProfileId", "mappingVersion"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "name": { "type": "string", "minLength": 1 },
+                "category": { "enum": ["triage", "backlog", "unstarted", "started", "completed", "canceled"] },
+                "mappedWorkState": { "enum": ["planned", "ready", "in_progress", "blocked", "handoff_ready", "handed_off", "cancelled"] },
+                "mappingProfileId": { "type": "string", "format": "uri" },
+                "mappingVersion": { "type": "integer", "minimum": 1 }
+            },
+            "additionalProperties": false
+        },
+        "assignee": { "$ref": "#/$defs/externalActor" },
+        "delegate": { "$ref": "#/$defs/externalActor" },
+        "planning": {
+            "type": "object",
+            "required": ["labels"],
+            "properties": {
+                "priority": { "type": "integer", "minimum": 0 },
+                "estimate": { "type": "number", "minimum": 0 },
+                "projectId": { "type": "string", "minLength": 1 },
+                "cycleId": { "type": "string", "minLength": 1 },
+                "dueDate": { "type": "string", "format": "date" },
+                "labels": { "type": "array", "uniqueItems": true, "items": { "type": "string", "minLength": 1 } }
+            },
+            "additionalProperties": false
+        },
+        "relations": { "type": "array", "items": { "type": "object", "required": ["type", "resourceId"], "properties": { "type": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" } }, "additionalProperties": false } },
+        "attachments": { "type": "array", "items": { "$ref": "#/$defs/sourceReference" } },
+        "promotedComments": { "type": "array", "items": { "$ref": "#/$defs/sourceReference" } },
+        "sourceCreatedAt": { "type": "string", "format": "date-time" },
+        "sourceUpdatedAt": { "type": "string", "format": "date-time" },
+        "retrievedAt": { "type": "string", "format": "date-time" },
+        "sourceEventId": { "type": "string", "minLength": 1 },
+        "digest": { "$ref": "#/$defs/digest" },
+        "extensions": { "type": "object" }
+    },
+    "$defs": {
+        "uuidV7": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" },
+        "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}$" },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "externalActor": { "type": "object", "required": ["id"], "properties": { "id": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 }, "did": { "type": "string", "pattern": "^did:[a-z0-9]+:.+" } }, "additionalProperties": false },
+        "sourceReference": { "type": "object", "required": ["id", "url", "digest"], "properties": { "id": { "type": "string", "minLength": 1 }, "url": { "type": "string", "format": "uri" }, "digest": { "$ref": "#/$defs/digest" } }, "additionalProperties": false }
+    },
+    "additionalProperties": false
+}