optolith-database-schema 0.9.0 → 0.10.0

package/lib/types/traditionArtifacts/OrbEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main OrbEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Orb Enchantment
  */

package/lib/types/traditionArtifacts/RingEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main RingEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Ring Enchantment
  */

package/lib/types/traditionArtifacts/SickleRitual.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main SickleRitual
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Sickle Ritual
  */

package/lib/types/traditionArtifacts/SpellSwordEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main SpellSwordEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Spell-Sword Enchantment
  */
@@ -41,6 +41,11 @@ export declare type SpellSwordEnchantmentTranslation = {
      * @deprecated
      */
     bindingCost?: string;
+    /**
+     * The AP value. It is only used if the text cannot be generated from the
+     * given information.
+     */
+    ap_value?: Activatable.AdventurePointsValueReplacement;
     errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<SpellSwordEnchantment>;

package/lib/types/traditionArtifacts/StaffEnchantment.d.ts

@@ -1,11 +1,12 @@
 /**
  * @main StaffEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { ResponsiveTextOptional } from "../_ResponsiveText.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Staff Enchantment
  */
@@ -37,10 +38,19 @@ export declare type StaffEnchantmentTranslation = {
      * @deprecated
      */
     aeCost?: string;
+    /**
+     * A note, appended to the generated cost string in parenthesis.
+     */
+    cost_note?: ResponsiveTextOptional;
     /**
      * @deprecated
      */
     bindingCost?: string;
+    /**
+     * The AP value. It is only used if the text cannot be generated from the
+     * given information.
+     */
+    ap_value?: Activatable.AdventurePointsValueReplacement;
     errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<StaffEnchantment>;

package/lib/types/traditionArtifacts/ToyEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main ToyEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Toy Enchantment
  */

package/lib/types/traditionArtifacts/Trinkhornzauber.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main Trinkhornzauber
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Trinkhornzauber
  */

package/lib/types/traditionArtifacts/WandEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main WandEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Wand Enchantment
  */

package/lib/types/traditionArtifacts/WeaponEnchantment.d.ts

@@ -1,11 +1,11 @@
 /**
  * @main WeaponEnchantment
  */
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Weapon Enchantment
  */

package/lib/validation/schema.js

@@ -1,12 +1,12 @@
 import { basename, dirname, extname, join, relative, sep } from "path";
 import { fileURLToPath } from "url";
 import { libDir } from "../../config/directories.js";
+const baseNamePattern = /^(?:0|[1-9][0-9]*)_(?:[A-Z][a-zA-Z]*|[1-9][0-9]*)(?:-(?:[a-zA-Z]+|[1-9][0-9]*))*\.yml$/;
 const fileNameError = (fileName) => ({
     keyword: "filename",
     instancePath: "",
-    message: `the file name "${fileName}" does not match the pattern ^[1-9][0-9]*_[A-Z][a-z]*(?:-[a-zA-Z][a-z]*)\\.yml$`
+    message: `the file name "${fileName}" does not match the pattern ${baseNamePattern.source}`
 });
-const baseNamePattern = /^[1-9][0-9]*_[A-Z][a-z]*(?:-[a-zA-Z][a-z]*)*\.yml$/;
 const changeFileExtension = (path, ext) => join(dirname(path), basename(path, extname(path)) + ext);
 const schemaIdFromSourcePath = (sourcePath) => {
     const relativePathOfType = relative(libDir, fileURLToPath(sourcePath));

package/package.json

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

@@ -75,6 +75,10 @@
         "name_in_library": {
           "$ref": "./_Activatable.schema.json#/$defs/NameInLibrary"
         },
+        "input": {
+          "description": "A string that is used as a label for an input field.",
+          "$ref": "./_Activatable.schema.json#/$defs/Input"
+        },
         "rules": {
           "$ref": "./_Activatable.schema.json#/$defs/Rules"
         },
@@ -83,6 +87,13 @@
           "type": "string",
           "minLength": 1
         },
+        "ap_value": {
+          "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
+        "ap_value_append": {
+          "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.",
+          "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueAppend"
+        },
         "errata": {
           "$ref": "./source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/Disadvantage.schema.json

@@ -67,6 +67,10 @@
         "name_in_library": {
           "$ref": "./_Activatable.schema.json#/$defs/NameInLibrary"
         },
+        "input": {
+          "description": "A string that is used as a label for an input field.",
+          "$ref": "./_Activatable.schema.json#/$defs/Input"
+        },
         "rules": {
           "$ref": "./_Activatable.schema.json#/$defs/Rules"
         },
@@ -75,6 +79,10 @@
           "type": "string",
           "minLength": 1
         },
+        "ap_value_append": {
+          "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.",
+          "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueAppend"
+        },
         "errata": {
           "$ref": "./source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/Profession.schema.json

@@ -509,6 +509,14 @@
         "name": {
           "description": "Name of the profession variant.",
           "$ref": "#/$defs/ProfessionName"
+        },
+        "full_text": {
+          "description": "A text that replaces the generated text for the profession variant.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "concluding_text": {
+          "description": "A text that is appended to the generated text for the profession variant.\n\nHas no effect when `full_text` is set.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         }
       },
       "required": [

package/schema/Talisman.schema.json

@@ -21,11 +21,11 @@
           "minItems": 1
         },
         "type": {
-          "description": "The talisman type.",
+          "description": "The talisman type, if any.",
           "$ref": "#/$defs/TalismanType"
         },
         "ap_value": {
-          "description": "The AP value for the required trade secret.",
+          "description": "The AP value for the required trade secret, if possible.",
           "type": "integer",
           "minimum": 5,
           "multipleOf": 5
@@ -48,8 +48,6 @@
       "required": [
         "id",
         "tradition",
-        "type",
-        "ap_value",
         "src",
         "translations"
       ],

package/schema/_Activatable.schema.json

@@ -123,6 +123,11 @@
         "prerequisites": {
           "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites"
         },
+        "binding_cost": {
+          "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.",
+          "type": "integer",
+          "minimum": 0
+        },
         "ap_value": {
           "description": "Specific AP cost for the select option.",
           "type": "integer",
@@ -202,6 +207,11 @@
         "prerequisites": {
           "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites"
         },
+        "binding_cost": {
+          "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.",
+          "type": "integer",
+          "minimum": 0
+        },
         "ap_value": {
           "description": "Specific AP cost for the select option.",
           "type": "integer",
@@ -248,6 +258,11 @@
         "prerequisites": {
           "$ref": "./_Prerequisite.schema.json#/$defs/GeneralPrerequisites"
         },
+        "binding_cost": {
+          "description": "Specific binding cost for the select option. Only has an effect if the\nassociated entry supports binding costs.",
+          "type": "integer",
+          "minimum": 0
+        },
         "ap_value": {
           "description": "Specific AP cost for the select option.",
           "type": "integer",
@@ -1192,6 +1207,10 @@
     "IndefiniteArcaneEnergyCost": {
       "type": "object",
       "properties": {
+        "modifier": {
+          "description": "Specified if the indefinite AP cost description needs to be modified by a\ncertain value.",
+          "$ref": "#/$defs/IndefiniteArcaneEnergyCostModifier"
+        },
         "translations": {
           "description": "All translations for the entry, identified by IETF language tag (BCP47).",
           "type": "object",
@@ -1209,6 +1228,30 @@
       ],
       "additionalProperties": false
     },
+    "IndefiniteArcaneEnergyCostModifier": {
+      "type": "object",
+      "properties": {
+        "arithmetic": {
+          "description": "The arithmetic how to apply the `value` to the `base`.",
+          "$ref": "#/$defs/IndefiniteArcaneEnergyCostModifierArithmetic"
+        },
+        "value": {
+          "description": "The value that is applied to the `base` using the defined `arithmetic`.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "arithmetic",
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "IndefiniteArcaneEnergyCostModifierArithmetic": {
+      "enum": [
+        "Add"
+      ]
+    },
     "IndefiniteArcaneEnergyCostTranslation": {
       "type": "object",
       "properties": {
@@ -1399,6 +1442,22 @@
             "map"
           ],
           "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DerivedFromSelection"
+            },
+            "derived_from_selection": {
+              "$ref": "#/$defs/VolumeDerivedFromSelection"
+            }
+          },
+          "required": [
+            "tag",
+            "derived_from_selection"
+          ],
+          "additionalProperties": false
         }
       ]
     },
@@ -1573,6 +1632,20 @@
       ],
       "additionalProperties": false
     },
+    "VolumeDerivedFromSelection": {
+      "type": "object",
+      "properties": {
+        "fallback": {
+          "description": "The volume for the selection if it does not define a specific one.",
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "fallback"
+      ],
+      "additionalProperties": false
+    },
     "BindingCost": {
       "description": "The binding cost for an enchantment.",
       "oneOf": [
@@ -1623,6 +1696,22 @@
             "map"
           ],
           "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DerivedFromSelection"
+            },
+            "derived_from_selection": {
+              "$ref": "#/$defs/BindingCostDerivedFromSelection"
+            }
+          },
+          "required": [
+            "tag",
+            "derived_from_selection"
+          ],
+          "additionalProperties": false
         }
       ]
     },
@@ -1745,6 +1834,20 @@
       ],
       "additionalProperties": false
     },
+    "BindingCostDerivedFromSelection": {
+      "type": "object",
+      "properties": {
+        "fallback": {
+          "description": "The binding cost for the selection if it does not define a specific one.",
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "fallback"
+      ],
+      "additionalProperties": false
+    },
     "Property": {
       "description": "The magic property's identifier. `DependingOnProperty` can only be used if\nthe special ability has an option to select a property.",
       "oneOf": [
@@ -1795,6 +1898,10 @@
     "AdvancedSpecialAbilityDerivedExternalEntryOptionId": {
       "$ref": "./_Identifier.schema.json#/$defs/PatronIdentifier"
     },
+    "PrerequisitesReplacement": {
+      "description": "The prerequisites text. It is only used if the text cannot be generated from\nthe given information.",
+      "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+    },
     "ApplicableCombatTechniques": {
       "oneOf": [
         {
@@ -2537,6 +2644,22 @@
           ],
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "DerivedFromSelection"
+            },
+            "derived_from_selection": {
+              "$ref": "#/$defs/AdventurePointsDerivedFromSelection"
+            }
+          },
+          "required": [
+            "tag",
+            "derived_from_selection"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -2570,10 +2693,53 @@
       },
       "minItems": 2
     },
+    "AdventurePointsDerivedFromSelection": {
+      "description": "The adventure points value is derived from the selection of the special\nability. Its display value may be able to be derived from the given\ninformation for the select options. If that is not the case or the generated\ntext would not match the original one, a replacement text can be provided.",
+      "type": "object",
+      "properties": {
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/AdventurePointsDerivedFromSelectionTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+    "AdventurePointsDerivedFromSelectionTranslation": {
+      "type": "object",
+      "properties": {
+        "replacement": {
+          "description": "A replacement for the generated text if it would not match the original\none.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        }
+      },
+      "required": [],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
     "AdventurePointsSingleValue": {
       "description": "A single adventure points value.",
       "type": "integer",
       "minimum": 0
+    },
+    "Input": {
+      "description": "A string that is used as a label for an input field.",
+      "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+    },
+    "AdventurePointsValueReplacement": {
+      "description": "The AP value. It is only used if the text cannot be generated from the given\ninformation.",
+      "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+    },
+    "AdventurePointsValueAppend": {
+      "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text is\nreplaced.",
+      "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
     }
   }
 }