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

package/dist/schemas/external-project-snapshot.schema.json

@@ -0,0 +1,121 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/external-project-snapshot.schema.json",
+    "title": "External project snapshot v1",
+    "type": "object",
+    "required": [
+        "version",
+        "snapshotId",
+        "bindingId",
+        "topicId",
+        "source",
+        "title",
+        "workflowState",
+        "progress",
+        "milestones",
+        "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 },
+                "teamIds": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": { "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
+        },
+        "lead": { "$ref": "#/$defs/externalActor" },
+        "planning": {
+            "type": "object",
+            "required": ["labels"],
+            "properties": {
+                "startDate": { "type": "string", "format": "date" },
+                "targetDate": { "type": "string", "format": "date" },
+                "labels": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            },
+            "additionalProperties": false
+        },
+        "progress": {
+            "type": "object",
+            "required": ["scope", "completed", "total"],
+            "properties": {
+                "scope": { "enum": ["provider_reported", "work_items", "observed_page"] },
+                "completed": { "type": "integer", "minimum": 0 },
+                "total": { "type": "integer", "minimum": 0 },
+                "hasMore": { "type": "boolean" }
+            },
+            "additionalProperties": false
+        },
+        "milestones": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": ["id", "name"],
+                "properties": {
+                    "id": { "type": "string", "minLength": 1 },
+                    "name": { "type": "string", "minLength": 1 },
+                    "targetDate": { "type": "string", "format": "date" },
+                    "status": { "type": "string", "minLength": 1 }
+                },
+                "additionalProperties": false
+            }
+        },
+        "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
+        }
+    },
+    "additionalProperties": false
+}

package/dist/schemas/external-work-state-map.schema.json

@@ -3,7 +3,7 @@
     "$id": "https://topic-protocol.ixo.world/schemas/external-work-state-map.schema.json",
     "title": "External work state mapping profile v1",
     "type": "object",
