optolith-database-schema 0.13.3 → 0.13.5

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.13.5](https://github.com/elyukai/optolith-database-schema/compare/v0.13.4...v0.13.5) (2023-12-05)
+
+### [0.13.4](https://github.com/elyukai/optolith-database-schema/compare/v0.13.3...v0.13.4) (2023-12-01)
+
+
+### Bug Fixes
+
+* make complexity optional for natural weapons ([13a3b53](https://github.com/elyukai/optolith-database-schema/commit/13a3b530f4cabf4c644c7ded8b020cef21df9013))
+* musical instruments may have a complexity and combat use ([8e6dab0](https://github.com/elyukai/optolith-database-schema/commit/8e6dab0907af7d11f32631c00f8abc4178157492))
+
 ### [0.13.3](https://github.com/elyukai/optolith-database-schema/compare/v0.13.2...v0.13.3) (2023-11-01)
 
 

package/lib/config/build.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaSpec } from "optolith-tsjsonschemamd/config";
+import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers/jsonSchema";
 export declare const sourceDir: string;
 export declare const libDir: string;
 export declare const jsonSchemaDir: string;

package/lib/config/build.js

@@ -1,8 +1,9 @@
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
+import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers/jsonSchema";
 const root = join(dirname(fileURLToPath(import.meta.url)), "..", "..");
 export const sourceDir = join(root, "src", "types");
 export const libDir = join(root, "lib", "types");
 export const jsonSchemaDir = join(root, "schema");
 export const markdownDir = join(root, "docs", "reference");
-export const jsonSchemaSpec = "Draft_2019_09";
+export const jsonSchemaSpec = JsonSchemaSpec.Draft_2019_09;

package/lib/types/equipment/item/MusicalInstrument.d.ts

@@ -4,7 +4,7 @@
 import { TypeConfig } from "../../../typeConfig.js";
 import { LocaleMap } from "../../_LocaleMap.js";
 import { PublicationRefs } from "../../source/_PublicationRef.js";
-import { Cost, DefaultItemTranslation, Weight } from "./_Item.js";
+import { CombatUse, Complexity, Cost, DefaultItemTranslation, Weight } from "./_Item.js";
 export type MusicalInstrument = {
     /**
      * The cost in silverthalers.
@@ -14,6 +14,15 @@ export type MusicalInstrument = {
      * The weight in kg.
      */
     weight: Weight;
+    /**
+     * The complexity of crafting the item.
+     */
+    complexity?: Complexity;
+    /**
+     * The item can also be used either as an improvised weapon or as an armor,
+     * although this is not the primary use case of the item.
+     */
+    combat_use?: CombatUse;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

package/lib/types/equipment/item/Weapon.d.ts

@@ -20,9 +20,9 @@ export type Weapon = {
      */
     weight: Weight;
     /**
-     * The complexity of crafting the item.
+     * The complexity of crafting the item, if any.
      */
-    complexity: Complexity;
+    complexity?: Complexity;
     /**
      * The structure points of the item. Use an array if the item consists of
      * multiple components that have individual structure points.

package/lib/validation/schema.d.ts

@@ -1,6 +1,6 @@
 import AjvModule from "ajv";
 import Ajv2019Module from "ajv/dist/2019.js";
 import Ajv2020Module from "ajv/dist/2020.js";
-import type { JsonSchemaSpec } from "optolith-tsjsonschemamd/config";
+import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers/jsonSchema";
 import "../helpers/array.js";
 export declare const getPreparedSchemaValidator: (jsonSchemaSpec: JsonSchemaSpec, validatorOptions: AjvModule.Options | undefined, jsonSchemaDir: string) => Promise<Ajv2019Module.default | Ajv2020Module.default>;

package/lib/validation/schema.js

@@ -1,6 +1,7 @@
 import addFormatsModule from "ajv-formats";
 import Ajv2019Module from "ajv/dist/2019.js";
 import Ajv2020Module from "ajv/dist/2020.js";
+import { JsonSchemaSpec } from "optolith-tsjsonschemamd/renderers/jsonSchema";
 import "../helpers/array.js";
 import { isHiddenFileName, readDirectoryRec, readJsonFile } from "../helpers/io.js";
 import { assertExhaustive } from "../helpers/typeSafety.js";
@@ -9,10 +10,10 @@ const Ajv2020 = Ajv2020Module.default;
 const addFormats = addFormatsModule.default;
 const createSchemaValidator = (jsonSchemaSpec, validatorOptions = {}) => {
     switch (jsonSchemaSpec) {
-        case "Draft_07":
-        case "Draft_2019_09":
+        case JsonSchemaSpec.Draft_07:
+        case JsonSchemaSpec.Draft_2019_09:
             return new Ajv2019(validatorOptions);
-        case "Draft_2020_12":
+        case JsonSchemaSpec.Draft_2020_12:
             return new Ajv2020(validatorOptions);
         default:
             assertExhaustive(jsonSchemaSpec);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.13.3",
+  "version": "0.13.5",
   "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",
@@ -33,7 +33,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.8.10",
-    "optolith-tsjsonschemamd": "^0.9.4",
+    "optolith-tsjsonschemamd": "^0.10.2",
     "standard-version": "^9.5.0",
     "typescript": "^5.2.2"
   },

package/schema/Profession.schema.json

@@ -648,34 +648,22 @@
       ]
     },
     "FixedVariantSpecialAbility": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "description": "The identifier of the combat technique to provide the rating for.",
-          "$ref": "./_IdentifierGroup.schema.json#/$defs/SpecialAbilityIdentifier"
-        },
-        "level": {
-          "description": "The level of the received special ability.",
-          "type": "integer",
-          "minimum": 1
+      "allOf": [
+        {
+          "$ref": "#/$defs/SpecialAbilityDefinition"
         },
-        "options": {
-          "description": "Received select options. Order is important. Typically, you only need the\nfirst array index, though.",
-          "type": "array",
-          "items": {
-            "$ref": "./_IdentifierGroup.schema.json#/$defs/RequirableSelectOptionIdentifier"
+        {
+          "type": "object",
+          "properties": {
+            "active": {
+              "description": "if set to `false`, if the selection is granted by the basic package, it\nis removed.",
+              "const": false
+            }
           },
-          "minItems": 1
-        },
-        "active": {
-          "description": "if set to `false`, if the selection is granted by the basic package, it\nis removed.",
-          "const": false
+          "required": []
         }
-      },
-      "required": [
-        "id"
       ],
-      "additionalProperties": false
+      "unresolvedProperties": false
     },
     "VariantSpecialAbilitySelection": {
       "type": "object",

package/schema/Race.schema.json

@@ -240,28 +240,24 @@
       "additionalProperties": false
     },
     "WeightDice": {
-      "type": "object",
-      "properties": {
-        "number": {
-          "description": "Number of dice of the same type. Example: 2 in 2D6.",
-          "type": "integer",
-          "minimum": 1
-        },
-        "sides": {
-          "description": "Number of sides on every die. Example: 6 in 2D6.",
-          "$ref": "./_Dice.schema.json#/$defs/DieType"
+      "allOf": [
+        {
+          "$ref": "./_Dice.schema.json#/$defs/Dice"
         },
-        "offset_strategy": {
-          "description": "The strategy how to offset the randomly generated values against the\nbase value. Either they are all added or subtracted or even results are\nadded and odd results are subtracted.",
-          "$ref": "#/$defs/WeightDiceOffsetStrategy"
+        {
+          "type": "object",
+          "properties": {
+            "offset_strategy": {
+              "description": "The strategy how to offset the randomly generated values against the\nbase value. Either they are all added or subtracted or even results are\nadded and odd results are subtracted.",
+              "$ref": "#/$defs/WeightDiceOffsetStrategy"
+            }
+          },
+          "required": [
+            "offset_strategy"
+          ]
         }
-      },
-      "required": [
-        "number",
-        "sides",
-        "offset_strategy"
       ],
-      "additionalProperties": false
+      "unresolvedProperties": false
     },
     "WeightDiceOffsetStrategy": {
       "description": "The strategy how to offset the randomly generated values against the\nbase value. Either they are all added or subtracted or even results are\nadded and odd results are subtracted.",

package/schema/_ActivatableSkillDuration.schema.json

@@ -201,41 +201,39 @@
     },
     "CheckResultBasedDuration": {
       "description": "Defines the duration being based on a check result.",
-      "type": "object",
-      "properties": {
-        "base": {
-          "description": "The base value that is derived from the check result.",
-          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultValue"
-        },
-        "modifier": {
-          "description": "If defined, it modifies the base value.",
-          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBasedModifier"
-        },
-        "is_maximum": {
-          "description": "If the duration is the maximum duration, so it may end earlier.",
-          "const": true
-        },
-        "unit": {
-          "description": "The duration unit.",
-          "$ref": "#/$defs/DurationUnit"
+      "allOf": [
+        {
+          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBased"
         },
-        "translations": {
-          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+        {
           "type": "object",
-          "patternProperties": {
-            "^[a-z]{2}-[A-Z]{2}$": {
-              "$ref": "#/$defs/CheckResultBasedDurationTranslation"
+          "properties": {
+            "is_maximum": {
+              "description": "If the duration is the maximum duration, so it may end earlier.",
+              "const": true
+            },
+            "unit": {
+              "description": "The duration unit.",
+              "$ref": "#/$defs/DurationUnit"
+            },
+            "translations": {
+              "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+              "type": "object",
+              "patternProperties": {
+                "^[a-z]{2}-[A-Z]{2}$": {
+                  "$ref": "#/$defs/CheckResultBasedDurationTranslation"
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
             }
           },
-          "minProperties": 1,
-          "additionalProperties": false
+          "required": [
+            "unit"
+          ]
         }
-      },
-      "required": [
-        "base",
-        "unit"
       ],
-      "additionalProperties": false
+      "unresolvedProperties": false
     },
     "CheckResultBasedDurationTranslation": {
       "type": "object",

package/schema/_ActivatableSkillRange.schema.json

@@ -205,34 +205,32 @@
     },
     "CheckResultBasedRange": {
       "description": "Defines the range being based on a check result.",
-      "type": "object",
-      "properties": {
-        "base": {
-          "description": "The base value that is derived from the check result.",
-          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultValue"
-        },
-        "modifier": {
-          "description": "If defined, it modifies the base value.",
-          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBasedModifier"
-        },
-        "is_maximum": {
-          "description": "If the range is the maximum range.",
-          "const": true
-        },
-        "unit": {
-          "description": "The duration unit.",
-          "$ref": "#/$defs/RangeUnit"
+      "allOf": [
+        {
+          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBased"
         },
-        "is_radius": {
-          "description": "If `true`, the range is a radius.",
-          "const": true
+        {
+          "type": "object",
+          "properties": {
+            "is_maximum": {
+              "description": "If the range is the maximum range.",
+              "const": true
+            },
+            "unit": {
+              "description": "The duration unit.",
+              "$ref": "#/$defs/RangeUnit"
+            },
+            "is_radius": {
+              "description": "If `true`, the range is a radius.",
+              "const": true
+            }
+          },
+          "required": [
+            "unit"
+          ]
         }
-      },
-      "required": [
-        "base",
-        "unit"
       ],
-      "additionalProperties": false
+      "unresolvedProperties": false
     },
     "RangeTranslation": {
       "type": "object",

package/schema/equipment/item/MusicalInstrument.schema.json

@@ -14,6 +14,14 @@
           "description": "The weight in kg.",
           "$ref": "./_Item.schema.json#/$defs/Weight"
         },
+        "complexity": {
+          "description": "The complexity of crafting the item.",
+          "$ref": "./_Item.schema.json#/$defs/Complexity"
+        },
+        "combat_use": {
+          "description": "The item can also be used either as an improvised weapon or as an armor,\nalthough this is not the primary use case of the item.",
+          "$ref": "./_Item.schema.json#/$defs/CombatUse"
+        },
         "src": {
           "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
         },

package/schema/equipment/item/Weapon.schema.json

@@ -15,7 +15,7 @@
           "$ref": "./_Item.schema.json#/$defs/Weight"
         },
         "complexity": {
-          "description": "The complexity of crafting the item.",
+          "description": "The complexity of crafting the item, if any.",
           "$ref": "./_Item.schema.json#/$defs/Complexity"
         },
         "structure_points": {
@@ -64,7 +64,6 @@
       "required": [
         "cost",
         "weight",
-        "complexity",
         "uses",
         "src",
         "translations"