@ixo/topic-protocol 0.7.0 → 1.0.0-rc.1

package/dist/schemas/decision-to-pay-template.schema.json

@@ -0,0 +1,346 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://topic-protocol.ixo.world/schemas/decision-to-pay-template.schema.json",
+    "title": "IXO Decision-to-Pay Topic Template manifest v1",
+    "type": "object",
+    "required": [
+        "$schema",
+        "version",
+        "id",
+        "templateVersion",
+        "label",
+        "description",
+        "maturity",
+        "compatibility",
+        "topic",
+        "actors",
+        "resources",
+        "protocolContracts",
+        "operations",
+        "gates",
+        "settlement",
+        "privacy",
+        "acceptanceCriteria"
+    ],
+    "properties": {
+        "$schema": { "type": "string", "minLength": 1 },
+        "version": { "const": 1 },
+        "id": { "type": "string", "pattern": "^urn:ixo:decision-to-pay:template:[a-z0-9-]+$" },
+        "templateVersion": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$" },
+        "label": { "type": "string", "minLength": 1, "maxLength": 120 },
+        "description": { "type": "string", "minLength": 1, "maxLength": 1000 },
+        "maturity": { "enum": ["draft", "incubating", "candidate", "stable"] },
+        "compatibility": { "$ref": "#/$defs/compatibility" },
+        "topic": { "$ref": "#/$defs/topic" },
+        "topology": { "$ref": "#/$defs/topology" },
+        "actors": {
+            "type": "array",
+            "minItems": 2,
+            "items": { "$ref": "#/$defs/actor" }
+        },
+        "resources": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#/$defs/resource" }
+        },
+        "protocolContracts": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#/$defs/protocolContract" }
+        },
+        "operations": {
+            "type": "array",
+            "minItems": 1,
+            "uniqueItems": true,
+            "items": { "$ref": "#/$defs/topicOperation" }
+        },
+        "gates": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#/$defs/gate" }
+        },
+        "settlement": { "$ref": "#/$defs/settlement" },
+        "privacy": { "$ref": "#/$defs/privacy" },
+        "acceptanceCriteria": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#/$defs/acceptanceCriterion" }
+        },
+        "extensions": { "type": "object" }
+    },
+    "additionalProperties": false,
+    "$defs": {
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" },
+        "did": { "type": "string", "pattern": "^did:[a-z0-9]+:.+" },
+        "jsonPointer": { "type": "string", "pattern": "^/" },
+        "compatibility": {
+            "type": "object",
+            "required": ["protocolPackage", "protocolVersion", "sourceCommit", "implementationStatus", "requiredExtensions"],
+            "properties": {
+                "protocolPackage": { "const": "@ixo/topic-protocol" },
+                "protocolVersion": { "const": "0.7.0" },
+                "sourceCommit": { "type": "string", "pattern": "^[0-9a-f]{40}$" },
+                "implementationStatus": {
+                    "enum": ["draft_contract_extension", "design_ready", "design_ready_extension_required", "implemented"]
+                },
+                "requiredExtensions": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                },
+                "constraints": {
+                    "type": "array",
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            },
+            "additionalProperties": false
+        },
+        "persistedKind": {
+            "enum": ["task", "agent_task", "proposal", "evaluation", "claims", "question", "discussion", "incident"]
+        },
+        "recipe": {
+            "enum": ["project", "flow", "proposal", "evaluation", "claims", "research", "discussion", "incident"]
+        },
+        "kindRef": {
+            "oneOf": [
+                {
+                    "type": "object",
+                    "required": ["source", "kind"],
+                    "properties": {
+                        "source": { "const": "standard" },
+                        "kind": { "$ref": "#/$defs/persistedKind" }
+                    },
+                    "additionalProperties": false
+                },
+                {
+                    "type": "object",
+                    "required": ["source", "customId", "label", "baseKind"],
+                    "properties": {
+                        "source": { "const": "custom" },
+                        "customId": { "type": "string", "pattern": "^[a-z][a-z0-9.-]+$" },
+                        "label": { "type": "string", "minLength": 1, "maxLength": 80 },
+                        "baseKind": { "$ref": "#/$defs/persistedKind" }
+                    },
+                    "additionalProperties": false
+                }
+            ]
+        },
+        "kindProfile": {
+            "type": "object",
+            "required": ["id", "version", "schema", "digest"],
+            "properties": {
+                "id": { "type": "string", "format": "uri" },
+                "version": { "type": "string", "minLength": 1 },
+                "schema": { "type": "string", "format": "uri" },
+                "digest": { "$ref": "#/$defs/digest" }
+            },
+            "additionalProperties": false
+        },
+        "topic": {
+            "type": "object",
+            "required": ["primaryRole", "kindRef", "recipe", "workingMode", "temporalMode", "acceptance", "lifecyclePolicy"],
+            "properties": {
+                "primaryRole": { "enum": ["work_case", "delivery_case", "payable_milestone", "payment_claim"] },
+                "kindRef": { "$ref": "#/$defs/kindRef" },
+                "kindProfile": { "$ref": "#/$defs/kindProfile" },
+                "recipe": { "$ref": "#/$defs/recipe" },
+                "workingMode": { "enum": ["solo", "team", "client"] },
+                "temporalMode": { "enum": ["finite", "ongoing"] },
+                "acceptance": {
+                    "type": "object",
+                    "required": ["requiredTopicContractPaths", "allowHonestDraft"],
+                    "properties": {
+                        "requiredTopicContractPaths": {
+                            "type": "array",
+                            "uniqueItems": true,
+                            "items": { "$ref": "#/$defs/jsonPointer" }
+                        },
+                        "allowHonestDraft": { "const": true }
+                    },
+                    "additionalProperties": false
+                },
+                "lifecyclePolicy": {
+                    "type": "object",
+                    "required": ["separateTopicContractOutcomeAxes", "resolveRule"],
+                    "properties": {
+                        "separateTopicContractOutcomeAxes": { "const": true },
+                        "resolveRule": { "type": "string", "minLength": 1 },
+                        "waitingRule": { "type": "string", "minLength": 1 }
+                    },
+                    "additionalProperties": false
+                }
+            },
+            "additionalProperties": false
+        },
+        "topology": {
+            "type": "object",
+            "required": ["requiresParentTopic", "onePayableUnitPerTopic"],
+            "properties": {
+                "requiresParentTopic": { "type": "boolean" },
+                "parentBaseKind": { "$ref": "#/$defs/persistedKind" },
+                "relation": { "enum": ["branches_from", "merged_into", "redirects_to", "references", "produced"] },
+                "onePayableUnitPerTopic": { "type": "boolean" }
+            },
+            "additionalProperties": false
+        },
+        "actor": {
+            "type": "object",
+            "required": ["role", "label", "required", "identity", "capabilities"],
+            "properties": {
+                "role": { "type": "string", "pattern": "^[a-z][a-z0-9_]*$" },
+                "label": { "type": "string", "minLength": 1 },
+                "required": { "type": "boolean" },
+                "identity": { "const": "did" },
+                "capabilities": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                },
+                "constraints": {
+                    "type": "array",
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            },
+            "additionalProperties": false
+        },
+        "resource": {
+            "type": "object",
+            "required": ["role", "type", "required", "binding", "authority", "availability", "confidentiality"],
+            "properties": {
+                "role": { "type": "string", "pattern": "^[a-z][a-z0-9_]*$" },
+                "type": { "type": "string", "minLength": 1 },
+                "required": { "type": "boolean" },
+                "binding": { "enum": ["kind_resource", "typed_context", "vfs_attachment", "protocol_record", "external_reference"] },
+                "authority": { "enum": ["topic_contract", "bound_resource", "external_system", "protocol_record"] },
+                "availability": { "enum": ["topic_protocol_0.7", "contract_pack", "proposed_extension", "external"] },
+                "schemaRef": { "type": "string", "format": "uri-reference" },
+                "confidentiality": { "enum": ["room_encrypted", "vfs_ucan", "external_authority", "public"] },
+                "notes": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": false
+        },
+        "protocolContract": {
+            "type": "object",
+            "required": ["name", "source", "schemaRef"],
+            "properties": {
+                "name": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
+                "source": { "enum": ["topic_protocol", "contract_pack", "proposed_extension"] },
+                "schemaRef": { "type": "string", "format": "uri-reference" },
+                "required": { "type": "boolean" }
+            },
+            "additionalProperties": false
+        },
+        "topicOperation": {
+            "enum": [
+                "propose-contract",
+                "update-contract",
+                "accept-contract",
+                "supersede-contract",
+                "bind-external-work",
+                "sync-external-work",
+                "unlink-external-work",
+                "submit-delivery",
+                "record-delivery-decision",
+                "record-evaluation",
+                "record-approval",
+                "record-claim",
+                "record-settlement",
+                "record-decision",
+                "change-status",
+                "redirect",
+                "branch",
+                "merge",
+                "resolve-conflict"
+            ]
+        },
+        "gateCondition": {
+            "type": "object",
+            "required": ["contract", "path", "operator"],
+            "properties": {
+                "contract": {
+                    "enum": [
+                        "topic-contract-state",
+                        "payment-terms",
+                        "payable-obligation",
+                        "external-work-binding",
+                        "delivery-packet",
+                        "delivery-decision",
+                        "evaluation-assertion",
+                        "approval-decision",
+                        "claim-record",
+                        "settlement-receipt",
+                        "operator-verification"
+                    ]
+                },
+                "path": { "$ref": "#/$defs/jsonPointer" },
+                "operator": { "enum": ["exists", "equals", "min_count", "all_equal", "digest_matches"] },
+                "value": {}
+            },
+            "additionalProperties": false
+        },
+        "gate": {
+            "type": "object",
+            "required": ["id", "stage", "description", "all", "onFailure"],
+            "properties": {
+                "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
+                "stage": { "enum": ["terms", "delivery", "evaluation", "approval", "claim", "settlement", "exception"] },
+                "description": { "type": "string", "minLength": 1 },
+                "all": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": { "$ref": "#/$defs/gateCondition" }
+                },
+                "onFailure": { "enum": ["block", "human_review", "return_for_changes", "open_incident"] }
+            },
+            "additionalProperties": false
+        },
+        "settlement": {
+            "type": "object",
+            "required": ["movesFunds", "requiresExternalAdapter", "failClosed", "requiredAxes", "exactMatchFields", "terminalState"],
+            "properties": {
+                "movesFunds": { "const": false },
+                "requiresExternalAdapter": { "const": true },
+                "failClosed": { "const": true },
+                "requiredAxes": {
+                    "type": "array",
+                    "minItems": 4,
+                    "uniqueItems": true,
+                    "items": { "enum": ["delivery", "evaluation", "approval", "claim", "settlement"] }
+                },
+                "exactMatchFields": {
+                    "type": "array",
+                    "minItems": 3,
+                    "uniqueItems": true,
+                    "items": { "enum": ["topicId", "deliveryPacketId", "deliveryPacketDigest", "evaluationIds", "approvalId", "claimId", "amount", "asset", "recipient"] }
+                },
+                "terminalState": { "const": "confirmed" }
+            },
+            "additionalProperties": false
+        },
+        "privacy": {
+            "type": "object",
+            "required": ["topicIsConfidentialityBoundary", "topicCapabilityGrantsVfsAccess", "sensitiveResourceStorage", "minimumRoomVisibleFields"],
+            "properties": {
+                "topicIsConfidentialityBoundary": { "const": false },
+                "topicCapabilityGrantsVfsAccess": { "const": false },
+                "sensitiveResourceStorage": { "const": "encrypted_room_or_ucan_vfs" },
+                "minimumRoomVisibleFields": {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": { "type": "string", "minLength": 1 }
+                }
+            },
+            "additionalProperties": false
+        },
+        "acceptanceCriterion": {
+            "type": "object",
+            "required": ["id", "statement"],
+            "properties": {
+                "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
+                "statement": { "type": "string", "minLength": 1 },
+                "verification": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": false
+        }
+    }
+}