-    "required": ["version", "profileId", "provider", "organizationId", "teamId", "mappings"],
+    "required": ["version", "profileId", "provider", "organizationId", "mappings"],
     "properties": {
         "version": { "const": 1 },
         "profileId": { "type": "string", "format": "uri" },

package/dist/schemas/project-plan.schema.json

@@ -0,0 +1,75 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/project-plan.schema.json",
+    "title": "Project plan v1",
+    "type": "object",
+    "required": ["version"],
+    "properties": {
+        "version": { "const": 1 },
+        "lead": { "$ref": "#/$defs/subject" },
+        "closer": { "$ref": "#/$defs/subject" },
+        "milestones": { "type": "array", "items": { "$ref": "#/$defs/milestone" }, "uniqueItemProperty": "id" },
+        "childObligations": { "type": "array", "items": { "$ref": "#/$defs/childObligation" }, "uniqueItemProperty": "id" },
+        "currentBlockingChildObligationId": { "type": "string", "minLength": 1 },
+        "methodManifestRef": { "$ref": "#/$defs/digestRef" },
+        "trackerBindings": { "type": "array", "items": { "$ref": "#/$defs/trackerBinding" }, "uniqueItemProperty": "id" }
+    },
+    "additionalProperties": false,
+    "$defs": {
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "digestRef": {
+            "type": "object",
+            "required": ["id", "version", "digest"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "version": { "type": "string", "minLength": 1 },
+                "digest": { "$ref": "#/$defs/digest" }
+            },
+            "additionalProperties": false
+        },
+        "subject": {
+            "type": "object",
+            "required": ["kind", "id"],
+            "properties": {
+                "kind": { "enum": ["actor", "role"] },
+                "id": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": false
+        },
+        "milestone": {
+            "type": "object",
+            "required": ["id", "name"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "name": { "type": "string", "minLength": 1 },
+                "evidenceRequired": { "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }
+            },
+            "additionalProperties": false
+        },
+        "childObligation": {
+            "type": "object",
+            "required": ["id", "title"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "title": { "type": "string", "minLength": 1 },
+                "kind": { "enum": ["task", "agent_task", "proposal", "evaluation", "claims", "incident", "question", "discussion"] },
+                "topicId": { "type": "string", "pattern": "^ixo:topic:[0-9a-f-]{36}$" }
+            },
+            "additionalProperties": false
+        },
+        "trackerBinding": {
+            "type": "object",
+            "required": ["id", "resourceClass", "role"],
+            "properties": {
+                "id": { "type": "string", "minLength": 1 },
+                "resourceClass": { "enum": ["project", "work-item"] },
+                "role": { "enum": ["primary", "supporting", "verification", "delivery"] },
+                "provider": { "type": "string", "pattern": "^[a-z][a-z0-9.-]{0,63}$" },
+                "resourceType": { "type": "string", "minLength": 1, "maxLength": 80 },
+                "bindingId": { "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}$" },
+                "label": { "type": "string", "minLength": 1, "maxLength": 160 }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/dist/schemas/project-projection.schema.json

@@ -0,0 +1,187 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/project-projection.schema.json",
+    "title": "Projected Project state v1",
+    "type": "object",
+    "required": [
+        "version",
+        "lifecycle",
+        "milestones",
+        "childObligations"
+    ],
+    "properties": {
+        "version": {
+            "const": 1
+        },
+        "lifecycle": {
+            "enum": [
+                "proposed",
+                "effective",
+                "closing",
+                "closed"
+            ]
+        },
+        "lead": {
+            "type": "object",
+            "required": [
+                "kind",
+                "id"
+            ],
+            "properties": {
+                "kind": {
+                    "enum": [
+                        "actor",
+                        "role"
+                    ]
+                },
+                "id": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            },
+            "additionalProperties": false
+        },
+        "closer": {
+            "type": "object",
+            "required": [
+                "kind",
+                "id"
+            ],
+            "properties": {
+                "kind": {
+                    "enum": [
+                        "actor",
+                        "role"
+                    ]
+                },
+                "id": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            },
+            "additionalProperties": false
+        },
+        "milestones": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "name",
+                    "status",
+                    "evidenceRefs"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "status": {
+                        "enum": [
+                            "pending",
+                            "in-progress",
+                            "met",
+                            "waived"
+                        ]
+                    },
+                    "evidenceRequired": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "evidenceRefs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "lastOperationId": {
+                        "type": "string"
+                    }
+                },
+                "additionalProperties": false
+            },
+            "uniqueItemProperty": "id"
+        },
+        "childObligations": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "required": [
+                    "id",
+                    "title",
+                    "status"
+                ],
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "title": {
+                        "type": "string"
+                    },
+                    "kind": {
+                        "enum": [
+                            "task",
+                            "agent_task",
+                            "proposal",
+                            "evaluation",
+                            "claims",
+                            "incident",
+                            "question",
+                            "discussion"
+                        ]
+                    },
+                    "topicId": {
+                        "type": "string"
+                    },
+                    "status": {
+                        "enum": [
+                            "unmet",
+                            "linked",
+                            "complete",
+                            "waived"
+                        ]
+                    },
+                    "childRevision": {
+                        "type": "string"
+                    },
+                    "childShapeDigest": {
+                        "type": "string",
+                        "pattern": "^sha256:[0-9a-f]{64}$"
+                    },
+                    "sourceEventId": {
+                        "type": "string"
+                    },
+                    "lastOperationId": {
+                        "type": "string"
+                    },
+                    "waiverReason": {
+                        "type": "string",
+                        "minLength": 1
+                    }
+                },
+                "additionalProperties": false
+            },
+            "uniqueItemProperty": "id"
+        },
+        "currentBlockingChildObligationId": {
+            "type": "string"
+        },
+        "methodManifestRef": {
+            "type": "object"
+        },
+        "closeRequest": {
+            "type": "object"
+        },
+        "closeAcceptance": {
+            "type": "object"
+        },
+        "sourceContractRevision": {
+            "type": "string"
+        }
+    },
+    "additionalProperties": false
+}

package/dist/schemas/topic-contract-body.schema.json

@@ -29,6 +29,7 @@
         "outcome": { "type": "object" },
         "completion": { "type": "object" },
         "ownerId": { "type": "string" },
+        "project": { "$ref": "https://topic-protocol.ixo.world/schemas/project-plan.schema.json" },
         "scope": { "type": "object" },
         "constraints": { "type": "array", "items": { "type": "object" } },
         "assumptions": { "type": "array", "items": { "type": "object" } },

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

@@ -3,28 +3,170 @@
     "$id": "https://topic-protocol.ixo.world/schemas/topic-operation.schema.json",
     "title": "Topic operation",
     "type": "object",
