optolith-database-schema 0.1.6 → 0.1.7

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

@@ -1,10 +1,10 @@
 /**
  * @main WeaponEnchantment
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
-import { GeneralPrerequisites } from "../_Prerequisite";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Weapon Enchantment
  */
@@ -47,3 +47,4 @@ export declare type WeaponEnchantment = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<WeaponEnchantment>;

package/lib/types/traditionArtifacts/WeaponEnchantment.js

@@ -1,4 +1,5 @@
 /**
  * @main WeaponEnchantment
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -40,3 +40,4 @@ export declare type AnimalShape = {
         };
     };
 };
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShape>;

package/lib/types/traditionArtifacts/sub/AnimalShape.js

@@ -1,4 +1,5 @@
 /**
  * @main AnimalShape
  */
-export {};
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -28,3 +28,4 @@ export declare type AnimalShapePath = {
         };
     };
 };
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapePath>;

package/lib/types/traditionArtifacts/sub/AnimalShapePath.js

@@ -1,4 +1,5 @@
 /**
  * @main AnimalShapePath
  */
-export {};
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,10 +1,10 @@
 /**
- * @main AnimalShape
+ * @main AnimalShapeSize
  */
 /**
- * @title Animal Shape
+ * @title Animal Shape Size
  */
-export declare type AnimalShape = {
+export declare type AnimalShapeSize = {
     /**
      * The animal shape's identifier. An unique, increasing integer.
      * @integer
@@ -40,3 +40,4 @@ export declare type AnimalShape = {
         };
     };
 };
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<AnimalShapeSize>;

package/lib/types/traditionArtifacts/sub/AnimalShapeSize.js

@@ -1,4 +1,5 @@
 /**
- * @main AnimalShape
+ * @main AnimalShapeSize
  */
-export {};
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -28,3 +28,4 @@ export declare type Brew = {
         };
     };
 };
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Brew>;

package/lib/types/traditionArtifacts/sub/Brew.js

@@ -1,4 +1,5 @@
 /**
  * @main Brew
  */
-export {};
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/validation/schema.d.ts

@@ -0,0 +1,10 @@
+import Ajv, { DefinedError } from "ajv";
+export declare type TypeValidationResult<T> = {
+    tag: "Ok";
+    value: T;
+} | {
+    tag: "Error";
+    errors: DefinedError[];
+};
+export declare type TypeValidator<T> = (validator: Ajv, data: unknown, filePath: string) => TypeValidationResult<T>;
+export declare const validateSchemaCreator: <T>(importMetaUrl: string) => TypeValidator<T>;

package/lib/validation/schema.js

