optolith-database-schema 0.11.4 → 0.11.6

package/lib/helpers/typeSafety.js

@@ -0,0 +1,8 @@
+/**
+ * This function is used to make sure that the `switch` is exhaustive. Place it
+ * in the `default` case of the `switch`.
+ * @param x The value that is used in the `switch`.
+ */
+export function assertExhaustive(x) {
+    throw new Error("The switch is not exhaustive.");
+}

package/lib/main.d.ts

@@ -0,0 +1,55 @@
+import { TypeMap } from "./config/types.js";
+import "./helpers/array.js";
+import { Result } from "./helpers/result.js";
+import { TypeId } from "./typeConfig.js";
+import { IntegrityError } from "./validation/builders/integrity.js";
+import { FileNameError } from "./validation/builders/naming.js";
+import { SchemaError } from "./validation/builders/schema.js";
+/**
+ * Options for validating data files.
+ */
+export type ValidationOptions = {
+    /**
+     * Whether to check the integrity of the data files. This includes checking
+     * for referencial integrity (i.e. whether all referenced entities exist).
+     * @default false
+     */
+    checkIntegrity?: boolean;
+};
+/**
+ * A type validation may fail because of the data not matching the schema, the
+ * file name not matching a pattern, or integrity issues.
+ */
+export type TypeValidationError = IntegrityError | FileNameError | SchemaError;
+/**
+ * A map of all valid entries, grouped by entity type.
+ */
+export type ValidResults = {
+    [K in keyof TypeMap]: [id: TypeId<keyof TypeMap>, data: TypeMap[keyof TypeMap]][];
+};
+/**
+ * A dictionary of entity types and their data’s associated locations.
+ */
+export type EntityDirectoryPaths = {
+    [K in keyof TypeMap]: string;
+};
+type StrictResults = Result<ValidResults, Record<string, TypeValidationError[]>>;
+/**
+ * If the database has no validation issues, returns the whole data set as a map
+ * of entity types to their data. If there are any errors, only the errors will
+ * be returned instead.
+ * @param entityDirPaths THe paths to the directories containing the data to be
+ * validated.
+ * @param options Configuration options for the validation.
+ * @returns Either the whole data set or the errors.
+ */
+export declare const getAllValidDataOrErrors: (entityDirPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<StrictResults>;
+/**
+ * Returns all valid data as a map of entity types to their data.
+ * @param entityDirPaths THe paths to the directories containing the data to be
+ * validated.
+ * @param options Configuration options for the validation.
+ * @returns The valid data.
+ */
+export declare const getAllValidData: (entityDirPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<ValidResults>;
+export {};

package/lib/main.js

@@ -0,0 +1,55 @@
+import "./helpers/array.js";
+import { mapSecond } from "./helpers/pair.js";
+import { Result, error, isError, isOk, ok } from "./helpers/result.js";
+import { getRawValidationResults } from "./validation/raw.js";
+const rawResultMapToResult = (rawResultMap) => rawResultMap.reduce((result, [typeName, typeResults]) => typeResults.reduce((outerResult, [filePath, fileResult]) => {
+    if (isOk(outerResult) && isOk(fileResult)) {
+        return ok({
+            ...outerResult.value,
+            [typeName]: [...(outerResult.value[typeName] ?? []), fileResult.value]
+        });
+    }
+    else if (isOk(outerResult) && isError(fileResult)) {
+        return error({
+            [filePath]: fileResult.error
+        });
+    }
+    else if (isError(outerResult) && isError(fileResult)) {
+        return error({
+            ...outerResult.error,
+            [filePath]: fileResult.error
+        });
+    }
+    else {
+        return outerResult;
+    }
+}, result), ok({}));
+const filterResultMapByValidData = (rawResultMap) => rawResultMap
+    .map(mapSecond((typeResults) => typeResults
+    .filter((typeResult) => Result.isOk(typeResult[1]))
+    .map(fileResult => fileResult[1].value)))
+    .objectFromEntries();
+/**
+ * If the database has no validation issues, returns the whole data set as a map
+ * of entity types to their data. If there are any errors, only the errors will
+ * be returned instead.
+ * @param entityDirPaths THe paths to the directories containing the data to be
+ * validated.
+ * @param options Configuration options for the validation.
+ * @returns Either the whole data set or the errors.
+ */
+export const getAllValidDataOrErrors = async (entityDirPaths, options = {}) => {
+    const rawResultMap = await getRawValidationResults(entityDirPaths, options);
+    return rawResultMapToResult(rawResultMap);
+};
+/**
+ * Returns all valid data as a map of entity types to their data.
+ * @param entityDirPaths THe paths to the directories containing the data to be
+ * validated.
+ * @param options Configuration options for the validation.
+ * @returns The valid data.
+ */
+export const getAllValidData = async (entityDirPaths, options = {}) => {
+    const rawResultMap = await getRawValidationResults(entityDirPaths, options);
+    return filterResultMapByValidData(rawResultMap);
+};

package/lib/typeConfig.d.ts

@@ -0,0 +1,10 @@
+import { TypeMap, configMap } from "./config/types.js";
+import { IntegrityValidator } from "./validation/builders/integrity.js";
+import { SchemaValidator } from "./validation/builders/schema.js";
+export type TypeId<K extends keyof TypeMap> = ReturnType<(typeof configMap)[K]["id"]>;
+export type TypeConfig<T, ID extends string | number = number> = {
+    name: string;
+    id: (data: T, filepath: string) => ID;
+    integrityValidator: IntegrityValidator<T>;
+    schemaValidator: SchemaValidator<T>;
+};

package/lib/typeConfig.js

@@ -0,0 +1 @@
+export {};

package/lib/types/Advantage.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @main Advantage
+ */
+import { TypeConfig } from "../typeConfig.js";
+import * as Activatable from "./_Activatable.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AdvantageDisadvantagePrerequisites } from "./_Prerequisite.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Advantage
+ */
+export type Advantage = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    maximum?: Activatable.Maximum;
+    prerequisites?: AdvantageDisadvantagePrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    /**
+     * Does this advantage count towards the maximum of AP to be spent on
+     * advantages?
+     * @default true
+     */
+    has_maximum_spent_influence: boolean;
+    /**
+     * Does this advantage exclusively applies to arcane spellworks and not
+     * to magical actions and magical applications?
+     * @default false
+     */
+    is_exclusive_to_arcane_spellworks: boolean;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AdvantageTranslation>;
+};
+export type AdvantageTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    /**
+     * A string that is used as a label for an input field.
+     */
+    input?: Activatable.Input;
+    rules: Activatable.Rules;
+    /**
+     * The range.
+     * @markdown
+     * @minLength 1
+     */
+    range?: string;
+    ap_value?: Activatable.AdventurePointsValueReplacement;
+    /**
+     * A string that gets appended to the default AP Value text with a preceding
+     * space. This always happens if present, even if the generated AP Value text
+     * is replaced.
+     */
+    ap_value_append?: Activatable.AdventurePointsValueAppend;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Advantage>;

package/lib/types/Advantage.js

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

package/lib/types/AnimalDisease.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @main AnimalDisease
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { Cause, DiseaseTranslation, Resistance } from "./_DiseasePoison.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AnimalTypeReference } from "./_SimpleReferences.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Animal Disease
+ */
+export type AnimalDisease = {
+    /**
+     * The animal disease's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The animal disease's level.
+     * @integer
+     * @minimum 1
+     */
+    level: number;
+    /**
+     * Depending on the disease, apply Spirit or Toughness as a penalty to the
+     * disease roll. It may also happen that the lower of both is applied as a
+     * penalty.
+     */
+    resistance: Resistance;
+    /**
+     * What causes the disease? The GM rolls 1D20 to see if a character gets
+     * infected. If the infection check succeeds, the GM makes a disease check to
+     * determine the severity of the infection.
+     * @minItems 1
+     */
+    cause: Cause[];
+    /**
+     * The animal types this disease applies to.
+     *
+     * If no animal types are given, the animal disease applies to all animal
+     * types.
+     */
+    animal_types: AnimalTypeReference[];
+    /**
+     * If and at which chance the disease can be communicated to intelligent
+     * creatures.
+     *
+     * If no causes are given, the disease is not communicable to intelligent
+     * creatures.
+     */
+    communicability_to_intelligent_creatures: Cause[];
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DiseaseTranslation>;
+};
+export declare const config: TypeConfig<AnimalDisease>;

package/lib/types/AnimalDisease.js

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

package/lib/types/AnimalType.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @main AnimalType
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * @title Animal Type
+ */
+export type AnimalType = {
+    /**
+     * The animal type's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AnimalTypeTranslation>;
+};
+export type AnimalTypeTranslation = {
+    /**
+     * The animal type name.
+     */
+    name: NonEmptyString;
+};
+export declare const config: TypeConfig<AnimalType>;

package/lib/types/AnimalType.js

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

package/lib/types/ArcaneBardTradition.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @main ArcaneBardTradition
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { ArcaneTradition } from "./_ArcaneTradition.js";
+/**
+ * @title Arcane Bard Tradition
+ */
+export type ArcaneBardTradition = ArcaneTradition;
+export declare const config: TypeConfig<ArcaneBardTradition>;

package/lib/types/ArcaneBardTradition.js

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

package/lib/types/ArcaneDancerTradition.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @main ArcaneDancerTradition
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { ArcaneTradition } from "./_ArcaneTradition.js";
+/**
+ * @title Arcane Dancer Tradition
+ */
+export type ArcaneDancerTradition = ArcaneTradition;
+export declare const config: TypeConfig<ArcaneDancerTradition>;

package/lib/types/ArcaneDancerTradition.js

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

package/lib/types/Aspect.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @main Aspect
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * @title Aspect
+ */
+export type Aspect = {
+    /**
+     * The aspect's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AspectTranslation>;
+};
+export type AspectTranslation = {
+    /**
+     * The aspect name.
+     */
+    name: NonEmptyString;
+    /**
+     * The aspect's name appended to the simple name (not `name_in_library`)
+     * of the special ability *Master of (Aspect)*.
+     */
+    master_of_aspect_suffix?: NonEmptyString;
+};
+export declare const config: TypeConfig<Aspect>;

package/lib/types/Aspect.js

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

package/lib/types/Attribute.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @main Attribute
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * @title Attribute
+ */
+export type Attribute = {
+    /**
+     * The attribute's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AttributeTranslation>;
+};
+export type AttributeTranslation = {
+    /**
+     * The attribute's name.
+     */
+    name: NonEmptyString;
+    /**
+     * The abbreviation of the attribute's name.
+     */
+    abbreviation: NonEmptyString;
+    /**
+     * The description of the attribute.
+     */
+    description: NonEmptyString;
+};
+export declare const config: TypeConfig<Attribute>;

package/lib/types/Attribute.js

@@ -0,0 +1,12 @@
+/**
+ * @main Attribute
+ */
+import { getReferencialIntegrityErrorsForTranslatable, reduceIntegrityValidationResults, validateEntityIntegrity } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "Attribute",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: (validators, data, filepath) => reduceIntegrityValidationResults(validateEntityIntegrity(validators.identity.attributes.exists, getFIlenamePrefixAsNumericId(data, filepath), data.id, [{ k: "id" }]), getReferencialIntegrityErrorsForTranslatable(validators, data)),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/Blessing.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @main Blessing
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { DurationUnit } from "./_ActivatableSkillDuration.js";
+import { FixedRange } from "./_ActivatableSkillRange.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Blessing
+ */
+export type Blessing = {
+    /**
+     * The blessing's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a blessing.
+     */
+    parameters: BlessingPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<BlessingTranslation>;
+};
+export type BlessingTranslation = {
+    /**
+     * The name of the blessing.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The effect description.
+     * @markdown
+     * @minLength 1
+     */
+    effect: string;
+    /**
+     * @deprecated
+     */
+    range: string;
+    /**
+     * @deprecated
+     */
+    duration: string;
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+export type BlessingPerformanceParameters = {
+    range: BlessingRange;
+    duration: BlessingDuration;
+};
+export type BlessingRange = {
+    tag: "Self";
+    self: {};
+} | {
+    tag: "Touch";
+    touch: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedRange;
+};
+export type BlessingDuration = {
+    tag: "Immediate";
+    immediate: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedBlessingDuration;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteBlessingDuration;
+};
+export type FixedBlessingDuration = {
+    /**
+     * The (unitless) duration.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The duration unit.
+     */
+    unit: DurationUnit;
+};
+export type IndefiniteBlessingDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export type IndefiniteDurationTranslation = {
+    /**
+     * A description of the duration.
+     * @minLength 1
+     */
+    description: string;
+};
+export declare const config: TypeConfig<Blessing>;

package/lib/types/Blessing.js

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