optolith-database-schema 0.2.4 → 0.4.1

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

@@ -3,8 +3,13 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect, TargetCategory } from "../_ActivatableSkill.js";
+import { CheckResultBasedDuration, DurationUnit } from "../_ActivatableSkillDuration.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 Jester Trick
@@ -27,17 +32,15 @@ export declare type JesterTrick = {
     /**
      * Measurable parameters of a jester trick.
      */
-    parameters: PerformanceParameters;
+    parameters: JesterTrickPerformanceParameters;
     /**
      * 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,124 +48,129 @@ export declare type JesterTrick = {
     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 jester trick.
-             * @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<JesterTrickTranslation>;
+};
+export declare type JesterTrickTranslation = {
+    /**
+     * The name of the jester trick.
+     */
+    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;
 };
 /**
- * Measurable parameters of a jester trick.
+ * Measurable parameters of a geode ritual.
  */
-declare type PerformanceParameters = {
+export declare type JesterTrickPerformanceParameters = {
     /**
      * The casting time.
+     */
+    casting_time: JesterTrickCastingTime;
+    /**
+     * The AE cost.
+     */
+    cost: JesterTrickCost;
+    /**
+     * The range.
+     */
+    range: JesterTrickRange;
+    /**
+     * The duration.
+     */
+    duration: JesterTrickDuration;
+};
+export declare type JesterTrickCastingTime = {
+    /**
+     * The casting time in actions.
      * @integer
      * @minimum 1
      */
-    casting_time: {
-        /**
-         * The casting time in actions.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-    };
+    value: number;
+};
+export declare type JesterTrickCost = {
     /**
-     * The AE cost.
+     * The AE cost value.
      * @integer
      * @minimum 1
      */
-    cost: {
-        /**
-         * The AE cost value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-    };
+    value: number;
+};
+export declare type JesterTrickRange = {
+    tag: "Touch";
+    touch: {};
+} | {
+    tag: "Self";
+    self: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedJesterTrickRange;
+};
+export declare type FixedJesterTrickRange = {
     /**
-     * The range.
+     * The range in steps/m.
+     * @integer
+     * @minimum 1
      */
-    range: {
-        tag: "Touch";
-    } | {
-        tag: "Self";
-    } | {
-        tag: "Fixed";
-        /**
-         * The range in steps/m.
-         * @integer
-         * @minimum 2
-         */
-        value: number;
-    };
+    value: number;
+};
+export declare type JesterTrickDuration = {
+    tag: "Immediate";
+    immediate: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedJesterTrickDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
+};
+export declare type FixedJesterTrickDuration = {
     /**
-     * The duration.
+     * The (unitless) duration.
+     * @integer
+     * @minimum 2
      */
-    duration: {
-        tag: "Immediate";
-    } | {
-        tag: "Fixed";
-        /**
-         * The (unitless) duration.
-         * @integer
-         * @minimum 2
-         */
-        value: number;
-        /**
-         * The duration unit.
-         */
-        unit: Duration.Unit;
-    } | Duration.CheckResultBasedTagged;
+    value: number;
+    /**
+     * The duration unit.
+     */
+    unit: DurationUnit;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<JesterTrick>;
-export {};

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

@@ -1,12 +1,18 @@
 /**
  * @main MagicalDance
  */
+import { FixedOneTimeCostTranslation } from "../FamiliarsTrick.js";
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect } from "../_ActivatableSkill.js";
+import { CheckResultBasedModifier } from "../_ActivatableSkillCheckResultBased.js";
+import { IndefiniteOneTimeCostTranslation } from "../_ActivatableSkillCost.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck } from "../_SkillCheck.js";
-import { MusicTraditionReference } from "./_MusicTradition.js";
+import { MusicDuration, MusicTraditionReference } from "./_MusicTradition.js";
 /**
  * @title Magical Dance
  */
@@ -24,13 +30,11 @@ export declare type MagicalDance = {
     /**
      * Measurable parameters of a magical dance.
      */
-    parameters: PerformanceParameters;
+    parameters: MagicalDancePerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * The music tradition(s) the magical dance is available for. This also
      * defines the different names in each music tradition.
@@ -44,142 +48,71 @@ export declare type MagicalDance = {
     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 dance.
-             * @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
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<MagicalDanceTranslation>;
 };
-/**
- * Measurable parameters of a magical dance.
- */
-declare type PerformanceParameters = {
+export declare type MagicalDanceTranslation = {
+    /**
+     * The name of the magical dance.
+     */
+    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
+     */
     duration: {
-        length: {
-            tag: "Long";
-        } | {
-            tag: "Short";
-        };
-        reusability: {
-            tag: "OneTime";
-        } | {
-            tag: "Sustainable";
-        };
+        full: string;
+        abbr: string;
     };
+    /**
+     * @deprecated
+     */
     cost: {
-        tag: "Fixed";
-        /**
-         * The (temporary) 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]: {
-                /**
-                 * The cost have to be per a specific countable entity, e.g. `8 AE per
-                 * person`.
-                 */
-                per?: {
-                    /**
-                     * The full countable entity name.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * The compressed countable entity name.
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    } | {
-        tag: "Indefinite";
-        /**
-         * Specified if the indefinite description's result value is to be
-         * modified by a certain number.
-         */
-        modifier?: {
-            /**
-             * The arithmetic how to apply the `value` to the indefinite value.
-             */
-            arithmetic: Duration.CheckResultArithmetic;
-            /**
-             * The value that is applied to the indefinite value using the defined
-             * `arithmetic`.
-             * @integer
-             * @minimum 2
-             */
-            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]: {
-                /**
-                 * A description of the duration.
-                 * @minLength 1
-                 */
-                description: {
-                    /**
-                     * The full description of the duration.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed description of the duration for use in small areas
-                     * (e.g. on character sheet).
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
+        full: string;
+        abbr: string;
     };
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a magical dance.
+ */
+export declare type MagicalDancePerformanceParameters = {
+    duration: MusicDuration;
+    cost: MagicalDanceCost;
+};
+export declare type MagicalDanceCost = {
+    tag: "Fixed";
+    fixed: FixedMagicalDanceCost;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteMagicalDanceCost;
+};
+export declare type FixedMagicalDanceCost = {
+    /**
+     * The (temporary) AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<FixedOneTimeCostTranslation>;
+};
+export declare type IndefiniteMagicalDanceCost = {
+    /**
+     * Specified if the indefinite description's result value is to be
+     * modified by a certain number.
+     */
+    modifier?: CheckResultBasedModifier;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteOneTimeCostTranslation>;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalDance>;
-export {};

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

@@ -3,11 +3,14 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Effect } from "../_ActivatableSkill.js";
+import { Effect } from "../_ActivatableSkillEffect.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";
-import { MusicTraditionReference } from "./_MusicTradition.js";
-import { SkillReference } from "./_SkillReference.js";
+import { MusicDuration, MusicTraditionReference } from "./_MusicTradition.js";
+import { MusicalSkillReference } from "./_SkillReference.js";
 /**
  * @title Magical Melody
  */
@@ -33,17 +36,15 @@ export declare type MagicalMelody = {
      * @maxItems 2
      * @uniqueItems
      */
-    skill: SkillReference[];
+    skill: MusicalSkillReference[];
     /**
      * Measurable parameters of a magical melody.
      */
-    parameters: PerformanceParameters;
+    parameters: MagicalMelodyPerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * The music tradition(s) the magical melody is available for. This also
      * defines the different names in each music tradition.
@@ -57,77 +58,66 @@ export declare type MagicalMelody = {
     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 melody.
-             * @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
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<MagicalMelodyTranslation>;
 };
-/**
- * Measurable parameters of a magical melody.
- */
-declare type PerformanceParameters = {
+export declare type MagicalMelodyTranslation = {
+    /**
+     * The name of the magical melody.
+     */
+    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
+     */
     duration: {
-        length: {
-            tag: "Long";
-        } | {
-            tag: "Short";
-        };
-        reusability: {
-            tag: "OneTime";
-        } | {
-            tag: "Sustainable";
-        };
+        full: string;
+        abbr: string;
     };
+    /**
+     * @deprecated
+     */
     cost: {
-        tag: "Fixed";
-        /**
-         * The (temporary) AE cost value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-    } | {
-        tag: "FirstPerson";
-        /**
-         * The (temporary) AE cost value for the first targeted person. The AE
-         * cost for each additional person is half this value.
-         * @integer
-         * @minimum 1
-         * @multipleOf 2
-         */
-        value: number;
+        full: string;
+        abbr: string;
     };
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a magical melody.
+ */
+export declare type MagicalMelodyPerformanceParameters = {
+    duration: MusicDuration;
+    cost: MagicalMelodyCost;
+};
+export declare type MagicalMelodyCost = {
+    tag: "Fixed";
+    fixed: FixedMagicalMelodyCost;
+} | {
+    tag: "FirstPerson";
+    first_person: FirstPersonMagicalMelodyCost;
+};
+export declare type FixedMagicalMelodyCost = {
+    /**
+     * The (temporary) AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+export declare type FirstPersonMagicalMelodyCost = {
+    /**
+     * The (temporary) AE cost value for the first targeted person. The AE
+     * cost for each additional person is half this value.
+     * @integer
+     * @minimum 1
+     * @multipleOf 2
+     */
+    value: number;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<MagicalMelody>;
-export {};