optolith-database-schema 0.10.0 → 0.11.0

package/lib/types/traditionArtifacts/SickleRitual.js

@@ -1,5 +1,12 @@
 /**
  * @main SickleRitual
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "SickleRitual",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("SickleRitual"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/SpellSwordEnchantment.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main SpellSwordEnchantment
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -9,7 +10,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Spell-Sword Enchantment
  */
-export declare type SpellSwordEnchantment = {
+export type SpellSwordEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +26,7 @@ export declare type SpellSwordEnchantment = {
      */
     translations: LocaleMap<SpellSwordEnchantmentTranslation>;
 };
-export declare type SpellSwordEnchantmentTranslation = {
+export type SpellSwordEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -48,4 +49,4 @@ export declare type SpellSwordEnchantmentTranslation = {
     ap_value?: Activatable.AdventurePointsValueReplacement;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<SpellSwordEnchantment>;
+export declare const config: TypeConfig<SpellSwordEnchantment>;

package/lib/types/traditionArtifacts/SpellSwordEnchantment.js

@@ -1,5 +1,12 @@
 /**
  * @main SpellSwordEnchantment
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "SpellSwordEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("SpellSwordEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/StaffEnchantment.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main StaffEnchantment
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -10,7 +11,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Staff Enchantment
  */
-export declare type StaffEnchantment = {
+export type StaffEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -26,7 +27,7 @@ export declare type StaffEnchantment = {
      */
     translations: LocaleMap<StaffEnchantmentTranslation>;
 };
-export declare type StaffEnchantmentTranslation = {
+export type StaffEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -53,4 +54,4 @@ export declare type StaffEnchantmentTranslation = {
     ap_value?: Activatable.AdventurePointsValueReplacement;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<StaffEnchantment>;
+export declare const config: TypeConfig<StaffEnchantment>;

package/lib/types/traditionArtifacts/StaffEnchantment.js

@@ -1,5 +1,12 @@
 /**
  * @main StaffEnchantment
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "StaffEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("StaffEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/ToyEnchantment.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main ToyEnchantment
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -9,7 +10,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Toy Enchantment
  */
-export declare type ToyEnchantment = {
+export type ToyEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +26,7 @@ export declare type ToyEnchantment = {
      */
     translations: LocaleMap<ToyEnchantmentTranslation>;
 };
-export declare type ToyEnchantmentTranslation = {
+export type ToyEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -43,4 +44,4 @@ export declare type ToyEnchantmentTranslation = {
     bindingCost?: string;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ToyEnchantment>;
+export declare const config: TypeConfig<ToyEnchantment>;

package/lib/types/traditionArtifacts/ToyEnchantment.js

@@ -1,5 +1,12 @@
 /**
  * @main ToyEnchantment
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "ToyEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("ToyEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/Trinkhornzauber.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main Trinkhornzauber
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -9,7 +10,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Trinkhornzauber
  */
-export declare type Trinkhornzauber = {
+export type Trinkhornzauber = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +26,7 @@ export declare type Trinkhornzauber = {
      */
     translations: LocaleMap<TrinkhornzauberTranslation>;
 };
-export declare type TrinkhornzauberTranslation = {
+export type TrinkhornzauberTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -43,4 +44,4 @@ export declare type TrinkhornzauberTranslation = {
     bindingCost?: string;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Trinkhornzauber>;
+export declare const config: TypeConfig<Trinkhornzauber>;

package/lib/types/traditionArtifacts/Trinkhornzauber.js

@@ -1,5 +1,12 @@
 /**
  * @main Trinkhornzauber
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "Trinkhornzauber",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Trinkhornzauber"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/WandEnchantment.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main WandEnchantment
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -9,7 +10,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Wand Enchantment
  */
-export declare type WandEnchantment = {
+export type WandEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -24,7 +25,7 @@ export declare type WandEnchantment = {
      */
     translations: LocaleMap<WandEnchantmentTranslation>;
 };
-export declare type WandEnchantmentTranslation = {
+export type WandEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -38,4 +39,4 @@ export declare type WandEnchantmentTranslation = {
     bindingCost?: string;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<WandEnchantment>;
+export declare const config: TypeConfig<WandEnchantment>;

package/lib/types/traditionArtifacts/WandEnchantment.js

@@ -1,5 +1,12 @@
 /**
  * @main WandEnchantment
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "WandEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("WandEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/WeaponEnchantment.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main WeaponEnchantment
  */
+import { TypeConfig } from "../../typeConfig.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
@@ -9,7 +10,7 @@ import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Weapon Enchantment
  */
-export declare type WeaponEnchantment = {
+export type WeaponEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +26,7 @@ export declare type WeaponEnchantment = {
      */
     translations: LocaleMap<WeaponEnchantmentTranslation>;
 };
-export declare type WeaponEnchantmentTranslation = {
+export type WeaponEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -43,4 +44,4 @@ export declare type WeaponEnchantmentTranslation = {
     bindingCost?: string;
     errata?: Errata;
 };
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<WeaponEnchantment>;
+export declare const config: TypeConfig<WeaponEnchantment>;

package/lib/types/traditionArtifacts/WeaponEnchantment.js

@@ -1,5 +1,12 @@
 /**
  * @main WeaponEnchantment
  */
-import { validateSchemaCreator } from "../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "WeaponEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("WeaponEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/sub/AnimalShape.d.ts

@@ -1,12 +1,13 @@
 /**
  * @main AnimalShape
  */
+import { TypeConfig } from "../../../typeConfig.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape
  */
-export declare type AnimalShape = {
+export type AnimalShape = {
     /**
      * The animal shape's identifier. An unique, increasing integer.
      * @integer
@@ -26,7 +27,7 @@ export declare type AnimalShape = {
      */
     translations: LocaleMap<AnimalShapeTranslation>;
 };
-export declare type AnimalShapePathReference = {
+export type AnimalShapePathReference = {
     /**
      * The identifier of the animal shape's path.
      * @integer
@@ -34,7 +35,7 @@ export declare type AnimalShapePathReference = {
      */
     id: number;
 };
-export declare type AnimalShapeSizeReference = {
+export type AnimalShapeSizeReference = {
     /**
      * The identifier of the animal shape's size.
      * @integer
@@ -42,10 +43,10 @@ export declare type AnimalShapeSizeReference = {
      */
     id: number;
 };
-export declare type AnimalShapeTranslation = {
+export type AnimalShapeTranslation = {
     /**
      * The animal shape name.
      */
     name: NonEmptyString;
 };
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShape>;
+export declare const config: TypeConfig<AnimalShape>;

package/lib/types/traditionArtifacts/sub/AnimalShape.js

@@ -1,5 +1,12 @@
 /**
  * @main AnimalShape
  */
-import { validateSchemaCreator } from "../../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "AnimalShape",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AnimalShape"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/sub/AnimalShapePath.d.ts

@@ -1,12 +1,13 @@
 /**
  * @main AnimalShapePath
  */
+import { TypeConfig } from "../../../typeConfig.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Path
  */
-export declare type AnimalShapePath = {
+export type AnimalShapePath = {
     /**
      * The animal shape path's identifier. An unique, increasing integer.
      * @integer
@@ -18,10 +19,10 @@ export declare type AnimalShapePath = {
      */
     translations: LocaleMap<AnimalShapePathTranslation>;
 };
-export declare type AnimalShapePathTranslation = {
+export type AnimalShapePathTranslation = {
     /**
      * The animal shape path's name.
      */
     name: NonEmptyString;
 };
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapePath>;
+export declare const config: TypeConfig<AnimalShapePath>;

package/lib/types/traditionArtifacts/sub/AnimalShapePath.js

@@ -1,5 +1,12 @@
 /**
  * @main AnimalShapePath
  */
-import { validateSchemaCreator } from "../../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "AnimalShapePath",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AnimalShapePath"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/sub/AnimalShapeSize.d.ts

@@ -1,12 +1,13 @@
 /**
  * @main AnimalShapeSize
  */
+import { TypeConfig } from "../../../typeConfig.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Size
  */
-export declare type AnimalShapeSize = {
+export type AnimalShapeSize = {
     /**
      * The animal shape's identifier. An unique, increasing integer.
      * @integer
@@ -30,10 +31,10 @@ export declare type AnimalShapeSize = {
      */
     translations: LocaleMap<AnimalShapeSizeTranslation>;
 };
-export declare type AnimalShapeSizeTranslation = {
+export type AnimalShapeSizeTranslation = {
     /**
      * The animal shape size name.
      */
     name: NonEmptyString;
 };
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapeSize>;
+export declare const config: TypeConfig<AnimalShapeSize>;

package/lib/types/traditionArtifacts/sub/AnimalShapeSize.js

@@ -1,5 +1,12 @@
 /**
  * @main AnimalShapeSize
  */
-import { validateSchemaCreator } from "../../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "AnimalShapeSize",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AnimalShapeSize"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/sub/Brew.d.ts

@@ -1,12 +1,13 @@
 /**
  * @main Brew
  */
+import { TypeConfig } from "../../../typeConfig.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Brew
  */
-export declare type Brew = {
+export type Brew = {
     /**
      * The brew's identifier. An unique, increasing integer.
      * @integer
@@ -18,10 +19,10 @@ export declare type Brew = {
      */
     translations: LocaleMap<BrewTranslation>;
 };
-export declare type BrewTranslation = {
+export type BrewTranslation = {
     /**
      * The brew name.
      */
     name: NonEmptyString;
 };
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Brew>;
+export declare const config: TypeConfig<Brew>;

package/lib/types/traditionArtifacts/sub/Brew.js

@@ -1,5 +1,12 @@
 /**
  * @main Brew
  */
-import { validateSchemaCreator } from "../../../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "Brew",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Brew"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/validation/builders/integrity.d.ts

@@ -0,0 +1,57 @@
+import { TypeMap } from "../../config.js";
+import { PathDescriptor } from "../../helpers/objectPath.js";
+import { Result } from "../../helpers/result.js";
+import { TypeId } from "../../typeConfig.js";
+/**
+ * An error in the shape of an `Ajv` error, with `keyword` being the
+ * discriminating property.
+ */
+export type IntegrityError = {
+    keyword: "integrity";
+    instancePath: string;
+    message: string;
+};
+export type IntegrityValidationResult = Result<void, IntegrityError[]>;
+/**
+ * A function that validates `data` at a specific `filePath` to be of type `T`
+ * using a specified `validator`.
+ */
+export type IntegrityValidator<T> = (validators: IntegrityValidators, data: T, filepath: string) => IntegrityValidationResult;
+export type IntegrityValidators = {
+    identity: IdentityIntegrityValidators;
+};
+export type IdentityIntegrityValidators = {
+    [K in keyof TypeMap]: {
+        isUnique: (id: TypeId<K>) => boolean;
+        exists: (id: TypeId<K>) => boolean;
+    };
+};
+export declare const getReferencialIntegrityErrors: <T>(ids: T[], typeName: string, existsId: (id: T) => boolean, pathToData: PathDescriptor) => IntegrityValidationResult;
+interface Translatable<T> {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        [localeId: string]: T;
+    };
+}
+export declare const getReferencialIntegrityErrorsForTranslatable: <T>(validators: IntegrityValidators, data: Translatable<T>, pathToData?: PathDescriptor) => IntegrityValidationResult;
+/**
+ * Validates that a given identifier is unique. If the identifier is present in
+ * both the file name and the file contents, their equality is validated as
+ * well. The `pathToId` parameter is used to identify the location of the
+ * identifier in the file contents.
+ */
+export declare const validateEntityIntegrity: <ID extends string | number>(isUnique: (id: ID) => boolean, filenameId: ID, dataId?: ID | undefined, pathToId?: PathDescriptor) => IntegrityValidationResult;
+/**
+ * Warns about missing integrity validation, but returns no errors.
+ * @param typeName The name of the type that is not being validated.
+ * @returns An empty list of errors.
+ */
+export declare const todo: (typeName: string) => () => IntegrityValidationResult;
+/**
+ * Combines multiple integrity validation results into one.
+ */
+export declare const reduceIntegrityValidationResults: (...results: IntegrityValidationResult[]) => IntegrityValidationResult;
+export {};

package/lib/validation/builders/integrity.js

@@ -0,0 +1,44 @@
+import { printPathDescriptor } from "../../helpers/objectPath.js";
+import { Result } from "../../helpers/result.js";
+import { config } from "../../types/Locale.js";
+const integrityError = (instancePath, message) => ({
+    keyword: "integrity",
+    instancePath: printPathDescriptor(instancePath),
+    message
+});
+/**
+ * Returns an error if the condition evaluates to `false`.
+ */
+const conditionalError = (condition, instancePath, message) => condition ? Result.ok(undefined) : Result.error([integrityError(instancePath, message)]);
+export const getReferencialIntegrityErrors = (ids, typeName, existsId, pathToData) => {
+    const errors = ids
+        .filter(id => !existsId(id))
+        .map(id => integrityError(pathToData, `The identifier "${id}" for type ${typeName} does not exist.`));
+    if (errors.length > 0) {
+        return Result.error(errors);
+    }
+    else {
+        return Result.ok(undefined);
+    }
+};
+export const getReferencialIntegrityErrorsForTranslatable = (validators, data, pathToData = []) => getReferencialIntegrityErrors(Object.keys(data.translations), config.name, validators.identity.locales.exists, [...pathToData, { k: "translations" }]);
+/**
+ * Validates that a given identifier is unique. If the identifier is present in
+ * both the file name and the file contents, their equality is validated as
+ * well. The `pathToId` parameter is used to identify the location of the
+ * identifier in the file contents.
+ */
+export const validateEntityIntegrity = (isUnique, filenameId, dataId, pathToId = [{ k: "id" }]) => reduceIntegrityValidationResults(conditionalError(isUnique(filenameId), [], `The identifier "${filenameId}" is not unique.`), conditionalError(dataId === undefined || filenameId === dataId, pathToId, `The identifier in the filename (${JSON.stringify(filenameId)}) and the identifier (${JSON.stringify(dataId)}) in the file itself are not equal.`));
+/**
+ * Warns about missing integrity validation, but returns no errors.
+ * @param typeName The name of the type that is not being validated.
+ * @returns An empty list of errors.
+ */
+export const todo = (typeName) => {
+    console.warn(`The type ${typeName} has no integrity validation yet.`);
+    return () => Result.ok(undefined);
+};
+/**
+ * Combines multiple integrity validation results into one.
+ */
+export const reduceIntegrityValidationResults = (...results) => results.reduce((acc, result) => Result.combine(acc, result, () => undefined, (a, b) => [...a, ...b]), Result.ok(undefined));

package/lib/validation/builders/naming.d.ts

@@ -0,0 +1,13 @@
+import { Result } from "../../helpers/result.js";
+/**
+ * An error in the shape of an `Ajv` error, with `keyword` being the
+ * discriminating property.
+ */
+export type FileNameError = {
+    keyword: "filename";
+    instancePath: string;
+    message: string;
+};
+export type FileNameValidationResult = Result<void, FileNameError[]>;
+export type FileNameValidator = (filePath: string) => FileNameValidationResult;
+export declare const validateFileName: FileNameValidator;

package/lib/validation/builders/naming.js

@@ -0,0 +1,14 @@
+import { basename } from "node:path";
+import { error, ok } from "../../helpers/result.js";
+const BASE_NAME_PATTERN = /^(?:0|[1-9][0-9]*)_(?:[A-Z][a-zA-Z]*|[1-9][0-9]*)(?:-(?:[a-zA-Z]+|[1-9][0-9]*))*\.yml$/;
+const fileNameError = (fileName) => ({
+    keyword: "filename",
+    instancePath: "",
+    message: `the file name "${fileName}" does not match the pattern ${BASE_NAME_PATTERN.source}`
+});
+export const validateFileName = (filePath) => {
+    const fileName = basename(filePath);
+    return BASE_NAME_PATTERN.test(fileName)
+        ? ok(undefined)
+        : error([fileNameError(fileName)]);
+};