optolith-database-schema 0.2.4 → 0.4.1

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

@@ -4,6 +4,7 @@
 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";
 /**
  * @title Toy Enchantment
@@ -15,36 +16,31 @@ export declare type ToyEnchantment = {
     maximum?: Activatable.Maximum;
     prerequisites?: GeneralPrerequisites;
     volume: Activatable.Volume;
-    cost?: Activatable.EnchantmentCost;
+    cost: Activatable.EnchantmentCost;
     property: Activatable.Property;
     ap_value: Activatable.AdventurePointsValue;
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ToyEnchantmentTranslation>;
+};
+export declare type ToyEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ToyEnchantment>;

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

@@ -4,6 +4,7 @@
 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";
 /**
  * @title Trinkhornzauber
@@ -21,30 +22,25 @@ export declare type Trinkhornzauber = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<TrinkhornzauberTranslation>;
+};
+export declare type TrinkhornzauberTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Trinkhornzauber>;

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

@@ -4,6 +4,7 @@
 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";
 /**
  * @title Wand Enchantment
@@ -21,30 +22,25 @@ export declare type WandEnchantment = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<WandEnchantmentTranslation>;
+};
+export declare type WandEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<WandEnchantment>;

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

@@ -21,30 +21,25 @@ export declare type WeaponEnchantment = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            effect: Activatable.Effect;
-            /**
-             * @deprecated
-             */
-            volume: string;
-            /**
-             * @deprecated
-             */
-            aeCost?: string;
-            /**
-             * @deprecated
-             */
-            bindingCost?: string;
-            errata?: Errata;
-        };
-    };
+    translations: WeaponEnchantmentTranslation;
+};
+export declare type WeaponEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<WeaponEnchantment>;

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

@@ -1,6 +1,8 @@
 /**
  * @main AnimalShape
  */
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape
  */
