@bsv/dpp-core 0.3.0-beta.1

package/schemas/paginated-history.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/contracts/paginated-history.schema.json",
+  "title": "DPP paginated history page, version 1",
+  "description": "One page of an export over a stable snapshot (spec/portable-evidence.md section 1). An extension a service serves beside the standard bounded lookups, never in place of them; completeness is relative to the snapshot's scope.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["pageVersion", "items", "nextCursor", "snapshotId", "scope", "truncated", "completeForSnapshot"],
+  "properties": {
+    "pageVersion": { "const": "1" },
+    "items": { "type": "array", "maxItems": 500 },
+    "nextCursor": { "type": ["string", "null"], "description": "Opaque, bound to the query and the snapshot; null when exhausted." },
+    "snapshotId": { "type": "string", "minLength": 1 },
+    "scope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["source", "query"],
+      "properties": {
+        "source": { "type": "string", "description": "The service or topic answered from." },
+        "query": { "type": "object" },
+        "sequenceRange": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": { "from": { "type": "integer", "minimum": 0 }, "to": { "type": "integer", "minimum": 0 } }
+        }
+      }
+    },
+    "truncated": { "type": "boolean" },
+    "completeForSnapshot": { "type": "boolean" },
+    "pageSize": { "type": "integer", "minimum": 1, "maximum": 500 }
+  }
+}

