@fedify/vocab-tools 2.4.0-dev.2122 → 2.4.0-dev.2129

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.2122+bdc0ce8d",
+  "version": "2.4.0-dev.2129+c0ddb433",
   "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.2122+bdc0ce8d";
+var version = "2.4.0-dev.2129+c0ddb433";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -737,6 +737,7 @@ function* generatePreprocessorBlock(property, rangeTypeName, variable, baseUrlEx
             documentLoader: options.documentLoader,
             contextLoader: options.contextLoader,
             tracerProvider: options.tracerProvider,
+            verifyPortableObject: options.verifyPortableObject,
             baseUrl: ${baseUrlExpr},
           });
           if (_result instanceof Error) throw _result;
@@ -1005,6 +1006,10 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
    *                - \`contextLoader\`: The loader for remote JSON-LD contexts.
    *                - \`tracerProvider\`: The OpenTelemetry tracer provider to use.
    *                  If omitted, the global tracer provider is used.
+   *                - \`verifyPortableObject\`: The default FEP-ef61 portable
+   *                  object verifier for the property accessors of the
+   *                  returned object and the objects obtained from it.  It
+   *                  does not verify the given \`json\` itself.
    * @returns The object of this type.
    * @throws {TypeError} If the given \`json\` is invalid.
    */
@@ -1014,6 +1019,7 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
       baseUrl?: URL,
     } = {},
   ): Promise<${type.name}> {
@@ -1052,6 +1058,7 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
       baseUrl?: URL,
     } = {},
   ): Promise<${type.name}> {
@@ -1287,6 +1294,7 @@ async function* generateConstructor(typeUri, types) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
     } = {},
   ) {
   `;
@@ -1294,6 +1302,7 @@ async function* generateConstructor(typeUri, types) {
     this.#documentLoader = options.documentLoader;
     this.#contextLoader = options.contextLoader;
     this.#tracerProvider = options.tracerProvider;
+    this.#verifyPortableObject = options.verifyPortableObject;
     const baseUrl = (options as { baseUrl?: URL }).baseUrl;
     this.#_baseUrl = baseUrl == null ? undefined : new URL(baseUrl.href);
     if ("$warning" in options) {
@@ -1408,6 +1417,7 @@ async function* generateCloner(typeUri, types) {
     options: {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
+      verifyPortableObject?: PortableObjectVerifier,
     } = {}
   ): ${type.name} {
     if (this._warning != null) {
@@ -1702,6 +1712,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                   documentLoader,
                   contextLoader: parseOptions.contextLoader,
                   tracerProvider,
+                  // Only the parent's own default is inherited, never the
+                  // verifier given to this call:
+                  verifyPortableObject: this._verifyPortableObject,
                   baseUrl: parseOptions.baseUrl,
                 }),
             });
@@ -1743,7 +1756,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         }
         let fetchResult: RemoteDocument;
         try {
-          fetchResult = await documentLoader(lookupUrl);
+          fetchResult = await documentLoader(lookupUrl, {
+            suppressError: options.suppressError,
+          });
         } catch (error) {
           span.setStatus({
             code: SpanStatusCode.ERROR,
@@ -1751,7 +1766,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           });
           span.end();
           if (options.suppressError) {
-            getLogger(["fedify", "vocab"]).error(
+            getLogger(["fedify", "vocab"]).warn(
               "Failed to fetch {url}: {error}",
               { error, url: lookupUrl }
             );
@@ -1763,8 +1778,12 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         // In portable mode, the document may turn out to be a portable object,
         // which has to be verified with the same context documents:
         const snapshot = portableMode
-          ? createSnapshotContextLoader(contextLoader)
+          ? createSnapshotContextLoader(contextLoader, options.suppressError)
           : null;
+        const scopedContext = createScopedContextLoader(
+          snapshot?.loader ?? contextLoader,
+          snapshot == null && options.suppressError,
+        );
         try {
           let claim: PortableResponseClaim | null | undefined;
           try {
@@ -1773,8 +1792,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
               document,
               {
                 documentLoader,
-                contextLoader: snapshot?.loader ?? contextLoader,
+                contextLoader: scopedContext.loader,
                 tracerProvider,
+                verifyPortableObject: this._verifyPortableObject,
                 baseUrl,
               }
             );
@@ -1817,7 +1837,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             }
           } catch (e) {
             if (options.suppressError) {
-              getLogger(["fedify", "vocab"]).error(
+              getLogger(["fedify", "vocab"]).warn(
                 "Failed to parse {url}: {error}",
                 { error: e, url: lookupUrl }
               );
@@ -1843,6 +1863,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             contextLoader: snapshot?.loader,
           });
         } finally {
+          scopedContext.release();
           snapshot?.release();
         }
       });