@@ -11,33 +13,39 @@ export declare type AnimalShape = {
      * @minimum 1
      */
     id: number;
+    /**
+     * The animal shape's path.
+     */
+    path: AnimalShapePathReference;
+    /**
+     * The animal shape's size.
+     */
+    size: AnimalShapeSizeReference;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AnimalShapeTranslation>;
+};
+export declare type AnimalShapePathReference = {
     /**
      * The identifier of the animal shape's path.
      * @integer
      * @minimum 1
      */
-    path_id: number;
+    id: number;
+};
+export declare type AnimalShapeSizeReference = {
     /**
      * The identifier of the animal shape's size.
      * @integer
      * @minimum 1
      */
-    size_id: number;
+    id: number;
+};
+export declare type AnimalShapeTranslation = {
     /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
+     * The animal shape name.
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The animal shape name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShape>;

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

@@ -1,6 +1,8 @@
 /**
  * @main AnimalShapePath
  */
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Path
  */
@@ -13,19 +15,13 @@ export declare type AnimalShapePath = {
     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 animal shape path's name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<AnimalShapePathTranslation>;
+};
+export declare type AnimalShapePathTranslation = {
+    /**
+     * The animal shape path's name.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapePath>;

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

@@ -1,6 +1,8 @@
 /**
  * @main AnimalShapeSize
  */
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Animal Shape Size
  */
@@ -25,19 +27,13 @@ export declare type AnimalShapeSize = {
     ap_value: 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 animal shape size name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<AnimalShapeSizeTranslation>;
+};
+export declare type AnimalShapeSizeTranslation = {
+    /**
+     * The animal shape size name.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapeSize>;

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

@@ -1,6 +1,8 @@
 /**
  * @main Brew
  */
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
 /**
  * @title Brew
  */
@@ -13,19 +15,13 @@ export declare type Brew = {
     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 brew name.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<BrewTranslation>;
+};
+export declare type BrewTranslation = {
+    /**
+     * The brew name.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Brew>;

package/lib/validation/schema.d.ts

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

package/lib/validation/schema.js

@@ -1,20 +1,32 @@
 import { basename, dirname, extname, join, relative, sep } from "path";
 import { fileURLToPath } from "url";
 import { libDir } from "../../config/directories.js";
+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$`
+});
+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));
     const relativePathOfSchema = changeFileExtension(relativePathOfType, ".schema.json");
     return "/" + relativePathOfSchema.split(sep).join("/");
 };
-export const validateSchemaCreator = (importMetaUrl) => {
+export const validateSchemaCreator = (importMetaUrl, { ignoreFileNamePattern = false } = {}) => {
     const schemaId = schemaIdFromSourcePath(importMetaUrl);
-    return (validator, data) => {
-        if (validator.validate(schemaId, data)) {
+    return (validator, data, filePath) => {
+        const fileName = basename(filePath);
+        const correctFileName = ignoreFileNamePattern || baseNamePattern.test(fileName);
+        if (validator.validate(schemaId, data) && correctFileName) {
             return { tag: "Ok", value: data };
         }
         else {
-            return { tag: "Error", errors: validator.errors };
+            const errors = [
+                ...(validator.errors ?? []),
+                ...(!correctFileName ? [fileNameError(fileName)] : [])
+            ];
+            return { tag: "Error", errors };
         }
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.2.4",
+  "version": "0.4.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",
@@ -14,6 +14,7 @@
     "build:ts": "tsc",
     "watch:ts": "tsc -w",
     "build:gen": "node ./build/generate.js",
+    "watch:gen": "node ./build/generate.js -w",
     "build": "npm run build:ts && npm run build:gen",
     "release": "standard-version",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -21,15 +22,15 @@
   "author": "Lukas Obermann",
   "license": "MPL-2.0",
   "dependencies": {
-    "ajv": "^8.10.0",
+    "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
-    "yaml": "^1.10.2"
+    "yaml": "^2.1.1"
   },
   "devDependencies": {
-    "@types/node": "^17.0.21",
-    "optolith-tsjsonschemamd": "^0.5.5",
-    "standard-version": "^9.3.2",
-    "typescript": "^4.6.2"
+    "@types/node": "^18.0.0",
+    "optolith-tsjsonschemamd": "^0.5.16",
+    "standard-version": "^9.5.0",
+    "typescript": "^4.7.4"
   },
   "repository": "github:elyukai/optolith-database-schema",
   "bugs": {

package/schema/Advantage.schema.json

@@ -1,77 +1,55 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
   "$id": "/Advantage.schema.json",
-  "$ref": "#/definitions/Advantage",
-  "definitions": {
+  "$ref": "#/$defs/Advantage",
+  "$defs": {
     "Advantage": {
       "title": "Advantage",
       "type": "object",
       "properties": {
         "id": {
-          "$ref": "./_Activatable.schema.json#/definitions/Id"
+          "$ref": "./_Activatable.schema.json#/$defs/Id"
         },
         "levels": {
-          "$ref": "./_Activatable.schema.json#/definitions/Levels"
+          "$ref": "./_Activatable.schema.json#/$defs/Levels"
         },
         "select_options": {
-          "$ref": "./_Activatable.schema.json#/definitions/SelectOptions"
+          "$ref": "./_Activatable.schema.json#/$defs/SelectOptions"
         },
         "skill_applications": {
-          "$ref": "./_Activatable.schema.json#/definitions/SkillApplications"
+          "$ref": "./_Activatable.schema.json#/$defs/SkillApplications"
         },
         "skill_uses": {
-          "$ref": "./_Activatable.schema.json#/definitions/SkillUses"
+          "$ref": "./_Activatable.schema.json#/$defs/SkillUses"
         },
         "maximum": {
-          "$ref": "./_Activatable.schema.json#/definitions/Maximum"
+          "$ref": "./_Activatable.schema.json#/$defs/Maximum"
         },
         "prerequisites": {
-          "$ref": "./_Prerequisite.schema.json#/definitions/AdvantageDisadvantagePrerequisites"
+          "$ref": "./_Prerequisite.schema.json#/$defs/AdvantageDisadvantagePrerequisites"
         },
         "ap_value": {
-          "$ref": "./_Activatable.schema.json#/definitions/AdventurePointsValueAdvantagesDisadvantages"
+          "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValue"
         },
-        "has_no_maximum_spent_influence": {
-          "description": "Does this advantage not count towards the maximum of AP to be spent\non advantages?",
-          "const": true
+        "has_maximum_spent_influence": {
+          "description": "Does this advantage count towards the maximum of AP to be spent on\nadvantages?",
+          "type": "boolean",
+          "default": true
         },
         "is_exclusive_to_arcane_spellworks": {
-          "description": "Does this advantage exclusively applies to arcane spellworks but not\nto magical actions and applications?",
-          "const": true
+          "description": "Does this advantage exclusively applies to arcane spellworks and not\nto magical actions and magical applications?",
+          "type": "boolean",
+          "default": false
         },
         "src": {
-          "$ref": "./source/_PublicationRef.schema.json#/definitions/PublicationRefs"
+          "$ref": "./source/_PublicationRef.schema.json#/$defs/PublicationRefs"
         },
         "translations": {
           "description": "All translations for the entry, identified by IETF language tag (BCP47).",
           "type": "object",
           "patternProperties": {
             "^[a-z]{2}-[A-Z]{2}$": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "$ref": "./_Activatable.schema.json#/definitions/Name"
-                },
-                "name_in_library": {
-                  "$ref": "./_Activatable.schema.json#/definitions/NameInLibrary"
-                },
-                "rules": {
-                  "$ref": "./_Activatable.schema.json#/definitions/Rules"
-                },
-                "range": {
-                  "description": "The range.",
-                  "type": "string",
-                  "minLength": 1
-                },
-                "errata": {
-                  "$ref": "./source/_Erratum.schema.json#/definitions/Errata"
-                }
-              },
-              "required": [
-                "name",
-                "rules"
-              ],
-              "additionalProperties": false
+              "$ref": "#/$defs/AdvantageTranslation"
             }
           },
           "minProperties": 1,
@@ -81,10 +59,39 @@
       "required": [
         "id",
         "ap_value",
+        "has_maximum_spent_influence",
+        "is_exclusive_to_arcane_spellworks",
         "src",
         "translations"
       ],
       "additionalProperties": false
+    },
+    "AdvantageTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "$ref": "./_Activatable.schema.json#/$defs/Name"
+        },
+        "name_in_library": {
+          "$ref": "./_Activatable.schema.json#/$defs/NameInLibrary"
+        },
+        "rules": {
+          "$ref": "./_Activatable.schema.json#/$defs/Rules"
+        },
+        "range": {
+          "description": "The range.",
+          "type": "string",
+          "minLength": 1
+        },
+        "errata": {
+          "$ref": "./source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name",
+        "rules"
+      ],
+      "additionalProperties": false
     }
   }
 }