optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/specialAbility/LycantropicGift.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Lycantropic Gift
@@ -18,18 +19,13 @@ export declare type LycantropicGift = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<LycantropicGiftTranslation>;
+};
+export declare type LycantropicGiftTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<LycantropicGift>;

package/lib/types/specialAbility/MagicStyleSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Magic Style Special Ability
@@ -21,18 +22,13 @@ export declare type MagicStyleSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<MagicStyleSpecialAbilityTranslation>;
+};
+export declare type MagicStyleSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicStyleSpecialAbility>;

package/lib/types/specialAbility/MagicalSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Magical Special Ability
@@ -20,18 +21,13 @@ export declare type MagicalSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<MagicalSpecialAbilityTranslation>;
+};
+export declare type MagicalSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalSpecialAbility>;

package/lib/types/specialAbility/MagicalTradition.d.ts

@@ -5,7 +5,10 @@ import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { Influence } from "../_Influence.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { MagicalTraditionReference } from "../_SimpleReferences.js";
+import { SpecialRule } from "./_Tradition.js";
 /**
  * @title Magical Tradition
  */
@@ -19,20 +22,7 @@ export declare type MagicalTradition = {
      * The tradition's primary attribute. Leave empty if the tradition does not
      * have one.
      */
-    primary?: {
-        /**
-         * The attribute's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-        /**
-         * Typically, the value of the primary attribute (if one exists) is added
-         * onto the base of 20 AE to get the actual AE. But sometimes, only half the
-         * value is added.
-         */
-        use_half_for_arcane_energy: boolean;
-    };
+    primary?: PrimaryAttribute;
     /**
      * Can a member of the tradition learn cantrips?
      */
@@ -76,14 +66,7 @@ export declare type MagicalTradition = {
      * If arcane spellworks from a different tradition count as arcane spellworks
      * of this tradition, this is the different tradition's reference.
      */
-    use_arcane_spellworks_from_tradition: {
-        /**
-         * The magical tradition's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    };
+    use_arcane_spellworks_from_tradition: MagicalTraditionReference;
     /**
      * The Influences for the traditions. Influences are enabled by Focus Rules.
      * @minItems 2
@@ -94,41 +77,38 @@ export declare type MagicalTradition = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
-     */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            /**
-             * The name used for the traditions list of arcane spellworks if it is
-             * different than the `name` of the special ability.
-             * @minLength 1
-             */
-            name_for_arcane_spellworks?: string;
-            name_in_library?: Activatable.NameInLibrary;
-            /**
-             * The special rules of the tradition. They should be sorted like they are
-             * in the book.
-             * @minItems 1
-             */
-            special_rules: {
-                /**
-                 * An optional label that is displayed and placed before the actual
-                 * text.
-                 * @minLength 1
-                 */
-                label?: string;
-                /**
-                 * The text of a special rule.
-                 * @minLength 1
-                 */
-                text: string;
-            }[];
-            errata?: Errata;
-        };
-    };
+     */
+    translations: LocaleMap<MagicalTraditionTranslation>;
+};
+export declare type PrimaryAttribute = {
+    /**
+     * The attribute's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Typically, the value of the primary attribute (if one exists) is added
+     * onto the base of 20 AE to get the actual AE. But sometimes, only half the
+     * value is added.
+     */
+    use_half_for_arcane_energy: boolean;
+};
+export declare type MagicalTraditionTranslation = {
+    name: Activatable.Name;
+    /**
+     * The name used for the traditions list of arcane spellworks if it is
+     * different than the `name` of the special ability.
+     * @minLength 1
+     */
+    name_for_arcane_spellworks?: string;
+    name_in_library?: Activatable.NameInLibrary;
+    /**
+     * The special rules of the tradition. They should be sorted like they are
+     * in the book.
+     * @minItems 1
+     */
+    special_rules: SpecialRule[];
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalTradition>;

package/lib/types/specialAbility/PactGift.d.ts

@@ -5,6 +5,7 @@ import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { ActivatableIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Pact Gift
@@ -14,78 +15,90 @@ export declare type PactGift = {
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
     maximum?: Activatable.Maximum;
-    permanent_demonic_consumption?: {
-        tag: "Fixed";
-        /**
-         * The levels of *Demonic Consumption* the pact gift causes.
-         * @integer
-         * @minimum 1
-         * @maximum 4
-         */
-        levels: number;
-    } | {
-        tag: "PerLevel";
-        /**
-         * The levels of *Demonic Consumption* the pact gift causes per activated
-         * level of the pact gift.
-         * @integer
-         * @minimum 1
-         * @maximum 4
-         */
-        levels: number;
-    };
+    permanent_demonic_consumption?: PactGiftPermanentDemonicConsumption;
     /**
      * This pact gift has direct influence on the existence of other entries. It
      * may add or remove entries.
      * @minItems 1
      */
-    automatic_entries?: {
-        /**
-         * What type of action is applied to the target entry?
-         */
-        action: {
-            tag: "Add";
-        } | {
-            tag: "Remove";
-        };
-        /**
-         * If an entry is added or removed, does is cost or grant adventure points
-         * or is it free of charge?
-         */
-        apply_ap_value: boolean;
-        /**
-         * The entry that is to be added or removed. It can be a fixed entry or a
-         * selection where the player must choose one entry.
-         */
-        target: {
-            tag: "Selection";
-            list: {
-                tag: "MagicalTraditions";
-            } | {
-                tag: "MagicalDilettanteTraditions";
-            };
-        } | {
-            tag: "Fixed";
-            id: ActivatableIdentifier;
-        };
-    }[];
+    automatic_entries?: AutomaticEntry[];
     prerequisites?: GeneralPrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<PactGiftTranslation>;
+};
+export declare type PactGiftPermanentDemonicConsumption = {
+    tag: "Fixed";
+    fixed: FixedPactGiftPermanentDemonicConsumption;
+} | {
+    tag: "PerLevel";
+    per_level: PactGiftPermanentDemonicConsumptionPerLevel;
+};
+export declare type FixedPactGiftPermanentDemonicConsumption = {
+    /**
+     * The levels of *Demonic Consumption* the pact gift causes.
+     * @integer
+     * @minimum 1
+     * @maximum 4
+     */
+    levels: number;
+};
+export declare type PactGiftPermanentDemonicConsumptionPerLevel = {
+    /**
+     * The levels of *Demonic Consumption* the pact gift causes per activated
+     * level of the pact gift.
+     * @integer
+     * @minimum 1
+     * @maximum 4
+     */
+    levels: number;
+};
+export declare type AutomaticEntry = {
+    /**
+     * What type of action is applied to the target entry?
+     */
+    action: AutomaticEntryAction;
+    /**
+     * If an entry is added or removed, does is cost or grant adventure points
+     * or is it free of charge?
+     */
+    apply_ap_value: boolean;
+    /**
+     * The entry that is to be added or removed. It can be a fixed entry or a
+     * selection where the player must choose one entry.
+     */
+    target: AutomaticEntryTarget;
+};
+export declare type AutomaticEntryAction = {
+    tag: "Add";
+} | {
+    tag: "Remove";
+};
+export declare type AutomaticEntryTarget = {
+    tag: "Selection";
+    selection: AutomaticEntryTargetSelection;
+} | {
+    tag: "Fixed";
+    fixed: FixedAutomaticEntryTarget;
+};
+export declare type AutomaticEntryTargetSelection = {
+    list: AutomaticEntryTargetSelectionList;
+};
+export declare type AutomaticEntryTargetSelectionList = {
+    tag: "MagicalTraditions";
+} | {
+    tag: "MagicalDilettanteTraditions";
+};
+export declare type FixedAutomaticEntryTarget = {
+    id: ActivatableIdentifier;
+};
+export declare type PactGiftTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<PactGift>;

package/lib/types/specialAbility/ProtectiveWardingCircleSpecialAbility.d.ts

@@ -4,6 +4,8 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown } from "../_NonEmptyString.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Protective Warding Circle Special Ability
@@ -18,29 +20,20 @@ export declare type ProtectiveWardingCircleSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            /**
-             * The rules for the protective circle variant.
-             * @markdown
-             * @minLength 1
-             */
-            protective_circle: string;
-            /**
-             * The rules for the warding circle variant.
-             * @markdown
-             * @minLength 1
-             */
-            warding_circle: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ProtectiveWardingCircleSpecialAbilityTranslation>;
+};
+export declare type ProtectiveWardingCircleSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    /**
+     * The rules for the protective circle variant.
+     */
+    protective_circle: NonEmptyMarkdown;
+    /**
+     * The rules for the warding circle variant.
+     */
+    warding_circle: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ProtectiveWardingCircleSpecialAbility>;

