optolith-database-schema 0.3.0 → 0.4.0

package/lib/types/_Activatable.d.ts

@@ -233,22 +233,19 @@ export declare type Effect = NonEmptyMarkdown;
 /**
  * The definition of how the combat special ability can be used in combat.
  */
-export declare type CombatSpecialAbilityUsageType = {
-    tag: "Passive";
-} | {
-    tag: "BasicManeuver";
-} | {
-    tag: "SpecialManeuver";
-};
+export declare enum CombatSpecialAbilityUsageType {
+    Passive = "Passive",
+    BasicManeuver = "BasicManeuver",
+    SpecialManeuver = "SpecialManeuver"
+}
 /**
  * The definition of if the combat special ability can be used when armed or
  * when unarmed.
  */
-export declare type CombatSpecialAbilityType = {
-    tag: "Armed";
-} | {
-    tag: "Unarmed";
-};
+export declare enum CombatSpecialAbilityType {
+    Armed = "Armed",
+    Unarmed = "Unarmed"
+}
 /**
  * Registers new skill applications, which get enabled once this entry is
  * activated. It specifies an entry-unique identifier and the skill it belongs
@@ -367,6 +364,7 @@ export declare type Penalty = {
     by_attack: PenaltyByAttack;
 } | {
     tag: "DependsOnHitZone";
+    depends_on_hit_zone: {};
 };
 export declare type SinglePenalty = {
     /**
@@ -512,9 +510,9 @@ export declare type PenaltyByAttackOrderItem = {
  * Set if a predefined different word should be used instead of the word
  * `attack` for display purposes.
  */
