@fedify/vocab-tools 2.2.0-dev.731 → 2.2.0-dev.766

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.2.0-dev.731+3d1ca85e",
+  "version": "2.2.0-dev.766+e04e54aa",
   "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.2.0-dev.731+3d1ca85e";
+var version = "2.2.0-dev.766+e04e54aa";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -162,7 +162,7 @@ const scalarTypes = {
 			return `${v}.href`;
 		},
 		dataCheck(v) {
-			return `typeof ${v} === "object" && "@id" in ${v}
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
         && typeof ${v}["@id"] === "string"
         && ${v}["@id"] !== ""`;
 		},
@@ -401,7 +401,7 @@ const scalarTypes = {
 			return v;
 		},
 		dataCheck(v) {
-			return `typeof ${v} === "object" && "@id" in ${v}
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
         && typeof ${v}["@id"] === "string"
         && ${v}["@id"].startsWith("https://w3id.org/security#")
         && [
@@ -431,6 +431,36 @@ const scalarTypes = {
 		decoder(v) {
 			return `${v}["@value"]`;
 		}
+	},
+	"fedify:vocabEntityType": {
+		name: "$EntityType",
+		typeGuard(v) {
+			return `isEntityType(${v})`;
+		},
+		encoder(v) {
+			return `{ "@id": ${v}.typeId.href }`;
+		},
+		dataCheck(v) {
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
+        && typeof ${v}["@id"] === "string"
+        && ${v}["@id"] !== ""`;
+		},
+		decoder(v) {
+			return `(() => {
+        if (${v} == null || typeof ${v} !== "object" || !("@id" in ${v}) ||
+            typeof ${v}["@id"] !== "string" || ${v}["@id"] === "") {
+          return undefined;
+        }
+        const entityType = getEntityTypeById(${v}["@id"]);
+        if (entityType == null) {
+          getLogger(["fedify", "vocab"]).warn(
+            "Ignoring unknown vocabulary entity type reference: {typeId}",
+            { typeId: ${v}["@id"] },
+          );
+        }
+        return entityType;
+      })()`;
+		}
 	}
 };
 function getTypeName(typeUri, types) {
@@ -592,6 +622,7 @@ function hasSingularAccessor(property) {
 }
 const XSD_STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
 const XSD_DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
+const FEDIFY_VOCAB_ENTITY_TYPE_URI = "fedify:vocabEntityType";
 /**
 * Validates schema combinations that cannot be represented safely by the
 * generated code.
@@ -608,6 +639,7 @@ function validateTypeSchemas(types) {
 		const hasString = property.range.includes(XSD_STRING_URI);
 		const hasDecimal = property.range.includes(XSD_DECIMAL_URI);
 		if (hasString && hasDecimal) throw new TypeError(`The property ${type.name}.${property.singularName} cannot have both xsd:string and xsd:decimal in its range because the generated encoder cannot disambiguate them at runtime.`);
+		if (property.range.includes(FEDIFY_VOCAB_ENTITY_TYPE_URI) && property.range.length > 1) throw new TypeError(`The property ${type.name}.${property.singularName} cannot mix fedify:vocabEntityType with other range types because the generated decoder cannot disambiguate entity type references from ordinary IRIs.`);
 	}
 }
 /**
@@ -1037,7 +1069,10 @@ async function* generateDecoder(typeUri, types) {
         continue;
       }
       `;
-		if (property.range.length == 1) yield `${variable}.push(${getDecoder(property.range[0], types, "v", "options", `(values["@id"] == null ? options.baseUrl : new URL(values["@id"]))`)})`;
+		if (property.range.length == 1) yield `
+      const decoded = ${getDecoder(property.range[0], types, "v", "options", `(values["@id"] == null ? options.baseUrl : new URL(values["@id"]))`)};
+      if (typeof decoded === "undefined") continue;
+      ${variable}.push(decoded);`;
 		else {
 			yield `
       const decoded =
@@ -1871,6 +1906,47 @@ async function* generateClass(typeUri, types) {
 	yield "}\n\n";
 	for await (const code of generateInspectorPostClass(typeUri, types)) yield code;
 }
+function* generateEntityTypeHelpers(sortedTypeUris, types) {
+	const entityTypes = sortedTypeUris.filter((typeUri) => types[typeUri].entity).map((typeUri) => ({
+		name: types[typeUri].name,
+		uri: typeUri
+	}));
+	const entityTypeNames = entityTypes.map((entityType) => entityType.name);
+	yield `/**
+ * Constructor types for all generated vocabulary entity classes.
+ */
+export type $EntityType =${entityTypeNames.length < 1 ? " never" : `\n  | typeof ${entityTypeNames.join("\n  | typeof ")}`};
+
+const entityTypes: readonly $EntityType[] = [
+`;
+	for (const entityTypeName of entityTypeNames) yield `  ${entityTypeName},\n`;
+	yield `];
+
+const entityTypeSet: ReadonlySet<$EntityType> = new Set(entityTypes);
+
+const entityTypeIds: ReadonlyMap<string, $EntityType> = new Map<string, $EntityType>(
+  [
+`;
+	for (const entityType of entityTypes) yield `    [${JSON.stringify(entityType.uri)}, ${entityType.name}],\n`;
+	yield `  ],
+);
+
+/**
+ * Checks whether the given value is a generated vocabulary entity class.
+ */
+export function isEntityType(value: unknown): value is $EntityType {
+  return entityTypeSet.has(value as $EntityType);
+}
+
+/**
+ * Gets the generated vocabulary entity class for the given type URI.
+ */
+export function getEntityTypeById(id: string | URL): $EntityType | undefined {
+  return entityTypeIds.get(typeof id === "string" ? id : id?.href);
+}
+
+`;
+}
 /**
 * Generates the TypeScript classes from the given types.
 * @param types The types to generate classes from.
@@ -1903,6 +1979,7 @@ async function* generateClasses(types) {
 	yield "\n\n";
 	const sorted = sortTopologically(types);
 	for (const typeUri of sorted) for await (const code of generateClass(typeUri, types)) yield code;
+	for (const code of generateEntityTypeHelpers(sorted, types)) yield code;
 }
 //#endregion
 //#region src/generate.ts

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.2.0-dev.731+3d1ca85e";
+var version = "2.2.0-dev.766+e04e54aa";
 //#endregion
 //#region src/type.ts
 const HEURISTICS_CONTEXTS = [
@@ -161,7 +161,7 @@ const scalarTypes = {
 			return `${v}.href`;
 		},
 		dataCheck(v) {
-			return `typeof ${v} === "object" && "@id" in ${v}
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
         && typeof ${v}["@id"] === "string"
         && ${v}["@id"] !== ""`;
 		},
@@ -400,7 +400,7 @@ const scalarTypes = {
 			return v;
 		},
 		dataCheck(v) {
-			return `typeof ${v} === "object" && "@id" in ${v}
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
         && typeof ${v}["@id"] === "string"
         && ${v}["@id"].startsWith("https://w3id.org/security#")
         && [
@@ -430,6 +430,36 @@ const scalarTypes = {
 		decoder(v) {
 			return `${v}["@value"]`;
 		}
+	},
+	"fedify:vocabEntityType": {
+		name: "$EntityType",
+		typeGuard(v) {
+			return `isEntityType(${v})`;
+		},
+		encoder(v) {
+			return `{ "@id": ${v}.typeId.href }`;
+		},
+		dataCheck(v) {
+			return `${v} != null && typeof ${v} === "object" && "@id" in ${v}
+        && typeof ${v}["@id"] === "string"
+        && ${v}["@id"] !== ""`;
+		},
+		decoder(v) {
+			return `(() => {
+        if (${v} == null || typeof ${v} !== "object" || !("@id" in ${v}) ||
+            typeof ${v}["@id"] !== "string" || ${v}["@id"] === "") {
+          return undefined;
+        }
+        const entityType = getEntityTypeById(${v}["@id"]);
+        if (entityType == null) {
+          getLogger(["fedify", "vocab"]).warn(
+            "Ignoring unknown vocabulary entity type reference: {typeId}",
+            { typeId: ${v}["@id"] },
+          );
+        }
+        return entityType;
+      })()`;
+		}
 	}
 };
 function getTypeName(typeUri, types) {
@@ -591,6 +621,7 @@ function hasSingularAccessor(property) {
 }
 const XSD_STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
 const XSD_DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
+const FEDIFY_VOCAB_ENTITY_TYPE_URI = "fedify:vocabEntityType";
 /**
 * Validates schema combinations that cannot be represented safely by the
 * generated code.
@@ -607,6 +638,7 @@ function validateTypeSchemas(types) {
 		const hasString = property.range.includes(XSD_STRING_URI);
 		const hasDecimal = property.range.includes(XSD_DECIMAL_URI);
 		if (hasString && hasDecimal) throw new TypeError(`The property ${type.name}.${property.singularName} cannot have both xsd:string and xsd:decimal in its range because the generated encoder cannot disambiguate them at runtime.`);
+		if (property.range.includes(FEDIFY_VOCAB_ENTITY_TYPE_URI) && property.range.length > 1) throw new TypeError(`The property ${type.name}.${property.singularName} cannot mix fedify:vocabEntityType with other range types because the generated decoder cannot disambiguate entity type references from ordinary IRIs.`);
 	}
 }
 /**
@@ -1036,7 +1068,10 @@ async function* generateDecoder(typeUri, types) {
         continue;
       }
       `;
-		if (property.range.length == 1) yield `${variable}.push(${getDecoder(property.range[0], types, "v", "options", `(values["@id"] == null ? options.baseUrl : new URL(values["@id"]))`)})`;
+		if (property.range.length == 1) yield `
+      const decoded = ${getDecoder(property.range[0], types, "v", "options", `(values["@id"] == null ? options.baseUrl : new URL(values["@id"]))`)};
+      if (typeof decoded === "undefined") continue;
+      ${variable}.push(decoded);`;
 		else {
 			yield `
       const decoded =
@@ -1870,6 +1905,47 @@ async function* generateClass(typeUri, types) {
 	yield "}\n\n";
 	for await (const code of generateInspectorPostClass(typeUri, types)) yield code;
 }
+function* generateEntityTypeHelpers(sortedTypeUris, types) {
+	const entityTypes = sortedTypeUris.filter((typeUri) => types[typeUri].entity).map((typeUri) => ({
+		name: types[typeUri].name,
+		uri: typeUri
+	}));
+	const entityTypeNames = entityTypes.map((entityType) => entityType.name);
+	yield `/**
+ * Constructor types for all generated vocabulary entity classes.
+ */
+export type $EntityType =${entityTypeNames.length < 1 ? " never" : `\n  | typeof ${entityTypeNames.join("\n  | typeof ")}`};
+
+const entityTypes: readonly $EntityType[] = [
+`;
+	for (const entityTypeName of entityTypeNames) yield `  ${entityTypeName},\n`;
+	yield `];
+
+const entityTypeSet: ReadonlySet<$EntityType> = new Set(entityTypes);
+
+const entityTypeIds: ReadonlyMap<string, $EntityType> = new Map<string, $EntityType>(
+  [
+`;
+	for (const entityType of entityTypes) yield `    [${JSON.stringify(entityType.uri)}, ${entityType.name}],\n`;
+	yield `  ],
+);
+
+/**
+ * Checks whether the given value is a generated vocabulary entity class.
+ */
+export function isEntityType(value: unknown): value is $EntityType {
+  return entityTypeSet.has(value as $EntityType);
+}
+
+/**
+ * Gets the generated vocabulary entity class for the given type URI.
+ */
+export function getEntityTypeById(id: string | URL): $EntityType | undefined {
+  return entityTypeIds.get(typeof id === "string" ? id : id?.href);
+}
+
+`;
+}
 /**
 * Generates the TypeScript classes from the given types.
 * @param types The types to generate classes from.
@@ -1902,6 +1978,7 @@ async function* generateClasses(types) {
 	yield "\n\n";
 	const sorted = sortTopologically(types);
 	for (const typeUri of sorted) for await (const code of generateClass(typeUri, types)) yield code;
+	for (const code of generateEntityTypeHelpers(sorted, types)) yield code;
 }
 //#endregion
 //#region src/generate.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.2.0-dev.731+3d1ca85e",
+  "version": "2.2.0-dev.766+e04e54aa",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {