@bcts/provenance-mark 1.0.0-alpha.12 → 1.0.0-alpha.14

package/dist/index.iife.js

@@ -1,4 +1,4 @@
-var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js, _noble_hashes_hkdf_js, _noble_ciphers_chacha_js, _bcts_rand, _bcts_tags, _bcts_uniform_resources) {
+var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js, _noble_hashes_hkdf_js, _noble_ciphers_chacha_js, _bcts_rand, _bcts_tags, _bcts_uniform_resources, _bcts_envelope) {
 
 
 //#region src/error.ts
@@ -1009,7 +1009,7 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 			return ProvenanceMark.fromMessage(res, message);
 		}
 		/**
-		* Encode for URL (minimal bytewords of CBOR).
+		* Encode for URL (minimal bytewords of tagged CBOR).
 		*/
 		toUrlEncoding() {
 			return (0, _bcts_uniform_resources.encodeBytewords)(this.toCborData(), _bcts_uniform_resources.BytewordsStyle.Minimal);
@@ -1022,6 +1022,20 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 			return ProvenanceMark.fromTaggedCbor(cborValue);
 		}
 		/**
+		* Get the UR string representation (e.g., "ur:provenance/...").
+		*/
+		urString() {
+			return _bcts_uniform_resources.UR.new("provenance", this.untaggedCbor()).string();
+		}
+		/**
+		* Create from a UR string.
+		*/
+		static fromURString(urString) {
+			const ur = _bcts_uniform_resources.UR.fromURString(urString);
+			if (ur.urTypeStr() !== "provenance") throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Expected UR type 'provenance', got '${ur.urTypeStr()}'` });
+			return ProvenanceMark.fromUntaggedCbor(ur.cbor());
+		}
+		/**
 		* Build a URL with this mark as a query parameter.
 		*/
 		toUrl(base) {
@@ -1098,17 +1112,23 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 		}
 		/**
 		* Detailed debug representation.
+		* Matches Rust format exactly for parity.
 		*/
 		toDebugString() {
+			const dateStr = this._date.toISOString().replace(".000Z", "Z");
 			const components = [
 				`key: ${bytesToHex(this._key)}`,
 				`hash: ${bytesToHex(this._hash)}`,
 				`chainID: ${bytesToHex(this._chainId)}`,
 				`seq: ${this._seq}`,
-				`date: ${this._date.toISOString()}`
+				`date: ${dateStr}`
 			];
 			const info = this.info();
-			if (info !== void 0) components.push(`info: ${JSON.stringify(info)}`);
+			if (info !== void 0) {
+				const textValue = info.asText();
+				if (textValue !== void 0) components.push(`info: "${textValue}"`);
+				else components.push(`info: ${info.toDiagnostic()}`);
+			}
 			return `ProvenanceMark(${components.join(", ")})`;
 		}
 		/**
@@ -1149,6 +1169,33 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 			if (typeof json["info_bytes"] === "string") infoBytes = fromBase64(json["info_bytes"]);
 			return new ProvenanceMark(res, key, hash, chainId, seqBytes, dateBytes, infoBytes, seq, date);
 		}
+		/**
+		* Convert this provenance mark to a Gordian Envelope.
+		*
+		* The envelope contains the tagged CBOR representation of the mark.
+		*
+		* Note: Use provenanceMarkToEnvelope() for a standalone function alternative.
+		*/
+		intoEnvelope() {
+			return _bcts_envelope.Envelope.new(this.toCborData());
+		}
+		/**
+		* Extract a ProvenanceMark from a Gordian Envelope.
+		*
+		* @param envelope - The envelope to extract from
+		* @returns The extracted provenance mark
+		* @throws ProvenanceMarkError if extraction fails
+		*/
+		static fromEnvelope(envelope) {
+			const bytes = envelope.asByteString();
+			if (bytes !== void 0) return ProvenanceMark.fromCborData(bytes);
+			const envCase = envelope.case();
+			if (envCase.type === "node") {
+				const subjectBytes = envCase.subject.asByteString();
+				if (subjectBytes !== void 0) return ProvenanceMark.fromCborData(subjectBytes);
+			}
+			throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Could not extract ProvenanceMark from envelope" });
+		}
 	};
 	/**
 	* Helper function to compare two Uint8Arrays.
@@ -1280,6 +1327,63 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 			const rngState = RngState.fromBytes(fromBase64(json["rngState"]));
 			return ProvenanceMarkGenerator.new(res, seed, chainId, nextSeq, rngState);
 		}
+		/**
+		* Convert this generator to a Gordian Envelope.
+		*
+		* The envelope contains structured assertions for all generator fields:
+		* - isA: "provenance-generator"
+		* - res: The resolution
+		* - seed: The seed
+		* - next-seq: The next sequence number
+		* - rng-state: The RNG state
+		*
+		* Note: Use provenanceMarkGeneratorToEnvelope() for a standalone function alternative.
+		*/
+		intoEnvelope() {
+			let envelope = _bcts_envelope.Envelope.new(this._chainId);
+			envelope = envelope.addType("provenance-generator");
+			envelope = envelope.addAssertion("res", resolutionToNumber(this._res));
+			envelope = envelope.addAssertion("seed", this._seed.toBytes());
+			envelope = envelope.addAssertion("next-seq", this._nextSeq);
+			envelope = envelope.addAssertion("rng-state", this._rngState.toBytes());
+			return envelope;
+		}
+		/**
+		* Extract a ProvenanceMarkGenerator from a Gordian Envelope.
+		*
+		* @param envelope - The envelope to extract from
+		* @returns The extracted generator
+		* @throws ProvenanceMarkError if extraction fails
+		*/
+		static fromEnvelope(envelope) {
+			const env = envelope;
+			if (!env.hasType("provenance-generator")) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Envelope is not a provenance-generator" });
+			const chainId = env.subject().asByteString();
+			if (chainId === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Could not extract chain ID" });
+			const extractAssertion = (predicate) => {
+				const assertions = env.assertionsWithPredicate(predicate);
+				if (assertions.length === 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Missing ${predicate} assertion` });
+				const assertionCase = assertions[0].case();
+				if (assertionCase.type !== "assertion") throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Invalid ${predicate} assertion` });
+				const obj = assertionCase.assertion.object();
+				const objCase = obj.case();
+				if (objCase.type === "leaf") return {
+					cbor: objCase.cbor,
+					bytes: obj.asByteString()
+				};
+				throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Invalid ${predicate} value` });
+			};
+			const res = resolutionFromCbor(extractAssertion("res").cbor);
+			const seedValue = extractAssertion("seed");
+			if (seedValue.bytes === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Invalid seed data" });
+			const seed = ProvenanceSeed.fromBytes(seedValue.bytes);
+			const seqValue = extractAssertion("next-seq");
+			const nextSeq = Number(seqValue.cbor);
+			const rngValue = extractAssertion("rng-state");
+			if (rngValue.bytes === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Invalid rng-state data" });
+			const rngState = RngState.fromBytes(rngValue.bytes);
+			return ProvenanceMarkGenerator.new(res, seed, chainId, nextSeq, rngState);
+		}
 	};
 
 //#endregion