@@ -1854,6 +1875,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         documentLoader?: DocumentLoader,
         contextLoader?: DocumentLoader,
         tracerProvider?: TracerProvider,
+        verifyPortableObject?: PortableObjectVerifier,
         baseUrl?: URL
       }
     ): Promise<${getTypeNames(property.range, types)}> {
@@ -1864,6 +1886,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
       const tracerProvider = options.tracerProvider ??
         this._tracerProvider ?? trace.getTracerProvider();
       const baseUrl = options.baseUrl;
+      const verifyPortableObject = options.verifyPortableObject;
     `;
 		if (property.preprocessors != null && property.preprocessors.length > 0) {
 			yield `
@@ -1883,6 +1906,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                 documentLoader,
                 contextLoader,
                 tracerProvider,
+                verifyPortableObject,
                 baseUrl,
               });
               if (_result instanceof Error) throw _result;
@@ -1901,7 +1925,13 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         try {
           return await ${types[range].name}.fromJsonLd(
             jsonLd,
-            { documentLoader, contextLoader, tracerProvider, baseUrl },
+            {
+              documentLoader,
+              contextLoader,
+              tracerProvider,
+              verifyPortableObject,
+              baseUrl,
+            },
           );
         } catch (e) {
           if (!(e instanceof TypeError)) throw e;
@@ -1954,6 +1984,15 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           );
         }
         if (this.${await getFieldName(property.uri)}.length < 1) return null;
+        if (
+          options.verifyPortableObject == null &&
+          this._verifyPortableObject != null
+        ) {
+          options = {
+            ...options,
+            verifyPortableObject: this._verifyPortableObject,
+          };
+        }
         let v = this.${await getFieldName(property.uri)}[0];
         if (!(v instanceof URL) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
@@ -2000,6 +2039,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
 				yield `
             v = await this.#${property.singularName}_fromJsonLd(doc, {
               ...options,
+              verifyPortableObject: this._verifyPortableObject,
               baseUrl: ${cachedPropertyBaseUrl},
             });
       `;
@@ -2078,6 +2118,15 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             this._warning.values
           );
         }
