optolith-database-schema 0.4.0 → 0.5.0

package/lib/types/equipment/item/Poison.d.ts

@@ -4,9 +4,11 @@
 import { Errata } from "../../source/_Erratum.js";
 import { PublicationRefs } from "../../source/_PublicationRef.js";
 import { AlternativeName } from "../../_AlternativeNames.js";
+import { Dice } from "../../_Dice.js";
 import { Reduceable, Resistance } from "../../_DiseasePoison.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { EffectType, LaboratoryLevel, RecipeTradeSecret } from "./_Herbary.js";
 /**
  * @title Poison
  */
@@ -17,12 +19,6 @@ export declare type Poison = {
      * @minimum 1
      */
     id: number;
-    /**
-     * The poison's level.
-     * @integer
-     * @minimum 1
-     */
-    level: PoisonLevel;
     /**
      * The poison's application type(s).
      * @minItems 1
@@ -37,6 +33,14 @@ export declare type Poison = {
      * Use Spirit or Toughness as a modifier for the poison.
      */
     resistance: Resistance;
+    /**
+     * When the poison takes effect.
+     */
+    start: PoisonStart;
+    /**
+     * The normal and degraded poison's duration.
+     */
+    duration: Reduceable<PoisonDuration>;
     /**
      * The raw (ingredients) value, in silverthalers.
      * @integer
@@ -55,87 +59,265 @@ export declare type Poison = {
      */
     translations: LocaleMap<PoisonTranslation>;
 };
-export declare type PoisonLevel = {
-    tag: "QualityLevel";
-    quality_level: {};
-} | {
-    tag: "Fixed";
-    fixed: FixedPoisonLevel;
-};
-export declare type FixedPoisonLevel = {
-    /**
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-};
 export declare enum PoisonApplicationType {
     Weapon = "Weapon",
     Ingestion = "Ingestion",
     Inhalation = "Inhalation",
     Contact = "Contact"
 }
+export declare type PoisonStart = {
+    tag: "Immediate";
+    immediate: {};
+} | {
+    tag: "Constant";
+    constant: ConstantPoisonTime;
+} | {
+    tag: "DiceBased";
+    dice_based: DiceBasedPoisonTime;
+};
+export declare type PoisonDuration = {
+    tag: "Constant";
+    constant: ConstantPoisonTime;
+} | {
+    tag: "DiceBased";
+    dice_based: DiceBasedPoisonTime;
+};
+export declare type ConstantPoisonTime = {
+    value: number;
+    unit: PoisonTimeUnit;
+};
+export declare type DiceBasedPoisonTime = {
+    dice: Dice;
+    unit: PoisonTimeUnit;
+};
+export declare enum PoisonTimeUnit {
+    CombatRounds = "CombatRounds",
+    Minutes = "Minutes",
+    Hours = "Hours"
+}
 export declare type PoisonSourceType = {
     tag: "AnimalVenom";
-    animal_venom: {};
+    animal_venom: AnimalVenom;
 } | {
     tag: "AlchemicalPoison";
-    alchemical_poison: {};
+    alchemical_poison: AlchemicalPoison;
 } | {
     tag: "MineralPoison";
-    mineral_poison: {};
+    mineral_poison: MineralPoison;
 } | {
     tag: "PlantPoison";
     plant_poison: PlantPoison;
+} | {
+    tag: "DemonicPoison";
+    demonic_poison: DemonicPoison;
+};
+export declare type AnimalVenom = {
+    /**
+     * The poison’s level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    level: number;
+};
+export declare type AlchemicalPoison = {
+    /**
+     * Effect type(s) of an alchemical poison.
+     * @minItems 1
+     * @uniqueItems
+     */
+    effect_types: EffectType[];
+    /**
+     * The cost per ingredient level in silverthalers.
+     */
+    cost_per_ingredient_level: number;
+    /**
+     * The laboratory level needed to brew the elixir.
+     */
+    laboratory: LaboratoryLevel;
+    /**
+     * The brewing difficulty, which represents the challenge of creating an
+     * elixir.
+     * @integer
+     */
+    brewing_difficulty: number;
+    /**
+     * AP value and prerequisites of the elixir recipe’s trade secret.
+     */
+    trade_secret: RecipeTradeSecret;
+    /**
+     * Additional information if the poison is an intoxicant.
+     */
+    intoxicant?: Intoxicant;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AlchemicalPoisonTranslation>;
+};
+export declare type AlchemicalPoisonTranslation = {
+    /**
+     * A list of common ingredients.
+     * @minItems 1
+     * @uniqueItems
+     */
+    common_ingredients: NonEmptyString[];
+    /**
+     * Prerequsites for the brewing process, if any.
+     */
+    brewing_process_prerequisites?: NonEmptyMarkdown;
+};
+export declare type MineralPoison = {
+    /**
+     * The poison’s level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    level: number;
 };
 export declare type PlantPoison = {
     /**
-     * The plant poison category and dependent additional values.
+     * Effect type(s) of a plant poison.
+     * @minItems 1
+     * @uniqueItems
+     */
+    effect_types: EffectType[];
+    /**
+     * The poison’s level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    level: number;
+    /**
+     * Additional information if the poison is an intoxicant.
      */
-    category: PlantPoisonCategory;
+    intoxicant?: Intoxicant;
 };
-export declare type PlantPoisonCategory = {
-    tag: "Default";
-    default: {};
+export declare type DemonicPoison = {
+    /**
+     * The poison’s level.
+     */
+    level: DemonicPoisonLevel;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<DemonicPoisonTranslation>;
+};
+export declare type DemonicPoisonLevel = {
+    tag: "QualityLevel";
+    quality_level: QualityLevelDemonicPoisonLevel;
 } | {
-    tag: "Intoxicant";
-    intoxicant: Intoxicant;
+    tag: "Constant";
+    constant: ConstantDemonicPoisonLevel;
+};
+export declare type QualityLevelDemonicPoisonLevel = {
+    source: QualityLevelDemonicPoisonLevelSource;
+};
+export declare enum QualityLevelDemonicPoisonLevelSource {
+    Spellwork = "Spellwork"
+}
+export declare type ConstantDemonicPoisonLevel = {
+    /**
+     * The poison’s level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    value: number;
+};
+/**
+ * @minProperties 1
+ */
+export declare type DemonicPoisonTranslation = {
+    /**
+     * A note, if any.
+     */
+    note?: NonEmptyMarkdown;
 };
 export declare type Intoxicant = {
     /**
-     * Whether the use of the intoxicant is legal or not.
+     * Whether the use of the intoxicant is legal or not, usually from the
+     * perspective of most middle-Aventurian an northern-Aventurian nations.
      */
     legality: IntoxicantLegality;
+    /**
+     * The chance of getting addicted after an ingestion in addition to the
+     * maximum interval at which it, while addicted, must be ingested to not
+     * suffer from withdrawal symptoms.
+     */
+    addiction?: IntoxicantAddiction;
     /**
      * All translations for the entry, identified by IETF language tag
      * (BCP47).
      */
     translations: LocaleMap<IntoxicantTranslation>;
 };
+/**
+ * Whether the use of the intoxicant is legal or not, usually from the
+ * perspective of most middle-Aventurian an northern-Aventurian nations.
+ */
 export declare type IntoxicantLegality = {
     is_legal: boolean;
 };
+/**
+ * The chance of getting addicted after an ingestion in addition to the maximum
+ * interval at which it, while addicted, must be ingested to not suffer from
+ * withdrawal symptoms.
+ */
+export declare type IntoxicantAddiction = {
+    /**
+     * The chance of getting addicted after an ingestion.
+     */
+    chance: number;
+    /**
+     * The maximum interval at which it, while addicted, must be ingested to not
+     * suffer from withdrawal symptoms.
+     */
+    interval: IntoxicantAddictionInterval;
+};
+/**
+ * The maximum interval at which it, while addicted, must be ingested to not
+ * suffer from withdrawal symptoms.
+ */
+export declare type IntoxicantAddictionInterval = {
+    tag: "Constant";
+    constant: ConstantIntoxicantAddictionInterval;
+} | {
+    tag: "DiceBased";
+    dice_based: DiceBasedIntoxicantAddictionInterval;
+};
+export declare type ConstantIntoxicantAddictionInterval = {
+    /**
+     * The interval value in days.
+     */
+    value: number;
+};
+export declare type DiceBasedIntoxicantAddictionInterval = {
+    /**
+     * The dice that define the interval value in days.
+     */
+    dice: Dice;
+};
 export declare type IntoxicantTranslation = {
     /**
      * How to ingest the intoxicant.
      */
     ingestion: NonEmptyString;
     /**
-     * The intoxicants side effects, if any.
+     * The intoxicants side effects that always happen, no matter whether the
+     * intoxicant has the default or the reduced effect.
      */
     side_effect?: NonEmptyMarkdown;
     /**
-     * What happens if the intoxicant has been overdosed.
+     * What happens if the intoxicant has been overdosed, that is, it has been
+     * ingested another time within the duration.
      */
     overdose: NonEmptyMarkdown;
     /**
-     *
+     * Special information about the intoxicant.
      */
     special?: NonEmptyMarkdown;
-    /**
-     *
-     */
-    addiction?: NonEmptyMarkdown;
 };
 export declare type PoisonTranslation = {
     /**
@@ -151,15 +333,6 @@ export declare type PoisonTranslation = {
      * The normal and degraded poison's effects.
      */
     effect: Reduceable;
-    /**
-     * When the poison takes effect.
-     * @minLength 1
-     */
-    start: string;
-    /**
-     * The normal and degraded poison's duration.
-     */
-    duration: Reduceable;
     errata?: Errata;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Poison>;

package/lib/types/equipment/item/Poison.js

@@ -9,4 +9,14 @@ export var PoisonApplicationType;
     PoisonApplicationType["Inhalation"] = "Inhalation";
     PoisonApplicationType["Contact"] = "Contact";
 })(PoisonApplicationType || (PoisonApplicationType = {}));
+export var PoisonTimeUnit;
+(function (PoisonTimeUnit) {
+    PoisonTimeUnit["CombatRounds"] = "CombatRounds";
+    PoisonTimeUnit["Minutes"] = "Minutes";
+    PoisonTimeUnit["Hours"] = "Hours";
+})(PoisonTimeUnit || (PoisonTimeUnit = {}));
+export var QualityLevelDemonicPoisonLevelSource;
+(function (QualityLevelDemonicPoisonLevelSource) {
+    QualityLevelDemonicPoisonLevelSource["Spellwork"] = "Spellwork";
+})(QualityLevelDemonicPoisonLevelSource || (QualityLevelDemonicPoisonLevelSource = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/equipment/item/ToolOfTheTrade.d.ts

@@ -5,6 +5,7 @@ import { Errata } from "../../source/_Erratum.js";
 import { PublicationRefs } from "../../source/_PublicationRef.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { LaboratoryLevel } from "./_Herbary.js";
 import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js";
 export declare type ToolOfTheTrade = {
     /**
@@ -25,15 +26,18 @@ export declare type ToolOfTheTrade = {
      */
     structure_points?: StructurePoints;
     /**
-     * If the item is a laboratory.
+     * Additional information if the item is a laboratory.
      */
-    is_laboratory: boolean;
+    laboratory?: Laboratory;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
      */
     translations: LocaleMap<ToolOfTheTradeTranslation>;
 };
+export declare type Laboratory = {
+    level: LaboratoryLevel;
+};
 export declare type ToolOfTheTradeTranslation = {
     /**
      * The name of the item.

package/lib/types/equipment/item/_Herbary.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Herbary-related types.
+ */
+import { PlainGeneralPrerequisites } from "../../_Prerequisite.js";
+/**
+ * Effect type categories of a plant or recipe.
+ */
+export declare enum EffectType {
+    Healing = "Healing",
+    Poison = "Poison",
+    PhysicalEffect = "PhysicalEffect",
+    PsychicEffect = "PsychicEffect",
+    Beneficial = "Beneficial",
+    Defensive = "Defensive",
+    Supernatural = "Supernatural"
+}
+export declare enum LaboratoryLevel {
+    ArchaicLaboratory = "ArchaicLaboratory",
+    WitchKitchen = "WitchKitchen",
+    AlchemistsLaboratory = "AlchemistsLaboratory"
+}
+export declare type RecipeTradeSecret = {
+    /**
+     * The AP value of the trade secret.
+     */
+    ap_value: number;
+    /**
+     * The prerequisites of the trade secret, if any.
+     */
+    prerequisites?: PlainGeneralPrerequisites;
+};

package/lib/types/equipment/item/_Herbary.js

@@ -0,0 +1,22 @@
+/**
+ * Herbary-related types.
+ */
+/**
+ * Effect type categories of a plant or recipe.
+ */
+export var EffectType;
+(function (EffectType) {
+    EffectType["Healing"] = "Healing";
+    EffectType["Poison"] = "Poison";
+    EffectType["PhysicalEffect"] = "PhysicalEffect";
+    EffectType["PsychicEffect"] = "PsychicEffect";
+    EffectType["Beneficial"] = "Beneficial";
+    EffectType["Defensive"] = "Defensive";
+    EffectType["Supernatural"] = "Supernatural";
+})(EffectType || (EffectType = {}));
+export var LaboratoryLevel;
+(function (LaboratoryLevel) {
+    LaboratoryLevel["ArchaicLaboratory"] = "ArchaicLaboratory";
+    LaboratoryLevel["WitchKitchen"] = "WitchKitchen";
+    LaboratoryLevel["AlchemistsLaboratory"] = "AlchemistsLaboratory";
+})(LaboratoryLevel || (LaboratoryLevel = {}));

package/lib/types/equipment/item/_MeleeWeapon.d.ts

@@ -2,6 +2,7 @@
  * Auxiliary types for melee weapons.
  */
 import { Dice } from "../../_Dice.js";
+import { ReachIdentifier } from "../../_Identifier.js";
 import { CloseCombatTechniqueReference } from "../../_SimpleReferences.js";
 import { Length, PrimaryAttributeDamageThreshold } from "./_Weapon.js";
 /**
@@ -17,15 +18,7 @@ export declare type ParryModifier = number;
 /**
  * The reach of the weapon.
  */
-export declare type Reach = {
-    /**
-     * The identifier of the weapon's reach.
-     * @integer
-     * @minimum 1
-     * @maximum 4
-     */
-    id: number;
-};
+export declare type Reach = ReachIdentifier;
 /**
  * The damage of a weapon consists of a random part using dice and an optional
  * flat part.

package/lib/types/equipment/item/_RangedWeapon.d.ts

@@ -2,6 +2,7 @@
  * Auxiliary types for ranged weapons.
  */
 import { Dice } from "../../_Dice.js";
+import { AmmunitionIdentifier } from "../../_Identifier.js";
 import { RangedCombatTechniqueReference } from "../../_SimpleReferences.js";
 import { Length } from "./_Weapon.js";
 /**
@@ -75,10 +76,8 @@ export declare type RangedWeapon = {
 export declare type AmmunitionReference = {
     /**
      * The item's identifier.
-     * @integer
-     * @minimum 1
      */
-    id: number;
+    id: AmmunitionIdentifier;
 };
 export declare type Range = {
     /**

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

@@ -41,7 +41,6 @@ export declare type AnimistPower = {
      *
      * If no tribe tradition is given, the animist power is generally available to
      * all tribe traditions.
-     * @minItems 1
      * @uniqueItems
      */
     tribe_tradition: AnimistTribeReference[];

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

@@ -5,6 +5,7 @@ import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import { CheckResultBasedDuration } from "../_ActivatableSkillDuration.js";
 import { Effect } from "../_ActivatableSkillEffect.js";
+import { CloseCombatTechniqueIdentifier } from "../_Identifier.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { NonEmptyString } from "../_NonEmptyString.js";
@@ -21,6 +22,7 @@ export declare type MagicalRune = {
      * @minimum 1
      */
     id: number;
+    option?: MagicalRuneOption;
     /**
      * Lists the linked three attributes used to make a skill check.
      */
@@ -50,6 +52,10 @@ export declare type MagicalRune = {
 export declare type MagicalRuneTranslation = {
     /**
      * The name of the magical rune.
+     *
+     * If the rune has an option, the option’s name will/should not be included in
+     * the name as well as its surrounding parenthesis. It will/should be combined
+     * on demand.
      */
     name: NonEmptyString;
     /**
@@ -112,10 +118,8 @@ export declare type MagicalRuneCloseCombatTechniqueCheckPenalty = {
 export declare type MagicalRuneCloseCombatTechniqueCheckPenaltyMapping = {
     /**
      * The close combat technique's identifier.
-     * @integer
-     * @minimum 1
      */
-    combat_technique_id: number;
+    combat_technique_id: CloseCombatTechniqueIdentifier;
     /**
      * The check modifier for the specified close combat technique.
      * @integer
@@ -205,4 +209,19 @@ export declare type MagicalRuneDuration = {
      */
     fast: CheckResultBasedDuration;
 };
+export declare type MagicalRuneOption = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalRuneOptionTranslation>;
+};
+export declare type MagicalRuneOptionTranslation = {
+    /**
+     * The name of the option.
+     *
+     * The surrounding parenthesis will/should not be included, they will/should
+     * be generated.
+     */
+    name: NonEmptyString;
+};
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalRune>;

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

@@ -1,3 +1,4 @@
+import { SkillIdentifier } from "../_Identifier.js";
 /**
  * A reference to a skill used for performing melodies.
  */
@@ -5,9 +6,9 @@ export declare type MusicalSkillReference = {
     /**
      * The skill's identifier.
      */
-    id: SkillIdentifier;
+    id: SkillIdentifier<SkillIdentifierValue>;
 };
-export declare enum SkillIdentifier {
+export declare enum SkillIdentifierValue {
     Singing = 9,
     Music = 56
 }

package/lib/types/magicalActions/_SkillReference.js

@@ -1,5 +1,5 @@
-export var SkillIdentifier;
-(function (SkillIdentifier) {
-    SkillIdentifier[SkillIdentifier["Singing"] = 9] = "Singing";
-    SkillIdentifier[SkillIdentifier["Music"] = 56] = "Music";
-})(SkillIdentifier || (SkillIdentifier = {}));
+export var SkillIdentifierValue;
+(function (SkillIdentifierValue) {
+    SkillIdentifierValue[SkillIdentifierValue["Singing"] = 9] = "Singing";
+    SkillIdentifierValue[SkillIdentifierValue["Music"] = 56] = "Music";
+})(SkillIdentifierValue || (SkillIdentifierValue = {}));

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

@@ -1,4 +1,4 @@
-import { ActivatableOptionSetPrerequisite, ActivatablePrerequisite, ActivatableSetPrerequisite } from "./single/ActivatablePrerequisite.js";
+import { ActivatablePrerequisite } from "./single/ActivatablePrerequisite.js";
 import { AnimistPowerPrerequisite } from "./single/AnimistPowerPrerequisite.js";
 import { CulturePrerequisite } from "./single/CulturePrerequisite.js";
 import { ExternalEnhancementPrerequisite, InternalEnhancementPrerequisite } from "./single/EnhancementPrerequisite.js";
@@ -7,7 +7,7 @@ import { PactPrerequisite } from "./single/PactPrerequisite.js";
 import { PrimaryAttributePrerequisite } from "./single/PrimaryAttributePrerequisite.js";
 import { PublicationPrerequisite } from "./single/PublicationPrerequisite.js";
 import { RacePrerequisite } from "./single/RacePrerequisite.js";
-import { RatedMinimumNumberPrerequisite, RatedPrerequisite, RatedSetPrerequisite } from "./single/RatedPrerequisite.js";
+import { RatedMinimumNumberPrerequisite, RatedPrerequisite } from "./single/RatedPrerequisite.js";
 import { RulePrerequisite } from "./single/RulePrerequisite.js";
 import { SexPrerequisite } from "./single/SexPrerequisite.js";
 import { SocialStatusPrerequisite } from "./single/SocialStatusPrerequisite.js";
@@ -49,12 +49,6 @@ export declare type GeneralPrerequisiteGroup = {
 } | {
     tag: "Activatable";
     activatable: ActivatablePrerequisite;
-} | {
-    tag: "ActivatableSet";
-    activatable_set: ActivatableSetPrerequisite;
-} | {
-    tag: "ActivatableOptionSet";
-    activatable_option_set: ActivatableOptionSetPrerequisite;
 } | {
     tag: "BlessedTradition";
     blessed_tradition: BlessedTraditionPrerequisite;
@@ -64,9 +58,6 @@ export declare type GeneralPrerequisiteGroup = {
 } | {
     tag: "Rated";
     rated: RatedPrerequisite;
-} | {
-    tag: "RatedSet";
-    rated_set: RatedSetPrerequisite;
 } | {
     tag: "RatedMinimumNumber";
     rated_minimum_number: RatedMinimumNumberPrerequisite;
@@ -123,12 +114,6 @@ export declare type AdvantageDisadvantagePrerequisiteGroup = {
 } | {
     tag: "Activatable";
     activatable: ActivatablePrerequisite;
-} | {
-    tag: "ActivatableSet";
-    activatable_set: ActivatableSetPrerequisite;
-} | {
-    tag: "ActivatableOptionSet";
-    activatable_option_set: ActivatableOptionSetPrerequisite;
 } | {
     tag: "BlessedTradition";
     blessed_tradition: BlessedTraditionPrerequisite;
@@ -138,9 +123,6 @@ export declare type AdvantageDisadvantagePrerequisiteGroup = {
 } | {
     tag: "Rated";
     rated: RatedPrerequisite;
-} | {
-    tag: "RatedSet";
-    rated_set: RatedSetPrerequisite;
 } | {
     tag: "RatedMinimumNumber";
     rated_minimum_number: RatedMinimumNumberPrerequisite;