optolith-database-schema 0.2.4 → 0.4.1

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

@@ -1,308 +0,0 @@
-/**
- * @main Item
- */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-import { ArmorType, Encumbrance, HasAdditionalPenalties, HitZone, Protection } from "./_Armor.js";
-import { MeleeWeapon, RangedWeapon, RestrictedToCultures, SanctifiedBy, StructurePoints } from "./_Weapon.js";
-/**
- * @title Item
- */
-export declare type Item = {
-    /**
-     * The item's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The cost in silverthalers.
-     */
-    cost: Cost;
-    /**
-     * The weight in kg.
-     */
-    weight?: Weight;
-    /**
-     * The complexity of crafting the item.
-     */
-    complexity: Complexity;
-    type: {
-        tag: "Weapon";
-        /**
-         * @minItems 1
-         */
-        uses: (MeleeWeapon | RangedWeapon)[];
-        sanctified_by?: SanctifiedBy;
-        restricted_to_cultures?: RestrictedToCultures;
-        secondary?: {
-            type: Type;
-            structure_points: StructurePoints;
-        };
-        /**
-         * All translations for the entry, identified by IETF language tag
-         * (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                name: Name;
-                secondary_name?: SecondaryName;
-                note?: Note;
-                rules?: Rules;
-                advantage?: Advantage;
-                disadvantage?: Disadvantage;
-                errata?: Errata;
-            };
-        };
-    } | {
-        tag: "Armor";
-        protection: Protection;
-        encumbrance: Encumbrance;
-        has_additional_penalties: HasAdditionalPenalties;
-        armor_type: ArmorType;
-        hit_zone?: HitZone;
-        secondary?: {
-            type: Type;
-            structure_points: StructurePoints;
-        };
-        /**
-         * All translations for the entry, identified by IETF language tag
-         * (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                name: Name;
-                secondary_name?: SecondaryName;
-                note?: Note;
-                rules?: Rules;
-                advantage?: Advantage;
-                disadvantage?: Disadvantage;
-                errata?: Errata;
-            };
-        };
-    } | {
-        tag: "Default";
-        type: Type;
-        combat_uses: {
-            tag: "ImprovisedWeapon";
-            /**
-             * @minItems 1
-             */
-            uses: (MeleeWeapon | RangedWeapon)[];
-            sanctified_by?: SanctifiedBy;
-            restricted_to_cultures?: RestrictedToCultures;
-            /**
-             * All translations for the entry, identified by IETF language tag
-             * (BCP47).
-             * @minProperties 1
-             */
-            translations: {
-                /**
-                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-                 */
-                [localeId: string]: {
-                    advantage: Advantage;
-                    disadvantage: Disadvantage;
-                };
-            };
-        } | {
-            tag: "Armor";
-            protection: Protection;
-            encumbrance: Encumbrance;
-            has_additional_penalties: HasAdditionalPenalties;
-            armor_type: ArmorType;
-            hit_zone?: HitZone;
-            /**
-             * All translations for the entry, identified by IETF language tag
-             * (BCP47).
-             * @minProperties 1
-             */
-            translations: {
-                /**
-                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-                 */
-                [localeId: string]: {
-                    advantage: Advantage;
-                    disadvantage: Disadvantage;
-                };
-            };
-        };
-        structure_points: StructurePoints;
-        /**
-         * All translations for the entry, identified by IETF language tag
-         * (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                name: Name;
-                secondary_name?: SecondaryName;
-                note?: Note;
-                rules?: Rules;
-                errata?: Errata;
-            };
-        };
-    };
-    src: PublicationRefs;
-};
-/**
- * The name of the item.
- * @minLength 1
- */
-declare type Name = string;
-/**
- * An auxiliary name or label of the item, if available.
- * @minLength 1
- */
-declare type SecondaryName = string;
-/**
- * The cost in silverthalers.
- */
-declare type Cost = {
-    tag: "Free";
-} | {
-    tag: "Various";
-} | {
-    tag: "Fixed";
-    /**
-     * The cost in silverthalers.
-     * @exclusiveMinimum 0
-     */
-    value: number;
-    /**
-     * All translations for the entry, identified by IETF language tag
-     * (BCP47).
-     * @minProperties 1
-     */
-    translations?: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The cost get wrapped by this text using a placeholder in the text.
-             * @minLength 1
-             * @pattern \\{0\\}
-             */
-            wrap_in_text: string;
-        };
-    };
-} | {
-    tag: "Range";
-    /**
-     * 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).
-     * @minProperties 1
-     */
-    translations?: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The cost range gets wrapped by this text using a placeholder in the
-             * text.
-             * @minLength 1
-             * @pattern \\{0\\}
-             */
-            wrap_in_text: string;
-        };
-    };
-};
-/**
- * The weight in kg.
- * @exclusiveMinimum 0
- */
-declare type Weight = number;
-/**
- * The complexity of crafting the item.
- */
-declare type Complexity = {
-    tag: "Primitive";
-} | {
-    tag: "Simple";
-} | {
-    tag: "Complex";
-    /**
-     * The AP value for the trade secret.
-     * @integer
-     * @minimum 1
-     */
-    ap_value: number;
-};
-declare enum Type {
-    Ammunition = "Ammunition",
-    WeaponAccessories = "WeaponAccessories",
-    Clothes = "Clothes",
-    TravelGearAndTools = "TravelGearAndTools",
-    Illumination = "Illumination",
-    BandagesAndRemedies = "BandagesAndRemedies",
-    Containers = "Containers",
-    RopesAndChains = "RopesAndChains",
-    ThievesTools = "ThievesTools",
-    ToolsOfTheTrade = "ToolsOfTheTrade",
-    OrienteeringAids = "OrienteeringAids",
-    Jewelry = "Jewelry",
-    GemsAndPreciousStones = "GemsAndPreciousStones",
-    Stationary = "Stationary",
-    Books = "Books",
-    MagicalArtifacts = "MagicalArtifacts",
-    Alchemicae = "Alchemicae",
-    Poisons = "Poisons",
-    HealingHerbs = "HealingHerbs",
-    MusicalInstruments = "MusicalInstruments",
-    LuxuryGoods = "LuxuryGoods",
-    Animals = "Animals",
-    AnimalCare = "AnimalCare",
-    Vehicles = "Vehicles",
-    AusruestungDerGeweihtenschaft = "AusruestungDerGeweihtenschaft",
-    CeremonialItems = "CeremonialItems",
-    Liebesspielzeug = "Liebesspielzeug"
-}
-/**
- * Note text.
- * @markdown
- * @minLength 1
- */
-declare type Note = string;
-/**
- * Special rules text.
- * @markdown
- * @minLength 1
- */
-declare type Rules = string;
-/**
- * The weapon/armor advantage text.
- * @markdown
- * @minLength 1
- */
-declare type Advantage = string;
-/**
- * The weapon/armor disadvantage text.
- * @markdown
- * @minLength 1
- */
-declare type Disadvantage = string;
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Item>;
-export {};

