@fedify/vocab-tools 2.5.0-dev.2332 → 2.5.0-dev.2355

package/README.md

@@ -52,10 +52,20 @@ Conditional contexts and metadata trust
 ---------------------------------------
 
 A property schema can set `extraContext` to a context URL.  The generated
-serializer adds it to its default context when the property's expanded IRI
-appears after compaction, including inside nested objects.  A caller-provided
-context takes precedence.  When populated, such a property uses the JSON-LD
-processor so context container rules, including `@set`, are respected.
+serializer adds it to its default context when the property is populated,
+including inside nested objects, even if the default context already defines a
+prefix that could abbreviate the property's IRI.  A nested object kept in its
+received form is recognized by the context URL or the full property IRI it
+uses.  A caller-provided context takes precedence.  When populated, such a
+property uses the JSON-LD processor so context container rules, including
+`@set`, are respected.
+
+The `fedify:absoluteIri` range is a `URL` written as an IRI reference
+(`@id`).  When reading, it also accepts plain string literals and literals
+typed as `xsd:string` or `xsd:anyURI`, because publishers do not always coerce
+the property's term to an IRI.  The decoder never resolves a value against the
+object's ID or a base URL, so a value must already be absolute after JSON-LD
+expansion; values that are not are skipped.
 
 A type schema can set `trustEmbeddedObjects: false` when its identifier is
 metadata rather than a resource that establishes an origin.  Its own

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.5.0-dev.2332+d4e3f91f",
+  "version": "2.5.0-dev.2355+c92a1cb1",
   "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.5.0-dev.2332+d4e3f91f";
+var version = "2.5.0-dev.2355+c92a1cb1";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -327,6 +327,25 @@ const scalarTypes = {
 		},
 		skipUnparsable: true
 	},
