optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/magicalActions/MagicalRune.d.ts

@@ -3,8 +3,13 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect } from "../_ActivatableSkill.js";
+import { CheckResultBasedDuration } from "../_ActivatableSkillDuration.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { ResponsiveText, ResponsiveTextOptional } from "../_ResponsiveText.js";
+import { PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck } from "../_SkillCheck.js";
 /**
  * @title Magical Rune
@@ -23,44 +28,15 @@ export declare type MagicalRune = {
     /**
      * In some cases, the target's Spirit or Toughness is applied as a penalty.
      */
-    check_penalty?: {
-        tag: "CloseCombatTechnique";
-        /**
-         * A map from close combat techniques to their modifiers.
-         * @minItems 1
-         */
-        map: {
-            /**
-             * The close combat technique's identifier.
-             * @integer
-             * @minimum 1
-             */
-            combat_technique_id: number;
-            /**
-             * The check modifier for the specified close combat technique.
-             * @integer
-             */
-            modifier: number;
-        }[];
-        other: {
-            /**
-             * The check modifier for close combat techniques not specified in
-             * `map`.
-             * @integer
-             */
-            modifier: number;
-        };
-    };
+    check_penalty?: MagicalRuneCheckPenalty;
     /**
      * Measurable parameters of a magical rune.
      */
-    parameters: PerformanceParameters;
+    parameters: MagicalRunePerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * States which column is used to improve the skill.
      */
@@ -68,175 +44,165 @@ export declare type MagicalRune = {
     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 magical rune.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The native name of the magical rune.
-             * @minLength 1
-             */
-            native_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
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            crafting_time: {
-                slow: {
-                    full: string;
-                    abbr: string;
-                };
-                fast: {
-                    full: string;
-                    abbr: string;
-                };
-            };
-            /**
-             * @deprecated
-             */
-            duration: {
-                slow: {
-                    full: string;
-                    abbr: string;
-                };
-                fast: {
-                    full: string;
-                    abbr: string;
-                };
-            };
-            errata?: Errata;
+     */
+    translations: LocaleMap<MagicalRuneTranslation>;
+};
+export declare type MagicalRuneTranslation = {
+    /**
+     * The name of the magical rune.
+     */
+    name: NonEmptyString;
+    /**
+     * The native name of the magical rune.
+     */
+    native_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
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    crafting_time: {
+        slow: {
+            full: string;
+            abbr: string;
+        };
+        fast: {
+            full: string;
+            abbr: string;
         };
     };
+    /**
+     * @deprecated
+     */
+    duration: {
+        slow: {
+            full: string;
+            abbr: string;
+        };
+        fast: {
+            full: string;
+            abbr: string;
+        };
+    };
+    errata?: Errata;
+};
+export declare type MagicalRuneCheckPenalty = {
+    tag: "CloseCombatTechnique";
+    close_combat_technique: MagicalRuneCloseCombatTechniqueCheckPenalty;
+};
+export declare type MagicalRuneCloseCombatTechniqueCheckPenalty = {
+    /**
+     * A map from close combat techniques to their modifiers.
+     * @minItems 1
+     */
+    map: MagicalRuneCloseCombatTechniqueCheckPenaltyMapping[];
+    rest: MagicalRuneCloseCombatTechniqueCheckPenaltyRest;
+};
+export declare type MagicalRuneCloseCombatTechniqueCheckPenaltyMapping = {
+    /**
+     * The close combat technique's identifier.
+     * @integer
+     * @minimum 1
+     */
+    combat_technique_id: number;
+    /**
+     * The check modifier for the specified close combat technique.
+     * @integer
+     */
+    modifier: number;
+};
+export declare type MagicalRuneCloseCombatTechniqueCheckPenaltyRest = {
+    /**
+     * The check modifier for close combat techniques not specified in `map`.
+     * @integer
+     */
+    modifier: number;
 };
 /**
  * Measurable parameters of a magical rune.
  */
-declare type PerformanceParameters = {
+export declare type MagicalRunePerformanceParameters = {
     /**
      * The AE cost.
      */
-    cost: {
-        tag: "Single";
-        /**
-         * The AE cost value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * 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]: {
-                /**
-                 * A note, appended to the generated string in parenthesis.
-                 */
-                note?: {
-                    /**
-                     * The full note.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed note, if applicable. If not specified it should not
-                     * be displayed in small location.
-                     * @minLength 1
-                     */
-                    compressed?: string;
-                };
-            };
-        };
-    } | {
-        tag: "Disjunction";
-        /**
-         * A set of possible AE cost values.
-         * @minItems 2
-         */
-        list: {
-            /**
-              * The AE cost value.
-              * @integer
-              * @minimum 1
-              */
-            value: number;
-        }[];
-    };
+    cost: MagicalRuneCost;
     /**
      * The crafting time.
      */
-    crafting_time: {
-        /**
-         * The (unitless) crafting time.
-         */
-        value: 1 | 2 | 4;
-        /**
-         * 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]: {
-                /**
-                 * The crafting time has to be per a specific countable entity, e.g. `8
-                 * action per person`.
-                 */
-                per?: {
-                    /**
-                     * The full countable entity name.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * The compressed countable entity name.
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    };
+    crafting_time: MagicalRuneCraftingTime;
     /**
      * The duration.
      */
-    duration: {
-        /**
-         * The duration on slow rune application.
-         */
-        slow: Duration.CheckResultBased;
-        /**
-         * The duration on fast rune application.
-         */
-        fast: Duration.CheckResultBased;
-    };
+    duration: MagicalRuneDuration;
+};
+export declare type MagicalRuneCost = {
+    tag: "Single";
+    single: SingleMagicalRuneCost;
+} | {
+    tag: "Disjunction";
+    disjunction: MagicalRuneCostDisjunction;
+};
+export declare type SingleMagicalRuneCost = {
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<SingleMagicalRuneCostTranslation>;
+};
+export declare type SingleMagicalRuneCostTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note: ResponsiveTextOptional;
+};
+export declare type MagicalRuneCostDisjunction = {
+    /**
+     * A set of possible AE cost values.
+     * @minItems 2
+     */
+    list: SingleMagicalRuneCost[];
+};
+export declare type MagicalRuneCraftingTime = {
+    /**
+     * The (unitless) crafting time.
+     */
+    value: 1 | 2 | 4;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<MagicalRuneCraftingTimeTranslation>;
+};
+export declare type MagicalRuneCraftingTimeTranslation = {
+    /**
+     * The crafting time has to be per a specific countable entity, e.g. `8
+     * action per person`.
+     */
+    per: ResponsiveText;
+};
+export declare type MagicalRuneDuration = {
+    /**
+     * The duration on slow rune application.
+     */
+    slow: CheckResultBasedDuration;
+    /**
+     * The duration on fast rune application.
+     */
+    fast: CheckResultBasedDuration;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalRune>;
-export {};

package/lib/types/magicalActions/ZibiljaRitual.d.ts

@@ -3,8 +3,14 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { CastingTime, Cost, Duration, Effect, Range, TargetCategory } from "../_ActivatableSkill.js";
+import { OneTimePerformanceParameters } from "../_ActivatableSkill.js";
+import { CastingTime, SlowSkillNonModifiableCastingTime } from "../_ActivatableSkillCastingTime.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { TargetCategory } from "../_ActivatableSkillTargetCategory.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
 /**
  * @title Zibilja Ritual
@@ -27,17 +33,15 @@ export declare type ZibiljaRitual = {
     /**
      * Measurable parameters of a zibilja ritual.
      */
-    parameters: PerformanceParameters;
+    parameters: ZibiljaRitualPerformanceParameters;
     /**
      * 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;
     /**
      * States which column is used to improve the skill.
      */
@@ -45,65 +49,53 @@ export declare type ZibiljaRitual = {
     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 zibilja ritual.
-             * @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<ZibiljaRitualTranslation>;
 };
-declare type PerformanceParameters = {
-    casting_time: CastingTime.ModifiableCastingTime | CastingTime.SlowSkillCastingTime;
-    cost: Cost.OneTime.T;
-    range: Range.T;
-    duration: Duration.OneTime.T;
+export declare type ZibiljaRitualTranslation = {
+    /**
+     * The name of the zibilja ritual.
+     */
+    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 type ZibiljaRitualPerformanceParameters = OneTimePerformanceParameters<CastingTime<SlowSkillNonModifiableCastingTime>>;
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ZibiljaRitual>;
-export {};

package/lib/types/magicalActions/_MusicTradition.d.ts

@@ -1,3 +1,5 @@
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 /**
  * A reference to a music tradition with the music-tradition-specific name of
  * the entry
@@ -11,18 +13,26 @@ export declare type MusicTraditionReference = {
     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 music-tradition-specific name of the entry.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<MusicTraditionReferenceTranslation>;
+};
+export declare type MusicTraditionReferenceTranslation = {
+    /**
+     * The music-tradition-specific name of the entry.
+     */
+    name: NonEmptyString;
+};
+export declare type MusicDuration = {
+    length: MusicLength;
+    reusability: MusicReusability;
+};
+export declare type MusicLength = {
+    tag: "Long";
+} | {
+    tag: "Short";
+};
+export declare type MusicReusability = {
+    tag: "OneTime";
+} | {
+    tag: "Sustainable";
 };

package/lib/types/magicalActions/_SkillReference.d.ts

@@ -1,7 +1,7 @@
 /**
  * A reference to a skill used for performing melodies.
  */
-export declare type SkillReference = {
+export declare type MusicalSkillReference = {
     /**
      * The skill's identifier.
      */

package/lib/types/prerequisites/DisplayOption.d.ts

@@ -1,3 +1,5 @@
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 /**
  * @title Display Option
  */
@@ -5,15 +7,11 @@ export declare type DisplayOption = {
     tag: "Hide";
 } | {
     tag: "ReplaceWith";
+    replace_with: ReplacementDisplayOption;
+};
+export declare type ReplacementDisplayOption = {
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         * @minLength 1
-         */
-        [localeId: string]: string;
-    };
+    translations: LocaleMap<NonEmptyString>;
 };