-    "required": ["version", "operationId", "topicId", "type", "previousRevision", "actor", "createdAt", "payload"],
+    "required": [
+        "version",
+        "operationId",
+        "topicId",
+        "type",
+        "previousRevision",
+        "actor",
+        "createdAt",
+        "payload"
+    ],
     "properties": {
-        "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", "record-outcome", "propose-contract", "update-contract", "accept-contract", "confirm-setup", "withdraw-setup-confirmation", "record-assent", "withdraw-assent", "raise-dispute", "resolve-dispute", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-flow", "update-flow-binding", "unbind-flow", "request-action", "cancel-action", "record-action-receipt", "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" },
-        "payload": { "type": "object" },
-        "capability": { "type": "string" }
+        "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",
+                "change-progress",
+                "answer-question",
+                "change-due-date",
+                "unblock-topic",
+                "complete-topic",
+                "update-overview",
+                "link-context",
+                "unlink-context",
+                "attach-files",
+                "detach-files",
+                "record-decision",
+                "record-outcome",
+                "propose-contract",
+                "update-contract",
+                "accept-contract",
+                "confirm-setup",
+                "withdraw-setup-confirmation",
+                "record-assent",
+                "withdraw-assent",
+                "raise-dispute",
+                "resolve-dispute",
+                "supersede-contract",
+                "bind-automation",
+                "update-automation",
+                "pause-automation",
+                "remove-automation",
+                "bind-flow",
+                "update-flow-binding",
+                "unbind-flow",
+                "request-action",
+                "cancel-action",
+                "record-action-receipt",
+                "bind-external-work",
+                "sync-external-work",
+                "unlink-external-work",
+                "submit-delivery",
+                "record-delivery-decision",
+                "record-evaluation",
+                "record-approval",
+                "record-claim",
+                "record-settlement",
+                "record-project-milestone",
+                "link-project-child",
+                "unlink-project-child",
+                "record-project-child-status",
+                "waive-project-child",
+                "set-project-blocker",
+                "request-project-close",
+                "close-project",
+                "redirect",
+                "branch",
+                "merge",
+                "resolve-conflict",
+                "record-review"
+            ]
+        },
+        "previousRevision": {
+            "type": "string",
+            "minLength": 1
+        },
+        "actor": {
+            "type": "string",
+            "minLength": 1
+        },
+        "createdAt": {
+            "type": "string",
+            "format": "date-time"
+        },
+        "payload": {
+            "type": "object"
+        },
+        "capability": {
+            "type": "string"
+        }
     },
     "additionalProperties": true,
     "allOf": [
         {
             "if": {
                 "properties": {
-                    "type": { "enum": ["record-outcome", "propose-contract", "update-contract", "accept-contract", "confirm-setup", "withdraw-setup-confirmation", "record-assent", "withdraw-assent", "raise-dispute", "resolve-dispute", "supersede-contract", "bind-automation", "update-automation", "pause-automation", "remove-automation", "bind-flow", "update-flow-binding", "unbind-flow", "request-action", "cancel-action", "record-action-receipt", "bind-external-work", "sync-external-work", "unlink-external-work", "submit-delivery", "record-delivery-decision", "record-evaluation", "record-approval", "record-claim", "record-settlement"] }
+                    "type": {
+                        "enum": [
+                            "record-outcome",
+                            "propose-contract",
+                            "update-contract",
+                            "accept-contract",
+                            "confirm-setup",
+                            "withdraw-setup-confirmation",
+                            "record-assent",
+                            "withdraw-assent",
+                            "raise-dispute",
+                            "resolve-dispute",
+                            "supersede-contract",
+                            "bind-automation",
+                            "update-automation",
+                            "pause-automation",
+                            "remove-automation",
+                            "bind-flow",
+                            "update-flow-binding",
+                            "unbind-flow",
+                            "request-action",
+                            "cancel-action",
+                            "record-action-receipt",
+                            "bind-external-work",
+                            "sync-external-work",
+                            "unlink-external-work",
+                            "submit-delivery",
+                            "record-delivery-decision",
+                            "record-evaluation",
+                            "record-approval",
+                            "record-claim",
+                            "record-settlement",
+                            "record-project-milestone",
+                            "link-project-child",
+                            "unlink-project-child",
+                            "record-project-child-status",
+                            "waive-project-child",
+                            "set-project-blocker",
+                            "request-project-close",
+                            "close-project"
+                        ]
+                    }
                 },
-                "required": ["type"]
+                "required": [
+                    "type"
+                ]
             },
-            "then": { "properties": { "version": { "const": 2 } } }
+            "then": {
+                "properties": {
+                    "version": {
+                        "const": 2
+                    }
+                }
+            }
         }
     ]
 }

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

