optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/Property.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main Property
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { SkillCheck } from "./_SkillCheck.js";
 /**
  * @title Property
@@ -19,19 +21,13 @@ export declare type Property = {
     check?: SkillCheck;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The property's name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<PropertyTranslation>;
+};
+export declare type PropertyTranslation = {
+    /**
+     * The property's name.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Property>;

package/lib/types/Race.d.ts

@@ -4,7 +4,10 @@
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { CommonnessRatedAdvantageDisadvantage } from "./_CommonnessRatedAdvantageDisadvantage.js";
-import { Dice, DieType } from "./_Dice.js";
+import { Dice } from "./_Dice.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { AdvantageReference, AttributeReference, CultureReference, EyeColorReference, HairColorReference } from "./_SimpleReferences.js";
 /**
  * A playable race with stats and skills.
  * @title Race
@@ -30,14 +33,14 @@ export declare type Race = {
      * Describes how to raise or lower maximum attribute values during character
      * creation.
      */
-    attribute_adjustments: AttributeAdjustments.Config;
+    attribute_adjustments: AttributeAdjustments;
     /**
      * A list of automatically applied advantages. This does only work for
      * advantages with no further configuration such as level or special
      * selection.
      * @minItems 1
      */
-    automatic_advantages?: AutomaticAdvantage[];
+    automatic_advantages?: AdvantageReference[];
     /**
      * A list of strongly recommended advantages.
      * @minItems 1
@@ -79,7 +82,7 @@ export declare type Race = {
     /**
      * Configuration for random weight generation.
      */
-    weight: Weight.Config;
+    weight: Weight;
     /**
      * Defines the starting ages for the race. It depends on the selected
      * experience level.
@@ -94,23 +97,17 @@ export declare type Race = {
      * This excludes common and uncommon advantages and disadvantages, since they
      * may be defined for the whole race even if variants exist.
      */
-    variant_dependent: VariantDependent;
+    variant_dependent: RaceVariantDependent;
     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]: RaceTranslation;
-    };
+     */
+    translations: LocaleMap<RaceTranslation>;
 };
 /**
  * The race’s base values.
  */
