optolith-database-schema 0.2.3 → 0.4.0

package/lib/types/PactCategory.d.ts

@@ -3,6 +3,8 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Pact Category
  */
@@ -17,75 +19,59 @@ export declare type PactCategory = {
      * Types of creatures in this category.
      * @minItems 1
      */
-    types: {
-        /**
-         * The type'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 type.
-                 * @minLength 1
-                 */
-                name: string;
-            };
-        };
-    }[];
+    types: PactType[];
     /**
      * Domains in this category.
      * @minItems 1
      */
-    domains: {
-        /**
-         * The domain'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 domain.
-                 * @minLength 1
-                 */
-                name: string;
-            };
-        };
-    }[];
+    domains: PactDomain[];
     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 pact category.
-             * @minLength 1
-             */
-            name: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<PactCategoryTranslation>;
+};
+export declare type PactCategoryTranslation = {
+    /**
+     * The name of the pact category.
+     */
+    name: NonEmptyString;
+    errata?: Errata;
+};
+export declare type PactType = {
+    /**
+     * The type's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PactTypeTranslation>;
+};
+export declare type PactTypeTranslation = {
+    /**
+     * The name of the type.
+     */
+    name: NonEmptyString;
+};
+export declare type PactDomain = {
+    /**
+     * The domain's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PactDomainTranslation>;
+};
+export declare type PactDomainTranslation = {
+    /**
+     * The name of the domain.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<PactCategory>;

package/lib/types/Patron.d.ts

@@ -2,6 +2,9 @@
  * @main Patron
  */
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { CultureReference, PatronCategoryReference, SkillReference } from "./_SimpleReferences.js";
 /**
  * @title Patron
  */
@@ -13,11 +16,9 @@ export declare type Patron = {
      */
     id: number;
     /**
-     * The patron's category identifier.
-     * @integer
-     * @minimum 1
+     * The patron's category.
      */
-    category_id: number;
+    category: PatronCategoryReference;
     /**
      * The patron-specific skills.
      */
@@ -28,43 +29,13 @@ export declare type Patron = {
      * and it may be available to all except specific ones to the listed cultures
      * (difference).
      */
-    culture: {
-        tag: "All";
-    } | {
-        tag: "Intersection";
-        list: {
-            /**
-             * The culture's identifier.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-        }[];
-    } | {
-        tag: "Difference";
-        list: {
-            /**
-             * The culture's identifier.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-        }[];
-    };
+    culture: PatronCulture;
     /**
      * The list of cultures where patrons from this category can be the primary
      * patron of.
-     * @minItems 1
      * @uniqueItems
      */
-    primary_patron_cultures?: {
-        /**
-         * The culture's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+    primary_patron_cultures?: CultureReference[];
     /**
      * The patron-specific powers. Used by animist power Animal Powers I–III and
      * should only be present on animal patrons.
@@ -85,31 +56,35 @@ export declare type Patron = {
     improvement_cost?: ImprovementCost;
     /**
      * 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 patron.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+     */
+    translations: LocaleMap<PatronTranslation>;
 };
-export declare type SkillReference = {
+export declare type PatronTranslation = {
     /**
-     * The skill's identifier.
-     * @integer
-     * @minimum 1
+     * The name of the patron.
      */
-    id: number;
+    name: NonEmptyString;
 };
-export declare type AnimalPowerLevel1 = {
-    tag: "Advantage";
+/**
+ * The patron cultures the patron is or is not part of. If the patron is part of
+ * all patron cultures, the set should be empty and the operation should be
+ * difference.
+ */
+export declare type PatronCulture = {
+    set: CultureReference[];
+    operation: PatronCultureOperation;
+};
+/**
+ * The set operation to combine the set of all patron cultures with the
+ * specified set of patron cultures: If they should intersect, the patron is
+ * only part of the given cultures. If they should differ, the patron is only
+ * part of the cultures that are not given.
+ */
+export declare enum PatronCultureOperation {
+    Intersection = "Intersection",
+    Difference = "Difference"
+}
+export declare type AdvantageAnimalPower = {
     /**
      * The advantage's identifier.
      * @integer
@@ -128,8 +103,8 @@ export declare type AnimalPowerLevel1 = {
      * @minimum 1
      */
     option?: number;
-} | {
-    tag: "Skill";
+};
+export declare type SkillAnimalPower = {
     /**
      * The skill's identifier.
      * @integer
@@ -143,28 +118,22 @@ export declare type AnimalPowerLevel1 = {
      */
     points: number;
 };
+export declare type AnimalPowerLevel1 = {
+    tag: "Advantage";
+    advantage: AdvantageAnimalPower;
+} | {
+    tag: "Skill";
+    skill: SkillAnimalPower;
+};
 /**
  * @minItems 1
  */
 export declare type AnimalPowersLevel1 = AnimalPowerLevel1[];
-export declare type AnimalPowerLevel2 = {
-    tag: "Combat";
+export declare type CombatAnimalPower = {
     /**
      * The combat value.
      */
-    id: {
-        tag: "Attack";
-    } | {
-        tag: "Parry";
-    } | {
-        tag: "RangedCombat";
-    } | {
-        tag: "Dodge";
-    } | {
-        tag: "DamagePoints";
-    } | {
-        tag: "Protection";
-    };
+    id: CombatAnimalPowerType;
     /**
      * The value that gets added to the combat value.
      * @integer
@@ -172,12 +141,23 @@ export declare type AnimalPowerLevel2 = {
      */
     value: number;
 };
+export declare enum CombatAnimalPowerType {
+    Attack = "Attack",
+    Parry = "Parry",
+    RangedCombat = "RangedCombat",
+    Dodge = "Dodge",
+    DamagePoints = "DamagePoints",
+    Protection = "Protection"
+}
+export declare type AnimalPowerLevel2 = {
+    tag: "Combat";
+    combat: CombatAnimalPower;
+};
 /**
  * @minItems 1
  */
 export declare type AnimalPowersLevel2 = AnimalPowerLevel2[];
-export declare type AnimalPowerLevel3 = {
-    tag: "Attribute";
+export declare type AttributeAnimalPower = {
     /**
      * The attribute's identifier.
      * @integer
@@ -191,6 +171,10 @@ export declare type AnimalPowerLevel3 = {
      */
     value: number;
 };
+export declare type AnimalPowerLevel3 = {
+    tag: "Attribute";
+    attribute: AttributeAnimalPower;
+};
 /**
  * @minItems 1
  */

package/lib/types/Patron.js

@@ -2,4 +2,24 @@
  * @main Patron
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * The set operation to combine the set of all patron cultures with the
+ * specified set of patron cultures: If they should intersect, the patron is
+ * only part of the given cultures. If they should differ, the patron is only
+ * part of the cultures that are not given.
+ */
+export var PatronCultureOperation;
+(function (PatronCultureOperation) {
+    PatronCultureOperation["Intersection"] = "Intersection";
+    PatronCultureOperation["Difference"] = "Difference";
+})(PatronCultureOperation || (PatronCultureOperation = {}));
+export var CombatAnimalPowerType;
+(function (CombatAnimalPowerType) {
+    CombatAnimalPowerType["Attack"] = "Attack";
+    CombatAnimalPowerType["Parry"] = "Parry";
+    CombatAnimalPowerType["RangedCombat"] = "RangedCombat";
+    CombatAnimalPowerType["Dodge"] = "Dodge";
+    CombatAnimalPowerType["DamagePoints"] = "DamagePoints";
+    CombatAnimalPowerType["Protection"] = "Protection";
+})(CombatAnimalPowerType || (CombatAnimalPowerType = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/PatronCategory.d.ts

@@ -1,6 +1,9 @@
 /**
  * @main PatronCategory
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { CultureReference } from "./_SimpleReferences.js";
 /**
  * @title Patron Category
  */
@@ -17,29 +20,16 @@ export declare type PatronCategory = {
      * @minItems 1
      * @uniqueItems
      */
-    primary_patron_cultures: {
-        /**
-         * The culture's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+    primary_patron_cultures: CultureReference[];
     /**
      * 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 patron category.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<PatronCategoryTranslation>;
+};
+export declare type PatronCategoryTranslation = {
+    /**
+     * The name of the patron category.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<PatronCategory>;

package/lib/types/PersonalityTrait.d.ts

@@ -3,8 +3,14 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { PersonalityTraitPrerequisites } from "./_Prerequisite.js";
+import { PersonalityTraitReference } from "./_SimpleReferences.js";
 /**
+ * A personality trait describes character aspects of a person from a certain
+ * region. Higher trait levels only cover a part of the region covered by
+ * lower-level traits.
  * @title Personality Trait
  */
 export declare type PersonalityTrait = {
@@ -27,48 +33,34 @@ export declare type PersonalityTrait = {
      * @minItems 1
      * @uniqueItems
      */
-    combination_options?: {
-        /**
-         * The referenced personality trait's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+    combination_options?: PersonalityTraitReference[];
     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 personality trait.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effects of the personality trait. They should be sorted like they
-             * are in the book.
-             * @minItems 1
-             */
-            effects: {
-                /**
-                 * A label that is displayed and placed before the actual text.
-                 * @minLength 1
-                 */
-                label?: string;
-                /**
-                 * The effect text.
-                 * @minLength 1
-                 */
-                text: string;
-            }[];
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<PersonalityTraitTranslation>;
+};
+export declare type PersonalityTraitTranslation = {
+    /**
+     * The name of the personality trait.
+     */
+    name: NonEmptyString;
+    /**
+     * The effects of the personality trait. They should be sorted like they
+     * are in the book.
+     * @minItems 1
+     */
+    effects: PersonalityTraitEffect[];
+    errata?: Errata;
+};
+export declare type PersonalityTraitEffect = {
+    /**
+     * A label that is displayed and placed before the actual text.
+     */
+    label?: NonEmptyString;
+    /**
+     * The effect text.
+     */
+    text: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<PersonalityTrait>;