-export declare type PenaltyByAttackReplacement = {
-    tag: "Throw";
-};
+export declare enum PenaltyByAttackReplacement {
+    Throw = "Throw"
+}
 export declare type EnchantmentCost = {
     tag: "ArcaneEnergyCost";
     arcane_energy_cost: ArcaneEnergyCost;
@@ -545,6 +543,7 @@ export declare type ArcaneEnergyCost = {
     none?: NoArcaneEnergyCost;
 } | {
     tag: "Variable";
+    variable: {};
 };
 export declare type FixedArcaneEnergyCost = {
     /**
@@ -579,11 +578,10 @@ export declare type FixedArcaneEnergyCost = {
  * in a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1
  * AE for level I; 2 AE for level II`).
  */
-export declare type FixedArcaneEnergyCostPerLevel = {
-    tag: "Compressed";
-} | {
-    tag: "Verbose";
-};
+export declare enum FixedArcaneEnergyCostPerLevel {
+    Compressed = "Compressed",
+    Verbose = "Verbose"
+}
 /**
  * @minProperties 1
  */
@@ -650,11 +648,10 @@ export declare type IndefiniteArcaneEnergyCost = {
 /**
  * Defines how the the `value` is set off against the check result.
  */
-export declare type IndefiniteArcaneEnergyCostArithmetic = {
-    tag: "Add";
-} | {
-    tag: "Subtract";
-};
+export declare enum IndefiniteArcaneEnergyCostArithmetic {
+    Add = "Add",
+    Subtract = "Subtract"
+}
 export declare type IndefiniteArcaneEnergyCostModifier = {
     /**
      * The arithmetic how to apply the `value` to the `base`.
@@ -1020,6 +1017,7 @@ export declare type BindingCostMapOptionTranslation = {
  */
 export declare type Property = {
     tag: "DependingOnSelection";
+    depending_on_selection: {};
 } | {
     tag: "Fixed";
     fixed: PropertyReference;
@@ -1113,8 +1111,10 @@ export declare type AdvancedSpecialAbilities = [
 ];
 export declare type ApplicableCombatTechniques = {
     tag: "None";
+    none: {};
 } | {
     tag: "DependingOnCombatStyle";
+    depending_on_combat_style: {};
 } | {
     tag: "All";
     all: AllApplicableCombatTechniques;
@@ -1161,10 +1161,13 @@ export declare type SpecificApplicableCombatTechnique = {
 };
 export declare type ApplicableAllCombatTechniquesRestriction = {
     tag: "Improvised";
+    improvised: {};
 } | {
     tag: "PointedBlade";
+    pointed_blade: {};
 } | {
     tag: "Mount";
+    mount: {};
 } | {
     tag: "Race";
     race: ApplicableCombatTechniquesRaceRestriction;
@@ -1174,16 +1177,22 @@ export declare type ApplicableAllCombatTechniquesRestriction = {
 };
 export declare type ApplicableCloseCombatTechniquesRestriction = {
     tag: "Improvised";
+    improvised: {};
 } | {
     tag: "PointedBlade";
+    pointed_blade: {};
 } | {
     tag: "Mount";
+    mount: {};
 } | {
     tag: "HasParry";
+    has_parry: {};
 } | {
     tag: "OneHanded";
+    one_handed: {};
 } | {
     tag: "ParryingWeapon";
+    parrying_weapon: {};
 } | {
     tag: "Race";
     race: ApplicableCombatTechniquesRaceRestriction;
@@ -1193,10 +1202,13 @@ export declare type ApplicableCloseCombatTechniquesRestriction = {
 };
 export declare type ApplicableRangedCombatTechniquesRestriction = {
     tag: "Improvised";
+    improvised: {};
 } | {
     tag: "PointedBlade";
+    pointed_blade: {};
 } | {
     tag: "Mount";
+    mount: {};
 } | {
     tag: "Race";
     race: ApplicableCombatTechniquesRaceRestriction;
@@ -1206,10 +1218,13 @@ export declare type ApplicableRangedCombatTechniquesRestriction = {
 };
 export declare type ApplicableSpecificCombatTechniquesRestriction = {
     tag: "Improvised";
+    improvised: {};
 } | {
     tag: "PointedBlade";
+    pointed_blade: {};
 } | {
     tag: "Mount";
+    mount: {};
 } | {
     tag: "Race";
     race: ApplicableCombatTechniquesRaceRestriction;
@@ -1253,6 +1268,7 @@ export declare type AdventurePointsValue = {
     by_level: AdventurePointsValueByLevel;
 } | {
     tag: "Indefinite";
+    indefinite: {};
 };
 /**
  * A fixed adventure points value. If the entry has levels, this is the cost per

package/lib/types/_Activatable.js

@@ -2,7 +2,50 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
-export {};
+/**
+ * The definition of how the combat special ability can be used in combat.
+ */
+export var CombatSpecialAbilityUsageType;
+(function (CombatSpecialAbilityUsageType) {
+    CombatSpecialAbilityUsageType["Passive"] = "Passive";
+    CombatSpecialAbilityUsageType["BasicManeuver"] = "BasicManeuver";
+    CombatSpecialAbilityUsageType["SpecialManeuver"] = "SpecialManeuver";
+})(CombatSpecialAbilityUsageType || (CombatSpecialAbilityUsageType = {}));
+/**
+ * The definition of if the combat special ability can be used when armed or
+ * when unarmed.
+ */
+export var CombatSpecialAbilityType;
+(function (CombatSpecialAbilityType) {
+    CombatSpecialAbilityType["Armed"] = "Armed";
+    CombatSpecialAbilityType["Unarmed"] = "Unarmed";
+})(CombatSpecialAbilityType || (CombatSpecialAbilityType = {}));
+/**
+ * Set if a predefined different word should be used instead of the word
+ * `attack` for display purposes.
+ */
+export var PenaltyByAttackReplacement;
+(function (PenaltyByAttackReplacement) {
+    PenaltyByAttackReplacement["Throw"] = "Throw";
+})(PenaltyByAttackReplacement || (PenaltyByAttackReplacement = {}));
+/**
+ * The AE cost are per level of the enchantment. It may either be displayed
+ * in a compressed way (e.g. `1 AE per level`) or in a verbose way (e.g. `1
+ * AE for level I; 2 AE for level II`).
+ */
+export var FixedArcaneEnergyCostPerLevel;
+(function (FixedArcaneEnergyCostPerLevel) {
+    FixedArcaneEnergyCostPerLevel["Compressed"] = "Compressed";
+    FixedArcaneEnergyCostPerLevel["Verbose"] = "Verbose";
+})(FixedArcaneEnergyCostPerLevel || (FixedArcaneEnergyCostPerLevel = {}));
+/**
+ * Defines how the the `value` is set off against the check result.
+ */
+export var IndefiniteArcaneEnergyCostArithmetic;
+(function (IndefiniteArcaneEnergyCostArithmetic) {
+    IndefiniteArcaneEnergyCostArithmetic["Add"] = "Add";
+    IndefiniteArcaneEnergyCostArithmetic["Subtract"] = "Subtract";
+})(IndefiniteArcaneEnergyCostArithmetic || (IndefiniteArcaneEnergyCostArithmetic = {}));
 // "Input": {
 //   "description": "A string that is used as a placeholder text for an input field.",
 //   "type": "string",

package/lib/types/_ActivatableSelectOptionCategory.d.ts

@@ -3,24 +3,34 @@ import { LocaleMap } from "./_LocaleMap.js";
 import { CeremonyReference, CloseCombatTechniqueReference, ElementReference, LiturgicalChantReference, RangedCombatTechniqueReference, RitualReference, SkillGroupReference, SpellReference } from "./_SimpleReferences.js";
 export declare type SelectOptionCategory = {
     tag: "Blessings";
+    blessings: {};
 } | {
     tag: "Cantrips";
+    cantrips: {};
 } | {
     tag: "TradeSecrets";
+    trade_secrets: {};
 } | {
     tag: "Scripts";
+    scripts: {};
 } | {
     tag: "AnimalShapes";
+    animal_shapes: {};
 } | {
     tag: "ArcaneBardTraditions";
+    arcane_bard_traditions: {};
 } | {
     tag: "ArcaneDancerTraditions";
+    arcane_dancer_traditions: {};
 } | {
     tag: "SexPractices";
+    sex_practices: {};
 } | {
     tag: "Races";
+    races: {};
 } | {
     tag: "Cultures";
+    cultures: {};
 } | {
     tag: "BlessedTraditions";
     blessed_traditions: BlessedTraditionsSelectOptionCategory;
@@ -143,23 +153,20 @@ export declare type SkillsSelectOptionCategory = {
 };
 export declare type SkillsSelectOptionCategoryCategory = {
     tag: "Skills";
-    skills?: SkillSelectOptionCategoryCategory;
+    skills: SkillSelectOptionCategoryCategory;
 } | {
     tag: "Spells";
-    spells?: GenericSkillsSelectOptionCategoryCategory<SpellReference>;
+    spells: GenericSkillsSelectOptionCategoryCategory<SpellReference>;
 } | {
     tag: "Rituals";
-    rituals?: GenericSkillsSelectOptionCategoryCategory<RitualReference>;
+    rituals: GenericSkillsSelectOptionCategoryCategory<RitualReference>;
 } | {
     tag: "LiturgicalChants";
-    liturgical_chants?: GenericSkillsSelectOptionCategoryCategory<LiturgicalChantReference>;
+    liturgical_chants: GenericSkillsSelectOptionCategoryCategory<LiturgicalChantReference>;
 } | {
     tag: "Ceremonies";
-    ceremonies?: GenericSkillsSelectOptionCategoryCategory<CeremonyReference>;
+    ceremonies: GenericSkillsSelectOptionCategoryCategory<CeremonyReference>;
 };
-/**
- * @minProperties 1
- */
 export declare type SkillSelectOptionCategoryCategory = {
     /**
      * Only include entries of the specified groups.
@@ -208,10 +215,10 @@ export declare type CombatTechniquesSelectOptionCategory = {
 };
 export declare type CombatTechniquesSelectOptionCategoryCategory = {
     tag: "CloseCombatTechniques";
-    close_combat_techniques?: GenericSkillsSelectOptionCategoryCategory<CloseCombatTechniqueReference>;
+    close_combat_techniques: GenericSkillsSelectOptionCategoryCategory<CloseCombatTechniqueReference>;
 } | {
     tag: "RangedCombatTechniques";
-    ranged_combat_techniques?: GenericSkillsSelectOptionCategoryCategory<RangedCombatTechniqueReference>;
+    ranged_combat_techniques: GenericSkillsSelectOptionCategoryCategory<RangedCombatTechniqueReference>;
 };
 export declare type SkillApplicationOrUse = {
     /**
@@ -233,9 +240,6 @@ export declare type SkillApplicationOrUseTranslation = {
      */
     name: string;
 };
-/**
- * @minProperties 1
- */
 export declare type GenericSkillsSelectOptionCategoryCategory<Ref> = {
     /**
      * Only include (`Intersection`) or exclude (`Difference`) specific entries.
@@ -259,11 +263,10 @@ export declare type SpecificFromSkillSelectOptionCategoryCategory<Ref> = {
 /**
  * Only include (`Intersection`) or exclude (`Difference`) specific entries.
  */
-export declare type SpecificFromSkillSelectOptionCategoryCategoryOperation = {
-    tag: "Intersection";
-} | {
-    tag: "Difference";
-};
+export declare enum SpecificFromSkillSelectOptionCategoryCategoryOperation {
+    Intersection = "Intersection",
+    Difference = "Difference"
+}
 export declare type SkillSelectOptionCategoryPrerequisite = {
     tag: "Self";
     self: SelfPrerequisite;

package/lib/types/_ActivatableSelectOptionCategory.js

@@ -1 +1,8 @@
-export {};
+/**
+ * Only include (`Intersection`) or exclude (`Difference`) specific entries.
+ */
+export var SpecificFromSkillSelectOptionCategoryCategoryOperation;
+(function (SpecificFromSkillSelectOptionCategoryCategoryOperation) {
+    SpecificFromSkillSelectOptionCategoryCategoryOperation["Intersection"] = "Intersection";
+    SpecificFromSkillSelectOptionCategoryCategoryOperation["Difference"] = "Difference";
+})(SpecificFromSkillSelectOptionCategoryCategoryOperation || (SpecificFromSkillSelectOptionCategoryCategoryOperation = {}));

package/lib/types/_ActivatableSkillCheckResultBased.d.ts

@@ -1,19 +1,17 @@
 /**
  * Defines the derived (unitless) value.
  */
-export declare type CheckResultValue = {
-    tag: "QualityLevels";
-} | {
-    tag: "SkillPoints";
-};
+export declare enum CheckResultValue {
+    QualityLevels = "QualityLevels",
+    SkillPoints = "SkillPoints"
+}
 /**
  * Defines how the the `value` is set off against the check result.
  */
-export declare type CheckResultArithmetic = {
-    tag: "Multiply";
-} | {
-    tag: "Divide";
-};
+export declare enum CheckResultArithmetic {
+    Multiply = "Multiply",
+    Divide = "Divide"
+}
 export declare type CheckResultBasedModifier = {
     /**
      * The arithmetic how to apply the `value` to the `base`.

package/lib/types/_ActivatableSkillCheckResultBased.js

@@ -1 +1,16 @@
-export {};
+/**
+ * Defines the derived (unitless) value.
+ */
+export var CheckResultValue;
+(function (CheckResultValue) {
+    CheckResultValue["QualityLevels"] = "QualityLevels";
+    CheckResultValue["SkillPoints"] = "SkillPoints";
+})(CheckResultValue || (CheckResultValue = {}));
+/**
+ * Defines how the the `value` is set off against the check result.
+ */
+export var CheckResultArithmetic;
+(function (CheckResultArithmetic) {
+    CheckResultArithmetic["Multiply"] = "Multiply";
+    CheckResultArithmetic["Divide"] = "Divide";
+})(CheckResultArithmetic || (CheckResultArithmetic = {}));

package/lib/types/_ActivatableSkillRange.d.ts

@@ -13,13 +13,17 @@ export declare type RangeValue = {
     modifiable: ModifiableRange;
 } | {
     tag: "Sight";
+    sight: {};
 } | {
     tag: "Self";
-} | {
-    /**
-     * German: *dereumfassend*
-     */
+    self: {};
+}
+/**
+ * German: *dereumfassend*
+ */
+ | {
     tag: "Global";
+    global: {};
 } | {
     tag: "Fixed";
     fixed: FixedRange;

package/lib/types/_ActivatableSkillTargetCategory.d.ts

@@ -23,12 +23,16 @@ export declare type SpecificTargetCategoryTranslation = {
 };
 export declare type TargetCategoryIdentifier = {
     tag: "Self";
+    self: {};
 } | {
     tag: "Zone";
+    zone: {};
 } | {
     tag: "LiturgicalChantsAndCeremonies";
+    liturgical_chants_and_ceremonies: {};
 } | {
     tag: "Cantrips";
+    cantrips: {};
 } | {
     tag: "Predefined";
     predefined: TargetCategoryReference;

package/lib/types/_DiseasePoison.d.ts

@@ -11,13 +11,11 @@ import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
  * disease roll. It may also happen that the lower of both is applied as a
  * penalty.
  */
-export declare type Resistance = {
-    tag: "Spirit";
-} | {
-    tag: "Toughness";
-} | {
-    tag: "LowerOfSpiritAndToughness";
-};
+export declare enum Resistance {
+    Spirit = "Spirit",
+    Toughness = "Toughness",
+    LowerOfSpiritAndToughness = "LowerOfSpiritAndToughness"
+}
 /**
  * What causes the disease? The GM rolls 1D20 to see if a character gets
  * infected. If the infection check succeeds, the GM makes a disease check to

package/lib/types/_DiseasePoison.js

@@ -2,4 +2,14 @@
  * This file defines some shared types for different diseases and poisons.
  * @title Disease (shared)
  */
-export {};
+/**
+ * Depending on the disease, apply Spirit or Toughness as a penalty to the
+ * disease roll. It may also happen that the lower of both is applied as a
+ * penalty.
+ */
+export var Resistance;
+(function (Resistance) {
+    Resistance["Spirit"] = "Spirit";
+    Resistance["Toughness"] = "Toughness";
+    Resistance["LowerOfSpiritAndToughness"] = "LowerOfSpiritAndToughness";
+})(Resistance || (Resistance = {}));

package/lib/types/_Sex.d.ts

@@ -4,8 +4,7 @@
 /**
  * @title Binary Sex
  */
-export declare type BinarySex = {
-    tag: "Male";
-} | {
-    tag: "Female";
-};
+export declare enum BinarySex {
+    Male = "Male",
+    Female = "Female"
+}

package/lib/types/_Sex.js

@@ -1,4 +1,11 @@
 /**
  * @main BinarySex
  */
-export {};
+/**
+ * @title Binary Sex
+ */
+export var BinarySex;
+(function (BinarySex) {
+    BinarySex["Male"] = "Male";
+    BinarySex["Female"] = "Female";
+})(BinarySex || (BinarySex = {}));

package/lib/types/_SkillCheck.d.ts

@@ -12,12 +12,9 @@ export declare type SkillCheck = [
  * A specific value that represents a penalty for the associated skill check.
  * @title Skill Check Penalty
  */
-export declare type SkillCheckPenalty = {
-    tag: "SPI";
-} | {
-    tag: "SPI/2";
-} | {
-    tag: "TOU";
-} | {
-    tag: "SPI/TOU";
-};
+export declare enum SkillCheckPenalty {
+    Spirit = "Spirit",
+    HalfOfSpirit = "HalfOfSpirit",
+    Toughness = "Toughness",
+    HigherOfSpiritAndToughness = "HigherOfSpiritAndToughness"
+}

package/lib/types/_SkillCheck.js

@@ -1 +1,11 @@
-export {};
+/**
+ * A specific value that represents a penalty for the associated skill check.
+ * @title Skill Check Penalty
+ */
+export var SkillCheckPenalty;
+(function (SkillCheckPenalty) {
+    SkillCheckPenalty["Spirit"] = "Spirit";
+    SkillCheckPenalty["HalfOfSpirit"] = "HalfOfSpirit";
+    SkillCheckPenalty["Toughness"] = "Toughness";
+    SkillCheckPenalty["HigherOfSpiritAndToughness"] = "HigherOfSpiritAndToughness";
+})(SkillCheckPenalty || (SkillCheckPenalty = {}));

package/lib/types/_Spellwork.d.ts

@@ -6,6 +6,7 @@ import { MagicalTraditionIdentifier } from "./_Identifier.js";
  */
 export declare type Traditions = {
     tag: "General";
+    general: {};
 } | {
     tag: "Specific";
     specific: SpecificTraditions;

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

@@ -150,17 +150,17 @@ export declare type ArmorType = {
  */
 export declare type HitZone = {
     tag: "Head";
-    head?: HeadHitZone;
+    head: HeadHitZone;
 } | {
     tag: "Torso";
+    torso: {};
 } | {
     tag: "Arms";
+    arms: {};
 } | {
     tag: "Legs";
+    legs: {};
 };
-/**
- * @minProperties 1
- */
 export declare type HeadHitZone = {
     /**
      * In some cases, multiple armors for the same hit zone can be combined.

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

@@ -1,6 +1,36 @@
 /**
  * @main BandageOrRemedy
  */
-import { DefaultItem } from "./_Item.js";
-export declare type BandageOrRemedy = DefaultItem;
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js";
+export declare type BandageOrRemedy = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+    /**
+     * The complexity of crafting the item.
+     */
+    complexity?: Complexity;
+    /**
+     * The structure points of the item. Use an array if the item consists of
+     * multiple components that have individual structure points.
+     */
+    structure_points?: StructurePoints;
+    /**
+     * The item can also be used either as an improvised weapon or as an armor,
+     * although this is not the primary use case of the item.
+     */
+    combat_use?: CombatUse;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DefaultItemTranslation>;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<BandageOrRemedy>;

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

@@ -1,6 +1,41 @@
 /**
  * @main CeremonialItem
  */
-import { DefaultItem } from "./_Item.js";
-export declare type CeremonialItem = DefaultItem;
-export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { BlessedTraditionReference } from "../../_SimpleReferences.js";
+import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js";
+export declare type CeremonialItem = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+    /**
+     * The complexity of crafting the item.
+     */
+    complexity?: Complexity;
+    /**
+     * The structure points of the item. Use an array if the item consists of
+     * multiple components that have individual structure points.
+     */
+    structure_points: StructurePoints;
+    /**
+     * The deity associated with the equipment item.
+     */
+    associated_tradition: BlessedTraditionReference;
+    /**
+     * The item can also be used either as an improvised weapon or as an armor,
+     * although this is not the primary use case of the item.
+     */
+    combat_use?: CombatUse;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DefaultItemTranslation>;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<CeremonialItem>;