optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/Lessons_Curriculum.d.ts

@@ -3,6 +3,10 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { CombatTechniqueIdentifier, MagicalTraditionIdentifier, SpellworkIdentifier } from "./_Identifier.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { GuidelineReference } from "./_SimpleReferences.js";
 /**
  * This is a curriculum of a specified academy, containing the guideline,
  * elective and restricted spellworks as well as the lesson packages of that
@@ -17,12 +21,9 @@ export declare type Curriculum = {
      */
     id: number;
     /**
-     * The institution's guideline's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 6
+     * The institution's guideline.
      */
-    guideline_id: number;
+    guideline: GuidelineReference;
     /**
      * The academy's elective spellworks package.
      */
@@ -38,21 +39,15 @@ export declare type Curriculum = {
     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 academy.
-             * @minLength 1
-             */
-            name: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<CurriculumTranslation>;
+};
+export declare type CurriculumTranslation = {
+    /**
+     * The name of the academy.
+     */
+    name: NonEmptyString;
+    errata?: Errata;
 };
 /**
  * The academy's elective spellworks package.
@@ -60,14 +55,17 @@ export declare type Curriculum = {
 declare type ElectiveSpellworks = {
     tag: "DefinedByGameMaster";
 } | {
-    tag: "Explicit";
+    tag: "Specific";
+    specific: SpecificElectiveSpellworks;
+};
+export declare type SpecificElectiveSpellworks = {
     /**
      * @minItems 1
      */
     list: ElectiveSpellwork[];
 };
