optolith-database-schema 0.17.0 → 0.18.1

package/lib/helpers/objectPath.js

@@ -1,3 +0,0 @@
-export const printPathDescriptor = (pathDescriptor) => pathDescriptor
-    .map(segment => "k" in segment ? segment.k : segment.i)
-    .join("/");

package/lib/helpers/pair.d.ts

@@ -1,20 +0,0 @@
-/**
- * Map the second element of a pair using a function that receives both
- * elements.
- */
-export declare const mapSecond: <A, B, C>(f: (second: B, first: A) => C) => (pair: [A, B]) => [A, C];
-/**
- * Map the second element of a pair using a function that receives both
- * elements and returns a `Promise`.
- */
-export declare const mapSecondAsync: <A, B, C>(f: (second: B, first: A) => Promise<C>) => (pair: [A, B]) => Promise<[A, C]>;
-/**
- * Map a value using a function into the second value of a pair with the
- * original value.
- */
-export declare const mapToSecond: <A, B>(f: (value: A) => B) => (value: A) => [A, B];
-/**
- * Map a value using a function that returns a `Promise` into the second value
- * of a pair with the original value.
- */
-export declare const mapToSecondAsync: <A, B>(f: (value: A) => Promise<B>) => (value: A) => Promise<[A, B]>;

package/lib/helpers/pair.js

@@ -1,20 +0,0 @@
-/**
- * Map the second element of a pair using a function that receives both
- * elements.
- */
-export const mapSecond = (f) => (pair) => [pair[0], f(pair[1], pair[0])];
-/**
- * Map the second element of a pair using a function that receives both
- * elements and returns a `Promise`.
- */
-export const mapSecondAsync = (f) => async (pair) => [pair[0], await f(pair[1], pair[0])];
-/**
- * Map a value using a function into the second value of a pair with the
- * original value.
- */
-export const mapToSecond = (f) => (value) => [value, f(value)];
-/**
- * Map a value using a function that returns a `Promise` into the second value
- * of a pair with the original value.
- */
-export const mapToSecondAsync = (f) => async (value) => [value, await f(value)];

package/lib/helpers/result.d.ts

@@ -1,57 +0,0 @@
-/**
- * A result is either a value or an error.
- */
-export type Result<T, E> = Ok<T> | Error<E>;
-/**
- * A result that contains a value.
- */
-export type Ok<T> = {
-    readonly tag: "Ok";
-    readonly value: T;
-};
-/**
- * A result that contains an error.
- */
-export type Error<E> = {
-    readonly tag: "Error";
-    readonly error: E;
-};
-/**
- * Creates a result that contains a value.
- */
-export declare const ok: <T>(value: T) => Result<T, never>;
-/**
- * Checks if a result contains a value.
- */
-export declare const isOk: <T, E>(result: Result<T, E>) => result is Ok<T>;
-/**
- * Creates a result that contains an error.
- */
-export declare const error: <E>(error: E) => Result<never, E>;
-/**
- * Checks if a result contains an error.
- */
-export declare const isError: <T, E>(result: Result<T, E>) => result is Error<E>;
-/**
- * Reduces a result to a value of a common type.
- */
-export declare const reduce: <T, E, R>(result: Result<T, E>, fok: (value: T) => R, ferror: (error: E) => R) => R;
-/**
- * Maps the value of a result to a new value.
- */
-export declare const map: <T, U, E>(result: Result<T, E>, f: (value: T) => U) => Result<U, E>;
-/**
- * Maps an error to a new error.
- */
-export declare const mapError: <T, E, F>(result: Result<T, E>, f: (value: E) => F) => Result<T, F>;
-export declare const combine: <T1, T2, TR, E1, E2, ER>(result1: Result<T1, E1>, result2: Result<T2, E2>, fok: (value1: T1, value2: T2) => TR, ferror: (error1: E1, error2: E2) => ER) => Result<TR, E1 | E2 | ER>;
-export declare const Result: Readonly<{
-    ok: <T>(value: T) => Result<T, never>;
-    isOk: <T_1, E>(result: Result<T_1, E>) => result is Ok<T_1>;
-    error: <E_1>(error: E_1) => Result<never, E_1>;
-    isError: <T_2, E_2>(result: Result<T_2, E_2>) => result is Error<E_2>;
-    reduce: <T_3, E_3, R>(result: Result<T_3, E_3>, fok: (value: T_3) => R, ferror: (error: E_3) => R) => R;
-    map: <T_4, U, E_4>(result: Result<T_4, E_4>, f: (value: T_4) => U) => Result<U, E_4>;
-    mapError: <T_5, E_5, F>(result: Result<T_5, E_5>, f: (value: E_5) => F) => Result<T_5, F>;
-    combine: <T1, T2, TR, E1, E2, ER>(result1: Result<T1, E1>, result2: Result<T2, E2>, fok: (value1: T1, value2: T2) => TR, ferror: (error1: E1, error2: E2) => ER) => Result<TR, E1 | E2 | ER>;
-}>;

package/lib/helpers/result.js

@@ -1,45 +0,0 @@
-/**
- * Creates a result that contains a value.
- */
-export const ok = (value) => ({ tag: "Ok", value });
-/**
- * Checks if a result contains a value.
- */
-export const isOk = (result) => result.tag === "Ok";
-/**
- * Creates a result that contains an error.
- */
-export const error = (error) => ({ tag: "Error", error });
-/**
- * Checks if a result contains an error.
- */
-export const isError = (result) => result.tag === "Error";
-/**
- * Reduces a result to a value of a common type.
- */
-export const reduce = (result, fok, ferror) => isOk(result) ? fok(result.value) : ferror(result.error);
-/**
- * Maps the value of a result to a new value.
- */
-export const map = (result, f) => isOk(result) ? ok(f(result.value)) : result;
-/**
- * Maps an error to a new error.
- */
-export const mapError = (result, f) => isError(result) ? error(f(result.error)) : result;
-export const combine = (result1, result2, fok, ferror) => isOk(result1)
-    ? isOk(result2)
-        ? ok(fok(result1.value, result2.value))
-        : result2
-    : isOk(result2)
-        ? result1
-        : error(ferror(result1.error, result2.error));
-export const Result = Object.freeze({
-    ok,
-    isOk,
-    error,
-    isError,
-    reduce,
-    map,
-    mapError,
-    combine,
-});

package/lib/helpers/typeSafety.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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`.
- * @example
- * const aorb = (x: "a" | "b") => {
- *   switch (x) {
- *     case "a": return 1
- *     case "b": return 2
- *     default: return assertExhaustive(x)
- *   }
- * }
- */
-export declare function assertExhaustive(_x: never): never;

package/lib/helpers/typeSafety.js

@@ -1,16 +0,0 @@
-/**
- * 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`.
- * @example
- * const aorb = (x: "a" | "b") => {
- *   switch (x) {
- *     case "a": return 1
- *     case "b": return 2
- *     default: return assertExhaustive(x)
- *   }
- * }
- */
-export function assertExhaustive(_x) {
-    throw new Error("The switch is not exhaustive.");
-}

package/lib/helpers/typeSafety.test.d.ts

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

package/lib/helpers/typeSafety.test.js

@@ -1,10 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { assertExhaustive } from "./typeSafety.js";
-describe("assertExhaustive", () => {
-    it("should throw an error with the message 'The switch is not exhaustive.'", () => {
-        assert.throws(
-        // @ts-expect-error The function should never receive a value.
-        () => assertExhaustive(""), err => err instanceof Error && err.message === "The switch is not exhaustive.");
-    });
-});

package/lib/typeConfig.d.ts

@@ -1,10 +0,0 @@
-import { IntegrityValidator } from "./validation/builders/integrity.js";
-import { FileNameValidator } from "./validation/builders/naming.js";
-import { SchemaValidator } from "./validation/builders/schema.js";
-export type TypeConfig<T, ID extends string | number, N extends string> = {
-    name: N;
-    id: (data: T, filepath: string) => ID;
-    integrityValidator: IntegrityValidator<T>;
-    schemaValidator: SchemaValidator<T>;
-    fileNameValidator: FileNameValidator;
-};

package/lib/typeConfig.js

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

package/lib/types/CombatTechnique_Close.d.ts

