@bsv/dpp-profiles 0.3.0-beta.1

package/schemas/interoperability-profile.schema.json

@@ -0,0 +1,347 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/profiles/schemas/interoperability-profile.schema.json",
+  "title": "DPP interoperability profile manifest, version 1",
+  "description": "One named, versioned selection of how a passport is discovered, how source events are exchanged, or how a source event is mapped into an existing credential profile (spec/gs1-discovery.md, spec/epcis-interoperability.md). Neither an industry profile nor a signed credential format: it records the role, the standards and artefact versions it pins, the formats it accepts and produces, its dependencies, its resource limits, what it cannot map and what it does not support. An artefact without a digest is recorded as not retrieved and supports no claim.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "manifestVersion",
+    "id",
+    "version",
+    "profile",
+    "kind",
+    "role",
+    "status",
+    "title",
+    "standards",
+    "artefacts",
+    "inputs",
+    "outputs",
+    "dependencies",
+    "limits",
+    "mappingLimits",
+    "unsupported",
+    "sourceRefs"
+  ],
+  "properties": {
+    "manifestVersion": {
+      "const": "1"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9.-]*$"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9][0-9a-z.-]*$"
+    },
+    "profile": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9.-]*@[0-9][0-9a-z.-]*$"
+    },
+    "kind": {
+      "const": "interoperability"
+    },
+    "role": {
+      "enum": [
+        "discovery",
+        "source-exchange",
+        "mapping"
+      ],
+      "description": "discovery: resolving an identifier to services. source-exchange: importing, querying, retaining and exporting source documents. mapping: projecting a retained source into an existing credential or data profile."
+    },
+    "status": {
+      "enum": [
+        "proposed",
+        "current",
+        "superseded"
+      ]
+    },
+    "supersededBy": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9.-]*@[0-9][0-9a-z.-]*$"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "specification": {
+      "type": "string",
+      "description": "Where in spec/ the profile's normative behaviour is defined."
+    },
+    "standards": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "name",
+          "version",
+          "uri"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "uri": {
+            "type": "string"
+          },
+          "scope": {
+            "type": "string",
+            "description": "The clauses or capabilities of the standard this profile claims, in words."
+          }
+        }
+      }
+    },
+    "artefacts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "kind",
+          "uri",
+          "version",
+          "retrieval"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "kind": {
+            "enum": [
+              "json-schema",
+              "jsonld-context",
+              "openapi",
+              "vocabulary",
+              "specification",
+              "grammar"
+            ]
+          },
+          "uri": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "digest": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{64}$"
+          },
+          "byteLength": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "retrieval": {
+            "enum": [
+              "pinned",
+              "not-retrieved",
+              "unavailable",
+              "owned"
+            ],
+            "description": "pinned: digest computed over retrieved bytes. not-retrieved: documented location, no bytes fetched. unavailable: the upstream location does not serve it. owned: published by this repository."
+          },
+          "carried": {
+            "type": "string",
+            "description": "The package path the pinned bytes are carried at, when they are."
+          },
+          "licence": {
+            "type": "string"
+          },
+          "notes": {
+            "type": "string"
+          }
+        },
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "retrieval": {
+                  "const": "pinned"
+                }
+              }
+            },
+            "then": {
+              "properties": {
+                "digest": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "digest"
+              ]
+            }
+          }
+        ]
+      }
+    },
+    "inputs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/format"
+      }
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/format"
+      }
+    },
+    "dependencies": {
+      "type": "array",
+      "description": "The maintained implementations this profile's reference code relies on, with the exact version tested; an empty list means the reference code is self-contained.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "name",
+          "version"
+        ],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "licence": {
+            "type": "string"
+          },
+          "use": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "limits": {
+      "type": "object",
+      "description": "Named resource limits the reference implementation enforces and discloses, for example maxDocumentBytes, maxEventsPerPage, maxJsonDepth, fetchTimeoutMs.",
+      "additionalProperties": {
+        "type": [
+          "integer",
+          "string"
+        ]
+      }
+    },
+    "mappingLimits": {
+      "type": "array",
+      "description": "What this profile cannot express losslessly, each named so a mapping result can cite it.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "outcome",
+          "reason"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "outcome": {
+            "enum": [
+              "transformed",
+              "unsupported",
+              "insufficient-data"
+            ]
+          },
+          "reason": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "unsupported": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "reason"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "reason": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "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"
+          },
+          "attribution": {
+            "type": "string"
+          },
+          "use": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "$defs": {
+    "format": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "mediaType",
+        "format"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "mediaType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "format": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The document or message shape, for example EPCISDocument, EPCISQueryDocument, GS1 linkset, resolver description file."
+        },
+        "notes": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/schemas/operator-profile.schema.json

