optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/equipment/EquipmentPackage.d.ts

@@ -1,6 +1,9 @@
 /**
  * @main EquipmentPackage
  */
+import { EquipmentIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 /**
  * @title Equipment Package
  */
@@ -17,36 +20,29 @@ export declare type EquipmentPackage = {
      * is included in the package.
      * @minItems 2
      */
-    items: {
-        /**
-         * The item's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-        /**
-         * The number of how often the item is included in the package.
-         * @integer
-         * @minimum 2
-         * @default 1
-         */
-        number?: number;
-    }[];
+    items: EquipmentPackageItem[];
     /**
      * 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 equipment package.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<EquipmentPackageTranslation>;
+};
+export declare type EquipmentPackageItem = {
+    /**
+     * The item's identifier.
+     */
+    id: EquipmentIdentifier;
+    /**
+     * The number of how often the item is included in the package.
+     * @integer
+     * @minimum 2
+     * @default 1
+     */
+    number?: number;
+};
+export declare type EquipmentPackageTranslation = {
+    /**
+     * The name of the equipment package.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<EquipmentPackage>;

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

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

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

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

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

@@ -0,0 +1,31 @@
+/**
+ * @main Ammunition
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
+import { Cost } from "./_Item.js";
+export declare type Ammunition = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AmmunitionTranslation>;
+};
+export declare type AmmunitionTranslation = {
+    /**
+     * The name of the item.
+     */
+    name: NonEmptyString;
+    /**
+     * An auxiliary name or label of the item, if available.
+     */
+    secondary_name?: NonEmptyString;
+    errata?: Errata;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Ammunition>;

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * @main Animal
+ */
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { Cost, DefaultItemTranslation } from "./_Item.js";
+export declare 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 validateSchema: import("../../../validation/schema.js").TypeValidator<Animal>;

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

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

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

@@ -0,0 +1,48 @@
+/**
+ * @main AnimalCare
+ */
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { Cost, DefaultItemTranslation, FixedCost, Weight } from "./_Item.js";
+export declare 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 declare type AnimalCareType = {
+    tag: "General";
+    general: GeneralAnimalCare;
+} | {
+    tag: "Feed";
+    feed: AnimalFeed;
+};
+export declare type GeneralAnimalCare = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+};
+export declare type AnimalFeed = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: AnimalFeedCost;
+};
+export declare type AnimalFeedCost = {
+    tag: "PerWeek";
+    per_week: FixedCost;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalCare>;

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

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

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

@@ -0,0 +1,185 @@
+/**
+ * @main Armor
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { ArmorReference } from "../../_SimpleReferences.js";
+import { Complexity, Cost, Weight } from "./_Item.js";
+export declare 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 declare 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 declare 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 declare type SecondaryArmorTranslation = {
+    /**
+     * The armor advantage text.
+     */
+    advantage?: NonEmptyMarkdown;
+    /**
+     * The armor disadvantage text.
+     */
+    disadvantage?: NonEmptyMarkdown;
+};
+/**
+ * The PRO value.
+ * @integer
+ * @minimum 0
+ */
+export declare type Protection = number;
+/**
+ * The ENC value.
+ * @integer
+ * @minimum 0
+ */
+export declare type Encumbrance = number;
+/**
+ * Does the armor have additional penalties (MOV -1, INI -1)?
+ */
+export declare type HasAdditionalPenalties = boolean;
+/**
+ * The armor type.
+ * @title Armor Type
+ */
+export declare 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 declare type HitZone = {
+    tag: "Head";
+    head: HeadHitZone;
+} | {
+    tag: "Torso";
+    torso: {};
+} | {
+    tag: "Arms";
+    arms: {};
+} | {
+    tag: "Legs";
+    legs: {};
+};
+export declare 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 declare 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 validateSchema: import("../../../validation/schema.js").TypeValidator<Armor>;

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

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

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

@@ -0,0 +1,36 @@
+/**
+ * @main BandageOrRemedy
+ */
+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/BandageOrRemedy.js

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

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

@@ -0,0 +1,60 @@
+/**
+ * @main Book
+ */
+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 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 declare 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 validateSchema: import("../../../validation/schema.js").TypeValidator<Book>;

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

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

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

@@ -0,0 +1,41 @@
+/**
+ * @main CeremonialItem
+ */
+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>;

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,28 @@
+/**
+ * @main EquipmentOfBlessedOnes
+ */
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { BlessedTraditionReference } from "../../_SimpleReferences.js";
+import { Cost, DefaultItemTranslation, StructurePoints } from "./_Item.js";
+export declare 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 validateSchema: import("../../../validation/schema.js").TypeValidator<EquipmentOfBlessedOnes>;

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

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

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

@@ -0,0 +1,43 @@
+/**
+ * @main GemOrPreciousStone
+ */
+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 GemOrPreciousStone = {
+    /**
+     * The cost in silverthalers per 10 karat.
+     */
+    cost: Cost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<GemOrPreciousStoneTranslation>;
+};
+export declare type GemOrPreciousStoneTranslation = {
+    /**
+     * The name of the item.
+     */
+    name: NonEmptyString;
+    /**
+     * An auxiliary name or label of the item, if available.
+     */
+    secondary_name?: NonEmptyString;
+    /**
+     * The color of the gem or stone.
+     */
+    color: NonEmptyString;
+    /**
+     * Note text.
+     */
+    note?: NonEmptyMarkdown;
+    /**
+     * Special rules text.
+     */
+    rules?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<GemOrPreciousStone>;

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

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