@@ -0,0 +1,20 @@
+import { basename, dirname, extname, join, relative, sep } from "path";
+import { fileURLToPath } from "url";
+import { libDir } from "../../build/directories.js";
+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) => {
+    const schemaId = schemaIdFromSourcePath(importMetaUrl);
+    return (validator, data) => {
+        if (validator.validate(schemaId, data)) {
+            return { tag: "Ok", value: data };
+        }
+        else {
+            return { tag: "Error", errors: validator.errors };
+        }
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "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",
@@ -12,6 +12,7 @@
   "types": "./lib/main.d.ts",
   "scripts": {
     "build:ts": "tsc",
+    "watch:ts": "tsc -w",
     "build:gen": "node ./build/generate.js",
     "build": "npm run build:ts && npm run build:gen",
     "release": "standard-version",
@@ -21,11 +22,12 @@
   "license": "MPL-2.0",
   "dependencies": {
     "ajv": "^8.10.0",
+    "ajv-formats": "^2.1.1",
     "yaml": "^1.10.2"
   },
   "devDependencies": {
     "@types/node": "^17.0.21",
-    "optolith-tsjsonschemamd": "^0.5.4",
+    "optolith-tsjsonschemamd": "^0.5.5",
     "standard-version": "^9.3.2",
     "typescript": "^4.6.2"
   },

package/schema/Advantage.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Advantage.schema.json",
+  "$id": "/Advantage.schema.json",
   "$ref": "#/definitions/Advantage",
   "definitions": {
     "Advantage": {

package/schema/ArcaneBardTradition.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "ArcaneBardTradition.schema.json",
+  "$id": "/ArcaneBardTradition.schema.json",
   "$ref": "#/definitions/ArcaneBardTradition",
   "definitions": {
     "ArcaneBardTradition": {

package/schema/ArcaneDancerTradition.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "ArcaneDancerTradition.schema.json",
+  "$id": "/ArcaneDancerTradition.schema.json",
   "$ref": "#/definitions/ArcaneDancerTradition",
   "definitions": {
     "ArcaneDancerTradition": {

package/schema/Aspect.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Aspect.schema.json",
+  "$id": "/Aspect.schema.json",
   "$ref": "#/definitions/Aspect",
   "definitions": {
     "Aspect": {

package/schema/Attribute.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Attribute.schema.json",
+  "$id": "/Attribute.schema.json",
   "$ref": "#/definitions/Attribute",
   "definitions": {
     "Attribute": {

package/schema/Blessing.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Blessing.schema.json",
+  "$id": "/Blessing.schema.json",
   "$ref": "#/definitions/Blessing",
   "definitions": {
     "Blessing": {

package/schema/Cantrip.schema.json

@@ -1,19 +1,19 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Cantrip.schema.json",
+  "$id": "/Cantrip.schema.json",
   "$ref": "#/definitions/Spell",
   "definitions": {
-    "Spell": {
-      "title": "Spell",
+    "Cantrip": {
+      "title": "Cantrip",
       "type": "object",
       "properties": {
         "id": {
-          "description": "The spell's identifier. An unique, increasing integer.",
+          "description": "The cantrip's identifier. An unique, increasing integer.",
           "type": "integer",
           "minimum": 1
         },
         "parameters": {
-          "description": "Measurable parameters of a spell.",
+          "description": "Measurable parameters of a cantrip.",
           "$ref": "#/definitions/PerformanceParameters"
         },
         "target": {
@@ -25,10 +25,6 @@
           "type": "integer",
           "minimum": 1
         },
-        "improvement_cost": {
-          "description": "States which column is used to improve the skill.",
-          "$ref": "./_ImprovementCost.schema.json#/definitions/ImprovementCost"
-        },
         "note": {
           "description": "A note specifying the dissemination of the cantrip in different traditions.\nSometimes a cantrip is exclusively available to one or more specific\ntraditions, but usually one the academies and traditions are listed the\ncantrip is most commonly teached in.",
           "oneOf": [
@@ -203,7 +199,6 @@
         "parameters",
         "target",
         "property_id",
-        "improvement_cost",
         "note",
         "src",
         "translations"

package/schema/Ceremony.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Ceremony.schema.json",
+  "$id": "/Ceremony.schema.json",
   "$ref": "#/definitions/Ceremony",
   "definitions": {
     "Ceremony": {

package/schema/CombatTechnique_Close.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "CombatTechnique_Close.schema.json",
+  "$id": "/CombatTechnique_Close.schema.json",
   "$ref": "#/definitions/CloseCombatTechnique",
   "definitions": {
     "CloseCombatTechnique": {

package/schema/CombatTechnique_Ranged.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "CombatTechnique_Ranged.schema.json",
+  "$id": "/CombatTechnique_Ranged.schema.json",
   "$ref": "#/definitions/RangedCombatTechnique",
   "definitions": {
     "RangedCombatTechnique": {

package/schema/Condition.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Condition.schema.json",
+  "$id": "/Condition.schema.json",
   "$ref": "#/definitions/Condition",
   "definitions": {
     "Condition": {

package/schema/Continent.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Continent.schema.json",
+  "$id": "/Continent.schema.json",
   "$ref": "#/definitions/Continent",
   "definitions": {
     "Continent": {

package/schema/Culture.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Culture.schema.json",
+  "$id": "/Culture.schema.json",
   "$ref": "#/definitions/Culture",
   "definitions": {
     "Culture": {

package/schema/DerivedCharacteristic.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "DerivedCharacteristic.schema.json",
+  "$id": "/DerivedCharacteristic.schema.json",
   "$ref": "#/definitions/DerivedCharacteristic",
   "definitions": {
     "DerivedCharacteristic": {

package/schema/Disadvantage.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Disadvantage.schema.json",
+  "$id": "/Disadvantage.schema.json",
   "$ref": "#/definitions/Disadvantage",
   "definitions": {
     "Disadvantage": {

package/schema/Element.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Element.schema.json",
+  "$id": "/Element.schema.json",
   "$ref": "#/definitions/Element",
   "definitions": {
     "Element": {

package/schema/ExperienceLevel.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "ExperienceLevel.schema.json",
+  "$id": "/ExperienceLevel.schema.json",
   "$ref": "#/definitions/ExperienceLevel",
   "definitions": {
     "ExperienceLevel": {

package/schema/EyeColor.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "EyeColor.schema.json",
+  "$id": "/EyeColor.schema.json",
   "$ref": "#/definitions/EyeColor",
   "definitions": {
     "EyeColor": {

package/schema/FamiliarsTrick.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "FamiliarsTrick.schema.json",
+  "$id": "/FamiliarsTrick.schema.json",
   "$ref": "#/definitions/FamiliarsTrick",
   "definitions": {
     "FamiliarsTrick": {

package/schema/FamiliarsTrick_AnimalType.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "FamiliarsTrick_AnimalType.schema.json",
+  "$id": "/FamiliarsTrick_AnimalType.schema.json",
   "$ref": "#/definitions/AnimalType",
   "definitions": {
     "AnimalType": {

package/schema/HairColor.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "HairColor.schema.json",
+  "$id": "/HairColor.schema.json",
   "$ref": "#/definitions/HairColor",
   "definitions": {
     "HairColor": {

package/schema/Lessons_Curriculum.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Lessons_Curriculum.schema.json",
+  "$id": "/Lessons_Curriculum.schema.json",
   "$ref": "#/definitions/Curriculum",
   "definitions": {
     "Curriculum": {

package/schema/Lessons_Guideline.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Lessons_Guideline.schema.json",
+  "$id": "/Lessons_Guideline.schema.json",
   "$ref": "#/definitions/Guideline",
   "definitions": {
     "Guideline": {

package/schema/LiturgicalChant.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "LiturgicalChant.schema.json",
+  "$id": "/LiturgicalChant.schema.json",
   "$ref": "#/definitions/LiturgicalChant",
   "definitions": {
     "LiturgicalChant": {

package/schema/Locale.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Locale.schema.json",
+  "$id": "/Locale.schema.json",
   "$ref": "#/definitions/Locales",
   "definitions": {
     "Locales": {

package/schema/MetaCondition.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "MetaCondition.schema.json",
+  "$id": "/MetaCondition.schema.json",
   "$ref": "#/definitions/MetaCondition",
   "definitions": {
     "MetaCondition": {

package/schema/PactCategory.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "PactCategory.schema.json",
+  "$id": "/PactCategory.schema.json",
   "$ref": "#/definitions/PactCategory",
   "definitions": {
     "PactCategory": {

package/schema/Patron.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Patron.schema.json",
+  "$id": "/Patron.schema.json",
   "$ref": "#/definitions/Patron",
   "definitions": {
     "Patron": {

package/schema/PatronCategory.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "PatronCategory.schema.json",
+  "$id": "/PatronCategory.schema.json",
   "$ref": "#/definitions/PatronCategory",
   "definitions": {
     "PatronCategory": {

package/schema/Property.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Property.schema.json",
+  "$id": "/Property.schema.json",
   "$ref": "#/definitions/Property",
   "definitions": {
     "Property": {

package/schema/Race.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Race.schema.json",
+  "$id": "/Race.schema.json",
   "$ref": "#/definitions/Race",
   "definitions": {
     "Race": {

package/schema/Region.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Region.schema.json",
+  "$id": "/Region.schema.json",
   "$ref": "#/definitions/Region",
   "definitions": {
     "Region": {

package/schema/Ritual.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Ritual.schema.json",
+  "$id": "/Ritual.schema.json",
   "$ref": "#/definitions/Ritual",
   "definitions": {
     "Ritual": {

package/schema/Service.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Service.schema.json",
+  "$id": "/Service.schema.json",
   "$ref": "#/definitions/Service",
   "definitions": {
     "Service": {

package/schema/SexPractice.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "SexPractice.schema.json",
+  "$id": "/SexPractice.schema.json",
   "$ref": "#/definitions/SexPractice",
   "definitions": {
     "SexPractice": {

package/schema/Skill.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Skill.schema.json",
+  "$id": "/Skill.schema.json",
   "$ref": "#/definitions/Skill",
   "definitions": {
     "Skill": {

package/schema/SkillGroup.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "SkillGroup.schema.json",
+  "$id": "/SkillGroup.schema.json",
   "$ref": "#/definitions/SkillGroup",
   "definitions": {
     "SkillGroup": {

package/schema/SkillModificationLevel.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "SkillModificationLevel.schema.json",
+  "$id": "/SkillModificationLevel.schema.json",
   "$ref": "#/definitions/SkillModificationLevel",
   "definitions": {
     "SkillModificationLevel": {

package/schema/SocialStatus.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "SocialStatus.schema.json",
+  "$id": "/SocialStatus.schema.json",
   "$ref": "#/definitions/SocialStatus",
   "definitions": {
     "SocialStatus": {

package/schema/Spell.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "Spell.schema.json",
+  "$id": "/Spell.schema.json",
   "$ref": "#/definitions/Spell",
   "definitions": {
     "Spell": {

package/schema/State.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "State.schema.json",
+  "$id": "/State.schema.json",
   "$ref": "#/definitions/State",
   "definitions": {
     "State": {

package/schema/TargetCategory.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "TargetCategory.schema.json",
+  "$id": "/TargetCategory.schema.json",
   "$ref": "#/definitions/TargetCategory",
   "definitions": {
     "TargetCategory": {

package/schema/_Activatable.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "_Activatable.schema.json",
+  "$id": "/_Activatable.schema.json",
   "definitions": {
     "Id": {
       "description": "The activatable entry's identifier. An unique, increasing integer.",

package/schema/_ActivatableSkill.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "_ActivatableSkill.schema.json",
+  "$id": "/_ActivatableSkill.schema.json",
   "definitions": {
     "Effect": {
       "T": {

package/schema/_CommonnessRatedAdvantageDisadvantage.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "_CommonnessRatedAdvantageDisadvantage.schema.json",
+  "$id": "/_CommonnessRatedAdvantageDisadvantage.schema.json",
   "definitions": {
     "CommonnessRatedAdvantageDisadvantage": {
       "title": "Commonness-rated Advantage/Disadvantage",

package/schema/_Enhancements.schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "_Enhancements.schema.json",
+  "$id": "/_Enhancements.schema.json",
   "definitions": {
     "Enhancements": {
       "description": "A list of enhancements.",