optolith-database-schema 0.1.14 → 0.1.17

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 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.1.17](https://github.com/elyukai/optolith-database-schema/compare/v0.1.16...v0.1.17) (2022-03-21)
+
+
+### Bug Fixes
+
+* duration value can be 1 ([9be3bdb](https://github.com/elyukai/optolith-database-schema/commit/9be3bdbc0e0b8502e7d0424f94eaf1b7b57091eb))
+* zibilja rituals need their own custom parameters ([d60ee69](https://github.com/elyukai/optolith-database-schema/commit/d60ee693dda449d2b00d4f77dbef8d0a9e1e1e8b))
+
+### [0.1.16](https://github.com/elyukai/optolith-database-schema/compare/v0.1.15...v0.1.16) (2022-03-17)
+
+
+### Features
+
+* support countable entities for ae cost of elven magical songs ([2feb0de](https://github.com/elyukai/optolith-database-schema/commit/2feb0deed85b7e823597560fd83523556a283642))
+
+
+### Bug Fixes
+
+* sex restriction of a name group from a culture should be optional ([e09f0b4](https://github.com/elyukai/optolith-database-schema/commit/e09f0b43d8b193303d67247a060fcaad8495a99f))
+
+### [0.1.15](https://github.com/elyukai/optolith-database-schema/compare/v0.1.14...v0.1.15) (2022-03-16)
+
+
+### Bug Fixes
+
+* remove fields not present in cantrip ([132f37b](https://github.com/elyukai/optolith-database-schema/commit/132f37b211732c039f784e1279ff997f998d0be7))
+
 ### [0.1.14](https://github.com/elyukai/optolith-database-schema/compare/v0.1.13...v0.1.14) (2022-03-16)
 
 

package/lib/types/Cantrip.d.ts

@@ -80,14 +80,6 @@ export declare type Cantrip = {
              * @minLength 1
              */
             effect: string;
-            /**
-             * @deprecated
-             */
-            casting_time: string;
-            /**
-             * @deprecated
-             */
-            cost: string;
             /**
              * @deprecated
              */

package/lib/types/Culture.d.ts

@@ -473,7 +473,7 @@ declare type NameGroup = {
     /**
      * The binary sex if the group is only for a certain binary sex.
      */
-    sex: BinarySex;
+    sex?: BinarySex;
     /**
      * The names from the group.
      * @minItems 1

package/lib/types/_ActivatableSkill.d.ts

@@ -147,16 +147,7 @@ export declare namespace CastingTime {
         /**
          * The default casting time definition.
          */
-        default: {
-            tag: "Modifiable";
-            /**
-             * The initial skill modification identifier/level.
-             * @integer
-             * @minimum 1
-             * @maximum 6
-             */
-            initial_modification_level: number;
-        } | NonModifiable;
+        default: ModifiableCastingTime | NonModifiable;
         /**
          * The casting time during lovemaking. In Aventurian Intimacy, you may only
          * use an activatable skill during lovemaking if it has a casting time used
@@ -175,6 +166,16 @@ export declare namespace CastingTime {
             unit: CastingTimeDuringLovemakingUnit;
         };
     };
+    type ModifiableCastingTime = {
+        tag: "Modifiable";
+        /**
+         * The initial skill modification identifier/level.
+         * @integer
+         * @minimum 1
+         * @maximum 6
+         */
+        initial_modification_level: number;
+    };
     type FastSkillCastingTime = {
         tag: "NonModifiable";
         /**
@@ -480,12 +481,15 @@ export declare namespace Range {
         translations?: {
             /**
              * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
              */
             [localeId: string]: {
                 /**
-                 * A note, appended to the generated string in parenthesis.
+                 * A note, appended to the generated string in parenthesis. If the
+                 * generated is modified using `replacement`, the note is appended to
+                 * the modifier string.
                  */
-                note: {
+                note?: {
                     /**
                      * The full note.
                      * @minLength 1
@@ -498,6 +502,31 @@ export declare namespace Range {
                      */
                     compressed?: string;
                 };
+                /**
+                 * A replacement string. If `note` is provided, it is appended to the
+                 * replaced string.
+                 */
+                replacement?: {
+                    /**
+                     * The full replacement string. It must contain `$1`, which is
+                     * going to be replaced with the generated duration string, so
+                     * additional information can be provided without duplicating
+                     * concrete numeric values.
+                     * @minLength 1
+                     * @pattern \$1
+                     */
+                    default: string;
+                    /**
+                     * A compressed replacement string for use in small areas (e.g. on
+                     * character sheet). It must contain `$1`, which is going to be
+                     * replaced with the generated duration string, so additional
+                     * information can be provided without duplicating concrete
+                     * numeric values.
+                     * @minLength 1
+                     * @pattern \$1
+                     */
+                    compressed: string;
+                };
             };
         };
     };
@@ -651,7 +680,7 @@ export declare namespace Duration {
             /**
              * The (unitless) duration.
              * @integer
-             * @minimum 2
+             * @minimum 1
              */
             value: number;
             /**
@@ -909,6 +938,7 @@ export declare namespace Duration {
         Weeks = "Weeks",
         Months = "Months",
         Years = "Years",
+        Centuries = "Centuries",
         CombatRounds = "CombatRounds"
     }
     type UnitValue = {

package/lib/types/_ActivatableSkill.js

@@ -28,6 +28,7 @@ export var Duration;
         Unit["Weeks"] = "Weeks";
         Unit["Months"] = "Months";
         Unit["Years"] = "Years";
+        Unit["Centuries"] = "Centuries";
         Unit["CombatRounds"] = "CombatRounds";
     })(Unit = Duration.Unit || (Duration.Unit = {}));
 })(Duration || (Duration = {}));

package/lib/types/magicalActions/ElvenMagicalSong.d.ts

@@ -144,6 +144,34 @@ declare type PerformanceParameters = {
                 };
             };
         };
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 * The cost have to be per a specific countable entity, e.g. `8 AE
+                 * per person`.
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
     };
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ElvenMagicalSong>;

package/lib/types/magicalActions/ZibiljaRitual.d.ts

@@ -3,7 +3,7 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
-import { Effect, SlowPerformanceParameters, TargetCategory } from "../_ActivatableSkill.js";
+import { CastingTime, Cost, Duration, Effect, Range, TargetCategory } from "../_ActivatableSkill.js";
 import { ImprovementCost } from "../_ImprovementCost.js";
 import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck.js";
 /**
@@ -27,7 +27,7 @@ export declare type ZibiljaRitual = {
     /**
      * Measurable parameters of a zibilja ritual.
      */
-    parameters: SlowPerformanceParameters;
+    parameters: PerformanceParameters;
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
@@ -99,4 +99,11 @@ export declare type ZibiljaRitual = {
         };
     };
 };
+declare type PerformanceParameters = {
+    casting_time: CastingTime.ModifiableCastingTime | CastingTime.SlowSkillCastingTime;
+    cost: Cost.OneTime.T;
+    range: Range.T;
+    duration: Duration.OneTime.T;
+};
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<ZibiljaRitual>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.14",
+  "version": "0.1.17",
   "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",

package/schema/Cantrip.schema.json

@@ -105,12 +105,6 @@
                   "type": "string",
                   "minLength": 1
                 },
-                "casting_time": {
-                  "type": "string"
-                },
-                "cost": {
-                  "type": "string"
-                },
                 "range": {
                   "type": "string"
                 },
@@ -127,8 +121,6 @@
               "required": [
                 "name",
                 "effect",
-                "casting_time",
-                "cost",
                 "range",
                 "duration",
                 "target"

package/schema/Culture.schema.json

@@ -831,7 +831,6 @@
       },
       "required": [
         "label",
-        "sex",
         "names"
       ],
       "additionalProperties": false

package/schema/_ActivatableSkill.schema.json

@@ -284,6 +284,25 @@
       ]
     },
     "CastingTime": {
+      "ModifiableCastingTime": {
+        "type": "object",
+        "properties": {
+          "tag": {
+            "const": "Modifiable"
+          },
+          "initial_modification_level": {
+            "description": "The initial skill modification identifier/level.",
+            "type": "integer",
+            "maximum": 6,
+            "minimum": 1
+          }
+        },
+        "required": [
+          "tag",
+          "initial_modification_level"
+        ],
+        "additionalProperties": false
+      },
       "FastSkillCastingTime": {
         "type": "object",
         "properties": {
@@ -331,23 +350,7 @@
             "description": "The default casting time definition.",
             "oneOf": [
               {
-                "type": "object",
-                "properties": {
-                  "tag": {
-                    "const": "Modifiable"
-                  },
-                  "initial_modification_level": {
-                    "description": "The initial skill modification identifier/level.",
-                    "type": "integer",
-                    "maximum": 6,
-                    "minimum": 1
-                  }
-                },
-                "required": [
-                  "tag",
-                  "initial_modification_level"
-                ],
-                "additionalProperties": false
+                "$ref": "#/definitions/CastingTime/ModifiableCastingTime"
               },
               {
                 "$ref": "#/definitions/CastingTime/FastSkillCastingTime"
@@ -387,23 +390,7 @@
             "description": "The default casting time definition.",
             "oneOf": [
               {
-                "type": "object",
-                "properties": {
-                  "tag": {
-                    "const": "Modifiable"
-                  },
-                  "initial_modification_level": {
-                    "description": "The initial skill modification identifier/level.",
-                    "type": "integer",
-                    "maximum": 6,
-                    "minimum": 1
-                  }
-                },
-                "required": [
-                  "tag",
-                  "initial_modification_level"
-                ],
-                "additionalProperties": false
+                "$ref": "#/definitions/CastingTime/ModifiableCastingTime"
               },
               {
                 "$ref": "#/definitions/CastingTime/SlowSkillCastingTime"
@@ -870,7 +857,7 @@
                 "type": "object",
                 "properties": {
                   "note": {
-                    "description": "A note, appended to the generated string in parenthesis.",
+                    "description": "A note, appended to the generated string in parenthesis. If the\ngenerated is modified using `replacement`, the note is appended to\nthe modifier string.",
                     "type": "object",
                     "properties": {
                       "default": {
@@ -888,11 +875,33 @@
                       "default"
                     ],
                     "additionalProperties": false
+                  },
+                  "replacement": {
+                    "description": "A replacement string. If `note` is provided, it is appended to the\nreplaced string.",
+                    "type": "object",
+                    "properties": {
+                      "default": {
+                        "description": "The full replacement string. It must contain `$1`, which is\ngoing to be replaced with the generated duration string, so\nadditional information can be provided without duplicating\nconcrete numeric values.",
+                        "type": "string",
+                        "minLength": 1,
+                        "pattern": "\\$1"
+                      },
+                      "compressed": {
+                        "description": "A compressed replacement string for use in small areas (e.g. on\ncharacter sheet). It must contain `$1`, which is going to be\nreplaced with the generated duration string, so additional\ninformation can be provided without duplicating concrete\nnumeric values.",
+                        "type": "string",
+                        "minLength": 1,
+                        "pattern": "\\$1"
+                      }
+                    },
+                    "required": [
+                      "default",
+                      "compressed"
+                    ],
+                    "additionalProperties": false
                   }
                 },
-                "required": [
-                  "note"
-                ],
+                "required": [],
+                "minProperties": 1,
                 "additionalProperties": false
               }
             },
@@ -1162,7 +1171,7 @@
                 "value": {
                   "description": "The (unitless) duration.",
                   "type": "integer",
-                  "minimum": 2
+                  "minimum": 1
                 },
                 "unit": {
                   "description": "The duration unit.",
@@ -1566,6 +1575,7 @@
           "Weeks",
           "Months",
           "Years",
+          "Centuries",
           "CombatRounds"
         ]
       },

package/schema/magicalActions/ElvenMagicalSong.schema.json

@@ -177,6 +177,43 @@
                 "value"
               ],
               "additionalProperties": false
+            },
+            "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": {
+                    "per": {
+                      "description": "The cost have to be per a specific countable entity, e.g. `8 AE\nper person`.",
+                      "type": "object",
+                      "properties": {
+                        "default": {
+                          "description": "The full countable entity name.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "compressed": {
+                          "description": "The compressed countable entity name.",
+                          "type": "string",
+                          "minLength": 1
+                        }
+                      },
+                      "required": [
+                        "default",
+                        "compressed"
+                      ],
+                      "additionalProperties": false
+                    }
+                  },
+                  "required": [],
+                  "minProperties": 1,
+                  "additionalProperties": false
+                }
+              },
+              "minProperties": 1,
+              "additionalProperties": false
             }
           },
           "required": [

package/schema/magicalActions/ZibiljaRitual.schema.json

@@ -22,7 +22,7 @@
         },
         "parameters": {
           "description": "Measurable parameters of a zibilja ritual.",
-          "$ref": "../_ActivatableSkill.schema.json#/definitions/SlowPerformanceParameters"
+          "$ref": "#/definitions/PerformanceParameters"
         },
         "target": {
           "description": "The target category – the kind of creature or object – the skill affects.",
@@ -154,6 +154,37 @@
         "translations"
       ],
       "additionalProperties": false
+    },
+    "PerformanceParameters": {
+      "type": "object",
+      "properties": {
+        "casting_time": {
+          "oneOf": [
+            {
+              "$ref": "../_ActivatableSkill.schema.json#/definitions/CastingTime/ModifiableCastingTime"
+            },
+            {
+              "$ref": "../_ActivatableSkill.schema.json#/definitions/CastingTime/SlowSkillCastingTime"
+            }
+          ]
+        },
+        "cost": {
+          "$ref": "../_ActivatableSkill.schema.json#/definitions/Cost/OneTime/T"
+        },
+        "range": {
+          "$ref": "../_ActivatableSkill.schema.json#/definitions/Range/T"
+        },
+        "duration": {
+          "$ref": "../_ActivatableSkill.schema.json#/definitions/Duration/OneTime/T"
+        }
+      },
+      "required": [
+        "casting_time",
+        "cost",
+        "range",
+        "duration"
+      ],
+      "additionalProperties": false
     }
   }
 }