optolith-database-schema 0.0.1 → 0.0.2

package/lib/types/Spell.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @main Spell
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+import { GroupCollection } from "./_Prerequisite";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
+/**
+ * @title Spell
+ */
+export declare type Spell = {
+    /**
+     * The spell's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a spell.
+     */
+    parameters: FastPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * The tradition(s) the spell is available for. It may be *generally*
+     * available to all traditions or it may be only familiar in specific
+     * traditions.
+     */
+    traditions: {
+        tag: "General";
+    } | {
+        tag: "Specific";
+        /**
+         * A list of specific traditions.
+         * @minItems 1
+         */
+        list: {
+            /**
+             * The magical tradition's identifier. If `is_placeholder` is `true`
+             * then this is the magical tradition's placeholder identifier
+             * instead.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+            /**
+             * If set to `true`, the tradition is not available as a special ability
+             * yet.
+             */
+            is_placeholder?: true;
+        }[];
+    };
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: GroupCollection.Spellwork;
+    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 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;
+        };
+    };
+    enhancements?: Enhancements;
+};

package/lib/types/Spell.js

@@ -0,0 +1,4 @@
+/**
+ * @main Spell
+ */
+export {};

package/lib/types/_ActivatableSkill.d.ts

@@ -1,6 +1,7 @@
 /**
  * @title Activatable Skill
  */
+import { SlowSkillCastingTimeUnit } from "./SkillModificationLevel";
 /**
  *
  */
@@ -115,25 +116,39 @@ export declare namespace Effect {
     type QualityLevel5To6 = string;
     export {};
 }