package/schemas/passport-projection.schema.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/contracts/passport-projection.schema.json",
+  "title": "DPP passport projection, version 1",
+  "description": "passport-projection@1 (spec/passport-projections.md section 4): the deterministic derivation of one passport's fields from pinned source revisions, accepted relationships and a named policy, at a stated cutoff and for a stated audience. A data projection envelope with its own identity and digest; not a token format, not a credential, and never carrying a proof copied from a source. The same pinned inputs produce the same projectionDigest whatever the arrival order.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["projectionId", "projectionVersion", "projectionDigest", "passportId", "subjectId", "granularity", "profileRef", "sourceRefs", "relationshipRefs", "policyRef", "asOf", "disclosureScope", "values", "fieldResults", "evidenceRefs", "validationRefs"],
+  "properties": {
+    "projectionId": { "type": "string", "pattern": "^urn:bsv:dpp:projection:sha256:[0-9a-f]{64}$", "description": "Derived from projectionDigest; never a secured-source digest." },
+    "projectionVersion": { "const": "1" },
+    "projectionDigest": { "$ref": "#/$defs/hex64", "description": "SHA-256 of the RFC 8785 canonical JSON of the commitment body: every property of this document except projectionId, projectionDigest, diagnostics and template." },
+    "passportId": { "type": "string", "minLength": 1, "maxLength": 512 },
+    "subjectId": { "type": "string", "minLength": 1, "maxLength": 512 },
+    "granularity": { "enum": ["model", "batch", "item"] },
+    "profileRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version"],
+      "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" }, "version": { "type": "integer", "minimum": 1 } }
+    },
+    "sourceRefs": {
+      "type": "array",
+      "description": "Every source revision the projection read, sorted by record then revision identifier.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["recordId", "revisionId", "digest"],
+        "properties": {
+          "recordId": { "type": "string", "minLength": 1 },
+          "revisionId": { "type": "string", "minLength": 1 },
+          "digest": { "$ref": "#/$defs/hex64" },
+          "subjectId": { "type": "string", "minLength": 1 },
+          "granularity": { "enum": ["model", "batch", "item", "component"] },
+          "pointer": { "type": "string" }
+        }
+      }
+    },
+    "relationshipRefs": {
+      "type": "array",
+      "description": "Every accepted relationship the projection followed, sorted by identifier.",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["relationshipId", "kind", "sourceId", "targetId"],
+        "properties": {
+          "relationshipId": { "type": "string", "minLength": 1 },
+          "kind": { "enum": ["instance-of-model", "member-of-batch", "component-of", "successor-of"] },
+          "sourceId": { "type": "string", "minLength": 1 },
+          "targetId": { "type": "string", "minLength": 1 },
+          "policyRef": { "type": "string" }
+        }
+      }
+    },
+    "policyRef": { "type": "string", "minLength": 1 },
+    "asOf": { "type": ["string", "null"], "description": "The historical cutoff sources and measurements were selected at, or null when none was selected." },
+    "disclosureScope": { "enum": ["public", "owner", "legitimate", "authority"] },
+    "values": {
+      "type": "object",
+      "description": "The derived value of each field that has one, keyed by field key.",
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["value", "source", "granularity"],
+        "properties": {
+          "value": {},
+          "source": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["recordId", "revisionId", "pointer"],
+            "properties": {
+              "recordId": { "type": "string", "minLength": 1 },
+              "revisionId": { "type": "string", "minLength": 1 },
+              "pointer": { "type": "string" }
+            }
+          },
+          "granularity": { "enum": ["model", "batch", "item", "component"] },
+          "language": { "type": "string" },
+          "selection": { "enum": ["exact", "base", "default"] },
+          "conversion": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["fromUnit", "toUnit", "rule", "explicit"],
+            "properties": {
+              "fromUnit": { "type": "string" },
+              "toUnit": { "type": "string" },
+              "rule": { "type": "string" },
+              "explicit": { "const": true }
+            }
+          },
+          "observedAt": { "type": "string" },
+          "method": { "type": "string" }
+        }
+      }
+    },
+    "fieldResults": {
+      "type": "object",
+      "description": "One result per field the profile declares, keyed by field key: availability, applicability and any finding, on separate axes.",
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["availability", "applicability"],
+        "properties": {
+          "availability": { "enum": ["present", "missing", "unknown", "withheld"] },
+          "applicability": { "enum": ["applies", "not-applicable", "unresolved"] },
+          "finding": { "enum": ["conflict", "unsupported", "limit", "cycle", "missing-source"] },
+          "conflicts": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["recordId", "revisionId", "value"],
+              "properties": {
+                "recordId": { "type": "string" },
+                "revisionId": { "type": "string" },
+                "value": {}
+              }
+            }
+          },
+          "reason": { "type": "string" },
+          "excluded": {
+            "type": "array",
+            "description": "Measurements or sources set aside with the reason, so the history stays inspectable.",
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["recordId", "revisionId", "reason"],
+              "properties": { "recordId": { "type": "string" }, "revisionId": { "type": "string" }, "reason": { "type": "string" } }
+            }
+          }
+        }
+      }
+    },
+    "evidenceRefs": { "type": "array", "items": { "type": "string", "minLength": 1 } },
+    "validationRefs": { "type": "array", "items": { "type": "string", "minLength": 1 } },
+    "diagnostics": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Outside the commitment: what the derivation ran into.",
+      "properties": {
+        "truncated": { "type": "boolean" },
+        "limits": { "type": "object", "additionalProperties": { "type": "integer" } },
+        "findings": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["code", "detail"], "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "detail": { "type": "string" } } } }
+      }
+    },
+    "template": { "type": "string", "description": "Outside the commitment: the rendering preset a surface applied, if any." }
+  },
+  "$defs": {
+    "hex64": { "type": "string", "pattern": "^[0-9a-f]{64}$" }
+  }
+}

package/schemas/passport-source.schema.json

