optolith-database-schema 0.1.3 → 0.1.6

package/lib/types/_Activatable.d.ts

@@ -2,8 +2,12 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
-import { Identifier } from "./_Identifier";
-import { Prerequisite } from "./_Prerequisite";
+import { DisplayOption } from "./prerequisites/DisplayOption";
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration } from "./_ActivatableSkill";
+import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, MagicalTraditionIdentifier, PatronIdentifier, VolumePointsOptionReferenceIdentifier } from "./_Identifier";
+import { GeneralPrerequisites } from "./_Prerequisite";
 /**
  * The activatable entry's identifier. An unique, increasing integer.
  * @integer
@@ -28,13 +32,587 @@ export declare type NameInLibrary = string;
  */
 export declare type Levels = number;
 /**
+ * The number stating how often you can buy the entry. The **default** depends on
+ * the entry type:
  *
+ * - **Advantage:** `1` in all cases (as specified in the **Core Rules**)
+ * - **Disadvantage:** `1` in all cases (as specified in the **Core Rules**)
+ * - **Special Abilities:** `1` if no options can be selected, otherwise the
+ *   number of possible options
+ *
+ * The maximum is only set if it differs from the defaults specified above.
+ * @integer
+ * @minimum 1
  */
-export declare type Maximum = "";
+export declare type Maximum = number;
 /**
+ * Definitions for possible options for the activatable entry. They can either
+ * be derived from entry categories or be defined explicitly. Both can happen as
+ * well, but if there is an explicitly defined select option and a derived
+ * select option has the same identifier (which may only happen if skill or
+ * combat technique identifiers are used for explicit select options), the
+ * explicit definition overwrites the derived option.
  *
+ * Note that this is only a full definition of options for simple logic that can
+ * be made explicit using the more detailed configuration for both derived
+ * categories and explicit options. There are quite a few entries whose option
+ * logic cannot be fully represented here, so that it needs to be implemented
+ * manually.
+ * @minProperties 1
+ */
+export declare type SelectOptions = {
+    /**
+     * A list of categories with optional further configuration. All available
+     * entries from the specified categories will be included as separate select
+     * options. You can also specify a set of groups that should only be
+     * included. Groups not mentioned will be excluded then.
+     * @minItems 1
+     */
+    derived?: CategoryOption[];
+    /**
+     * A list of explicit select options. If the identifier has a specific type,
+     * its entry is the base of this select option, where values defined here
+     * override values from the base. Define the `src` property if the options
+     * are not derived from the rules text of the advantage/disadvantage/special
+     * ability but instead are listed in a separate block and/or on a separate
+     * page.
+     * @minItems 1
+     */
+    explicit?: ExplicitOption[];
+};
+declare type CategoryOption = {
+    tag: "Blessings";
+} | {
+    tag: "Cantrips";
+} | {
+    tag: "TradeSecrets";
+} | {
+    tag: "Scripts";
+} | {
+    tag: "AnimalShapes";
+} | {
+    tag: "ArcaneBardTraditions";
+} | {
+    tag: "ArcaneDancerTraditions";
+} | {
+    tag: "SexPractices";
+} | {
+    tag: "Races";
+} | {
+    tag: "Cultures";
+} | {
+    tag: "BlessedTraditions";
+    /**
+     * Should the principles (code) of the tradition be required to select the
+     * respective tradition?
+     */
+    require_principles?: true;
+} | {
+    tag: "Elements";
+    /**
+     * Only include entries with the listed identifiers.
+     * @minItems 1
+     * @uniqueItems
+     */
+    specific?: {
+        /**
+         * The element's identifier.
+         * @integer
+         * @minimum 1
+         * @maximum 6
+         */
+        id: number;
+    }[];
+} | {
+    tag: "Properties";
+    /**
+     * Does each property require it's corresponding property knowledge?
+     */
+    require_knowledge?: true;
+    /**
+     * Require a minimum number of spellworks of the respective property to be
+     * on a minimum skill rating.
+     */
+    require_minimum_spellworks_on?: {
+        /**
+         * The minimum number of spellworks that need to be on the defined minimum
+         * skill rating.
+         * @integer
+         * @minimum 1
+         */
+        number: number;
+        /**
+         * The minimum skill rating the defined minimum number of spellworks need
+         * to be on.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+} | {
+    tag: "Aspects";
+    /**
+     * Does each aspect require it's corresponding aspect knowledge?
+     */
+    require_knowledge?: true;
+    /**
+     * The generated name should be the *Master of (Aspect)* suffix for this
+     * aspect instead of the aspect's name. If an aspect does not provide a
+     * suffix (such as the General aspect), it is automatically excluded from
+     * the list.
+     */
+    use_master_of_suffix_as_name?: true;
+    /**
+     * Require a minimum number of liturgies of the respective aspect to be on a
+     * minimum skill rating.
+     */
+    require_minimum_liturgies_on?: {
+        /**
+         * The minimum number of liturgies that need to be on the defined minimum
+         * skill rating.
+         * @integer
+         * @minimum 1
+         */
+        number: number;
+        /**
+         * The minimum skill rating the defined minimum number of liturgies need
+         * to be on.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+} | {
+    tag: "Diseases";
+    /**
+     * Only convert half the disease level into the AP value.
+     */
+    use_half_level_as_ap_value?: true;
+} | {
+    tag: "Poisons";
+    /**
+     * Only convert half the poison level into the AP value.
+     */
+    use_half_level_as_ap_value?: true;
+} | {
+    tag: "Languages";
+    /**
+     * Generate prerequisites for each entry of the category.
+     * @minItems 1
+     */
+    prerequisites?: OptionOptionPrerequisite[];
+} | {
+    tag: "Skills";
+    /**
+     * Only include entries of the specified groups.
+     * @minItems 1
+     */
+    groups?: {
+        /**
+         * The skill group's identifier.
+         * @integer
+         * @minimum 1
+         * @maximum 5
+         */
+        id: number;
+    }[];
+    /**
+     * Only include (`Intersection`) or exclude (`Difference`) specific skills.
+     */
+    specific?: {
+        operation: {
+            tag: "Intersection";
+        } | {
+            tag: "Difference";
+        };
+        /**
+         * The list of specific skills.
+         * @minItems 1
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The skill's identifier.
+             * @integer
+             * @minimum 1
+             * @maximum 59
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * Registers new applications, which get enabled once this entry is
+     * activated with its respective select option. It specifies an entry-unique
+     * identifier, the skill it belongs to is derived from the select option
+     * automatically. A translation can be left out if its name equals the name
+     * of the origin entry.
+     * @minItems 1
+     */
+    skill_applications?: {
+        /**
+         * The application's identifier. An entry-unique, increasing integer.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * The name of the application if different from the activatable entry's
+                 * name.
+                 * @minLength 1
+                 */
+                name: string;
+            };
+        };
+    }[];
+    /**
+     * Registers uses, which get enabled once this entry is activated with its
+     * respective select option. It specifies an entry-unique identifier, the
+     * skill it belongs to is derived from the select option automatically. A
+     * translation can be left out if its name equals the name of the origin
+     * entry.
+     * @minItems 1
+     */
+    skill_uses?: {
+        /**
+         * The use's identifier. An entry-unique, increasing integer.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * The name of the use if different from the activatable entry's name.
+                 * @minLength 1
+                 */
+                name: string;
+            };
+        };
+    }[];
+    /**
+     * Generate prerequisites for each entry of the category.
+     * @minItems 1
+     */
+    prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+    /**
+     * Generate AP values for each entry.
+     */
+    ap_value?: OptionSkillDeriveAdventurePointsValue;
+} | {
+    tag: NonSkillSkillCategory;
+    /**
+     * Only include (`Intersection`) or exclude (`Difference`) specific entries.
+     */
+    specific?: {
+        operation: {
+            tag: "Intersection";
+        } | {
+            tag: "Difference";
+        };
+        /**
+         * The list of specific entries.
+         * @minItems 1
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The entry's identifier.
+             * @integer
+             * @minimum 1
+             * @maximum 59
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * Generate prerequisites for each entry of the category.
+     * @minItems 1
+     */
+    prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+    /**
+     * Generate AP values for each entry.
+     */
+    ap_value?: OptionSkillDeriveAdventurePointsValue;
+};
+declare enum NonSkillSkillCategory {
+    CloseCombatTechniques = "CloseCombatTechniques",
+    RangedCombatTechniques = "RangedCombatTechniques",
+    LiturgicalChants = "LiturgicalChants",
+    Ceremonies = "Ceremonies",
+    Spells = "Spells",
+    Rituals = "Rituals"
+}
+declare type OptionSkillSelfPrerequisite = {
+    tag: "Self";
+    /**
+     * The entry requires itself on a certain Skill Rating.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+/**
+ * The entry requires or prohibits itself as a select option of another entry.
+ */
+declare type OptionOptionPrerequisite = {
+    tag: "SelectOption";
+    /**
+     * The target entry's identifier.
+     */
+    id: ActivatableIdentifier;
+    /**
+     * Is the select option required (`true`) or prohibited (`false`)?
+     */
+    active: boolean;
+    /**
+     * The required level, if any.
+     * @integer
+     * @minimum 2
+     */
+    level?: number;
+};
+/**
+ * Generate AP values for each entry.
  */
-export declare type Options = "";
+declare type OptionSkillDeriveAdventurePointsValue = {
+    tag: "DerivedFromImprovementCost";
+    /**
+     * This number is multiplied with the improvement cost of the entry
+     * (A = 1 to D = 4).
+     * @integer
+     * @minimum 2
+     */
+    multiplier?: number;
+} | {
+    tag: "Fixed";
+    /**
+     * A mapping of skill identifiers to their specific AP values.
+     */
+    map: {
+        /**
+         * The skill's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * The AP value for the specified entry.
+         * @integer
+         * @minimum 1
+         */
+        ap_value: number;
+    }[];
+    /**
+     * The default value of an entry. Used as a fallback if no value is
+     * found in `list`.
+     * @integer
+     * @minimum 1
+     */
+    default: number;
+};
+declare type ExplicitOption = {
+    tag: "General";
+    /**
+     * The option's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Sometimes, professions use specific text selections that are not
+     * contained in described lists. This ensures you can use them for
+     * professions only. They are not going to be displayed as options to the
+     * user.
+     */
+    profession_only?: true;
+    /**
+     * Registers new applications, which get enabled once this entry is
+     * activated with its respective select option. It specifies an entry-unique
+     * identifier and the skill it belongs to. A translation can be left out if
+     * its name equals the name of the origin select option.
+     */
+    skill_applications?: SkillApplications;
+    /**
+     * Registers uses, which get enabled once this entry is activated with its
+     * respective select option. It specifies an entry-unique identifier and the
+     * skill it belongs to. A translation can be left out if its name equals the
+     * name of the origin select option.
+     */
+    skill_uses?: SkillUses;
+    prerequisites?: GeneralPrerequisites;
+    /**
+     * Specific AP cost for the select option.
+     * @integer
+     * @minimum 1
+     */
+    ap_value?: number;
+    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]: {
+            /**
+             * The name of the select option.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The name of the select option when displayed in a generated
+             * profession text.
+             * @minLength 1
+             */
+            name_in_profession?: string;
+            /**
+             * The description of the select option. Useful for Bad Habits, Trade
+             * Secrets and other entries where a description is available.
+             * @markdown
+             * @minLength 1
+             */
+            description?: string;
+            errata?: Errata;
+        };
+    };
+} | {
+    tag: "Skill";
+    /**
+     * The skill's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Registers new applications, which get enabled once this entry is
+     * activated with its respective select option. It specifies an entry-unique
+     * identifier and the skill it belongs to. A translation can be left out if
+     * its name equals the name of the origin select option.
+     * @minItems 1
+     */
+    skill_applications?: {
+        /**
+         * The application's identifier. An entry-unique, increasing integer.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * The name of the application if different from the activatable entry's
+                 * name.
+                 * @minLength 1
+                 */
+                name: string;
+            };
+        };
+    }[];
+    /**
+     * Registers uses, which get enabled once this entry is activated with its
+     * respective select option. It specifies an entry-unique identifier and the
+     * skill it belongs to. A translation can be left out if its name equals the
+     * name of the origin select option.
+     * @minItems 1
+     */
+    skill_uses?: {
+        /**
+         * The use's identifier. An entry-unique, increasing integer.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * The name of the use if different from the activatable entry's name.
+                 * @minLength 1
+                 */
+                name: string;
+            };
+        };
+    }[];
+    prerequisites?: GeneralPrerequisites;
+    /**
+     * Specific AP cost for the select option.
+     * @integer
+     * @minimum 1
+     */
+    ap_value?: number;
+    src?: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minProperties 1
+         */
+        [localeId: string]: {
+            errata?: Errata;
+        };
+    };
+} | {
+    tag: "CombatTechnique";
+    /**
+     * The combat technique's identifier.
+     */
+    id: CombatTechniqueIdentifier;
+    prerequisites?: GeneralPrerequisites;
+    /**
+     * Specific AP cost for the select option.
+     * @integer
+     * @minimum 1
+     */
+    ap_value?: number;
+    src?: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minProperties 1
+         */
+        [localeId: string]: {
+            errata?: Errata;
+        };
+    };
+};
 /**
  * The rule text.
  * @markdown
@@ -58,21 +636,86 @@ export declare type CombatSpecialAbilityType = {
     tag: "SpecialManeuver";
 };
 /**
- * Registers new skill applications, which get enabled once this entry is
- * activated. It specifies an entry-unique identifier and the skill it belongs
- * to. A translation can be left out if its name equals the name of the origin
- * activatable entry.
+ * Registers new skill applications, which get enabled once this entry is
+ * activated. It specifies an entry-unique identifier and the skill it belongs
+ * to. A translation can be left out if its name equals the name of the origin
+ * activatable entry.
+ * @minItems 1
+ */
+export declare type SkillApplications = {
+    /**
+     * The application's identifier. An entry-unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill(s) this application belongs to.
+     */
+    skill: {
+        tag: "Single";
+        /**
+         * The referenced skill's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    } | {
+        tag: "Multiple";
+        /**
+         * The skills this application belongs to.
+         * @minItems 2
+         */
+        list: {
+            /**
+             * The referenced skill's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+        /**
+         * If an application applies to multiple skills, it may need to ensure the
+         * respective skill is on a certain skill rating if the activatable entry
+         * cannot ensure this prerequisite.
+         * @integer
+         * @minimum 1
+         */
+        required_skill_rating?: number;
+    };
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the application if different from the activatable entry's
+             * name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+}[];
+/**
+ * Registers uses, which get enabled once this entry is activated. It specifies
+ * an entry-unique identifier and the skill it belongs to. A translation can be
+ * left out if its name equals the name of the origin activatable entry.
  * @minItems 1
  */
-export declare type SkillApplications = {
+export declare type SkillUses = {
     /**
-     * The application's identifier. An entry-unique, increasing integer.
+     * The use's identifier. An entry-unique, increasing integer.
      * @integer
      * @minimum 1
      */
     id: number;
     /**
-     * The skill(s) this application belongs to.
+     * The skill(s) this use belongs to.
      */
     skill: {
         tag: "Single";
@@ -85,7 +728,7 @@ export declare type SkillApplications = {
     } | {
         tag: "Multiple";
         /**
-         * The skills this application belongs to.
+         * The skills this use belongs to.
          * @minItems 2
          */
         list: {
@@ -96,228 +739,709 @@ export declare type SkillApplications = {
              */
             id: number;
         }[];
+    };
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the use if different from the activatable entry's name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+}[];
+/**
+ * The penalty the special ability gives when used.
+ */
+export declare type Penalty = {
+    tag: "Single";
+    /**
+     * The penalty value.
+     * @integer
+     */
+    value: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByHandedness";
+    /**
+     * The penalty value for one-handed weapons.
+     * @integer
+     */
+    one_handed: number;
+    /**
+     * The penalty value for two-handed weapons.
+     * @integer
+     */
+    two_handed: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByActivation";
+    /**
+     * The penalty value if the entry has been bought by the character.
+     * @integer
+     */
+    active: number;
+    /**
+     * The penalty value if the entry has not been bought by the character.
+     * @integer
+     */
+    inactive: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "Selection";
+    options: {
+        tag: "Specific";
+        /**
+         * The list of specific penalty options.
+         * @minItems 2
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The penalty value.
+             * @integer
+             */
+            value: number;
+        }[];
+    } | {
+        tag: "Range";
+        /**
+         * The minimum penalty value.
+         * @integer
+         */
+        minimum: number;
+        /**
+         * The maximum penalty value.
+         * @integer
+         */
+        maximum: number;
+    };
+} | {
+    tag: "ByLevel";
+    /**
+     * A continuous range of penalties for each level. The first element is the
+     * penalty for the first level, the second element is the penalty for the
+     * second level, and so on.
+     * @minItems 2
+     */
+    levels: {
+        /**
+         * The penalty value for this level.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The identifier of the combat-related special ability of which the level
+     * defines the penalty instead.
+     */
+    external_id?: CombatRelatedSpecialAbilityIdentifier;
+} | {
+    tag: "ByAttack";
+    /**
+     * A list of penalties for subsequent attacks. The first element is the
+     * penalty for the first attack, the second element is the penalty for the
+     * second attack, and so on. The order of the first element may be changed
+     * using `initial_order`, so that e.g. if set to `2`, the first element is
+     * the penalty for the second attack, the second element is the penalty for
+     * the third attack, and so on.
+     * @minItems 1
+     */
+    list: {
+        /**
+         * The penalty value for this order.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The order of the first element in the `list` of penalties.
+     */
+    initial_order?: number;
+    /**
+     * Set if a predefined different word should be used instead of the word
+     * `attack` for display purposes.
+     */
+    attack_replacement?: {
+        tag: "Throw";
+    };
+} | {
+    tag: "DependsOnHitZone";
+};
+export declare type EnchantmentCost = {
+    tag: "ArcaneEnergyCost";
+    ae_cost: ArcaneEnergyCost;
+} | {
+    tag: "BindingCost";
+    binding_cost: BindingCost;
+};
+/**
+ * The AE Cost.
+ */
+export declare type ArcaneEnergyCost = {
+    tag: "Fixed";
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * Set to `true` if the AE costs are permanent.
+     * @integer
+     * @minimum 1
+     */
+    is_permanent?: true;
+    /**
+     * Specified if the AE cost `value` has to be paid for each time interval.
+     */
+    interval?: Duration.UnitValue;
+    /**
+     * The AE cost are per level of the enchantment. It may either be displayed
+     * in a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1
+     * AE for level I; 2 AE for level II`).
+     */
+    per_level?: {
+        tag: "Compressed";
+    } | {
+        tag: "Verbose";
+    };
+    /**
+     * All translations for the entry, identified by IETF language tag
+     * (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minProperties 1
+         */
+        [localeId: string]: {
+            /**
+             * A note, appended to the generated string in parenthesis.
+             */
+            note?: {
+                /**
+                 * The full note.
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * A compressed note, if applicable. If not specified it should not
+                 * be displayed in small location.
+                 * @minLength 1
+                 */
+                compressed?: string;
+            };
+        };
+    };
+} | {
+    tag: "PerCountable";
+    /**
+     * The AE cost value that has to be per a specific countable entity.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * If defined, in addition to the cost per entity you have to pay a flat
+     * amount, regardless of the entity count.
+     * @integer
+     * @minimum 1
+     */
+    base_value?: number;
+    /**
+     * All translations for the entry, identified by IETF language tag
+     * (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minProperties 1
+         */
+        [localeId: string]: {
+            /**
+             * The cost have to be per a specific countable entity, e.g. `8 AE per
+             * person`.
+             */
+            per: {
+                /**
+                 * The full countable entity name.
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * The compressed countable entity name.
+                 * @minLength 1
+                 */
+                compressed: string;
+            };
+            /**
+             * A note, appended to the generated string in parenthesis.
+             */
+            note?: {
+                /**
+                 * The full note.
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * A compressed note, if applicable. If not specified it should not
+                 * be displayed in small location.
+                 * @minLength 1
+                 */
+                compressed?: string;
+            };
+        };
+    };
+} | {
+    tag: "ActivationAndHalfInterval";
+    /**
+     * The AE cost value that has to be payed for activation. Half of this value
+     * has to be payed each interval.
+     * @integer
+     * @minimum 2
+     * @multipleOf 2
+     */
+    value: number;
+    /**
+     * The time interval for which the AE cost `value` has to be paid.
+     */
+    interval: Duration.UnitValue;
+} | {
+    tag: "Indefinite";
+    /**
+     * The indefinite AE cost may be modified by a certain value.
+     */
+    modifier: {
         /**
-         * If an application applies to multiple skills, it may need to ensure the
-         * respective skill is on a certain skill rating if the activatable entry
-         * cannot ensure this prerequisite.
+         * The arithmetic how to apply the `value` to the indefinite base value.
+         */
+        arithmetic: {
+            tag: "Add";
+        } | {
+            tag: "Multiply";
+        };
+        /**
+         * The value that is applied to the indefinite base value using the
+         * defined `arithmetic`.
          * @integer
          * @minimum 1
          */
-        required_skill_rating?: number;
+        value: number;
     };
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
      * @minProperties 1
      */
-    translations?: {
+    translations: {
         /**
          * @patternProperties ^[a-z]{2}-[A-Z]{2}$
          */
         [localeId: string]: {
             /**
-             * The name of the application if different from the activatable entry's
-             * name.
-             * @minLength 1
+             * A description of where the cost come from.
              */
-            name: string;
+            description: {
+                /**
+                 * The full description of where the cost come from.
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * A compressed description of where the cost come from for use in
+                 * small areas (e.g. on character sheet).
+                 * @minLength 1
+                 */
+                compressed: string;
+            };
         };
     };
-}[];
-/**
- * Registers uses, which get enabled once this entry is activated. It specifies
- * an entry-unique identifier and the skill it belongs to. A translation can be
- * left out if its name equals the name of the origin activatable entry.
- * @minItems 1
- */
-export declare type SkillUses = {
+} | {
+    tag: "Disjunction";
     /**
-     * The use's identifier. An entry-unique, increasing integer.
-     * @integer
-     * @minimum 1
+     * Specified if the selected AE cost option has to be paid for each time
+     * interval.
      */
-    id: number;
+    interval?: {
+        /**
+         * The interval itself.
+         */
+        value: Duration.UnitValue;
+        /**
+         * The AE cost value for activation.
+         * @integer
+         * @minimum 1
+         */
+        activation_value: number;
+        /**
+         * Set to `true` if the action where the enchantment is casted does
+         * **not** as a part of the first interval that has to be payed, so that
+         * the first interval payment needs to be done after the activation.
+         *
+         * This works different than other sustained spells, since for them the
+         * end of the cast usually already counts as part of the first interval.
+         */
+        after_activation: boolean;
+    };
     /**
-     * The skill(s) this use belongs to.
+     * The possible AE cost values.
      */
-    skill: {
-        tag: "Single";
+    options: {
         /**
-         * The referenced skill's identifier.
+         * A possible AE cost value.
          * @integer
          * @minimum 1
          */
-        id: number;
-    } | {
-        tag: "Multiple";
+        value: number;
         /**
-         * The skills this use belongs to.
-         * @minItems 2
+         * All translations for the entry, identified by IETF language tag
+         * (BCP47).
+         * @minProperties 1
          */
-        list: {
+        translations?: {
             /**
-             * The referenced skill's identifier.
-             * @integer
-             * @minimum 1
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
              */
-            id: number;
-        }[];
-    };
+            [localeId: string]: {
+                /**
+                 * A note, appended to the generated option string in parenthesis.
+                 */
+                note?: {
+                    /**
+                     * The full note.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed note, if applicable. If not specified it should not
+                     * be displayed in small location.
+                     * @minLength 1
+                     */
+                    compressed?: string;
+                };
+            };
+        };
+    }[];
+} | {
+    tag: "None";
     /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
+     * All translations for the entry, identified by IETF language tag
+     * (BCP47).
      * @minProperties 1
      */
     translations?: {
         /**
          * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minProperties 1
          */
         [localeId: string]: {
             /**
-             * The name of the use if different from the activatable entry's name.
-             * @minLength 1
+             * A note, appended to the generated string in parenthesis.
              */
-            name: string;
+            note?: {
+                /**
+                 * The full note.
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * A compressed note, if applicable. If not specified it should not
+                 * be displayed in small location.
+                 * @minLength 1
+                 */
+                compressed?: string;
+            };
         };
     };
-}[];
+} | {
+    tag: "Variable";
+};
 /**
- * The penalty the special ability gives when used.
+ * The volume points the enchantment needs.
  */
-export declare type Penalty = {
-    tag: "Single";
+export declare type Volume = {
+    tag: "Fixed";
     /**
-     * The penalty value.
+     * The volume points.
      * @integer
+     * @minimum 0
      */
-    value: number;
+    points: number;
+} | {
+    tag: "PerLevel";
     /**
-     * Set to `true` if the penalty applies to the parry instead of the attack.
+     * The volume points per level.
+     * @integer
+     * @minimum 1
      */
-    applies_to_parry?: true;
+    points: number;
 } | {
-    tag: "ByHandedness";
+    tag: "ByLevel";
     /**
-     * The penalty value for one-handed weapons.
-     * @integer
+     * The volume points for each level. The first element is the volume points
+     * for the first level, the second element is the volume points for the
+     * second level, and so on.
+     * @minItems 2
      */
-    one_handed: number;
+    list: {
+        /**
+         * The volume points for this level.
+         * @integer
+         * @minimum 0
+         */
+        points: number;
+    }[];
+} | {
+    tag: "Map";
+    map: VolumeMap;
+};
+/**
+ * A content that is `3/4/5 Points for Chimera, Daimonid, Golems, Undead /
+ * Fairies, Ghosts / Demons, Elementals` may be respresented as the following
+ * map:
+ *
+ * ```yaml
+ * options:
+ *   - points: 3
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Chimera, Daimonid, Golems, Undead"
+ *         label_standalone: "Chimera/Daimonid/Golems/Undead"
+ *   - points: 4
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Fairies, Ghosts"
+ *         label_standalone: "Fairies/Ghosts"
+ *   - points: 5
+ *     associated_options:
+ *       - id:
+ *           tag: General
+ *           value: # ...
+ *       # ...
+ *     translations:
+ *       en-US:
+ *         label: "Demons, Elementals"
+ *         label_standalone: "Demons/Elementals"
+ * ```
+ *
+ * This will generate the exact same string as seen above. The associated
+ * options are not present in the example, but they link to the options the
+ * volume specification is meant for.
+ */
+export declare type VolumeMap = {
     /**
-     * The penalty value for two-handed weapons.
-     * @integer
+     * The possible costs and associated labels.
+     * @minItems 2
      */
-    two_handed: number;
+    options: VolumeMapOption[];
     /**
-     * Set to `true` if the penalty applies to the parry instead of the attack.
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
      */
-    applies_to_parry?: true;
-} | {
-    tag: "ByActivation";
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * Place a string between the `for` and the grouped map option labels.
+             */
+            list_prepend?: string;
+            /**
+             * Place a string after the grouped map option labels.
+             */
+            list_append?: string;
+            /**
+             * If the string from the book cannot be generated using the default
+             * generation technique, use this string. All options still need to be
+             * inserted propertly, since it may be used by in-game tools to provide a
+             * selection to players.
+             */
+            replacement?: string;
+        };
+    };
+};
+export declare type VolumeMapOption = {
     /**
-     * The penalty value if the entry has been bought by the character.
+     * The full permanent AE cost value for this option.
      * @integer
+     * @minimum 1
      */
-    active: number;
+    points: number;
     /**
-     * The penalty value if the entry has not been bought by the character.
-     * @integer
+     * Links to the options this volume specification is meant for.
      */
-    inactive: number;
+    associated_options: {
+        /**
+         * The option's identifier.
+         */
+        id: VolumePointsOptionReferenceIdentifier;
+    }[];
     /**
-     * Set to `true` if the penalty applies to the parry instead of the attack.
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
      */
-    applies_to_parry?: true;
-} | {
-    tag: "Selection";
-    options: {
-        tag: "Specific";
+    translations?: {
         /**
-         * The list of specific penalty options.
-         * @minItems 2
-         * @uniqueItems
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
          */
-        list: {
+        [localeId: string]: {
             /**
-             * The penalty value.
-             * @integer
+             * The description of the option for cost string generation.
+             * @minLength 1
              */
-            value: number;
-        }[];
-    } | {
-        tag: "Range";
-        /**
-         * The minimum penalty value.
-         * @integer
-         */
-        minimum: number;
-        /**
-         * The maximum penalty value.
-         * @integer
-         */
-        maximum: number;
+            label: string;
+            /**
+             * The description of the option if used standalone. Only used if
+             * different from `label`.
+             * @minLength 1
+             */
+            label_standalone?: string;
+        };
     };
-} | {
-    tag: "ByLevel";
+};
+/**
+ * The binding cost for an enchantment.
+ */
+export declare type BindingCost = {
+    tag: "Fixed";
     /**
-     * A continuous range of penalties for each level. The first element is the
-     * penalty for the first level, the second element is the penalty for the
-     * second level, and so on.
-     * @minItems 2
+     * The permanent AE cost.
+     * @integer
+     * @minimum 1
      */
-    levels: {
-        /**
-         * The penalty value for this level.
-         * @integer
-         */
-        value: number;
-    }[];
+    permanent_value: number;
+} | {
+    tag: "PerLevel";
     /**
-     * The identifier of the combat-related special ability of which the level
-     * defines the penalty instead.
+     * The permanent AE cost per level.
+     * @integer
+     * @minimum 1
      */
-    external_id?: Identifier.Group.CombatRelatedSpecialAbility;
+    permanent_value: number;
 } | {
-    tag: "ByAttack";
+    tag: "Map";
+    map: BindingCostMap;
+};
+/**
+ * A content that is `2/4/8 permanent AE for spell-swords with the combat
+ * technique Daggers, Swords, or Two-Handed Swords` may be respresented as the
+ * following map:
+ *
+ * ```yaml
+ * options:
+ *   - permanent_value: 2
+ *     translations:
+ *       en-US:
+ *         label: "Daggers"
+ *         label_standalone: "Dagger"
+ *   - permanent_value: 4
+ *     translations:
+ *       en-US:
+ *         label: "Swords"
+ *         label_standalone: "Sword"
+ *   - permanent_value: 8
+ *     translations:
+ *       en-US:
+ *         label: "Two-Handed Swords"
+ *         label_standalone: "Two-Handed Sword"
+ * list_prepend: "spell-swords with the combat technique"
+ * ```
+ *
+ * This will generate the exact same string as seen above.
+ */
+export declare type BindingCostMap = {
     /**
-     * A list of penalties for subsequent attacks. The first element is the
-     * penalty for the first attack, the second element is the penalty for the
-     * second attack, and so on. The order of the first element may be changed
-     * using `initial_order`, so that e.g. if set to `2`, the first element is
-     * the penalty for the second attack, the second element is the penalty for
-     * the third attack, and so on.
-     * @minItems 1
+     * The possible costs and associated labels.
+     * @minItems 2
      */
-    list: {
+    options: VolumeMapOption[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: {
         /**
-         * The penalty value for this order.
-         * @integer
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
          */
-        value: number;
-    }[];
+        [localeId: string]: {
+            /**
+             * Place a string between the `for` and the grouped map option labels.
+             */
+            list_prepend?: string;
+            /**
+             * Place a string after the grouped map option labels.
+             */
+            list_append?: string;
+            /**
+             * If the string from the book cannot be generated using the default
+             * generation technique, use this string. All options still need to be
+             * inserted propertly, since it may be used by in-game tools to provide a
+             * selection to players.
+             */
+            replacement?: string;
+        };
+    };
+};
+export declare type BindingCostMapOption = {
     /**
-     * The order of the first element in the `list` of penalties.
+     * The full permanent AE cost value for this option.
+     * @integer
+     * @minimum 1
      */
-    initial_order?: number;
+    permanent_value: number;
     /**
-     * Set if a predefined different word should be used instead of the word
-     * `attack` for display purposes.
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
      */
-    attack_replacement?: {
-        tag: "Throw";
+    translations?: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The description of the option for cost string generation.
+             * @minLength 1
+             */
+            label: string;
+            /**
+             * The description of the option if used standalone. Only used if
+             * different from `label`.
+             * @minLength 1
+             */
+            label_standalone?: string;
+        };
     };
-} | {
-    tag: "DependsOnHitZone";
 };
-/**
- * The AE Cost.
- */
-export declare type ArcaneEnergyCost = "";
-/**
- * The volume points the enchantment needs.
- */
-export declare type Volume = "";
-/**
- * The binding cost for an enchantment.
- */
-export declare type BindingCost = "";
 /**
  * The magic property's identifier. `DependingOnProperty` can only be used if
  * the special ability has an option to select a property.
@@ -363,7 +1487,7 @@ export declare type AdvancedSpecialAbility = {
      * advanced special ability; others are disallowed.
      * @minItems 1
      */
-    option: Identifier.Group.AdvancedSpecialAbilityRestrictedOption[];
+    option: AdvancedSpecialAbilityRestrictedOptionIdentifier[];
 } | {
     tag: "OneOf";
     /**
@@ -387,8 +1511,8 @@ export declare type AdvancedSpecialAbility = {
      * advanced special ability; others are disallowed.
      * @minItems 1
      */
-    option: Identifier.Group.AdvancedSpecialAbilityRestrictedOption[];
-    display_option?: Prerequisite.Single.DisplayOption.T;
+    option: AdvancedSpecialAbilityRestrictedOptionIdentifier[];
+    display_option?: DisplayOption;
 } | {
     tag: "DeriveFromExternalOption";
     /**
@@ -415,7 +1539,7 @@ export declare type AdvancedSpecialAbility = {
             id: number;
         };
     }[];
-    display_option?: Prerequisite.Single.DisplayOption.T;
+    display_option?: DisplayOption;
     /**
      * Do have to choose on when buying the special ability? Otherwise the
      * decision can be made later.
@@ -426,10 +1550,10 @@ export declare type AdvancedSpecialAbility = {
      * advanced special ability; others are disallowed.
      * @minItems 1
      */
-    option: Identifier.Group.AdvancedSpecialAbilityRestrictedOption[];
+    option: AdvancedSpecialAbilityRestrictedOptionIdentifier[];
 };
-export declare type AdvancedSpecialAbilityDerivedExternalEntryId = Identifier.Tagged<"MagicalTradition">;
-export declare type AdvancedSpecialAbilityDerivedExternalEntryOptionId = Identifier.Tagged<"Patron">;
+export declare type AdvancedSpecialAbilityDerivedExternalEntryId = MagicalTraditionIdentifier;
+export declare type AdvancedSpecialAbilityDerivedExternalEntryOptionId = PatronIdentifier;
 /**
  * The Advanced Special Abilities for the respective Style Special Ability.
  * Sometimes, only a specific select option or a set of select options of an
@@ -470,7 +1594,7 @@ export declare type ApplicableCombatTechniques = {
      * @minItems 1
      */
     list: {
-        id: Identifier.Group.CombatTechnique;
+        id: CombatTechniqueIdentifier;
         /**
          * @minItems 1
          */
@@ -499,7 +1623,7 @@ export declare type ApplicableAllCombatTechniquesRestriction = {
      * @minItems 1
      * @uniqueItems
      */
-    list: Identifier.Group.CombatTechnique[];
+    list: CombatTechniqueIdentifier[];
 };
 export declare type ApplicableCloseCombatTechniquesRestriction = {
     tag: "Improvised";
@@ -649,3 +1773,4 @@ export declare type AdventurePointsValue = {
  * @minimum 0
  */
 export declare type AdventurePointsSingleValue = number;
+export {};