optolith-database-schema 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.2](https://github.com/elyukai/optolith-database-schema/compare/v0.0.1...v0.0.2) (2022-03-05)
+
+
+### Features
+
+* finish basic activatable skills ([ede33df](https://github.com/elyukai/optolith-database-schema/commit/ede33df9e897cb58f19f58c4e8d5619c2f9be0e0))
+
 ### 0.0.1 (2022-03-05)
 
 

package/lib/types/Ceremony.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @main Ceremony
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+import { GroupCollection } from "./_Prerequisite";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
+/**
+ * @title Ceremony
+ */
+export declare type Ceremony = {
+    /**
+     * The ceremony'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 ceremony.
+     */
+    parameters: SlowPerformanceParameters;
+    /**
+     * 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 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[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: GroupCollection.Liturgy;
+    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;
+        };
+    };
+    enhancements?: Enhancements;
+};
+export declare type Tradition = {
+    tag: "GeneralAspect";
+    /**
+     * A general aspect's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The blessed tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * 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;
+    }[];
+};

package/lib/types/Ceremony.js

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

package/lib/types/LiturgicalChant.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @main LiturgicalChant
+ */
+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 Liturgical Chant
+ */
+export declare type LiturgicalChant = {
+    /**
+     * The liturgical chant'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 liturgical chant.
+     */
+    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 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[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: GroupCollection.Liturgy;
+    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;
+        };
+    };
+    enhancements?: Enhancements;
+};
+export declare type Tradition = {
+    tag: "GeneralAspect";
+    /**
+     * A general aspect's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The blessed tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * 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;
+    }[];
+};

package/lib/types/LiturgicalChant.js

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

package/lib/types/Ritual.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @main Ritual
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+import { GroupCollection } from "./_Prerequisite";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
+/**
+ * @title Ritual
+ */
+export declare type Ritual = {
+    /**
+     * The ritual'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 ritual.
+     */
+    parameters: SlowPerformanceParameters;
+    /**
+     * 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 ritual 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 ritual.
+             * @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/Ritual.js

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

package/lib/types/{SkillModificationIncrement.d.ts → SkillModificationLevel.d.ts}

@@ -1,27 +1,72 @@
 /**
- * @main SkillModificationIncrement
+ * @main SkillModificationLevel
  */
 /**
- * @title Skill Modification Increment
+ * @title Skill Modification Level
  */
-declare type SkillModificationIncrement = {
+export declare type SkillModificationLevel = {
     /**
-     * The skill modification increment's identifier. It also represents the
-     * increment level.
+     * The skill modification level's identifier.
      * @integer
      * @minimum 1
      * @maximum 6
-     *
      */
     id: number;
     /**
      * Configuration for this level for fast skills (spells, liturgical chants).
      */
-    fast: LevelTypeConfig;
+    fast: {
+        /**
+         * The casting time in actions.
+         * @integer
+         * @minimum 1
+         */
+        casting_time: number;
+        /**
+         * The range in meters.
+         * @integer
+         * @minimum 1
+         */
+        range: number;
+        /**
+         * The cost in AE/KP.
+         * @integer
+         * @minimum 1
+         */
+        cost: number;
+    };
     /**
      * Configuration for this level for slow skills (rituals, ceremonies).
      */
-    slow: LevelTypeConfig;
+    slow: {
+        /**
+         * The casting time.
+         */
+        casting_time: {
+            /**
+             * The (unitless) casting time.
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+            /**
+             * The unit for the `value`.
+             */
+            unit: SlowSkillCastingTimeUnit;
+        };
+        /**
+         * The range in meters.
+         * @integer
+         * @minimum 1
+         */
+        range: number;
+        /**
+         * The cost in AE/KP.
+         * @integer
+         * @minimum 1
+         */
+        cost: number;
+    };
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
      * @minProperties 1
@@ -47,29 +92,10 @@ declare type SkillModificationIncrement = {
         };
     };
 };
-/**
- * Configuration of a type for a level.
- */
-declare type LevelTypeConfig = {
-    /**
-     * Casting time in actions.
-     * @integer
-     * @minimum 1
-     */
-    casting_time: number;
-    /**
-     * Range in meters.
-     * @integer
-     * @minimum 1
-     */
-    range: number;
-    /**
-     * Cost in AE/KP.
-     * @integer
-     * @minimum 1
-     */
-    cost: number;
-};
+export declare enum SlowSkillCastingTimeUnit {
+    Minutes = "Minutes",
+    Hours = "Hours"
+}
 /**
  * Configuration translation of a type for a level. Values set here override the
  * default generated text.
@@ -80,3 +106,4 @@ declare type LevelTypeConfigTranslation = {
      */
     range: string;
 };
+export {};

package/lib/types/SkillModificationLevel.js

@@ -0,0 +1,8 @@
+/**
+ * @main SkillModificationLevel
+ */
+export var SlowSkillCastingTimeUnit;
+(function (SlowSkillCastingTimeUnit) {
+    SlowSkillCastingTimeUnit["Minutes"] = "Minutes";
+    SlowSkillCastingTimeUnit["Hours"] = "Hours";
+})(SlowSkillCastingTimeUnit || (SlowSkillCastingTimeUnit = {}));