optolith-database-schema 0.11.3 → 0.11.4

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

@@ -1,52 +0,0 @@
-/**
- * @main SpellSwordEnchantment
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Spell-Sword Enchantment
- */
-export type SpellSwordEnchantment = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<SpellSwordEnchantmentTranslation>;
-};
-export type SpellSwordEnchantmentTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    volume: string;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    /**
-     * The AP value. It is only used if the text cannot be generated from the
-     * given information.
-     */
-    ap_value?: Activatable.AdventurePointsValueReplacement;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<SpellSwordEnchantment>;

package/lib/types/traditionArtifacts/SpellSwordEnchantment.js

@@ -1,12 +0,0 @@
-/**
- * @main SpellSwordEnchantment
- */
-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,57 +0,0 @@
-/**
- * @main StaffEnchantment
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { ResponsiveTextOptional } from "../_ResponsiveText.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Staff Enchantment
- */
-export type StaffEnchantment = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<StaffEnchantmentTranslation>;
-};
-export type StaffEnchantmentTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    volume: string;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * A note, appended to the generated cost string in parenthesis.
-     */
-    cost_note?: ResponsiveTextOptional;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    /**
-     * The AP value. It is only used if the text cannot be generated from the
-     * given information.
-     */
-    ap_value?: Activatable.AdventurePointsValueReplacement;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<StaffEnchantment>;

package/lib/types/traditionArtifacts/StaffEnchantment.js

@@ -1,12 +0,0 @@
-/**
- * @main StaffEnchantment
- */
-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,47 +0,0 @@
-/**
- * @main ToyEnchantment
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Toy Enchantment
- */
-export type ToyEnchantment = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<ToyEnchantmentTranslation>;
-};
-export type ToyEnchantmentTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    volume: string;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<ToyEnchantment>;

package/lib/types/traditionArtifacts/ToyEnchantment.js

@@ -1,12 +0,0 @@
-/**
- * @main ToyEnchantment
- */
-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,47 +0,0 @@
-/**
- * @main Trinkhornzauber
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Trinkhornzauber
- */
-export type Trinkhornzauber = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<TrinkhornzauberTranslation>;
-};
-export type TrinkhornzauberTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    volume: string;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<Trinkhornzauber>;

package/lib/types/traditionArtifacts/Trinkhornzauber.js

@@ -1,12 +0,0 @@
-/**
- * @main Trinkhornzauber
- */
-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,42 +0,0 @@
-/**
- * @main WandEnchantment
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Wand Enchantment
- */
-export type WandEnchantment = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<WandEnchantmentTranslation>;
-};
-export type WandEnchantmentTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<WandEnchantment>;

package/lib/types/traditionArtifacts/WandEnchantment.js

@@ -1,12 +0,0 @@
-/**
- * @main WandEnchantment
- */
-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,47 +0,0 @@
-/**
- * @main WeaponEnchantment
- */
-import { TypeConfig } from "../../typeConfig.js";
-import * as Activatable from "../_Activatable.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { GeneralPrerequisites } from "../_Prerequisite.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Weapon Enchantment
- */
-export type WeaponEnchantment = {
-    id: Activatable.Id;
-    levels?: Activatable.Levels;
-    select_options?: Activatable.SelectOptions;
-    maximum?: Activatable.Maximum;
-    prerequisites?: GeneralPrerequisites;
-    volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
-    property: Activatable.Property;
-    ap_value: Activatable.AdventurePointsValue;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<WeaponEnchantmentTranslation>;
-};
-export type WeaponEnchantmentTranslation = {
-    name: Activatable.Name;
-    name_in_library?: Activatable.NameInLibrary;
-    effect: Activatable.Effect;
-    /**
-     * @deprecated
-     */
-    volume: string;
-    /**
-     * @deprecated
-     */
-    aeCost?: string;
-    /**
-     * @deprecated
-     */
-    bindingCost?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<WeaponEnchantment>;

package/lib/types/traditionArtifacts/WeaponEnchantment.js

@@ -1,12 +0,0 @@
-/**
- * @main WeaponEnchantment
- */
-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,52 +0,0 @@
-/**
- * @main AnimalShape
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape
- */
-export type AnimalShape = {
-    /**
-     * The animal shape's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The animal shape's path.
-     */
-    path: AnimalShapePathReference;
-    /**
-     * The animal shape's size.
-     */
-    size: AnimalShapeSizeReference;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<AnimalShapeTranslation>;
-};
-export type AnimalShapePathReference = {
-    /**
-     * The identifier of the animal shape's path.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-export type AnimalShapeSizeReference = {
-    /**
-     * The identifier of the animal shape's size.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-export type AnimalShapeTranslation = {
-    /**
-     * The animal shape name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShape>;

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

@@ -1,12 +0,0 @@
-/**
- * @main AnimalShape
- */
-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,28 +0,0 @@
-/**
- * @main AnimalShapePath
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape Path
- */
-export type AnimalShapePath = {
-    /**
-     * The animal shape path's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<AnimalShapePathTranslation>;
-};
-export type AnimalShapePathTranslation = {
-    /**
-     * The animal shape path's name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShapePath>;

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

@@ -1,12 +0,0 @@
-/**
- * @main AnimalShapePath
- */
-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,40 +0,0 @@
-/**
- * @main AnimalShapeSize
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape Size
- */
-export type AnimalShapeSize = {
-    /**
-     * The animal shape's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The volume points the animal shape needs.
-     * @integer
-     * @minimum 1
-     */
-    volume: number;
-    /**
-     * The adventure point value of the animal shape.
-     * @integer
-     * @minimum 1
-     */
-    ap_value: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<AnimalShapeSizeTranslation>;
-};
-export type AnimalShapeSizeTranslation = {
-    /**
-     * The animal shape size name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShapeSize>;

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

@@ -1,12 +0,0 @@
-/**
- * @main AnimalShapeSize
- */
-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,28 +0,0 @@
-/**
- * @main Brew
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Brew
- */
-export type Brew = {
-    /**
-     * The brew's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<BrewTranslation>;
-};
-export type BrewTranslation = {
-    /**
-     * The brew name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<Brew>;

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

@@ -1,12 +0,0 @@
-/**
- * @main Brew
- */
-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

@@ -1,57 +0,0 @@
-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 {};