@@ -0,0 +1,108 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/profiles/schemas/operator-profile.schema.json",
+  "title": "DPP operator profile manifest, version 1",
+  "description": "One named operator configuration (spec/services.md, spec/conformance.md section 4): how an overlay or registry admits, discovers, synchronises and retains evidence and authorises publishers, and the exercises a deployment passes before it may claim the profile.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["manifestVersion", "id", "version", "profile", "kind", "status", "title", "roles", "admission", "publisherPolicy", "discovery", "synchronisation", "retention", "capabilities", "acceptance", "unsupported"],
+  "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": "operator" },
+    "status": { "enum": ["proposed", "current", "superseded"] },
+    "title": { "type": "string", "minLength": 1 },
+    "description": { "type": "string" },
+    "roles": { "type": "array", "minItems": 1, "items": { "enum": ["overlay", "registry"] } },
+    "admission": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["topics", "nativeRules", "idempotent"],
+      "properties": {
+        "topics": { "type": "array", "items": { "type": "string" } },
+        "nativeRules": { "type": "string" },
+        "idempotent": { "const": true },
+        "ownerConsent": { "enum": ["not-selected", "required", "deployment-choice"] }
+      }
+    },
+    "publisherPolicy": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["separateFromOperatorIdentity", "keySet", "historicalAuthorisation", "handover"],
+      "properties": {
+        "separateFromOperatorIdentity": { "const": true },
+        "keySet": { "type": "string", "description": "How the accepted publisher keys are configured, versioned, activated and retired." },
+        "historicalAuthorisation": { "type": "string", "description": "How a state's publisher signature is checked against the key that was authorised at its time, never against the current allowlist alone." },
+        "handover": { "type": "string", "description": "What a publisher handover requires, and what it can never do to the spending key." }
+      }
+    },
+    "discovery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode"],
+      "properties": {
+        "mode": { "enum": ["none", "ship-slap", "static-peers"] },
+        "notes": { "type": "string" }
+      }
+    },
+    "synchronisation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode", "genesisFirst", "deduplication", "proofUpdates", "checkpoints", "bounds"],
+      "properties": {
+        "mode": { "enum": ["none", "gasp", "static-peer-backfill"] },
+        "genesisFirst": { "const": true },
+        "deduplication": { "type": "string" },
+        "proofUpdates": { "type": "string" },
+        "checkpoints": { "type": "string" },
+        "bounds": { "type": "string" },
+        "reorganisation": { "type": "string" }
+      }
+    },
+    "retention": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["spentStates", "anchorLeaves", "bytes"],
+      "properties": {
+        "spentStates": { "type": "string" },
+        "anchorLeaves": { "type": "string" },
+        "bytes": { "type": "string" }
+      }
+    },
+    "capabilities": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["document", "mustDeclare"],
+      "properties": {
+        "document": { "type": "string", "description": "The capability document schema the deployment serves." },
+        "mustDeclare": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "acceptance": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "exercise", "evidence", "independence"],
+        "properties": {
+          "id": { "type": "string" },
+          "exercise": { "type": "string" },
+          "evidence": { "type": "string" },
+          "independence": { "enum": ["local", "independently-administered"], "description": "local: two processes under one administration prove the mechanism. independently-administered: separate organisations, credentials and databases, which no local run can substitute for." }
+        }
+      }
+    },
+    "unsupported": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "reason"],
+        "properties": { "id": { "type": "string" }, "reason": { "type": "string" } }
+      }
+    }
+  }
+}

package/schemas/product-identity.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/profiles/schemas/product-identity.schema.json",
+  "title": "DPP product identity, version 1",
+  "description": "The three granularities a passport may relate (spec/profiles.md section 5): the model a manufacturer designs, the batch a production run produces and the item one physical unit is, with the enduring passport identifier that never changes and the resolver location that may.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["passportId", "item"],
+  "properties": {
+    "passportId": { "type": "string", "minLength": 1, "maxLength": 512, "description": "The enduring passport identifier, exactly as field 3 of the record carries it." },
+    "genesisOutpoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["txid", "outputIndex"],
+      "properties": { "txid": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "outputIndex": { "type": "integer", "minimum": 0 } }
+    },
+    "item": { "$ref": "#/$defs/identifier" },
+    "batch": { "$ref": "#/$defs/identifier" },
+    "model": { "$ref": "#/$defs/identifier" },
+    "resolver": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Mutable service metadata: where the identifier is answered today. A change here changes nothing about the identity or the history.",
+      "properties": {
+        "host": { "type": "string", "format": "hostname" },
+        "linkSet": { "type": "string", "format": "uri" },
+        "recordedAt": { "type": "string", "format": "date-time" }
+      }
+    }
+  },
+  "$defs": {
+    "identifier": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["scheme", "value"],
+      "properties": {
+        "scheme": { "type": "string", "minLength": 1, "description": "For example gs1-gtin, gs1-sgtin, gs1-digital-link, iso-15459, vendor." },
+        "value": { "type": "string", "minLength": 1 },
+        "authority": { "type": "string", "description": "Who allocated the identifier, when known independently. Syntax never proves allocation." },
+        "checkDigitValid": { "type": "boolean", "description": "For GS1 keys: whether the check digit holds. A writer keeps it true; a reader records what it found." },
+        "demonstration": { "type": "boolean", "description": "True when the GS1 prefix is 952, the prefix reserved for demonstrations and examples, so nothing real stands behind the record." }
+      }
+    }
+  }
+}