optolith-database-schema 0.9.0 → 0.10.1

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type OrbEnchantment = {
+export type OrbEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type OrbEnchantment = {
      */
     translations: LocaleMap<OrbEnchantmentTranslation>;
 };
-export declare type OrbEnchantmentTranslation = {
+export type OrbEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type RingEnchantment = {
+export type RingEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type RingEnchantment = {
      */
     translations: LocaleMap<RingEnchantmentTranslation>;
 };
-export declare type RingEnchantmentTranslation = {
+export type RingEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type SickleRitual = {
+export type SickleRitual = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type SickleRitual = {
      */
     translations: LocaleMap<SickleRitualTranslation>;
 };
-export declare type SickleRitualTranslation = {
+export type SickleRitualTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type SpellSwordEnchantment = {
+export type SpellSwordEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type SpellSwordEnchantment = {
      */
     translations: LocaleMap<SpellSwordEnchantmentTranslation>;
 };
-export declare type SpellSwordEnchantmentTranslation = {
+export type SpellSwordEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -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,15 +1,16 @@
 /**
  * @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
  */
-export declare type StaffEnchantment = {
+export type StaffEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +26,7 @@ export declare type StaffEnchantment = {
      */
     translations: LocaleMap<StaffEnchantmentTranslation>;
 };
-export declare type StaffEnchantmentTranslation = {
+export type StaffEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;
@@ -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,15 +1,15 @@
 /**
  * @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
  */
-export declare type ToyEnchantment = {
+export type ToyEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type ToyEnchantment = {
      */
     translations: LocaleMap<ToyEnchantmentTranslation>;
 };
-export declare type ToyEnchantmentTranslation = {
+export type ToyEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type Trinkhornzauber = {
+export type Trinkhornzauber = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type Trinkhornzauber = {
      */
     translations: LocaleMap<TrinkhornzauberTranslation>;
 };
-export declare type TrinkhornzauberTranslation = {
+export type TrinkhornzauberTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type WandEnchantment = {
+export type WandEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -24,7 +24,7 @@ export declare type WandEnchantment = {
      */
     translations: LocaleMap<WandEnchantmentTranslation>;
 };
-export declare type WandEnchantmentTranslation = {
+export type WandEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

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

@@ -1,15 +1,15 @@
 /**
  * @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
  */
-export declare type WeaponEnchantment = {
+export type WeaponEnchantment = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     select_options?: Activatable.SelectOptions;
@@ -25,7 +25,7 @@ export declare type WeaponEnchantment = {
      */
     translations: LocaleMap<WeaponEnchantmentTranslation>;
 };
-export declare type WeaponEnchantmentTranslation = {
+export type WeaponEnchantmentTranslation = {
     name: Activatable.Name;
     name_in_library?: Activatable.NameInLibrary;
     effect: Activatable.Effect;

package/lib/types/traditionArtifacts/sub/AnimalShape.d.ts

@@ -6,7 +6,7 @@ import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape
  */
-export declare type AnimalShape = {
+export type AnimalShape = {
     /**
      * The animal shape's identifier. An unique, increasing integer.
      * @integer
@@ -26,7 +26,7 @@ export declare type AnimalShape = {
      */
     translations: LocaleMap<AnimalShapeTranslation>;
 };
-export declare type AnimalShapePathReference = {
+export type AnimalShapePathReference = {
     /**
      * The identifier of the animal shape's path.
      * @integer
@@ -34,7 +34,7 @@ export declare type AnimalShapePathReference = {
      */
     id: number;
 };
-export declare type AnimalShapeSizeReference = {
+export type AnimalShapeSizeReference = {
     /**
      * The identifier of the animal shape's size.
      * @integer
@@ -42,7 +42,7 @@ export declare type AnimalShapeSizeReference = {
      */
     id: number;
 };
-export declare type AnimalShapeTranslation = {
+export type AnimalShapeTranslation = {
     /**
      * The animal shape name.
      */

package/lib/types/traditionArtifacts/sub/AnimalShapePath.d.ts

@@ -6,7 +6,7 @@ import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Path
  */
-export declare type AnimalShapePath = {
+export type AnimalShapePath = {
     /**
      * The animal shape path's identifier. An unique, increasing integer.
      * @integer
@@ -18,7 +18,7 @@ export declare type AnimalShapePath = {
      */
     translations: LocaleMap<AnimalShapePathTranslation>;
 };
-export declare type AnimalShapePathTranslation = {
+export type AnimalShapePathTranslation = {
     /**
      * The animal shape path's name.
      */

package/lib/types/traditionArtifacts/sub/AnimalShapeSize.d.ts

@@ -6,7 +6,7 @@ import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Size
  */
-export declare type AnimalShapeSize = {
+export type AnimalShapeSize = {
     /**
      * The animal shape's identifier. An unique, increasing integer.
      * @integer
@@ -30,7 +30,7 @@ export declare type AnimalShapeSize = {
      */
     translations: LocaleMap<AnimalShapeSizeTranslation>;
 };
-export declare type AnimalShapeSizeTranslation = {
+export type AnimalShapeSizeTranslation = {
     /**
      * The animal shape size name.
      */

package/lib/types/traditionArtifacts/sub/Brew.d.ts

@@ -6,7 +6,7 @@ import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Brew
  */
-export declare type Brew = {
+export type Brew = {
     /**
      * The brew's identifier. An unique, increasing integer.
      * @integer
@@ -18,7 +18,7 @@ export declare type Brew = {
      */
     translations: LocaleMap<BrewTranslation>;
 };
-export declare type BrewTranslation = {
+export type BrewTranslation = {
     /**
      * The brew name.
      */

package/lib/validation/schema.d.ts

@@ -1,22 +1,22 @@
 import Ajv, { DefinedError } from "ajv";
-export declare type FileNameError = {
+export type FileNameError = {
     keyword: "filename";
     instancePath: string;
     message: string;
 };
-export declare type TypeValidationResult<T> = {
+export type TypeValidationResult<T> = {
     tag: "Ok";
     value: T;
 } | {
     tag: "Error";
     errors: TypeValidationResultErrors;
 };
-export declare type TypeValidationResultErrors = {
+export type TypeValidationResultErrors = {
     fileNameError?: FileNameError;
     schemaErrors: DefinedError[];
 };
-export declare type TypeValidator<T> = (validator: Ajv, data: unknown, filePath: string) => TypeValidationResult<T>;
-export declare type TypeValidatorOptions = {
+export type TypeValidator<T> = (validator: Ajv, data: unknown, filePath: string) => TypeValidationResult<T>;
+export type TypeValidatorOptions = {
     ignoreFileNamePattern?: boolean;
 };
 export declare const validateSchemaCreator: <T>(importMetaUrl: string, { ignoreFileNamePattern }?: TypeValidatorOptions) => TypeValidator<T>;

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.1",
   "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",
@@ -22,15 +22,15 @@
   "author": "Lukas Obermann",
   "license": "MPL-2.0",
   "dependencies": {
-    "ajv": "^8.11.0",
+    "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "yaml": "^2.1.1"
+    "yaml": "^2.2.2"
   },
   "devDependencies": {
-    "@types/node": "^18.0.0",
+    "@types/node": "^18.16.3",
     "optolith-tsjsonschemamd": "^0.5.20",
     "standard-version": "^9.5.0",
-    "typescript": "^4.7.4"
+    "typescript": "^5.0.4"
   },
   "repository": "github:elyukai/optolith-database-schema",
   "bugs": {

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"
       ],