optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/specialAbility/_Tradition.d.ts

@@ -0,0 +1,12 @@
+import { NonEmptyString } from "../_NonEmptyString.js";
+export declare type SpecialRule = {
+    /**
+     * An optional label that is displayed and placed before the actual
+     * text.
+     */
+    label?: NonEmptyString;
+    /**
+     * The text of a special rule.
+     */
+    text: NonEmptyString;
+};

package/lib/types/specialAbility/_Tradition.js

@@ -0,0 +1 @@
+export {};

package/lib/types/specialAbility/sub/Language.d.ts

@@ -3,7 +3,11 @@
  */
 import { Errata } from "../../source/_Erratum.js";
 import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
 import { LanguagePrerequisites } from "../../_Prerequisite.js";
+import { AssociatedContinent } from "./_LanguageScript.js";
 /**
  * @title Language
  */
@@ -18,83 +22,12 @@ export declare type Language = {
      * The continents this language is present on.
      * @minItems 1
      */
-    continent: {
-        /**
-         * The continent's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 3
-         */
-        id: number;
-        /**
-         * Is the language considered virtually extinct in this continent?
-         */
-        is_extinct: boolean;
-    }[];
+    continent: AssociatedContinent[];
     /**
      * Language-specific specializations. Either a list of possible options or a
      * indefinite description of what may be a specialization.
      */
-    specializations: {
-        tag: "Specific";
-        /**
-         * A list of specific possible specializations.
-         */
-        list: {
-            /**
-             * The specialization's identifier. An unique, increasing integer.
-             * @integer
-             * @minimum 1
-             */
-            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 name of the specialization.
-                     * @minLength 1
-                     */
-                    name: string;
-                    /**
-                     * The specialization description. It will be appended to the name in
-                     * parenthesis.
-                     * @minLength 1
-                     */
-                    description?: 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]: {
-                /**
-                 * The specializations description.
-                 * @minLength 1
-                 */
-                description: string;
-                /**
-                 * An input label or placeholder text for an UI element if it differs
-                 * from the `description`.
-                 * @minLength 1
-                 */
-                label?: string;
-            };
-        };
-    };
+    specializations: Specializations;
     prerequisites?: LanguagePrerequisites;
     /**
      * The maximum possible level of the language. Only specified if lower than
@@ -107,36 +40,77 @@ export declare type Language = {
     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 language.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * A list of alternative names.
-             * @minLength 1
-             */
-            alternative_names?: {
-                /**
-                 * An alternative name of the language.
-                 * @minLength 1
-                 */
-                name: string;
-            }[];
-            /**
-             * The description of the language.
-             * @minLength 1
-             */
-            description?: string;
-            errata?: Errata;
-        };
-    };
+     */
+    translations: LocaleMap<LanguageTranslation>;
+};
+export declare type Specializations = {
+    tag: "Specific";
+    specific: SpecificSpecializations;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteSpecializations;
+};
+export declare type SpecificSpecializations = {
+    /**
+     * A list of specific possible specializations.
+     * @minItems 1
+     */
+    list: SpecificSpecialization[];
+};
+export declare type SpecificSpecialization = {
+    /**
+     * The specialization's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<SpecificSpecializationTranslation>;
+};
+export declare type SpecificSpecializationTranslation = {
+    /**
+     * The name of the specialization.
+     */
+    name: NonEmptyString;
+    /**
+     * The specialization description. It will be appended to the name in
+     * parenthesis.
+     */
+    description?: NonEmptyString;
+};
+export declare type IndefiniteSpecializations = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteSpecializationsTranslation>;
+};
+export declare type IndefiniteSpecializationsTranslation = {
+    /**
+     * The specializations description.
+     */
+    description: NonEmptyString;
+    /**
+     * An input label or placeholder text for an UI element if it differs
+     * from the `description`.
+     */
+    label?: NonEmptyString;
+};
+export declare type LanguageTranslation = {
+    /**
+     * The name of the language.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * The description of the language.
+     */
+    description?: NonEmptyString;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Language>;

package/lib/types/specialAbility/sub/Script.d.ts

@@ -3,6 +3,11 @@
  */
 import { Errata } from "../../source/_Erratum.js";
 import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
+import { LanguageReference } from "../../_SimpleReferences.js";
+import { AssociatedContinent } from "./_LanguageScript.js";
 /**
  * @title Script
  */
@@ -23,64 +28,32 @@ export declare type Script = {
     /**
      * A list of languages that use this script.
      */
-    associated_languages: {
-        /**
-         * The language's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+    associated_languages: LanguageReference[];
     /**
      * The continents this script is present on.
      * @minItems 1
      */
-    continent: {
-        /**
-         * The continent's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 3
-         */
-        id: number;
-        /**
-         * Is the script considered virtually extinct in this continent?
-         */
-        is_extinct: boolean;
-    }[];
+    continent: AssociatedContinent[];
     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 language.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * A list of alternative names.
-             * @minLength 1
-             */
-            alternative_names?: {
-                /**
-                 * An alternative name of the language.
-                 * @minLength 1
-                 */
-                name: string;
-            }[];
-            /**
-             * The description of the alphabet.
-             * @minLength 1
-             */
-            alphabet?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ScriptTranslation>;
+};
+export declare type ScriptTranslation = {
+    /**
+     * The name of the language.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * The description of the alphabet.
+     */
+    alphabet?: NonEmptyString;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Script>;

package/lib/types/specialAbility/sub/TradeSecret.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";
 import { GeneralPrerequisites } from "../../_Prerequisite.js";
 /**
  * @title Trade Secret
@@ -28,26 +30,18 @@ export declare type TradeSecret = {
     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 trade secret.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The description of the trade secret.
-             * @markdown
-             * @minLength 1
-             */
-            description?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<TradeSecretTranslation>;
+};
+export declare type TradeSecretTranslation = {
+    /**
+     * The name of the trade secret.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the trade secret.
+     */
+    description?: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<TradeSecret>;

package/lib/types/specialAbility/sub/_LanguageScript.d.ts

@@ -0,0 +1,13 @@
+export declare type AssociatedContinent = {
+    /**
+     * The continent's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 3
+     */
+    id: number;
+    /**
+     * Is the language considered virtually extinct in this continent?
+     */
+    is_extinct: boolean;
+};

package/lib/types/specialAbility/sub/_LanguageScript.js

@@ -0,0 +1 @@
+export {};

package/lib/types/traditionArtifacts/ArcaneOrbEnchantment.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Arcane Orb Enchantment
@@ -21,30 +22,25 @@ export declare type ArcaneOrbEnchantment = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ArcaneOrbEnchantmentTranslation>;
+};
+export declare type ArcaneOrbEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ArcaneOrbEnchantment>;

package/lib/types/traditionArtifacts/AttireEnchantment.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Attire Enchantment
@@ -21,30 +22,25 @@ export declare type AttireEnchantment = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AttireEnchantmentTranslation>;
+};
+export declare type AttireEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AttireEnchantment>;

package/lib/types/traditionArtifacts/BowlEnchantment.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Bowl Enchantment
@@ -21,30 +22,25 @@ export declare type BowlEnchantment = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<BowlEnchantmentTranslation>;
+};
+export declare type BowlEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<BowlEnchantment>;

package/lib/types/traditionArtifacts/CauldronEnchantment.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Cauldron Enchantment
@@ -19,45 +20,41 @@ export declare type CauldronEnchantment = {
      * Witches can learn to brew special things in their Witch's Cauldron. These
      * brews can be categorized in different types.
      */
-    brew: {
-        /**
-         * The brew's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 4
-         */
-        id: number;
-    };
-    cost?: Activatable.EnchantmentCost;
+    brew: BrewReference;
+    cost: Activatable.EnchantmentCost;
     property: Activatable.Property;
     ap_value: Activatable.AdventurePointsValue;
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<CauldronEnchantmentTranslation>;
+};
+export declare type BrewReference = {
+    /**
+     * The brew's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 4
+     */
+    id: number;
+};
+export declare type CauldronEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<CauldronEnchantment>;