optolith-database-schema 0.11.4 → 0.11.7

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

@@ -0,0 +1,44 @@
+/**
+ * @main GemOrPreciousStone
+ */
+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 { Cost } from "./_Item.js";
+export 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 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 config: TypeConfig<GemOrPreciousStone>;

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

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

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

@@ -0,0 +1,63 @@
+/**
+ * @main IlluminationLightSource
+ */
+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 IlluminationLightSource = {
+    /**
+     * 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 burning time is the time how long the light source can be lit. After
+     * that time you have to use a new light source.
+     */
+    burning_time: BurningTime;
+    /**
+     * 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 type BurningTime = {
+    tag: "Unlimited";
+    unlimited: {};
+} | {
+    tag: "Limited";
+    limited: LimitedBurningTime;
+};
+export type LimitedBurningTime = {
+    /**
+     * The (unitless) time value.
+     * @exclusiveMinimum 0
+     */
+    value: number;
+    /**
+     * The time unit.
+     */
+    unit: LimitedBurningTimeUnit;
+};
+export declare enum LimitedBurningTimeUnit {
+    Hours = "Hours"
+}
+export declare const config: TypeConfig<IlluminationLightSource>;

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

@@ -0,0 +1,16 @@
+/**
+ * @main IlluminationLightSource
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export var LimitedBurningTimeUnit;
+(function (LimitedBurningTimeUnit) {
+    LimitedBurningTimeUnit["Hours"] = "Hours";
+})(LimitedBurningTimeUnit = LimitedBurningTimeUnit || (LimitedBurningTimeUnit = {}));
+export const config = {
+    name: "IlluminationLightSource",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("IlluminationLightSource"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

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

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

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

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

@@ -0,0 +1,61 @@
+/**
+ * @main Jewelry
+ */
+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 Jewelry = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: JewelryMaterialDifference<Cost>;
+    /**
+     * The weight in kg.
+     */
+    weight: JewelryMaterialDifference<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<JewelryTranslation>;
+};
+/**
+ * Jewelry has different cost based on the material.
+ */
+export type JewelryMaterialDifference<T> = {
+    bronze: T;
+    silver: T;
+    gold: T;
+};
+export type JewelryTranslation = {
+    /**
+     * 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 config: TypeConfig<Jewelry>;

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

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

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

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

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

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

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

@@ -0,0 +1,37 @@
+/**
+ * @main LuxuryGood
+ */
+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 LuxuryGood = {
+    /**
+     * 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<LuxuryGood>;

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

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

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

@@ -0,0 +1,40 @@
+/**
+ * @main MagicalArtifact
+ */
+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 { Cost } from "./_Item.js";
+export 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 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 config: TypeConfig<MagicalArtifact>;

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * @main MusicalInstrument
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { Cost, DefaultItemTranslation, Weight } from "./_Item.js";
+export type MusicalInstrument = {
+    /**
+     * The cost in silverthalers.
+     */
+    cost: Cost;
+    /**
+     * The weight in kg.
+     */
+    weight: Weight;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<DefaultItemTranslation>;
+};
+export declare const config: TypeConfig<MusicalInstrument>;

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

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

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

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

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

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