optolith-database-schema 0.2.2 → 0.3.0

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

@@ -1,11 +1,17 @@
 /**
  * @main AnimistPower
  */
+import { FixedOneTimeDuration } from "../FamiliarsTrick.js";
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Duration, Effect } from "../_ActivatableSkill.js";
+import { CheckResultBasedDuration, DurationUnitValue } from "../_ActivatableSkillDuration.js";
+import { Effect } from "../_ActivatableSkillEffect.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
 import { AnimistPowerPrerequisites } from "../_Prerequisite.js";
+import { ResponsiveTextOptional } from "../_ResponsiveText.js";
+import { AnimistTribeReference, PropertyReference } from "../_SimpleReferences.js";
 import { SkillCheck } from "../_SkillCheck.js";
 /**
  * @title Animist Power
@@ -24,46 +30,26 @@ export declare type AnimistPower = {
     /**
      * Measurable parameters of a animist power.
      */
-    parameters: PerformanceParameters;
+    parameters: AnimistPowerPerformanceParameters;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * The tribe traditions the animist power is available to. It may be available
      * to all or only specific tribes.
+     *
+     * If no tribe tradition is given, the animist power is generally available to
+     * all tribe traditions.
+     * @minItems 1
+     * @uniqueItems
      */
-    tribe_tradition: {
-        tag: "General";
-    } | {
-        tag: "Specific";
-        /**
-         * The specific tribe traditions this animist power is available to.
-         * @minItems 1
-         * @uniqueItems
-         */
-        list: {
-            /**
-             * The tribe's identifier.
-             * @integer
-             * @minimum 1
-             * @maximum 6
-             */
-            id: number;
-        }[];
-    };
+    tribe_tradition: AnimistTribeReference[];
     /**
      * States which column is used to improve the skill. It is a fixed value or
      * depends on the primary patron.
      */
-    improvement_cost: {
-        tag: "Flat";
-        value: ImprovementCost;
-    } | {
-        tag: "ByPrimaryPatron";
-    };
+    improvement_cost: AnimistPowerImprovementCost;
     prerequisites?: AnimistPowerPrerequisites;
     /**
      * The animist power can have multiple levels. Each level is skilled
@@ -73,221 +59,178 @@ export declare type AnimistPower = {
      * first level.
      * @minItems 1
      */
-    levels?: {
-        /**
-         * The level number.
-         * @integer
-         * @minimum 2
-         */
-        level: number;
-        /**
-         * The source references, if different than the references for level 1.
-         */
-        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]: {
-                /**
-                 * An additional effect description for this level.
-                 * @markdown
-                 * @minLength 1
-                 */
-                effect: string;
-            };
-        };
-    }[];
+    levels?: AnimistPowerLevel[];
     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 animist power.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The full name of the entry as stated in the sources. Only use when
-             * `name` needs to be different from full name for text generation
-             * purposes.
-             * @minLength 1
-             */
-            name_in_library?: 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;
-            };
-            /**
-             * A prerequisites text.
-             * @deprecated
-             */
-            prerequisites?: string;
-            errata?: Errata;
-        };
+    translations: LocaleMap<AnimistPowerTranslation>;
+};
+export declare type AnimistPowerTranslation = {
+    /**
+     * The name of the animist power.
+     */
+    name: NonEmptyString;
+    /**
+     * The full name of the entry as stated in the sources. Only use when
+     * `name` needs to be different from full name for text generation
+     * purposes.
+     */
+    name_in_library?: 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;
+    };
+    /**
+     * A prerequisites text.
+     * @deprecated
+     */
+    prerequisites?: string;
+    errata?: Errata;
+};
+export declare type AnimistPowerLevel = {
+    /**
+     * The level number.
+     * @integer
+     * @minimum 2
+     */
+    level: number;
+    /**
+     * The source references, if different than the references for level 1.
+     */
+    src?: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AnimistPowerLevelTranslation>;
+};
+export declare type AnimistPowerLevelTranslation = {
+    /**
+     * An additional effect description for this level.
+     */
+    effect: NonEmptyMarkdown;
 };
 /**
  * Measurable parameters of a animist power.
  */