-declare type ElectiveSpellwork = {
-    id: SpellworkId;
+export declare type ElectiveSpellwork = {
+    id: SpellworkIdentifier;
     /**
      * The elective spellwork may only take effect if a certain condition is met.
      * The condition may be related to professions or profession variants, but it
@@ -82,7 +80,7 @@ declare type ElectiveSpellwork = {
  * designed so that it can work without a specific profession, as multiple may
  * belong to an institute, but with referencing other entities instead.
  */
-declare type ElectiveSpellworkRestriction = {
+export declare type ElectiveSpellworkRestriction = {
     tag: "Element";
     /**
      * The element's identifier.
@@ -96,12 +94,24 @@ declare type ElectiveSpellworkRestriction = {
  * The academy's restricted spellworks package.
  * @minItems 1
  */
-declare type RestrictedSpellworks = RestrictedSpellwork[];
+export declare type RestrictedSpellworks = RestrictedSpellwork[];
 /**
  * The academy's restricted spellworks package.
  */
-declare type RestrictedSpellwork = {
+export declare type RestrictedSpellwork = {
     tag: "Property";
+    property: RestrictedProperty;
+} | {
+    tag: "Spellwork";
+    spellwork: SpellworkIdentifier;
+} | {
+    tag: "DemonSummoning";
+} | {
+    tag: "Borbaradian";
+} | {
+    tag: "DamageIntelligent";
+};
+export declare type RestrictedProperty = {
     /**
      * The identifier of the property that spellworks are disallowed from.
      * @integer
@@ -112,29 +122,23 @@ declare type RestrictedSpellwork = {
      * Exclude specific spellworks from the restriction.
      * @minItems 1
      */
-    exclude?: SpellworkId[];
+    exclude?: SpellworkIdentifier[];
     /**
      * Spellworks from this property up to a certain number are allowed.
      * Spellworks excluded from this restriction definition using `exclude` do
      * not contribute to the maximum.
      */
     maximum?: number;
-} | SpellworkId | {
-    tag: "DemonSummoning";
-} | {
-    tag: "Borbaradian";
-} | {
-    tag: "DamageIntelligent";
 };
 /**
  * A list of available lesson packages.
  */
-declare type LessonPackages = [LessonPackage, LessonPackage];
+export declare type LessonPackages = [LessonPackage, LessonPackage];
 /**
  * @title Lesson Package
  * @minProperties 3
  */
-declare type LessonPackage = {
+export declare type LessonPackage = {
     /**
      * The lesson package's identifier. An unique, increasing integer.
      * @integer
@@ -148,60 +152,42 @@ declare type LessonPackage = {
      * completely.
      * @minItems 1
      */
-    spellwork_changes?: {
-        base: SpellworkAdjustment;
-        replacement: SpellworkAdjustment;
-    }[];
-    skills?: SkillAdjustment[];
+    spellwork_changes?: SpellworkChange[];
+    skills?: AbilityAdjustment[];
     /**
      * 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 lesson package.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The spell values difference of the lesson package. Use this field to
-             * specify a text that is displayed instead of the generated
-             * `spellwork_changes` list. The field is displayed even if no list is
-             * present.
-             * @minLength 1
-             */
-            spellwork_changes?: string;
-        };
-    };
+    translations: LocaleMap<LessonPackageTranslation>;
 };
-declare type SkillAdjustment = {
-    tag: "MeleeCombatTechnique";
+export declare type SpellworkChange = {
+    base: SpellworkAdjustment;
+    replacement: SpellworkAdjustment;
+};
+export declare type LessonPackageTranslation = {
     /**
-     * The melee combat technique's identifier.
-     * @integer
-     * @minimum 1
+     * The name of the lesson package.
      */
-    id: number;
+    name: NonEmptyString;
     /**
-     * The combat technique points that will be added to the current combat
-     * technique rating.
-     * @integer
-     * @minimum -6
-     * @maximum 6
+     * The spell values difference of the lesson package. Use this field to
+     * specify a text that is displayed instead of the generated
+     * `spellwork_changes` list. The field is displayed even if no list is
+     * present.
      */
-    points: number;
+    spellwork_changes?: NonEmptyString;
+};
+export declare type AbilityAdjustment = {
+    tag: "CombatTechnique";
+    combat_technique: CombatTechniqueAdjustment;
 } | {
-    tag: "RangedCombatTechnique";
-    /**
-     * The ranged combat technique's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    tag: "Skill";
+    skill: SkillAdjustment;
+} | {
+    tag: "Spellwork";
+    spellwork: SpellworkAdjustment;
+};
+export declare type CombatTechniqueAdjustment = {
+    id: CombatTechniqueIdentifier;
     /**
      * The combat technique points that will be added to the current combat
      * technique rating.
@@ -210,8 +196,8 @@ declare type SkillAdjustment = {
      * @maximum 6
      */
     points: number;
-} | {
-    tag: "Skill";
+};
+export declare type SkillAdjustment = {
     /**
      * The skill's identifier.
      * @integer
@@ -225,15 +211,9 @@ declare type SkillAdjustment = {
      * @maximum 8
      */
     points: number;
-} | SpellworkAdjustment;
-declare type SpellworkAdjustment = {
-    tag: "Spell";
-    /**
-     * The spell's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+};
+export declare type SpellworkAdjustment = {
+    id: SpellworkIdentifier;
     /**
      * The skill points that will be added to the current skill rating. If a
      * spell gets to a skill rating of 0 because of this, it will be removed
@@ -244,55 +224,10 @@ declare type SpellworkAdjustment = {
      */
     points: number;
     /**
-     * The target tradition's identifier. If the target spell is not from the
-     * Guild Mage tradition, specify the tradition identifier here.
-     * @integer
-     * @minimum 2
-     * @default 1
-     */
-    tradition_id?: number;
-} | {
-    tag: "Ritual";
-    /**
-     * The ritual's identifier.
-     * @integer
-     * @minimum 1
+     * The target tradition. If the target spell is not from the Guild Mage
+     * tradition, specify the tradition identifier here.
      */
-    id: number;
-    /**
-     * The skill points that will be added to the current skill rating. If a
-     * ritual gets to a skill rating of 0 because of this, it will be removed
-     * completely.
-     * @integer
-     * @minimum -10
-     * @maximum 10
-     */
-    points: number;
-    /**
-     * The target tradition's identifier. If the target ritual is not from the
-     * Guild Mage tradition, specify the tradition identifier here.
-     * @integer
-     * @minimum 2
-     * @default 1
-     */
-    tradition_id?: number;
-};
-declare type SpellworkId = {
-    tag: "Spell";
-    /**
-     * The spell's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-} | {
-    tag: "Ritual";
-    /**
-     * The ritual's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    tradition?: MagicalTraditionIdentifier;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Curriculum>;
 export {};

package/lib/types/Lessons_Guideline.d.ts

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

package/lib/types/LiturgicalChant.d.ts

@@ -3,9 +3,14 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill.js";
+import { FastPerformanceParameters } 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 LiturgicalChant = {
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     /**
      * The tradition(s) the liturgical chant 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 LiturgicalChant = {
     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 liturgical chant.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * A compressed name of the liturgical chant 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<LiturgicalChantTranslation>;
     enhancements?: Enhancements;
 };
-export declare type Tradition = {
-    tag: "GeneralAspect";
+export declare type LiturgicalChantTranslation = {
     /**
-     * A general aspect's identifier.
-     * @integer
-     * @minimum 1
+     * The name of the liturgical chant.
      */
-    id: number;
-} | {
-    tag: "Tradition";
+    name: NonEmptyString;
     /**
-     * The blessed tradition's identifier.
-     * @integer
-     * @minimum 1
+     * A compressed name of the liturgical chant 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<LiturgicalChant>;

package/lib/types/Locale.d.ts

@@ -34,6 +34,6 @@ export declare type Locale = {
      * The language is not (fully) implemented and thus needs to be excluded from
      * stable releases.
      */
-    is_missing_implementation?: boolean;
+    is_missing_implementation?: true;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Locales>;

package/lib/types/Locale.js

@@ -2,4 +2,4 @@
  * @main Locales
  */
 import { validateSchemaCreator } from "../validation/schema.js";
-export const validateSchema = validateSchemaCreator(import.meta.url);
+export const validateSchema = validateSchemaCreator(import.meta.url, { ignoreFileNamePattern: true });

package/lib/types/MetaCondition.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";
 /**
  * Meta Conditions are rule elements that work like conditions in the sense that
  * they have four levels with different effects, but which are not explicitly
@@ -19,37 +21,22 @@ export declare type MetaCondition = {
     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 meta condition's name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * Additional rules for the meta condition, if applicable.
-             * @markdown
-             * @minLength 1
-             */
-            rules?: string;
-            /**
-             * The effects for level 1 to 4.
-             */
-            effects: [Effect, Effect, Effect, Effect];
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<MetaConditionTranslation>;
+};
+export declare type MetaConditionTranslation = {
+    /**
+     * The meta condition's name.
+     */
+    name: NonEmptyString;
+    /**
+     * Additional rules for the meta 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<MetaCondition>;
-export {};