optolith-database-schema 0.1.2 → 0.1.5

package/lib/types/magicalActions/GeodeRitual.d.ts

@@ -5,7 +5,7 @@ import { SlowSkillCastingTimeUnit } from "../SkillModificationLevel";
 import { Errata } from "../source/_Erratum";
 import { PublicationRefs } from "../source/_PublicationRef";
 import { Cost, Duration, Effect, TargetCategory } from "../_ActivatableSkill";
-import { Prerequisite } from "../_Prerequisite";
+import { GeodeRitualPrerequisites } from "../_Prerequisite";
 import { SkillCheck } from "../_SkillCheck";
 /**
  * @title Geode Ritual
@@ -35,7 +35,7 @@ export declare type GeodeRitual = {
      * @minimum 1
      */
     property_id: number;
-    prerequisites?: Prerequisite.GroupCollection.GeodeRitual;
+    prerequisites?: GeodeRitualPrerequisites;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

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

@@ -0,0 +1,10 @@
+import { PreconditionGroup } from "./PrerequisiteGroups";
+/**
+ * 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.
+ *
+ * Usually appears at the `when` property of the parent prerequisite.
+ * @title Preconditions (`when`)
+ * @minItems 1
+ */
+export declare type Preconditions = PreconditionGroup[];

package/lib/types/prerequisites/ConditionalPrerequisites.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,19 @@
+/**
+ * @title Display Option
+ */
+export declare type DisplayOption = {
+    tag: "Hide";
+} | {
+    tag: "ReplaceWith";
+    /**
+     * 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;
+    };
+};

package/lib/types/prerequisites/DisplayOption.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,32 @@
+import { ActivatableOptionSetPrerequisite, ActivatablePrerequisite, ActivatableSetPrerequisite } from "./single/ActivatablePrerequisite";
+import { AnimistPowerPrerequisite } from "./single/AnimistPowerPrerequisite";
+import { CommonSuggestedByRCPPrerequisite } from "./single/CommonSuggestedByRCPPrerequisite";
+import { CulturePrerequisite } from "./single/CulturePrerequisite";
+import { ExternalEnhancementPrerequisite, InternalEnhancementPrerequisite } from "./single/EnhancementPrerequisite";
+import { InfluencePrerequisite } from "./single/InfluencePrerequisite";
+import { PactPrerequisite } from "./single/PactPrerequisite";
+import { PrimaryAttributePrerequisite } from "./single/PrimaryAttributePrerequisite";
+import { PublicationPrerequisite } from "./single/PublicationPrerequisite";
+import { RacePrerequisite } from "./single/RacePrerequisite";
+import { RatedMinimumNumberPrerequisite, RatedPrerequisite, RatedSetPrerequisite } from "./single/RatedPrerequisite";
+import { RulePrerequisite } from "./single/RulePrerequisite";
+import { SexPrerequisite } from "./single/SexPrerequisite";
+import { SocialStatusPrerequisite } from "./single/SocialStatusPrerequisite";
+import { StatePrerequisite } from "./single/StatePrerequisite";
+import { TextPrerequisite } from "./single/TextPrerequisite";
+import { BlessedTraditionPrerequisite, MagicalTraditionPrerequisite } from "./single/TraditionPrerequisite";
+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;

package/lib/types/prerequisites/PrerequisiteGroups.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,95 @@
+import { ActivatableIdentifier, RequirableSelectOptionIdentifier } from "../../_Identifier";
+import { Preconditions } from "../ConditionalPrerequisites";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific advantage, disadvantage or special ability.
+ * @title Activatable Prerequisite
+ */
+export declare type ActivatablePrerequisite = {
+    tag: "Activatable";
+    /**
+     * The activatable entry's identifier.
+     */
+    id: ActivatableIdentifier;
+    /**
+     * If the required entry should be required to be active or inactive.
+     */
+    active: boolean;
+    /**
+     * The required minimum level of the entry.
+     * @integer
+     * @minimum 1
+     */
+    level?: number;
+    /**
+     * Required select options. Order is important. Typically, you only need the
+     * first array index, though.
+     * @minItems 1
+     */
+    options?: RequirableSelectOptionIdentifier[];
+    display_option?: DisplayOption;
+    when?: Preconditions;
+};
+/**
+ * Requires a specific advantage, disadvantage or special ability from a given
+ * set of entries.
+ * @title Activatable Set Prerequisite
+ */
+export declare type ActivatableSetPrerequisite = {
+    tag: "ActivatableSet";
+    /**
+     * The possible activatable entries' identifiers.
+     * @minItems 2
+     */
+    id: ActivatableIdentifier[];
+    /**
+     * If the required entry should be required to be active or inactive.
+     */
+    active: boolean;
+    /**
+     * The required minimum level of the entry.
+     * @integer
+     * @minimum 1
+     */
+    level?: number;
+    /**
+     * Required select options. Order is important. Typically, you only need the
+     * first array index, though.
+     * @minItems 1
+     */
+    options?: RequirableSelectOptionIdentifier[];
+    display_option?: DisplayOption;
+};
+/**
+ * Requires one option from a set of options from a specific advantage,
+ * disadvantage or special ability.
+ * @title Activatable Option Set Prerequisite
+ */
+export declare type ActivatableOptionSetPrerequisite = {
+    tag: "ActivatableOptionSet";
+    /**
+     * The activatable entry's identifier.
+     */
+    id: ActivatableIdentifier;
+    /**
+     * If the required entry should be required to be active or inactive.
+     */
+    active: boolean;
+    /**
+     * The required minimum level of the entry.
+     * @integer
+     * @minimum 1
+     */
+    level?: number;
+    /**
+     * The possible set of first options.
+     * @minItems 2
+     */
+    first_option: RequirableSelectOptionIdentifier[];
+    /**
+     * Required other select options. Order is important.
+     * @minItems 1
+     */
+    other_options?: RequirableSelectOptionIdentifier[];
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/ActivatablePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,28 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific animist power to be on a minimum value.
+ * @title Animist Power Prerequisite
+ */
+export declare type AnimistPowerPrerequisite = {
+    tag: "AnimistPower";
+    /**
+     * The animist power's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The level to which the minimum value applies.
+     * @integer
+     * @minimum 2
+     * @default 1
+     */
+    level?: number;
+    /**
+     * The required minimum value.
+     * @integer
+     * @minimum 0
+     */
+    value: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/AnimistPowerPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+export declare type CommonSuggestedByRCPPrerequisite = {
+    tag: "CommonSuggestedByRCP";
+};

package/lib/types/prerequisites/single/CommonSuggestedByRCPPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { OneOrManyNumericIdentifiers } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific culture or one of a specific set of cultures.
+ * @title Culture Prerequisite
+ */
+export declare type CulturePrerequisite = {
+    tag: "Culture";
+    id: OneOrManyNumericIdentifiers;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/CulturePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,36 @@
+import { SkillWithEnhancementsIdentifier } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific enhancement from a skill. This should **not** be used
+ * for enhancements themselves; they can only require enhancements from the same
+ * skill they enhance.
+ * @title External Enhancement Prerequisite
+ */
+export declare type ExternalEnhancementPrerequisite = {
+    tag: "Enhancement";
+    /**
+     * The required skill's identifier.
+     */
+    skill_id: SkillWithEnhancementsIdentifier;
+    /**
+     * The required enhancement's identifier.
+     * @integer
+     * @minimum 1
+     */
+    enhancement_id: number;
+    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";
+    /**
+     * The enhancement's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};

package/lib/types/prerequisites/single/EnhancementPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,18 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @title Influence Prerequisite
+ */
+export declare type InfluencePrerequisite = {
+    tag: "Influence";
+    /**
+     * The influence's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * If the referenced influence must or must not be chosen.
+     */
+    active: boolean;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/InfluencePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,32 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific pact.
+ * @title Pact Prerequisite
+ */
+export declare type PactPrerequisite = {
+    tag: "Pact";
+    /**
+     * The required pact category's identifier.
+     * @integer
+     * @minimum 1
+     */
+    category_id: number;
+    /**
+     * The required domains' identifiers.
+     */
+    domain_id?: DomainId[];
+    /**
+     * The required pact level.
+     * @integer
+     * @minimum 1
+     */
+    level?: number;
+    display_option?: DisplayOption;
+};
+/**
+ * A domain's identifier.
+ * @integer
+ * @minimum 1
+ */
+declare type DomainId = number;
+export {};

package/lib/types/prerequisites/single/PactPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,22 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @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";
+    };
+    /**
+     * Required value of the attribute
+     * @integer
+     * @minimum 9
+     */
+    value: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/PrimaryAttributePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @title Publication Prerequisite
+ */
+export declare type PublicationPrerequisite = {
+    tag: "Publication";
+    /**
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/PublicationPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,14 @@
+import { OneOrManyNumericIdentifiers } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific race or one of a specific set of races. You can also
+ * provide an object to say whether the hero must meet one of the races or
+ * if the entry does not allow one of the races.
+ * @title Race Prerequisite
+ */
+export declare type RacePrerequisite = {
+    tag: "Culture";
+    id: OneOrManyNumericIdentifiers;
+    active: boolean;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RacePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,99 @@
+import { RatedIdentifier } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @title Rated Prerequisite
+ */
+export declare type RatedPrerequisite = {
+    tag: "Rated";
+    /**
+     * The rated entry's identifier.
+     */
+    id: RatedIdentifier;
+    /**
+     * The required minimum value.
+     * @integer
+     * @minimum 0
+     */
+    value: number;
+    display_option?: DisplayOption;
+};
+/**
+ * @title Rated Set Prerequisite
+ */
+export declare type RatedSetPrerequisite = {
+    tag: "RatedSet";
+    /**
+     * The possible rated entries' identifiers.
+     * @minItems 2
+     */
+    id: RatedIdentifier[];
+    /**
+     * The required minimum value.
+     * @integer
+     * @minimum 0
+     */
+    value: number;
+    display_option?: DisplayOption;
+};
+/**
+ * @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.
+     * @integer
+     * @minimum 1
+     */
+    number: number;
+    /**
+     * The minimum skill rating the defined minimum number of skills need to be
+     * on.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * 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;
+        };
+    };
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RatedPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,10 @@
+import { ExtensionRuleIdentifier } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @title Rule Prerequisite
+ */
+export declare type RulePrerequisite = {
+    tag: "Rule";
+    id: ExtensionRuleIdentifier;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RulePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { BinarySex } from "../../_Sex";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific sex.
+ * @title Sex Prerequisite
+ */
+export declare type SexPrerequisite = {
+    tag: "Sex";
+    id: BinarySex;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/SexPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,16 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a minimum social status.
+ * @title Social Status Prerequisite
+ */
+export declare type SocialStatusPrerequisite = {
+    tag: "SocialStatus";
+    /**
+     * The minimum social status' identifier.
+     * @integer
+     * @minimum 2
+     * @maximum 5
+     */
+    id: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/SocialStatusPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { OneOrManyNumericIdentifiers } from "../../_Identifier";
+import { DisplayOption } from "../DisplayOption";
+/**
+ * Requires a specific state or one of a specific set of states.
+ * @title State Prerequisite
+ */
+export declare type StatePrerequisite = {
+    tag: "Culture";
+    id: OneOrManyNumericIdentifiers;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/StatePrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,31 @@
+/**
+ * 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
+ */
+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";
+    };
+    /**
+     * 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;
+    };
+};

package/lib/types/prerequisites/single/TextPrerequisite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,33 @@
+import { DisplayOption } from "../DisplayOption";
+/**
+ * @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";
+    };
+    display_option?: DisplayOption;
+};
+/**
+ * @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";
+    };
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/TraditionPrerequisite.js

@@ -0,0 +1 @@
+export {};