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

package/src/class.ts

@@ -18,6 +18,11 @@ const INTERNAL_RUNTIME_IMPORTS = [
   "isTrustedIriOrigin",
   "normalizeJsonLdIris",
 ].join(",\n    ");
+const SIGNED_REPRESENTATION_IMPORTS = [
+  "enterSignedValueScope",
+  "resolveSignedValues",
+  "retainedSignedValueRef",
+].join(",\n    ");
 const RUNTIME_IMPORTS = [
   "canParseDecimal",
   "decodeMultibase",
@@ -268,6 +273,7 @@ export async function* generateClasses(
     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/src/codec.ts

@@ -95,6 +95,10 @@ export async function* generateEncoder(
       ...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 `
@@ -127,6 +131,7 @@ export async function* generateEncoder(
         const item = (
       `;
       if (!areAllScalarTypes(property.range, types)) {
+        yield "retainedSignedValueRef(v, signedValues.scope) ?? (";
         yield "v instanceof URL ? formatIri(v) : ";
       }
       const encoders = getEncoders(
@@ -137,6 +142,7 @@ export async function* generateEncoder(
         true,
       );
       for (const code of encoders) yield code;
+      if (!areAllScalarTypes(property.range, types)) yield ")";
       yield `
         );
         compactItems.push(item);
@@ -180,7 +186,9 @@ export async function* generateEncoder(
     }
       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;
     }
     `;
   }
@@ -210,11 +218,13 @@ export async function* generateEncoder(
       let element = (
     `;
     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)) {
@@ -325,7 +335,9 @@ export async function* generateEncoder(
   }
   yield `
     }
-    return compacted;
+    return signedValues.owner
+      ? resolveSignedValues(compacted, signedValues.scope)
+      : compacted;
   }
 
   protected ${emitOverride(typeUri, types)} isCompactable(): boolean {

package/src/constructor.ts

@@ -208,6 +208,13 @@ export async function* generateCloner(
   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.