-declare type PerformanceParameters = {
+export declare type AnimistPowerPerformanceParameters = {
     tag: "OneTime";
+    one_time: OneTimeAnimistPowerPerformanceParameters;
+} | {
+    tag: "Sustained";
+    sustained: SustainedAnimistPowerPerformanceParameters;
+};
+export declare type OneTimeAnimistPowerPerformanceParameters = {
     /**
      * The AE cost value, either a flat value or defined dynamically by the
      * primary patron.
      */
-    cost: {
-        tag: "Fixed";
-        /**
-         * The AE cost value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * If defined, half of the AE cost `value` has to be paid each
-         * interval.
-         */
-        interval?: Duration.UnitValue;
-    } | {
-        tag: "ByPrimaryPatron";
-        /**
-         * If defined, half of the AE cost `value` has to be paid each
-         * interval.
-         */
-        interval?: Duration.UnitValue;
-        /**
-         * 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;
-                };
-            };
-        };
-    };
+    cost: OneTimeAnimistPowerCost;
     /**
      * The duration.
      */
-    duration: {
-        tag: "Immediate";
-    } | {
-        tag: "Fixed";
-        /**
-         * If the duration is the maximum duration, so it may end earlier.
-         */
-        is_maximum?: boolean;
-        /**
-         * The (unitless) duration.
-         * @integer
-         * @minimum 2
-         */
-        value: number;
-        /**
-         * The duration unit.
-         */
-        unit: Duration.Unit;
-    } | Duration.CheckResultBasedTaggedAnimistPower;
+    duration: OneTimeAnimistPowerDuration;
+};
+export declare type OneTimeAnimistPowerCost = {
+    tag: "Fixed";
+    fixed: FixedOneTimeAnimistPowerCost;
 } | {
-    tag: "Sustained";
+    tag: "ByPrimaryPatron";
+    by_primary_patron: OneTimeAnimistPowerCostByPrimaryPatron;
+};
+export declare type FixedOneTimeAnimistPowerCost = {
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * If defined, half of the AE cost `value` has to be paid each interval.
+     */
+    interval?: DurationUnitValue;
+};
+export declare type OneTimeAnimistPowerCostByPrimaryPatron = {
+    /**
+     * If defined, half of the AE cost `value` has to be paid each interval.
+     */
+    interval?: DurationUnitValue;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<AnimistPowerCostByPrimaryPatronTranslation>;
+};
+export declare type OneTimeAnimistPowerDuration = {
+    tag: "Immediate";
+} | {
+    tag: "Fixed";
+    fixed: FixedOneTimeDuration;
+} | {
+    tag: "CheckResultBased";
+    check_result_based: CheckResultBasedDuration;
+};
+export declare type SustainedAnimistPowerPerformanceParameters = {
     /**
      * The AE cost value, either a flat value or defined dynamically by the
      * primary patron.
      */
-    cost: {
-        tag: "Fixed";
-        /**
-         * The AE cost value.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * Half of the AE cost `value` has to be paid each interval.
-         */
-        interval: Duration.UnitValue;
-    } | {
-        tag: "ByPrimaryPatron";
-        /**
-         * Half of the AE cost `value` has to be paid each interval.
-         */
-        interval: Duration.UnitValue;
-        /**
-         * 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;
-                };
-            };
-        };
-    };
+    cost: SustainedAnimistPowerCost;
+};
+export declare type SustainedAnimistPowerCost = {
+    tag: "Fixed";
+    fixed: FixedSustainedAnimistPowerCost;
+} | {
+    tag: "ByPrimaryPatron";
+    by_primary_patron: SustainedAnimistPowerCostByPrimaryPatron;
+};
+export declare type FixedSustainedAnimistPowerCost = {
+    /**
+     * The AE cost value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * Half of the AE cost `value` has to be paid each interval.
+     */
+    interval: DurationUnitValue;
+};
+export declare type SustainedAnimistPowerCostByPrimaryPatron = {
+    /**
+     * Half of the AE cost `value` has to be paid each interval.
+     */
+    interval: DurationUnitValue;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<AnimistPowerCostByPrimaryPatronTranslation>;
+};
+export declare type AnimistPowerCostByPrimaryPatronTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note: ResponsiveTextOptional;
+};
+export declare type AnimistPowerImprovementCost = {
+    tag: "Fixed";
+    fixed: ImprovementCost;
+} | {
+    tag: "ByPrimaryPatron";
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AnimistPower>;
-export {};

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

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