-declare type BaseValues = {
+export declare type BaseValues = {
     /**
      * The race’s life point base value.
      * @integer
@@ -133,121 +130,69 @@ declare type BaseValues = {
      */
     movement: number;
 };
-declare namespace AttributeAdjustments {
+/**
+ * Describes how to raise or lower maximum attribute values during character
+ * creation.
+ */
+export declare type AttributeAdjustments = AttributeAdjustment[];
+/**
+ * An array of attribute maximum modifiers. The value will be added to the
+ * current maximum of the selected attribute that has been chosen from the
+ * listed attributes (negative values will lower the maximum).
+ * @minItems 1
+ */
+export declare type AttributeAdjustment = {
     /**
-     * Describes how to raise or lower maximum attribute values during character
-     * creation.
+     * The value by which the selected attribute's maximum is modified
+     * (negative values will lower the maximum).
+     * @integer
+     */
+    value: number;
+    /**
+     * A list of attributes the player has to choose from. If only one attribute
+     * is listed, no attribute has to be chosen.
+     * @minItems 1
      */
-    type Config = {
-        /**
-         * An array of attribute maximum modifiers. The value will be added to the
-         * current maximum of the ID-specified attribute (negative values will lower
-         * the maximum).
-         * @minItems 1
-         */
-        fix?: Fix[];
-        /**
-         * Used if the player has to choose between different modifiers.
-         */
-        selection: Selection;
-    };
-    type Fix = {
-        /**
-         * The attribute's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 8
-         */
-        id: number;
-        /**
-         * The value by which the attribute's maximum is modified (negative values
-         * will lower the maximum).
-         * @integer
-         */
-        value: number;
-    };
-    type Selection = {
-        /**
-         * The value by which the selected attribute's maximum is modified
-         * (negative values will lower the maximum).
-         * @integer
-         */
-        value: number;
-        /**
-         * A list of attributes the player has to choose from.
-         * @minItems 2
-         */
-        list: SelectionItem[];
-    };
-    type SelectionItem = {
-        /**
-         * The attribute's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 8
-         */
-        id: number;
-    };
-}
-declare type AutomaticAdvantage = {
-    /**
-     * The advantage's identifier.
+    list: AttributeReference[];
+};
+/**
+ * Configuration for random weight generation.
+ */
+export declare type Weight = {
+    /**
+     * The base value used for random weight. The height subtrahend; in case of
+     * `Height - 110 + 2D6` it is `110`.
      * @integer
      * @minimum 1
      */
-    id: number;
-};
-declare namespace Weight {
+    base: number;
     /**
-     * Configuration for random weight generation.
+     * The dice used for random weight.
+     * @minItems 1
      */
-    export type Config = {
-        /**
-         * The base value used for random weight. The height subtrahend; in case of
-         * `Height - 110 + 2D6` it is `110`.
-         * @integer
-         * @minimum 1
-         */
-        base: number;
-        /**
-         * The dice used for random weight.
-         * @minItems 1
-         */
-        random: Die[];
-    };
-    type Die = {
-        /**
-         * Number of dice of the same type. Example: 2 in 2D6.
-         * @integer
-         * @minimum 1
-         */
-        number: number;
-        /**
-         * Number of sides on every die. Example: 6 in 2D6.
-         */
-        sides: DieType;
-        /**
-         * The strategy how to offset the randomly generated values against the
-         * base value. Either they are all added or subtracted or even results are
-         * added and odd results are subtracted.
-         */
-        offset_strategy: OffsetStrategy;
-    };
+    random: WeightDice[];
+};
+export declare type WeightDice = Dice & {
     /**
      * The strategy how to offset the randomly generated values against the
      * base value. Either they are all added or subtracted or even results are
      * added and odd results are subtracted.
      */
-    type OffsetStrategy = {
-        tag: "Add";
-    } | {
-        tag: "Subtract";
-    } | {
-        tag: "AddEvenSubtractOdd";
-    };
-    export {};
-}
-declare type StartingAgeConfigForExperienceLevel = {
+    offset_strategy: WeightDiceOffsetStrategy;
+};
+/**
+ * The strategy how to offset the randomly generated values against the
+ * base value. Either they are all added or subtracted or even results are
+ * added and odd results are subtracted.
+ */
+export declare type WeightDiceOffsetStrategy = {
+    tag: "Add";
+} | {
+    tag: "Subtract";
+} | {
+    tag: "AddEvenSubtractOdd";
+};
+export declare type StartingAgeConfigForExperienceLevel = {
     /**
      * The selected experience level's identifier.
      * @integer
@@ -274,32 +219,36 @@ declare type StartingAgeConfigForExperienceLevel = {
  * This excludes common and uncommon advantages and disadvantages, since they
  * may be defined for the whole race even if variants exist.
  */
-declare type VariantDependent = {
+export declare type RaceVariantDependent = {
     tag: "HasVariants";
-    /**
-     * A list of available race variants.
-     * @minItems 1
-     */
-    variants: RaceVariant[];
+    has_variants: RaceVariants;
 } | {
     tag: "Plain";
+    plain: ValuesForRaceWithoutVariants;
+};
+/**
+ * A list of available race variants.
+ * @minItems 1
+ */
+export declare type RaceVariants = RaceVariant[];
+export declare type ValuesForRaceWithoutVariants = {
     /**
      * The list of common cultures.
      * @minItems 1
      */
-    common_cultures: CommonCulture[];
+    common_cultures: CultureReference[];
     /**
      * An array containing 20 (numeric) hair color identifiers. The array also represents the 20-sided die for a random hair color.
      * @minItems 20
      * @maxItems 20
      */
-    hair_color: HairColor[];
+    hair_color: HairColorReference[];
     /**
      * An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color.
      * @minItems 20
      * @maxItems 20
      */
-    eye_color: EyeColor[];
+    eye_color: EyeColorReference[];
     /**
      * Configuration for random height generation.
      */
@@ -308,7 +257,7 @@ declare type VariantDependent = {
 /**
  * @title Race Variant
  */
-declare type RaceVariant = {
+export declare type RaceVariant = {
     /**
      * An unique, increasing integer.
      * @integer
@@ -319,7 +268,7 @@ declare type RaceVariant = {
      * The list of common cultures.
      * @minItems 1
      */
-    common_cultures: CommonCulture[];
+    common_cultures: CultureReference[];
     /**
      * A list of common advantages. If common advantages are defined by the base race, leave this field empty. This field overrides the same field of the base race, if both are defined.
      * @minItems 1
@@ -345,56 +294,26 @@ declare type RaceVariant = {
      * @minItems 20
      * @maxItems 20
      */
-    hair_color: HairColor[];
+    hair_color: HairColorReference[];
     /**
      * An array containing 20 (numeric) eye color identifiers. The array also represents the 20-sided die for a random eye color.
      * @minItems 20
      * @maxItems 20
      */
-    eye_color: EyeColor[];
+    eye_color: EyeColorReference[];
     /**
      * Configuration for random height generation.
      */
     height: Height;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
-     */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: RaceVariantTranslation;
-    };
-};
-declare type CommonCulture = {
-    /**
-     * The culture's identifier.
-     * @integer
-     * @minimum 1
      */
-    id: number;
-};
-declare type HairColor = {
-    /**
-     * The hair color's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-declare type EyeColor = {
-    /**
-     * The hair color's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    translations: LocaleMap<RaceVariantTranslation>;
 };
 /**
  * Configuration for random height generation.
  */
-declare type Height = {
+export declare type Height = {
     /**
      * The base value used for random height.
      * @integer
@@ -407,97 +326,83 @@ declare type Height = {
      */
     random: Dice[];
 };
-declare type RaceVariantTranslation = {
+export declare type RaceVariantTranslation = {
     /**
      * The race variant's name.
-     * @minLength 1
      */
-    name: string;
+    name: NonEmptyString;
     /**
      * The respective common advantages text from the source book. If common
      * advantages are defined by the base race, leave this field empty. This field
      * overrides the same field of the base race, if both are defined.
-     * @minLength 1
      */
-    common_advantages?: string;
+    common_advantages?: NonEmptyString;
     /**
      * The respective common disadvantages text from the source book. If common
      * disadvantages are defined by the base race, leave this field empty. This
      * field overrides the same field of the base race, if both are defined.
-     * @minLength 1
      */
-    common_disadvantages?: string;
+    common_disadvantages?: NonEmptyString;
     /**
      * The respective uncommon advantages text from the source book. If uncommon
      * advantages are defined by the base race, leave this field empty. This field
      * overrides the same field of the base race, if both are defined.
-     * @minLength 1
      */
-    uncommon_advantages?: string;
+    uncommon_advantages?: NonEmptyString;
     /**
      * The respective uncommon disadvantages text from the source book. If
      * uncommon disadvantages are defined by the base race, leave this field
      * empty. This field overrides the same field of the base race, if both are
      * defined.
-     * @minLength 1
      */
-    uncommon_disadvantages?: string;
+    uncommon_disadvantages?: NonEmptyString;
 };
-declare type RaceTranslation = {
+export declare type RaceTranslation = {
     /**
      * The race's name.
-     * @minLength 1
      */
-    name: string;
+    name: NonEmptyString;
     /**
      * The respective attribute adjustments text from the source book.
-     * @minLength 1
      */
-    attribute_adjustments: string;
+    attribute_adjustments: NonEmptyString;
     /**
      * The respective automatic advantages text from the source book.
-     * @minLength 1
      */
-    automatic_advantages?: string;
+    automatic_advantages?: NonEmptyString;
     /**
      * The respective strongly recommended advantages text from the source book.
-     * @minLength 1
      */
-    strongly_recommended_advantages?: string;
+    strongly_recommended_advantages?: NonEmptyString;
     /**
-     * The respective strongly recommended disadvantages text from the source book.
-     * @minLength 1
+     * The respective strongly recommended disadvantages text from the source
+     * book.
      */
-    strongly_recommended_disadvantages?: string;
+    strongly_recommended_disadvantages?: NonEmptyString;
     /**
      * The respective common advantages text from the source book. If common
      * advantages are defined by race variants, leave this field empty. It is
      * overridden by the same field in race variants.
-     * @minLength 1
      */
-    common_advantages?: string;
+    common_advantages?: NonEmptyString;
     /**
      * The respective common disadvantages text from the source book. If common
      * disadvantages are defined by race variants, leave this field empty. It is
      * overridden by the same field in race variants.
-     * @minLength 1
      */
-    common_disadvantages?: string;
+    common_disadvantages?: NonEmptyString;
     /**
      * The respective uncommon advantages text from the source book. If uncommon
      * advantages are defined by race variants, leave this field empty. It is
      * overridden by the same field in race variants.
-     * @minLength 1
      */
-    uncommon_advantages?: string;
+    uncommon_advantages?: NonEmptyString;
     /**
      * The respective uncommon disadvantages text from the source book. If
      * uncommon disadvantages are defined by race variants, leave this field
      * empty. It is overridden by the same field in race variants.
-     * @minLength 1
      */
-    uncommon_disadvantages?: string;
+    uncommon_disadvantages?: NonEmptyString;
     errata?: Errata;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Race>;
-export {};

package/lib/types/Region.d.ts

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