@bsv/dpp-core 0.3.0-beta.1

package/schemas/profile-evidence.schema.json

@@ -0,0 +1,706 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/contracts/profile-evidence.schema.json",
+  "title": "DPP profile evidence shapes, version 1",
+  "description": "The shared shapes an industry profile field or a passport projection carries when a value is more than a scalar (spec/passport-projections.md section 5): a claim's evidence, a certification, a measurement or assessment, a related document, a language-tagged text, a date with its precision, and warranty terms with a derived expiry. Reused by profile manifests of version 2 through their value types and by passport-projection@1. None of these is a credential format and none makes a value true: a scheme homepage or an issuer signature alone never proves a certification valid, a document URL is not a content commitment, and a date is never made more precise than its source.",
+  "type": "object",
+  "$defs": {
+    "datePrecision": {
+      "enum": [
+        "day",
+        "month",
+        "year"
+      ],
+      "description": "How precise a date is. A month-precision date is written YYYY-MM and never given a day; a year-precision date is written YYYY."
+    },
+    "hex64": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    },
+    "dayDate": {
+      "type": "string",
+      "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
+    },
+    "monthDate": {
+      "type": "string",
+      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
+    },
+    "yearDate": {
+      "type": "string",
+      "pattern": "^\\d{4}$"
+    },
+    "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}))?)?)?$",
+      "description": "A year, a month, a day or an instant; the precision the shape declares says which is meant."
+    },
+    "preciseDate": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "date",
+        "precision"
+      ],
+      "properties": {
+        "date": {
+          "type": "string"
+        },
+        "precision": {
+          "$ref": "#/$defs/datePrecision"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "precision": {
+                "const": "day"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "date": {
+                "$ref": "#/$defs/dayDate"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "precision": {
+                "const": "month"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "date": {
+                "$ref": "#/$defs/monthDate"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "precision": {
+                "const": "year"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "date": {
+                "$ref": "#/$defs/yearDate"
+              }
+            }
+          }
+        }
+      ]
+    },
+    "subjectRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "granularity"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512
+        },
+        "granularity": {
+          "enum": [
+            "model",
+            "batch",
+            "item",
+            "component"
+          ]
+        },
+        "componentRef": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 512,
+          "description": "The component this evidence covers, when the granularity is component; a component need not have a token."
+        }
+      }
+    },
+    "sourceRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "id"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "source-revision",
+            "credential",
+            "document"
+          ]
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "revisionId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "digest": {
+          "$ref": "#/$defs/hex64"
+        }
+      }
+    },
+    "relevantTime": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "precision"
+      ],
+      "properties": {
+        "at": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "from": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "until": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "precision": {
+          "$ref": "#/$defs/datePrecision"
+        }
+      }
+    },
+    "claimEvidence": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "property",
+        "subject",
+        "source"
+      ],
+      "properties": {
+        "property": {
+          "type": "string",
+          "pattern": "^/",
+          "description": "The JSON pointer of the field the evidence is about."
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "source": {
+          "$ref": "#/$defs/sourceRef"
+        },
+        "reporter": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Who reported the fact, when that is not the issuer of the source."
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1
+        },
+        "relevantTime": {
+          "$ref": "#/$defs/relevantTime"
+        },
+        "reportRef": {
+          "type": "string",
+          "minLength": 1,
+          "description": "A verification report the evidence was evaluated in."
+        }
+      }
+    },
+    "certification": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "scheme",
+        "certificateId",
+        "issuer",
+        "subject",
+        "verification"
+      ],
+      "description": "A certificate as evidence. The scheme's homepage and the issuer's signature are inputs to a verification; only verification.status says what was established, and unknown is not a pass.",
+      "properties": {
+        "scheme": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "id",
+            "name"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 1
+            },
+            "name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "version": {
+              "type": "string"
+            }
+          }
+        },
+        "certificateId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "issuer": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The certification body or issuer as named on the certificate."
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "validFrom": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "validUntil": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "precision": {
+          "$ref": "#/$defs/datePrecision"
+        },
+        "documentRef": {
+          "$ref": "#/$defs/relatedDocument"
+        },
+        "credentialRef": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "id"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 1
+            },
+            "digest": {
+              "$ref": "#/$defs/hex64"
+            }
+          }
+        },
+        "verification": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "status"
+          ],
+          "properties": {
+            "status": {
+              "enum": [
+                "verified",
+                "failed",
+                "unknown",
+                "not-checked"
+              ]
+            },
+            "checkedAt": {
+              "$ref": "#/$defs/dateOrDateTime"
+            },
+            "reportRef": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      }
+    },
+    "quantity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "value",
+        "unit"
+      ],
+      "properties": {
+        "value": {
+          "type": "number"
+        },
+        "unit": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "measurement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "property",
+        "value",
+        "unit",
+        "subject"
+      ],
+      "description": "A measured or assessed value with the scope that makes it comparable: the unit, the basis (a fraction is not a percent), the functional unit or denominator, the method and its version, the boundary and conditions, when it was measured and for which subject. A value that is a string carries a basis, because a bare string cannot be compared.",
+      "properties": {
+        "property": {
+          "type": "string",
+          "minLength": 1
+        },
+        "value": {
+          "type": [
+            "number",
+            "string"
+          ]
+        },
+        "unit": {
+          "type": "string",
+          "minLength": 1
+        },
+        "basis": {
+          "$ref": "#/$defs/measurementBasis"
+        },
+        "functionalUnit": {
+          "type": "string",
+          "minLength": 1
+        },
+        "denominator": {
+          "$ref": "#/$defs/quantity"
+        },
+        "method": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "id"
+          ],
+          "properties": {
+            "id": {
+              "type": "string",
+              "minLength": 1
+            },
+            "version": {
+              "type": "string"
+            }
+          }
+        },
+        "boundary": {
+          "type": "string",
+          "minLength": 1
+        },
+        "conditions": {
+          "type": "string",
+          "minLength": 1
+        },
+        "measuredAt": {
+          "$ref": "#/$defs/preciseDate"
+        },
+        "effective": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "from": {
+              "$ref": "#/$defs/dateOrDateTime"
+            },
+            "until": {
+              "$ref": "#/$defs/dateOrDateTime"
+            }
+          }
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectRef"
+        },
+        "evidence": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/claimEvidence"
+          }
+        },
+        "conversion": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "fromUnit",
+            "toUnit",
+            "rule",
+            "explicit"
+          ],
+          "description": "Present only when the value was converted from its source unit under a stated rule; a converted value never loses its source unit.",
+          "properties": {
+            "fromUnit": {
+              "type": "string",
+              "minLength": 1
+            },
+            "toUnit": {
+              "type": "string",
+              "minLength": 1
+            },
+            "rule": {
+              "type": "string",
+              "minLength": 1
+            },
+            "explicit": {
+              "const": true
+            }
+          }
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "value": {
+                "type": "string"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "basis": {
+                "$ref": "#/$defs/measurementBasis"
+              }
+            },
+            "required": [
+              "basis"
+            ]
+          }
+        }
+      ]
+    },
+    "relatedDocument": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ref",
+        "purpose",
+        "retained",
+        "access"
+      ],
+      "description": "A document a value points at. A URL is where the document was seen, not a commitment to its content; only retained bytes carry a digest.",
+      "properties": {
+        "ref": {
+          "type": "string",
+          "minLength": 1
+        },
+        "purpose": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        },
+        "mediaType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "language": {
+          "type": "string",
+          "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
+        },
+        "revision": {
+          "type": "string"
+        },
+        "date": {
+          "$ref": "#/$defs/dateOrDateTime"
+        },
+        "precision": {
+          "$ref": "#/$defs/datePrecision"
+        },
+        "digest": {
+          "$ref": "#/$defs/hex64"
+        },
+        "byteLength": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retained": {
+          "type": "boolean"
+        },
+        "access": {
+          "enum": [
+            "public",
+            "owner",
+            "legitimate",
+            "authority"
+          ]
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "retained": {
+                "const": true
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "digest": {
+                "$ref": "#/$defs/hex64"
+              },
+              "byteLength": {
+                "type": "integer",
+                "minimum": 0
+              }
+            },
+            "required": [
+              "digest",
+              "byteLength"
+            ]
+          }
+        }
+      ]
+    },
+    "localisedText": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "values"
+      ],
+      "description": "Text in one or more languages as the source supplied it. A reader selects the exact tag, then the base language, then the declared default, and records which; it never rewrites a value as another language.",
+      "properties": {
+        "values": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "language",
+              "text"
+            ],
+            "properties": {
+              "language": {
+                "type": "string",
+                "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
+              },
+              "text": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "returnedLanguage": {
+          "type": "string",
+          "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
+        },
+        "selection": {
+          "enum": [
+            "exact",
+            "base",
+            "default"
+          ]
+        }
+      }
+    },
+    "warrantyTerms": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "duration",
+        "calendarRule"
+      ],
+      "description": "A model's warranty terms: a duration and the calendar rule that says what the duration counts from. Terms alone give no expiry.",
+      "properties": {
+        "duration": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "value",
+            "unit"
+          ],
+          "properties": {
+            "value": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "unit": {
+              "enum": [
+                "months",
+                "years"
+              ]
+            }
+          }
+        },
+        "calendarRule": {
+          "enum": [
+            "purchase-date",
+            "manufacture-date",
+            "first-use"
+          ]
+        },
+        "conditions": {
+          "type": "string"
+        }
+      }
+    },
+    "warrantyExpiry": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "start",
+        "terms",
+        "derived"
+      ],
+      "description": "An item's derived warranty expiry: the evidenced start, the terms applied and the derived date at the precision the start permits. A month-precision start yields a month, never an invented day.",
+      "properties": {
+        "start": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "date",
+            "precision",
+            "evidenceRef"
+          ],
+          "properties": {
+            "date": {
+              "type": "string"
+            },
+            "precision": {
+              "$ref": "#/$defs/datePrecision"
+            },
+            "evidenceRef": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "terms": {
+          "$ref": "#/$defs/warrantyTerms"
+        },
+        "derived": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "date",
+            "precision",
+            "rule"
+          ],
+          "properties": {
+            "date": {
+              "type": "string"
+            },
+            "precision": {
+              "$ref": "#/$defs/datePrecision"
+            },
+            "rule": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      }
+    },
+    "measurementBasis": {
+      "enum": [
+        "fraction",
+        "percent",
+        "mass",
+        "count",
+        "per-functional-unit"
+      ]
+    }
+  }
+}