@fedify/vocab-tools 2.4.0-dev.1508 → 2.4.0-dev.1531

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.1508+68519bf4";
+var version = "2.4.0-dev.1531+0896bc51";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -155,10 +155,10 @@ const scalarTypes = {
 			return `${v} instanceof URL`;
 		},
 		encoder(v) {
-			return `{ "@id": ${v}.href }`;
+			return `{ "@id": formatIri(${v}) }`;
 		},
 		compactEncoder(v) {
-			return `${v}.href`;
+			return `formatIri(${v})`;
 		},
 		dataCheck(v) {
 			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
@@ -166,22 +166,7 @@ const scalarTypes = {
         && ${v}["@id"] !== ""`;
 		},
 		decoder(v, baseUrlVar) {
-			return `${v}["@id"].startsWith("at://")
-        ? new URL("at://" +
-          encodeURIComponent(
-            ${v}["@id"].includes("/", 5)
-              ? ${v}["@id"].slice(5, ${v}["@id"].indexOf("/", 5))
-              : ${v}["@id"].slice(5)
-          ) +
-          (
-            ${v}["@id"].includes("/", 5)
-              ? ${v}["@id"].slice(${v}["@id"].indexOf("/", 5))
-              : ""
-          )
-        )
-        : URL.canParse(${v}["@id"]) && ${baseUrlVar}
-          ? new URL(${v}["@id"])
-          : new URL(${v}["@id"], ${baseUrlVar})`;
+			return `parseIri(${v}["@id"], ${baseUrlVar})`;
 		}
 	},
 	"http://www.w3.org/1999/02/22-rdf-syntax-ns#langString": {
@@ -323,10 +308,10 @@ const scalarTypes = {
 			return `${v} instanceof URL`;
 		},
 		encoder(v) {
-			return `{ "@value": ${v}.href }`;
+			return `{ "@value": formatIri(${v}) }`;
 		},
 		compactEncoder(v) {
-			return `${v}.href`;
+			return `formatIri(${v})`;
 		},
 		dataCheck(v) {
 			return `typeof ${v} === "object" && "@value" in ${v}
@@ -334,7 +319,7 @@ const scalarTypes = {
         && ${v}["@value"] !== "" && ${v}["@value"] !== "/"`;
 		},
 		decoder(v) {
-			return `new URL(${v}["@value"])`;
+			return `parseIri(${v}["@value"])`;
 		}
 	},
 	"fedify:publicKey": {
@@ -804,7 +789,7 @@ 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 ? v.href : ";
+			if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? formatIri(v) : ";
 			const encoders = getEncoders(property.range, types, "v", "options", true);
 			for (const code of encoders) yield code;
 			yield `
@@ -835,7 +820,7 @@ async function* generateEncoder(typeUri, types) {
 		}
 		yield `
       ${type.typeless ? "" : `result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};`}
-      if (this.id != null) result["id"] = this.id.href;
+      if (this.id != null) result["id"] = formatIri(this.id);
       result["@context"] = ${JSON.stringify(type.defaultContext)};
       return result;
     }
@@ -863,7 +848,7 @@ async function* generateEncoder(typeUri, types) {
     for (const v of this.${await getFieldName(property.uri)}) {
       const element = (
     `;
-		if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? { \"@id\": v.href } : ";
+		if (!areAllScalarTypes(property.range, types)) yield "v instanceof URL ? { \"@id\": formatIri(v) } : ";
 		for (const code of getEncoders(property.range, types, "v", "options")) yield code;
 		yield `
       );
@@ -890,7 +875,7 @@ async function* generateEncoder(typeUri, types) {
 	}
 	yield `
     ${type.typeless ? "" : `values["@type"] = [${JSON.stringify(type.uri)}];`}
-    if (this.id != null) values["@id"] = this.id.href;
+    if (this.id != null) values["@id"] = formatIri(this.id);
     if (options.format === "expand") {
       return await jsonld.expand(
         values,
@@ -1016,10 +1001,12 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
     };
     // deno-lint-ignore no-explicit-any
     let values: Record<string, any[]> & { "@id"?: string };
+    let expanded: unknown[];
     if (globalThis.Object.keys(json).length == 0) {
       values = {};
+      expanded = [values];
     } else {
-      const expanded = await jsonld.expand(json, {
+      expanded = await jsonld.expand(json, {
         documentLoader: options.contextLoader,
         keepFreeFloatingNodes: true,
       });
@@ -1027,11 +1014,9 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
         // deno-lint-ignore no-explicit-any
         (expanded[0] ?? {}) as (Record<string, any[]> & { "@id"?: string });
     }
-    if (values["@id"] != null && !values["@id"].startsWith("_:") && !URL.canParse(values["@id"], options.baseUrl)) {
-      throw new TypeError("Invalid @id: " + values["@id"]);
-    }
-    if (options.baseUrl == null && values["@id"] != null && !values["@id"].startsWith("_:") && URL.canParse(values["@id"])) {
-      options = { ...options, baseUrl: new URL(values["@id"]) };
+    const id = parseJsonLdId(values["@id"], options.baseUrl);
+    if (id != null && options.baseUrl == null) {
+      options = { ...options, baseUrl: id };
     }
   `;
 	const subtypes = getSubtypes(typeUri, types, true);
@@ -1052,10 +1037,24 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       throw new TypeError("Invalid type: " + values["@type"]);
     }
   }
+  `;
+	yield `
+    let cacheJsonLd = !("_fromSubclass" in options) || !options._fromSubclass
+      ? normalizeJsonLdIris(
+        expanded,
+        PORTABLE_IRI_KEYS,
+        PORTABLE_IRI_PATTERN,
+      )
+      : undefined;
+    if (cacheJsonLd != null && cacheJsonLd !== expanded) {
+      cacheJsonLd = structuredClone(cacheJsonLd);
+    }
   `;
 	if (type.extends == null) yield `
     const instance = new this(
-      { id: values["@id"] != null && !values["@id"].startsWith("_:") && URL.canParse(values["@id"], options.baseUrl) ? new URL(values["@id"], options.baseUrl) : undefined },
+      {
+        id
+      },
       options,
     );
     `;
@@ -1098,11 +1097,7 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
       if (typeof v === "object" && "@id" in v && !("@type" in v)
           && globalThis.Object.keys(v).length === 1) {
         if (v["@id"].startsWith("_:")) continue;
-        ${variable}.push(
-          !URL.canParse(v["@id"], ${propertyBaseUrl}) && v["@id"].startsWith("at://")
-            ? new URL("at://" + encodeURIComponent(v["@id"].substring(5)))
-            : new URL(v["@id"], ${propertyBaseUrl})
-        );
+        ${variable}.push(parseIri(v["@id"], ${propertyBaseUrl}));
         continue;
       }
       `;
@@ -1130,7 +1125,19 @@ async function* generateDecoder(typeUri, types, moduleVarNames) {
 	yield `
     if (!("_fromSubclass" in options) || !options._fromSubclass) {
       try {
-        instance._cachedJsonLd = structuredClone(json);
+        if (cacheJsonLd != null && cacheJsonLd !== expanded) {
+          const compactArray = Array.isArray(json) && json.length === 1;
+          const jsonLd = compactArray ? json[0] : json;
+          const normalized = cacheJsonLd;
+          const cachedJsonLd = await compactJsonLdCache(
+            normalized,
+            jsonLd,
+            options.contextLoader,
+          );
+          instance._cachedJsonLd = compactArray ? [cachedJsonLd] : cachedJsonLd;
+        } else {
+          instance._cachedJsonLd = structuredClone(json);
+        }
       } catch {
         getLogger(["fedify", "vocab"]).warn(
           "Failed to cache JSON-LD: {json}",
@@ -1557,9 +1564,10 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         ${JSON.stringify(version)},
       );
       return await tracer.startActiveSpan("activitypub.lookup_object", async (span) => {
+        const lookupUrl = formatIri(url);
         let fetchResult: RemoteDocument;
         try {
-          fetchResult = await documentLoader(url.href);
+          fetchResult = await documentLoader(lookupUrl);
         } catch (error) {
           span.setStatus({
             code: SpanStatusCode.ERROR,
@@ -1569,21 +1577,20 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           if (options.suppressError) {
             getLogger(["fedify", "vocab"]).error(
               "Failed to fetch {url}: {error}",
-              { error, url: url.href }
+              { error, url: lookupUrl }
             );
             return null;
           }
           throw error;
         }
         const { document, documentUrl } = fetchResult;
-        const baseUrl = new URL(documentUrl);
+        const baseUrl = parseIri(documentUrl);
         try {
           const obj = await this.#${property.singularName}_fromJsonLd(
             document,
             { documentLoader, contextLoader, tracerProvider, baseUrl }
           );
-          if (options.crossOrigin !== "trust" && obj?.id != null &&
-              obj.id.origin !== baseUrl.origin) {
+          if (obj?.id != null && !isTrustedIriOrigin(options, obj.id, baseUrl)) {
             if (options.crossOrigin === "throw") {
               throw new Error(
                 "The object's @id (" + obj.id.href + ") has a different origin " +
@@ -1612,7 +1619,7 @@ async function* generateProperty(type, property, types, moduleVarNames) {
           if (options.suppressError) {
             getLogger(["fedify", "vocab"]).error(
               "Failed to parse {url}: {error}",
-              { error: e, url: url.href }
+              { error: e, url: lookupUrl }
             );
             return null;
           }
@@ -1732,8 +1739,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         }
         if (this.${await getFieldName(property.uri)}.length < 1) return null;
         let v = this.${await getFieldName(property.uri)}[0];
-        if (options.crossOrigin !== "trust" && !(v instanceof URL) &&
-            v.id != null && v.id.origin !== this.id?.origin &&
+        if (!(v instanceof URL) &&
+            v.id != null &&
+            !isTrustedIriOrigin(options, v.id, this.id) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
           v = v.id;
         }
@@ -1772,8 +1780,8 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         `;
 			}
 			yield `
-        if (options.crossOrigin !== "trust" && v?.id != null &&
-            this.id != null && v.id.origin !== this.id.origin &&
+        if (v?.id != null &&
+            this.id != null && !isTrustedIriOrigin(options, v.id, this.id) &&
             !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
           if (options.crossOrigin === "throw") {
             throw new Error(
@@ -1837,8 +1845,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         const vs = this.${await getFieldName(property.uri)};
         for (let i = 0; i < vs.length; i++) {
           let v = vs[i];
-          if (options.crossOrigin !== "trust" && !(v instanceof URL) &&
-              v.id != null && v.id.origin !== this.id?.origin &&
+          if (!(v instanceof URL) &&
+              v.id != null &&
+              !isTrustedIriOrigin(options, v.id, this.id) &&
               !this.${await getFieldName(property.uri, "#_trust")}.has(i)) {
             v = v.id;
           }
@@ -1878,9 +1887,9 @@ async function* generateProperty(type, property, types, moduleVarNames) {
         `;
 			}
 			yield `
-          if (options.crossOrigin !== "trust" && v?.id != null &&
-              this.id != null && v.id.origin !== this.id.origin &&
-              !this.${await getFieldName(property.uri, "#_trust")}.has(0)) {
+          if (v?.id != null &&
+              this.id != null && !isTrustedIriOrigin(options, v.id, this.id) &&
+              !this.${await getFieldName(property.uri, "#_trust")}.has(i)) {
             if (options.crossOrigin === "throw") {
               throw new Error(
                 "The property object's @id (" + v.id.href + ") has a different " +
@@ -1913,6 +1922,33 @@ async function* generateProperties(typeUri, types, moduleVarNames) {
 }
 //#endregion
 //#region src/class.ts
+const XSD_ANY_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
+const FEDIFY_URL = "fedify:url";
+const INTERNAL_RUNTIME_IMPORTS = [
+	"compactJsonLdCache",
+	"getJsonLdContext",
+	"isTrustedIriOrigin",
+	"normalizeJsonLdIris"
+].join(",\n    ");
+const RUNTIME_IMPORTS = [
+	"canParseDecimal",
+	"decodeMultibase",
+	"type Decimal",
+	"type DocumentLoader",
+	"encodeMultibase",
+	"exportMultibaseKey",
+	"exportSpki",
+	"formatIri",
+	"getDocumentLoader",
+	"importMultibaseKey",
+	"importPem",
+	"isDecimal",
+	"LanguageString",
+	"parseDecimal",
+	"parseIri",
+	"parseJsonLdId",
+	"type RemoteDocument"
+].join(",\n    ");
 /**
 * Sorts the given types topologically so that the base types come before the
 * extended types.
@@ -2046,6 +2082,18 @@ export function getEntityTypeById(id: string | URL): $EntityType | undefined {
 
 `;
 }
+function canContainIriValue(property, types) {
+	return property.range.some((typeUri) => typeUri === XSD_ANY_URI || typeUri === FEDIFY_URL || types[typeUri]?.entity);
+}
+function addKeys(keys, property) {
+	keys.add(property.uri);
+	if (property.compactName != null) keys.add(property.compactName);
+}
+function addPortableIriKeys(keys, property, types) {
+	if (!canContainIriValue(property, types)) return;
+	addKeys(keys, property);
+	if ("redundantProperties" in property && property.redundantProperties != null) for (const redundantProperty of property.redundantProperties) addKeys(keys, redundantProperty);
+}
 /**
 * Generates the TypeScript classes from the given types.
 * @param types The types to generate classes from.
@@ -2053,33 +2101,21 @@ export function getEntityTypeById(id: string | URL): $EntityType | undefined {
 */
 async function* generateClasses(types) {
 	validateTypeSchemas(types);
-	const runtimeImports = [
-		"canParseDecimal",
-		"decodeMultibase",
-		"type Decimal",
-		"type DocumentLoader",
-		"encodeMultibase",
-		"exportMultibaseKey",
-		"exportSpki",
-		"getDocumentLoader",
-		"importMultibaseKey",
-		"importPem",
-		"isDecimal",
-		"LanguageString",
-		"parseDecimal",
-		"type RemoteDocument"
-	];
 	yield "// deno-lint-ignore-file ban-unused-ignore no-explicit-any no-unused-vars prefer-const verbatim-module-syntax\n";
 	yield "import jsonld from \"@fedify/vocab-runtime/jsonld\";\n";
 	yield "import { getLogger } from \"@logtape/logtape\";\n";
 	yield `import { type Span, SpanStatusCode, type TracerProvider, trace }
     from "@opentelemetry/api";\n`;
-	yield `import {\n    ${runtimeImports.join(",\n    ")}\n} from "@fedify/vocab-runtime";\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 {
     isTemporalDuration,
     isTemporalInstant,
 } from "@fedify/vocab-runtime/temporal";\n`;
-	yield "\n\n";
+	const portableIriKeys = new Set(["@id", "id"]);
+	for (const type of Object.values(types)) for (const property of type.properties) addPortableIriKeys(portableIriKeys, property, types);
+	yield "const PORTABLE_IRI_PATTERN = /^ap(?:\\+ef61)?:\\/\\//i;\n";
+	yield `const PORTABLE_IRI_KEYS: ReadonlySet<string> = new Set(${JSON.stringify([...portableIriKeys].sort())});\n\n`;
 	const moduleVarNames = /* @__PURE__ */ new Map();
 	const sorted = sortTopologically(types);
 	for (const typeUri of sorted) for (const property of types[typeUri].properties) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.4.0-dev.1508+68519bf4",
+  "version": "2.4.0-dev.1531+0896bc51",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {