optolith-database-schema 0.2.2 → 0.3.0

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

@@ -0,0 +1,39 @@
+/**
+ * @main MagicalArtifact
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { Cost } from "./_Item.js";
+export declare type MagicalArtifact = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<MagicalArtifactTranslation>;
+};
+export declare type MagicalArtifactTranslation = {
+    /**
+     * 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;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<MagicalArtifact>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main MagicalArtifact
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,27 @@
+/**
+ * @main MusicalInstrument
+ */
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { Complexity, Cost, DefaultItemTranslation, StructurePoints } from "./_Item.js";
+export declare type MusicalInstrument = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * 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;
+    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<MusicalInstrument>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main MusicalInstrument
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main OrienteeringAid
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type OrienteeringAid = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main OrienteeringAid
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,163 @@
+/**
+ * @main Poison
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { Reduceable, Resistance } from "../../_DiseasePoison.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+/**
+ * @title Poison
+ */
+export declare type Poison = {
+    /**
+     * The poison's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The poison's level.
+     * @integer
+     * @minimum 1
+     */
+    level: PoisonLevel;
+    /**
+     * The poison's application type(s).
+     * @minItems 1
+     * @uniqueItems
+     */
+    application_type: PoisonApplicationType[];
+    /**
+     * The poison's source type and dependent additional values.
+     */
+    source_type: PoisonSourceType;
+    /**
+     * Use Spirit or Toughness as a modifier for the poison.
+     */
+    resistance: Resistance;
+    /**
+     * The raw (ingredients) value, in silverthalers.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * Price for one dose, in silverthalers.
+     * @integer
+     * @minimum 1
+     */
+    cost: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PoisonTranslation>;
+};
+export declare type PoisonLevel = {
+    tag: "QualityLevel";
+} | {
+    tag: "Fixed";
+    fixed: FixedPoisonLevel;
+};
+export declare type FixedPoisonLevel = {
+    /**
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+export declare type PoisonApplicationType = {
+    tag: "Weapon";
+} | {
+    tag: "Ingestion";
+} | {
+    tag: "Inhalation";
+} | {
+    tag: "Contact";
+};
+export declare type PoisonSourceType = {
+    tag: "AnimalVenom";
+} | {
+    tag: "AlchemicalPoison";
+} | {
+    tag: "MineralPoison";
+} | {
+    tag: "PlantPoison";
+    plant_poison: PlantPoison;
+};
+export declare type PlantPoison = {
+    /**
+     * The plant poison category and dependent additional values.
+     */
+    category: PlantPoisonCategory;
+};
+export declare type PlantPoisonCategory = {
+    tag: "Default";
+} | {
+    tag: "Intoxicant";
+    intoxicant: Intoxicant;
+};
+export declare type Intoxicant = {
+    /**
+     * Whether the use of the intoxicant is legal or not.
+     */
+    legality: IntoxicantLegality;
+    /**
+     * All translations for the entry, identified by IETF language tag
+     * (BCP47).
+     */
+    translations: LocaleMap<IntoxicantTranslation>;
+};
+export declare type IntoxicantLegality = {
+    is_legal: boolean;
+};
+export declare type IntoxicantTranslation = {
+    /**
+     * How to ingest the intoxicant.
+     */
+    ingestion: NonEmptyString;
+    /**
+     * The intoxicants side effects, if any.
+     */
+    side_effect?: NonEmptyMarkdown;
+    /**
+     * What happens if the intoxicant has been overdosed.
+     */
+    overdose: NonEmptyMarkdown;
+    /**
+     *
+     */
+    special?: NonEmptyMarkdown;
+    /**
+     *
+     */
+    addiction?: NonEmptyMarkdown;
+};
+export declare type PoisonTranslation = {
+    /**
+     * The name of the poison.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * 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/{Poison.js → equipment/item/Poison.js}

@@ -1,5 +1,5 @@
 /**
  * @main Poison
  */
-import { validateSchemaCreator } from "../validation/schema.js";
+import { validateSchemaCreator } from "../../../validation/schema.js";
 export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main RopeOrChain
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type RopeOrChain = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main RopeOrChain
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main Stationary
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type Stationary = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main Stationary
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main ThievesTool
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type ThievesTool = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main ThievesTool
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,56 @@
+/**
+ * @main ToolOfTheTrade
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js";
+export declare type ToolOfTheTrade = {
+    /**
+     * 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;
+    /**
+     * If the item is a laboratory.
+     */
+    is_laboratory: boolean;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ToolOfTheTradeTranslation>;
+};
+export declare type ToolOfTheTradeTranslation = {
+    /**
+     * 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;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<ToolOfTheTrade>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main ToolOfTheTrade
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main TravelGearOrTool
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type TravelGearOrTool = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main TravelGearOrTool
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,18 @@
+/**
+ * @main Vehicle
+ */
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { Cost, DefaultItemTranslation } from "./_Item.js";
+export declare type Vehicle = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    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<Vehicle>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main Vehicle
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,152 @@
+/**
+ * @main Weapon
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { BlessedTraditionReference, CultureReference, RaceReference } from "../../_SimpleReferences.js";
+import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js";
+import { MeleeWeapon } from "./_MeleeWeapon.js";
+import { RangedWeapon } from "./_RangedWeapon.js";
+export declare 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;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<WeaponTranslation>;
+};
+export declare 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 declare type ImprovisedWeapon = {
+    /**
+     * 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;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<ImprovisedWeaponTranslation>;
+};
+/**
+ * @minProperties 1
+ */
+export declare type ImprovisedWeaponTranslation = {
+    /**
+     * The weapon advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The weapon disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+};
+export declare type WeaponUse = {
+    /**
+     * An increasing integer for use identification.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    values: WeaponUseValues;
+};
+export declare 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.
+ */
+export declare type SanctifiedBy = BlessedTraditionReference;
+/**
+ * Define if during character creation this weapon can only be bought by
+ * characters of a specific race or culture.
+ */
+export declare type RestrictedToCultures = {
+    tag: "CulturesOfRace";
+    cultures_of_race: RaceReference;
+} | {
+    tag: "Cultures";
+    cultures: RestrictedToSpecificCultures;
+};
+export declare type RestrictedToSpecificCultures = {
+    /**
+     * @minitems 1
+     */
+    list: CultureReference[];
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Weapon>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main Weapon
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -0,0 +1,6 @@
+/**
+ * @main WeaponAccessory
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type WeaponAccessory = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

@@ -0,0 +1,5 @@
+/**
+ * @main WeaponAccessory
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);