optolith-database-schema 0.2.2 → 0.3.0

package/lib/main.js

@@ -1,5 +1,5 @@
-import Ajv from "ajv";
 import addFormats from "ajv-formats";
+import Ajv from "ajv/dist/2020.js";
 import { lstat, readdir, readFile } from "fs/promises";
 import { join } from "path";
 import YAML from "yaml";

package/lib/types/Advantage.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 { AdvantageDisadvantagePrerequisites } from "./_Prerequisite.js";
 /**
  * @title Advantage
@@ -18,36 +19,33 @@ export declare type Advantage = {
     prerequisites?: AdvantageDisadvantagePrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     /**
-     * Does this advantage not count towards the maximum of AP to be spent
-     * on advantages?
+     * Does this advantage count towards the maximum of AP to be spent on
+     * advantages?
+     * @default true
      */
-    has_no_maximum_spent_influence?: true;
+    has_maximum_spent_influence: boolean;
     /**
-     * Does this advantage exclusively applies to arcane spellworks but not
-     * to magical actions and applications?
+     * Does this advantage exclusively applies to arcane spellworks and not
+     * to magical actions and magical applications?
+     * @default false
      */
-    is_exclusive_to_arcane_spellworks?: true;
+    is_exclusive_to_arcane_spellworks: boolean;
     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;
-            rules: Activatable.Rules;
-            /**
-             * The range.
-             * @markdown
-             * @minLength 1
-             */
-            range?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AdvantageTranslation>;
+};
+export declare type AdvantageTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    /**
+     * The range.
+     * @markdown
+     * @minLength 1
+     */
+    range?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Advantage>;

package/lib/types/AnimalDisease.d.ts

@@ -1,8 +1,10 @@
 /**
  * @main AnimalDisease
  */
-import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { Cause, DiseaseTranslation, Resistance } from "./_DiseasePoison.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AnimalTypeReference } from "./_SimpleReferences.js";
 /**
  * @title Animal Disease
  */
@@ -24,229 +26,33 @@ export declare type AnimalDisease = {
      * disease roll. It may also happen that the lower of both is applied as a
      * penalty.
      */
-    resistance: {
-        tag: "Spirit";
-    } | {
-        tag: "Toughness";
-    } | {
-        tag: "LowerOfSpiritAndToughness";
-    };
+    resistance: Resistance;
     /**
      * What causes the disease? The GM rolls 1D20 to see if a character gets
      * infected. If the infection check succeeds, the GM makes a disease check to
      * determine the severity of the infection.
      * @minItems 1
      */
-    cause: {
-        /**
-         * The chance to get infected by this cause, in percent.
-         * @integer
-         * @minimum 5
-         * @multipleOf 5
-         * @maximum 100
-         */
-        chance?: 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 cause.
-                 * @minLength 1
-                 */
-                name: string;
-                /**
-                 * The chance to get infected by this cause. If present for this
-                 * language, this overrides the universal `chance` field; they cannot be
-                 * used at the same time.
-                 * @minLength 1
-                 */
-                chance?: string;
-                /**
-                 * An additional note about this cause.
-                 * @minLength 1
-                 */
-                note?: string;
-            };
-        };
-    }[];
+    cause: Cause[];
     /**
      * The animal types this disease applies to.
+     *
+     * If no animal types are given, the animal disease applies to all animal
+     * types.
      */
-    animal_types: {
-        tag: "All";
-    } | {
-        tag: "Specific";
-        /**
-         * The list of specific animal types this disease applies to.
-         * @minItems 1
-         */
-        list: {
-            /**
-             * The animal type's identifier.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-        }[];
-    };
-    communicability_to_intelligent_creatures: {
-        tag: "NonCommunicable";
-    } | {
-        tag: "Communicable";
-        /**
-         * What causes the communication? The GM rolls 1D20 to see if a character
-         * gets infected. If the infection check succeeds, the GM makes a disease
-         * check to determine the severity of the infection.
-         * @minItems 1
-         */
-        cause: {
-            /**
-             * The chance to get infected by this cause, in percent.
-             * @integer
-             * @minimum 5
-             * @multipleOf 5
-             * @maximum 100
-             */
-            chance?: 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 cause.
-                     * @minLength 1
-                     */
-                    name: string;
-                    /**
-                     * The chance to get infected by this cause. If present for this
-                     * language, this overrides the universal `chance` field; they
-                     * cannot be used at the same time.
-                     * @minLength 1
-                     */
-                    chance?: string;
-                    /**
-                     * An additional note about this communication cause.
-                     * @minLength 1
-                     */
-                    note?: string;
-                };
-            };
-        }[];
-    };
+    animal_types: AnimalTypeReference[];
+    /**
+     * If and at which chance the disease can be communicated to intelligent
+     * creatures.
+     *
+     * If no causes are given, the disease is not communicable to intelligent
+     * creatures.
+     */
+    communicability_to_intelligent_creatures: Cause[];
     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 animal disease.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * A list of alternative names.
