@bsv/dpp-profiles 0.3.0-beta.1

package/schemas/profile-manifest.schema.json

@@ -0,0 +1,291 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/profiles/schemas/profile-manifest.schema.json",
+  "title": "DPP industry profile manifest, version 1",
+  "description": "The canonical, immutable definition of one industry data profile (spec/profiles.md section 2). Forms, validators, consumer documents and registry endpoints are generated from it and never edit it.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["manifestVersion", "id", "version", "profile", "kind", "status", "title", "regulatoryLine", "baseline", "roles", "applicability", "schemaDialect", "schemaUri", "schemaDigest", "restrictedSchemaUri", "restrictedSchemaDigest", "contextRefs", "extends", "stamps", "fields", "eventMappings", "accessPolicyRef", "accessTiers", "sourceRefs", "identity"],
+  "properties": {
+    "manifestVersion": { "const": "1" },
+    "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" },
+    "version": { "type": "integer", "minimum": 1 },
+    "profile": { "type": "string", "pattern": "^[a-z][a-z0-9-]*@[0-9]+$" },
+    "kind": { "const": "industry" },
+    "status": { "enum": ["draft", "current", "superseded"] },
+    "supersededBy": { "type": "string", "pattern": "^[a-z][a-z0-9-]*@[0-9]+$" },
+    "title": { "type": "string", "minLength": 1 },
+    "description": { "type": "string" },
+    "regulatoryLine": { "type": "string", "minLength": 1, "description": "One sentence, aligned with and never compliant." },
+    "baseline": { "type": "string", "pattern": "^[a-z][a-z0-9-]*@[0-9]+$" },
+    "roles": { "type": "array", "minItems": 1, "items": { "enum": ["passport-writer", "attestation-issuer", "registry", "passport-reader"] } },
+    "applicability": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["categories", "jurisdictions", "statements"],
+      "properties": {
+        "categories": { "type": "array", "items": { "$ref": "#/$defs/option" } },
+        "categoryKey": { "type": "string", "description": "The payload key that names the product category the applicability rules read." },
+        "jurisdictions": { "type": "array", "items": { "type": "string" } },
+        "statements": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["text", "status"],
+            "properties": {
+              "text": { "type": "string", "minLength": 1 },
+              "status": { "enum": ["enacted", "anticipated", "needs-review"] },
+              "source": { "type": "string" },
+              "effectiveDate": { "type": "string", "format": "date" }
+            }
+          }
+        }
+      }
+    },
+    "schemaDialect": { "const": "https://json-schema.org/draft/2020-12/schema" },
+    "schemaUri": { "type": "string", "minLength": 1, "description": "The generated JSON Schema for the public payload." },
+    "schemaDigest": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
+    "restrictedSchemaUri": { "type": "string", "minLength": 1, "description": "The generated JSON Schema for the off-chain restricted tiers." },
+    "restrictedSchemaDigest": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
+    "contextRefs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "name", "version", "use"],
+        "properties": {
+          "id": { "type": "string" },
+          "name": { "type": "string" },
+          "version": { "type": "string" },
+          "repository": { "type": "string" },
+          "licence": { "type": "string" },
+          "retrieved": { "type": "string", "format": "date" },
+          "urnPattern": { "type": "string" },
+          "use": { "type": "string" }
+        }
+      }
+    },
+    "extends": { "type": ["string", "null"], "pattern": "^[a-z][a-z0-9-]*@[0-9]+$" },
+    "stamps": {
+      "type": "array",
+      "description": "Reserved payload keys the platform writes and a consumer must not read as product data.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["key", "description", "valueType"],
+        "properties": {
+          "key": { "type": "string" },
+          "description": { "type": "string" },
+          "valueType": { "enum": ["text", "id", "integer", "enum"] },
+          "const": { "type": ["string", "integer"] },
+          "codeList": { "$ref": "#/$defs/codeList" },
+          "pattern": { "type": "string" }
+        }
+      }
+    },
+    "fields": { "type": "array", "items": { "$ref": "#/$defs/field" } },
+    "eventMappings": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["nativeOperation", "eventType", "externalEvent", "requires", "withoutEvidence"],
+        "properties": {
+          "nativeOperation": { "enum": ["ACTIVATE", "SOLD", "RESOLD", "REPAIRED", "RECYCLED", "EDIT", "TRANSFER"] },
+          "eventType": { "enum": ["Origin", "Transfer", "Transformation", "Disposition"] },
+          "externalEvent": { "type": "string", "description": "The external lifecycle semantics the operation may map to when its evidence condition holds." },
+          "requires": { "type": "string", "description": "The evidence without which the mapping is not made." },
+          "withoutEvidence": { "enum": ["insufficient-data", "unsupported", "transformed"] }
+        }
+      }
+    },
+    "accessPolicyRef": { "type": "string" },
+    "accessTiers": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "description", "storage"],
+        "properties": {
+          "id": { "enum": ["public", "owner", "legitimate", "authority"] },
+          "description": { "type": "string" },
+          "storage": { "enum": ["on-chain public payload", "off-chain encrypted"] }
+        }
+      }
+    },
+    "sourceRefs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "name", "use"],
+        "properties": {
+          "id": { "type": "string" },
+          "name": { "type": "string" },
+          "reference": { "type": "string" },
+          "version": { "type": "string" },
+          "licence": { "type": "string" },
+          "licensedText": { "type": "boolean", "description": "True when the text is licensed and is cited by clause only, never reproduced." },
+          "use": { "type": "string" },
+          "fields": { "type": "array", "items": { "type": "string" } }
+        }
+      }
+    },
+    "groups": {
+      "type": "array",
+      "description": "Presentation grouping, informative.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "title"],
+        "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "blurb": { "type": "string" } }
+      }
+    },
+    "identity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["passportIdentifier", "granularities", "parentRelations"],
+      "properties": {
+        "passportIdentifier": { "type": "string", "description": "How the enduring passport identifier is formed for this profile." },
+        "granularities": { "type": "array", "items": { "enum": ["model", "batch", "item"] } },
+        "itemIdentifier": { "type": "string", "description": "The field key that identifies the one physical unit, when the profile declares one." },
+        "modelIdentifier": { "type": "string" },
+        "batchIdentifier": { "type": "string" },
+        "parentRelations": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["child", "parent"],
+            "properties": { "child": { "enum": ["item", "batch"] }, "parent": { "enum": ["model", "batch"] } }
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "option": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["value", "label"],
+      "properties": { "value": { "type": "string" }, "label": { "type": "string" } }
+    },
+    "codeList": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["closed", "options"],
+      "properties": {
+        "closed": { "type": "boolean", "description": "True: a value outside the options is invalid. False: the list is what is known in practice and a value outside it is valid." },
+        "options": { "type": "array", "items": { "$ref": "#/$defs/option" } }
+      }
+    },
+    "valueType": {
+      "enum": ["id", "text", "enum", "multi", "decimal", "integer", "percent", "monthYear", "date", "url", "document", "graphic", "country", "record", "any"]
+    },
+    "constraints": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "minimum": { "type": "number" },
+        "maximum": { "type": "number" },
+        "step": { "type": "number" },
+        "pattern": { "type": "string" },
+        "patternHint": { "type": "string" },
+        "maxLength": { "type": "integer", "minimum": 1 }
+      }
+    },
+    "part": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "label", "valueType"],
+      "properties": {
+        "key": { "type": "string" },
+        "label": { "type": "string" },
+        "valueType": { "enum": ["text", "decimal", "percent", "integer", "enum", "country"] },
+        "unit": { "type": "string" },
+        "codeList": { "$ref": "#/$defs/codeList" },
+        "constraints": { "$ref": "#/$defs/constraints" },
+        "required": { "type": "boolean" }
+      }
+    },
+    "applicabilityRule": {
+      "description": "always: the field applies. category-in: it applies only to the named categories. needs-review: an obligation holds only under a condition a form cannot decide, stated in words; a consumer shows it and never reads it as satisfied or as universally required.",
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["rule"],
+          "properties": { "rule": { "const": "always" } }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["rule", "categories"],
+          "properties": {
+            "rule": { "const": "category-in" },
+            "categories": { "type": "array", "minItems": 1, "items": { "type": "string" } }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["rule", "condition"],
+          "properties": {
+            "rule": { "const": "needs-review" },
+            "condition": { "type": "string", "minLength": 1 },
+            "categories": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "Narrows the categories the review concerns." }
+          }
+        }
+      ]
+    },
+    "field": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "pointer", "label", "valueType", "cardinality", "granularity", "provenance", "accessTier", "obligation", "legalBasis", "applicability"],
+      "properties": {
+        "key": { "type": "string", "minLength": 1 },
+        "pointer": { "type": "string", "pattern": "^/" },
+        "label": { "type": "string" },
+        "semanticUri": { "type": "string" },
+        "valueType": { "$ref": "#/$defs/valueType" },
+        "unit": { "type": "string" },
+        "codeList": { "$ref": "#/$defs/codeList" },
+        "constraints": { "$ref": "#/$defs/constraints" },
+        "cardinality": { "enum": ["one", "many"] },
+        "granularity": { "enum": ["model", "batch", "item"] },
+        "provenance": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["capture"],
+          "properties": {
+            "capture": { "enum": ["form", "brand", "platform", "event", "derived", "deferred"] },
+            "dynamic": { "type": "boolean" },
+            "prose": { "type": "boolean" },
+            "onLabel": { "type": "boolean" },
+            "needsBms": { "type": "boolean" },
+            "kind": { "enum": ["fact", "declaration", "calculation", "assessment"], "description": "What the value is: a recorded fact, the maker's declaration, a calculated figure or a third party's assessment." }
+          }
+        },
+        "accessTier": { "enum": ["public", "owner", "legitimate", "authority"] },
+        "obligation": { "enum": ["required", "recommended", "optional"] },
+        "legalBasis": { "type": "string", "minLength": 1, "description": "The instrument that asks for the value, or the plain statement that none does. Separate from obligation." },
+        "applicability": { "$ref": "#/$defs/applicabilityRule" },
+        "sourceRefs": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["source"],
+            "properties": { "source": { "type": "string" }, "clause": { "type": "string" }, "name": { "type": "string" }, "property": { "type": "string" } }
+          }
+        },
+        "awaitingAct": { "type": "string" },
+        "supersedes": { "type": "string", "description": "The previous version's key this field replaces." },
+        "group": { "type": "string" },
+        "parts": { "type": "array", "items": { "$ref": "#/$defs/part" } },
+        "note": { "type": "string" }
+      }
+    }
+  }
+}