-export declare type PerformanceParameters = {
+export declare type FastPerformanceParameters = {
     tag: "OneTime";
-    casting_time: CastingTime.T;
+    casting_time: CastingTime.Fast;
     cost: Cost.OneTime.T;
     range: Range.T;
     duration: Duration.OneTime.T;
 } | {
     tag: "Sustained";
-    casting_time: CastingTime.T;
+    casting_time: CastingTime.Fast;
+    cost: Cost.Sustained.T;
+    range: Range.T;
+    duration?: Duration.Sustained.T;
+};
+export declare type SlowPerformanceParameters = {
+    tag: "OneTime";
+    casting_time: CastingTime.Slow;
+    cost: Cost.OneTime.T;
+    range: Range.T;
+    duration: Duration.OneTime.T;
+} | {
+    tag: "Sustained";
+    casting_time: CastingTime.Slow;
     cost: Cost.Sustained.T;
     range: Range.T;
     duration?: Duration.Sustained.T;
 };
 export declare namespace CastingTime {
-    type T = {
+    type T<NonModifiable extends FastSkillCastingTime | SlowSkillCastingTime> = {
         /**
          * The default casting time definition.
          */
         default: {
+            tag: "Modifiable";
             /**
              * The initial skill modification identifier/level.
              * @integer
@@ -141,12 +156,7 @@ export declare namespace CastingTime {
              * @maximum 6
              */
             initial_modification_level: number;
-            /**
-             * Is the casting time modifiable?
-             * @default true
-             */
-            is_modifiable: boolean;
-        };
+        } | NonModifiable;
         /**
          * The casting time during lovemaking. In Aventurian Intimacy, you may only
          * use an activatable skill during lovemaking if it has a casting time used
@@ -154,7 +164,7 @@ export declare namespace CastingTime {
          */
         during_lovemaking?: {
             /**
-             * The (unitless) duration value.
+             * The (unitless) casting time value.
              * @integer
              * @minimum 1
              */
@@ -165,14 +175,31 @@ export declare namespace CastingTime {
             unit: CastingTimeDuringLovemakingUnit;
         };
     };
+    type FastSkillCastingTime = {
+        tag: "NonModifiable";
+        /**
+         * The casting time value in actions.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    type SlowSkillCastingTime = {
+        tag: "NonModifiable";
+        /**
+         * The (unitless) casting time value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        unit: SlowSkillCastingTimeUnit;
+    };
+    type Fast = T<FastSkillCastingTime>;
+    type Slow = T<SlowSkillCastingTime>;
     enum CastingTimeDuringLovemakingUnit {
         SeductionActions = "SeductionActions",
         Rounds = "Rounds"
     }
-    enum SlowSkillCastingTimeUnit {
-        Minutes = "Minutes",
-        Hours = "Hours"
-    }
 }
 export declare namespace Cost {
     namespace OneTime {

package/lib/types/_ActivatableSkill.js

@@ -8,11 +8,6 @@ export var CastingTime;
         CastingTimeDuringLovemakingUnit["SeductionActions"] = "SeductionActions";
         CastingTimeDuringLovemakingUnit["Rounds"] = "Rounds";
     })(CastingTimeDuringLovemakingUnit = CastingTime.CastingTimeDuringLovemakingUnit || (CastingTime.CastingTimeDuringLovemakingUnit = {}));
-    let SlowSkillCastingTimeUnit;
-    (function (SlowSkillCastingTimeUnit) {
-        SlowSkillCastingTimeUnit["Minutes"] = "Minutes";
-        SlowSkillCastingTimeUnit["Hours"] = "Hours";
-    })(SlowSkillCastingTimeUnit = CastingTime.SlowSkillCastingTimeUnit || (CastingTime.SlowSkillCastingTimeUnit = {}));
 })(CastingTime || (CastingTime = {}));
 export var Range;
 (function (Range) {

package/lib/types/_Enhancements.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @title Enhancements
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { GroupCollection } from "./_Prerequisite";
+/**
+ * A list of enhancements.
+ * @minItems 3
+ * @maxItems 5
+ */
+export declare type Enhancements = Enhancement[];
+/**
+ * @title Enhancement
+ */
+export declare type Enhancement = {
+    /**
+     * The enhancement's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill rating required to learn this enhancement.
+     * @integer
+     * @minimum 8
+     * @maximum 16
+     * @mulitpleOf 2
+     */
+    skill_rating: number;
+    /**
+     * The value to multiply with the numeric representation of the associated
+     * skill's improvement cost to form the final AP cost of this enhancement.
+     * @integer
+     * @minimum 1
+     */
+    adventure_points_modifier: number;
+    prerequisites?: GroupCollection.Enhancement;
+    /**
+     * Only defined if different than the associated skill.
+     */
+    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 enhancement.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            effect: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/_Enhancements.js

@@ -0,0 +1,4 @@
+/**
+ * @title Enhancements
+ */
+export {};

package/lib/types/_Identifier.d.ts

@@ -0,0 +1,80 @@
+export declare namespace Identifier {
+    namespace Tagged {
+        type Attribute = {
+            tag: "Attribute";
+            /**
+             * The attribute's numeric identifier.
+             * @integer
+             * @minimum 1
+             * @maximum 8
+             */
+            value: number;
+        };
+        type Skill = {
+            tag: "Skill";
+            /**
+             * The skill's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type CloseCombatTechnique = {
+            tag: "CloseCombatTechnique";
+            /**
+             * The close combat technique's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type RangedCombatTechnique = {
+            tag: "RangedCombatTechnique";
+            /**
+             * The ranged combat technique's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type Spell = {
+            tag: "Spell";
+            /**
+             * The spell's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type Ritual = {
+            tag: "Ritual";
+            /**
+             * The ritual's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type LiturgicalChant = {
+            tag: "LiturgicalChant";
+            /**
+             * The liturgical chant's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        type Ceremony = {
+            tag: "Ceremony";
+            /**
+             * The ceremony's numeric identifier.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+    }
+    namespace Group {
+        type Rated = Tagged.Attribute | Tagged.Skill | Tagged.CloseCombatTechnique | Tagged.RangedCombatTechnique | Tagged.Spell | Tagged.Ritual | Tagged.LiturgicalChant | Tagged.Ceremony;
+    }
+}

package/lib/types/_Identifier.js

@@ -0,0 +1 @@
+export {};

package/lib/types/_Prerequisite.d.ts

@@ -1,6 +1,7 @@
 /**
  * @title Prerequisites
  */
+import { Identifier } from "./_Identifier";
 import { BinarySex } from "./_Sex";
 /**
  * @title Single Prerequisites
@@ -202,7 +203,7 @@ export declare namespace Single {
         type T = {
             tag: "Influence";
             /**
-             * The influence' identifier.
+             * The influence's identifier.
              * @integer
              * @minimum 1
              */
@@ -214,6 +215,82 @@ export declare namespace Single {
             display_option?: DisplayOption.T;
         };
     }
+    namespace Rated {
+        /**
+         * @title Rated Prerequisite
+         */
+        type T = {
+            tag: "Rated";
+            /**
+             * The rated entry's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: Identifier.Group.Rated;
+            /**
+             * The required minimum value.
+             * @integer
+             * @minimum 0
+             */
+            value: number;
+            display_option?: DisplayOption.T;
+        };
+    }
+    namespace Enhancement {
+        /**
+         * Requires a specific enhancement from a skill.
+         * @title Enhancement Prerequisite
+         */
+        type T = {
+            tag: "Enhancement";
+            /**
+             * The required skill's identifier.
+             */
+            skill: {
+                tag: SkillCategoryWithEnhancements;
+                /**
+                 * The skill's identifier.
+                 * @integer
+                 * @minimum 1
+                 */
+                id: number;
+            };
+            /**
+             * The required enhancement's identifier.
+             */
+            enhancement: {
+                /**
+                 * The enhancement's identifier.
+                 * @integer
+                 * @minimum 1
+                 */
+                id: number;
+            };
+            display_option?: DisplayOption.T;
+        };
+        enum SkillCategoryWithEnhancements {
+            Spell = "Spell",
+            Ritual = "Ritual",
+            LiturgicalChant = "LiturgicalChant",
+            Ceremony = "Ceremony"
+        }
+    }
+    namespace EnhancementInternal {
+        /**
+         * Requires a specific enhancement from a skill. This can only be used by an
+         * enhancement to require another enhancement from the same skill.
+         * @title Internal Enhancement Prerequisite
+         */
+        type T = {
+            tag: "EnhancementInternal";
+            /**
+             * The enhancement's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        };
+    }
 }
 /**
  * @title Grouped Prerequisites
@@ -222,7 +299,10 @@ declare namespace Group {
     type DerivedCharacteristic = Single.Rule.T;
     type Publication = Single.Publication.T;
     type ArcaneTradition = Single.Sex.T | Single.Culture.T;
+    type Spellwork = Single.Rule.T | Single.Rated.T;
+    type Liturgy = Single.Rule.T;
     type GeodeRitual = Single.Influence.T;
+    type Enhancement = Single.EnhancementInternal.T;
 }
 /**
  * @title Prerequisite Collection Types
@@ -266,9 +346,21 @@ export declare namespace GroupCollection {
      * @title Arcane Tradition Prerequisites
      */
     type ArcaneTradition = Collection.Plain<Group.ArcaneTradition>;
+    /**
+     * @title Spellwork Prerequisites
+     */
+    type Spellwork = Collection.Plain<Group.Spellwork>;
+    /**
+     * @title Liturgy Prerequisites
+     */
+    type Liturgy = Collection.Plain<Group.Liturgy>;
     /**
      * @title Geode Ritual Prerequisites
      */
     type GeodeRitual = Collection.Plain<Group.GeodeRitual>;
+    /**
+     * @title Enhancement Prerequisites
+     */
+    type Enhancement = Collection.Plain<Group.Enhancement>;
 }
 export {};