@bsv/dpp-profiles 0.3.0-beta.1

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@bsv/dpp-profiles",
+  "version": "0.3.0-beta.1",
+  "description": "Experimental prerelease: Canonical DPP industry, exchange, operator and interoperability profiles: immutable manifests, generated payload schemas and consumer documents, lifecycle mapping, GS1 identifier and discovery helpers, applicability evaluation and deterministic passport projection",
+  "license": "SEE LICENSE IN LICENSE",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./manifests/*": "./manifests/*",
+    "./schemas/*": "./schemas/*",
+    "./generated/*": "./generated/*",
+    "./frozen.json": "./frozen.json"
+  },
+  "files": [
+    "dist",
+    "manifests",
+    "schemas",
+    "generated",
+    "frozen.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/build.mjs",
+    "generate": "node scripts/build.mjs",
+    "refreeze": "node scripts/build.mjs --refreeze",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "canonicalize": "4.0.0"
+  },
+  "devDependencies": {
+    "@bsv/dpp-core": "0.3.0-beta.1",
+    "@bsv/sdk": "2.4.2",
+    "ajv": "8.20.0",
+    "ajv-formats": "3.0.1",
+    "typescript": "^5.9.3",
+    "vitest": "4.1.11"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bsv-blockchain/dpp.git",
+    "directory": "packages/dpp-profiles"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "next"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}

package/schemas/exchange-profile.schema.json

@@ -0,0 +1,134 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://bsv-blockchain.github.io/dpp/profiles/schemas/exchange-profile.schema.json",
+  "title": "DPP exchange profile manifest, version 1",
+  "description": "One credential representation beside the native record (spec/exchange.md section 2): its format, data model, pinned artefacts, proof suites, native evidence extension, anchoring rule, mappings and explicit unsupported items. An artefact without a digest is recorded as not retrieved and supports no claim.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["manifestVersion", "id", "version", "profile", "kind", "status", "title", "representation", "mediaType", "dataModel", "artefacts", "proofSuites", "anchoring", "nativeEvidenceExtension", "mappings", "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": "exchange" },
+    "status": { "enum": ["proposed", "current", "superseded"] },
+    "title": { "type": "string", "minLength": 1 },
+    "description": { "type": "string" },
+    "representation": { "type": "string", "minLength": 1, "description": "The representation identifier a reader dispatches on." },
+    "mediaType": { "type": "string", "minLength": 1 },
+    "dataModel": { "type": "string", "minLength": 1 },
+    "specification": { "type": "string", "description": "Where in spec/ the representation's byte contract is defined." },
+    "artefacts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "kind", "uri", "version", "retrieval"],
+        "properties": {
+          "id": { "type": "string" },
+          "kind": { "enum": ["json-schema", "jsonld-context", "vocabulary", "specification"] },
+          "uri": { "type": "string" },
+          "version": { "type": "string" },
+          "digest": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
+          "retrieval": { "enum": ["pinned", "not-retrieved", "unavailable", "owned"], "description": "pinned: digest computed over retrieved bytes. not-retrieved: documented location, no bytes fetched yet. unavailable: the upstream location does not serve it. owned: published by this repository." },
+          "licence": { "type": "string" },
+          "notes": { "type": "string" }
+        },
+        "allOf": [
+          { "if": { "properties": { "retrieval": { "const": "pinned" } } }, "then": { "properties": { "digest": { "type": "string" } }, "required": ["digest"] } }
+        ]
+      }
+    },
+    "proofSuites": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "support"],
+        "properties": {
+          "id": { "type": "string", "description": "For example ES256K, ES256, Ed25519Signature2020, bbs-2023, ecdsa-jcs-2019." },
+          "support": { "enum": ["issue-and-verify", "verify-only", "optional-dedicated-key", "not-supported"] },
+          "keyRule": { "type": "string", "description": "How the signing key relates to the issuer and to the BSV actor, and what it must never be derived from." },
+          "consumerMustConfirm": { "type": "boolean" },
+          "notes": { "type": "string" }
+        }
+      }
+    },
+    "anchoring": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["format", "bytesCommitted", "attestationIdRule", "subjectRule"],
+      "properties": {
+        "format": { "const": "bsv-attestation-anchor-v1" },
+        "bytesCommitted": { "type": "string" },
+        "attestationIdRule": { "type": "string" },
+        "subjectRule": { "type": "string" },
+        "attestationType": { "type": "string" }
+      }
+    },
+    "nativeEvidenceExtension": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schema", "version", "carried"],
+      "properties": {
+        "schema": { "type": "string" },
+        "version": { "type": "string" },
+        "carried": { "enum": ["required", "optional", "not-applicable"] },
+        "notes": { "type": "string" }
+      }
+    },
+    "mappings": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["nativeOperation", "externalEvent", "requires", "withoutEvidence"],
+        "properties": {
+          "nativeOperation": { "enum": ["ACTIVATE", "SOLD", "RESOLD", "REPAIRED", "RECYCLED", "EDIT", "TRANSFER"] },
+          "externalEvent": { "type": "string" },
+          "requires": { "type": "string" },
+          "withoutEvidence": { "enum": ["insufficient-data", "unsupported", "transformed"] }
+        }
+      }
+    },
+    "storage": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The four artefacts of spec/exchange.md section 3, named so a consumer implements them separately.",
+      "required": ["nativeClaim", "originalSecured", "decoded", "projection"],
+      "properties": {
+        "nativeClaim": { "type": "string" },
+        "originalSecured": { "type": "string" },
+        "decoded": { "type": "string" },
+        "projection": { "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" }
+        }
+      }
+    }
+  }
+}

package/schemas/gs1/NOTICE.md

@@ -0,0 +1,11 @@
+# GS1-Conformant Resolver artefacts
+
+The linkset schema, resolver description file schema and linkset context of the GS1-Conformant Resolver standard, retrieved unchanged from ref.gs1.org on 6 September 2026 and carried here so a resolver descriptor and a linkset can be validated against the published bytes without a network fetch. GS1 is the publisher and rights holder; the files are used under GS1's terms for its published standards artefacts (https://ref.gs1.org/standards/resolver/) and are not part of this repository's licence.
+
+| File | Source URI | SHA-256 | Bytes |
+| --- | --- | --- | --- |
+| resolver-linkset-schema-1.2.1.json | https://ref.gs1.org/standards/resolver/1.2.1/linkset-schema | d2e23510f17558c29f9d1baf9e112a70df42efd6557a49dc9a317048973669f2 | 4696 |
+| resolver-description-file-schema-1.2.0.json | https://ref.gs1.org/standards/resolver/1.2.0/description-file-schema | 99d505c7aa2004cde3277651e8db0e019eab61d2746b2631ddab3fec8a13617e | 3593 |
+| resolver-linkset-context-1.2.1.jsonld | https://ref.gs1.org/standards/resolver/1.2.1/linkset-context | 05792d010165fa6f28cc9cc3463cc1668f522ac75c26abe5b2877ec4a37b1312 | 838 |
+
+A test holds each file to its digest.

package/schemas/gs1/resolver-description-file-schema-1.2.0.json

@@ -0,0 +1,124 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "https://ref.gs1.org/standards/resolver/1.2.0/description-file-schema",
+	"description": "The JSON schema for a conformant GS1 resolver description file to be placed at /.well-known/gs1resolver",
+	"type": "object",
+	"properties": {
+		"resolverRoot": {
+			"description": "The root URL of the resolver",
+			"type": "string",
+			"format": "uri"
+		},
+		"supportedPrimaryKeys": {
+			"description": "An array of primary keys supported by the resolver, provided as their numeric AI. The value 'all' indicates that all GS1 primary identification keys are supported",
+			"type": "array",
+			"items": {
+				"type": "string",
+				"enum": ["all", "01", "8006", "8013", "8010", "410", "411", "412", "413", "414", "415", "417", "8017", "8018", "255", "00", "253", "401", "402", "8003", "8004"]
+			}
+		},
+		"name": {
+			"description": "The name of the resolver",
+			"type": "string"
+		},
+		"supportedLinkType": {
+			"type": "array",
+			"items": {
+				"properties": {
+					"namespace": {
+						"description": "A namespace URI recognised by the resolver",
+						"type": "string",
+						"format": "uri"
+					},
+					"prefix": {
+						"description": "The prefix assigned to this URI for use in CURIEs, including the colon",
+						"type": "string",
+						"pattern": "^[a-zA-Z_][A-Za-z0-9_-]*?:$"
+					}
+				}
+			}
+		},
+		"linkTypeDefaultCanBeLinkset": {
+			"description": "Boolean flag stating whether the resolver supports the option to make 'linkset' the default linkType.",
+			"type": "boolean",
+			"default": false
+		},
+		"supportedContextValuesEnumerated": {
+			"description": "Enumerated list of values for context supported by this resolver",
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
+		"supportedContextValuesExternal": {
+			"description": "External lists of supported values for context recognised by this resolver",
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"nameOfList": {
+						"description": "The name of the list of values",
+						"type": "string"
+					},
+					"url": {
+						"description": "The URL of the external list",
+						"type": "string",
+						"format": "uri"
+					}
+				}
+			}
+		},
+		"contact": {
+			"description": "Contact details for the resolver operator, uses VCard",
+			"type": "object",
+			"properties": {
+				"fn": {
+					"description": "Full name",
+					"type": "string"
+				},
+				"hasAddress": {
+					"description": "Address info for the resolver operator",
+					"type": "object",
+					"properties": {
+						"streetAddress": {
+							"description": "Street address of hte operator",
+							"type": "string"
+						},
+						"locality": {
+							"description": "locality of the operator",
+							"type": "string"
+						},
+						"region": {
+							"description": "region of the operator",
+							"type": "string"
+						},
+						"postal-code": {
+							"decription": "post code of the operator",
+							"type": "string"
+						}
+					}
+				}
+			},
+			"hasTelephone": {
+				"description": "A contact telephone number",
+				"type": "string",
+				"format": "uri"
+			}
+		},
+		"extensionProfile": {
+			"description": "A link to a document that describes any extended key=value pairs supported by the resolver and/or an additional supported compression/decompression capability",
+			"type": "string",
+			"format": "uri"
+		},
+
+		"jsonLdContextLocation": {
+			"description": "The location of the JSON-LD context file referenced when serving linksets as JSON",
+			"type": "string",
+			"format": "uri"
+		}
+
+
+	},
+	"required": ["resolverRoot", "supportedPrimaryKeys"]
+}
+

package/schemas/gs1/resolver-linkset-context-1.2.1.jsonld

@@ -0,0 +1,39 @@
+{
+	"@context": {
+		"schema": "https://schema.org/",
+		"gs1": "http://gs1.org/voc/",
+		"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+		"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+		"owl": "http://www.w3.org/2002/07/owl#",
+		"dcterms": "http://purl.org/dc/terms/",
+		"xsd": "http://www.w3.org/2001/XMLSchema#",
+		"skos": "http://www.w3.org/2004/02/skos/core#",
+		"gs1:value": {
+			"@type": "xsd:float"
+		},
+		"@protected": true,
+		"href": "@id",
+		"hreflang": {
+			"@id": "dcterms:language",
+			"@container": "@set"
+		},
+		"title": {
+			"@id": "dcterms:title"
+		},
+		"title*": {
+			"@id": "dcterms:title",
+			"@container": "@set"
+		},
+		"type": {
+			"@id": "dcterms:format"
+		},
+		"modified": {
+			"@id": "dcterms:modified"
+		},
+		"itemDescription": {
+			"@id": "rdfs:comment"
+		},
+		"linkset": "@nest",
+		"anchor": "@id"
+	}
+}

package/schemas/gs1/resolver-linkset-schema-1.2.1.json

@@ -0,0 +1,96 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "@id": "https://ref.gs1.org/standards/resolver/linkset-schema",
+    "title": "JSON schema for linksets as defined in RFC 9264",
+    "type": "object",
+    "properties": {
+        "linkset": {
+            "description": "The linkset",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "anchor": {
+                        "description": "The URL at the root of the linkset, a.k.a the link context",
+                        "type": "string",
+                        "pattern": "^https?:\/\/[a-zA-z0-9./]+"
+                    },
+                    "itemDescription": {
+                        "name": "Item description",
+                        "description": "A description of the item. There are no restrictions on this so that, for example, it does not have to be a product's name. This has been deprecated in favour of description.",
+                        "type": "string"
+                    },
+                    "description": {
+                        "name": "Description",
+                        "description": "A description of the item. There are no restrictions on this so that, for example, it does not have to be a product's name. Preferred alternative to itemDescription which has been deprecated",
+                        "type": "string"
+                    }
+                },
+                "patternProperties": {
+                    "(?!(anchor|itemDescription|description))^([a-z-]+$)|(^https?:\/\/[a-zA-z0-9./]+$)": {
+                        "title": "Link object schema",
+                        "description": "The schema for each link context object for each link relation",
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "href": {
+                                    "name": "href",
+                                    "description": "The target URL",
+                                    "type": "string",
+                                    "pattern": "^https?:\/\/[a-zA-z0-9./]+"
+                                },
+                                "title": {
+                                    "title": "title",
+                                    "description": "A human-readable title for the link",
+                                    "type": "string"
+                                },
+                                "hreflang": {
+                                    "name": "hreflang",
+                                    "description": "The human language(s) of the target resource",
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string",
+                                        "pattern": "(^\\w{2}$)|(^\\w{2}-\\w{2}$)"
+                                    }
+                                },
+                                "type": {
+                                    "name": "Type",
+                                    "description": "The content type (MIME type) of the target resource",
+                                    "type": "string",
+                                    "pattern": "\\w+/[-+.\\w]+"
+                                },
+                                  "context": {
+                                    "name":"Context",
+                                    "description":"Any additional descriptor for the link, typically a geography or jurisdiction in which the link applies",
+                                    "type":"array"
+                                  },
+                                  "fwqs" : {
+                                    "name":"Forward query strings",
+                                    "type": "boolean"
+                                  },
+                                  "public" : {
+                                    "name":"Link can be shared publicly",
+                                    "type": "boolean"
+                                  }
+                            },
+                            "required": [
+                                "href",
+                                "title"
+                            ],
+                            "additionalProperties": false
+                        }
+                    }
+                },
+                "required": [
+                    "anchor"
+                ],
+                "additionalProperties": false
+            }
+        }
+    },
+    "required": [
+        "linkset"
+    ],
+    "additionalProperties": false
+}