-             * @minItems 1
-             */
-            alternative_names?: {
-                /**
-                 * An alternative name of the animal disease.
-                 * @minLength 1
-                 */
-                name: string;
-                /**
-                 * The region where this alternative name is used.
-                 * @minLength 1
-                 */
-                region?: string;
-            }[];
-            /**
-             * The disease’s progress, in detail.
-             * @markdown
-             * @minLength 1
-             */
-            progress: string;
-            /**
-             * After infection, how much time passes before symptoms appear?
-             * @minLength 1
-             */
-            incubation_time: string;
-            /**
-             * The damage caused by the disease. If the disease check fails, apply the
-             * lessened effects.
-             */
-            damage: {
-                /**
-                 * The disease’s default damage. In the source, it's the text before the
-                 * slash.
-                 * @markdown
-                 * @minLength 1
-                 */
-                default: string;
-                /**
-                 * The disease’s lessened damage. In the source, it's the text after the
-                 * slash.
-                 * @markdown
-                 * @minLength 1
-                 */
-                lessened?: string;
-            };
-            /**
-             * The duration of the disease. If the disease check fails, use the
-             * lessened duration.
-             */
-            duration: {
-                /**
-                 * The default duration of the disease. In the source, it's the text
-                 * before the slash.
-                 * @markdown
-                 * @minLength 1
-                 */
-                default: string;
-                /**
-                 * The lessened duration of the disease. In the source, it's the text
-                 * after the slash.
-                 * @markdown
-                 * @minLength 1
-                 */
-                lessened?: string;
-            };
-            /**
-             * Special information about the disease.
-             * @markdown
-             * @minLength 1
-             */
-            special?: string;
-            /**
-             * Methods known to lessen the disease’s progress or relieve symptoms.
-             * @markdown
-             * @minLength 1
-             */
-            treatment: string;
-            /**
-             * Known remedies for the disease.
-             * @markdown
-             * @minLength 1
-             */
-            cure: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<DiseaseTranslation>;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<AnimalDisease>;

package/lib/types/AnimalType.d.ts

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

package/lib/types/ArcaneBardTradition.d.ts

@@ -1,33 +1,9 @@
 /**
  * @main ArcaneBardTradition
  */
-import { ArcaneTraditionPrerequisites } from "./_Prerequisite.js";
+import { ArcaneTradition } from "./_ArcaneTradition.js";
 /**
  * @title Arcane Bard Tradition
  */
-export declare type ArcaneBardTradition = {
-    /**
-     * The arcane bard tradition's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    prerequisites: ArcaneTraditionPrerequisites;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
-     */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The arcane bard tradition's name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
-};
-export declare const validateSchema: import("../validation/schema.js").TypeValidator<ArcaneBardTradition>;
+export declare type ArcaneBardTradition = ArcaneTradition;
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<ArcaneTradition>;

package/lib/types/ArcaneDancerTradition.d.ts

@@ -1,33 +1,9 @@
 /**
  * @main ArcaneDancerTradition
  */
-import { ArcaneTraditionPrerequisites } from "./_Prerequisite.js";
+import { ArcaneTradition } from "./_ArcaneTradition.js";
 /**
  * @title Arcane Dancer Tradition
  */
-export declare type ArcaneDancerTradition = {
-    /**
-     * The arcane dancer tradition's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    prerequisites: ArcaneTraditionPrerequisites;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
-     */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The arcane dancer tradition's name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
-};
-export declare const validateSchema: import("../validation/schema.js").TypeValidator<ArcaneDancerTradition>;
+export declare type ArcaneDancerTradition = ArcaneTradition;
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<ArcaneTradition>;

package/lib/types/Aspect.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main Aspect
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Aspect
  */
@@ -13,25 +15,18 @@ export declare type Aspect = {
     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 aspect name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The aspect's name appended to the simple name (not `name_in_library`)
-             * of the special ability *Master of (Aspect)*.
-             * @minLength 1
-             */
-            master_of_aspect_suffix?: string;
-        };
-    };
+    translations: LocaleMap<AspectTranslation>;
+};
+export declare type AspectTranslation = {
+    /**
+     * The aspect name.
+     */
+    name: NonEmptyString;
+    /**
+     * The aspect's name appended to the simple name (not `name_in_library`)
+     * of the special ability *Master of (Aspect)*.
+     */
+    master_of_aspect_suffix?: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Aspect>;

package/lib/types/Attribute.d.ts

@@ -2,6 +2,8 @@
  * @main Attribute
  */
 import { ReferencialIntegrityValidators } from "../validation/integrity.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Attribute
  */
@@ -14,30 +16,22 @@ export declare type Attribute = {
     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 attribute's name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The abbreviation of the attribute's name.
-             * @minLength 1
-             */
-            abbreviation: string;
-            /**
-             * The description of the attribute.
-             * @minLength 1
-             */
-            description: string;
-        };
-    };
+    translations: LocaleMap<AttributeTranslation>;
+};
+export declare type AttributeTranslation = {
+    /**
+     * The attribute's name.
+     */
+    name: NonEmptyString;
+    /**
+     * The abbreviation of the attribute's name.
+     */
+    abbreviation: NonEmptyString;
+    /**
+     * The description of the attribute.
+     */
+    description: NonEmptyString;
 };
 export declare const validateIntegrity: (attribute: Attribute, { checkLocaleId }: ReferencialIntegrityValidators) => string[];
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Attribute>;