@@ -1642,6 +1746,124 @@ var bctsProvenanceMark = (function(exports, _bcts_dcbor, _noble_hashes_sha2_js,
 		}
 	};
 
+//#endregion
+//#region src/envelope.ts
+/**
+	* Envelope support for Provenance Marks
+	*
+	* This module provides Gordian Envelope integration for ProvenanceMark and
+	* ProvenanceMarkGenerator, enabling them to be used with the bc-envelope
+	* ecosystem.
+	*
+	* Ported from provenance-mark-rust/src/mark.rs and generator.rs (envelope feature)
+	*/
+	/**
+	* Registers provenance mark tags in the global format context.
+	*
+	* This function sets up a summarizer for the PROVENANCE_MARK tag that displays
+	* provenance marks in a human-readable format.
+	*/
+	function registerTags() {
+		registerTagsIn(globalTagsContext);
+	}
+	/**
+	* Registers provenance mark tags in a specific format context.
+	*
+	* @param context - The format context to register tags in
+	*/
+	function registerTagsIn(context) {
+		context.setSummarizer(Number(_bcts_tags.PROVENANCE_MARK.value), (cborValue) => {
+			return ProvenanceMark.fromUntaggedCbor(cborValue).toString();
+		});
+	}
+	const globalTagsContext = { setSummarizer(_tag, _summarizer) {} };
+	/**
+	* Convert a ProvenanceMark to an Envelope.
+	*
+	* The envelope contains the tagged CBOR representation of the mark.
+	*
+	* @param mark - The provenance mark to convert
+	* @returns An envelope containing the mark
+	*/
+	function provenanceMarkToEnvelope(mark) {
+		return _bcts_envelope.Envelope.new(mark.toCborData());
+	}
+	/**
+	* Extract a ProvenanceMark from an Envelope.
+	*
+	* @param envelope - The envelope to extract from
+	* @returns The extracted provenance mark
+	* @throws ProvenanceMarkError if extraction fails
+	*/
+	function provenanceMarkFromEnvelope(envelope) {
+		const bytes = envelope.asByteString();
+		if (bytes !== void 0) return ProvenanceMark.fromCborData(bytes);
+		const envCase = envelope.case();
+		if (envCase.type === "node") {
+			const subjectBytes = envCase.subject.asByteString();
+			if (subjectBytes !== void 0) return ProvenanceMark.fromCborData(subjectBytes);
+		}
+		throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Could not extract ProvenanceMark from envelope" });
+	}
+	/**
+	* Convert a ProvenanceMarkGenerator to an Envelope.
+	*
+	* The envelope contains structured assertions for all generator fields:
+	* - type: "provenance-generator"
+	* - res: The resolution
+	* - seed: The seed
+	* - next-seq: The next sequence number
+	* - rng-state: The RNG state
+	*
+	* @param generator - The generator to convert
+	* @returns An envelope containing the generator
+	*/
+	function provenanceMarkGeneratorToEnvelope(generator) {
+		let envelope = _bcts_envelope.Envelope.new(generator.chainId());
+		envelope = envelope.addType("provenance-generator");
+		envelope = envelope.addAssertion("res", resolutionToNumber(generator.res()));
+		envelope = envelope.addAssertion("seed", generator.seed().toBytes());
+		envelope = envelope.addAssertion("next-seq", generator.nextSeq());
+		envelope = envelope.addAssertion("rng-state", generator.rngState().toBytes());
+		return envelope;
+	}
+	/**
+	* Extract a ProvenanceMarkGenerator from an Envelope.
+	*
+	* @param envelope - The envelope to extract from
+	* @returns The extracted generator
+	* @throws ProvenanceMarkError if extraction fails
+	*/
+	function provenanceMarkGeneratorFromEnvelope(envelope) {
+		const env = envelope;
+		if (!env.hasType("provenance-generator")) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Envelope is not a provenance-generator" });
+		const chainId = env.subject().asByteString();
+		if (chainId === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Could not extract chain ID" });
+		const extractAssertion = (predicate) => {
+			const assertions = env.assertionsWithPredicate(predicate);
+			if (assertions.length === 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Missing ${predicate} assertion` });
+			const assertionCase = assertions[0].case();
+			if (assertionCase.type !== "assertion") throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Invalid ${predicate} assertion` });
+			const obj = assertionCase.assertion.object();
+			const objCase = obj.case();
+			if (objCase.type === "leaf") return {
+				cbor: objCase.cbor,
+				bytes: obj.asByteString()
+			};
+			throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: `Invalid ${predicate} value` });
+		};
+		const res = resolutionFromCbor(extractAssertion("res").cbor);
+		const seedValue = extractAssertion("seed");
+		if (seedValue.bytes === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Invalid seed data" });
+		const seed = ProvenanceSeed.fromBytes(seedValue.bytes);
+		const seqValue = extractAssertion("next-seq");
+		const nextSeq = Number(seqValue.cbor);
+		const rngValue = extractAssertion("rng-state");
+		if (rngValue.bytes === void 0) throw new ProvenanceMarkError(ProvenanceMarkErrorType.CborError, void 0, { message: "Invalid rng-state data" });
+		const rngState = RngState.fromBytes(rngValue.bytes);
+		return ProvenanceMarkGenerator.new(res, seed, chainId, nextSeq, rngState);
+	}
+
 //#endregion
 exports.PROVENANCE_SEED_LENGTH = PROVENANCE_SEED_LENGTH;
 exports.ProvenanceMark = ProvenanceMark;
@@ -1679,7 +1901,13 @@ exports.infoRangeStart = infoRangeStart;
 exports.keyRange = keyRange;
 exports.linkLength = linkLength;
 exports.obfuscate = obfuscate;
+exports.provenanceMarkFromEnvelope = provenanceMarkFromEnvelope;
+exports.provenanceMarkGeneratorFromEnvelope = provenanceMarkGeneratorFromEnvelope;
+exports.provenanceMarkGeneratorToEnvelope = provenanceMarkGeneratorToEnvelope;
+exports.provenanceMarkToEnvelope = provenanceMarkToEnvelope;
 exports.rangeOfDaysInMonth = rangeOfDaysInMonth;
+exports.registerTags = registerTags;
+exports.registerTagsIn = registerTagsIn;
 exports.resolutionFromCbor = resolutionFromCbor;
 exports.resolutionFromNumber = resolutionFromNumber;
 exports.resolutionToCbor = resolutionToCbor;
@@ -1696,5 +1924,5 @@ exports.sha256 = sha256;
 exports.sha256Prefix = sha256Prefix;
 exports.validate = validate;
 return exports;
-})({}, bctsDcbor, nobleHashesSha2, nobleHashesHkdf, nobleCiphersChacha, bctsRand, bctsTags, bctsUniformResources);
+})({}, bctsDcbor, nobleHashesSha2, nobleHashesHkdf, nobleCiphersChacha, bctsRand, bctsTags, bctsUniformResources, bctsEnvelope);
 //# sourceMappingURL=index.iife.js.map