+        if (
+          options.verifyPortableObject == null &&
+          this._verifyPortableObject != null
+        ) {
+          options = {
+            ...options,
+            verifyPortableObject: this._verifyPortableObject,
+          };
+        }
         const vs = this.${await getFieldName(property.uri)};
         for (let i = 0; i < vs.length; i++) {
           let v = vs[i];
@@ -2130,6 +2179,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
 				yield `
               v = await this.#${property.singularName}_fromJsonLd(obj, {
                 ...options,
+                verifyPortableObject: this._verifyPortableObject,
                 baseUrl: ${cachedPropertyBaseUrl},
               });
       `;
@@ -2183,6 +2233,7 @@ const XSD_ANY_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
 const FEDIFY_URL = "fedify:url";
 const INTERNAL_RUNTIME_IMPORTS = [
 	"compactJsonLdCache",
+	"createScopedContextLoader",
 	"getJsonLdContext",
 	"isTrustedIriOrigin",
 	"normalizeJsonLdIris"
@@ -2264,6 +2315,7 @@ async function* generateClass(typeUri, types, moduleVarNames) {
     readonly #documentLoader?: DocumentLoader;
     readonly #contextLoader?: DocumentLoader;
     readonly #tracerProvider?: TracerProvider;
+    readonly #verifyPortableObject?: PortableObjectVerifier;
     readonly #warning?: {
       category: string[];
       message: string;
@@ -2286,6 +2338,10 @@ async function* generateClass(typeUri, types, moduleVarNames) {
         return this.#tracerProvider;
     }
 
+    protected get _verifyPortableObject(): PortableObjectVerifier | undefined {
+      return this.#verifyPortableObject;
+    }
+
     protected get _warning(): {
         category: string[];
         message: string;

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.2122+bdc0ce8d";
+var version = "2.4.0-dev.2129+c0ddb433";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -736,6 +736,7 @@ function* generatePreprocessorBlock(property, rangeTypeName, variable, baseUrlEx
             documentLoader: options.documentLoader,
             contextLoader: options.contextLoader,
             tracerProvider: options.tracerProvider,
+            verifyPortableObject: options.verifyPortableObject,
             baseUrl: ${baseUrlExpr},
           });
           if (_result instanceof Error) throw _result;
@@ -1004,6 +1005,10 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
    *                - \`contextLoader\`: The loader for remote JSON-LD contexts.
    *                - \`tracerProvider\`: The OpenTelemetry tracer provider to use.
    *                  If omitted, the global tracer provider is used.
+   *                - \`verifyPortableObject\`: The default FEP-ef61 portable
+   *                  object verifier for the property accessors of the
+   *                  returned object and the objects obtained from it.  It
+   *                  does not verify the given \`json\` itself.
    * @returns The object of this type.
    * @throws {TypeError} If the given \`json\` is invalid.
    */
@@ -1013,6 +1018,7 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
       baseUrl?: URL,
     } = {},
   ): Promise<${type.name}> {
@@ -1051,6 +1057,7 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
       baseUrl?: URL,
     } = {},
   ): Promise<${type.name}> {
@@ -1286,6 +1293,7 @@ async function* generateConstructor(typeUri, types) {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
       tracerProvider?: TracerProvider,
+      verifyPortableObject?: PortableObjectVerifier,
     } = {},
   ) {
   `;
@@ -1293,6 +1301,7 @@ async function* generateConstructor(typeUri, types) {
     this.#documentLoader = options.documentLoader;
     this.#contextLoader = options.contextLoader;
     this.#tracerProvider = options.tracerProvider;
+    this.#verifyPortableObject = options.verifyPortableObject;
     const baseUrl = (options as { baseUrl?: URL }).baseUrl;
     this.#_baseUrl = baseUrl == null ? undefined : new URL(baseUrl.href);
     if ("$warning" in options) {
@@ -1407,6 +1416,7 @@ async function* generateCloner(typeUri, types) {
     options: {
       documentLoader?: DocumentLoader,
       contextLoader?: DocumentLoader,
+      verifyPortableObject?: PortableObjectVerifier,
     } = {}
   ): ${type.name} {
     if (this._warning != null) {
@@ -1701,6 +1711,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                   documentLoader,
                   contextLoader: parseOptions.contextLoader,
                   tracerProvider,
+                  // Only the parent's own default is inherited, never the
+                  // verifier given to this call:
+                  verifyPortableObject: this._verifyPortableObject,
                   baseUrl: parseOptions.baseUrl,
                 }),
             });
@@ -1742,7 +1755,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         }
         let fetchResult: RemoteDocument;
         try {
-          fetchResult = await documentLoader(lookupUrl);
+          fetchResult = await documentLoader(lookupUrl, {
+            suppressError: options.suppressError,
+          });
         } catch (error) {
           span.setStatus({
             code: SpanStatusCode.ERROR,
@@ -1750,7 +1765,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           });
           span.end();
           if (options.suppressError) {
-            getLogger(["fedify", "vocab"]).error(
+            getLogger(["fedify", "vocab"]).warn(
               "Failed to fetch {url}: {error}",
               { error, url: lookupUrl }
             );
@@ -1762,8 +1777,12 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         // In portable mode, the document may turn out to be a portable object,
         // which has to be verified with the same context documents:
         const snapshot = portableMode
-          ? createSnapshotContextLoader(contextLoader)
+          ? createSnapshotContextLoader(contextLoader, options.suppressError)
           : null;
+        const scopedContext = createScopedContextLoader(
+          snapshot?.loader ?? contextLoader,
+          snapshot == null && options.suppressError,
+        );
         try {
           let claim: PortableResponseClaim | null | undefined;
           try {
@@ -1772,8 +1791,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
               document,
               {
                 documentLoader,
-                contextLoader: snapshot?.loader ?? contextLoader,
+                contextLoader: scopedContext.loader,
                 tracerProvider,
+                verifyPortableObject: this._verifyPortableObject,
                 baseUrl,
               }
             );
@@ -1816,7 +1836,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             }
           } catch (e) {
             if (options.suppressError) {
-              getLogger(["fedify", "vocab"]).error(
+              getLogger(["fedify", "vocab"]).warn(
                 "Failed to parse {url}: {error}",
                 { error: e, url: lookupUrl }
               );
@@ -1842,6 +1862,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             contextLoader: snapshot?.loader,
           });
         } finally {
+          scopedContext.release();
           snapshot?.release();
         }
       });
@@ -1853,6 +1874,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         documentLoader?: DocumentLoader,
         contextLoader?: DocumentLoader,
         tracerProvider?: TracerProvider,
+        verifyPortableObject?: PortableObjectVerifier,
         baseUrl?: URL
       }
     ): Promise<${getTypeNames(property.range, types)}> {
@@ -1863,6 +1885,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
       const tracerProvider = options.tracerProvider ??
         this._tracerProvider ?? trace.getTracerProvider();
       const baseUrl = options.baseUrl;
+      const verifyPortableObject = options.verifyPortableObject;
     `;
 		if (property.preprocessors != null && property.preprocessors.length > 0) {
 			yield `
@@ -1882,6 +1905,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
                 documentLoader,
                 contextLoader,
                 tracerProvider,
+                verifyPortableObject,
                 baseUrl,
               });
               if (_result instanceof Error) throw _result;
