@fedify/vocab-tools 2.1.0-dev.592 → 2.1.0-dev.600

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.1.0-dev.592+6c1f6e6f",
+  "version": "2.1.0-dev.600+bfa25994",
   "license": "MIT",
   "exports": {
     ".": "./src/mod.ts"

package/dist/mod.cjs

@@ -31,7 +31,7 @@ const es_toolkit = __toESM(require("es-toolkit"));
 
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.1.0-dev.592+6c1f6e6f";
+var version = "2.1.0-dev.600+bfa25994";
 var license = "MIT";
 var exports$1 = { ".": "./src/mod.ts" };
 var author = {
@@ -163,6 +163,30 @@ const scalarTypes = {
 			return `${v}["@value"]`;
 		}
 	},
+	"http://www.w3.org/2001/XMLSchema#decimal": {
+		name: "Decimal",
+		typeGuard(v) {
+			return `typeof ${v} === "string" && isDecimal(${v})`;
+		},
+		encoder(v) {
+			return `{
+        "@type": "http://www.w3.org/2001/XMLSchema#decimal",
+        "@value": ${v},
+      }`;
+		},
+		compactEncoder(v) {
+			return v;
+		},
+		dataCheck(v) {
+			return `typeof ${v} === "object" && "@type" in ${v}
+        && ${v}["@type"] === "http://www.w3.org/2001/XMLSchema#decimal"
+        && "@value" in ${v} && typeof ${v}["@value"] === "string"
+        && canParseDecimal(${v}["@value"])`;
+		},
+		decoder(v) {
+			return `parseDecimal(${v}["@value"])`;
+		}
+	},
 	"http://www.w3.org/2001/XMLSchema#string": {
 		name: "string",
 		typeGuard(v) {
@@ -632,6 +656,26 @@ function hasSingularAccessor(property) {
 	if (property.functional === true) return true;
 	return isNonFunctionalProperty(property) && property.singularAccessor === true;
 }
+const XSD_STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
+const XSD_DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
+/**
+* Validates schema combinations that cannot be represented safely by the
+* generated code.
+*
+* In particular, `xsd:string` and `xsd:decimal` cannot coexist in the same
+* property range because both are represented as runtime strings, which makes
+* JSON-LD serialization ambiguous and order-dependent.
+*
+* @param types The loaded type schemas to validate.
+* @throws {TypeError} Thrown when an unsupported range combination is found.
+*/
+function validateTypeSchemas(types) {
+	for (const type of Object.values(types)) for (const property of type.properties) {
+		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.`);
+	}
+}
 /**
 * An error that occurred while loading a schema file.
 */
@@ -1914,23 +1958,29 @@ async function* generateClass(typeUri, types) {
 * @returns The source code of the generated classes.
 */
 async function* generateClasses(types) {
-	yield "// deno-lint-ignore-file ban-unused-ignore prefer-const\n";
+	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-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 {
-    decodeMultibase,
-    type DocumentLoader,
-    encodeMultibase,
-    exportMultibaseKey,
-    exportSpki,
-    getDocumentLoader,
-    importMultibaseKey,
-    importPem,
-    LanguageString,
-    type RemoteDocument,
-} from "@fedify/vocab-runtime";\n`;
+	yield `import {\n    ${runtimeImports.join(",\n    ")}\n} from "@fedify/vocab-runtime";\n`;
 	yield "\n\n";
 	const sorted = sortTopologically(types);
 	for (const typeUri of sorted) for await (const code of generateClass(typeUri, types)) yield code;

package/dist/mod.js

@@ -8,7 +8,7 @@ import { pascalCase } from "es-toolkit";
 
 //#region deno.json
 var name = "@fedify/vocab-tools";
-var version = "2.1.0-dev.592+6c1f6e6f";
+var version = "2.1.0-dev.600+bfa25994";
 var license = "MIT";
 var exports = { ".": "./src/mod.ts" };
 var author = {
@@ -140,6 +140,30 @@ const scalarTypes = {
 			return `${v}["@value"]`;
 		}
 	},
+	"http://www.w3.org/2001/XMLSchema#decimal": {
+		name: "Decimal",
+		typeGuard(v) {
+			return `typeof ${v} === "string" && isDecimal(${v})`;
+		},
+		encoder(v) {
+			return `{
+        "@type": "http://www.w3.org/2001/XMLSchema#decimal",
+        "@value": ${v},
+      }`;
+		},
+		compactEncoder(v) {
+			return v;
+		},
+		dataCheck(v) {
+			return `typeof ${v} === "object" && "@type" in ${v}
+        && ${v}["@type"] === "http://www.w3.org/2001/XMLSchema#decimal"
+        && "@value" in ${v} && typeof ${v}["@value"] === "string"
+        && canParseDecimal(${v}["@value"])`;
+		},
+		decoder(v) {
+			return `parseDecimal(${v}["@value"])`;
+		}
+	},
 	"http://www.w3.org/2001/XMLSchema#string": {
 		name: "string",
 		typeGuard(v) {
@@ -609,6 +633,26 @@ function hasSingularAccessor(property) {
 	if (property.functional === true) return true;
 	return isNonFunctionalProperty(property) && property.singularAccessor === true;
 }
+const XSD_STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
+const XSD_DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
+/**
+* Validates schema combinations that cannot be represented safely by the
+* generated code.
+*
+* In particular, `xsd:string` and `xsd:decimal` cannot coexist in the same
+* property range because both are represented as runtime strings, which makes
+* JSON-LD serialization ambiguous and order-dependent.
+*
+* @param types The loaded type schemas to validate.
+* @throws {TypeError} Thrown when an unsupported range combination is found.
+*/
+function validateTypeSchemas(types) {
+	for (const type of Object.values(types)) for (const property of type.properties) {
+		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.`);
+	}
+}
 /**
 * An error that occurred while loading a schema file.
 */
@@ -1891,23 +1935,29 @@ async function* generateClass(typeUri, types) {
 * @returns The source code of the generated classes.
 */
 async function* generateClasses(types) {
-	yield "// deno-lint-ignore-file ban-unused-ignore prefer-const\n";
+	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-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 {
-    decodeMultibase,
-    type DocumentLoader,
-    encodeMultibase,
-    exportMultibaseKey,
-    exportSpki,
-    getDocumentLoader,
-    importMultibaseKey,
-    importPem,
-    LanguageString,
-    type RemoteDocument,
-} from "@fedify/vocab-runtime";\n`;
+	yield `import {\n    ${runtimeImports.join(",\n    ")}\n} from "@fedify/vocab-runtime";\n`;
 	yield "\n\n";
 	const sorted = sortTopologically(types);
 	for (const typeUri of sorted) for await (const code of generateClass(typeUri, types)) yield code;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.1.0-dev.592+6c1f6e6f",
+  "version": "2.1.0-dev.600+bfa25994",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {

package/src/__snapshots__/class.test.ts.deno.snap

@@ -1,13 +1,15 @@
 export const snapshot = {};
 
 snapshot[`generateClasses() 1`] = `
-"// deno-lint-ignore-file ban-unused-ignore prefer-const
+"// deno-lint-ignore-file ban-unused-ignore no-unused-vars prefer-const verbatim-module-syntax
 import jsonld from \\"@fedify/vocab-runtime/jsonld\\";
 import { getLogger } from \\"@logtape/logtape\\";
 import { type Span, SpanStatusCode, type TracerProvider, trace }
     from \\"@opentelemetry/api\\";
 import {
+    canParseDecimal,
     decodeMultibase,
+    type Decimal,
     type DocumentLoader,
     encodeMultibase,
     exportMultibaseKey,
@@ -15,8 +17,10 @@ import {
     getDocumentLoader,
     importMultibaseKey,
     importPem,
+    isDecimal,
     LanguageString,
-    type RemoteDocument,
+    parseDecimal,
+    type RemoteDocument
 } from \\"@fedify/vocab-runtime\\";
 
 

package/src/__snapshots__/class.test.ts.node.snap

@@ -1,11 +1,13 @@
 exports[`generateClasses() 1`] = `
-"// deno-lint-ignore-file ban-unused-ignore prefer-const
+"// deno-lint-ignore-file ban-unused-ignore no-unused-vars prefer-const verbatim-module-syntax
 import jsonld from \\"@fedify/vocab-runtime/jsonld\\";
 import { getLogger } from \\"@logtape/logtape\\";
 import { type Span, SpanStatusCode, type TracerProvider, trace }
     from \\"@opentelemetry/api\\";
 import {
+    canParseDecimal,
     decodeMultibase,
+    type Decimal,
     type DocumentLoader,
     encodeMultibase,
     exportMultibaseKey,
@@ -13,8 +15,10 @@ import {
     getDocumentLoader,
     importMultibaseKey,
     importPem,
+    isDecimal,
     LanguageString,
-    type RemoteDocument,
+    parseDecimal,
+    type RemoteDocument
 } from \\"@fedify/vocab-runtime\\";
 
 

package/src/__snapshots__/class.test.ts.snap

@@ -1,13 +1,15 @@
 // Bun Snapshot v1, https://bun.sh/docs/test/snapshots
 
 exports[`generateClasses() 1`] = `
-"// deno-lint-ignore-file ban-unused-ignore prefer-const
+"// deno-lint-ignore-file ban-unused-ignore no-unused-vars prefer-const verbatim-module-syntax
 import jsonld from "@fedify/vocab-runtime/jsonld";
 import { getLogger } from "@logtape/logtape";
 import { type Span, SpanStatusCode, type TracerProvider, trace }
     from "@opentelemetry/api";
 import {
+    canParseDecimal,
     decodeMultibase,
+    type Decimal,
     type DocumentLoader,
     encodeMultibase,
     exportMultibaseKey,
@@ -15,8 +17,10 @@ import {
     getDocumentLoader,
     importMultibaseKey,
     importPem,
+    isDecimal,
     LanguageString,
-    type RemoteDocument,
+    parseDecimal,
+    type RemoteDocument
 } from "@fedify/vocab-runtime";
 
 

package/src/class.test.ts

@@ -1,9 +1,10 @@
-import { deepStrictEqual, match } from "node:assert";
+import { deepStrictEqual, match, rejects } from "node:assert";
 import { basename, dirname, extname, join } from "node:path";
 import { test } from "node:test";
 import metadata from "../deno.json" with { type: "json" };
 import { generateClasses, sortTopologically } from "./class.ts";
-import { loadSchemaFiles } from "./schema.ts";
+import { getDataCheck } from "./type.ts";
+import { loadSchemaFiles, type TypeSchema } from "./schema.ts";
 
 test("sortTopologically()", () => {
   const sorted = sortTopologically({
@@ -69,6 +70,56 @@ test("generateClasses() imports the browser-safe jsonld entrypoint", async () =>
   match(entireCode, /import jsonld from "@fedify\/vocab-runtime\/jsonld";/);
 });
 
+test("generateClasses() imports Decimal helpers for xsd:decimal", async () => {
+  const entireCode = await getDecimalFixtureCode();
+  match(entireCode, /canParseDecimal,/);
+  match(entireCode, /isDecimal,/);
+  match(entireCode, /type Decimal,/);
+  match(entireCode, /parseDecimal/);
+  match(entireCode, /amount\?: Decimal \| null;/);
+  match(entireCode, /isDecimal\(values\.amount\)/);
+  match(entireCode, /parseDecimal\(v\["@value"\]\)/);
+});
+
+test("getDataCheck() uses canParseDecimal() for xsd:decimal", () => {
+  const check = getDataCheck(
+    "http://www.w3.org/2001/XMLSchema#decimal",
+    {},
+    "v",
+  );
+  match(check, /canParseDecimal\(v\["@value"\]\)/);
+});
+
+test("generateClasses() rejects xsd:string and xsd:decimal unions", async () => {
+  await rejects(
+    Array.fromAsync(generateClasses({
+      "https://example.com/measure": {
+        name: "Measure",
+        uri: "https://example.com/measure",
+        compactName: "Measure",
+        entity: false,
+        description: "A measure.",
+        properties: [
+          {
+            singularName: "amount",
+            functional: true,
+            compactName: "amount",
+            uri: "https://example.com/amount",
+            description: "An exact decimal amount.",
+            range: [
+              "http://www.w3.org/2001/XMLSchema#decimal",
+              "http://www.w3.org/2001/XMLSchema#string",
+            ],
+          },
+        ],
+        defaultContext:
+          "https://example.com/context" as TypeSchema["defaultContext"],
+      },
+    })),
+    /cannot have both xsd:string and xsd:decimal in its range/,
+  );
+});
+
 if ("Deno" in globalThis) {
   const { assertSnapshot } = await import("@std/testing/snapshot");
   Deno.test("generateClasses()", async (t) => {
@@ -101,6 +152,31 @@ async function getEntireCode() {
   return entireCode;
 }
 
+async function getDecimalFixtureCode() {
+  const types: Record<string, TypeSchema> = {
+    "https://example.com/measure": {
+      name: "Measure",
+      uri: "https://example.com/measure",
+      compactName: "Measure",
+      entity: false,
+      description: "A measure.",
+      properties: [
+        {
+          singularName: "amount",
+          functional: true,
+          compactName: "amount",
+          uri: "https://example.com/amount",
+          description: "An exact decimal amount.",
+          range: ["http://www.w3.org/2001/XMLSchema#decimal"],
+        },
+      ],
+      defaultContext:
+        "https://example.com/context" as TypeSchema["defaultContext"],
+    },
+  };
+  return (await Array.fromAsync(generateClasses(types))).join("");
+}
+
 async function changeNodeSnapshotPath() {
   const { snapshot } = await import("node:test");
   snapshot.setResolveSnapshotPath(

package/src/class.ts

@@ -3,7 +3,7 @@ import { generateCloner, generateConstructor } from "./constructor.ts";
 import { generateFields } from "./field.ts";
 import { generateInspector, generateInspectorPostClass } from "./inspector.ts";
 import { generateProperties } from "./property.ts";
-import type { TypeSchema } from "./schema.ts";
+import { type TypeSchema, validateTypeSchemas } from "./schema.ts";
 import { emitOverride } from "./type.ts";
 
 /**
@@ -117,23 +117,31 @@ async function* generateClass(
 export async function* generateClasses(
   types: Record<string, TypeSchema>,
 ): AsyncIterable<string> {
-  yield "// deno-lint-ignore-file ban-unused-ignore prefer-const\n";
+  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-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 {
-    decodeMultibase,
-    type DocumentLoader,
-    encodeMultibase,
-    exportMultibaseKey,
-    exportSpki,
-    getDocumentLoader,
-    importMultibaseKey,
-    importPem,
-    LanguageString,
-    type RemoteDocument,
-} from "@fedify/vocab-runtime";\n`;
+  yield `import {\n    ${
+    runtimeImports.join(",\n    ")
+  }\n} from "@fedify/vocab-runtime";\n`;
   yield "\n\n";
   const sorted = sortTopologically(types);
   for (const typeUri of sorted) {

package/src/schema.ts

@@ -240,6 +240,38 @@ export function hasSingularAccessor(property: PropertySchema): boolean {
     property.singularAccessor === true;
 }
 
+const XSD_STRING_URI = "http://www.w3.org/2001/XMLSchema#string";
+const XSD_DECIMAL_URI = "http://www.w3.org/2001/XMLSchema#decimal";
+
+/**
+ * Validates schema combinations that cannot be represented safely by the
+ * generated code.
+ *
+ * In particular, `xsd:string` and `xsd:decimal` cannot coexist in the same
+ * property range because both are represented as runtime strings, which makes
+ * JSON-LD serialization ambiguous and order-dependent.
+ *
+ * @param types The loaded type schemas to validate.
+ * @throws {TypeError} Thrown when an unsupported range combination is found.
+ */
+export function validateTypeSchemas(
+  types: Record<string, TypeSchema>,
+): void {
+  for (const type of Object.values(types)) {
+    for (const property of type.properties) {
+      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.`,
+        );
+      }
+    }
+  }
+}
+
 /**
  * An error that occurred while loading a schema file.
  */

package/src/type.ts

@@ -108,6 +108,30 @@ const scalarTypes: Record<string, ScalarType> = {
       return `${v}["@value"]`;
     },
   },
+  "http://www.w3.org/2001/XMLSchema#decimal": {
+    name: "Decimal",
+    typeGuard(v) {
+      return `typeof ${v} === "string" && isDecimal(${v})`;
+    },
+    encoder(v) {
+      return `{
+        "@type": "http://www.w3.org/2001/XMLSchema#decimal",
+        "@value": ${v},
+      }`;
+    },
+    compactEncoder(v) {
+      return v;
+    },
+    dataCheck(v) {
+      return `typeof ${v} === "object" && "@type" in ${v}
+        && ${v}["@type"] === "http://www.w3.org/2001/XMLSchema#decimal"
+        && "@value" in ${v} && typeof ${v}["@value"] === "string"
+        && canParseDecimal(${v}["@value"])`;
+    },
+    decoder(v) {
+      return `parseDecimal(${v}["@value"])`;
+    },
+  },
   "http://www.w3.org/2001/XMLSchema#string": {
     name: "string",
     typeGuard(v) {