optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/prerequisites/PrerequisiteGroups.d.ts

@@ -1,6 +1,5 @@
 import { ActivatableOptionSetPrerequisite, ActivatablePrerequisite, ActivatableSetPrerequisite } from "./single/ActivatablePrerequisite.js";
 import { AnimistPowerPrerequisite } from "./single/AnimistPowerPrerequisite.js";
-import { CommonSuggestedByRCPPrerequisite } from "./single/CommonSuggestedByRCPPrerequisite.js";
 import { CulturePrerequisite } from "./single/CulturePrerequisite.js";
 import { ExternalEnhancementPrerequisite, InternalEnhancementPrerequisite } from "./single/EnhancementPrerequisite.js";
 import { InfluencePrerequisite } from "./single/InfluencePrerequisite.js";
@@ -15,18 +14,197 @@ import { SocialStatusPrerequisite } from "./single/SocialStatusPrerequisite.js";
 import { StatePrerequisite } from "./single/StatePrerequisite.js";
 import { TextPrerequisite } from "./single/TextPrerequisite.js";
 import { BlessedTraditionPrerequisite, MagicalTraditionPrerequisite } from "./single/TraditionPrerequisite.js";
-export declare type DerivedCharacteristicPrerequisiteGroup = RulePrerequisite;
-export declare type PublicationPrerequisiteGroup = PublicationPrerequisite;
-export declare type GeneralPrerequisiteGroup = SexPrerequisite | RacePrerequisite | CulturePrerequisite | PactPrerequisite | SocialStatusPrerequisite | StatePrerequisite | RulePrerequisite | PrimaryAttributePrerequisite | ActivatablePrerequisite | ActivatableSetPrerequisite | ActivatableOptionSetPrerequisite | BlessedTraditionPrerequisite | MagicalTraditionPrerequisite | RatedPrerequisite | RatedSetPrerequisite | RatedMinimumNumberPrerequisite | ExternalEnhancementPrerequisite | TextPrerequisite;
-export declare type ProfessionPrerequisiteGroup = SexPrerequisite | RacePrerequisite | CulturePrerequisite | ActivatablePrerequisite | RatedPrerequisite;
-export declare type AdvantageDisadvantagePrerequisiteGroup = CommonSuggestedByRCPPrerequisite | SexPrerequisite | RacePrerequisite | CulturePrerequisite | PactPrerequisite | SocialStatusPrerequisite | StatePrerequisite | RulePrerequisite | PrimaryAttributePrerequisite | ActivatablePrerequisite | ActivatableSetPrerequisite | ActivatableOptionSetPrerequisite | BlessedTraditionPrerequisite | MagicalTraditionPrerequisite | RatedPrerequisite | RatedSetPrerequisite | RatedMinimumNumberPrerequisite | ExternalEnhancementPrerequisite | TextPrerequisite;
-export declare type ArcaneTraditionPrerequisiteGroup = SexPrerequisite | CulturePrerequisite;
-export declare type PersonalityTraitPrerequisiteGroup = CulturePrerequisite | TextPrerequisite;
-export declare type SpellworkPrerequisiteGroup = RulePrerequisite | RatedPrerequisite;
-export declare type LiturgyPrerequisiteGroup = RulePrerequisite;
-export declare type InfluencePrerequisiteGroup = InfluencePrerequisite | TextPrerequisite;
-export declare type LanguagePrerequisiteGroup = RacePrerequisite | ActivatablePrerequisite | TextPrerequisite;
-export declare type AnimistPowerPrerequisiteGroup = AnimistPowerPrerequisite;
-export declare type GeodeRitualPrerequisiteGroup = InfluencePrerequisite;
-export declare type EnhancementPrerequisiteGroup = InternalEnhancementPrerequisite;
-export declare type PreconditionGroup = PublicationPrerequisite;
+export declare type DerivedCharacteristicPrerequisiteGroup = {
+    tag: "Rule";
+    rule: RulePrerequisite;
+};
+export declare type PublicationPrerequisiteGroup = {
+    tag: "Publication";
+    publication: PublicationPrerequisite;
+};
+export declare type GeneralPrerequisiteGroup = {
+    tag: "Sex";
+    sex: SexPrerequisite;
+} | {
+    tag: "Race";
+    race: RacePrerequisite;
+} | {
+    tag: "Culture";
+    culture: CulturePrerequisite;
+} | {
+    tag: "Pact";
+    pact: PactPrerequisite;
+} | {
+    tag: "SocialStatus";
+    social_status: SocialStatusPrerequisite;
+} | {
+    tag: "State";
+    state: StatePrerequisite;
+} | {
+    tag: "Rule";
+    rule: RulePrerequisite;
+} | {
+    tag: "PrimaryAttribute";
+    primary_attribute: PrimaryAttributePrerequisite;
+} | {
+    tag: "Activatable";
+    activatable: ActivatablePrerequisite;
+} | {
+    tag: "ActivatableSet";
+    activatable_set: ActivatableSetPrerequisite;
+} | {
+    tag: "ActivatableOptionSet";
+    activatable_option_set: ActivatableOptionSetPrerequisite;
+} | {
+    tag: "BlessedTradition";
+    blessed_tradition: BlessedTraditionPrerequisite;
+} | {
+    tag: "MagicalTradition";
+    magical_tradition: MagicalTraditionPrerequisite;
+} | {
+    tag: "Rated";
+    rated: RatedPrerequisite;
+} | {
+    tag: "RatedSet";
+    rated_set: RatedSetPrerequisite;
+} | {
+    tag: "RatedMinimumNumber";
+    rated_minimum_number: RatedMinimumNumberPrerequisite;
+} | {
+    tag: "ExternalEnhancement";
+    external_enhancement: ExternalEnhancementPrerequisite;
+} | {
+    tag: "Text";
+    text: TextPrerequisite;
+};
+export declare type ProfessionPrerequisiteGroup = {
+    tag: "Sex";
+    sex: SexPrerequisite;
+} | {
+    tag: "Race";
+    race: RacePrerequisite;
+} | {
+    tag: "Culture";
+    culture: CulturePrerequisite;
+} | {
+    tag: "Activatable";
+    activatable: ActivatablePrerequisite;
+} | {
+    tag: "Rated";
+    rated: RatedPrerequisite;
+};
+export declare type AdvantageDisadvantagePrerequisiteGroup = {
+    tag: "CommonSuggestedByRCP";
+} | {
+    tag: "Sex";
+    sex: SexPrerequisite;
+} | {
+    tag: "Race";
+    race: RacePrerequisite;
+} | {
+    tag: "Culture";
+    culture: CulturePrerequisite;
+} | {
+    tag: "Pact";
+    pact: PactPrerequisite;
+} | {
+    tag: "SocialStatus";
+    social_status: SocialStatusPrerequisite;
+} | {
+    tag: "State";
+    state: StatePrerequisite;
+} | {
+    tag: "Rule";
+    rule: RulePrerequisite;
+} | {
+    tag: "PrimaryAttribute";
+    primary_attribute: PrimaryAttributePrerequisite;
+} | {
+    tag: "Activatable";
+    activatable: ActivatablePrerequisite;
+} | {
+    tag: "ActivatableSet";
+    activatable_set: ActivatableSetPrerequisite;
+} | {
+    tag: "ActivatableOptionSet";
+    activatable_option_set: ActivatableOptionSetPrerequisite;
+} | {
+    tag: "BlessedTradition";
+    blessed_tradition: BlessedTraditionPrerequisite;
+} | {
+    tag: "MagicalTradition";
+    magical_tradition: MagicalTraditionPrerequisite;
+} | {
+    tag: "Rated";
+    rated: RatedPrerequisite;
+} | {
+    tag: "RatedSet";
+    rated_set: RatedSetPrerequisite;
+} | {
+    tag: "RatedMinimumNumber";
+    rated_minimum_number: RatedMinimumNumberPrerequisite;
+} | {
+    tag: "ExternalEnhancement";
+    external_enhancement: ExternalEnhancementPrerequisite;
+} | {
+    tag: "Text";
+    text: TextPrerequisite;
+};
+export declare type ArcaneTraditionPrerequisiteGroup = {
+    tag: "Sex";
+    sex: SexPrerequisite;
+} | {
+    tag: "Culture";
+    culture: CulturePrerequisite;
+};
+export declare type PersonalityTraitPrerequisiteGroup = {
+    tag: "Culture";
+    culture: CulturePrerequisite;
+} | {
+    tag: "Text";
+    text: TextPrerequisite;
+};
+export declare type SpellworkPrerequisiteGroup = {
+    tag: "Rule";
+    rule: RulePrerequisite;
+} | {
+    tag: "Rated";
+    rated: RatedPrerequisite;
+};
+export declare type LiturgyPrerequisiteGroup = {
+    tag: "Rule";
+    rule: RulePrerequisite;
+};
+export declare type InfluencePrerequisiteGroup = {
+    tag: "Influence";
+    influence: InfluencePrerequisite;
+} | {
+    tag: "Text";
+    text: TextPrerequisite;
+};
+export declare type LanguagePrerequisiteGroup = {
+    tag: "Race";
+    race: RacePrerequisite;
+} | {
+    tag: "Activatable";
+    activatable: ActivatablePrerequisite;
+} | {
+    tag: "Text";
+    text: TextPrerequisite;
+};
+export declare type AnimistPowerPrerequisiteGroup = {
+    tag: "AnimistPower";
+    animist_power: AnimistPowerPrerequisite;
+};
+export declare type GeodeRitualPrerequisiteGroup = {
+    tag: "Influence";
+    influence: InfluencePrerequisite;
+};
+export declare type EnhancementPrerequisiteGroup = {
+    tag: "InternalEnhancement";
+    internal_enhancement: InternalEnhancementPrerequisite;
+};
+export declare type PreconditionGroup = {
+    tag: "Publication";
+    publication: PublicationPrerequisite;
+};

