@fedify/vocab-tools 2.4.0-dev.1995 → 2.4.0-dev.2027

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.1995+618fd4e7",
+  "version": "2.4.0-dev.2027+fcf88bfc",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts"

package/dist/mod.cjs

@@ -8,7 +8,7 @@ let yaml = require("yaml");
 let es_toolkit = require("es-toolkit");
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.4.0-dev.1995+618fd4e7";
+var version = "2.4.0-dev.2027+fcf88bfc";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -785,6 +785,10 @@ async function* generateEncoder(typeUri, types) {
       ...options,
       contextLoader: options.contextLoader ?? getDocumentLoader(),
     };
+    // Joins the enclosing frame's signed-value scope, or starts one when this
+    // frame is the outermost.  Only the owning frame puts retained signed
+    // child documents back in place of their placeholders.
+    const signedValues = enterSignedValueScope(options);
   `;
 	if (isCompactableType(typeUri, types)) {
 		yield `
@@ -815,9 +819,13 @@ async function* generateEncoder(typeUri, types) {
       for (const v of this.${await getFieldName(property.uri)}) {
         const item = (
       `;
-			if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? formatIri(v) : ";
+			if (!areAllScalarTypes(property.range, types)) {
+				yield "retainedSignedValueRef(v, signedValues.scope) ?? (";
+				yield "v instanceof URL ? formatIri(v) : ";
+			}
 			const encoders = getEncoders(property.range, types, "v", "options", true);
 			for (const code of encoders) yield code;
+			if (!areAllScalarTypes(property.range, types)) yield ")";
 			yield `
         );
         compactItems.push(item);
@@ -848,7 +856,9 @@ async function* generateEncoder(typeUri, types) {
       ${type.typeless ? "" : `result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};`}
       if (this.id != null) result["id"] = formatIri(this.id);
       result["@context"] = ${JSON.stringify(type.defaultContext)};
-      return result;
+      return signedValues.owner
+        ? resolveSignedValues(result, signedValues.scope)
+        : result;
     }
     `;
 	}
@@ -874,8 +884,12 @@ async function* generateEncoder(typeUri, types) {
     for (const v of this.${await getFieldName(property.uri)}) {
       let element = (
     `;
-		if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? { \"@id\": formatIri(v) } : ";
+		if (!areAllScalarTypes(property.range, types)) {
+			yield "retainedSignedValueRef(v, signedValues.scope) ?? (";
+			yield "v instanceof URL ? { \"@id\": formatIri(v) } : ";
+		}
 		for (const code of getEncoders(property.range, types, "v", "options")) yield code;
+		if (!areAllScalarTypes(property.range, types)) yield ")";
 		yield `
       );
       if (Array.isArray(element)) {
@@ -962,7 +976,9 @@ async function* generateEncoder(typeUri, types) {
 	}
 	yield `
     }
-    return compacted;
+    return signedValues.owner
+      ? resolveSignedValues(compacted, signedValues.scope)
+      : compacted;
   }
 
   protected ${emitOverride$1(typeUri, types)} isCompactable(): boolean {
@@ -1372,6 +1388,13 @@ async function* generateCloner(typeUri, types) {
 	yield `
   /**
    * Clones this instance, optionally updating it with the given values.
+   *
+   * A clone never inherits a signed JSON-LD representation retained by
+   * \`signObject()\`: the clone may differ from the document that the proof
+   * covers, so embedding the original secured JSON in a parent document
+   * would be wrong.  Sign the clone again if it has to be embedded as a
+   * secured child.
+   *
    * @param values The values to update the clone with.
    * @param options The options to use for cloning.
    * @returns The cloned instance.
@@ -2013,6 +2036,11 @@ const INTERNAL_RUNTIME_IMPORTS = [
 	"isTrustedIriOrigin",
 	"normalizeJsonLdIris"
 ].join(",\n    ");
+const SIGNED_REPRESENTATION_IMPORTS = [
+	"enterSignedValueScope",
+	"resolveSignedValues",
+	"retainedSignedValueRef"
+].join(",\n    ");
 const RUNTIME_IMPORTS = [
 	"canParseDecimal",
 	"decodeMultibase",
@@ -2208,6 +2236,7 @@ async function* generateClasses(types) {
     from "@opentelemetry/api";\n`;
 	yield `import {\n    ${RUNTIME_IMPORTS}\n} from "@fedify/vocab-runtime";\n`;
 	yield `import {\n    ${INTERNAL_RUNTIME_IMPORTS}\n} from "@fedify/vocab-runtime/internal/jsonld-cache";\n`;
+	yield `import {\n    ${SIGNED_REPRESENTATION_IMPORTS}\n} from "@fedify/vocab-runtime/internal/signed-representation";\n`;
 	yield `import {
     isTemporalDuration,
     isTemporalInstant,

package/dist/mod.js

@@ -7,7 +7,7 @@ import { parse } from "yaml";
 import { pascalCase } from "es-toolkit";
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.4.0-dev.1995+618fd4e7";
+var version = "2.4.0-dev.2027+fcf88bfc";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -784,6 +784,10 @@ async function* generateEncoder(typeUri, types) {
       ...options,
       contextLoader: options.contextLoader ?? getDocumentLoader(),
     };
+    // Joins the enclosing frame's signed-value scope, or starts one when this
+    // frame is the outermost.  Only the owning frame puts retained signed
+    // child documents back in place of their placeholders.
+    const signedValues = enterSignedValueScope(options);
   `;
 	if (isCompactableType(typeUri, types)) {
 		yield `
@@ -814,9 +818,13 @@ async function* generateEncoder(typeUri, types) {
       for (const v of this.${await getFieldName(property.uri)}) {
         const item = (
       `;
-			if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? formatIri(v) : ";
+			if (!areAllScalarTypes(property.range, types)) {
+				yield "retainedSignedValueRef(v, signedValues.scope) ?? (";
+				yield "v instanceof URL ? formatIri(v) : ";
+			}
 			const encoders = getEncoders(property.range, types, "v", "options", true);
 			for (const code of encoders) yield code;
+			if (!areAllScalarTypes(property.range, types)) yield ")";
 			yield `
         );
         compactItems.push(item);
@@ -847,7 +855,9 @@ async function* generateEncoder(typeUri, types) {
       ${type.typeless ? "" : `result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};`}
       if (this.id != null) result["id"] = formatIri(this.id);
       result["@context"] = ${JSON.stringify(type.defaultContext)};
-      return result;
+      return signedValues.owner
+        ? resolveSignedValues(result, signedValues.scope)
+        : result;
     }
     `;
 	}
@@ -873,8 +883,12 @@ async function* generateEncoder(typeUri, types) {
     for (const v of this.${await getFieldName(property.uri)}) {
       let element = (
     `;
-		if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? { \"@id\": formatIri(v) } : ";
+		if (!areAllScalarTypes(property.range, types)) {
+			yield "retainedSignedValueRef(v, signedValues.scope) ?? (";
+			yield "v instanceof URL ? { \"@id\": formatIri(v) } : ";
+		}
 		for (const code of getEncoders(property.range, types, "v", "options")) yield code;
+		if (!areAllScalarTypes(property.range, types)) yield ")";
 		yield `
       );
       if (Array.isArray(element)) {
@@ -961,7 +975,9 @@ async function* generateEncoder(typeUri, types) {
 	}
 	yield `
     }
-    return compacted;
+    return signedValues.owner
+      ? resolveSignedValues(compacted, signedValues.scope)
+      : compacted;
   }
 
   protected ${emitOverride$1(typeUri, types)} isCompactable(): boolean {
@@ -1371,6 +1387,13 @@ async function* generateCloner(typeUri, types) {
 	yield `
   /**
    * Clones this instance, optionally updating it with the given values.
+   *
+   * A clone never inherits a signed JSON-LD representation retained by
+   * \`signObject()\`: the clone may differ from the document that the proof
+   * covers, so embedding the original secured JSON in a parent document
+   * would be wrong.  Sign the clone again if it has to be embedded as a
+   * secured child.
+   *
    * @param values The values to update the clone with.
    * @param options The options to use for cloning.
    * @returns The cloned instance.
@@ -2012,6 +2035,11 @@ const INTERNAL_RUNTIME_IMPORTS = [
 	"isTrustedIriOrigin",
 	"normalizeJsonLdIris"
 ].join(",\n    ");
+const SIGNED_REPRESENTATION_IMPORTS = [
+	"enterSignedValueScope",
+	"resolveSignedValues",
+	"retainedSignedValueRef"
+].join(",\n    ");
 const RUNTIME_IMPORTS = [
 	"canParseDecimal",
 	"decodeMultibase",
@@ -2207,6 +2235,7 @@ async function* generateClasses(types) {
     from "@opentelemetry/api";\n`;
 	yield `import {\n    ${RUNTIME_IMPORTS}\n} from "@fedify/vocab-runtime";\n`;
 	yield `import {\n    ${INTERNAL_RUNTIME_IMPORTS}\n} from "@fedify/vocab-runtime/internal/jsonld-cache";\n`;
+	yield `import {\n    ${SIGNED_REPRESENTATION_IMPORTS}\n} from "@fedify/vocab-runtime/internal/signed-representation";\n`;
 	yield `import {
     isTemporalDuration,
     isTemporalInstant,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.1995+618fd4e7",
+  "version": "2.4.0-dev.2027+fcf88bfc",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {