optolith-database-schema 0.11.4 → 0.11.6

package/lib/types/magicalActions/MagicalDance.d.ts

@@ -0,0 +1,119 @@
+/**
+ * @main MagicalDance
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { FixedOneTimeCostTranslation } from "../FamiliarsTrick.js";
+import { CheckResultBasedModifier } from "../_ActivatableSkillCheckResultBased.js";
+import { IndefiniteOneTimeCostTranslation } from "../_ActivatableSkillCost.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PropertyReference } from "../_SimpleReferences.js";
+import { SkillCheck } from "../_SkillCheck.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import { MusicDuration, MusicTraditionReference } from "./_MusicTradition.js";
+/**
+ * @title Magical Dance
+ */
+export type MagicalDance = {
+    /**
+     * The magical dance's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * Measurable parameters of a magical dance.
+     */
+    parameters: MagicalDancePerformanceParameters;
+    /**
+     * The associated property.
+     */
+    property: PropertyReference;
+    /**
+     * The music tradition(s) the magical dance is available for. This also
+     * defines the different names in each music tradition.
+     * @minItems 1
+     */
+    music_tradition: MusicTraditionReference[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalDanceTranslation>;
+};
+export type MagicalDanceTranslation = {
+    /**
+     * The name of the magical dance.
+     */
+    name: 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
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a magical dance.
+ */
+export type MagicalDancePerformanceParameters = {
+    duration: MusicDuration;
+    cost: MagicalDanceCost;
+};
+export type MagicalDanceCost = {
+    tag: "Fixed";
+    fixed: FixedMagicalDanceCost;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteMagicalDanceCost;
+};
+export type FixedMagicalDanceCost = {
+    /**
+     * The (temporary) AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<FixedOneTimeCostTranslation>;
+};
+export type IndefiniteMagicalDanceCost = {
+    /**
+     * Specified if the indefinite description's result value is to be
+     * modified by a certain number.
+     */
+    modifier?: CheckResultBasedModifier;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteOneTimeCostTranslation>;
+};
+export declare const config: TypeConfig<MagicalDance>;

package/lib/types/magicalActions/MagicalDance.js

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

package/lib/types/magicalActions/MagicalMelody.d.ts

@@ -0,0 +1,124 @@
+/**
+ * @main MagicalMelody
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PropertyReference } from "../_SimpleReferences.js";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import { MusicDuration, MusicTraditionReference } from "./_MusicTradition.js";
+import { MusicalSkillReference } from "./_SkillReference.js";
+/**
+ * @title Magical Melody
+ */
+export type MagicalMelody = {
+    /**
+     * The magical melody'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;
+    /**
+     * Arcane bards must make a *Singing (area of application)* or *Music (area of
+     * application)* check for each magical melody.
+     * @minItems 1
+     * @maxItems 2
+     * @uniqueItems
+     */
+    skill: MusicalSkillReference[];
+    /**
+     * Measurable parameters of a magical melody.
+     */
+    parameters: MagicalMelodyPerformanceParameters;
+    /**
+     * The associated property.
+     */
+    property: PropertyReference;
+    /**
+     * The music tradition(s) the magical melody is available for. This also
+     * defines the different names in each music tradition.
+     * @minItems 1
+     */
+    music_tradition: MusicTraditionReference[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalMelodyTranslation>;
+};
+export type MagicalMelodyTranslation = {
+    /**
+     * The name of the magical melody.
+     */
+    name: 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
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a magical melody.
+ */
+export type MagicalMelodyPerformanceParameters = {
+    duration: MusicDuration;
+    cost: MagicalMelodyCost;
+};
+export type MagicalMelodyCost = {
+    tag: "Fixed";
+    fixed: FixedMagicalMelodyCost;
+} | {
+    tag: "FirstPerson";
+    first_person: FirstPersonMagicalMelodyCost;
+};
+export type FixedMagicalMelodyCost = {
+    /**
+     * The (temporary) AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+export type FirstPersonMagicalMelodyCost = {
+    /**
+     * The (temporary) AE cost value for the first targeted person. The AE
+     * cost for each additional person is half this value.
+     * @integer
+     * @minimum 1
+     * @multipleOf 2
+     */
+    value: number;
+};
+export declare const config: TypeConfig<MagicalMelody>;

package/lib/types/magicalActions/MagicalMelody.js

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

package/lib/types/magicalActions/MagicalRune.d.ts

@@ -0,0 +1,294 @@
+/**
+ * @main MagicalRune
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { CheckResultBasedDuration } from "../_ActivatableSkillDuration.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { CombatTechniqueIdentifier } from "../_IdentifierGroup.js";
+import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { ResponsiveText, ResponsiveTextOptional } from "../_ResponsiveText.js";
+import { PropertyReference } from "../_SimpleReferences.js";
+import { SkillCheck } from "../_SkillCheck.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Magical Rune
+ */
+export type MagicalRune = {
+    /**
+     * The magical rune's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The options the magical rune has, if any.
+     *
+     * If there are multiple options, the magical rune may be activated for each
+     * option, that is, multiple times.
+     */
+    options?: MagicalRuneOption[];
+    /**
+     * 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?: MagicalRuneCheckPenalty;
+    /**
+     * Measurable parameters of a magical rune.
+     */
+    parameters: MagicalRunePerformanceParameters;
+    /**
+     * The associated property.
+     */
+    property: PropertyReference;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: MagicalRuneImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalRuneTranslation>;
+};
+export type MagicalRuneTranslation = {
+    /**
+     * The name of the magical rune.
+     *
+     * If the rune has an option, the option’s name will/should not be included in
+     * the name as well as its surrounding parenthesis. It will/should be combined
+     * on demand.
+     */
+    name: NonEmptyString;
+    /**
+     * The full name of the entry as stated in the sources. Only use when `name`
+     * needs to be different from full name for text generation purposes.
+     */
+    name_in_library?: NonEmptyString;
+    /**
+     * The native name of the magical rune.
+     */
+    native_name?: 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
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    crafting_time: {
+        slow: {
+            full: string;
+            abbr: string;
+        };
+        fast: {
+            full: string;
+            abbr: string;
+        };
+    };
+    /**
+     * @deprecated
+     */
+    duration: {
+        slow: {
+            full: string;
+            abbr: string;
+        };
+        fast: {
+            full: string;
+            abbr: string;
+        };
+    };
+    errata?: Errata;
+};
+export type MagicalRuneCheckPenalty = {
+    tag: "CombatTechnique";
+    combat_technique: MagicalRuneCombatTechniqueCheckPenalty;
+};
+export type MagicalRuneCombatTechniqueCheckPenalty = {
+    /**
+     * A map from combat techniques to their modifiers.
+     * @minItems 1
+     */
+    map: MagicalRuneCombatTechniqueCheckPenaltyMapping[];
+    rest: MagicalRuneCombatTechniqueCheckPenaltyRest;
+};
+export type MagicalRuneCombatTechniqueCheckPenaltyMapping = {
+    /**
+     * The combat technique's identifier.
+     */
+    id: CombatTechniqueIdentifier;
+    /**
+     * The check modifier for the specified combat technique.
+     * @integer
+     */
+    modifier: number;
+};
+export type MagicalRuneCombatTechniqueCheckPenaltyRest = {
+    /**
+     * The check modifier for combat techniques not specified in `map`.
+     * @integer
+     */
+    modifier: number;
+};
+/**
+ * Measurable parameters of a magical rune.
+ */
+export type MagicalRunePerformanceParameters = {
+    /**
+     * The AE cost.
+     */
+    cost: MagicalRuneCost;
+    /**
+     * The crafting time.
+     */
+    crafting_time: MagicalRuneCraftingTime;
+    /**
+     * The duration.
+     */
+    duration: MagicalRuneDuration;
+};
+export type MagicalRuneCost = {
+    tag: "Single";
+    single: SingleMagicalRuneCost;
+} | {
+    tag: "Disjunction";
+    disjunction: MagicalRuneCostDisjunction;
+} | {
+    tag: "DerivedFromOption";
+    derived_from_option: {};
+};
+export type MagicalRuneOptionCost = {
+    tag: "Single";
+    single: SingleMagicalRuneCost;
+} | {
+    tag: "Disjunction";
+    disjunction: MagicalRuneCostDisjunction;
+};
+export type SingleMagicalRuneCost = {
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<SingleMagicalRuneCostTranslation>;
+};
+export type SingleMagicalRuneCostTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note: ResponsiveTextOptional;
+};
+export type MagicalRuneCostDisjunction = {
+    /**
+     * A set of possible AE cost values.
+     * @minItems 2
+     */
+    list: SingleMagicalRuneCost[];
+};
+export type MagicalRuneCraftingTime = {
+    /**
+     * The (unitless) crafting time.
+     */
+    value: 1 | 2 | 4;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<MagicalRuneCraftingTimeTranslation>;
+};
+export type MagicalRuneCraftingTimeTranslation = {
+    /**
+     * The crafting time has to be per a specific countable entity, e.g. `8
+     * action per person`.
+     */
+    per: ResponsiveText;
+};
+export type MagicalRuneDuration = {
+    /**
+     * The duration on slow rune application.
+     */
+    slow: CheckResultBasedDuration;
+    /**
+     * The duration on fast rune application.
+     */
+    fast: CheckResultBasedDuration;
+};
+export type MagicalRuneImprovementCost = {
+    tag: "Constant";
+    constant: ConstantMagicalRuneImprovementCost;
+} | {
+    tag: "DerivedFromOption";
+    derived_from_option: {};
+};
+export type ConstantMagicalRuneImprovementCost = {
+    value: ImprovementCost;
+};
+export type MagicalRuneOption = {
+    /**
+     * The magical rune option’s identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The option-specific AE cost.
+     */
+    cost: MagicalRuneOptionCost;
+    /**
+     * The option-specific improvement cost.
+     */
+    improvement_cost: ImprovementCost;
+    suboption: MagicalRuneSuboption;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalRuneOptionTranslation>;
+};
+export type MagicalRuneSuboption = {
+    tag: "Custom";
+    custom: CustomMagicalRuneSuboption;
+};
+export type CustomMagicalRuneSuboption = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<CustomMagicalRuneSuboptionTranslation>;
+};
+export type CustomMagicalRuneSuboptionTranslation = {
+    /**
+     * One or more examples for the suboption.
+     */
+    examples?: NonEmptyString[];
+};
+export type MagicalRuneOptionTranslation = {
+    /**
+     * The name of the option.
+     *
+     * The surrounding parenthesis will/should not be included, they will/should
+     * be generated.
+     */
+    name: NonEmptyString;
+    /**
+     * The native name of the magical rune option.
+     */
+    native_name: NonEmptyString;
+};
+export declare const config: TypeConfig<MagicalRune>;

package/lib/types/magicalActions/MagicalRune.js

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

package/lib/types/magicalActions/ZibiljaRitual.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @main ZibiljaRitual
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { OneTimePerformanceParameters } from "../_ActivatableSkill.js";
+import { CastingTime, SlowSkillNonModifiableCastingTime } from "../_ActivatableSkillCastingTime.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { TargetCategory } from "../_ActivatableSkillTargetCategory.js";
+import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PropertyReference } from "../_SimpleReferences.js";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Zibilja Ritual
+ */
+export type ZibiljaRitual = {
+    /**
+     * The zibilja ritual'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 zibilja ritual.
+     */
+    parameters: ZibiljaRitualPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory;
+    /**
+     * The associated property.
+     */
+    property: PropertyReference;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ZibiljaRitualTranslation>;
+};
+export type ZibiljaRitualTranslation = {
+    /**
+     * The name of the zibilja ritual.
+     */
+    name: 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 type ZibiljaRitualPerformanceParameters = OneTimePerformanceParameters<CastingTime<SlowSkillNonModifiableCastingTime>>;
+export declare const config: TypeConfig<ZibiljaRitual>;

package/lib/types/magicalActions/ZibiljaRitual.js

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