optolith-database-schema 0.17.0 → 0.18.1

package/lib/types/traditionArtifacts/WeaponEnchantment.js

@@ -1,14 +1,37 @@
-/**
- * @main WeaponEnchantment
- */
-import { todo } from "../../validation/builders/integrity.js";
-import { validateEntityFileName } from "../../validation/builders/naming.js";
-import { createSchemaValidator } from "../../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../../validation/filename.js";
-export const config = {
+import { Entity, IncludeIdentifier, Object, Optional, Required } from "tsondb/schema/def";
+import { aeCost, ap_value, ap_value_append, ap_value_l10n, bindingCost, cost, effect, levels, maximum, name, name_in_library, property, select_options, volume, volume_l10n, } from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { NestedLocaleMap } from "../Locale.js";
+import { Errata } from "../source/_Erratum.js";
+import { src } from "../source/_PublicationRef.js";
+export const WeaponEnchantment = Entity(import.meta.url, {
     name: "WeaponEnchantment",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("WeaponEnchantment"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "WeaponEnchantments",
+    type: () => Object({
+        levels,
+        select_options,
+        maximum,
+        prerequisites: Optional({
+            type: IncludeIdentifier(GeneralPrerequisites),
+        }),
+        volume,
+        cost,
+        property,
+        ap_value,
+        src,
+        translations: NestedLocaleMap(Required, "WeaponEnchantmentTranslation", Object({
+            name,
+            name_in_library,
+            effect,
+            bindingCost,
+            aeCost,
+            volume: volume_l10n,
+            ap_value_append,
+            ap_value: ap_value_l10n,
+            errata: Optional({
+                type: IncludeIdentifier(Errata),
+            }),
+        })),
+    }),
+    displayName: {},
+});

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

@@ -1,52 +1,8 @@
-/**
- * @main AnimalShape
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape
- */
-export type AnimalShape = {
-    /**
-     * The animal shape's identifier. An unique, increasing integer.
-     * @integer
-     * @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 type AnimalShapePathReference = {
-    /**
-     * The identifier of the animal shape's path.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-export type AnimalShapeSizeReference = {
-    /**
-     * The identifier of the animal shape's size.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-export type AnimalShapeTranslation = {
-    /**
-     * The animal shape name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShape, AnimalShape["id"], "AnimalShape">;
+import { Entity, String } from "tsondb/schema/def";
+export declare const AnimalShape: Entity<"AnimalShape", {
+    path: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+    size: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"AnimalShapeTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+    }>, true>;
+}, undefined>;

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

@@ -1,14 +1,24 @@
-/**
- * @main AnimalShape
- */
-import { todo } from "../../../validation/builders/integrity.js";
-import { validateEntityFileName } from "../../../validation/builders/naming.js";
-import { createSchemaValidator } from "../../../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js";
-export const config = {
+import { Entity, Object, Required, String } from "tsondb/schema/def";
+import { AnimalShapePathIdentifier, AnimalShapeSizeIdentifier } from "../../_Identifier.js";
+import { NestedLocaleMap } from "../../Locale.js";
+export const AnimalShape = Entity(import.meta.url, {
     name: "AnimalShape",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("AnimalShape"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "AnimalShapes",
+    type: () => Object({
+        path: Required({
+            comment: "The animal shape’s path.",
+            type: AnimalShapePathIdentifier(),
+        }),
+        size: Required({
+            comment: "The animal shape’s size.",
+            type: AnimalShapeSizeIdentifier(),
+        }),
+        translations: NestedLocaleMap(Required, "AnimalShapeTranslation", Object({
+            name: Required({
+                comment: "The animal shape’s name.",
+                type: String({ minLength: 1 }),
+            }),
+        })),
+    }),
+    displayName: {},
+});

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

@@ -1,28 +1,6 @@
-/**
- * @main AnimalShapePath
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape Path
- */
-export type AnimalShapePath = {
-    /**
-     * The animal shape path's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<AnimalShapePathTranslation>;
-};
-export type AnimalShapePathTranslation = {
-    /**
-     * The animal shape path's name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShapePath, AnimalShapePath["id"], "AnimalShapePath">;
+import { Entity, String } from "tsondb/schema/def";
+export declare const AnimalShapePath: Entity<"AnimalShapePath", {
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"AnimalShapePathTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+    }>, true>;
+}, undefined>;

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

@@ -1,14 +1,15 @@
-/**
- * @main AnimalShapePath
- */
-import { todo } from "../../../validation/builders/integrity.js";
-import { validateEntityFileName } from "../../../validation/builders/naming.js";
-import { createSchemaValidator } from "../../../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js";
-export const config = {
+import { Entity, Object, Required, String } from "tsondb/schema/def";
+import { NestedLocaleMap } from "../../Locale.js";
+export const AnimalShapePath = Entity(import.meta.url, {
     name: "AnimalShapePath",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("AnimalShapePath"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "AnimalShapePaths",
+    type: () => Object({
+        translations: NestedLocaleMap(Required, "AnimalShapePathTranslation", Object({
+            name: Required({
+                comment: "The animal shape path’s name.",
+                type: String({ minLength: 1 }),
+            }),
+        })),
+    }),
+    displayName: {},
+});

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

@@ -1,40 +1,8 @@
-/**
- * @main AnimalShapeSize
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Animal Shape Size
- */
-export type AnimalShapeSize = {
-    /**
-     * The animal shape's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The volume points the animal shape needs.
-     * @integer
-     * @minimum 1
-     */
-    volume: number;
-    /**
-     * The adventure point value of the animal shape.
-     * @integer
-     * @minimum 1
-     */
-    ap_value: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<AnimalShapeSizeTranslation>;
-};
-export type AnimalShapeSizeTranslation = {
-    /**
-     * The animal shape size name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<AnimalShapeSize, AnimalShapeSize["id"], "AnimalShapeSize">;
+import { Entity, Integer, String } from "tsondb/schema/def";
+export declare const AnimalShapeSize: Entity<"AnimalShapeSize", {
+    volume: import("tsondb/schema/def").MemberDecl<Integer, true>;
+    ap_value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"AnimalShapeSizeTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+    }>, true>;
+}, undefined>;

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

@@ -1,14 +1,23 @@
-/**
- * @main AnimalShapeSize
- */
-import { todo } from "../../../validation/builders/integrity.js";
-import { validateEntityFileName } from "../../../validation/builders/naming.js";
-import { createSchemaValidator } from "../../../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js";
-export const config = {
+import { Entity, Integer, Object, Required, String } from "tsondb/schema/def";
+import { NestedLocaleMap } from "../../Locale.js";
+export const AnimalShapeSize = Entity(import.meta.url, {
     name: "AnimalShapeSize",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("AnimalShapeSize"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "AnimalShapeSizes",
+    type: () => Object({
+        volume: Required({
+            comment: "The animal shape size’s volume points",
+            type: Integer({ minimum: 1 }),
+        }),
+        ap_value: Required({
+            comment: "The animal shape size’s adventure point value",
+            type: Integer({ minimum: 1 }),
+        }),
+        translations: NestedLocaleMap(Required, "AnimalShapeSizeTranslation", Object({
+            name: Required({
+                comment: "The animal shape size’s name.",
+                type: String({ minLength: 1 }),
+            }),
+        })),
+    }),
+    displayName: {},
+});

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

@@ -1,28 +1,6 @@
-/**
- * @main Brew
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyString } from "../../_NonEmptyString.js";
-/**
- * @title Brew
- */
-export type Brew = {
-    /**
-     * The brew's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<BrewTranslation>;
-};
-export type BrewTranslation = {
-    /**
-     * The brew name.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<Brew, Brew["id"], "Brew">;
+import { Entity, String } from "tsondb/schema/def";
+export declare const Brew: Entity<"Brew", {
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"BrewTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+    }>, true>;
+}, undefined>;

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

@@ -1,14 +1,15 @@
-/**
- * @main Brew
- */
-import { todo } from "../../../validation/builders/integrity.js";
-import { validateEntityFileName } from "../../../validation/builders/naming.js";
-import { createSchemaValidator } from "../../../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../../../validation/filename.js";
-export const config = {
+import { Entity, Object, Required, String } from "tsondb/schema/def";
+import { NestedLocaleMap } from "../../Locale.js";
+export const Brew = Entity(import.meta.url, {
     name: "Brew",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("Brew"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "Brews",
+    type: () => Object({
+        translations: NestedLocaleMap(Required, "BrewTranslation", Object({
+            name: Required({
+                comment: "The brew’s name.",
+                type: String({ minLength: 1 }),
+            }),
+        })),
+    }),
+    displayName: {},
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.17.0",
+  "version": "0.18.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",
@@ -8,35 +8,40 @@
     "dsa",
     "dasschwarzeauge"
   ],
+  "files": [
+    "lib",
+    "schema",
+    "AUTHORS",
+    "CHANGELOG.md"
+  ],
   "main": "./lib/main.js",
   "exports": {
     ".": "./lib/main.js",
     "./errors": "./lib/errors.js",
     "./cache/*": "./lib/cache/*.js",
     "./config/*": "./lib/config/*.js",
+    "./rendering/*": "./lib/rendering/*.js",
+    "./types": "./lib/types/index.js",
     "./types/*": "./lib/types/*.js"
   },
   "scripts": {
-    "build:ts": "tsc",
-    "watch:ts": "tsc -w",
-    "build:gen": "otjsmd",
-    "watch:gen": "otjsmd -w",
-    "build": "npm run build:ts && npm run build:gen",
-    "release": "standard-version",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "node ./lib/test.js",
+    "release": "commit-and-tag-version",
+    "release:sign": "commit-and-tag-version --sign --signoff"
   },
   "author": "Lukas Obermann",
   "license": "MPL-2.0",
   "dependencies": {
-    "ajv": "^8.12.0",
-    "ajv-formats": "^2.1.1",
-    "yaml": "^2.3.3"
+    "@optolith/helpers": "^0.2.2",
+    "tsondb": "^0.7.4",
+    "yaml": "^2.8.1"
   },
   "devDependencies": {
-    "@types/node": "^20.8.10",
-    "optolith-tsjsonschemamd": "^0.10.6",
-    "standard-version": "^9.5.0",
-    "typescript": "^5.2.2"
+    "@types/node": "^24.6.2",
+    "commit-and-tag-version": "^12.6.0",
+    "typescript": "^5.9.3"
   },
   "repository": "github:elyukai/optolith-database-schema",
   "bugs": {

package/schema/Advantage.schema.json

@@ -32,12 +32,12 @@
           "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValue"
         },
         "has_maximum_spent_influence": {
-          "description": "Does this advantage count towards the maximum of AP to be spent on\nadvantages?",
+          "description": "Does this advantage count towards the maximum of AP to be spent on advantages?",
           "type": "boolean",
           "default": true
         },
         "is_exclusive_to_arcane_spellworks": {
-          "description": "Does this advantage exclusively applies to arcane spellworks and not\nto magical actions and magical applications?",
+          "description": "Does this advantage exclusively applies to arcane spellworks and not to magical actions and magical applications?",
           "type": "boolean",
           "default": false
         },
@@ -91,7 +91,7 @@
           "$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.",
+          "description": "A string that gets appended to the default AP Value text with a preceding space. This always happens if present, even if the generated AP Value text is replaced.",
           "$ref": "./_Activatable.schema.json#/$defs/AdventurePointsValueAppend"
         },
         "errata": {

package/schema/AnimalDisease.schema.json

@@ -18,11 +18,11 @@
           "minimum": 1
         },
         "resistance": {
-          "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the\ndisease roll. It may also happen that the lower of both is applied as a\npenalty.",
+          "description": "Depending on the disease, apply Spirit or Toughness as a penalty to the disease roll. It may also happen that the lower of both is applied as a penalty.",
           "$ref": "./_DiseasePoison.schema.json#/$defs/Resistance"
         },
         "cause": {
-          "description": "What causes the disease? The GM rolls 1D20 to see if a character gets\ninfected. If the infection check succeeds, the GM makes a disease check to\ndetermine the severity of the infection.",
+          "description": "What causes the disease? The GM rolls 1D20 to see if a character gets infected. If the infection check succeeds, the GM makes a disease check to determine the severity of the infection.",
           "type": "array",
           "items": {
             "$ref": "./_DiseasePoison.schema.json#/$defs/Cause"
@@ -30,14 +30,14 @@
           "minItems": 1
         },
         "animal_types": {
-          "description": "The animal types this disease applies to.\n\nIf no animal types are given, the animal disease applies to all animal\ntypes.",
+          "description": "The animal types this disease applies to.\n\nIf no animal types are given, the animal disease applies to all animal types.",
           "type": "array",
           "items": {
             "$ref": "./_SimpleReferences.schema.json#/$defs/AnimalTypeReference"
           }
         },
         "communicability_to_intelligent_creatures": {
-          "description": "If and at which chance the disease can be communicated to intelligent\ncreatures.\n\nIf no causes are given, the disease is not communicable to intelligent\ncreatures.",
+          "description": "If and at which chance the disease can be communicated to intelligent creatures.\n\nIf no causes are given, the disease is not communicable to intelligent creatures.",
           "type": "array",
           "items": {
             "$ref": "./_DiseasePoison.schema.json#/$defs/Cause"

package/schema/Aspect.schema.json

@@ -38,7 +38,7 @@
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
         "master_of_aspect_suffix": {
-          "description": "The aspect's name appended to the simple name (not `name_in_library`)\nof the special ability *Master of (Aspect)*.",
+          "description": "The aspect's name appended to the simple name (not `name_in_library`) of the special ability *Master of (Aspect)*.",
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         }
       },

package/schema/Blessing.schema.json

@@ -18,7 +18,7 @@
         },
         "target": {
           "description": "The target category – the kind of creature or object – the skill affects.",
-          "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/TargetCategory"
+          "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/AffectedTargetCategories"
         },
         "src": {
           "$ref": "./source/_PublicationRef.schema.json#/$defs/PublicationRefs"
@@ -236,7 +236,7 @@
           "type": "object",
           "patternProperties": {
             "^[a-z]{2}-[A-Z]{2}$": {
-              "$ref": "#/$defs/IndefiniteDurationTranslation"
+              "$ref": "#/$defs/IndefiniteBlessingDurationTranslation"
             }
           },
           "minProperties": 1,
@@ -248,7 +248,7 @@
       ],
       "additionalProperties": false
     },
-    "IndefiniteDurationTranslation": {
+    "IndefiniteBlessingDurationTranslation": {
       "type": "object",
       "properties": {
         "description": {

package/schema/Cantrip.schema.json

@@ -18,14 +18,14 @@
         },
         "target": {
           "description": "The target category – the kind of creature or object – the skill affects.",
-          "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/TargetCategory"
+          "$ref": "./_ActivatableSkillTargetCategory.schema.json#/$defs/AffectedTargetCategories"
         },
         "property": {
           "description": "The associated property.",
           "$ref": "./_SimpleReferences.schema.json#/$defs/PropertyReference"
         },
         "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.",
+          "description": "A note specifying the dissemination of the cantrip in different traditions. Sometimes a cantrip is exclusively available to one or more specific traditions, but usually one the academies and traditions are listed the cantrip is most commonly teached in.",
           "$ref": "#/$defs/CantripNote"
         },
         "src": {
@@ -414,7 +414,7 @@
           "type": "object",
           "patternProperties": {
             "^[a-z]{2}-[A-Z]{2}$": {
-              "$ref": "#/$defs/IndefiniteDurationTranslation"
+              "$ref": "#/$defs/IndefiniteCantripDurationTranslation"
             }
           },
           "minProperties": 1,
@@ -426,7 +426,7 @@
       ],
       "additionalProperties": false
     },
-    "IndefiniteDurationTranslation": {
+    "IndefiniteCantripDurationTranslation": {
       "type": "object",
       "properties": {
         "description": {