@fedify/vocab-tools 2.1.0-dev.405 → 2.1.0-dev.408

package/dist/mod.d.ts

@@ -3,185 +3,195 @@ declare function generateVocab(schemaDir: string, generatedPath: string): Promis
 //#endregion
 //#region src/schema.d.ts
 /**
- * The qualified URI of a type.  It is used as the range of a property.
- */
+* The qualified URI of a type.  It is used as the range of a property.
+*/
 type TypeUri = `https://${string}` | `http://${string}` | `fedify:${string}`;
 /**
- * The schema of a type.  It is used to generate a class.
- */
+* The schema of a type.  It is used to generate a class.
+*/
 interface TypeSchema {
   /**
-   * The type name.  It is used as the name of the generated class.
-   */
+  * The type name.  It is used as the name of the generated class.
+  */
   name: string;
   /**
-   * The qualified URI of the type.
-   */
+  * The qualified URI of the type.
+  */
   uri: TypeUri;
   /**
-   * The qualified URIs of the base type of the type (if any).
-   */
+  * The qualified URIs of the base type of the type (if any).
+  */
   extends?: TypeUri;
   /**
-   * The type name used in the compacted JSON-LD document.  It is used as the
-   * value of the `type` field.
-   */
+  * The type name used in the compacted JSON-LD document.  It is used as the
+  * value of the `type` field.
+  */
   compactName?: string;
   /**
-   * Marks the type an entity type rather than a value type.  Turning on this
-   * flag will make property accessors for the type asynchronous, so that they
-   * can load the values of the properties from the remote server.
-   *
-   * The extended subtypes must have the consistent value of this flag.
-   */
+  * Marks the type an entity type rather than a value type.  Turning on this
+  * flag will make property accessors for the type asynchronous, so that they
+  * can load the values of the properties from the remote server.
+  *
+  * The extended subtypes must have the consistent value of this flag.
+  */
   entity: boolean;
   /**
-   * The description of the type.  It is used as the doc comment of
-   * the generated class.
-   */
+  * Whether the type omits `@type` in JSON-LD serialization.  When `true`,
+  * the generated `toJsonLd()` method will not emit `@type` (or `type` in
+  * compact form) in the serialized JSON-LD.  The generated `fromJsonLd()`
+  * method will still accept `@type` if present for backward compatibility.
+  *
+  * This is useful for types that are not real vocabulary types but rather
+  * anonymous object structures (e.g., `Endpoints`, `Source` in ActivityStreams).
+  */
+  typeless?: boolean;
+  /**
+  * The description of the type.  It is used as the doc comment of
+  * the generated class.
+  */
   description: string;
   /**
-   * The possible properties of the type.
-   */
+  * The possible properties of the type.
+  */
   properties: PropertySchema[];
   /**
-   * The default JSON-LD context of the type.  It is used as the default
-   * context of the generated `toJsonLd()` method.
-   */
+  * The default JSON-LD context of the type.  It is used as the default
+  * context of the generated `toJsonLd()` method.
+  */
   defaultContext: Context;
 }
 interface PropertySchemaBase {
   /**
-   * The singular form of the property name.  It is used as the name of the
-   * generated property accessors.
-   */
+  * The singular form of the property name.  It is used as the name of the
+  * generated property accessors.
+  */
   singularName: string;
   /**
-   * The qualified URI of the property.
-   */
+  * The qualified URI of the property.
+  */
   uri: string;
   /**
-   * The property name used in the compacted JSON-LD document.  It is used as
-   * the key of the property.
-   */
+  * The property name used in the compacted JSON-LD document.  It is used as
+  * the key of the property.
+  */
   compactName?: string;
   /**
-   * The qualified URI of the superproperty of the property (if any).
-   * It means that the property is a specialization of the referenced property.
-   */
+  * The qualified URI of the superproperty of the property (if any).
+  * It means that the property is a specialization of the referenced property.
+  */
   subpropertyOf?: string;
   /**
-   * The description of the property.  It is used as the doc comment of
-   * the generated property accessors.
-   */
+  * The description of the property.  It is used as the doc comment of
+  * the generated property accessors.
+  */
   description: string;
   /**
-   * Whether the enclosed object should have its own context when the document
-   * is compacted.
-   */
+  * Whether the enclosed object should have its own context when the document
+  * is compacted.
+  */
   embedContext?: {
     /**
-     * The compact name of the property that contains the context.
-     */
+    * The compact name of the property that contains the context.
+    */
     compactName: string;
     /**
-     * Whether the embedded context should be the same as the context of
-     * the enclosing document.
-     */
+    * Whether the embedded context should be the same as the context of
+    * the enclosing document.
+    */
     inherit: true;
   };
 }
 type PropertySchemaTyping = {
   /**
-   * Whether the property value has `@type` field.  If `true`, the `range` must
-   * have only one element.
-   */
+  * Whether the property value has `@type` field.  If `true`, the `range` must
+  * have only one element.
+  */
   untyped?: false;
   /**
-   * The qualified URIs of all possible types of the property values.
-   */
+  * The qualified URIs of all possible types of the property values.
+  */
   range: [TypeUri] | [TypeUri, ...TypeUri[]];
 } | {
   /**
-   * Whether the property value has `@type` field.  If `true`, the `range` must
-   * have only one element.
-   */
+  * Whether the property value has `@type` field.  If `true`, the `range` must
+  * have only one element.
+  */
   untyped: true;
   /**
-   * The qualified URIs of all possible types of the property values.
-   */
+  * The qualified URIs of all possible types of the property values.
+  */
   range: [TypeUri];
 };
 /**
- * The schema of a property.  It is used to generate property accessors of
- * a class.
- */
+* The schema of a property.  It is used to generate property accessors of
+* a class.
+*/
 type PropertySchema = PropertySchemaBase & PropertySchemaTyping & {
   /**
-   * Marks the property that it can have only one value.  Turning on this
-   * flag will generate only singular property accessors, so `pluralName`
-   * and `singularAccessor` should not be specified.
-   */
+  * Marks the property that it can have only one value.  Turning on this
+  * flag will generate only singular property accessors, so `pluralName`
+  * and `singularAccessor` should not be specified.
+  */
   functional?: false;
   /**
-   * The plural form of the property name.  It is used as the name of the
-   * generated property accessors.
-   */
+  * The plural form of the property name.  It is used as the name of the
+  * generated property accessors.
+  */
   pluralName: string;
   /**
-   * Whether to generate singular property accessors.  Regardless of this
-   * flag, plural property accessors are generated (unless `functional` is
-   * turned on).
-   */
+  * Whether to generate singular property accessors.  Regardless of this
+  * flag, plural property accessors are generated (unless `functional` is
+  * turned on).
+  */
   singularAccessor?: boolean;
   /**
-   * The container type of the property values.  It can be unspecified.
-   */
+  * The container type of the property values.  It can be unspecified.
+  */
   container?: "graph" | "list";
 } | PropertySchemaBase & PropertySchemaTyping & {
   /**
-   * Marks the property that it can have only one value.  Turning on this
-   * flag will generate only singular property accessors, so `pluralName`
-   * and `singularAccessor` should not be specified.
-   */
+  * Marks the property that it can have only one value.  Turning on this
+  * flag will generate only singular property accessors, so `pluralName`
+  * and `singularAccessor` should not be specified.
+  */
   functional: true;
   /**
-   * If it's present, those redundant properties are also filled with
-   * the same value altogether when the object is serialized into
-   * JSON-LD.  When it's deserialized from JSON-LD, it tries to
-   * parse the values of the specified properties in order.
-   */
+  * If it's present, those redundant properties are also filled with
+  * the same value altogether when the object is serialized into
+  * JSON-LD.  When it's deserialized from JSON-LD, it tries to
+  * parse the values of the specified properties in order.
+  */
   redundantProperties?: {
     /**
-     * The qualified URI of the property.
-     */
+    * The qualified URI of the property.
+    */
     uri: string;
     /**
-     * The property name used in the compacted JSON-LD document.  It is used
-     * as the key of the property.
-     */
+    * The property name used in the compacted JSON-LD document.  It is used
+    * as the key of the property.
+    */
     compactName?: string;
   }[];
 };
 /**
- * A JSON-LD context, which is placed in the `@context` property of a JSON-LD
- * document.
- */
+* A JSON-LD context, which is placed in the `@context` property of a JSON-LD
+* document.
+*/
 type Context = Uri | EmbeddedContext | (Uri | EmbeddedContext)[];
 type Uri = "http://{string}" | "https://{string}";
 type EmbeddedContext = Record<string, TermDefinition>;
 type TermDefinition = Uri | Record<string, Uri | "@id">;
 /**
- * Type guard to check if a property is not functional (has pluralName).
- */
+* Type guard to check if a property is not functional (has pluralName).
+*/
 
 /**
- * Loads all schema files in the directory.
- * @param dir The path of the directory to load schema files from.
- * @returns A map from the qualified URI of a type to its {@link TypeSchema}.
- * @throws {@link AggregateError} if any schema file is invalid.  It contains
- *         all {@link SchemaError}s of the invalid schema files.
- */
+* Loads all schema files in the directory.
+* @param dir The path of the directory to load schema files from.
+* @returns A map from the qualified URI of a type to its {@link TypeSchema}.
+* @throws {@link AggregateError} if any schema file is invalid.  It contains
+*         all {@link SchemaError}s of the invalid schema files.
+*/
 declare function loadSchemaFiles(dir: string): Promise<Record<string, TypeSchema>>;
 //#endregion
 //#region src/type.d.ts

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.405+f4e278ae";
+var version = "2.1.0-dev.408+5c3c9d78";
 var license = "MIT";
 var exports = { ".": "./src/mod.ts" };
 var author = {
@@ -775,7 +775,7 @@ async function* generateEncoder(typeUri, types) {
       `;
 		}
 		yield `
-      result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};
+      ${type.typeless ? "" : `result["type"] = ${JSON.stringify(type.compactName ?? type.uri)};`}
       if (this.id != null) result["id"] = this.id.href;
       result["@context"] = ${JSON.stringify(type.defaultContext)};
       return result;
@@ -830,7 +830,7 @@ async function* generateEncoder(typeUri, types) {
     `;
 	}
 	yield `
-    values["@type"] = [${JSON.stringify(type.uri)}];
+    ${type.typeless ? "" : `values["@type"] = [${JSON.stringify(type.uri)}];`}
     if (this.id != null) values["@id"] = this.id.href;
     if (options.format === "expand") {
       return await jsonld.expand(
@@ -1390,25 +1390,41 @@ async function* generateInspector(typeUri, types) {
 	yield `
     return proxy;
   }
-
-  // @ts-ignore: suppressing TS4127
-  ${emitOverride(typeUri, types)} [Symbol.for("Deno.customInspect")](
+  `;
+}
+/**
+* Generates code that must appear *after* the class closing brace: prototype
+* assignments for the Deno and Node.js custom-inspect hooks.
+*
+* These are emitted outside the class body because computed property names
+* using `Symbol.for()` are incompatible with `isolatedDeclarations` mode.
+*/
+async function* generateInspectorPostClass(typeUri, types) {
+	const type = types[typeUri];
+	const className = type.name;
+	yield `
+// deno-lint-ignore no-explicit-any
+(${className}.prototype as any)[Symbol.for("Deno.customInspect")] =
+  function (
+    this: ${className},
     inspect: typeof Deno.inspect,
     options: Deno.InspectOptions,
   ): string {
     const proxy = this._getCustomInspectProxy();
     return ${JSON.stringify(type.name + " ")} + inspect(proxy, options);
-  }
+  };
 
-  // @ts-ignore: suppressing TS4127
-  ${emitOverride(typeUri, types)} [Symbol.for("nodejs.util.inspect.custom")](
+// deno-lint-ignore no-explicit-any
+(${className}.prototype as any)[Symbol.for("nodejs.util.inspect.custom")] =
+  function (
+    this: ${className},
     _depth: number,
     options: unknown,
     inspect: (value: unknown, options: unknown) => string,
   ): string {
     const proxy = this._getCustomInspectProxy();
     return ${JSON.stringify(type.name + " ")} + inspect(proxy, options);
-  }
+  };
   `;
 }
 
@@ -1867,6 +1883,7 @@ async function* generateClass(typeUri, types) {
 	for await (const code of generateDecoder(typeUri, types)) yield code;
 	for await (const code of generateInspector(typeUri, types)) yield code;
 	yield "}\n\n";
+	for await (const code of generateInspectorPostClass(typeUri, types)) yield code;
 }
 /**
 * Generates the TypeScript classes from the given types.

package/dist/schema.yaml

@@ -223,6 +223,17 @@ properties:
 
       The extended subtypes must have the consistent value of this flag.
     type: boolean
+  typeless:
+    description: >-
+      Whether the type omits @type in JSON-LD serialization.  When true,
+      the generated toJsonLd() method will not emit @type (or type in
+      compact form) in the serialized JSON-LD.  The generated fromJsonLd()
+      method will still accept @type if present for backward compatibility.
+
+      This is useful for types that are not real vocabulary types but rather
+      anonymous object structures (e.g., Endpoints, Source in
+      ActivityStreams).
+    type: boolean
   description:
     description: >-
       The description of the type.  It is used as the doc comment of

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/vocab-tools",
-  "version": "2.1.0-dev.405+f4e278ae",
+  "version": "2.1.0-dev.408+5c3c9d78",
   "description": "Code generator for Activity Vocabulary APIs",
   "homepage": "https://fedify.dev/",
   "repository": {