optolith-database-schema 0.2.2 → 0.2.3

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.3](https://github.com/elyukai/optolith-database-schema/compare/v0.2.2...v0.2.3) (2022-03-29)
+
+
+### Features
+
+* allow dis-/advantages to not contribute to maximum AP value ([9e401d0](https://github.com/elyukai/optolith-database-schema/commit/9e401d0be40797a5758220233af6c162d1ce76fb))
+
+
+### Bug Fixes
+
+* state prerequisite should have unique tag ([7710fd5](https://github.com/elyukai/optolith-database-schema/commit/7710fd538582b85cd67cb81b2f791774102d17db))
+
 ### [0.2.2](https://github.com/elyukai/optolith-database-schema/compare/v0.2.1...v0.2.2) (2022-03-29)
 
 

package/lib/types/Advantage.d.ts

@@ -16,7 +16,7 @@ export declare type Advantage = {
     skill_uses?: Activatable.SkillUses;
     maximum?: Activatable.Maximum;
     prerequisites?: AdvantageDisadvantagePrerequisites;
-    ap_value: Activatable.AdventurePointsValue;
+    ap_value: Activatable.AdventurePointsValueAdvantagesDisadvantages;
     /**
      * Does this advantage not count towards the maximum of AP to be spent
      * on advantages?

package/lib/types/Disadvantage.d.ts

@@ -14,7 +14,7 @@ export declare type Disadvantage = {
     select_options?: Activatable.SelectOptions;
     maximum?: Activatable.Maximum;
     prerequisites?: AdvantageDisadvantagePrerequisites;
-    ap_value: Activatable.AdventurePointsValue;
+    ap_value: Activatable.AdventurePointsValueAdvantagesDisadvantages;
     /**
      * Does this disadvantage not count towards the maximum of AP to be granted by
      * disadvantages?

package/lib/types/_Activatable.d.ts

@@ -1814,25 +1814,49 @@ export declare type AdventurePointsValue = {
      */
     values: AdventurePointsSingleValue[];
 } | {
-    tag: "ByImprovementCost";
     /**
-     * An entry with a selection of skills may have different costs for
-     * different improvement costs of the selected skill.
-     *
-     * If the select options will not have entries with improvement cost A
-     * (combat techniques only), you may leave out A.
-     */
-    values: {
-        A?: AdventurePointsSingleValue;
-        B: AdventurePointsSingleValue;
-        C: AdventurePointsSingleValue;
-        D: AdventurePointsSingleValue;
-    };
+     * Used if AP value is defined by the selected option(s) or special rules.
+     */
+    tag: "Indefinite";
+};
+export declare type AdventurePointsValueAdvantagesDisadvantages = {
+    tag: "Fixed";
+    /**
+     * A fixed adventure points value. If the entry has levels, this is the cost
+     * for each level as well.
+     */
+    value: AdventurePointsSingleValue;
+    /**
+     * The AP Value of the entry does not contribute to the AP maximum for
+     * advantages or disadvantages, so it may also be bought if the maximum has
+     * already been reached.
+     */
+    does_not_contribute_to_maximum?: true;
+} | {
+    tag: "ByLevel";
+    /**
+     * An entry with levels may have different costs for each level. The length
+     * of the list must match the amount of levels the special ability has.
+     * @minItems 2
+     */
+    values: AdventurePointsSingleValue[];
+    /**
+     * The AP Value of the entry does not contribute to the AP maximum for
+     * advantages or disadvantages, so it may also be bought if the maximum has
+     * already been reached.
+     */
+    does_not_contribute_to_maximum?: true;
 } | {
     /**
      * Used if AP value is defined by the selected option(s) or special rules.
      */
     tag: "Indefinite";
+    /**
+     * The AP Value of the entry does not contribute to the AP maximum for
+     * advantages or disadvantages, so it may also be bought if the maximum has
+     * already been reached.
+     */
+    does_not_contribute_to_maximum?: true;
 };
 /**
  * A single adventure points value.

package/lib/types/prerequisites/single/StatePrerequisite.d.ts

@@ -5,7 +5,7 @@ import { DisplayOption } from "../DisplayOption.js";
  * @title State Prerequisite
  */
 export declare type StatePrerequisite = {
-    tag: "Culture";
+    tag: "State";
     id: OneOrManyNumericIdentifiers;
     display_option?: DisplayOption;
 };

package/lib/types/prerequisites/single/TextPrerequisite.d.ts

@@ -3,7 +3,7 @@
  * background information – or the referenced entities were not made available
  * for use yet – e.g. races –, but which should be displayed, because it is part
  * of the prerequisite string from the sources.
- * @title Impossible Prerequisite
+ * @title Text Prerequisite
  */
 export declare type TextPrerequisite = {
     tag: "Text";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "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",

package/schema/Advantage.schema.json

@@ -29,7 +29,7 @@
           "$ref": "./_Prerequisite.schema.json#/definitions/AdvantageDisadvantagePrerequisites"
         },
         "ap_value": {
-          "$ref": "./_Activatable.schema.json#/definitions/AdventurePointsValue"
+          "$ref": "./_Activatable.schema.json#/definitions/AdventurePointsValueAdvantagesDisadvantages"
         },
         "has_no_maximum_spent_influence": {
           "description": "Does this advantage not count towards the maximum of AP to be spent\non advantages?",

package/schema/Disadvantage.schema.json

@@ -23,7 +23,7 @@
           "$ref": "./_Prerequisite.schema.json#/definitions/AdvantageDisadvantagePrerequisites"
         },
         "ap_value": {
-          "$ref": "./_Activatable.schema.json#/definitions/AdventurePointsValue"
+          "$ref": "./_Activatable.schema.json#/definitions/AdventurePointsValueAdvantagesDisadvantages"
         },
         "has_no_maximum_spent_influence": {
           "description": "Does this disadvantage not count towards the maximum of AP to be granted by\ndisadvantages?",

package/schema/_Activatable.schema.json

@@ -3328,31 +3328,57 @@
           "type": "object",
           "properties": {
             "tag": {
-              "const": "ByImprovementCost"
+              "description": "Used if AP value is defined by the selected option(s) or special rules.",
+              "const": "Indefinite"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "AdventurePointsValueAdvantagesDisadvantages": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "value": {
+              "description": "A fixed adventure points value. If the entry has levels, this is the cost\nfor each level as well.",
+              "$ref": "#/definitions/AdventurePointsSingleValue"
+            },
+            "does_not_contribute_to_maximum": {
+              "description": "The AP Value of the entry does not contribute to the AP maximum for\nadvantages or disadvantages, so it may also be bought if the maximum has\nalready been reached.",
+              "const": true
+            }
+          },
+          "required": [
+            "tag",
+            "value"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "ByLevel"
             },
             "values": {
-              "description": "An entry with a selection of skills may have different costs for\ndifferent improvement costs of the selected skill.\n\nIf the select options will not have entries with improvement cost A\n(combat techniques only), you may leave out A.",
-              "type": "object",
-              "properties": {
-                "A": {
-                  "$ref": "#/definitions/AdventurePointsSingleValue"
-                },
-                "B": {
-                  "$ref": "#/definitions/AdventurePointsSingleValue"
-                },
-                "C": {
-                  "$ref": "#/definitions/AdventurePointsSingleValue"
-                },
-                "D": {
-                  "$ref": "#/definitions/AdventurePointsSingleValue"
-                }
+              "description": "An entry with levels may have different costs for each level. The length\nof the list must match the amount of levels the special ability has.",
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/AdventurePointsSingleValue"
               },
-              "required": [
-                "B",
-                "C",
-                "D"
-              ],
-              "additionalProperties": false
+              "minItems": 2
+            },
+            "does_not_contribute_to_maximum": {
+              "description": "The AP Value of the entry does not contribute to the AP maximum for\nadvantages or disadvantages, so it may also be bought if the maximum has\nalready been reached.",
+              "const": true
             }
           },
           "required": [
@@ -3367,6 +3393,10 @@
             "tag": {
               "description": "Used if AP value is defined by the selected option(s) or special rules.",
               "const": "Indefinite"
+            },
+            "does_not_contribute_to_maximum": {
+              "description": "The AP Value of the entry does not contribute to the AP maximum for\nadvantages or disadvantages, so it may also be bought if the maximum has\nalready been reached.",
+              "const": true
             }
           },
           "required": [

package/schema/prerequisites/single/StatePrerequisite.schema.json

@@ -8,7 +8,7 @@
       "type": "object",
       "properties": {
         "tag": {
-          "const": "Culture"
+          "const": "State"
         },
         "id": {
           "$ref": "../../_Identifier.schema.json#/definitions/OneOrManyNumericIdentifiers"

package/schema/prerequisites/single/TextPrerequisite.schema.json

@@ -3,7 +3,7 @@
   "$id": "/prerequisites/single/TextPrerequisite.schema.json",
   "definitions": {
     "TextPrerequisite": {
-      "title": "Impossible Prerequisite",
+      "title": "Text Prerequisite",
       "description": "A prerequisite that is either not verifyable in general – e.g. roleplay or\nbackground information – or the referenced entities were not made available\nfor use yet – e.g. races –, but which should be displayed, because it is part\nof the prerequisite string from the sources.",
       "type": "object",
       "properties": {