optolith-database-schema 0.2.4 → 0.3.0

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

@@ -3,7 +3,13 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect } from "../_ActivatableSkill.js";
+import { IndefiniteOneTimeCost } from "../_ActivatableSkillCost.js";
+import { CheckResultBasedDuration, DurationUnit, IndefiniteDurationTranslation } from "../_ActivatableSkillDuration.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { ResponsiveText, ResponsiveTextOptional } from "../_ResponsiveText.js";
+import { PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
 /**
  * @title Curse
@@ -26,204 +32,129 @@ export declare type Curse = {
     /**
      * Measurable parameters of a curse.
      */
-    parameters: PerformanceParameters;
+    parameters: CursePerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     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 curse.
-             * @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
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            errata?: Errata;
-        };
+     */
+    translations: LocaleMap<CurseTranslation>;
+};
+export declare type CurseTranslation = {
+    /**
+     * The name of the curse.
+     */
+    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
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    errata?: Errata;
 };
 /**
  * Measurable parameters of a curse.
  */
-declare type PerformanceParameters = {
+export declare type CursePerformanceParameters = {
     /**
      * The AE cost.
      */
-    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 KP
-                 * per person`.
-                 */
-                per?: {
-                    /**
-                     * The full countable entity name.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * The compressed countable entity name.
-                     * @minLength 1
-                     */
-                    compressed: 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: "Indefinite";
-        /**
-         * 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 where the cost come from.
-                 */
-                description: {
-                    /**
-                     * The full description of where the cost come from.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed description of where the cost come from for use in
-                     * small areas (e.g. on character sheet).
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    };
+    cost: CurseCost;
     /**
      * The duration.
      */
-    duration: {
-        tag: "Immediate";
-    } | {
-        tag: "Fixed";
-        /**
-         * The (unitless) duration value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * The unit of the `value`.
-         */
-        unit: Duration.Unit;
-    } | Duration.CheckResultBasedTagged | {
-        tag: "Indefinite";
-        /**
-         * Specified if the duration has a maximum time span.
-         */
-        maximum?: {
-            tag: "Fixed";
-            /**
-             * The (unitless) maximum duration value.
-             * @integer
-             * @minimum 1
-             */
-            value: number;
-            /**
-             * The unit of the `value`.
-             */
-            unit: Duration.Unit;
-        } | Duration.CheckResultBasedTagged;
-        /**
-         * 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.
-                 */
-                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;
-                };
-            };
-        };
-    };
+    duration: CurseDuration;
+};
+export declare type CurseCost = {
+    tag: "Fixed";
+    fixed: FixedCurseCost;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteOneTimeCost;
+};
+export declare type FixedCurseCost = {
+    /**
+     * The (temporary) AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<FixedCurseCostTranslation>;
+};
+/**
+ * @minProperties 1
+ */
+export declare type FixedCurseCostTranslation = {
+    /**
+     * The cost have to be per a specific countable entity, e.g. `8 KP
+     * per person`.
+     */
+    per?: ResponsiveText;
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note?: ResponsiveTextOptional;
+};
+export declare type CurseDuration = {
+    tag: "Immediate";
+} | {
+    tag: "Fixed";
+    fixed: FixedCurseDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteCurseDuration;
+};
+export declare type FixedCurseDuration = {
+    /**
+     * The (unitless) duration value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit of the `value`.
+     */
+    unit: DurationUnit;
+};
+export declare type IndefiniteCurseDuration = {
+    /**
+     * Specified if the duration has a maximum time span.
+     */
+    maximum?: MaximumIndefiniteCurseDuration;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export declare type MaximumIndefiniteCurseDuration = {
+    tag: "Fixed";
+    fixed: FixedCurseDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Curse>;
-export {};

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

@@ -3,7 +3,12 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect } from "../_ActivatableSkill.js";
+import { CheckResultBasedDuration, DurationUnit, IndefiniteDurationTranslation } from "../_ActivatableSkillDuration.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { ResponsiveText } from "../_ResponsiveText.js";
+import { PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
 /**
  * @title Domination Ritual
@@ -26,157 +31,114 @@ export declare type DominationRitual = {
     /**
      * Measurable parameters of a curse.
      */
-    parameters: PerformanceParameters;
+    parameters: DominationRitualPerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     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 domination 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
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            errata?: Errata;
-        };
+    translations: LocaleMap<DominationRitualTranslation>;
+};
+export declare type DominationRitualTranslation = {
+    /**
+     * The name of the domination 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
+     */
+    cost: {
+        full: string;
+        abbr: string;
     };
+    /**
+     * @deprecated
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    errata?: Errata;
 };
 /**
  * Measurable parameters of a curse.
  */
-declare type PerformanceParameters = {
+export declare type DominationRitualPerformanceParameters = {
     /**
      * The AE cost.
      */
-    cost: {
-        /**
-         * The initial skill modification identifier/level.
-         * @integer
-         * @minimum 1
-         * @maximum 6
-         */
-        initial_modification_level: 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]: {
-                /**
-                 * AE cost in addition to the normal AE cost.
-                 */
-                additional?: {
-                    /**
-                     * The full description of where the cost come from.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed description of where the cost come from for use in
-                     * small areas (e.g. on character sheet).
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    };
+    cost: DominationRitualCost;
     /**
      * The duration.
      */
-    duration: {
-        tag: "Fixed";
-        /**
-         * The (unitless) duration value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * The unit of the `value`.
-         */
-        unit: Duration.Unit;
-    } | Duration.CheckResultBasedTagged | {
-        tag: "Indefinite";
-        /**
-         * Specified if the duration has a maximum time span.
-         */
-        maximum?: {
-            tag: "Fixed";
-            /**
-             * The (unitless) maximum duration value.
-             * @integer
-             * @minimum 1
-             */
-            value: number;
-            /**
-             * The unit of the `value`.
-             */
-            unit: Duration.Unit;
-        } | Duration.CheckResultBasedTagged;
-        /**
-         * 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.
-                 */
-                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;
-                };
-            };
-        };
-    };
+    duration: DominationRitualDuration;
+};
+export declare type DominationRitualCost = {
+    /**
+     * The initial skill modification identifier/level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    initial_modification_level: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations?: LocaleMap<DominationRitualCostTranslation>;
+};
+export declare type DominationRitualCostTranslation = {
+    /**
+     * AE cost in addition to the normal AE cost.
+     */
+    additional: ResponsiveText;
+};
+export declare type DominationRitualDuration = {
+    tag: "Fixed";
+    fixed: FixedDominationRitualDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteDominationRitualDuration;
+};
+export declare type FixedDominationRitualDuration = {
+    /**
+     * The (unitless) duration value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit of the `value`.
+     */
+    unit: DurationUnit;
+};
+export declare type IndefiniteDominationRitualDuration = {
+    /**
+     * Specified if the duration has a maximum time span.
+     */
+    maximum?: MaximumIndefiniteCurseDuration;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export declare type MaximumIndefiniteCurseDuration = {
+    tag: "Fixed";
+    fixed: FixedDominationRitualDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<DominationRitual>;
-export {};