optolith-database-schema 0.1.4 → 0.1.7

package/lib/types/_Activatable.d.ts

@@ -2,9 +2,12 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
-import { Duration } from "./_ActivatableSkill";
-import { Identifier } from "./_Identifier";
-import { Prerequisite } from "./_Prerequisite";
+import { DisplayOption } from "./prerequisites/DisplayOption.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+import { Duration } from "./_ActivatableSkill.js";
+import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, MagicalTraditionIdentifier, PatronIdentifier, VolumePointsOptionReferenceIdentifier } from "./_Identifier.js";
+import { GeneralPrerequisites } from "./_Prerequisite.js";
 /**
  * The activatable entry's identifier. An unique, increasing integer.
  * @integer
@@ -43,9 +46,573 @@ export declare type Levels = number;
  */
 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 Options = "";
+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.
+ */
+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
@@ -284,7 +851,7 @@ export declare type Penalty = {
      * The identifier of the combat-related special ability of which the level
      * defines the penalty instead.
      */
-    external_id?: Identifier.Group.CombatRelatedSpecialAbility;
+    external_id?: CombatRelatedSpecialAbilityIdentifier;
 } | {
     tag: "ByAttack";
     /**
@@ -737,7 +1304,7 @@ export declare type VolumeMapOption = {
         /**
          * The option's identifier.
          */
-        id: Identifier.Group.VolumePointsOptionReference;
+        id: VolumePointsOptionReferenceIdentifier;
     }[];
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
@@ -920,7 +1487,7 @@ export declare type AdvancedSpecialAbility = {
      * advanced special ability; others are disallowed.
      * @minItems 1
      */
-    option: Identifier.Group.AdvancedSpecialAbilityRestrictedOption[];
+    option: AdvancedSpecialAbilityRestrictedOptionIdentifier[];
 } | {
     tag: "OneOf";
     /**
@@ -944,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";
     /**
@@ -972,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.
@@ -983,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
@@ -1027,7 +1594,7 @@ export declare type ApplicableCombatTechniques = {
      * @minItems 1
      */
     list: {
-        id: Identifier.Group.CombatTechnique;
+        id: CombatTechniqueIdentifier;
         /**
          * @minItems 1
          */
@@ -1056,7 +1623,7 @@ export declare type ApplicableAllCombatTechniquesRestriction = {
      * @minItems 1
      * @uniqueItems
      */
-    list: Identifier.Group.CombatTechnique[];
+    list: CombatTechniqueIdentifier[];
 };
 export declare type ApplicableCloseCombatTechniquesRestriction = {
     tag: "Improvised";
@@ -1206,3 +1773,4 @@ export declare type AdventurePointsValue = {
  * @minimum 0
  */
 export declare type AdventurePointsSingleValue = number;
+export {};