optolith-database-schema 0.17.0 → 0.17.2

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 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.17.2](https://github.com/elyukai/optolith-database-schema/compare/v0.17.1...v0.17.2) (2024-10-06)
+
+### [0.17.1](https://github.com/elyukai/optolith-database-schema/compare/v0.17.0...v0.17.1) (2024-10-06)
+
+
+### Features
+
+* add minimum and maximum UI strings with placeholders ([1bf8df1](https://github.com/elyukai/optolith-database-schema/commit/1bf8df1575c605b50d2990ed5cd85892d871ecba))
+* add pluralization type definitions ([a8340e6](https://github.com/elyukai/optolith-database-schema/commit/a8340e6dd488945b63347a80de0f54f5eb5050e8))
+* use @optolith/helpers package ([d8324f7](https://github.com/elyukai/optolith-database-schema/commit/d8324f7042f459201452704bffa3c06e1ec582fe))
+
 ## [0.17.0](https://github.com/elyukai/optolith-database-schema/compare/v0.16.8...v0.17.0) (2024-10-03)
 
 

package/lib/cache/activatableSelectOptions.js

@@ -1,6 +1,6 @@
-import { isNotNullish } from "../helpers/nullable.js";
-import { mapObject } from "../helpers/object.js";
-import { assertExhaustive } from "../helpers/typeSafety.js";
+import { isNotNullish } from "@optolith/helpers/nullable";
+import { mapObject } from "@optolith/helpers/object";
+import { assertExhaustive } from "@optolith/helpers/typeSafety";
 const PRINCIPLES_ID = 31;
 const PROPERTY_KNOWLEDGE_ID = 3;
 const ASPECT_KNOWLEDGE_ID = 1;

package/lib/cache/magicalAndBlessedAdvantagesAndDisadvantages.js

@@ -1,4 +1,4 @@
-import { assertExhaustive } from "../helpers/typeSafety.js";
+import { assertExhaustive } from "@optolith/helpers/typeSafety";
 const BLESSED_ID = 12;
 const SPELLCASTER_ID = 47;
 const getAdvantageId = (type) => {

package/lib/errors.js

@@ -1,4 +1,4 @@
-import { filterNullable } from "./helpers/array.js";
+import { filterNonNullable } from "@optolith/helpers/array";
 import { collator } from "./helpers/i18n.js";
 /**
  * Pretty-prints an error map.
@@ -12,11 +12,11 @@ export const printErrors = (errorsByFile, printOptions = {}) => {
     return Object.entries(errorsByFile)
         .sort(([filePathA], [filePathB]) => collator.compare(filePathA, filePathB))
         .flatMap(verbose
-        ? ([filePath, errors]) => filterNullable(errors.map(printVerboseError(filePath)))
+        ? ([filePath, errors]) => filterNonNullable(errors.map(printVerboseError(filePath)))
         : ([filePath, errors]) => [
-            ...(errors
+            ...errors
                 .filter((error) => error.keyword === "integrity" || error.keyword === "filename")
-                .map(printVerboseError(filePath))),
+                .map(printVerboseError(filePath)),
             ...(errors.some(error => error.keyword !== "integrity" && error.keyword !== "filename")
                 ? [errorMessageBlock([filePath], "has schema errors")]
                 : []),
@@ -29,5 +29,5 @@ const printVerboseError = (filePath) => (error) => {
 };
 const errorMessageBlock = (path, message) => [
     ...path.map((segment, i) => `${" ".repeat(i * 2)}in "${segment}":`),
-    `${" ".repeat(path.length * 2)}${message}`
+    `${" ".repeat(path.length * 2)}${message}`,
 ].join("\n");

package/lib/helpers/array.d.ts

@@ -11,4 +11,4 @@ declare global {
         objectFromEntries<K extends string, T>(this: [key: K, value: T][]): Record<K, T>;
     }
 }
-export declare const filterNullable: <T>(arr: T[]) => NonNullable<T>[];
+export {};

package/lib/helpers/array.js

@@ -3,13 +3,13 @@ Object.defineProperty(Array.prototype, "promiseAll", {
     writable: true,
     value: function promiseAll() {
         return Promise.all(this);
-    }
+    },
 });
 Object.defineProperty(Array.prototype, "objectFromEntries", {
     configurable: true,
     writable: true,
     value: function objectFromEntries() {
         return Object.fromEntries(this);
-    }
+    },
 });
-export const filterNullable = (arr) => arr.filter((x) => x != null);
+export {};

package/lib/rendering/UI.d.ts

@@ -0,0 +1,14 @@
+import { PluralizationCategories } from "../types/_I18n.js";
+import { UI } from "../types/UI.js";
+declare const pluralType: {
+    [K in keyof UI as UI[K] extends PluralizationCategories ? K : never]: Intl.PluralRuleType;
+};
+/**
+ * The keys of the UI strings that support pluralization categories.
+ */
+export type KeySupportingPluralizationCategories = keyof typeof pluralType;
+/**
+ * Returns the plural rule type for the given key.
+ */
+export declare const getPluralRuleTypeForKey: (key: KeySupportingPluralizationCategories) => Intl.PluralRuleType;
+export {};

package/lib/rendering/UI.js

@@ -0,0 +1,28 @@
+const pluralType = {
+    "{0} Adventure Points": "cardinal",
+    "You are missing {0} Adventure Points to do this.": "cardinal",
+    "since the {0}. printing": "ordinal",
+    "removed in {0}. printing": "ordinal",
+    "{0} actions": "cardinal",
+    "{0} hours": "cardinal",
+    "{0} minutes": "cardinal",
+    "{0} rounds": "cardinal",
+    "{0} seduction actions": "cardinal",
+    ", {0} of which are permanent": "cardinal",
+    "{0} centuries": "cardinal",
+    "{0} combat rounds": "cardinal",
+    "{0} days": "cardinal",
+    "{0} months": "cardinal",
+    "{0} mos.": "cardinal",
+    "{0} seconds": "cardinal",
+    "{0} weeks": "cardinal",
+    "{0} wks.": "cardinal",
+    "{0} years": "cardinal",
+    "{0} yrs.": "cardinal",
+    "{0} miles": "cardinal",
+    "{0} yards": "cardinal",
+};
+/**
+ * Returns the plural rule type for the given key.
+ */
+export const getPluralRuleTypeForKey = (key) => pluralType[key];

package/lib/types/UI.d.ts

@@ -968,6 +968,8 @@ export type UI = {
     "{0} KP": NonEmptyString;
     "min. ": NonEmptyString;
     "at least ": NonEmptyString;
+    "min. {0}": NonEmptyString;
+    "at least {0}": NonEmptyString;
     "/{0}": NonEmptyString;
     " per {0}": NonEmptyString;
     ", minimum of {0}": NonEmptyString;
@@ -981,6 +983,8 @@ export type UI = {
     " for ": NonEmptyString;
     " (no more than {0})": NonEmptyString;
     " (max. {0})": NonEmptyString;
+    "no more than {0}": NonEmptyString;
+    "max. {0}": NonEmptyString;
     "Immediate": NonEmptyString;
     "Permanent": NonEmptyString;
     "no more than ": NonEmptyString;

package/lib/validation/schema.js

@@ -1,9 +1,9 @@
+import { assertExhaustive } from "@optolith/helpers/typeSafety";
 import addFormatsModule from "ajv-formats";
 import Ajv2019Module from "ajv/dist/2019.js";
 import Ajv2020Module from "ajv/dist/2020.js";
 import "../helpers/array.js";
 import { isHiddenFileName, readDirectoryRec, readJsonFile } from "../helpers/io.js";
-import { assertExhaustive } from "../helpers/typeSafety.js";
 const Ajv2019 = Ajv2019Module.default;
 const Ajv2020 = Ajv2020Module.default;
 const addFormats = addFormatsModule.default;
@@ -15,7 +15,7 @@ const createSchemaValidator = (jsonSchemaSpec, validatorOptions = {}) => {
         case "Draft_2020_12":
             return new Ajv2020(validatorOptions);
         default:
-            assertExhaustive(jsonSchemaSpec);
+            return assertExhaustive(jsonSchemaSpec);
     }
 };
 const registerAllJsonSchemaDocuments = async (jsonSchemaDir, validator) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.17.0",
+  "version": "0.17.2",
   "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 @@
     "./errors": "./lib/errors.js",
     "./cache/*": "./lib/cache/*.js",
     "./config/*": "./lib/config/*.js",
+    "./rendering/*": "./lib/rendering/*.js",
     "./types/*": "./lib/types/*.js"
   },
   "scripts": {
@@ -28,6 +29,7 @@
   "author": "Lukas Obermann",
   "license": "MPL-2.0",
   "dependencies": {
+    "@optolith/helpers": "^0.2.1",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "yaml": "^2.3.3"

package/schema/UI.schema.json

@@ -2446,6 +2446,12 @@
         "at least ": {
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
+        "min. {0}": {
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "at least {0}": {
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
         "/{0}": {
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
@@ -2485,6 +2491,12 @@
         " (max. {0})": {
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
+        "no more than {0}": {
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "max. {0}": {
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
         "Immediate": {
           "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
         },
@@ -3921,6 +3933,8 @@
         "{0} KP",
         "min. ",
         "at least ",
+        "min. {0}",
+        "at least {0}",
         "/{0}",
         " per {0}",
         ", minimum of {0}",
@@ -3934,6 +3948,8 @@
         " for ",
         " (no more than {0})",
         " (max. {0})",
+        "no more than {0}",
+        "max. {0}",
         "Immediate",
         "Permanent",
         "no more than ",

package/lib/helpers/nullable.d.ts

@@ -1,35 +0,0 @@
-/**
- * Extracts `null` and `undefined` from a type.
- */
-export type Nullish<T = null | undefined> = T extends null | undefined ? T : never;
-/**
- * Checks if a value is `null` or `undefined`.
- */
-export declare const isNullish: <T>(value: T) => value is Exclude<T, NonNullable<T>>;
-/**
- * Checks if a value is not `null` or `undefined`.
- */
-export declare const isNotNullish: <T>(value: T) => value is NonNullable<T>;
-/**
- * Maps a value to another value if it is not `null` or `undefined`.
- */
-export declare const mapNullable: <T, U>(value: T, map: (value: NonNullable<T>) => U) => U | Nullish<T>;
-/**
- * Maps a value to another value if it is not `null` or `undefined`, otherwise
- * returns a default value.
- */
-export declare const mapNullableDefault: <T, U>(value: T, map: (value: NonNullable<T>) => U, defaultValue: U) => U;
-/**
- * Returns an array, containing the value if it is not `null` or `undefined`.
- *
- * This can be useful in combination with the spread operator or
- * `Array.prototype.flatMap`.
- * @example
- * nullableToArray(2) // [2]
- * nullableToArray(undefined) // []
- *
- * [...nullableToArray(2)] // [2]
- * [1, ...nullableToArray(2)] // [1, 2]
- * [1, ...nullableToArray(undefined)] // [1]
- */
-export declare const nullableToArray: <T>(value: T) => NonNullable<T>[];

package/lib/helpers/nullable.js

@@ -1,31 +0,0 @@
-/**
- * Checks if a value is `null` or `undefined`.
- */
-export const isNullish = (value) => value === null || value === undefined;
-/**
- * Checks if a value is not `null` or `undefined`.
- */
-export const isNotNullish = (value) => !isNullish(value);
-/**
- * Maps a value to another value if it is not `null` or `undefined`.
- */
-export const mapNullable = (value, map) => isNotNullish(value) ? map(value) : value;
-/**
- * Maps a value to another value if it is not `null` or `undefined`, otherwise
- * returns a default value.
- */
-export const mapNullableDefault = (value, map, defaultValue) => (isNotNullish(value) ? map(value) : defaultValue);
-/**
- * Returns an array, containing the value if it is not `null` or `undefined`.
- *
- * This can be useful in combination with the spread operator or
- * `Array.prototype.flatMap`.
- * @example
- * nullableToArray(2) // [2]
- * nullableToArray(undefined) // []
- *
- * [...nullableToArray(2)] // [2]
- * [1, ...nullableToArray(2)] // [1, 2]
- * [1, ...nullableToArray(undefined)] // [1]
- */
-export const nullableToArray = (value) => isNotNullish(value) ? [value] : [];

package/lib/helpers/nullable.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/helpers/nullable.test.js

@@ -1,46 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { isNotNullish, isNullish, mapNullable, mapNullableDefault, nullableToArray, } from "./nullable.js";
-describe("isNullish", () => {
-    it("returns if a value is nullish", () => {
-        assert.equal(isNullish(null), true);
-        assert.equal(isNullish(undefined), true);
-        assert.equal(isNullish(false), false);
-        assert.equal(isNullish(0), false);
-        assert.equal(isNullish(""), false);
-    });
-});
-describe("isNotNullish", () => {
-    it("returns if a value is not nullish", () => {
-        assert.equal(isNotNullish(null), false);
-        assert.equal(isNotNullish(undefined), false);
-        assert.equal(isNotNullish(false), true);
-        assert.equal(isNotNullish(0), true);
-        assert.equal(isNotNullish(""), true);
-    });
-});
-describe("mapNullable", () => {
-    it("maps a value if it is not nullish", () => {
-        assert.equal(mapNullable(2, x => x * 2), 4);
-    });
-    it("returns the original value if it is nullish", () => {
-        assert.equal(mapNullable(undefined, x => x * 2), undefined);
-    });
-});
-describe("mapNullableDefault", () => {
-    it("maps a value if it is not nullish", () => {
-        assert.equal(mapNullableDefault(2, x => x * 2, 0), 4);
-    });
-    it("returns a default if the value is nullish", () => {
-        assert.equal(mapNullableDefault(undefined, x => x * 2, 0), 0);
-    });
-});
-describe("nullableToArray", () => {
-    it("wraps a non-nullish value into an array", () => {
-        assert.deepEqual(nullableToArray(2), [2]);
-    });
-    it("returns an empty array if the value is null or undefined", () => {
-        assert.deepEqual(nullableToArray(undefined), []);
-        assert.deepEqual(nullableToArray(null), []);
-    });
-});

package/lib/helpers/object.d.ts

@@ -1,5 +0,0 @@
-/**
- * Maps all own properties of an object to a new object. Returning `undefined`
- * from the mapping function will omit the property from the result.
- */
-export declare const mapObject: <T extends object, U>(object: T, map: (value: T[keyof T], key: keyof T) => U | undefined) => { [key in keyof T]: Exclude<U, undefined>; };

package/lib/helpers/object.js

@@ -1,16 +0,0 @@
-/**
- * Maps all own properties of an object to a new object. Returning `undefined`
- * from the mapping function will omit the property from the result.
- */
-export const mapObject = (object, map) => {
-    const result = {};
-    for (const key in object) {
-        if (Object.hasOwn(object, key)) {
-            const newValue = map(object[key], key);
-            if (newValue !== undefined) {
-                result[key] = newValue;
-            }
-        }
-    }
-    return result;
-};

package/lib/helpers/object.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/helpers/object.test.js

@@ -1,15 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { mapObject } from "./object.js";
-describe("mapObject", () => {
-    it("maps all own properties of an object to a new object", () => {
-        const object = { a: 1, b: 2, c: 3 };
-        const result = mapObject(object, (value, key) => value + key);
-        assert.deepEqual(result, { a: "1a", b: "2b", c: "3c" });
-    });
-    it("omits properties for which the mapping function returns undefined", () => {
-        const object = { a: 1, b: 2, c: 3 };
-        const result = mapObject(object, (value, key) => (key === "b" ? undefined : value + key));
-        assert.deepEqual(result, { a: "1a", c: "3c" });
-    });
-});

package/lib/helpers/typeSafety.d.ts

@@ -1,14 +0,0 @@
-/**
- * This function is used to make sure that the `switch` is exhaustive. Place it
- * in the `default` case of the `switch`.
- * @param _x - The value that is used in the `switch`.
- * @example
- * const aorb = (x: "a" | "b") => {
- *   switch (x) {
- *     case "a": return 1
- *     case "b": return 2
- *     default: return assertExhaustive(x)
- *   }
- * }
- */
-export declare function assertExhaustive(_x: never): never;

package/lib/helpers/typeSafety.js

@@ -1,16 +0,0 @@
-/**
- * This function is used to make sure that the `switch` is exhaustive. Place it
- * in the `default` case of the `switch`.
- * @param _x - The value that is used in the `switch`.
- * @example
- * const aorb = (x: "a" | "b") => {
- *   switch (x) {
- *     case "a": return 1
- *     case "b": return 2
- *     default: return assertExhaustive(x)
- *   }
- * }
- */
-export function assertExhaustive(_x) {
-    throw new Error("The switch is not exhaustive.");
-}

package/lib/helpers/typeSafety.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/helpers/typeSafety.test.js

@@ -1,10 +0,0 @@
-import assert from "node:assert/strict";
-import { describe, it } from "node:test";
-import { assertExhaustive } from "./typeSafety.js";
-describe("assertExhaustive", () => {
-    it("should throw an error with the message 'The switch is not exhaustive.'", () => {
-        assert.throws(
-        // @ts-expect-error The function should never receive a value.
-        () => assertExhaustive(""), err => err instanceof Error && err.message === "The switch is not exhaustive.");
-    });
-});