package/lib/types/specialAbility/Sermon.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Sermon
@@ -18,18 +19,13 @@ export declare type Sermon = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<SermonTranslation>;
+};
+export declare type SermonTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Sermon>;

package/lib/types/specialAbility/SexSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Sex Special Ability
@@ -20,18 +21,13 @@ export declare type SexSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<SexSpecialAbilityTranslation>;
+};
+export declare type SexSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<SexSpecialAbility>;

package/lib/types/specialAbility/SikaryanDrainSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Sikaryan Drain Special Ability
@@ -18,18 +19,13 @@ export declare type SikaryanDrainSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<SikaryanDrainSpecialAbilityTranslation>;
+};
+export declare type SikaryanDrainSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<SikaryanDrainSpecialAbility>;

package/lib/types/specialAbility/SkillStyleSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Skill Style Special Ability
@@ -19,18 +20,13 @@ export declare type SkillStyleSpecialAbility = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<SkillStyleSpecialAbilityTranslation>;
+};
+export declare type SkillStyleSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<SkillStyleSpecialAbility>;

package/lib/types/specialAbility/VampiricGift.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Vampiric Gift
@@ -18,18 +19,13 @@ export declare type VampiricGift = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<VampiricGiftTranslation>;
+};
+export declare type VampiricGiftTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<VampiricGift>;

package/lib/types/specialAbility/Vision.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Vision
@@ -18,18 +19,13 @@ export declare type Vision = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<VisionTranslation>;
+};
+export declare type VisionTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Vision>;

package/lib/types/specialAbility/_Tradition.d.ts

@@ -0,0 +1,12 @@
+import { NonEmptyString } from "../_NonEmptyString.js";
+export declare type SpecialRule = {
+    /**
+     * An optional label that is displayed and placed before the actual
+     * text.
+     */
+    label?: NonEmptyString;
+    /**
+     * The text of a special rule.
+     */
+    text: NonEmptyString;
+};

package/lib/types/specialAbility/_Tradition.js

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