optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/Ceremony.d.ts

@@ -3,9 +3,14 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill.js";
+import { SlowPerformanceParameters } from "./_ActivatableSkill.js";
+import { Effect } from "./_ActivatableSkillEffect.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { SkillTradition } from "./_Blessed.js";
 import { Enhancements } from "./_Enhancements.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { LiturgyPrerequisites } from "./_Prerequisite.js";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck.js";
 /**
@@ -33,14 +38,14 @@ export declare type Ceremony = {
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     /**
      * The tradition(s) the ceremony is available for. Note that general aspects
      * do not have an associated tradition and thus need to be defined in a
      * special way.
      * @minItems 1
      */
-    traditions: Tradition[];
+    traditions: SkillTradition[];
     /**
      * States which column is used to improve the skill.
      */
@@ -49,97 +54,59 @@ export declare type Ceremony = {
     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 ceremony.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * A compressed name of the ceremony for use in small areas (e.g. on
-             * character sheet). Should only be defined if the `name` does not fit on
-             * character sheet.
-             * @minLength 1
-             */
-            name_compressed?: 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
-             */
-            casting_time: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            cost: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            range: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            duration: {
-                full: string;
-                abbr: string;
-            };
-            /**
-             * @deprecated
-             */
-            target: string;
-            errata?: Errata;
-        };
-    };
+     */
+    translations: LocaleMap<CeremonyTranslation>;
     enhancements?: Enhancements;
 };
-export declare type Tradition = {
-    tag: "GeneralAspect";
+export declare type CeremonyTranslation = {
     /**
-     * A general aspect's identifier.
-     * @integer
-     * @minimum 1
+     * The name of the ceremony.
      */
-    id: number;
-} | {
-    tag: "Tradition";
+    name: NonEmptyString;
     /**
-     * The blessed tradition's identifier.
-     * @integer
-     * @minimum 1
+     * A compressed name of the ceremony for use in small areas (e.g. on
+     * character sheet). Should only be defined if the `name` does not fit on
+     * character sheet.
      */
-    id: number;
+    name_compressed?: NonEmptyString;
     /**
-     * The aspect(s) from the tradition the ceremony belongs to. Note that not
-     * all traditions have aspects.
-     * @minItems 1
-     * @maxItems 2
-     */
-    aspects?: {
-        /**
-         * The aspect's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-    }[];
+     * 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
+     */
+    casting_time: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    range: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Ceremony>;

package/lib/types/CombatTechnique_Close.d.ts

@@ -4,6 +4,8 @@
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AttributeReference } from "./_SimpleReferences.js";
 /**
  * @title Close Combat Technique
  */
@@ -18,19 +20,14 @@ export declare type CloseCombatTechnique = {
      * Special rules for the combat technique that apply to all weapons in this
      * category.
      */
-    special: {
-        /**
-         * Is parrying possible with this combat technique?
-         */
-        parrying: Parrying;
-    };
+    special: CloseCombatTechniqueSpecialRules;
     /**
      * The primary attribute(s).
      * @minItems 1
      * @maxItems 2
      * @uniqueItems
      */
-    primary_attribute: PrimaryAttribute[];
+    primary_attribute: AttributeReference[];
     /**
      * The *Breaking Point Rating* of the respective combat technique.
      * @integer
@@ -41,41 +38,35 @@ export declare type CloseCombatTechnique = {
     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 condition.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * Additional rules for the condition, if applicable.
-             * @markdown
-             * @minLength 1
-             */
-            special?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<CloseCombatTechniqueTranslation>;
 };
 /**
- * Is parrying possible with this combat technique?
+ * Special rules for the combat technique that apply to all weapons in this
+ * category.
  */
-declare type Parrying = {
-    tag: "Possible";
-} | {
-    tag: "Impossible";
+export declare type CloseCombatTechniqueSpecialRules = {
+    /**
+     * Is parrying possible with this combat technique?
+     */
+    can_parry: boolean;
+    has_damage_threshold: boolean;
+    has_reach: boolean;
+    has_length: boolean;
+    has_shield_size: boolean;
+};
+export declare type CloseCombatTechniqueTranslation = {
+    /**
+     * The name of the condition.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * Additional rules for the condition, if applicable.
+     * @markdown
+     * @minLength 1
+     */
+    special?: string;
+    errata?: Errata;
 };
-/**
- * The attribute's identifier.
- * @integer
- * @minimum 1
- */
-declare type PrimaryAttribute = number;
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<CloseCombatTechnique>;
-export {};

package/lib/types/CombatTechnique_Ranged.d.ts

@@ -4,6 +4,8 @@
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AttributeReference } from "./_SimpleReferences.js";
 /**
  * @title Ranged Combat Technique
  */
@@ -14,13 +16,18 @@ export declare type RangedCombatTechnique = {
      * @minimum 1
      */
     id: number;
+    /**
+     * Special rules for the combat technique that apply to all weapons in this
+     * category.
+     */
+    special: RangedCombatTechniqueSpecialRules;
     /**
      * The primary attribute(s).
      * @minItems 1
      * @maxItems 2
      * @uniqueItems
      */
-    primary_attribute: PrimaryAttribute[];
+    primary_attribute: AttributeReference[];
     /**
      * The *Breaking Point Rating* of the respective combat technique.
      * @integer
@@ -31,33 +38,28 @@ export declare type RangedCombatTechnique = {
     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 condition.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * Additional rules for the condition, if applicable.
-             * @markdown
-             * @minLength 1
-             */
-            special?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<RangedCombatTechniqueTranslation>;
 };
 /**
- * The attribute's identifier.
- * @integer
- * @minimum 1
+ * Special rules for the combat technique that apply to all weapons in this
+ * category.
  */
-declare type PrimaryAttribute = number;
+export declare type RangedCombatTechniqueSpecialRules = {
+    has_ammunition: boolean;
+};
+export declare type RangedCombatTechniqueTranslation = {
+    /**
+     * The name of the condition.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * Additional rules for the condition, if applicable.
+     * @markdown
+     * @minLength 1
+     */
+    special?: string;
+    errata?: Errata;
+};
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<RangedCombatTechnique>;
-export {};

package/lib/types/Condition.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";
 /**
  * @title Condition
  */
@@ -16,37 +18,22 @@ export declare type Condition = {
     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 condition's name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * Additional rules for the condition, if applicable.
-             * @markdown
-             * @minLength 1
-             */
-            rules?: string;
-            /**
-             * The effects for level 1 to 4.
-             */
-            effects: [Effect, Effect, Effect, Effect];
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ConditionTranslation>;
+};
+export declare type ConditionTranslation = {
+    /**
+     * The condition's name.
+     */
+    name: NonEmptyString;
+    /**
+     * Additional rules for the condition, if applicable.
+     */
+    rules?: NonEmptyMarkdown;
+    /**
+     * The effects for level 1 to 4.
+     */
+    effects: [NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown];
+    errata?: Errata;
 };
-/**
- * The effect on a level.
- * @markdown
- * @minLength 1
- */
-declare type Effect = string;
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Condition>;
-export {};

package/lib/types/Continent.d.ts

@@ -1,6 +1,7 @@
 /**
  * @main Continent
  */
+import { LocaleMap } from "./_LocaleMap.js";
 /**
  * Continents are mostly referenced to in languages and scripts that occur on a
  * specific continent.
@@ -15,19 +16,14 @@ export declare type Continent = {
     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 continent name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<ContinentTranslation>;
+};
+export declare type ContinentTranslation = {
+    /**
+     * The continent name.
+     * @minLength 1
+     */
+    name: string;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Continent>;