@@ -6,14 +6,64 @@
     "required": ["version", "code", "id", "recipeVersion", "label", "description", "baseRecipe", "creates", "shape"],
     "properties": {
         "version": { "const": 1 },
-        "code": { "enum": ["research-brief", "agent-delivery", "verified-work-payment"] },
+        "code": { "enum": ["research-brief", "agent-delivery", "verified-work-payment", "software-build", "blueprint-design"] },
         "id": { "type": "string", "format": "uri" },
         "recipeVersion": { "type": "string", "minLength": 1 },
         "label": { "type": "string", "minLength": 1 },
         "description": { "type": "string", "minLength": 1 },
         "baseRecipe": { "enum": ["project", "flow", "proposal", "evaluation", "claims", "research", "discussion", "incident"] },
         "creates": { "const": "draft" },
-        "shape": { "$ref": "https://topic-protocol.ixo.world/schemas/topic-shape.schema.json" }
+        "shape": { "$ref": "https://topic-protocol.ixo.world/schemas/topic-shape.schema.json" },
+        "project": { "$ref": "#/$defs/projectRecipe" }
     },
-    "additionalProperties": false
+    "additionalProperties": false,
+    "allOf": [
+        {
+            "if": { "properties": { "code": { "enum": ["software-build", "blueprint-design"] } }, "required": ["code"] },
+            "then": { "properties": { "baseRecipe": { "const": "project" }, "project": true }, "required": ["project"] }
+        }
+    ],
+    "$defs": {
+        "childKind": { "enum": ["task", "agent_task", "proposal", "evaluation", "claims", "incident", "question", "discussion"] },
+        "digestRef": { "type": "object", "required": ["id", "version", "digest"], "properties": { "id": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 }, "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" } }, "additionalProperties": false },
+        "entryPoint": {
+            "type": "object",
+            "required": ["code", "label", "kind", "target", "suggestedChildKinds", "requiresReview"],
+            "properties": {
+                "code": { "type": "string", "minLength": 1 },
+                "label": { "type": "string", "minLength": 1 },
+                "kind": { "enum": ["action", "flow"] },
+                "target": { "type": "string", "minLength": 1 },
+                "suggestedChildKinds": { "type": "array", "items": { "$ref": "#/$defs/childKind" }, "uniqueItems": true },
+                "requiresReview": { "const": true }
+            },
+            "additionalProperties": false
+        },
+        "milestoneSuggestion": {
+            "type": "object",
+            "required": ["code", "label", "provenance", "requiresAcceptance"],
+            "properties": {
+                "code": { "type": "string", "minLength": 1 },
+                "label": { "type": "string", "minLength": 1 },
+                "provenance": { "const": "recipe" },
+                "requiresAcceptance": { "const": true }
+            },
+            "additionalProperties": false
+        },
+        "projectRecipe": {
+            "type": "object",
+            "required": ["version", "compatibleKind", "compatibleShapeVersion", "allowedChildKinds", "entryPoints", "milestoneSuggestions"],
+            "properties": {
+                "version": { "const": 1 },
+                "compatibleKind": { "const": "project" },
+                "compatibleShapeVersion": { "const": 1 },
+                "methodManifestRef": { "$ref": "#/$defs/digestRef" },
+                "allowedChildKinds": { "type": "array", "items": { "$ref": "#/$defs/childKind" }, "uniqueItems": true },
+                "entryPoints": { "type": "array", "items": { "$ref": "#/$defs/entryPoint" } },
+                "milestoneSuggestions": { "type": "array", "items": { "$ref": "#/$defs/milestoneSuggestion" } },
+                "requiredCloseEvidenceTypes": { "type": "array", "items": { "type": "string", "minLength": 1 }, "uniqueItems": true }
+            },
+            "additionalProperties": false
+        }
+    }
 }