@optolith/database-schema 0.89.0 → 0.90.1

package/gen/types.d.ts

@@ -292,6 +292,7 @@ export type EnumMap = {
   CombatUse: CombatUse
   CommonCantripNote: CommonCantripNote
   CommonnessRatedAdvantageDisadvantageLevel: CommonnessRatedAdvantageDisadvantageLevel
+  CommonnessSelectOptionIdentifier: CommonnessSelectOptionIdentifier
   CommonnessWeight: CommonnessWeight
   CommonProfessionConstraintsOperation: CommonProfessionConstraintsOperation
   CommonProfessions: CommonProfessions
@@ -21337,7 +21338,7 @@ export interface CommonnessRatedAdvantageDisadvantage<Identifier> {
   /**
    * The options the commonness rating applies to.
    */
-  options?: RequirableSelectOptionIdentifier[]
+  options?: CommonnessSelectOptionIdentifier[]
 
   /**
    * All translations for the entry, identified by IETF language tag (BCP47).
@@ -21380,367 +21381,185 @@ export type CommonnessRatedAdvantageDisadvantageLevel =
     }
   }
 
-export type CommonnessRatedSkill = Skill_ID
-
-export interface CulturalPackageItem {
-  /**
-   * The skill’s identifier.
-   */
-  id: Skill_ID
-
-  /**
-   * The skill points for the respective skill you get for buying the cultural package.
-   */
-  points: number
-}
-
 /**
- * Description and examples of the area knowledge.
+ * A skill group can be chosen as an option for commonness-rated advantages and disadvantages, but it refers to all skills within that group, rather than being a select option itself.
  */
-export interface AreaKnowledgeTranslation {
-  /**
-   * The full description without examples in parenthesis.
-   */
-  description: string
+export type CommonnessSelectOptionIdentifier =
+  | {
+    kind: "General"
+    General: GeneralSelectOption_ID
+  }
+  | {
+    kind: "Race"
+    Race: Race_ID
+  }
+  | {
+    kind: "Skill"
+    Skill: Skill_ID
+  }
+  | {
+    kind: "SkillApplication"
+    SkillApplication: SkillApplication_ID
+  }
+  | {
+    kind: "CloseCombatTechnique"
+    CloseCombatTechnique: CloseCombatTechnique_ID
+  }
+  | {
+    kind: "RangedCombatTechnique"
+    RangedCombatTechnique: RangedCombatTechnique_ID
+  }
+  | {
+    kind: "Property"
+    Property: Property_ID
+  }
+  | {
+    kind: "Aspect"
+    Aspect: Aspect_ID
+  }
+  | {
+    kind: "Disease"
+    Disease: Disease_ID
+  }
+  | {
+    kind: "Poison"
+    Poison: Poison_ID
+  }
+  | {
+    kind: "Language"
+    Language: Language_ID
+  }
+  | {
+    kind: "AnimalShape"
+    AnimalShape: AnimalShape_ID
+  }
+  | {
+    kind: "LiturgicalChant"
+    LiturgicalChant: LiturgicalChant_ID
+  }
+  | {
+    kind: "Ceremony"
+    Ceremony: Ceremony_ID
+  }
+  | {
+    kind: "Spell"
+    Spell: Spell_ID
+  }
+  | {
+    kind: "Ritual"
+    Ritual: Ritual_ID
+  }
+  | {
+    kind: "TradeSecret"
+    TradeSecret: TradeSecret_ID
+  }
+  | {
+    kind: "ArcaneBardTradition"
+    ArcaneBardTradition: ArcaneBardTradition_ID
+  }
+  | {
+    kind: "ArcaneDancerTradition"
+    ArcaneDancerTradition: ArcaneDancerTradition_ID
+  }
+  | {
+    kind: "Element"
+    Element: Element_ID
+  }
+  | {
+    kind: "SkillGroup"
+    SkillGroup: SkillGroup_ID
+  }
 
+export interface TradeSecret {
   /**
-   * A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description.
+   * 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.
    */
-  abbreviated: string
+  select_options?: TradeSecretSelectOptions
 
   /**
-   * Examples of areas, if applicable.
+   * The trade secret’s adventure point value
    */
-  examples?: AreaKnowledgeExample[]
-}
-
-export interface AreaKnowledgeExample {
-  area: string
-}
+  ap_value: TradeSecretAdventurePointsValue
 
-/**
- * Structured description of common names.
- */
-export interface CommonNames {
   /**
-   * First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups.
+   * Is this trade secret considered secret knowledge?
    */
-  first_name_groups?: CommonNameGroup[]
+  is_secret_knowledge: boolean
 
-  /**
-   * Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups.
-   */
-  last_name_groups?: CommonNameGroup[]
+  prerequisites?: PlainGeneralPrerequisites
 
   /**
-   * Special naming rules.
+   * References to where in which publications this entry has been defined. Entries may also be added or removed in later printings.
    */
-  naming_rules?: string
-}
+  src: PublicationRefs
 
-export interface CommonNameGroup {
   /**
-   * The group label.
+   * All translations for the entry, identified by IETF language tag (BCP47).
    */
-  label: string
+  translations: {
+    [localeId: string]: TradeSecretTranslation
+  }
+}
 
-  /**
-   * The binary sex if the group is only for a certain binary sex.
-   */
-  sex?: BinarySex
+/**
+ * The entity’s identifier. A UUID or a locale code if it is registered as the locale entity.
+ */
+export type TradeSecret_ID = string
 
+export interface TradeSecretTranslation {
   /**
-   * The names from the group.
+   * The trade secret’s name.
    */
-  names: CommonName[]
-}
-
-export interface CommonName {
   name: string
 
   /**
-   * Additional information about the name, appended in parenthesis.
+   * 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.
    */
-  note?: string
-}
+  name_in_library?: string
 
-export interface RatedMinimumNumberPrerequisite {
   /**
-   * The minimum number of skills that need to be on the defined minimum skill rating.
+   * The description of the trade secret.
    */
-  number: number
+  description?: string
 
-  /**
-   * The minimum skill rating the defined minimum number of skills need to be on.
-   */
-  value: number
+  errata?: Errata
+}
 
+/**
+ * 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.
+ */
+export interface TradeSecretSelectOptions {
   /**
-   * The targets that contribute to satisfying the prerequisite.
+   * 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.
    */
-  targets: RatedMinimumNumberPrerequisiteTarget
-
-  display_option?: DisplayOption
+  derived?: TradeSecretSelectOptionCategory
 }
 
-export type RatedMinimumNumberPrerequisiteTarget =
+export type TradeSecretSelectOptionCategory =
   | {
-    kind: "Skills"
-    Skills: RatedMinimumNumberPrerequisiteSkillsTarget
+    kind: "Blessings"
   }
   | {
-    kind: "CombatTechniques"
-    CombatTechniques: RatedMinimumNumberPrerequisiteCombatTechniquesTarget
+    kind: "Cantrips"
   }
   | {
-    kind: "Spellworks"
-    Spellworks: RatedMinimumNumberPrerequisiteSpellworksTarget
+    kind: "Scripts"
   }
   | {
-    kind: "Liturgies"
-    Liturgies: RatedMinimumNumberPrerequisiteLiturgiesTarget
+    kind: "AnimalShapes"
   }
-
-export interface RatedMinimumNumberPrerequisiteSkillsTarget {
-  /**
-   * The skills that are taken into account for satisfying the prerequisite.
-   */
-  targets: Skill_ID[]
-}
-
-export interface RatedMinimumNumberPrerequisiteCombatTechniquesTarget {
-  /**
-   * The skills that are taken into account for satisfying the prerequisite.
-   */
-  group: RatedMinimumNumberPrerequisiteCombatTechniquesTargetGroup
-}
-
-export type RatedMinimumNumberPrerequisiteCombatTechniquesTargetGroup =
   | {
-    kind: "All"
+    kind: "ArcaneBardTraditions"
   }
   | {
-    kind: "Close"
+    kind: "ArcaneDancerTraditions"
   }
   | {
-    kind: "Ranged"
-  }
-
-export interface RatedMinimumNumberPrerequisiteSpellworksTarget {
-  /**
-   * The skills that are taken into account for satisfying the prerequisite.
-   */
-  property: Property_ID
-}
-
-export interface RatedMinimumNumberPrerequisiteLiturgiesTarget {
-  /**
-   * The skills that are taken into account for satisfying the prerequisite.
-   */
-  aspect: Aspect_ID
-}
-
-export interface EnergyPrerequisite {
-  /**
-   * The energy’s identifier.
-   */
-  id: DerivedCharacteristic_ID
-
-  /**
-   * The required value of additionally bought points.
-   */
-  value: number
-
-  display_option?: DisplayOption
-}
-
-/**
- * In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package.
- */
-export interface ProfessionPackageOptions {
-  skill_specialization?: SkillSpecializationOptions
-  languages_scripts?: LanguagesScriptsOptions
-  specialAbilitiesForAdventurePoints?: SpecialAbilitiesForAdventurePointsOption
-  combat_techniques?: CombatTechniquesOptions
-  combatTechniquesForAdventurePoints?: CombatTechniquesForAdventurePointsOption
-  cantrips?: CantripsOptions
-  curses?: CursesOptions
-  skills?: SkillsOptions
-  spellworks?: SpellworksOptions
-  spellworksForChosenProperty?: SpellworksForChosenProperty
-  liturgies?: LiturgiesOptions
-}
-
-export interface InfluenceEffect {
-  /**
-   * An optional label that is displayed and placed before the actual text.
-   */
-  label: string
-
-  /**
-   * The effect text.
-   */
-  text: string
-}
-
-export interface MagicalTraditionSubgroup {
-  /**
-   * The magical tradition this subgroup belongs to.
-   */
-  parent: MagicalTradition_ID
-
-  /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
-   */
-  translations: {
-    [localeId: string]: MagicalTraditionSubgroupTranslation
-  }
-}
-
-/**
- * The entity’s identifier. A UUID or a locale code if it is registered as the locale entity.
- */
-export type MagicalTraditionSubgroup_ID = string
-
-export interface MagicalTraditionSubgroupTranslation {
-  /**
-   * The name of the ceremonial item. This should be the heading used in the respective publication.
-   */
-  name: string
-}
-
-/**
- * Defines how to determine the AP cost of an enhancement.
- */
-export type EnhancementAdventurePoints =
-  | {
-    kind: "DerivedFromImprovementCost"
-    DerivedFromImprovementCost: DerivedEnhancementAdventurePoints
-  }
-  | {
-    kind: "Constant"
-    Constant: number
-  }
-
-export interface DerivedEnhancementAdventurePoints {
-  /**
-   * The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement.
-   */
-  multiplier: number
-}
-
-export type EnhancementPrerequisites = PlainPrerequisites<EnhancementPrerequisiteGroup>
-
-export type EnhancementPrerequisiteGroup =
-  | {
-    kind: "Enhancement"
-    Enhancement: EnhancementPrerequisite
-  }
-  | {
-    kind: "Rated"
-    Rated: RatedPrerequisite
-  }
-
-/**
- * Requires a specific enhancement from a skill.
- */
-export interface EnhancementPrerequisite {
-  /**
-   * The required enhancement.
-   */
-  id: Enhancement_ID
-}
-
-export interface TradeSecret {
-  /**
-   * 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.
-   */
-  select_options?: TradeSecretSelectOptions
-
-  /**
-   * The trade secret’s adventure point value
-   */
-  ap_value: TradeSecretAdventurePointsValue
-
-  /**
-   * Is this trade secret considered secret knowledge?
-   */
-  is_secret_knowledge: boolean
-
-  prerequisites?: PlainGeneralPrerequisites
-
-  /**
-   * References to where in which publications this entry has been defined. Entries may also be added or removed in later printings.
-   */
-  src: PublicationRefs
-
-  /**
-   * All translations for the entry, identified by IETF language tag (BCP47).
-   */
-  translations: {
-    [localeId: string]: TradeSecretTranslation
-  }
-}
-
-/**
- * The entity’s identifier. A UUID or a locale code if it is registered as the locale entity.
- */
-export type TradeSecret_ID = string
-
-export interface TradeSecretTranslation {
-  /**
-   * The trade secret’s name.
-   */
-  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.
-   */
-  description?: string
-
-  errata?: Errata
-}
-
-/**
- * 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.
- */
-export interface TradeSecretSelectOptions {
-  /**
-   * 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.
-   */
-  derived?: TradeSecretSelectOptionCategory
-}
-
-export type TradeSecretSelectOptionCategory =
-  | {
-    kind: "Blessings"
-  }
-  | {
-    kind: "Cantrips"
-  }
-  | {
-    kind: "Scripts"
-  }
-  | {
-    kind: "AnimalShapes"
-  }
-  | {
-    kind: "ArcaneBardTraditions"
-  }
-  | {
-    kind: "ArcaneDancerTraditions"
-  }
-  | {
-    kind: "SexPractices"
+    kind: "SexPractices"
   }
   | {
     kind: "Races"
@@ -22188,6 +22007,277 @@ export type TradeSecretAdventurePointsValue =
     DependingOnActiveInstances: AdventurePointsDependingOnActiveInstances
   }
 
+export type CommonnessRatedSkill = Skill_ID
+
+export interface CulturalPackageItem {
+  /**
+   * The skill’s identifier.
+   */
+  id: Skill_ID
+
+  /**
+   * The skill points for the respective skill you get for buying the cultural package.
+   */
+  points: number
+}
+
+/**
+ * Description and examples of the area knowledge.
+ */
+export interface AreaKnowledgeTranslation {
+  /**
+   * The full description without examples in parenthesis.
+   */
+  description: string
+
+  /**
+   * A shorter version of the description, used in input fields and other UI elements where the space might be to small to use the full description.
+   */
+  abbreviated: string
+
+  /**
+   * Examples of areas, if applicable.
+   */
+  examples?: AreaKnowledgeExample[]
+}
+
+export interface AreaKnowledgeExample {
+  area: string
+}
+
+/**
+ * Structured description of common names.
+ */
+export interface CommonNames {
+  /**
+   * First names can be gender-neutral, but they can also be for a specific binary sex. They are sorted into groups.
+   */
+  first_name_groups?: CommonNameGroup[]
+
+  /**
+   * Last names can be gender-neutral, like family names, but they can also be for a specific binary sex. They are sorted into groups.
+   */
+  last_name_groups?: CommonNameGroup[]
+
+  /**
+   * Special naming rules.
+   */
+  naming_rules?: string
+}
+
+export interface CommonNameGroup {
+  /**
+   * The group label.
+   */
+  label: string
+
+  /**
+   * The binary sex if the group is only for a certain binary sex.
+   */
+  sex?: BinarySex
+
+  /**
+   * The names from the group.
+   */
+  names: CommonName[]
+}
+
+export interface CommonName {
+  name: string
+
+  /**
+   * Additional information about the name, appended in parenthesis.
+   */
+  note?: string
+}
+
+export interface RatedMinimumNumberPrerequisite {
+  /**
+   * The minimum number of skills that need to be on the defined minimum skill rating.
+   */
+  number: number
+
+  /**
+   * The minimum skill rating the defined minimum number of skills need to be on.
+   */
+  value: number
+
+  /**
+   * The targets that contribute to satisfying the prerequisite.
+   */
+  targets: RatedMinimumNumberPrerequisiteTarget
+
+  display_option?: DisplayOption
+}
+
+export type RatedMinimumNumberPrerequisiteTarget =
+  | {
+    kind: "Skills"
+    Skills: RatedMinimumNumberPrerequisiteSkillsTarget
+  }
+  | {
+    kind: "CombatTechniques"
+    CombatTechniques: RatedMinimumNumberPrerequisiteCombatTechniquesTarget
+  }
+  | {
+    kind: "Spellworks"
+    Spellworks: RatedMinimumNumberPrerequisiteSpellworksTarget
+  }
+  | {
+    kind: "Liturgies"
+    Liturgies: RatedMinimumNumberPrerequisiteLiturgiesTarget
+  }
+
+export interface RatedMinimumNumberPrerequisiteSkillsTarget {
+  /**
+   * The skills that are taken into account for satisfying the prerequisite.
+   */
+  targets: Skill_ID[]
+}
+
+export interface RatedMinimumNumberPrerequisiteCombatTechniquesTarget {
+  /**
+   * The skills that are taken into account for satisfying the prerequisite.
+   */
+  group: RatedMinimumNumberPrerequisiteCombatTechniquesTargetGroup
+}
+
+export type RatedMinimumNumberPrerequisiteCombatTechniquesTargetGroup =
+  | {
+    kind: "All"
+  }
+  | {
+    kind: "Close"
+  }
+  | {
+    kind: "Ranged"
+  }
+
+export interface RatedMinimumNumberPrerequisiteSpellworksTarget {
+  /**
+   * The skills that are taken into account for satisfying the prerequisite.
+   */
+  property: Property_ID
+}
+
+export interface RatedMinimumNumberPrerequisiteLiturgiesTarget {
+  /**
+   * The skills that are taken into account for satisfying the prerequisite.
+   */
+  aspect: Aspect_ID
+}
+
+export interface EnergyPrerequisite {
+  /**
+   * The energy’s identifier.
+   */
+  id: DerivedCharacteristic_ID
+
+  /**
+   * The required value of additionally bought points.
+   */
+  value: number
+
+  display_option?: DisplayOption
+}
+
+/**
+ * In some areas, the profession package grants a loose set of stats where the player must choose between different options for the profession package.
+ */
+export interface ProfessionPackageOptions {
+  skill_specialization?: SkillSpecializationOptions
+  languages_scripts?: LanguagesScriptsOptions
+  specialAbilitiesForAdventurePoints?: SpecialAbilitiesForAdventurePointsOption
+  combat_techniques?: CombatTechniquesOptions
+  combatTechniquesForAdventurePoints?: CombatTechniquesForAdventurePointsOption
+  cantrips?: CantripsOptions
+  curses?: CursesOptions
+  skills?: SkillsOptions
+  spellworks?: SpellworksOptions
+  spellworksForChosenProperty?: SpellworksForChosenProperty
+  liturgies?: LiturgiesOptions
+}
+
+export interface InfluenceEffect {
+  /**
+   * An optional label that is displayed and placed before the actual text.
+   */
+  label: string
+
+  /**
+   * The effect text.
+   */
+  text: string
+}
+
+export interface MagicalTraditionSubgroup {
+  /**
+   * The magical tradition this subgroup belongs to.
+   */
+  parent: MagicalTradition_ID
+
+  /**
+   * All translations for the entry, identified by IETF language tag (BCP47).
+   */
+  translations: {
+    [localeId: string]: MagicalTraditionSubgroupTranslation
+  }
+}
+
+/**
+ * The entity’s identifier. A UUID or a locale code if it is registered as the locale entity.
+ */
+export type MagicalTraditionSubgroup_ID = string
+
+export interface MagicalTraditionSubgroupTranslation {
+  /**
+   * The name of the ceremonial item. This should be the heading used in the respective publication.
+   */
+  name: string
+}
+
+/**
+ * Defines how to determine the AP cost of an enhancement.
+ */
+export type EnhancementAdventurePoints =
+  | {
+    kind: "DerivedFromImprovementCost"
+    DerivedFromImprovementCost: DerivedEnhancementAdventurePoints
+  }
+  | {
+    kind: "Constant"
+    Constant: number
+  }
+
+export interface DerivedEnhancementAdventurePoints {
+  /**
+   * The value to multiply with the numeric representation of the associated skill's improvement cost to form the final AP cost of this enhancement.
+   */
+  multiplier: number
+}
+
+export type EnhancementPrerequisites = PlainPrerequisites<EnhancementPrerequisiteGroup>
+
+export type EnhancementPrerequisiteGroup =
+  | {
+    kind: "Enhancement"
+    Enhancement: EnhancementPrerequisite
+  }
+  | {
+    kind: "Rated"
+    Rated: RatedPrerequisite
+  }
+
+/**
+ * Requires a specific enhancement from a skill.
+ */
+export interface EnhancementPrerequisite {
+  /**
+   * The required enhancement.
+   */
+  id: Enhancement_ID
+}
+
 /**
  * A list of preconditions for the prerequisite it is defined on, so that it only takes effect if the prerequisites in this list are matched.
  *