optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/Blessing.d.ts

@@ -3,7 +3,10 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Duration, TargetCategory } from "./_ActivatableSkill.js";
+import { DurationUnit } from "./_ActivatableSkillDuration.js";
+import { FixedRange } from "./_ActivatableSkillRange.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { LocaleMap } from "./_LocaleMap.js";
 /**
  * @title Blessing
  */
@@ -17,109 +20,90 @@ export declare type Blessing = {
     /**
      * Measurable parameters of a blessing.
      */
-    parameters: PerformanceParameters;
+    parameters: BlessingPerformanceParameters;
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     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 blessing.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effect description.
-             * @markdown
-             * @minLength 1
-             */
-            effect: string;
-            /**
-             * @deprecated
-             */
-            range: string;
-            /**
-             * @deprecated
-             */
-            duration: string;
-            /**
-             * @deprecated
-             */
-            target: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<BlessingTranslation>;
+};
+export declare type BlessingTranslation = {
+    /**
+     * The name of the blessing.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The effect description.
+     * @markdown
+     * @minLength 1
+     */
+    effect: string;
+    /**
+     * @deprecated
+     */
+    range: string;
+    /**
+     * @deprecated
+     */
+    duration: string;
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
 };
 /**
  * Measurable parameters of a blessing.
  */
-declare type PerformanceParameters = {
-    range: {
-        tag: "Self";
-    } | {
-        tag: "Touch";
-    } | {
-        tag: "Fixed";
-        /**
-         * The range in steps/m.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-    };
-    duration: {
-        tag: "Immediate";
-    } | {
-        tag: "Fixed";
-        /**
-         * The (unitless) duration.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * The duration unit.
-         */
-        unit: Duration.Unit;
-    } | {
-        tag: "Indefinite";
-        /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                /**
-                 * A description of the duration.
-                 */
-                description: {
-                    /**
-                     * The full description of the duration.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed description of the duration for use in small areas
-                     * (e.g. on character sheet).
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    };
+export declare type BlessingPerformanceParameters = {
+    range: BlessingRange;
+    duration: BlessingDuration;
+};
+export declare type BlessingRange = {
+    tag: "Self";
+} | {
+    tag: "Touch";
+} | {
+    tag: "Fixed";
+    fixed: FixedRange;
+};
+export declare type BlessingDuration = {
+    tag: "Immediate";
+} | {
+    tag: "Fixed";
+    fixed: FixedBlessingDuration;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteBlessingDuration;
+};
+export declare type FixedBlessingDuration = {
+    /**
+     * The (unitless) duration.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The duration unit.
+     */
+    unit: DurationUnit;
+};
+export declare type IndefiniteBlessingDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export declare type IndefiniteDurationTranslation = {
+    /**
+     * A description of the duration.
+     * @minLength 1
+     */
+    description: string;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Blessing>;
-export {};

package/lib/types/Cantrip.d.ts

@@ -3,8 +3,14 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Duration, TargetCategory } from "./_ActivatableSkill.js";
+import { CastingTimeDuringLovemaking } from "./_ActivatableSkillCastingTime.js";
+import { DurationUnit } from "./_ActivatableSkillDuration.js";
+import { FixedRange } from "./_ActivatableSkillRange.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
 import { Enhancements } from "./_Enhancements.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { ResponsiveText } from "./_ResponsiveText.js";
+import { CurriculumReference, MagicalTraditionReference, PropertyReference } from "./_SimpleReferences.js";
 /**
  * @title Cantrip
  */
@@ -18,179 +24,157 @@ export declare type Cantrip = {
     /**
      * Measurable parameters of a cantrip.
      */
-    parameters: PerformanceParameters;
+    parameters: CantripPerformanceParameters;
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * A note specifying the dissemination of the cantrip in different traditions.
      * Sometimes a cantrip is exclusively available to one or more specific
      * traditions, but usually one the academies and traditions are listed the
      * cantrip is most commonly teached in.
      */
-    note?: {
-        tag: "Exclusive";
-        /**
-         * The traditions the cantrip is exclusively available to.
-         * @minItems 1
-         * @uniqueItems
-         */
-        traditions: {
-            /**
-             * The magical tradition's identifier.
-             * @integer
-             * @minimum 2
-             */
-            id: number;
-        }[];
-    } | {
-        tag: "Common";
-        /**
-         * The academies and traditions the cantrip is commonly teached in.
-         * @minItems 1
-         * @uniqueItems
-         */
-        list: CommonNote[];
-    };
+    note?: CantripNote;
     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 spell.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The effect description.
-             * @markdown
-             * @minLength 1
-             */
-            effect: string;
-            /**
-             * @deprecated
-             */
-            range: string;
-            /**
-             * @deprecated
-             */
-            duration: string;
-            /**
-             * @deprecated
-             */
-            target: string;
-            errata?: Errata;
-        };
-    };
+     */
+    translations: LocaleMap<CantripTranslation>;
     enhancements?: Enhancements;
 };
