optolith-database-schema 0.11.4 → 0.11.7

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

@@ -0,0 +1,166 @@
+/**
+ * @main Weapon
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { BlessedTraditionReference, CultureReference, MagicalTraditionReference, RaceReference } from "../../_SimpleReferences.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js";
+import { MeleeWeapon } from "./_MeleeWeapon.js";
+import { RangedWeapon } from "./_RangedWeapon.js";
+export type Weapon = {
+    /**
+     * 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;
+    /**
+     * A list of stat blocks for each combat technique this weapon can be used
+     * with.
+     * @minItems 1
+     */
+    uses: WeaponUse[];
+    /**
+     * If the weapon is sanctified by a god and thus restricted to it's Blessed
+     * Ones.
+     */
+    sanctified_by?: SanctifiedBy;
+    /**
+     * Define if during character creation this weapon can only be bought by
+     * characters of a specific race or culture.
+     */
+    restricted_to_cultures?: RestrictedToCultures;
+    /**
+     * Define if during character creation this weapon can only be bought by
+     * characters of specific magical or blessed traditions.
+     * @minItems 1
+     */
+    restricted_to_traditions?: MagicalTraditionReference[];
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<WeaponTranslation>;
+};
+export type WeaponTranslation = {
+    /**
+     * The name of the item.
+     */
+    name: NonEmptyString;
+    /**
+     * An auxiliary name or label of the item, if available.
+     */
+    secondary_name?: NonEmptyString;
+    /**
+     * Note text.
+     */
+    note?: NonEmptyMarkdown;
+    /**
+     * Special rules text.
+     */
+    rules?: NonEmptyMarkdown;
+    /**
+     * The weapon advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The weapon disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export type SecondaryWeapon = {
+    /**
+     * A list of stat blocks for each combat technique this weapon can be used
+     * with.
+     * @minItems 1
+     */
+    uses: WeaponUse[];
+    /**
+     * If the weapon is sanctified by a god and thus restricted to it's Blessed
+     * Ones.
+     */
+    sanctified_by?: SanctifiedBy;
+    /**
+     * Define if during character creation this weapon can only be bought by
+     * characters of a specific race or culture.
+     */
+    restricted_to_cultures?: RestrictedToCultures;
+    /**
+     * Define if during character creation this weapon can only be bought by
+     * characters of specific magical or blessed traditions.
+     * @minItems 1
+     */
+    restricted_to_traditions?: MagicalTraditionReference[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<ImprovisedWeaponTranslation>;
+};
+/**
+ * @minProperties 1
+ */
+export type ImprovisedWeaponTranslation = {
+    /**
+     * The weapon advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The weapon disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+};
+export type WeaponUse = {
+    /**
+     * An increasing integer for use identification.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    values: WeaponUseValues;
+};
+export type WeaponUseValues = {
+    tag: "Melee";
+    melee: MeleeWeapon;
+} | {
+    tag: "Ranged";
+    ranged: RangedWeapon;
+};
+/**
+ * If the weapon is sanctified by a god and thus restricted to it's Blessed
+ * Ones.
+ * @minItems 1
+ */
+export type SanctifiedBy = BlessedTraditionReference[];
+/**
+ * Define if during character creation this weapon can only be bought by
+ * characters of a specific race or culture.
+ */
+export type RestrictedToCultures = {
+    tag: "CulturesOfRace";
+    cultures_of_race: RaceReference;
+} | {
+    tag: "Cultures";
+    cultures: RestrictedToSpecificCultures;
+};
+export type RestrictedToSpecificCultures = {
+    /**
+     * @minitems 1
+     */
+    list: CultureReference[];
+};
+export declare const config: TypeConfig<Weapon>;

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

@@ -0,0 +1,12 @@
+/**
+ * @main Weapon
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "Weapon",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Weapon"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,7 @@
+/**
+ * @main WeaponAccessory
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { DefaultItem } from "./_Item.js";
+export type WeaponAccessory = DefaultItem;
+export declare const config: TypeConfig<WeaponAccessory>;

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

@@ -0,0 +1,12 @@
+/**
+ * @main WeaponAccessory
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "WeaponAccessory",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("WeaponAccessory"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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 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 || (EffectType = {}));
+export var LaboratoryLevel;
+(function (LaboratoryLevel) {
+    LaboratoryLevel["ArchaicLaboratory"] = "ArchaicLaboratory";
+    LaboratoryLevel["WitchKitchen"] = "WitchKitchen";
+    LaboratoryLevel["AlchemistsLaboratory"] = "AlchemistsLaboratory";
+})(LaboratoryLevel = LaboratoryLevel || (LaboratoryLevel = {}));

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

@@ -0,0 +1,160 @@
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { SecondaryArmor } from "./Armor.js";
+import { SecondaryWeapon } from "./Weapon.js";
+export type DefaultItem = {
+    /**
+     * 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>;
+};
+/**
+ * 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.
+ */
+export type CombatUse = {
+    tag: "Weapon";
+    weapon: SecondaryWeapon;
+} | {
+    tag: "Armor";
+    armor: SecondaryArmor;
+};
+export type DefaultItemTranslation = {
+    /**
+     * The name of the item.
+     */
+    name: NonEmptyString;
+    /**
+     * An auxiliary name or label of the item, if available.
+     */
+    secondary_name?: NonEmptyString;
+    /**
+     * Note text.
+     */
+    note?: NonEmptyMarkdown;
+    /**
+     * Special rules text.
+     */
+    rules?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+/**
+ * The structure points of the item. Use an array if the item consists of
+ * multiple components that have individual structure points.
+ * @title Structure Points
+ * @minItems 1
+ */
+export type StructurePoints = StructurePointsComponent[];
+export type StructurePointsComponent = {
+    /**
+     * The structure points.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+};
+/**
+ * The cost in silverthalers.
+ */
+export type Cost = {
+    tag: "Free";
+    free: {};
+} | {
+    tag: "Various";
+    various: {};
+} | {
+    tag: "Invaluable";
+    invaluable: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedCost;
+} | {
+    tag: "Range";
+    range: CostRange;
+};
+export type FixedCost = {
+    /**
+     * The cost in silverthalers.
+     * @exclusiveMinimum 0
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<CostTranslation>;
+};
+export type CostRange = {
+    /**
+     * The lower bound of the cost in silverthalers.
+     * @exclusiveMinimum 0
+     */
+    from: number;
+    /**
+     * The upper bound of the cost in silverthalers.
+     * @exclusiveMinimum 0
+     */
+    to: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<CostTranslation>;
+};
+export type CostTranslation = {
+    /**
+     * The cost get wrapped by this text using a placeholder in the text.
+     * @minLength 1
+     * @pattern \{0\}
+     */
+    wrap_in_text: string;
+};
+/**
+ * The weight in kg.
+ * @exclusiveMinimum 0
+ */
+export type Weight = number;
+/**
+ * The complexity of crafting the item.
+ */
+export type Complexity = {
+    tag: "Primitive";
+    primitive: {};
+} | {
+    tag: "Simple";
+    simple: {};
+} | {
+    tag: "Complex";
+    complex: ComplexComplexity;
+};
+export type ComplexComplexity = {
+    /**
+     * The AP value for the trade secret.
+     * @integer
+     * @minimum 1
+     */
+    ap_value: number;
+};

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

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

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

@@ -0,0 +1,108 @@
+/**
+ * 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";
+/**
+ * The AT modifier.
+ * @integer
+ */
+export type AttackModifier = number;
+/**
+ * The PA modifier.
+ * @integer
+ */
+export type ParryModifier = number;
+/**
+ * The reach of the weapon.
+ */
+export type Reach = ReachIdentifier;
+/**
+ * The damage of a weapon consists of a random part using dice and an optional
+ * flat part.
+ */
+export type MeleeDamage = {
+    /**
+     * How many dice of which type are rolled to get the damage.
+     */
+    dice: Dice;
+    /**
+     * Flat damage, if any. It gets added to the result of the dice rolls.
+     * @integer
+     * @default 0
+     */
+    flat?: number;
+};
+/**
+ * The shield size and potential size-depending values.
+ */
+export type ShieldSize = {
+    tag: "Small";
+    small: {};
+} | {
+    tag: "Medium";
+    medium: {};
+} | {
+    tag: "Large";
+    large?: LargeShieldSize;
+};
+export type LargeShieldSize = {
+    /**
+     * The attack penalty from the shield.
+     * @integer
+     * @default 1
+     */
+    attack_penalty: number;
+};
+/**
+ * @title Melee Weapon
+ */
+export type MeleeWeapon = {
+    /**
+     * The combat techniques and dependent values.
+     */
+    combat_technique: CloseCombatTechniqueReference;
+    /**
+     * The damage of a weapon consists of a random part using dice and an optional
+     * flat part.
+     */
+    damage: MeleeDamage;
+    /**
+     * The primary attribute damage and threshold value.
+     */
+    damage_threshold?: PrimaryAttributeDamageThreshold;
+    /**
+     * The AT modifier.
+     */
+    at: AttackModifier;
+    /**
+     * The PA modifier.
+     */
+    pa?: ParryModifier;
+    /**
+     * The reach of the weapon.
+     */
+    reach?: Reach;
+    /**
+     * The length of the weapon in cm/halffingers.
+     */
+    length?: Length;
+    /**
+     * The shield size and potential size-depending values.
+     */
+    size?: ShieldSize;
+    /**
+     * Is the weapon a parrying weapon?
+     */
+    is_parrying_weapon: boolean;
+    /**
+     * Is the weapon a two-handed weapon?
+     */
+    is_two_handed_weapon: boolean;
+    /**
+     * Is the weapon an improvised weapon?
+     */
+    is_improvised_weapon: boolean;
+};

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

@@ -0,0 +1,4 @@
+/**
+ * Auxiliary types for melee weapons.
+ */
+export {};

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

@@ -0,0 +1,109 @@
+/**
+ * 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";
+/**
+ * The damage of a ranged weapon. It consists of a random part using dice and an
+ * optional flat part ny default. Some ranged weapons may work different so that
+ * damage is either not applicable at all or it is outlined as *Special* and
+ * further defined in a description.
+ */
+export type RangedDamage = {
+    tag: "Default";
+    default: DefaultRangedDamage;
+} | {
+    tag: "NotApplicable";
+    not_applicable: {};
+} | {
+    tag: "Special";
+    special: {};
+};
+/**
+ * The damage of a weapon consists of a random part using dice and an optional
+ * flat part.
+ */
+export type DefaultRangedDamage = {
+    /**
+     * How many dice of which type are rolled to get the damage.
+     */
+    dice: Dice;
+    /**
+     * Flat damage, if any. It gets added to the result of the dice rolls.
+     * @integer
+     * @default 0
+     */
+    flat?: number;
+};
+/**
+ * @title Ranged Weapon
+ */
+export type RangedWeapon = {
+    /**
+     * The combat techniques and dependent values.
+     */
+    combat_technique: RangedCombatTechniqueReference;
+    /**
+     * The damage of a weapon consists of a random part using dice and an optional
+     * flat part.
+     */
+    damage: RangedDamage;
+    /**
+     * One or multiple reload times.
+     * @minItems 1
+     * @uniqueItems
+     */
+    reload_time: ReloadTime[];
+    /**
+     * The range brackets for the weapon: close, medium, far. Distances in m.
+     */
+    range: Range;
+    /**
+     * The needed ammunition.
+     */
+    ammunition?: AmmunitionReference;
+    /**
+     * The length of the weapon in cm/halffingers.
+     */
+    length: Length;
+    /**
+     * Is the weapon an improvised weapon?
+     */
+    is_improvised_weapon: boolean;
+};
+export type AmmunitionReference = {
+    /**
+     * The item's identifier.
+     */
+    id: AmmunitionIdentifier;
+};
+export type Range = {
+    /**
+     * The close range bracket for the weapon. Distance in m.
+     * @integer
+     * @minimum 1
+     */
+    close: number;
+    /**
+     * The medium range bracket for the weapon. Distance in m.
+     * @integer
+     * @minimum 1
+     */
+    medium: number;
+    /**
+     * The far range bracket for the weapon. Distance in m.
+     * @integer
+     * @minimum 1
+     */
+    far: number;
+};
+export type ReloadTime = {
+    /**
+     * A reload time value in actions.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};

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

@@ -0,0 +1,4 @@
+/**
+ * Auxiliary types for ranged weapons.
+ */
+export {};

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

@@ -0,0 +1,57 @@
+import { AttributeReference } from "../../_SimpleReferences.js";
+/**
+ * The primary attribute damage and threshold value. You can either use an
+ * integer, an object or a pair. Use an integer if you just have to define a
+ * single threshold value for the default primary attribute of the combat
+ * technique. Use an object if you need to define the value only or if you need
+ * to define the value as well as a single different primary attribute than
+ * which the combat technique uses. Use the pair if you need to set the primary
+ * attributes to AGI and STR (the combat technique has AGI but this item has
+ * AGI/STR) and/or if you need to set different thresholds for AGI and STR (e.g.
+ * AGI 14/STR 15). If the same values are in the pair, they will be merged (AGI
+ * 14/STR 14 will be AGI/STR 14).
+ * @minItems 1
+ * @uniqueItems
+ */
+export type PrimaryAttributeDamageThreshold = {
+    tag: "Default";
+    default: DefaultPrimaryAttributeDamageThreshold;
+} | {
+    tag: "List";
+    list: PrimaryAttributeDamageThresholdList;
+};
+export type DefaultPrimaryAttributeDamageThreshold = {
+    /**
+     * The attribute value representing the damage threshold for the primary
+     * attribute of the item's combat technique.
+     * @integer
+     * @minimum 1
+     */
+    threshold: number;
+};
+export type PrimaryAttributeDamageThresholdList = {
+    /**
+     * A list of primary attributes with their associated threshold.
+     * @minItems 1
+     * @uniqueItems
+     */
+    list: SinglePrimaryAttributeDamageThreshold[];
+};
+export type SinglePrimaryAttributeDamageThreshold = {
+    /**
+     * The primary attribute.
+     */
+    attribute: AttributeReference;
+    /**
+     * The attribute value representing the damage threshold.
+     * @integer
+     * @minimum 1
+     */
+    threshold: number;
+};
+/**
+ * The length of the weapon in cm/halffingers.
+ * @integer
+ * @minimum 1
+ */
+export type Length = number;