@@ -0,0 +1,370 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/contracts/passport-source.schema.json",
+  "title": "DPP passport source revision and relationship, version 1",
+  "description": "The two records a passport's facts are derived from (spec/passport-projections.md sections 2 and 3): an immutable source revision of a model, batch, item or component record, and a typed relationship between subjects. Revisions are append-only; a current pointer moves by compare-and-swap and never rewrites a revision. A relationship is an accepted assertion under a named policy, kept apart from any source event's own edges.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/sourceRevision"
+    },
+    {
+      "$ref": "#/$defs/relationship"
+    }
+  ],
+  "$defs": {
+    "hex64": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    },
+    "dateTime": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"
+    },
+    "dateOrDateTime": {
+      "type": "string",
+      "pattern": "^\\d{4}(-(0[1-9]|1[0-2])(-(0[1-9]|[12]\\d|3[01])(T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2}))?)?)?$"
+    },
+    "subjectRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "granularity"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "granularity": {
+          "enum": [
+            "model",
+            "batch",
+            "item",
+            "component"
+          ]
+        }
+      }
+    },
+    "revisionRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "revisionId"
+      ],
+      "properties": {
+        "recordId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "revisionId": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "interval": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "from": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "until": {
+          "$ref": "#/$defs/dateOrDateTime"
+        }
+      }
+    },
+    "sourceRevision": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "recordId",
+        "revisionId",
+        "subject",
+        "profileRef",
+        "recordedAt",
+        "payloadDigest",
+        "authorisation",
+        "disclosure"
+      ],
+      "properties": {
+        "recordId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The stable identifier of the record the revision belongs to."
+        },
+        "revisionId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Unique within the record; a revision is never edited or deleted, only superseded."
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "profileRef": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "id",
+            "version"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^[a-z][a-z0-9-]*$"
+            },
+            "version": {
+              "type": "integer",
+              "minimum": 1
+            }
+          }
+        },
+        "recordedAt": {
+          "$ref": "#/$defs/dateTime"
+        },
+        "effective": {
+          "$ref": "#/$defs/interval",
+          "description": "When the facts hold, where the source says so; distinct from when they were recorded."
+        },
+        "payloadDigest": {
+          "$ref": "#/$defs/hex64",
+          "description": "SHA-256 of the payload's exact bytes as retained."
+        },
+        "payload": {
+          "type": "object",
+          "description": "The payload when carried inline; keys are the profile's field keys."
+        },
+        "payloadRef": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "uri"
+          ],
+          "properties": {
+            "uri": {
+              "type": "string",
+              "minLength": 1
+            },
+            "byteLength": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "mediaType": {
+              "type": "string"
+            }
+          }
+        },
+        "authorisation": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "policyId"
+          ],
+          "description": "Who was entitled to write this revision and under which policy. migration-unknown-ancestry marks a legacy copy whose provenance is not known and is never invented.",
+          "properties": {
+            "kind": {
+              "enum": [
+                "registration",
+                "import",
+                "migration-unknown-ancestry",
+                "operator"
+              ]
+            },
+            "principal": {
+              "type": "string",
+              "minLength": 1
+            },
+            "evidenceRef": {
+              "type": "string",
+              "minLength": 1
+            },
+            "policyId": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "disclosure": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "policyId",
+            "scope"
+          ],
+          "properties": {
+            "policyId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "scope": {
+              "enum": [
+                "public",
+                "owner",
+                "legitimate",
+                "authority"
+              ]
+            }
+          }
+        },
+        "supersedes": {
+          "$ref": "#/$defs/revisionRef"
+        },
+        "sourceRefs": {
+          "type": "array",
+          "description": "Where the values came from, when the revision was derived from a retained source such as an import: opaque pointers, never the source bytes.",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      }
+    },
+    "relationship": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "relationshipId",
+        "kind",
+        "source",
+        "target",
+        "evidence",
+        "policyRef"
+      ],
+      "properties": {
+        "relationshipId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "kind": {
+          "enum": [
+            "instance-of-model",
+            "member-of-batch",
+            "component-of",
+            "successor-of"
+          ]
+        },
+        "source": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "target": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "evidence": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "What the assertion rests on: a source revision, a credential or a retained source event. At least one is named.",
+          "minProperties": 1,
+          "properties": {
+            "sourceRevision": {
+              "$ref": "#/$defs/revisionRef"
+            },
+            "credentialRef": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "id"
+              ],
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "digest": {
+                  "$ref": "#/$defs/hex64"
+                }
+              }
+            },
+            "eventRef": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "importId",
+                "eventRef"
+              ],
+              "properties": {
+                "importId": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "eventRef": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            }
+          }
+        },
+        "effective": {
+          "$ref": "#/$defs/interval"
+        },
+        "policyRef": {
+          "type": "string",
+          "minLength": 1
+        },
+        "quantities": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "For component-of only: the quantities the accepted assertion covers. A source event's own input and output quantities stay on the event and are not copied here.",
+          "properties": {
+            "input": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "value",
+                "unit"
+              ],
+              "properties": {
+                "value": {
+                  "type": "number"
+                },
+                "unit": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            },
+            "output": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "value",
+                "unit"
+              ],
+              "properties": {
+                "value": {
+                  "type": "number"
+                },
+                "unit": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            }
+          }
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "not": {
+                  "const": "component-of"
+                }
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "quantities": false
+            }
+          }
+        }
+      ]
+    }
+  }
+}