+	"fedify:absoluteIri": {
+		name: "URL",
+		typeGuard(v) {
+			return `${v} instanceof URL`;
+		},
+		encoder(v) {
+			return `{ "@id": formatIri(${v}) }`;
+		},
+		compactEncoder(v) {
+			return `formatIri(${v})`;
+		},
+		dataCheck(v) {
+			return `isAbsoluteIriValue(${v})`;
+		},
+		decoder(v) {
+			return `decodeIri(getAbsoluteIriValue(${v})!)`;
+		},
+		skipUnparsable: true
+	},
 	"fedify:gatewayUrl": {
 		name: "URL",
 		typeGuard(v) {
@@ -940,13 +959,27 @@ async function* generateEncoder(typeUri, types) {
     }
     let docContext: Parameters<typeof jsonld.compact>[1] = options.context ??
       ${JSON.stringify(type.defaultContext)};
+  `;
+	const hasExtraContexts = Object.values(types).some((t) => t.properties.some((p) => p.extraContext != null));
+	if (hasExtraContexts) yield `
+    if (options.context == null) {
+      const currentContexts = Array.isArray(docContext) ? docContext : [docContext];
+      const additionalContexts = getExtraContexts(values).filter(
+        context => !currentContexts.includes(context)
+      );
+      if (additionalContexts.length > 0) {
+        docContext = [...currentContexts, ...additionalContexts];
+      }
+    }
+    `;
+	yield `
     let compacted = await jsonld.compact(
       values,
       docContext,
       { documentLoader: options.contextLoader },
     );
   `;
-	if (Object.values(types).some((t) => t.properties.some((p) => p.extraContext != null))) yield `
+	if (hasExtraContexts) yield `
     if (options.context == null) {
       const currentContexts = Array.isArray(docContext) ? docContext : [docContext];
       const additionalContexts = getExtraContexts(compacted).filter(
@@ -2294,6 +2327,7 @@ async function* generateProperties(typeUri, types, moduleVarNames) {
 //#region src/class.ts
 const XSD_ANY_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
 const FEDIFY_URL = "fedify:url";
+const FEDIFY_ABSOLUTE_IRI = "fedify:absoluteIri";
 const INTERNAL_RUNTIME_IMPORTS = [
 	"compactJsonLdCache",
 	"createScopedContextLoader",
@@ -2502,7 +2536,7 @@ 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);
+	return property.range.some((typeUri) => typeUri === XSD_ANY_URI || typeUri === FEDIFY_URL || typeUri === FEDIFY_ABSOLUTE_IRI || types[typeUri]?.entity);
 }
 function addKeys(keys, property) {
 	keys.add(property.uri);
@@ -2560,12 +2594,38 @@ function isValidLanguageTag(language: string): boolean {
     throw error;
   }
 }
+`;
+	if (Object.values(types).some((type) => type.properties.some((property) => property.range.includes(FEDIFY_ABSOLUTE_IRI)))) yield `
+function getAbsoluteIriValue(value: unknown): string | undefined {
+  if (value == null || typeof value !== "object") return undefined;
+  const node = value as Record<string, unknown>;
+  if (typeof node["@id"] === "string") {
+    return node["@id"].startsWith("_:") ? undefined : node["@id"];
+  }
+  // A language tag can come from a context's default language, so it does
+  // not make a literal any less of an IRI:
+  if (typeof node["@value"] !== "string") return undefined;
+  const type = node["@type"];
+  return type == null ||
+      type === "http://www.w3.org/2001/XMLSchema#string" ||
+      type === "http://www.w3.org/2001/XMLSchema#anyURI"
+    ? node["@value"]
+    : undefined;
+}
+
+function isAbsoluteIriValue(value: unknown): boolean {
+  const iri = getAbsoluteIriValue(value);
+  return iri != null && canDecodeIri(iri);
+}
 `;
 	const extraContexts = Object.fromEntries(Object.values(types).flatMap((type) => type.properties.flatMap((property) => property.extraContext == null ? [] : [[property.uri, property.extraContext]])));
 	if (Object.keys(extraContexts).length > 0) yield `
 const extraPropertyContexts: Readonly<Record<string, string>> =
   ${JSON.stringify(extraContexts)};
 
+const extraContextUrls: readonly string[] =
+  ${JSON.stringify([...new Set(Object.values(extraContexts))])};
+
 function getExtraContexts(document: unknown): string[] {
   const contexts = new Set<string>();
   const pending: unknown[] = [document];
@@ -2578,7 +2638,16 @@ function getExtraContexts(document: unknown): string[] {
     }
     if ("@value" in value) continue;
     for (const [key, child] of globalThis.Object.entries(value)) {
-      if (key === "@context") continue;
+      if (key === "@context") {
+        for (const context of Array.isArray(child) ? child : [child]) {
+          if (
+            typeof context === "string" && extraContextUrls.includes(context)
+          ) {
+            contexts.add(context);
+          }
+        }
+        continue;
+      }
       if (globalThis.Object.hasOwn(extraPropertyContexts, key)) {
         contexts.add(extraPropertyContexts[key]);
       }

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.5.0-dev.2332+d4e3f91f";
+var version = "2.5.0-dev.2355+c92a1cb1";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -326,6 +326,25 @@ const scalarTypes = {
 		},
 		skipUnparsable: true
 	},
+	"fedify:absoluteIri": {
+		name: "URL",
+		typeGuard(v) {
+			return `${v} instanceof URL`;
+		},
+		encoder(v) {
+			return `{ "@id": formatIri(${v}) }`;
+		},
+		compactEncoder(v) {
+			return `formatIri(${v})`;
+		},
+		dataCheck(v) {
+			return `isAbsoluteIriValue(${v})`;
+		},
+		decoder(v) {
+			return `decodeIri(getAbsoluteIriValue(${v})!)`;
+		},
+		skipUnparsable: true
+	},
 	"fedify:gatewayUrl": {
 		name: "URL",
 		typeGuard(v) {
@@ -939,13 +958,27 @@ async function* generateEncoder(typeUri, types) {
     }
     let docContext: Parameters<typeof jsonld.compact>[1] = options.context ??
       ${JSON.stringify(type.defaultContext)};
+  `;
+	const hasExtraContexts = Object.values(types).some((t) => t.properties.some((p) => p.extraContext != null));
+	if (hasExtraContexts) yield `
+    if (options.context == null) {
+      const currentContexts = Array.isArray(docContext) ? docContext : [docContext];
+      const additionalContexts = getExtraContexts(values).filter(
+        context => !currentContexts.includes(context)
+      );
+      if (additionalContexts.length > 0) {
+        docContext = [...currentContexts, ...additionalContexts];
+      }
+    }
+    `;
+	yield `
     let compacted = await jsonld.compact(
       values,
       docContext,
       { documentLoader: options.contextLoader },
     );
   `;
-	if (Object.values(types).some((t) => t.properties.some((p) => p.extraContext != null))) yield `
+	if (hasExtraContexts) yield `
     if (options.context == null) {
       const currentContexts = Array.isArray(docContext) ? docContext : [docContext];
       const additionalContexts = getExtraContexts(compacted).filter(
@@ -2293,6 +2326,7 @@ async function* generateProperties(typeUri, types, moduleVarNames) {
 //#region src/class.ts
 const XSD_ANY_URI = "http://www.w3.org/2001/XMLSchema#anyURI";
 const FEDIFY_URL = "fedify:url";
+const FEDIFY_ABSOLUTE_IRI = "fedify:absoluteIri";
 const INTERNAL_RUNTIME_IMPORTS = [
 	"compactJsonLdCache",
 	"createScopedContextLoader",
@@ -2501,7 +2535,7 @@ 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);
+	return property.range.some((typeUri) => typeUri === XSD_ANY_URI || typeUri === FEDIFY_URL || typeUri === FEDIFY_ABSOLUTE_IRI || types[typeUri]?.entity);
 }
 function addKeys(keys, property) {
 	keys.add(property.uri);
@@ -2559,12 +2593,38 @@ function isValidLanguageTag(language: string): boolean {
     throw error;
   }
 }
+`;
+	if (Object.values(types).some((type) => type.properties.some((property) => property.range.includes(FEDIFY_ABSOLUTE_IRI)))) yield `
+function getAbsoluteIriValue(value: unknown): string | undefined {
+  if (value == null || typeof value !== "object") return undefined;
+  const node = value as Record<string, unknown>;
+  if (typeof node["@id"] === "string") {
+    return node["@id"].startsWith("_:") ? undefined : node["@id"];
+  }
+  // A language tag can come from a context's default language, so it does
+  // not make a literal any less of an IRI:
+  if (typeof node["@value"] !== "string") return undefined;
+  const type = node["@type"];
+  return type == null ||
+      type === "http://www.w3.org/2001/XMLSchema#string" ||
+      type === "http://www.w3.org/2001/XMLSchema#anyURI"
+    ? node["@value"]
+    : undefined;
+}
+
+function isAbsoluteIriValue(value: unknown): boolean {
+  const iri = getAbsoluteIriValue(value);
+  return iri != null && canDecodeIri(iri);
+}
 `;
 	const extraContexts = Object.fromEntries(Object.values(types).flatMap((type) => type.properties.flatMap((property) => property.extraContext == null ? [] : [[property.uri, property.extraContext]])));
 	if (Object.keys(extraContexts).length > 0) yield `
 const extraPropertyContexts: Readonly<Record<string, string>> =
   ${JSON.stringify(extraContexts)};
 
+const extraContextUrls: readonly string[] =
+  ${JSON.stringify([...new Set(Object.values(extraContexts))])};
+
 function getExtraContexts(document: unknown): string[] {
   const contexts = new Set<string>();
   const pending: unknown[] = [document];
@@ -2577,7 +2637,16 @@ function getExtraContexts(document: unknown): string[] {
     }
     if ("@value" in value) continue;
     for (const [key, child] of globalThis.Object.entries(value)) {
-      if (key === "@context") continue;
+      if (key === "@context") {
+        for (const context of Array.isArray(child) ? child : [child]) {
+          if (
+            typeof context === "string" && extraContextUrls.includes(context)
+          ) {
+            contexts.add(context);
+          }
+        }
+        continue;
+      }
       if (globalThis.Object.hasOwn(extraPropertyContexts, key)) {
         contexts.add(extraPropertyContexts[key]);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.5.0-dev.2332+d4e3f91f",
+  "version": "2.5.0-dev.2355+c92a1cb1",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {
@@ -51,7 +51,7 @@
     "@types/node": "^24.12.2",
     "tsdown": "^0.22.0",
     "typescript": "^6.0.0",
-    "@fedify/vocab-runtime": "^2.5.0-dev.2332+d4e3f91f"
+    "@fedify/vocab-runtime": "^2.5.0-dev.2355+c92a1cb1"
   },
   "dependencies": {
     "@cfworker/json-schema": "^4.1.1",