optolith-database-schema 0.11.4 → 0.11.6

package/lib/types/Lessons_Curriculum.js

@@ -0,0 +1,12 @@
+/**
+ * @main Curriculum
+ */
+import { todo } from "../validation/builders/integrity.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),
+};

package/lib/types/Lessons_Guideline.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @main Guideline
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * @title Guideline
+ */
+export type Guideline = {
+    /**
+     * The guideline's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Maximum number of spells that can be exchanged.
+     * @integer
+     * @minimum 0
+     */
+    spellwork_changes_allowed: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<GuidelineTranslation>;
+};
+export type GuidelineTranslation = {
+    /**
+     * The guideline name.
+     */
+    name: NonEmptyString;
+};
+export declare const config: TypeConfig<Guideline>;

package/lib/types/Lessons_Guideline.js

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

package/lib/types/LiturgicalChant.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @main LiturgicalChant
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { FastPerformanceParameters } from "./_ActivatableSkill.js";
+import { Effect } from "./_ActivatableSkillEffect.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { SkillTradition } from "./_Blessed.js";
+import { Enhancements } from "./_Enhancements.js";
+import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { LiturgyPrerequisites } from "./_Prerequisite.js";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Liturgical Chant
+ */
+export type LiturgicalChant = {
+    /**
+     * The liturgical chant's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a liturgical chant.
+     */
+    parameters: FastPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory;
+    /**
+     * The tradition(s) the liturgical chant is available for. Note that general
+     * aspects do not have an associated tradition and thus need to be defined in
+     * a special way.
+     * @minItems 1
+     */
+    traditions: SkillTradition[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: LiturgyPrerequisites;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<LiturgicalChantTranslation>;
+    enhancements?: Enhancements;
+};
+export type LiturgicalChantTranslation = {
+    /**
+     * The name of the liturgical chant.
+     */
+    name: NonEmptyString;
+    /**
+     * A compressed name of the liturgical chant for use in small areas (e.g.
+     * on character sheet). Should only be defined if the `name` does not fit
+     * on character sheet.
+     */
+    name_compressed?: NonEmptyString;
+    /**
+     * The effect description may be either a plain text or a text that is
+     * divided by a list of effects for each quality level. It may also be a
+     * list for each two quality levels.
+     */
+    effect: Effect;
+    /**
+     * @deprecated
+     */
+    casting_time: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    range: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<LiturgicalChant>;

package/lib/types/LiturgicalChant.js

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

package/lib/types/Locale.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @main Locale
+ */
+import { TypeConfig } from "../typeConfig.js";
+/**
+ * @title Supported locale
+ */
+export type Locale = {
+    /**
+     * The locale's identifier. An IETF language tag (BCP47).
+     * @pattern ^[a-z]{2}-[A-Z]{2}$
+     */
+    id: string;
+    /**
+     * Name of the language in it's language.
+     * @minLength 1
+     * @example "Deutsch"
+     * @example "English"
+     * @example "Nederlands"
+     */
+    name: string;
+    /**
+     * Region in which the language is spoken in it's language.
+     * @minLength 1
+     * @example "Deutschland"
+     * @example "United States"
+     * @example "België"
+     */
+    region: string;
+    /**
+     * The language is not (fully) implemented and thus needs to be excluded from
+     * stable releases.
+     */
+    is_missing_implementation?: true;
+};
+export declare const config: TypeConfig<Locale, string>;

package/lib/types/Locale.js

@@ -0,0 +1,12 @@
+/**
+ * @main Locale
+ */
+import { Result } from "../helpers/result.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFilenameAsStringId } from "../validation/filename.js";
+export const config = {
+    name: "Locale",
+    id: getFilenameAsStringId,
+    integrityValidator: () => Result.ok(undefined),
+    schemaValidator: createSchemaValidator(import.meta.url, { ignoreFileNamePattern: true })
+};

package/lib/types/MetaCondition.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @main MetaCondition
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * Meta Conditions are rule elements that work like conditions in the sense that
+ * they have four levels with different effects, but which are not explicitly
+ * listed as conditions.
+ * @title Meta Condition
+ */
+export type MetaCondition = {
+    /**
+     * The meta condition's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MetaConditionTranslation>;
+};
+export type MetaConditionTranslation = {
+    /**
+     * The meta condition's name.
+     */
+    name: NonEmptyString;
+    /**
+     * Additional rules for the meta condition, if applicable.
+     */
+    rules?: NonEmptyMarkdown;
+    /**
+     * The effects for level 1 to 4.
+     */
+    effects: [NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown];
+    errata?: Errata;
+};
+export declare const config: TypeConfig<MetaCondition>;

package/lib/types/MetaCondition.js

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

package/lib/types/PactCategory.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @main PactCategory
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Pact Category
+ */
+export type PactCategory = {
+    /**
+     * The pact category's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Types of creatures in this category.
+     * @minItems 1
+     */
+    types: PactType[];
+    /**
+     * Domains in this category.
+     * @minItems 1
+     */
+    domains: PactDomain[];
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PactCategoryTranslation>;
+};
+export type PactCategoryTranslation = {
+    /**
+     * The name of the pact category.
+     */
+    name: NonEmptyString;
+    errata?: Errata;
+};
+export type PactType = {
+    /**
+     * The 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<PactTypeTranslation>;
+};
+export type PactTypeTranslation = {
+    /**
+     * The name of the type.
+     */
+    name: NonEmptyString;
+};
+export type PactDomain = {
+    /**
+     * The domain's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PactDomainTranslation>;
+};
+export type PactDomainTranslation = {
+    /**
+     * The name of the domain.
+     */
+    name: NonEmptyString;
+};
+export declare const config: TypeConfig<PactCategory>;

package/lib/types/PactCategory.js

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

package/lib/types/Patron.d.ts

@@ -0,0 +1,207 @@
+/**
+ * @main Patron
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { AdvantageIdentifier, AttributeIdentifier, SkillIdentifier } from "./_Identifier.js";
+import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { AdvantageReference, CultureReference, DisadvantageReference, PatronCategoryReference, SkillReference, SpellworkReference } from "./_SimpleReferences.js";
+/**
+ * @title Patron
+ */
+export type Patron = {
+    /**
+     * The patron's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The patron's category.
+     */
+    category: PatronCategoryReference;
+    /**
+     * The patron-specific skills.
+     */
+    skills: [SkillReference, SkillReference, SkillReference];
+    /**
+     * The patron is only available to a certain set of cultures. It may be
+     * available to all, it may be available to only specific ones (intersection)
+     * and it may be available to all except specific ones to the listed cultures
+     * (difference).
+     */
+    culture: PatronCulture;
+    /**
+     * The list of cultures where patrons from this category can be the primary
+     * patron of.
+     * @uniqueItems
+     */
+    primary_patron_cultures?: CultureReference[];
+    /**
+     * The patron-specific powers. Used by animist power Animal Powers I–III and
+     * should only be present on animal patrons.
+     */
+    powers?: [AnimalPowersLevel1, AnimalPowersLevel2, AnimalPowersLevel3];
+    /**
+     * The patron-specific AE cost. Used by several animist forces for animal
+     * patrons.
+     * @integer
+     * @minimum 2
+     * @multipleOf 2
+     */
+    ae_cost?: number;
+    /**
+     * The patron-specific improvement cost. Used by several animist forces for
+     * animal patrons.
+     */
+    improvement_cost?: ImprovementCost;
+    /**
+     * The patron may grant common advantages that are taken into account during
+     * character creation.
+     *
+     * *Source:* Geisterwald & Knochenklippen, p. 6-7
+     * @minLength 1
+     */
+    common_advantages?: AdvantageReference[];
+    /**
+     * The patron may grant common disadvantages that are taken into account
+     * during character creation.
+     *
+     * *Source:* Geisterwald & Knochenklippen, p. 6-7
+     * @minLength 1
+     */
+    common_disadvantages?: DisadvantageReference[];
+    /**
+     * The animist may learn spellworks common for this patron.
+     *
+     * *Source:* Geisterwald & Knochenklippen, p. 6-7
+     * @minLength 1
+     */
+    common_spellworks?: SpellworkReference[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PatronTranslation>;
+};
+export type PatronTranslation = {
+    /**
+     * The name of the patron.
+     */
+    name: NonEmptyString;
+};
+/**
+ * The patron cultures the patron is or is not part of. If the patron is part of
+ * all patron cultures, the set should be empty and the operation should be
+ * difference.
+ */
+export type PatronCulture = {
+    set: CultureReference[];
+    operation: PatronCultureOperation;
+};
+/**
+ * The set operation to combine the set of all patron cultures with the
+ * specified set of patron cultures: If they should intersect, the patron is
+ * only part of the given cultures. If they should differ, the patron is only
+ * part of the cultures that are not given.
+ */
+export declare enum PatronCultureOperation {
+    Intersection = "Intersection",
+    Difference = "Difference"
+}
+export type AdvantageAnimalPower = {
+    /**
+     * The advantage's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: AdvantageIdentifier;
+    /**
+     * It grants a higher level of the advantage.
+     * @integer
+     * @minimum 2
+     */
+    level?: number;
+    /**
+     * It grants a specific general option of the advantage.
+     * @integer
+     * @minimum 1
+     */
+    option?: number;
+};
+export type SkillAnimalPower = {
+    /**
+     * The skill's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: SkillIdentifier;
+    /**
+     * The points that gets added to the skill's rating.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+};
+export type AnimalPowerLevel1 = {
+    tag: "Advantage";
+    advantage: AdvantageAnimalPower;
+} | {
+    tag: "Skill";
+    skill: SkillAnimalPower;
+};
+/**
+ * @minItems 1
+ */
+export type AnimalPowersLevel1 = AnimalPowerLevel1[];
+export type CombatAnimalPower = {
+    /**
+     * The combat value.
+     */
+    id: CombatAnimalPowerType;
+    /**
+     * The value that gets added to the combat value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+export declare enum CombatAnimalPowerType {
+    Attack = "Attack",
+    Parry = "Parry",
+    RangedCombat = "RangedCombat",
+    Dodge = "Dodge",
+    DamagePoints = "DamagePoints",
+    Protection = "Protection"
+}
+export type AnimalPowerLevel2 = {
+    tag: "Combat";
+    combat: CombatAnimalPower;
+};
+/**
+ * @minItems 1
+ */
+export type AnimalPowersLevel2 = AnimalPowerLevel2[];
+export type AttributeAnimalPower = {
+    /**
+     * The attribute's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: AttributeIdentifier;
+    /**
+     * The value that gets added to the attribute.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+export type AnimalPowerLevel3 = {
+    tag: "Attribute";
+    attribute: AttributeAnimalPower;
+};
+/**
+ * @minItems 1
+ */
+export type AnimalPowersLevel3 = AnimalPowerLevel3[];
+export declare const config: TypeConfig<Patron>;

package/lib/types/Patron.js

@@ -0,0 +1,32 @@
+/**
+ * @main Patron
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+/**
+ * The set operation to combine the set of all patron cultures with the
+ * specified set of patron cultures: If they should intersect, the patron is
+ * only part of the given cultures. If they should differ, the patron is only
+ * part of the cultures that are not given.
+ */
+export var PatronCultureOperation;
+(function (PatronCultureOperation) {
+    PatronCultureOperation["Intersection"] = "Intersection";
+    PatronCultureOperation["Difference"] = "Difference";
+})(PatronCultureOperation = PatronCultureOperation || (PatronCultureOperation = {}));
+export var CombatAnimalPowerType;
+(function (CombatAnimalPowerType) {
+    CombatAnimalPowerType["Attack"] = "Attack";
+    CombatAnimalPowerType["Parry"] = "Parry";
+    CombatAnimalPowerType["RangedCombat"] = "RangedCombat";
+    CombatAnimalPowerType["Dodge"] = "Dodge";
+    CombatAnimalPowerType["DamagePoints"] = "DamagePoints";
+    CombatAnimalPowerType["Protection"] = "Protection";
+})(CombatAnimalPowerType = CombatAnimalPowerType || (CombatAnimalPowerType = {}));
+export const config = {
+    name: "Patron",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Patron"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/PatronCategory.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @main PatronCategory
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { CultureReference } from "./_SimpleReferences.js";
+/**
+ * @title Patron Category
+ */
+export type PatronCategory = {
+    /**
+     * The patron category's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The list of cultures where patrons from this category can be the primary
+     * patron of.
+     * @minItems 1
+     * @uniqueItems
+     */
+    primary_patron_cultures: CultureReference[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PatronCategoryTranslation>;
+};
+export type PatronCategoryTranslation = {
+    /**
+     * The name of the patron category.
+     */
+    name: NonEmptyString;
+};
+export declare const config: TypeConfig<PatronCategory>;

package/lib/types/PatronCategory.js

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