optolith-database-schema 0.11.4 → 0.11.6

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * @main Animal
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Cost, DefaultItemTranslation } from "./_Item.js";
+export type Animal = {
+    /**
+     * 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 config: TypeConfig<Animal>;

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

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

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

@@ -0,0 +1,49 @@
+/**
+ * @main AnimalCare
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Cost, DefaultItemTranslation, FixedCost, Weight } from "./_Item.js";
+export type AnimalCare = {
+    /**
+     * Values depending on whether the animal care is feed.
+     */
+    type: AnimalCareType;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DefaultItemTranslation>;
+};
+/**
+ * Values depending on whether the animal care is feed.
+ */
+export type AnimalCareType = {
+    tag: "General";
+    general: GeneralAnimalCare;
+} | {
+    tag: "Feed";
+    feed: AnimalFeed;
+};
+export type GeneralAnimalCare = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+};
+export type AnimalFeed = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: AnimalFeedCost;
+};
+export type AnimalFeedCost = {
+    tag: "PerWeek";
+    per_week: FixedCost;
+};
+export declare const config: TypeConfig<AnimalCare>;

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

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

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

@@ -0,0 +1,186 @@
+/**
+ * @main Armor
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { ArmorReference } from "../../_SimpleReferences.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Complexity, Cost, Weight } from "./_Item.js";
+export type Armor = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+    /**
+     * The complexity of crafting the item.
+     */
+    complexity: Complexity;
+    /**
+     * The PRO value.
+     */
+    protection: Protection;
+    /**
+     * The ENC value.
+     */
+    encumbrance: Encumbrance;
+    /**
+     * Does the armor have additional penalties (MOV -1, INI -1)?
+     */
+    has_additional_penalties: HasAdditionalPenalties;
+    /**
+     * The armor type.
+     */
+    armor_type: ArmorType;
+    /**
+     * Specify if armor is only available for a specific hit zone.
+     */
+    hit_zone?: HitZone;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ArmorTranslation>;
+};
+/**
+ * @minProperties 1
+ */
+export type ArmorTranslation = {
+    /**
+     * 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 armor advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The armor disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export type SecondaryArmor = {
+    /**
+     * The PRO value.
+     */
+    protection: Protection;
+    /**
+     * The ENC value.
+     */
+    encumbrance: Encumbrance;
+    /**
+     * Does the armor have additional penalties (MOV -1, INI -1)?
+     */
+    has_additional_penalties: HasAdditionalPenalties;
+    /**
+     * The armor type.
+     */
+    armor_type: ArmorType;
+    /**
+     * Specify if armor is only available for a specific hit zone.
+     */
+    hit_zone?: HitZone;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<SecondaryArmorTranslation>;
+};
+/**
+ * @minProperties 1
+ */
+export type SecondaryArmorTranslation = {
+    /**
+     * The armor advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The armor disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+};
+/**
+ * The PRO value.
+ * @integer
+ * @minimum 0
+ */
+export type Protection = number;
+/**
+ * The ENC value.
+ * @integer
+ * @minimum 0
+ */
+export type Encumbrance = number;
+/**
+ * Does the armor have additional penalties (MOV -1, INI -1)?
+ */
+export type HasAdditionalPenalties = boolean;
+/**
+ * The armor type.
+ * @title Armor Type
+ */
+export type ArmorType = {
+    /**
+     * The armor type's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 10
+     */
+    id: number;
+};
+/**
+ * Specify if armor is only available for a specific hit zone.
+ * @title Hit Zone
+ */
+export type HitZone = {
+    tag: "Head";
+    head: HeadHitZone;
+} | {
+    tag: "Torso";
+    torso: {};
+} | {
+    tag: "Arms";
+    arms: {};
+} | {
+    tag: "Legs";
+    legs: {};
+};
+export type HeadHitZone = {
+    /**
+     * In some cases, multiple armors for the same hit zone can be combined.
+     * They're listed at the item that can be combined with others.
+     */
+    combination_possibilities?: HeadHitZoneCombinationPossibilities;
+};
+export type HeadHitZoneCombinationPossibilities = {
+    /**
+     * A list of armors that can be combined with this armor.
+     * @minItems 1
+     */
+    armors: ArmorReference[];
+    /**
+     * The PRO value that is added to the PRO value of the other armor instead
+     * of adding the normale PRO value.
+     * @integer
+     * @minimum 0
+     */
+    protection?: number;
+};
+export declare const config: TypeConfig<Armor>;

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

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

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

@@ -0,0 +1,37 @@
+/**
+ * @main BandageOrRemedy
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js";
+export 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 config: TypeConfig<BandageOrRemedy>;

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

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

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

@@ -0,0 +1,61 @@
+/**
+ * @main Book
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Complexity, Cost, StructurePoints, Weight } from "./_Item.js";
+export type Book = {
+    /**
+     * 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;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<BookTranslation>;
+};
+export type BookTranslation = {
+    /**
+     * The name of the item.
+     */
+    name: NonEmptyString;
+    /**
+     * An auxiliary name or label of the item, if available.
+     */
+    secondary_name?: NonEmptyString;
+    /**
+     * The language the book is written in.
+     */
+    language: NonEmptyString;
+    /**
+     * The script that was used for the book.
+     */
+    script: NonEmptyString;
+    /**
+     * Note text.
+     */
+    note?: NonEmptyMarkdown;
+    /**
+     * Special rules text.
+     */
+    rules?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Book>;

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

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

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

@@ -0,0 +1,42 @@
+/**
+ * @main CeremonialItem
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { BlessedTraditionReference } from "../../_SimpleReferences.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { CombatUse, Complexity, Cost, DefaultItemTranslation, StructurePoints, Weight } from "./_Item.js";
+export 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 config: TypeConfig<CeremonialItem>;

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,76 @@
+/**
+ * @main Elixir
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LaboratoryLevel, RecipeTradeSecret } from "./_Herbary.js";
+export type Elixir = {
+    /**
+     * The elixir's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * 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;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ElixirTranslation>;
+};
+export type ElixirTranslation = {
+    /**
+     * The name of the elixir.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * A list of typical ingredients.
+     * @minItems 1
+     * @uniqueItems
+     */
+    typical_ingredients: NonEmptyString[];
+    /**
+     * Prerequsites for the brewing process, if any.
+     */
+    brewing_process_prerequisites?: NonEmptyMarkdown;
+    /**
+     * The list of effects for each quality level. The first element
+     * represents QL 1, the second element QL 2, and so on.
+     */
+    quality_levels: [
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown
+    ];
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Elixir>;

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

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

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

@@ -0,0 +1,29 @@
+/**
+ * @main EquipmentOfBlessedOnes
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { BlessedTraditionReference } from "../../_SimpleReferences.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Cost, DefaultItemTranslation, StructurePoints } from "./_Item.js";
+export type EquipmentOfBlessedOnes = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * 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[];
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DefaultItemTranslation>;
+};
+export declare const config: TypeConfig<EquipmentOfBlessedOnes>;

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

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