@@ -1900,7 +1924,13 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         try {
           return await ${types[range].name}.fromJsonLd(
             jsonLd,
-            { documentLoader, contextLoader, tracerProvider, baseUrl },
+            {
+              documentLoader,
+              contextLoader,
+              tracerProvider,
+              verifyPortableObject,
+              baseUrl,
+            },
           );
         } catch (e) {
           if (!(e instanceof TypeError)) throw e;
@@ -1953,6 +1983,15 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           );
         }
         if (this.${await getFieldName(property.uri)}.length < 1) return null;
+        if (
+          options.verifyPortableObject == null &&
+          this._verifyPortableObject != null
+        ) {
+          options = {
+            ...options,
+            verifyPortableObject: this._verifyPortableObject,
+          };
+        }
         let v = this.${await getFieldName(property.uri)}[0];
         if (!(v instanceof URL) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
@@ -1999,6 +2038,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
 				yield `
             v = await this.#${property.singularName}_fromJsonLd(doc, {
               ...options,
+              verifyPortableObject: this._verifyPortableObject,
               baseUrl: ${cachedPropertyBaseUrl},
             });
       `;
@@ -2077,6 +2117,15 @@ async function* generateProperty(type, property, types, moduleVarNames) {
             this._warning.values
           );
         }
+        if (
+          options.verifyPortableObject == null &&
+          this._verifyPortableObject != null
+        ) {
+          options = {
+            ...options,
+            verifyPortableObject: this._verifyPortableObject,
+          };
+        }
         const vs = this.${await getFieldName(property.uri)};
         for (let i = 0; i < vs.length; i++) {
           let v = vs[i];
@@ -2129,6 +2178,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
 				yield `
               v = await this.#${property.singularName}_fromJsonLd(obj, {
                 ...options,
+                verifyPortableObject: this._verifyPortableObject,
                 baseUrl: ${cachedPropertyBaseUrl},
               });
       `;
@@ -2182,6 +2232,7 @@ const XSD_ANY_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
 const FEDIFY_URL = "fedify:url";
 const INTERNAL_RUNTIME_IMPORTS = [
 	"compactJsonLdCache",
+	"createScopedContextLoader",
 	"getJsonLdContext",
 	"isTrustedIriOrigin",
 	"normalizeJsonLdIris"
@@ -2263,6 +2314,7 @@ async function* generateClass(typeUri, types, moduleVarNames) {
     readonly #documentLoader?: DocumentLoader;
     readonly #contextLoader?: DocumentLoader;
     readonly #tracerProvider?: TracerProvider;
+    readonly #verifyPortableObject?: PortableObjectVerifier;
     readonly #warning?: {
       category: string[];
       message: string;
@@ -2285,6 +2337,10 @@ async function* generateClass(typeUri, types, moduleVarNames) {
         return this.#tracerProvider;
     }
 
+    protected get _verifyPortableObject(): PortableObjectVerifier | undefined {
+      return this.#verifyPortableObject;
+    }
+
     protected get _warning(): {
         category: string[];
         message: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.2122+bdc0ce8d",
+  "version": "2.4.0-dev.2129+c0ddb433",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {