optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/_ActivatableSkillRange.d.ts

@@ -0,0 +1,103 @@
+import { CheckResultBased } from "./_ActivatableSkillCheckResultBased.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { ResponsiveTextOptional, ResponsiveTextReplace } from "./_ResponsiveText.js";
+export declare type Range = {
+    value: RangeValue;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<RangeTranslation>;
+};
+export declare type RangeValue = {
+    tag: "Modifiable";
+    modifiable: ModifiableRange;
+} | {
+    tag: "Sight";
+} | {
+    tag: "Self";
+} | {
+    /**
+     * German: *dereumfassend*
+     */
+    tag: "Global";
+} | {
+    tag: "Fixed";
+    fixed: FixedRange;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedRange;
+};
+export declare type ModifiableRange = {
+    /**
+     * If `true`, the range is a maximum range.
+     */
+    is_maximum?: true;
+    /**
+     * The initial skill modification identifier/level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    initial_modification_level: number;
+    /**
+     * If `true`, the range is a radius.
+     */
+    is_radius?: true;
+};
+export declare type FixedRange = {
+    /**
+     * If `true`, the range is a maximum range.
+     */
+    is_maximum?: true;
+    /**
+     * The (unitless) range value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit of the `value`.
+     */
+    unit: RangeUnit;
+    /**
+     * If `true`, the range is a radius.
+     */
+    is_radius?: true;
+};
+/**
+ * Defines the range being based on a check result.
+ */
+export declare type CheckResultBasedRange = CheckResultBased & {
+    /**
+     * If the range is the maximum range.
+     */
+    is_maximum?: true;
+    /**
+     * The duration unit.
+     */
+    unit: RangeUnit;
+    /**
+     * If `true`, the range is a radius.
+     */
+    is_radius?: true;
+};
+/**
+ * @minProperties 1
+ */
+export declare type RangeTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis. If the
+     * generated is modified using `replacement`, the note is appended to
+     * the modifier string.
+     */
+    note?: ResponsiveTextOptional;
+    /**
+     * A replacement string. If `note` is provided, it is appended to the
+     * replaced string.
+     */
+    replacement?: ResponsiveTextReplace;
+};
+export declare enum RangeUnit {
+    Steps = "Steps",
+    Miles = "Miles"
+}

package/lib/types/_ActivatableSkillRange.js

@@ -0,0 +1,5 @@
+export var RangeUnit;
+(function (RangeUnit) {
+    RangeUnit["Steps"] = "Steps";
+    RangeUnit["Miles"] = "Miles";
+})(RangeUnit || (RangeUnit = {}));

package/lib/types/_ActivatableSkillTargetCategory.d.ts

@@ -0,0 +1,35 @@
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { TargetCategoryReference } from "./_SimpleReferences.js";
+/**
+ * The target category – the kind of creature or object – the skill affects.
+ *
+ * If no target categories are given, the skill applies to all target
+ * categories.
+ */
+export declare type TargetCategory = SpecificTargetCategory[];
+export declare type SpecificTargetCategory = {
+    id: TargetCategoryIdentifier;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<SpecificTargetCategoryTranslation>;
+};
+export declare type SpecificTargetCategoryTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note: NonEmptyString;
+};
+export declare type TargetCategoryIdentifier = {
+    tag: "Self";
+} | {
+    tag: "Zone";
+} | {
+    tag: "LiturgicalChantsAndCeremonies";
+} | {
+    tag: "Cantrips";
+} | {
+    tag: "Predefined";
+    predefined: TargetCategoryReference;
+};

package/lib/types/_ActivatableSkillTargetCategory.js

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

package/lib/types/_AlternativeNames.d.ts

@@ -0,0 +1,11 @@
+import { NonEmptyString } from "./_NonEmptyString.js";
+export declare type AlternativeName = {
+    /**
+     * An alternative name of the disease.
+     */
+    name: NonEmptyString;
+    /**
+     * The region where this alternative name is used.
+     */
+    region?: NonEmptyString;
+};

package/lib/types/_AlternativeNames.js

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

package/lib/types/_ArcaneTradition.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @main ArcaneTradition
+ */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { ArcaneTraditionPrerequisites } from "./_Prerequisite.js";
+/**
+ * @title Arcane Tradition
+ */
+export declare type ArcaneTradition = {
+    /**
+     * The arcane tradition's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    prerequisites: ArcaneTraditionPrerequisites;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ArcaneTraditionTranslation>;
+};
+export declare type ArcaneTraditionTranslation = {
+    /**
+     * The arcane tradition's name.
+     */
+    name: NonEmptyString;
+};

package/lib/types/_ArcaneTradition.js

@@ -0,0 +1,4 @@
+/**
+ * @main ArcaneTradition
+ */
+export {};

package/lib/types/_Blessed.d.ts

@@ -0,0 +1,22 @@
+import { AspectReference, BlessedTraditionReference } from "./_SimpleReferences.js";
+export declare type SkillTradition = {
+    tag: "GeneralAspect";
+    general_aspect: AspectReference;
+} | {
+    tag: "Tradition";
+    tradition: SkillTraditionWithAspects;
+};
+export declare type SkillTraditionWithAspects = {
+    /**
+     * The blessed tradition.
+     */
+    tradition: BlessedTraditionReference;
+    /**
+     * The aspect(s) from the tradition the ceremony belongs to. Note that not
+     * all traditions have aspects. Traditions with aspects must have at least one
+     * aspect specified.
+     * @minItems 1
+     * @maxItems 2
+     */
+    aspects?: AspectReference[];
+};

package/lib/types/_Blessed.js

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

package/lib/types/_DiseasePoison.d.ts

@@ -0,0 +1,116 @@
+/**
+ * This file defines some shared types for different diseases and poisons.
+ * @title Disease (shared)
+ */
+import { Errata } from "./source/_Erratum.js";
+import { AlternativeName } from "./_AlternativeNames.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * 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 declare type Resistance = {
+    tag: "Spirit";
+} | {
+    tag: "Toughness";
+} | {
+    tag: "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
+ * determine the severity of the infection.
+ */
+export declare type Cause = {
+    /**
+     * The chance to get infected by this cause, in percent.
+     * @integer
+     * @minimum 5
+     * @multipleOf 5
+     * @maximum 100
+     */
+    chance?: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<CauseTranslation>;
+};
+export declare type CauseTranslation = {
+    /**
+     * The name of the cause.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The chance to get infected by this cause. If present for this
+     * language, this overrides the universal `chance` field; they cannot be
+     * used at the same time.
+     */
+    chance?: NonEmptyString;
+    /**
+     * An additional note about this cause.
+     */
+    note?: NonEmptyString;
+};
+export declare type DiseaseTranslation = {
+    /**
+     * The name of the disease.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * The disease’s progress, in detail.
+     */
+    progress: NonEmptyMarkdown;
+    /**
+     * After infection, how much time passes before symptoms appear?
+     */
+    incubation_time: NonEmptyString;
+    /**
+     * The damage caused by the disease. If the disease check fails, apply the
+     * lessened effects.
+     */
+    damage: Reduceable;
+    /**
+     * The duration of the disease. If the disease check fails, use the
+     * lessened duration.
+     */
+    duration: Reduceable;
+    /**
+     * Special information about the disease.
+     */
+    special?: NonEmptyMarkdown;
+    /**
+     * Methods known to lessen the disease’s progress or relieve symptoms.
+     */
+    treatment: NonEmptyMarkdown;
+    /**
+     * Known remedies for the disease.
+     */
+    cure: NonEmptyMarkdown;
+    errata?: Errata;
+};
+/**
+ * An effect or other parameter that may be reduced by a failed disease check
+ * for lessening or a degraded poison.
+ *
+ * This streamlines the wording for diseases and poison by using a unified
+ * wording for *lessened* (disease) and *degraded* (poison).
+ */
+export declare type Reduceable = {
+    /**
+     * The default value. In the source, it's the text before the slash.
+     */
+    default: NonEmptyMarkdown;
+    /**
+     * The reduced value. In the source, it's the text after the slash. Some
+     * entries may not have a reduced value.
+     */
+    reduced?: NonEmptyMarkdown;
+};

package/lib/types/_DiseasePoison.js

@@ -0,0 +1,5 @@
+/**
+ * This file defines some shared types for different diseases and poisons.
+ * @title Disease (shared)
+ */
+export {};

package/lib/types/_Enhancements.d.ts

@@ -3,6 +3,7 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
 import { EnhancementPrerequisites } from "./_Prerequisite.js";
 /**
  * A list of enhancements.
@@ -42,25 +43,20 @@ export declare type Enhancement = {
     src?: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The name of the enhancement.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effect description.
-             * @markdown
-             * @minLength 1
-             */
-            effect: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<EnhancementTranslation>;
+};
+export declare type EnhancementTranslation = {
+    /**
+     * The name of the enhancement.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The effect description.
+     * @markdown
+     * @minLength 1
+     */
+    effect: string;
+    errata?: Errata;
 };

package/lib/types/_I18n.d.ts

@@ -1,3 +1,4 @@
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * The item can be present in multiple pluralization categories; this object
  * unifies handling of them. Not all of the options must be present, however,
@@ -31,8 +32,3 @@ export declare type PluralizationCategories = {
     many?: NonEmptyString;
     other: NonEmptyString;
 };
-/**
- * @minLength 1
- */
-declare type NonEmptyString = string;
-export {};

package/lib/types/_Identifier.d.ts

@@ -177,6 +177,37 @@ declare enum CoreRuleDerivableContentTag {
     MagicalSpecialAbility = "MagicalSpecialAbility",
     BlessedTradition = "BlessedTradition"
 }
+declare enum EquipmentTag {
+    Alchemicum = "Alchemicum",
+    Ammunition = "Ammunition",
+    Animal = "Animal",
+    AnimalCare = "AnimalCare",
+    Armor = "Armor",
+    BandageOrRemedy = "BandageOrRemedy",
+    Book = "Book",
+    CeremonialItem = "CeremonialItem",
+    Clothes = "Clothes",
+    Container = "Container",
+    EquipmentOfBlessedOnes = "EquipmentOfBlessedOnes",
+    GemOrPreciousStone = "GemOrPreciousStone",
+    HealingHerb = "HealingHerb",
+    Illumination = "Illumination",
+    Jewelry = "Jewelry",
+    Liebesspielzeug = "Liebesspielzeug",
+    LuxuryGood = "LuxuryGood",
+    MagicalArtifact = "MagicalArtifact",
+    MusicalInstrument = "MusicalInstrument",
+    OrienteeringAid = "OrienteeringAid",
+    Poison = "Poison",
+    RopeOrChain = "RopeOrChain",
+    Stationary = "Stationary",
+    ThievesTool = "ThievesTool",
+    ToolOfTheTrade = "ToolOfTheTrade",
+    TravelGearOrTool = "TravelGearOrTool",
+    Vehicle = "Vehicle",
+    Weapon = "Weapon",
+    WeaponAccessory = "WeaponAccessory"
+}
 declare type TaggedIdentifier<Tag> = {
     tag: Tag;
     /**
@@ -203,6 +234,7 @@ export declare type SpellworkIdentifier = TaggedIdentifier<SpellworkTag>;
 export declare type MagicalActionIdentifier = TaggedIdentifier<MagicalActionTag>;
 export declare type RequirableSelectOptionIdentifier = TaggedIdentifier<RequirableSelectOptionTag>;
 export declare type CoreRuleDerivableContentIdentifier = TaggedIdentifier<CoreRuleDerivableContentTag>;
+export declare type EquipmentIdentifier = TaggedIdentifier<EquipmentTag>;
 export declare type OneOrManyNumericIdentifiers = OneNumericIdentifier | ManyNumericIdentifiers;
 /**
  * @minimum 1

package/lib/types/_Identifier.js

@@ -194,4 +194,36 @@ var CoreRuleDerivableContentTag;
     CoreRuleDerivableContentTag["MagicalSpecialAbility"] = "MagicalSpecialAbility";
     CoreRuleDerivableContentTag["BlessedTradition"] = "BlessedTradition";
 })(CoreRuleDerivableContentTag || (CoreRuleDerivableContentTag = {}));
+var EquipmentTag;
+(function (EquipmentTag) {
+    EquipmentTag["Alchemicum"] = "Alchemicum";
+    EquipmentTag["Ammunition"] = "Ammunition";
+    EquipmentTag["Animal"] = "Animal";
+    EquipmentTag["AnimalCare"] = "AnimalCare";
+    EquipmentTag["Armor"] = "Armor";
+    EquipmentTag["BandageOrRemedy"] = "BandageOrRemedy";
+    EquipmentTag["Book"] = "Book";
+    EquipmentTag["CeremonialItem"] = "CeremonialItem";
+    EquipmentTag["Clothes"] = "Clothes";
+    EquipmentTag["Container"] = "Container";
+    EquipmentTag["EquipmentOfBlessedOnes"] = "EquipmentOfBlessedOnes";
+    EquipmentTag["GemOrPreciousStone"] = "GemOrPreciousStone";
+    EquipmentTag["HealingHerb"] = "HealingHerb";
+    EquipmentTag["Illumination"] = "Illumination";
+    EquipmentTag["Jewelry"] = "Jewelry";
+    EquipmentTag["Liebesspielzeug"] = "Liebesspielzeug";
+    EquipmentTag["LuxuryGood"] = "LuxuryGood";
+    EquipmentTag["MagicalArtifact"] = "MagicalArtifact";
+    EquipmentTag["MusicalInstrument"] = "MusicalInstrument";
+    EquipmentTag["OrienteeringAid"] = "OrienteeringAid";
+    EquipmentTag["Poison"] = "Poison";
+    EquipmentTag["RopeOrChain"] = "RopeOrChain";
+    EquipmentTag["Stationary"] = "Stationary";
+    EquipmentTag["ThievesTool"] = "ThievesTool";
+    EquipmentTag["ToolOfTheTrade"] = "ToolOfTheTrade";
+    EquipmentTag["TravelGearOrTool"] = "TravelGearOrTool";
+    EquipmentTag["Vehicle"] = "Vehicle";
+    EquipmentTag["Weapon"] = "Weapon";
+    EquipmentTag["WeaponAccessory"] = "WeaponAccessory";
+})(EquipmentTag || (EquipmentTag = {}));
 export {};

package/lib/types/_Influence.d.ts

@@ -3,6 +3,8 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { InfluencePrerequisites } from "./_Prerequisite.js";
 /**
  * @title Influence
@@ -18,37 +20,30 @@ export declare type Influence = {
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The influence name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effects of the influence. They should be sorted like they are in
-             * the book.
-             * @minItems 1
-             */
-            effects: {
-                /**
-                 * An optional label that is displayed and placed before the actual
-                 * text.
-                 * @minLength 1
-                 */
-                label?: string;
-                /**
-                 * The effect text.
-                 * @minLength 1
-                 */
-                text: string;
-            }[];
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<InfluenceTranslation>;
+};
+export declare type InfluenceTranslation = {
+    /**
+     * The influence name.
+     */
+    name: NonEmptyString;
+    /**
+     * The effects of the influence. They should be sorted like they are in
+     * the book.
+     * @minItems 1
+     */
+    effects: InfluenceEffect[];
+    errata?: Errata;
+};
+export declare type InfluenceEffect = {
+    /**
+     * An optional label that is displayed and placed before the actual
+     * text.
+     */
+    label?: NonEmptyString;
+    /**
+     * The effect text.
+     */
+    text: NonEmptyString;
 };

package/lib/types/_LocaleMap.d.ts

@@ -0,0 +1,10 @@
+/**
+ * All translations for the entry, identified by IETF language tag (BCP47).
+ * @minProperties 1
+ */
+export declare type LocaleMap<T> = {
+    /**
+     * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+     */
+    [localeId: string]: T;
+};

package/lib/types/_LocaleMap.js

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

package/lib/types/_NonEmptyString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @minLength 1
+ */
+export declare type NonEmptyString = string;
+/**
+ * @markdown
+ * @minLength 1
+ */
+export declare type NonEmptyMarkdown = string;

package/lib/types/_NonEmptyString.js

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