package/lib/types/equipment/Item.js

@@ -1,35 +0,0 @@
-/**
- * @main Item
- */
-import { validateSchemaCreator } from "../../validation/schema.js";
-var Type;
-(function (Type) {
-    Type["Ammunition"] = "Ammunition";
-    Type["WeaponAccessories"] = "WeaponAccessories";
-    Type["Clothes"] = "Clothes";
-    Type["TravelGearAndTools"] = "TravelGearAndTools";
-    Type["Illumination"] = "Illumination";
-    Type["BandagesAndRemedies"] = "BandagesAndRemedies";
-    Type["Containers"] = "Containers";
-    Type["RopesAndChains"] = "RopesAndChains";
-    Type["ThievesTools"] = "ThievesTools";
-    Type["ToolsOfTheTrade"] = "ToolsOfTheTrade";
-    Type["OrienteeringAids"] = "OrienteeringAids";
-    Type["Jewelry"] = "Jewelry";
-    Type["GemsAndPreciousStones"] = "GemsAndPreciousStones";
-    Type["Stationary"] = "Stationary";
-    Type["Books"] = "Books";
-    Type["MagicalArtifacts"] = "MagicalArtifacts";
-    Type["Alchemicae"] = "Alchemicae";
-    Type["Poisons"] = "Poisons";
-    Type["HealingHerbs"] = "HealingHerbs";
-    Type["MusicalInstruments"] = "MusicalInstruments";
-    Type["LuxuryGoods"] = "LuxuryGoods";
-    Type["Animals"] = "Animals";
-    Type["AnimalCare"] = "AnimalCare";
-    Type["Vehicles"] = "Vehicles";
-    Type["AusruestungDerGeweihtenschaft"] = "AusruestungDerGeweihtenschaft";
-    Type["CeremonialItems"] = "CeremonialItems";
-    Type["Liebesspielzeug"] = "Liebesspielzeug";
-})(Type || (Type = {}));
-export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,31 +0,0 @@
-/**
- * @main ItemGroup
- */
-/**
- * @title Item Group
- */
-export declare type ItemGroup = {
-    /**
-     * The item group's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * 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 item group.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
-};
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ItemGroup>;

package/lib/types/equipment/ItemGroup.js

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

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

@@ -1,31 +0,0 @@
-/**
- * @main Reach
- */
-/**
- * @title Reach
- */
-export declare type Reach = {
-    /**
-     * The reach's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * 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 reach.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
-};
-export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Reach>;

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

@@ -1,70 +0,0 @@
-/**
- *
- */
-/**
- * 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";
-    /**
-     * 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?: {
-        /**
-         * A list of armors that can be combined with this armor.
-         * @minItems 1
-         */
-        armors: {
-            /**
-             * The armor's identifier.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-        }[];
-        /**
-         * 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;
-    };
-} | {
-    tag: "Torso";
-} | {
-    tag: "Arms";
-} | {
-    tag: "Legs";
-};