@@ -1,73 +0,0 @@
-/**
- * @main CloseCombatTechnique
- */
-import { TypeConfig } from "../typeConfig.js";
-import { ImprovementCost } from "./_ImprovementCost.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { AttributeReference } from "./_SimpleReferences.js";
-import { Errata } from "./source/_Erratum.js";
-import { PublicationRefs } from "./source/_PublicationRef.js";
-/**
- * @title Close Combat Technique
- */
-export type CloseCombatTechnique = {
-    /**
-     * The close combat technique's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * Special rules for the combat technique that apply to all weapons in this
-     * category.
-     */
-    special: CloseCombatTechniqueSpecialRules;
-    /**
-     * The primary attribute(s).
-     * @minItems 1
-     * @maxItems 2
-     * @uniqueItems
-     */
-    primary_attribute: AttributeReference[];
-    /**
-     * The *Breaking Point Rating* of the respective combat technique.
-     * @integer
-     * @minimum 1
-     */
-    breaking_point_rating: number;
-    improvement_cost: ImprovementCost;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<CloseCombatTechniqueTranslation>;
-};
-/**
- * Special rules for the combat technique that apply to all weapons in this
- * category.
- */
-export type CloseCombatTechniqueSpecialRules = {
-    /**
-     * Is parrying possible with this combat technique?
-     */
-    can_parry: boolean;
-    has_damage_threshold: boolean;
-    has_reach: boolean;
-    has_length: boolean;
-    has_shield_size: boolean;
-};
-export type CloseCombatTechniqueTranslation = {
-    /**
-     * The name of the condition.
-     * @minLength 1
-     */
-    name: string;
-    /**
-     * Additional rules for the condition, if applicable.
-     * @markdown
-     * @minLength 1
-     */
-    special?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<CloseCombatTechnique, CloseCombatTechnique["id"], "CloseCombatTechnique">;

package/lib/types/CombatTechnique_Close.js

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

package/lib/types/CombatTechnique_Ranged.d.ts

@@ -1,66 +0,0 @@
-/**
- * @main RangedCombatTechnique
- */
-import { TypeConfig } from "../typeConfig.js";
-import { ImprovementCost } from "./_ImprovementCost.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { AttributeReference } from "./_SimpleReferences.js";
-import { Errata } from "./source/_Erratum.js";
-import { PublicationRefs } from "./source/_PublicationRef.js";
-/**
- * @title Ranged Combat Technique
- */
-export type RangedCombatTechnique = {
-    /**
-     * The ranged combat technique's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * Special rules for the combat technique that apply to all weapons in this
-     * category.
-     */
-    special: RangedCombatTechniqueSpecialRules;
-    /**
-     * The primary attribute(s).
-     * @minItems 1
-     * @maxItems 2
-     * @uniqueItems
-     */
-    primary_attribute: AttributeReference[];
-    /**
-     * The *Breaking Point Rating* of the respective combat technique.
-     * @integer
-     * @minimum 1
-     */
-    breaking_point_rating: number;
-    improvement_cost: ImprovementCost;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<RangedCombatTechniqueTranslation>;
-};
-/**
- * Special rules for the combat technique that apply to all weapons in this
- * category.
- */
-export type RangedCombatTechniqueSpecialRules = {
-    has_ammunition: boolean;
-};
-export type RangedCombatTechniqueTranslation = {
-    /**
-     * The name of the condition.
-     * @minLength 1
-     */
-    name: string;
-    /**
-     * Additional rules for the condition, if applicable.
-     * @markdown
-     * @minLength 1
-     */
-    special?: string;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<RangedCombatTechnique, RangedCombatTechnique["id"], "RangedCombatTechnique">;

package/lib/types/CombatTechnique_Ranged.js

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

package/lib/types/Kirchenpraegung.d.ts

@@ -1,10 +0,0 @@
-/**
- * @main Kirchenpraegung
- */
-import { TypeConfig } from "../typeConfig.js";
-import { Influence } from "./_Influence.js";
-/**
- * @title Kirchenprägung
- */
-export type Kirchenpraegung = Influence;
-export declare const config: TypeConfig<Kirchenpraegung, Kirchenpraegung["id"], "Kirchenpraegung">;

package/lib/types/Kirchenpraegung.js

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

package/lib/types/Lessons_Curriculum.d.ts

@@ -1,236 +0,0 @@
-/**
- * @main Curriculum
- */
-import { TypeConfig } from "../typeConfig.js";
-import { ElementIdentifier, MagicalTraditionIdentifier, PropertyIdentifier, SkillIdentifier } from "./_Identifier.js";
-import { CombatTechniqueIdentifier, SpellworkIdentifier } from "./_IdentifierGroup.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { NonEmptyString } from "./_NonEmptyString.js";
-import { GuidelineReference } from "./_SimpleReferences.js";
-import { Errata } from "./source/_Erratum.js";
-import { PublicationRefs } from "./source/_PublicationRef.js";
-/**
- * This is a curriculum of a specified academy, containing the guideline,
- * elective and restricted spellworks as well as the lesson packages of that
- * academy.
- * @title Curriculum
- */
-export type Curriculum = {
-    /**
-     * The curriculum's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The institution's guideline.
-     */
-    guideline: GuidelineReference;
-    /**
-     * The academy's elective spellworks package.
-     */
-    elective_spellworks?: ElectiveSpellworks;
-    /**
-     * The academy's restricted spellworks package.
-     */
-    restricted_spellworks?: RestrictedSpellworks;
-    /**
-     * A list of available lesson packages.
-     */
-    lesson_packages: LessonPackages;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<CurriculumTranslation>;
-};
-export type CurriculumTranslation = {
-    /**
-     * The name of the academy.
-     */
-    name: NonEmptyString;
-    errata?: Errata;
-};
-/**
- * The academy's elective spellworks package.
- */
-type ElectiveSpellworks = {
-    tag: "DefinedByGameMaster";
-    defined_by_game_master: {};
-} | {
-    tag: "Specific";
-    specific: SpecificElectiveSpellworks;
-};
-export type SpecificElectiveSpellworks = {
-    /**
-     * @minItems 1
-     */
-    list: ElectiveSpellwork[];
-};
-export type ElectiveSpellwork = {
-    id: SpellworkIdentifier;
-    /**
-     * The elective spellwork may only take effect if a certain condition is met.
-     * The condition may be related to professions or profession variants, but it
-     * is designed so that it can work without a specific profession, as multiple
-     * may belong to an institute, but with referencing other entities instead.
-     */
-    restriction?: ElectiveSpellworkRestriction;
-};
-/**
- * The elective spellwork may only take effect if a certain condition is met.
- * The condition may be related to professions or profession variants, but it is
- * designed so that it can work without a specific profession, as multiple may
- * belong to an institute, but with referencing other entities instead.
- */
-export type ElectiveSpellworkRestriction = {
-    tag: "Element";
-    element: ElectiveSpellworkElementRestriction;
-};
-export type ElectiveSpellworkElementRestriction = {
-    id: ElementIdentifier;
-};
-/**
- * The academy's restricted spellworks package.
- * @minItems 1
- */
-export type RestrictedSpellworks = RestrictedSpellwork[];
-/**
- * The academy's restricted spellworks package.
- */
-export type RestrictedSpellwork = {
-    tag: "Property";
-    property: RestrictedProperty;
-} | {
-    tag: "Spellwork";
-    spellwork: SpellworkIdentifier;
-} | {
-    tag: "DemonSummoning";
-    demon_summoning: {};
-} | {
-    tag: "Borbaradian";
-    borbaradian: {};
-} | {
-    tag: "DamageIntelligent";
-    damage_intelligent: {};
-};
-export type RestrictedProperty = {
-    /**
-     * The identifier of the property that spellworks are disallowed from.
-     * @integer
-     * @minimum 1
-     */
-    id: PropertyIdentifier;
-    /**
-     * Exclude specific spellworks from the restriction.
-     * @minItems 1
-     */
-    exclude?: SpellworkIdentifier[];
-    /**
-     * Spellworks from this property up to a certain number are allowed.
-     * Spellworks excluded from this restriction definition using `exclude` do
-     * not contribute to the maximum.
-     */
-    maximum?: number;
-};
-/**
- * A list of available lesson packages.
- */
-export type LessonPackages = [LessonPackage, LessonPackage];
-/**
- * @title Lesson Package
- * @minProperties 3
- */
-export type LessonPackage = {
-    /**
-     * The lesson package's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The spell values difference of the lesson package. This field reflects the
-     * changes (difference) to the field of the same name in the profession
-     * package. If a spell gets to SR 0 because of this, it will be removed
-     * completely.
-     * @minItems 1
-     */
-    spellwork_changes?: SpellworkChange[];
-    skills?: AbilityAdjustment[];
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<LessonPackageTranslation>;
-};
-export type SpellworkChange = {
-    base: SpellworkAdjustment;
-    replacement: SpellworkAdjustment;
-};
-export type LessonPackageTranslation = {
-    /**
-     * The name of the lesson package.
-     */
-    name: NonEmptyString;
-    /**
-     * The spell values difference of the lesson package. Use this field to
-     * specify a text that is displayed instead of the generated
-     * `spellwork_changes` list. The field is displayed even if no list is
-     * present.
-     */
-    spellwork_changes?: NonEmptyString;
-};
-export type AbilityAdjustment = {
-    tag: "CombatTechnique";
-    combat_technique: CombatTechniqueAdjustment;
-} | {
-    tag: "Skill";
-    skill: SkillAdjustment;
-} | {
-    tag: "Spellwork";
-    spellwork: SpellworkAdjustment;
-};
-export type CombatTechniqueAdjustment = {
-    id: CombatTechniqueIdentifier;
-    /**
-     * The combat technique points that will be added to the current combat
-     * technique rating.
-     * @integer
-     * @minimum -6
-     * @maximum 6
-     */
-    points: number;
-};
-export type SkillAdjustment = {
-    /**
-     * The skill's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: SkillIdentifier;
-    /**
-     * The skill points that will be added to the current skill rating.
-     * @integer
-     * @minimum -8
-     * @maximum 8
-     */
-    points: number;
-};
-export type SpellworkAdjustment = {
-    id: SpellworkIdentifier;
-    /**
-     * The skill points that will be added to the current skill rating. If a
-     * spell gets to a skill rating of 0 because of this, it will be removed
-     * completely.
-     * @integer
-     * @minimum -10
-     * @maximum 10
-     */
-    points: number;
-    /**
-     * The target tradition. If the target spell is not from the Guild Mage
-     * tradition, specify the tradition identifier here.
-     */
-    tradition?: MagicalTraditionIdentifier;
-};
-export declare const config: TypeConfig<Curriculum, Curriculum["id"], "Curriculum">;
-export {};

package/lib/types/Lessons_Curriculum.js

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