optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/SkillModificationLevel.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main SkillModificationLevel
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Skill Modification Level
  */
@@ -15,96 +17,90 @@ export declare type SkillModificationLevel = {
     /**
      * Configuration for this level for fast skills (spells, liturgical chants).
      */
-    fast: {
-        /**
-         * The casting time in actions.
-         * @integer
-         * @minimum 1
-         */
-        casting_time: number;
-        /**
-         * The range in meters.
-         * @integer
-         * @minimum 1
-         */
-        range: number;
-        /**
-         * The cost in AE/KP.
-         * @integer
-         * @minimum 1
-         */
-        cost: number;
-    };
+    fast: FastSkillModificationLevelConfig;
     /**
      * Configuration for this level for slow skills (rituals, ceremonies).
      */
-    slow: {
-        /**
-         * The casting time.
-         */
-        casting_time: {
-            /**
-             * The (unitless) casting time.
-             * @integer
-             * @minimum 1
-             */
-            value: number;
-            /**
-             * The unit for the `value`.
-             */
-            unit: SlowSkillCastingTimeUnit;
-        };
-        /**
-         * The range in meters.
-         * @integer
-         * @minimum 1
-         */
-        range: number;
-        /**
-         * The cost in AE/KP.
-         * @integer
-         * @minimum 1
-         */
-        cost: number;
-    };
+    slow: SlowSkillModificationLevelConfig;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations?: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         * @minProperties 1
-         */
-        [localeId: string]: {
-            /**
-             * Configuration for this level for fast skills (spells, liturgical chants).
-             * Values set here override the default generated text.
-             * @minLength 1
-             */
-            fast?: LevelTypeConfigTranslation;
-            /**
-             * Configuration for this level for slow skills (rituals, ceremonies). Values
-             * set here override the default generated text.
-             * @minLength 1
-             */
-            slow?: LevelTypeConfigTranslation;
-        };
-    };
+    translations?: LocaleMap<SkillModificationLevelTranslation>;
+};
+export declare type FastSkillModificationLevelConfig = {
+    /**
+     * The casting time in actions.
+     * @integer
+     * @minimum 1
+     */
+    casting_time: number;
+    /**
+     * The range in meters.
+     * @integer
+     * @minimum 1
+     */
+    range: number;
+    /**
+     * The cost in AE/KP.
+     * @integer
+     * @minimum 1
+     */
+    cost: number;
+};
+export declare type SlowSkillModificationLevelConfig = {
+    /**
+     * The casting time.
+     */
+    casting_time: SlowSkillCastingTime;
+    /**
+     * The range in meters.
+     * @integer
+     * @minimum 1
+     */
+    range: number;
+    /**
+     * The cost in AE/KP.
+     * @integer
+     * @minimum 1
+     */
+    cost: number;
+};
+export declare type SlowSkillCastingTime = {
+    /**
+     * The (unitless) casting time.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit for the `value`.
+     */
+    unit: SlowSkillCastingTimeUnit;
 };
 export declare enum SlowSkillCastingTimeUnit {
     Minutes = "Minutes",
     Hours = "Hours"
 }
 /**
- * Configuration translation of a type for a level. Values set here override the
- * default generated text.
+ * @minProperties 1
  */
-declare type LevelTypeConfigTranslation = {
+export declare type SkillModificationLevelTranslation = {
+    /**
+     * Configuration for this level for fast skills (spells, liturgical chants).
+     * Values set here override the default generated text.
+     */
+    fast?: LevelTypeConfigTranslation;
     /**
-     * @minLength 1
+     * Configuration for this level for slow skills (rituals, ceremonies). Values
+     * set here override the default generated text.
      */
-    range: string;
+    slow?: LevelTypeConfigTranslation;
+};
+/**
+ * Configuration translation of a type for a level. Values set here override the
+ * default generated text.
+ */
+export declare type LevelTypeConfigTranslation = {
+    range: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<SkillModificationLevel>;
-export {};

package/lib/types/SocialStatus.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main SocialStatus
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Social Status
  */
@@ -13,19 +15,13 @@ export declare type SocialStatus = {
     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 social status name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<SocialStatusTranslation>;
+};
+export declare type SocialStatusTranslation = {
+    /**
+     * The social status name.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<SocialStatus>;

package/lib/types/Spell.d.ts

@@ -3,11 +3,17 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill.js";
+import { FastPerformanceParameters } from "./_ActivatableSkill.js";
+import { Effect } from "./_ActivatableSkillEffect.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
 import { Enhancements } from "./_Enhancements.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { SpellworkPrerequisites } from "./_Prerequisite.js";
+import { PropertyReference } from "./_SimpleReferences.js";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck.js";
+import { Traditions } from "./_Spellwork.js";
 /**
  * @title Spell
  */
@@ -33,42 +39,17 @@ export declare type Spell = {
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * The tradition(s) the spell is available for. It may be *generally*
      * available to all traditions or it may be only familiar in specific
      * traditions.
      */
-    traditions: {
-        tag: "General";
-    } | {
-        tag: "Specific";
-        /**
-         * A list of specific traditions.
-         * @minItems 1
-         */
-        list: {
-            /**
-             * The magical tradition's identifier. If `is_placeholder` is `true`
-             * then this is the magical tradition's placeholder identifier
-             * instead.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-            /**
-             * If set to `true`, the tradition is not available as a special ability
-             * yet.
-             */
-            is_placeholder?: true;
-        }[];
-    };
+    traditions: Traditions;
     /**
      * States which column is used to improve the skill.
      */
@@ -77,59 +58,53 @@ export declare type Spell = {
     src: PublicationRefs;
     /**
      * 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 spell.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effect description may be either a plain text or a text that is
-             * divided by a list of effects for each quality level. It may also be a
-             * list for each two quality levels.
-             */
-            effect: Effect.T;
-            /**
-             * @deprecated
-             */
-            casting_time: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            range: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            target: string;
-            errata?: Errata;
-        };
-    };
+     */
+    translations: LocaleMap<SpellTranslation>;
     enhancements?: Enhancements;
 };
+export declare type SpellTranslation = {
+    /**
+     * The name of the spell.
+     */
+    name: NonEmptyString;
+    /**
+     * The effect description may be either a plain text or a text that is
+     * divided by a list of effects for each quality level. It may also be a
+     * list for each two quality levels.
+     */
+    effect: Effect;
+    /**
+     * @deprecated
+     */
+    casting_time: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    range: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Spell>;

package/lib/types/State.d.ts

@@ -3,6 +3,8 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title State
  */
@@ -16,26 +18,18 @@ export declare type State = {
     src: PublicationRefs;
     /**
      * 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 state.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The description of the state.
-             * @markdown
-             * @minLength 1
-             */
-            description: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<StateTranslation>;
+};
+export declare type StateTranslation = {
+    /**
+     * The name of the state.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the state.
+     */
+    description: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<State>;

package/lib/types/Talisman.d.ts

@@ -3,6 +3,9 @@
  */
 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 } from "./_SimpleReferences.js";
 /**
  * @title Talisman
  */
@@ -17,28 +20,11 @@ export declare type Talisman = {
      * The tradition(s) the talisman belongs to.
      * @minItems 1
      */
-    tradition: {
-        /**
-         * The blessed traditions's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+    tradition: BlessedTraditionReference[];
     /**
      * The talisman type.
      */
-    type: {
-        tag: "MainTalisman";
-    } | {
-        tag: "Talisman";
-    } | {
-        tag: "MinorTalisman";
-    } | {
-        tag: "Regalia";
-    } | {
-        tag: "PowerfulTalisman";
-    };
+    type: TalismanType;
     /**
      * The AP value for the required trade secret.
      * @integer
@@ -49,41 +35,41 @@ export declare type Talisman = {
     src: PublicationRefs;
     /**
      * 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 talisman.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effect description.
-             * @markdown
-             * @minLength 1
-             */
-            description: string;
-            /**
-             * The activation parameters.
-             */
-            activation: {
-                /**
-                 * The KP cost.
-                 * @minLength 1
-                 */
-                cost: string;
-                /**
-                 * The duration.
-                 * @minLength 1
-                 */
-                duration: string;
-            };
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<TalismanTranslation>;
+};
+export declare enum TalismanType {
+    MainTalisman = "MainTalisman",
+    Talisman = "Talisman",
+    MinorTalisman = "MinorTalisman",
+    Regalia = "Regalia",
+    PowerfulTalisman = "PowerfulTalisman"
+}
+export declare type TalismanTranslation = {
+    /**
+     * The name of the talisman.
+     */
+    name: NonEmptyString;
+    /**
+     * The effect description.
+     */
+    effect: NonEmptyMarkdown;
+    /**
+     * The activation parameters.
+     */
+    activation?: TalismanActivationTranslation;
+    errata?: Errata;
+};
+export declare type TalismanActivationTranslation = {
+    /**
+     * The KP cost.
+     * @integer
+     * @minimum 0
+     */
+    cost: number;
+    /**
+     * The duration.
+     */
+    duration: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Talisman>;

package/lib/types/Talisman.js

@@ -2,4 +2,12 @@
  * @main Talisman
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+export var TalismanType;
+(function (TalismanType) {
+    TalismanType["MainTalisman"] = "MainTalisman";
+    TalismanType["Talisman"] = "Talisman";
+    TalismanType["MinorTalisman"] = "MinorTalisman";
+    TalismanType["Regalia"] = "Regalia";
+    TalismanType["PowerfulTalisman"] = "PowerfulTalisman";
+})(TalismanType || (TalismanType = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/TargetCategory.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main TargetCategory
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Target Category
  */
@@ -12,26 +14,29 @@ export declare type TargetCategory = {
      */
     id: number;
     /**
-     * The identifier of a superordinate target category, if present.
+     * A superordinate target category, if present.
+     */
+    parent?: TargetCategoryParent;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<TargetCategoryTranslation>;
+};
+/**
+ * A superordinate target category, if present.
+ */
+export declare type TargetCategoryParent = {
+    /**
+     * The identifier of the superordinate target category.
      * @integer
      * @minimum 1
      */
-    parent_id: number;
+    id: number;
+};
+export declare type TargetCategoryTranslation = {
     /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
+     * The target category name.
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The target category name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<TargetCategory>;

package/lib/types/UI.d.ts

@@ -2,6 +2,7 @@
  * @main UI
  */
 import { PluralizationCategories } from "./_I18n.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title UI
  */
@@ -1057,9 +1058,4 @@ export declare type UI = {
     "pets.dialogs.addedit.addbtn": NonEmptyString;
     "pets.dialogs.addedit.savebtn": NonEmptyString;
 };
-/**
- * @minLength 1
- */
-declare type NonEmptyString = string;
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<UI>;
-export {};