optolith-database-schema 0.1.28 → 0.2.2

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.2.2](https://github.com/elyukai/optolith-database-schema/compare/v0.2.1...v0.2.2) (2022-03-29)
+
+
+### Features
+
+* add offset option for deriving AP value from improvement cost ([f556207](https://github.com/elyukai/optolith-database-schema/commit/f55620751b7a68383c74ba8c4256d11802ab99c7))
+
+### [0.2.1](https://github.com/elyukai/optolith-database-schema/compare/v0.2.0...v0.2.1) (2022-03-29)
+
+
+### Bug Fixes
+
+* category names and prerequisites should be defined separately ([eb312fe](https://github.com/elyukai/optolith-database-schema/commit/eb312fe2fc9973ef6be36937ebd8af8c8bf30e60))
+
+## [0.2.0](https://github.com/elyukai/optolith-database-schema/compare/v0.1.28...v0.2.0) (2022-03-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* derived select options are not a list anymore
+
+* derived select options are not a list anymore ([fa64a60](https://github.com/elyukai/optolith-database-schema/commit/fa64a60670f0cdf5567a168f3a4eccd7ea71d367))
+
 ### [0.1.28](https://github.com/elyukai/optolith-database-schema/compare/v0.1.27...v0.1.28) (2022-03-25)
 
 

package/lib/types/_Activatable.d.ts

@@ -6,7 +6,7 @@ import { DisplayOption } from "./prerequisites/DisplayOption.js";
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { Duration } from "./_ActivatableSkill.js";
-import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, MagicalTraditionIdentifier, PatronIdentifier, VolumePointsOptionReferenceIdentifier } from "./_Identifier.js";
+import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, MagicalTraditionIdentifier, PatronIdentifier, SkillIdentifier, VolumePointsOptionReferenceIdentifier } from "./_Identifier.js";
 import { GeneralPrerequisites } from "./_Prerequisite.js";
 /**
  * The activatable entry's identifier. An unique, increasing integer.
@@ -62,13 +62,13 @@ export declare type Maximum = number;
  */
 export declare type SelectOptions = {
     /**
-     * A list of categories with optional further configuration. All available
+     * An entry category with optional further configuration. All available
      * entries from the specified categories will be included as separate select
      * options. You can also specify a set of groups that should only be
      * included. Groups not mentioned will be excluded then.
      * @minItems 1
      */
-    derived?: CategoryOption[];
+    derived?: CategoryOption;
     /**
      * A list of explicit select options. If the identifier has a specific type,
      * its entry is the base of this select option, where values defined here
@@ -204,159 +204,213 @@ declare type CategoryOption = {
 } | {
     tag: "Skills";
     /**
-     * Only include entries of the specified groups.
+     * A list of skill categories.
      * @minItems 1
      */
-    groups?: {
+    categories: ({
+        tag: "Skills";
         /**
-         * The skill group's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 5
+         * Only include entries of the specified groups.
+         * @minItems 1
          */
-        id: number;
-    }[];
-    /**
-     * Only include (`Intersection`) or exclude (`Difference`) specific skills.
-     */
-    specific?: {
-        operation: {
-            tag: "Intersection";
-        } | {
-            tag: "Difference";
+        groups?: {
+            /**
+             * The skill group's identifier.
+             * @integer
+             * @minimum 1
+             * @maximum 5
+             */
+            id: number;
+        }[];
+        /**
+         * Only include (`Intersection`) or exclude (`Difference`) specific
+         * skills.
+         */
+        specific?: {
+            operation: {
+                tag: "Intersection";
+            } | {
+                tag: "Difference";
+            };
+            /**
+             * The list of specific skills.
+             * @minItems 1
+             * @uniqueItems
+             */
+            list: {
+                /**
+                 * The skill's identifier.
+                 * @integer
+                 * @minimum 1
+                 * @maximum 59
+                 */
+                id: number;
+            }[];
         };
         /**
-         * The list of specific skills.
+         * Registers new applications, which get enabled once this entry is
+         * activated with its respective select option. It specifies an
+         * entry-unique identifier, the skill it belongs to is derived from the
+         * select option automatically. A translation can be left out if its
+         * name equals the name of the origin entry.
          * @minItems 1
-         * @uniqueItems
          */
-        list: {
+        skill_applications?: {
             /**
-             * The skill's identifier.
+             * The application's identifier. An entry-unique, increasing integer.
              * @integer
              * @minimum 1
-             * @maximum 59
              */
             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 name of the application if different from the activatable
+                     * entry's
+                     * name.
+                     * @minLength 1
+                     */
+                    name: string;
+                };
+            };
         }[];
-    };
-    /**
-     * Registers new applications, which get enabled once this entry is
-     * activated with its respective select option. It specifies an entry-unique
-     * identifier, the skill it belongs to is derived from the select option
-     * automatically. A translation can be left out if its name equals the name
-     * of the origin entry.
-     * @minItems 1
-     */
-    skill_applications?: {
         /**
-         * The application's identifier. An entry-unique, increasing integer.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-        /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
+         * Registers uses, which get enabled once this entry is activated with
+         * its respective select option. It specifies an entry-unique
+         * identifier, the skill it belongs to is derived from the select option
+         * automatically. A translation can be left out if its name equals the
+         * name of the origin entry.
+         * @minItems 1
          */
-        translations?: {
+        skill_uses?: {
             /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * The use's identifier. An entry-unique, increasing integer.
+             * @integer
+             * @minimum 1
              */
-            [localeId: string]: {
+            id: number;
+            /**
+             * All translations for the entry, identified by IETF language tag
+             * (BCP47).
+             * @minProperties 1
+             */
+            translations?: {
                 /**
-                 * The name of the application if different from the activatable entry's
-                 * name.
-                 * @minLength 1
+                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
                  */
-                name: string;
+                [localeId: string]: {
+                    /**
+                     * The name of the use if different from the activatable entry's
+                     * name.
+                     * @minLength 1
+                     */
+                    name: string;
+                };
             };
-        };
-    }[];
-    /**
-     * Registers uses, which get enabled once this entry is activated with its
-     * respective select option. It specifies an entry-unique identifier, the
-     * skill it belongs to is derived from the select option automatically. A
-     * translation can be left out if its name equals the name of the origin
-     * entry.
-     * @minItems 1
-     */
-    skill_uses?: {
+        }[];
         /**
-         * The use's identifier. An entry-unique, increasing integer.
-         * @integer
-         * @minimum 1
+         * Generate prerequisites for each entry of the category.
+         * @minItems 1
          */
-        id: number;
+        prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+    } | {
+        tag: SkillWithEnhancementsCategory;
         /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
+         * Only include (`Intersection`) or exclude (`Difference`) specific
+         * entries.
          */
-        translations?: {
+        specific?: {
+            operation: {
+                tag: "Intersection";
+            } | {
+                tag: "Difference";
+            };
             /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * The list of specific entries.
+             * @minItems 1
+             * @uniqueItems
              */
-            [localeId: string]: {
+            list: {
                 /**
-                 * The name of the use if different from the activatable entry's name.
-                 * @minLength 1
+                 * The entry's identifier.
+                 * @integer
+                 * @minimum 1
+                 * @maximum 59
                  */
-                name: string;
-            };
+                id: number;
+            }[];
         };
-    }[];
-    /**
-     * Generate prerequisites for each entry of the category.
-     * @minItems 1
-     */
-    prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+        /**
+         * Generate prerequisites for each entry of the category.
+         * @minItems 1
+         */
+        prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+    })[];
     /**
      * Generate AP values for each entry.
      */
-    ap_value?: OptionSkillDeriveAdventurePointsValue;
+    ap_value?: OptionSkillDeriveAdventurePointsValue<SkillIdentifier>;
 } | {
-    tag: NonSkillSkillCategory;
+    tag: "CombatTechniques";
     /**
-     * Only include (`Intersection`) or exclude (`Difference`) specific entries.
+     * A list of combat technique categories.
+     * @minItems 1
      */
-    specific?: {
-        operation: {
-            tag: "Intersection";
-        } | {
-            tag: "Difference";
-        };
+    categories: {
+        tag: CombatTechniqueCategory;
         /**
-         * The list of specific entries.
-         * @minItems 1
-         * @uniqueItems
+         * Only include (`Intersection`) or exclude (`Difference`) specific
+         * entries.
          */
-        list: {
+        specific?: {
+            operation: {
+                tag: "Intersection";
+            } | {
+                tag: "Difference";
+            };
             /**
-             * The entry's identifier.
-             * @integer
-             * @minimum 1
-             * @maximum 59
+             * The list of specific entries.
+             * @minItems 1
+             * @uniqueItems
              */
-            id: number;
-        }[];
-    };
-    /**
-     * Generate prerequisites for each entry of the category.
-     * @minItems 1
-     */
-    prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+            list: {
+                /**
+                 * The entry's identifier.
+                 * @integer
+                 * @minimum 1
+                 * @maximum 59
+                 */
+                id: number;
+            }[];
+        };
+        /**
+         * Generate prerequisites for each entry of the category.
+         * @minItems 1
+         */
+        prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+    }[];
     /**
      * Generate AP values for each entry.
      */
-    ap_value?: OptionSkillDeriveAdventurePointsValue;
+    ap_value?: OptionSkillDeriveAdventurePointsValue<CombatTechniqueIdentifier>;
 };
-declare enum NonSkillSkillCategory {
-    CloseCombatTechniques = "CloseCombatTechniques",
-    RangedCombatTechniques = "RangedCombatTechniques",
-    LiturgicalChants = "LiturgicalChants",
-    Ceremonies = "Ceremonies",
+declare enum SkillWithEnhancementsCategory {
     Spells = "Spells",
-    Rituals = "Rituals"
+    Rituals = "Rituals",
+    LiturgicalChants = "LiturgicalChants",
+    Ceremonies = "Ceremonies"
+}
+declare enum CombatTechniqueCategory {
+    CloseCombatTechniques = "CloseCombatTechniques",
+    RangedCombatTechniques = "RangedCombatTechniques"
 }
 declare type OptionSkillSelfPrerequisite = {
     tag: "Self";
@@ -390,15 +444,28 @@ declare type OptionOptionPrerequisite = {
 /**
  * Generate AP values for each entry.
  */
-declare type OptionSkillDeriveAdventurePointsValue = {
+declare type OptionSkillDeriveAdventurePointsValue<Identifier> = {
+    /**
+     * Derive the cost from the improvement cost of each entry.
+     *
+     * AP Value = Improvement Cost × `multiplier` + `offset`
+     */
     tag: "DerivedFromImprovementCost";
     /**
      * This number is multiplied with the improvement cost of the entry
      * (A = 1 to D = 4).
      * @integer
      * @minimum 2
+     * @default 1
      */
     multiplier?: number;
+    /**
+     * This number is added to the maybe multiplied improvement cost of the
+     * entry.
+     * @integer
+     * @default 0
+     */
+    offset?: number;
 } | {
     tag: "Fixed";
     /**
@@ -410,7 +477,7 @@ declare type OptionSkillDeriveAdventurePointsValue = {
          * @integer
          * @minimum 1
          */
-        id: number;
+        id: Identifier;
         /**
          * The AP value for the specified entry.
          * @integer

package/lib/types/_Activatable.js

@@ -2,15 +2,18 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
-var NonSkillSkillCategory;
-(function (NonSkillSkillCategory) {
-    NonSkillSkillCategory["CloseCombatTechniques"] = "CloseCombatTechniques";
-    NonSkillSkillCategory["RangedCombatTechniques"] = "RangedCombatTechniques";
-    NonSkillSkillCategory["LiturgicalChants"] = "LiturgicalChants";
-    NonSkillSkillCategory["Ceremonies"] = "Ceremonies";
-    NonSkillSkillCategory["Spells"] = "Spells";
-    NonSkillSkillCategory["Rituals"] = "Rituals";
-})(NonSkillSkillCategory || (NonSkillSkillCategory = {}));
+var SkillWithEnhancementsCategory;
+(function (SkillWithEnhancementsCategory) {
+    SkillWithEnhancementsCategory["Spells"] = "Spells";
+    SkillWithEnhancementsCategory["Rituals"] = "Rituals";
+    SkillWithEnhancementsCategory["LiturgicalChants"] = "LiturgicalChants";
+    SkillWithEnhancementsCategory["Ceremonies"] = "Ceremonies";
+})(SkillWithEnhancementsCategory || (SkillWithEnhancementsCategory = {}));
+var CombatTechniqueCategory;
+(function (CombatTechniqueCategory) {
+    CombatTechniqueCategory["CloseCombatTechniques"] = "CloseCombatTechniques";
+    CombatTechniqueCategory["RangedCombatTechniques"] = "RangedCombatTechniques";
+})(CombatTechniqueCategory || (CombatTechniqueCategory = {}));
 export {};
 // "Input": {
 //   "description": "A string that is used as a placeholder text for an input field.",

package/lib/types/_Identifier.d.ts

@@ -108,6 +108,13 @@ declare enum RatedTag {
     LiturgicalChant = "LiturgicalChant",
     Ceremony = "Ceremony"
 }
+declare enum SkillTag {
+    Skill = "Skill",
+    Spell = "Spell",
+    Ritual = "Ritual",
+    LiturgicalChant = "LiturgicalChant",
+    Ceremony = "Ceremony"
+}
 declare enum AdvancedSpecialAbilityRestrictedOptionTag {
     General = "General",
     Skill = "Skill",
@@ -183,6 +190,7 @@ export declare type ActivatableIdentifier = TaggedIdentifier<ActivatableTag>;
 export declare type SpecialAbilityIdentifier = TaggedIdentifier<SpecialAbilityTag>;
 export declare type CombatRelatedSpecialAbilityIdentifier = TaggedIdentifier<CombatRelatedSpecialAbilityTag>;
 export declare type RatedIdentifier = TaggedIdentifier<RatedTag>;
+export declare type SkillIdentifier = TaggedIdentifier<SkillTag>;
 export declare type AdvancedSpecialAbilityRestrictedOptionIdentifier = TaggedIdentifier<AdvancedSpecialAbilityRestrictedOptionTag>;
 export declare type VolumePointsOptionReferenceIdentifier = TaggedIdentifier<VolumePointsOptionReferenceTag>;
 export declare type CombatTechniqueIdentifier = TaggedIdentifier<CombatTechniqueTag>;

package/lib/types/_Identifier.js

@@ -112,6 +112,14 @@ var RatedTag;
     RatedTag["LiturgicalChant"] = "LiturgicalChant";
     RatedTag["Ceremony"] = "Ceremony";
 })(RatedTag || (RatedTag = {}));
+var SkillTag;
+(function (SkillTag) {
+    SkillTag["Skill"] = "Skill";
+    SkillTag["Spell"] = "Spell";
+    SkillTag["Ritual"] = "Ritual";
+    SkillTag["LiturgicalChant"] = "LiturgicalChant";
+    SkillTag["Ceremony"] = "Ceremony";
+})(SkillTag || (SkillTag = {}));
 var AdvancedSpecialAbilityRestrictedOptionTag;
 (function (AdvancedSpecialAbilityRestrictedOptionTag) {
     AdvancedSpecialAbilityRestrictedOptionTag["General"] = "General";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.28",
+  "version": "0.2.2",
   "description": "Definitions and utilities for the flat-file database of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”, and its external integrations into other software.",
   "keywords": [
     "tde",