-/**
- * Measurable parameters of a blessing.
- */
-declare type PerformanceParameters = {
-    range: {
-        tag: "Self";
-    } | {
-        tag: "Touch";
-    } | {
-        tag: "Fixed";
-        /**
-         * The range in steps/m.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * If `true`, the range is a radius.
-         */
-        is_radius?: true;
-    };
-    duration: {
-        tag: "Immediate";
-    } | {
-        tag: "Fixed";
-        /**
-         * If `true`, the duration is a maximum duration.
-         */
-        is_maximum?: true;
-        /**
-         * The (unitless) duration.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-        /**
-         * The duration unit.
-         */
-        unit: Duration.Unit;
-    } | {
-        tag: "DuringLovemaking";
-        /**
-         * The duration in rounds.
-         * @integer
-         * @minimum 1
-         */
-        value: number;
-    } | {
-        tag: "Indefinite";
-        /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                /**
-                 * A description of the duration.
-                 */
-                description: {
-                    /**
-                     * The full description of the duration.
-                     * @minLength 1
-                     */
-                    default: string;
-                    /**
-                     * A compressed description of the duration for use in small areas
-                     * (e.g. on character sheet).
-                     * @minLength 1
-                     */
-                    compressed: string;
-                };
-            };
-        };
-    };
+export declare type CantripNote = {
+    tag: "Exclusive";
+    exclusive: ExclusiveCantripNote;
+} | {
+    tag: "Common";
+    common: CommonCantripNotes;
 };
-export declare type CommonNote = {
+export declare type ExclusiveCantripNote = {
+    /**
+     * The traditions the cantrip is exclusively available to.
+     * @minItems 1
+     * @uniqueItems
+     */
+    traditions: MagicalTraditionReference[];
+};
+export declare type CommonCantripNotes = {
+    /**
+     * The academies and traditions the cantrip is commonly teached in.
+     * @minItems 1
+     * @uniqueItems
+     */
+    list: CommonCantripNote[];
+};
+export declare type CommonCantripNote = {
     tag: "Academy";
+    academy: CurriculumReference;
+} | {
+    tag: "Tradition";
+    tradition: CommonCantripTraditionNote;
+};
+export declare type CommonCantripTraditionNote = {
     /**
-     * The academy's curriculum identifier.
+     * The magical tradition's identifier.
      * @integer
      * @minimum 1
      */
     id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<CommonCantripTraditionNoteTranslation>;
+};
+export declare type CommonCantripTraditionNoteTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     * @minLength 1
+     */
+    note: string;
+};
+export declare type CantripTranslation = {
+    /**
+     * The name of the spell.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The effect description.
+     * @markdown
+     * @minLength 1
+     */
+    effect: string;
+    /**
+     * @deprecated
+     */
+    range: string;
+    /**
+     * @deprecated
+     */
+    duration: string;
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+export declare type CantripPerformanceParameters = {
+    range: CantripRange;
+    duration: CantripDuration;
+};
+export declare type CantripRange = {
+    tag: "Self";
 } | {
-    tag: "Tradition";
+    tag: "Touch";
+} | {
+    tag: "Fixed";
+    fixed: FixedRange;
+};
+export declare type CantripDuration = {
+    tag: "Immediate";
+} | {
+    tag: "Fixed";
+    fixed: FixedCantripDuration;
+} | {
+    tag: "DuringLovemaking";
+    during_lovemaking: CastingTimeDuringLovemaking;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteCantripDuration;
+};
+export declare type FixedCantripDuration = {
     /**
-     * The magical tradition's identifier.
+     * If `true`, the duration is a maximum duration.
+     */
+    is_maximum?: true;
+    /**
+     * The (unitless) duration.
      * @integer
-     * @minimum 2
+     * @minimum 1
      */
-    id: number;
+    value: number;
+    /**
+     * The duration unit.
+     */
+    unit: DurationUnit;
+};
+export declare type IndefiniteCantripDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export declare type IndefiniteDurationTranslation = {
+    /**
+     * A description of the duration.
+     */
+    description: ResponsiveText;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Cantrip>;
-export {};

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>;