@fedify/vocab-tools 2.0.0-pr.458.1785

package/dist/mod.d.cts

@@ -0,0 +1,190 @@
+//#region src/generate.d.ts
+declare function generateVocab(schemaDir: string, generatedPath: string): Promise<void>;
+//#endregion
+//#region src/schema.d.ts
+/**
+ * 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.
+ */
+interface TypeSchema {
+  /**
+   * The type name.  It is used as the name of the generated class.
+   */
+  name: string;
+  /**
+   * The qualified URI of the type.
+   */
+  uri: TypeUri;
+  /**
+   * 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.
+   */
+  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.
+   */
+  entity: 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.
+   */
+  properties: PropertySchema[];
+  /**
+   * 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.
+   */
+  singularName: string;
+  /**
+   * 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.
+   */
+  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.
+   */
+  subpropertyOf?: string;
+  /**
+   * 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.
+   */
+  embedContext?: {
+    /**
+     * 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.
+     */
+    inherit: true;
+  };
+}
+type PropertySchemaTyping = {
+  /**
+   * 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.
+   */
+  range: [TypeUri] | [TypeUri, ...TypeUri[]];
+} | {
+  /**
+   * 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.
+   */
+  range: [TypeUri];
+};
+/**
+ * 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.
+   */
+  functional?: false;
+  /**
+   * 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).
+   */
+  singularAccessor?: boolean;
+  /**
+   * 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.
+   */
+  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.
+   */
+  redundantProperties?: {
+    /**
+     * 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.
+     */
+    compactName?: string;
+  }[];
+};
+/**
+ * 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).
+ */
+
+/**
+ * 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 SchemaFile}.
+ * @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
+declare function areAllScalarTypes(typeUris: string[], types: Record<string, TypeSchema>): boolean;
+//#endregion
+export { PropertySchema, TypeSchema, areAllScalarTypes, generateVocab, loadSchemaFiles };

package/dist/mod.d.ts

@@ -0,0 +1,190 @@
+//#region src/generate.d.ts
+declare function generateVocab(schemaDir: string, generatedPath: string): Promise<void>;
+//#endregion
+//#region src/schema.d.ts
+/**
+ * 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.
+ */
+interface TypeSchema {
+  /**
+   * The type name.  It is used as the name of the generated class.
+   */
+  name: string;
+  /**
+   * The qualified URI of the type.
+   */
+  uri: TypeUri;
+  /**
+   * 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.
+   */
+  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.
+   */
+  entity: 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.
+   */
+  properties: PropertySchema[];
+  /**
+   * 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.
+   */
+  singularName: string;
+  /**
+   * 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.
+   */
+  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.
+   */
+  subpropertyOf?: string;
+  /**
+   * 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.
+   */
+  embedContext?: {
+    /**
+     * 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.
+     */
+    inherit: true;
+  };
+}
+type PropertySchemaTyping = {
+  /**
+   * 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.
+   */
+  range: [TypeUri] | [TypeUri, ...TypeUri[]];
+} | {
+  /**
+   * 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.
+   */
+  range: [TypeUri];
+};
+/**
+ * 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.
+   */
+  functional?: false;
+  /**
+   * 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).
+   */
+  singularAccessor?: boolean;
+  /**
+   * 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.
+   */
+  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.
+   */
+  redundantProperties?: {
+    /**
+     * 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.
+     */
+    compactName?: string;
+  }[];
+};
+/**
+ * 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).
+ */
+
+/**
+ * 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 SchemaFile}.
+ * @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
+declare function areAllScalarTypes(typeUris: string[], types: Record<string, TypeSchema>): boolean;
+//#endregion
+export { PropertySchema, TypeSchema, areAllScalarTypes, generateVocab, loadSchemaFiles };