optolith-database-schema 0.26.0 → 0.26.1

package/gen/types.d.ts

@@ -377,6 +377,9 @@ export type SelectOptionCategory =
   | {
     kind: "RacesAndCultures"
   }
+  | {
+    kind: "HomunculusTypes"
+  }
   | {
     kind: "BlessedTraditions"
     BlessedTraditions: BlessedTraditionsSelectOptionCategory
@@ -5800,6 +5803,11 @@ export interface AdventurePointsDerivedFromSelection {
 }
 
 export interface AdventurePointsDerivedFromSelectionTranslation {
+  /**
+   * Place a string between the `for` and the grouped option names.
+   */
+  listPrepend?: string
+
   /**
    * A replacement for the generated text if it would not match the original one.
    */
@@ -6863,6 +6871,13 @@ export interface TradeSecret {
    */
   select_options?: TradeSecretSelectOptions
 
+  /**
+   * Explicit definitions for possible options for the activatable entry.
+   * 
+   * 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.
+   */
+  explicit_select_options: GeneralSelectOption_ID[]
+
   /**
    * The trade secret’s adventure point value
    */
@@ -6899,6 +6914,11 @@ export interface TradeSecretTranslation {
    */
   name: string
 
+  /**
+   * The full name of the entry as stated in the sources. Only use when `name` needs to be different from full name for text generation purposes.
+   */
+  name_in_library?: string
+
   /**
    * The description of the trade secret.
    */
@@ -6914,99 +6934,375 @@ export interface TradeSecretTranslation {
  */
 export interface TradeSecretSelectOptions {
   /**
-   * 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.
+   * An entry category 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.
    */
-  explicit?: ExplicitSelectOption[]
+  derived?: TradeSecretSelectOptionCategory
 }
 
-export type ExplicitSelectOption =
+export type TradeSecretSelectOptionCategory =
   | {
-    kind: "General"
-    General: GeneralSelectOption_ID
+    kind: "Blessings"
   }
   | {
-    kind: "Skill"
-    Skill: ExplicitSkillSelectOption
+    kind: "Cantrips"
   }
   | {
-    kind: "CombatTechnique"
-    CombatTechnique: ExplicitCombatTechniqueSelectOption
+    kind: "Scripts"
+  }
+  | {
+    kind: "AnimalShapes"
+  }
+  | {
+    kind: "ArcaneBardTraditions"
+  }
+  | {
+    kind: "ArcaneDancerTraditions"
+  }
+  | {
+    kind: "SexPractices"
+  }
+  | {
+    kind: "Races"
+  }
+  | {
+    kind: "Cultures"
+  }
+  | {
+    kind: "RacesAndCultures"
+  }
+  | {
+    kind: "HomunculusTypes"
+  }
+  | {
+    kind: "BlessedTraditions"
+    BlessedTraditions: BlessedTraditionsSelectOptionCategory
+  }
+  | {
+    kind: "Elements"
+    Elements: ElementsSelectOptionCategory
+  }
+  | {
+    kind: "Properties"
+    Properties: PropertiesSelectOptionCategory
+  }
+  | {
+    kind: "Aspects"
+    Aspects: AspectSelectOptionCategory
+  }
+  | {
+    kind: "Diseases"
+    Diseases: DiseasesPoisonsSelectOptionCategory
+  }
+  | {
+    kind: "Poisons"
+    Poisons: DiseasesPoisonsSelectOptionCategory
+  }
+  | {
+    kind: "Languages"
+    Languages: LanguagesSelectOptionCategory
+  }
+  | {
+    kind: "Skills"
+    Skills: SkillsSelectOptionCategory
+  }
+  | {
+    kind: "CombatTechniques"
+    CombatTechniques: CombatTechniquesSelectOptionCategory
+  }
+  | {
+    kind: "TargetCategories"
+    TargetCategories: TargetCategoriesSelectOptionCategory
   }
 
-export interface ExplicitSkillSelectOption {
+export interface SkillsSelectOptionCategory {
   /**
-   * The skill’s identifier.
+   * A list of skill categories.
    */
-  id: Skill_ID
+  categories: SkillsSelectOptionCategoryCategory[]
 
   /**
-   * Prerequisites for the select option.
+   * Generate AP values for each entry.
    */
-  prerequisites?: GeneralPrerequisites
+  ap_value?: SelectOptionsAdventurePointsValue<SkillishIdentifier>
+}
 
+export type SkillsSelectOptionCategoryCategory =
+  | {
+    kind: "Skills"
+    Skills: SkillSelectOptionCategoryCategory
+  }
+  | {
+    kind: "Spells"
+    Spells: GenericSkillsSelectOptionCategoryCategory<Spell_ID>
+  }
+  | {
+    kind: "Rituals"
+    Rituals: GenericSkillsSelectOptionCategoryCategory<Ritual_ID>
+  }
+  | {
+    kind: "LiturgicalChants"
+    LiturgicalChants: GenericSkillsSelectOptionCategoryCategory<LiturgicalChant_ID>
+  }
+  | {
+    kind: "Ceremonies"
+    Ceremonies: GenericSkillsSelectOptionCategoryCategory<Ceremony_ID>
+  }
+
+export interface SkillSelectOptionCategoryCategory {
   /**
-   * Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.
+   * Only include entries of the specified groups.
    */
-  binding_cost?: number
+  groups?: SkillGroup_ID[]
 
   /**
-   * Specific AP cost for the select option.
+   * Only include or exclude specific skills.
    */
-  ap_value?: number
+  specific?: SpecificFromSkillSelectOptionCategoryCategory<Skill_ID>
 
   /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
+   * 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.
    */
-  src?: PublicationRefs
+  skill_applications?: SkillApplicationOrUse[]
+
+  /**
+   * 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.
+   */
+  skill_uses?: SkillApplicationOrUse[]
+
+  /**
+   * Generate prerequisites for each entry of the category.
+   */
+  prerequisites?: SkillSelectOptionCategoryPrerequisite[]
+
+  /**
+   * Generate AP values for each entry.
+   */
+  ap_value?: SelectOptionsAdventurePointsValue<Skill_ID>
+}
+
+export interface SpecificFromSkillSelectOptionCategoryCategory<Ref> {
+  operation: SpecificFromSkillSelectOptionCategoryCategoryOperation
+
+  /**
+   * The list of specific entries.
+   */
+  list: Ref[]
+}
+
+/**
+ * Only include (`Intersection`) or exclude (`Difference`) specific entries.
+ */
+export type SpecificFromSkillSelectOptionCategoryCategoryOperation =
+  | {
+    kind: "Intersection"
+  }
+  | {
+    kind: "Difference"
+  }
+
+export interface SkillApplicationOrUse {
+  /**
+   * The application’s or use’s identifier. An entry-unique, increasing integer.
+   */
+  id: number
 
   /**
    * All translations for the entry, identified by IETF language tag (BCP47).
    */
   translations?: {
-    [localeId: string]: ExplicitSkillSelectOptionTranslation
+    [localeId: string]: SkillApplicationOrUseTranslation
   }
 }
 
-export interface ExplicitSkillSelectOptionTranslation {
-  errata?: Errata
+export interface SkillApplicationOrUseTranslation {
+  /**
+   * The name of the application or use if different from the activatable entry’s name.
+   */
+  name: string
 }
 
-export interface ExplicitCombatTechniqueSelectOption {
+export type SkillSelectOptionCategoryPrerequisite =
+  | {
+    kind: "Self"
+    Self: SelfPrerequisite
+  }
+  | {
+    kind: "SelectOption"
+    SelectOption: OptionPrerequisite
+  }
+
+export interface SelfPrerequisite {
   /**
-   * The combat technique’s identifier.
+   * The entry requires itself on a certain Skill Rating.
    */
-  id: CombatTechniqueIdentifier
+  value: number
+}
 
+/**
+ * Generate AP values for each entry.
+ */
+export type SelectOptionsAdventurePointsValue<Identifier> =
+  | {
+    kind: "DerivedFromImprovementCost"
+    DerivedFromImprovementCost: SelectOptionsDeriveAdventurePointsValueFromImprovementCost
+  }
+  | {
+    kind: "Fixed"
+    Fixed: SelectOptionsFixedAdventurePointsValue<Identifier>
+  }
+
+/**
+ * Derive the cost from the improvement cost of each entry. The AP value is calculated by multiplying the improvement cost with `multiplier` and then adding `offset`.
+ */
+export interface SelectOptionsDeriveAdventurePointsValueFromImprovementCost {
   /**
-   * Prerequisites for the select option.
+   * This number is multiplied with the improvement cost of the entry (A = 1 to D = 4).
    */
-  prerequisites?: GeneralPrerequisites
+  multiplier?: number
 
   /**
-   * Specific binding cost for the select option. Only has an effect if the associated entry supports binding costs.
+   * This number is added to the multiplied improvement cost of the entry.
    */
-  binding_cost?: number
+  offset?: number
+}
 
+export interface SelectOptionsFixedAdventurePointsValue<Identifier> {
   /**
-   * Specific AP cost for the select option.
+   * A mapping of skill identifiers to their specific AP values.
    */
-  ap_value?: number
+  map: SelectOptionsFixedAdventurePointsValueMapping<Identifier>[]
 
   /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
+   * The default value of an entry. Used as a fallback if no value is found in `list`.
    */
-  src?: PublicationRefs
+  default: number
+}
 
+export interface SelectOptionsFixedAdventurePointsValueMapping<Identifier> {
   /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
+   * The entry’s identifier.
    */
-  translations?: {
-    [localeId: string]: ExplicitCombatTechniqueSelectOptionTranslation
+  id: Identifier
+
+  /**
+   * The AP value for the specified entry.
+   */
+  ap_value: number
+}
+
+export interface GenericSkillsSelectOptionCategoryCategory<Ref> {
+  /**
+   * Only include (`Intersection`) or exclude (`Difference`) specific entries.
+   */
+  specific?: SpecificFromSkillSelectOptionCategoryCategory<Ref>
+
+  /**
+   * Generate prerequisites for each entry of the category.
+   */
+  prerequisites?: SkillSelectOptionCategoryPrerequisite[]
+}
+
+export type SkillishIdentifier =
+  | {
+    kind: "Skill"
+    Skill: Skill_ID
+  }
+  | {
+    kind: "Spell"
+    Spell: Spell_ID
+  }
+  | {
+    kind: "Ritual"
+    Ritual: Ritual_ID
+  }
+  | {
+    kind: "LiturgicalChant"
+    LiturgicalChant: LiturgicalChant_ID
+  }
+  | {
+    kind: "Ceremony"
+    Ceremony: Ceremony_ID
   }
+
+export interface CombatTechniquesSelectOptionCategory {
+  /**
+   * A list of combat technique categories.
+   */
+  categories: CombatTechniquesSelectOptionCategoryCategory[]
+
+  /**
+   * Generate binding cost values for each entry.
+   * 
+   * *Note: This only works if the entry it is defined on supports binding costs, i.e. is a tradition artifact enchantment.*
+   */
+  bindingCost?: SelectOptionsBindingCostValue<CombatTechniqueIdentifier>
+
+  /**
+   * Generate AP values for each entry.
+   */
+  ap_value?: SelectOptionsAdventurePointsValue<CombatTechniqueIdentifier>
 }
 
-export interface ExplicitCombatTechniqueSelectOptionTranslation {
-  errata?: Errata
+export type CombatTechniquesSelectOptionCategoryCategory =
+  | {
+    kind: "CloseCombatTechniques"
+    CloseCombatTechniques: GenericSkillsSelectOptionCategoryCategory<CloseCombatTechnique_ID>
+  }
+  | {
+    kind: "RangedCombatTechniques"
+    RangedCombatTechniques: GenericSkillsSelectOptionCategoryCategory<RangedCombatTechnique_ID>
+  }
+
+/**
+ * Generate binding cost for each entry.
+ */
+export type SelectOptionsBindingCostValue<Identifier> =
+  | {
+    kind: "Fixed"
+    Fixed: SelectOptionsFixedBindingCostValue<Identifier>
+  }
+
+export interface SelectOptionsFixedBindingCostValue<Identifier> {
+  /**
+   * A mapping of skill identifiers to their specific binding cost values.
+   */
+  map: SelectOptionsFixedBindingCostValueMapping<Identifier>[]
+
+  /**
+   * The default value of an entry. Used as a fallback if no value is found in `list`.
+   */
+  default: number
+}
+
+export interface SelectOptionsFixedBindingCostValueMapping<Identifier> {
+  /**
+   * The entry’s identifier.
+   */
+  id: Identifier
+
+  /**
+   * The binding cost for the specified entry.
+   */
+  bindingCost: number
+}
+
+export interface TargetCategoriesSelectOptionCategory {
+  /**
+   * A list of target categories.
+   */
+  list: SpecificTargetCategory[]
+}
+
+export interface SpecificTargetCategory {
+  /**
+   * The target category’s identifier.
+   */
+  id: TargetCategory_ID
+
+  /**
+   * The volume for this specific selection.
+   */
+  volume?: number
 }
 
 export type TradeSecretAdventurePointsValue =
@@ -9230,7 +9526,7 @@ export interface BindingCostMapOption {
   /**
    * All translations for the entry, identified by IETF language tag (BCP47).
    */
-  translations?: {
+  translations: {
     [localeId: string]: BindingCostMapOptionTranslation
   }
 }
@@ -9251,7 +9547,26 @@ export interface BindingCostDerivedFromSelection {
   /**
    * The binding cost for the selection if it does not define a specific one.
    */
-  fallback: number
+  fallback: number
+
+  /**
+   * All translations for the entry, identified by IETF language tag (BCP47).
+   */
+  translations?: {
+    [localeId: string]: BindingCostDerivedFromSelectionTranslation
+  }
+}
+
+export interface BindingCostDerivedFromSelectionTranslation {
+  /**
+   * Place a string between the `for` and the grouped option names.
+   */
+  listPrepend?: string
+
+  /**
+   * A replacement for the generated text if it would not match the original one.
+   */
+  replacement?: string
 }
 
 /**
@@ -15398,7 +15713,7 @@ export interface MagicalSkillRating {
   /**
    * The rating bonus provided for the (selected) magical skill. If used in a profession variant, it can also be used to lower the bonus of the base profession.
    * 
-   * **Note:** This is a rating *bonus*, so it will be *added* to the default value of 6.
+   * **Note:** If due to a variant a spell rating is lowered to 0, the spell is considered deactivated. Both setting the value for a spell and deactivating it by setting it to 0 takes into account the additional activation cost for spells.
    */
   rating_modifier: number
 }
@@ -17149,7 +17464,7 @@ export interface LiturgicalChantRating {
   /**
    * The rating bonus provided for the selected liturgical chant. If used in a profession variant, it can also be used to lower the bonus of the base profession.
    * 
-   * **Note:** This is a rating *bonus*, so it will be *added* to the default value of 6.
+   * **Note:** If due to a variant a liturgical chant rating is lowered to 0, the liturgical chant is considered deactivated. Both setting the value for a liturgical chant and deactivating it by setting it to 0 takes into account the additional activation cost for liturgical chants.
    */
   rating_modifier: number
 }
@@ -17965,257 +18280,6 @@ export type AdvantageDisadvantagePrerequisiteGroup =
     SexualCharacteristic: SexualCharacteristicPrerequisite
   }
 
-export interface SkillsSelectOptionCategory {
-  /**
-   * A list of skill categories.
-   */
-  categories: SkillsSelectOptionCategoryCategory[]
-
-  /**
-   * Generate AP values for each entry.
-   */
-  ap_value?: SelectOptionsAdventurePointsValue<SkillishIdentifier>
-}
-
-export type SkillsSelectOptionCategoryCategory =
-  | {
-    kind: "Skills"
-    Skills: SkillSelectOptionCategoryCategory
-  }
-  | {
-    kind: "Spells"
-    Spells: GenericSkillsSelectOptionCategoryCategory<Spell_ID>
-  }
-  | {
-    kind: "Rituals"
-    Rituals: GenericSkillsSelectOptionCategoryCategory<Ritual_ID>
-  }
-  | {
-    kind: "LiturgicalChants"
-    LiturgicalChants: GenericSkillsSelectOptionCategoryCategory<LiturgicalChant_ID>
-  }
-  | {
-    kind: "Ceremonies"
-    Ceremonies: GenericSkillsSelectOptionCategoryCategory<Ceremony_ID>
-  }
-
-export interface SkillSelectOptionCategoryCategory {
-  /**
-   * Only include entries of the specified groups.
-   */
-  groups?: SkillGroup_ID[]
-
-  /**
-   * Only include or exclude specific skills.
-   */
-  specific?: SpecificFromSkillSelectOptionCategoryCategory<Skill_ID>
-
-  /**
-   * 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.
-   */
-  skill_applications?: SkillApplicationOrUse[]
-
-  /**
-   * 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.
-   */
-  skill_uses?: SkillApplicationOrUse[]
-
-  /**
-   * Generate prerequisites for each entry of the category.
-   */
-  prerequisites?: SkillSelectOptionCategoryPrerequisite[]
-
-  /**
-   * Generate AP values for each entry.
-   */
-  ap_value?: SelectOptionsAdventurePointsValue<Skill_ID>
-}
-
-export interface SpecificFromSkillSelectOptionCategoryCategory<Ref> {
-  operation: SpecificFromSkillSelectOptionCategoryCategoryOperation
-
-  /**
-   * The list of specific entries.
-   */
-  list: Ref[]
-}
-
-/**
- * Only include (`Intersection`) or exclude (`Difference`) specific entries.
- */
-export type SpecificFromSkillSelectOptionCategoryCategoryOperation =
-  | {
-    kind: "Intersection"
-  }
-  | {
-    kind: "Difference"
-  }
-
-export interface SkillApplicationOrUse {
-  /**
-   * The application’s or use’s identifier. An entry-unique, increasing integer.
-   */
-  id: number
-
-  /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
-   */
-  translations?: {
-    [localeId: string]: SkillApplicationOrUseTranslation
-  }
-}
-
-export interface SkillApplicationOrUseTranslation {
-  /**
-   * The name of the application or use if different from the activatable entry’s name.
-   */
-  name: string
-}
-
-export type SkillSelectOptionCategoryPrerequisite =
-  | {
-    kind: "Self"
-    Self: SelfPrerequisite
-  }
-  | {
-    kind: "SelectOption"
-    SelectOption: OptionPrerequisite
-  }
-
-export interface SelfPrerequisite {
-  /**
-   * The entry requires itself on a certain Skill Rating.
-   */
-  value: number
-}
-
-/**
- * Generate AP values for each entry.
- */
-export type SelectOptionsAdventurePointsValue<Identifier> =
-  | {
-    kind: "DerivedFromImprovementCost"
-    DerivedFromImprovementCost: SelectOptionsDeriveAdventurePointsValueFromImprovementCost
-  }
-  | {
-    kind: "Fixed"
-    Fixed: SelectOptionsFixedAdventurePointsValue<Identifier>
-  }
-
-/**
- * Derive the cost from the improvement cost of each entry. The AP value is calculated by multiplying the improvement cost with `multiplier` and then adding `offset`.
- */
-export interface SelectOptionsDeriveAdventurePointsValueFromImprovementCost {
-  /**
-   * This number is multiplied with the improvement cost of the entry (A = 1 to D = 4).
-   */
-  multiplier?: number
-
-  /**
-   * This number is added to the multiplied improvement cost of the entry.
-   */
-  offset?: number
-}
-
-export interface SelectOptionsFixedAdventurePointsValue<Identifier> {
-  /**
-   * A mapping of skill identifiers to their specific AP values.
-   */
-  map: SelectOptionsFixedAdventurePointsValueMapping<Identifier>[]
-
-  /**
-   * The default value of an entry. Used as a fallback if no value is found in `list`.
-   */
-  default: number
-}
-
-export interface SelectOptionsFixedAdventurePointsValueMapping<Identifier> {
-  /**
-   * The entry’s identifier.
-   */
-  id: Identifier
-
-  /**
-   * The AP value for the specified entry.
-   */
-  ap_value: number
-}
-
-export interface GenericSkillsSelectOptionCategoryCategory<Ref> {
-  /**
-   * Only include (`Intersection`) or exclude (`Difference`) specific entries.
-   */
-  specific?: SpecificFromSkillSelectOptionCategoryCategory<Ref>
-
-  /**
-   * Generate prerequisites for each entry of the category.
-   */
-  prerequisites?: SkillSelectOptionCategoryPrerequisite[]
-}
-
-export type SkillishIdentifier =
-  | {
-    kind: "Skill"
-    Skill: Skill_ID
-  }
-  | {
-    kind: "Spell"
-    Spell: Spell_ID
-  }
-  | {
-    kind: "Ritual"
-    Ritual: Ritual_ID
-  }
-  | {
-    kind: "LiturgicalChant"
-    LiturgicalChant: LiturgicalChant_ID
-  }
-  | {
-    kind: "Ceremony"
-    Ceremony: Ceremony_ID
-  }
-
-export interface CombatTechniquesSelectOptionCategory {
-  /**
-   * A list of combat technique categories.
-   */
-  categories: CombatTechniquesSelectOptionCategoryCategory[]
-
-  /**
-   * Generate AP values for each entry.
-   */
-  ap_value?: SelectOptionsAdventurePointsValue<CombatTechniqueIdentifier>
-}
-
-export type CombatTechniquesSelectOptionCategoryCategory =
-  | {
-    kind: "CloseCombatTechniques"
-    CloseCombatTechniques: GenericSkillsSelectOptionCategoryCategory<CloseCombatTechnique_ID>
-  }
-  | {
-    kind: "RangedCombatTechniques"
-    RangedCombatTechniques: GenericSkillsSelectOptionCategoryCategory<RangedCombatTechnique_ID>
-  }
-
-export interface TargetCategoriesSelectOptionCategory {
-  /**
-   * A list of target categories.
-   */
-  list: SpecificTargetCategory[]
-}
-
-export interface SpecificTargetCategory {
-  /**
-   * The target category’s identifier.
-   */
-  id: TargetCategory_ID
-
-  /**
-   * The volume for this specific selection.
-   */
-  volume?: number
-}
-
 export interface AlternativeRule {
   /**
    * The player types this alternative rule is suitable for.