package/lib/types/prerequisites/single/ActivatablePrerequisite.d.ts

@@ -6,7 +6,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Activatable Prerequisite
  */
 export declare type ActivatablePrerequisite = {
-    tag: "Activatable";
     /**
      * The activatable entry's identifier.
      */
@@ -36,7 +35,6 @@ export declare type ActivatablePrerequisite = {
  * @title Activatable Set Prerequisite
  */
 export declare type ActivatableSetPrerequisite = {
-    tag: "ActivatableSet";
     /**
      * The possible activatable entries' identifiers.
      * @minItems 2
@@ -66,7 +64,6 @@ export declare type ActivatableSetPrerequisite = {
  * @title Activatable Option Set Prerequisite
  */
 export declare type ActivatableOptionSetPrerequisite = {
-    tag: "ActivatableOptionSet";
     /**
      * The activatable entry's identifier.
      */

package/lib/types/prerequisites/single/AnimistPowerPrerequisite.d.ts

@@ -4,7 +4,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Animist Power Prerequisite
  */
 export declare type AnimistPowerPrerequisite = {
-    tag: "AnimistPower";
     /**
      * The animist power's identifier.
      * @integer

package/lib/types/prerequisites/single/CulturePrerequisite.d.ts

@@ -5,7 +5,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Culture Prerequisite
  */
 export declare type CulturePrerequisite = {
-    tag: "Culture";
     id: OneOrManyNumericIdentifiers;
     display_option?: DisplayOption;
 };

package/lib/types/prerequisites/single/EnhancementPrerequisite.d.ts

@@ -7,26 +7,23 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title External Enhancement Prerequisite
  */
 export declare type ExternalEnhancementPrerequisite = {
-    tag: "Enhancement";
     /**
-     * The required skill's identifier.
+     * The required skill.
      */
-    skill_id: SkillWithEnhancementsIdentifier;
+    skill: SkillWithEnhancementsReference;
     /**
-     * The required enhancement's identifier.
-     * @integer
-     * @minimum 1
+     * The required enhancement.
      */
-    enhancement_id: number;
+    enhancement: EnhancementsReference;
     display_option?: DisplayOption;
 };
-/**
- * Requires a specific enhancement from a skill. This can only be used by an
- * enhancement to require another enhancement from the same skill.
- * @title Internal Enhancement Prerequisite
- */
-export declare type InternalEnhancementPrerequisite = {
-    tag: "Enhancement";
+export declare type SkillWithEnhancementsReference = {
+    /**
+     * The skill's identifier.
+     */
+    id: SkillWithEnhancementsIdentifier;
+};
+export declare type EnhancementsReference = {
     /**
      * The enhancement's identifier.
      * @integer
@@ -34,3 +31,9 @@ export declare type InternalEnhancementPrerequisite = {
      */
     id: number;
 };
+/**
+ * Requires a specific enhancement from a skill. This can only be used by an
+ * enhancement to require another enhancement from the same skill.
+ * @title Internal Enhancement Prerequisite
+ */
+export declare type InternalEnhancementPrerequisite = EnhancementsReference;

package/lib/types/prerequisites/single/InfluencePrerequisite.d.ts

@@ -3,7 +3,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Influence Prerequisite
  */
 export declare type InfluencePrerequisite = {
-    tag: "Influence";
     /**
      * The influence's identifier.
      * @integer

package/lib/types/prerequisites/single/PactPrerequisite.d.ts

@@ -1,20 +1,18 @@
+import { PactCategoryReference, PactDomainReference } from "../../_SimpleReferences.js";
 import { DisplayOption } from "../DisplayOption.js";
 /**
  * Requires a specific pact.
  * @title Pact Prerequisite
  */
 export declare type PactPrerequisite = {
-    tag: "Pact";
     /**
-     * The required pact category's identifier.
-     * @integer
-     * @minimum 1
+     * The required pact category.
      */
-    category_id: number;
+    category: PactCategoryReference;
     /**
-     * The required domains' identifiers.
+     * The required domain(s).
      */
-    domain_id?: DomainId[];
+    domain_id?: PactDomainReference[];
     /**
      * The required pact level.
      * @integer
@@ -23,10 +21,3 @@ export declare type PactPrerequisite = {
     level?: number;
     display_option?: DisplayOption;
 };
-/**
- * A domain's identifier.
- * @integer
- * @minimum 1
- */
-declare type DomainId = number;
-export {};

package/lib/types/prerequisites/single/PrimaryAttributePrerequisite.d.ts

@@ -3,15 +3,10 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Primary Attribute Prerequisite
  */
 export declare type PrimaryAttributePrerequisite = {
-    tag: "PrimaryAttribute";
     /**
      * Is the required primary attribute for spellcasters or blessed ones?
      */
-    category: {
-        tag: "Blessed";
-    } | {
-        tag: "Magical";
-    };
+    category: PrimaryAttributeCategory;
     /**
      * Required value of the attribute
      * @integer
@@ -20,3 +15,8 @@ export declare type PrimaryAttributePrerequisite = {
     value: number;
     display_option?: DisplayOption;
 };
+export declare type PrimaryAttributeCategory = {
+    tag: "Blessed";
+} | {
+    tag: "Magical";
+};

package/lib/types/prerequisites/single/PublicationPrerequisite.d.ts

@@ -3,7 +3,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Publication Prerequisite
  */
 export declare type PublicationPrerequisite = {
-    tag: "Publication";
     /**
      * @integer
      * @minimum 1

package/lib/types/prerequisites/single/RacePrerequisite.d.ts

@@ -7,7 +7,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Race Prerequisite
  */
 export declare type RacePrerequisite = {
-    tag: "Race";
     id: OneOrManyNumericIdentifiers;
     active: boolean;
     display_option?: DisplayOption;

package/lib/types/prerequisites/single/RatedPrerequisite.d.ts

@@ -1,10 +1,10 @@
 import { RatedIdentifier } from "../../_Identifier.js";
+import { AspectReference, PropertyReference, SkillReference } from "../../_SimpleReferences.js";
 import { DisplayOption } from "../DisplayOption.js";
 /**
  * @title Rated Prerequisite
  */
 export declare type RatedPrerequisite = {
-    tag: "Rated";
     /**
      * The rated entry's identifier.
      */
@@ -21,7 +21,6 @@ export declare type RatedPrerequisite = {
  * @title Rated Set Prerequisite
  */
 export declare type RatedSetPrerequisite = {
-    tag: "RatedSet";
     /**
      * The possible rated entries' identifiers.
      * @minItems 2
@@ -39,7 +38,6 @@ export declare type RatedSetPrerequisite = {
  * @title Rated Minimum Number Prerequisite
  */
 export declare type RatedMinimumNumberPrerequisite = {
-    tag: "RatedMinimumNumber";
     /**
      * The minimum number of skills that need to be on the defined minimum skill
      * rating.
@@ -57,43 +55,36 @@ export declare type RatedMinimumNumberPrerequisite = {
     /**
      * The targets that contribute to satisfying the prerequisite.
      */
-    targets: {
-        tag: "Skills";
-        /**
-         * The skills that are taken into account for satisfying the prerequisite.
-         * @minItems 2
-         * @uniqueItems
-         */
-        skills: {
-            /**
-             * The skill's identifier.
-             */
-            id: number;
-        }[];
-    } | {
-        tag: "Spellworks";
-        /**
-         * Spellworks with the referenced property are taken into account for
-         * satisfying the prerequisite.
-         */
-        property: {
-            /**
-             * The property's identifier.
-             */
-            id: number;
-        };
-    } | {
-        tag: "Liturgies";
-        /**
-         * Liturgies with the referenced aspect are taken into account for
-         * satisfying the prerequisite.
-         */
-        aspect: {
-            /**
-             * The aspect's identifier.
-             */
-            id: number;
-        };
-    };
+    targets: RatedMinimumNumberPrerequisiteTarget;
     display_option?: DisplayOption;
 };
+export declare type RatedMinimumNumberPrerequisiteTarget = {
+    tag: "Skills";
+    skills: RatedMinimumNumberPrerequisiteSkillsTarget;
+} | {
+    tag: "Spellworks";
+    spellworks: PropertyReference;
+} | {
+    tag: "Liturgies";
+    liturgies: AspectReference;
+};
+export declare type RatedMinimumNumberPrerequisiteSkillsTarget = {
+    /**
+     * The skills that are taken into account for satisfying the prerequisite.
+     * @minItems 2
+     * @uniqueItems
+     */
+    list: SkillReference[];
+};
+export declare type RatedMinimumNumberPrerequisiteSpellworksTarget = {
+    /**
+     * The skills that are taken into account for satisfying the prerequisite.
+     */
+    property: PropertyReference;
+};
+export declare type RatedMinimumNumberPrerequisiteLiturgiesTarget = {
+    /**
+     * The skills that are taken into account for satisfying the prerequisite.
+     */
+    aspect: AspectReference;
+};

package/lib/types/prerequisites/single/RulePrerequisite.d.ts

@@ -4,7 +4,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Rule Prerequisite
  */
 export declare type RulePrerequisite = {
-    tag: "Rule";
     id: ExtensionRuleIdentifier;
     display_option?: DisplayOption;
 };

package/lib/types/prerequisites/single/SexPrerequisite.d.ts

@@ -5,7 +5,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Sex Prerequisite
  */
 export declare type SexPrerequisite = {
-    tag: "Sex";
     id: BinarySex;
     display_option?: DisplayOption;
 };

package/lib/types/prerequisites/single/SocialStatusPrerequisite.d.ts

@@ -4,7 +4,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Social Status Prerequisite
  */
 export declare type SocialStatusPrerequisite = {
-    tag: "SocialStatus";
     /**
      * The minimum social status' identifier.
      * @integer

package/lib/types/prerequisites/single/StatePrerequisite.d.ts

@@ -5,7 +5,6 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title State Prerequisite
  */
 export declare type StatePrerequisite = {
-    tag: "Culture";
     id: OneOrManyNumericIdentifiers;
     display_option?: DisplayOption;
 };

package/lib/types/prerequisites/single/TextPrerequisite.d.ts

@@ -1,31 +1,27 @@
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown } from "../../_NonEmptyString.js";
 /**
  * A prerequisite that is either not verifyable in general – e.g. roleplay or
  * background information – or the referenced entities were not made available
  * for use yet – e.g. races –, but which should be displayed, because it is part
  * of the prerequisite string from the sources.
- * @title Impossible Prerequisite
+ * @title Text Prerequisite
  */
 export declare type TextPrerequisite = {
-    tag: "Text";
     /**
      * The method how the prerequisite should be verified. Either is passes all
      * verification text or it denies all verification tests. The latter results
      * in the associated entry to never be available for purchase.
      */
-    verification: {
-        tag: "Pass";
-    } | {
-        tag: "Deny";
-    };
+    verification: TextVerificationRule;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         * @minLength 1
-         */
-        [localeId: string]: string;
-    };
+    translations: LocaleMap<TextPrerequisiteTranslation>;
 };
+export declare type TextVerificationRule = {
+    tag: "Pass";
+} | {
+    tag: "Deny";
+};
+export declare type TextPrerequisiteTranslation = NonEmptyMarkdown;

package/lib/types/prerequisites/single/TraditionPrerequisite.d.ts

@@ -3,31 +3,39 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title Blessed Tradition Prerequisite
  */
 export declare type BlessedTraditionPrerequisite = {
-    tag: "BlessedTradition";
     /**
      * The blessed tradition prerequisite may only be satified if the blessed
      * tradition is either church or shamanistic.
      */
-    restriction?: {
-        tag: "Church";
-    } | {
-        tag: "Shamanistic";
-    };
+    restriction?: BlessedTraditionPrerequisiteRestriction;
     display_option?: DisplayOption;
 };
+/**
+ * The blessed tradition prerequisite may only be satified if the blessed
+ * tradition is either church or shamanistic.
+ */
+export declare type BlessedTraditionPrerequisiteRestriction = {
+    tag: "Church";
+} | {
+    tag: "Shamanistic";
+};
 /**
  * @title Magical Tradition Prerequisite
  */
 export declare type MagicalTraditionPrerequisite = {
-    tag: "MagicalTradition";
     /**
      * The magical tradition prerequisite may only be satified if the magical
      * tradition can learn rituals or can bind familiars.
      */
-    restriction?: {
-        tag: "CanLearnRituals";
-    } | {
-        tag: "CanBindFamiliars";
-    };
+    restriction?: MagicalTraditionPrerequisiteRestriction;
     display_option?: DisplayOption;
 };
+/**
+ * The magical tradition prerequisite may only be satified if the magical
+ * tradition can learn rituals or can bind familiars.
+ */
+export declare type MagicalTraditionPrerequisiteRestriction = {
+    tag: "CanLearnRituals";
+} | {
+    tag: "CanBindFamiliars";
+};