@tstdl/base 0.83.17 → 0.83.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.83.17",
+  "version": "0.83.18",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -21,12 +21,12 @@
     "luxon": "^3.3",
     "reflect-metadata": "^0.1",
     "rxjs": "^7.8",
-    "type-fest": "^3.7"
+    "type-fest": "^3.8"
   },
   "devDependencies": {
     "@types/chroma-js": "2.4",
     "@types/koa__router": "12.0",
-    "@types/luxon": "3.2",
+    "@types/luxon": "3.3",
     "@types/minio": "7.0",
     "@types/mjml": "4.7",
     "@types/node": "18",
@@ -35,7 +35,7 @@
     "@typescript-eslint/parser": "5.57",
     "concurrently": "8.0",
     "esbuild": "0.17",
-    "eslint": "8.37",
+    "eslint": "8.38",
     "eslint-import-resolver-typescript": "3.5",
     "eslint-plugin-import": "2.27",
     "tsc-alias": "1.8",
@@ -55,8 +55,8 @@
     "knex": "^2.4",
     "koa": "^2.14",
     "minio": "^7.0",
-    "mjml": "^4.13",
-    "mongodb": "5.1",
+    "mjml": "^4.14",
+    "mongodb": "5.2",
     "nodemailer": "^6.9",
     "preact": "^10.13",
     "preact-render-to-string": "^5.2",

package/random/index.d.ts

@@ -1 +1,2 @@
-export * from './number/index.js';
+export * from './number-generator/index.js';
+export * from './series.js';

package/random/index.js

@@ -15,4 +15,5 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var random_exports = {};
 module.exports = __toCommonJS(random_exports);
-__reExport(random_exports, require("./number/index.js"), module.exports);
+__reExport(random_exports, require("./number-generator/index.js"), module.exports);
+__reExport(random_exports, require("./series.js"), module.exports);

package/random/{number → number-generator}/index.d.ts

@@ -1,3 +1,3 @@
 export * from './mulberry32.js';
-export * from './seeded.js';
+export * from './seeded-random-number-generator.js';
 export * from './sfc32.js';

package/random/{number → number-generator}/index.js

@@ -13,8 +13,8 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var number_exports = {};
-module.exports = __toCommonJS(number_exports);
-__reExport(number_exports, require("./mulberry32.js"), module.exports);
-__reExport(number_exports, require("./seeded.js"), module.exports);
-__reExport(number_exports, require("./sfc32.js"), module.exports);
+var number_generator_exports = {};
+module.exports = __toCommonJS(number_generator_exports);
+__reExport(number_generator_exports, require("./mulberry32.js"), module.exports);
+__reExport(number_generator_exports, require("./seeded-random-number-generator.js"), module.exports);
+__reExport(number_generator_exports, require("./sfc32.js"), module.exports);

package/random/{number → number-generator}/mulberry32.d.ts

@@ -1,4 +1,4 @@
-import { SeededRandomNumberGenerator } from './seeded.js';
+import { SeededRandomNumberGenerator } from './seeded-random-number-generator.js';
 export declare class Mulberry32 extends SeededRandomNumberGenerator {
     private state;
     constructor(seed: number);
@@ -10,7 +10,7 @@ export declare class Mulberry32 extends SeededRandomNumberGenerator {
 /**
  * mulberry32
  *
- * very fast 32 bit random number generator with 32 bit state
+ * Very fast 32 bit random number generator with 32 bit state
  * @param seed 32 bit integer seed
  */
-export declare function mulberry32(seed: number): SeededRandomNumberGenerator;
+export declare function mulberry32(seed?: number): SeededRandomNumberGenerator;

package/random/{number → number-generator}/mulberry32.js

@@ -22,10 +22,11 @@ __export(mulberry32_exports, {
   mulberry32: () => mulberry32
 });
 module.exports = __toCommonJS(mulberry32_exports);
-var import_seeded = require("./seeded.js");
+var import_seeded_random_number_generator = require("./seeded-random-number-generator.js");
+var import_utils = require("./utils.js");
 const maxValue = 2 ** 32 - 1;
 const nextDivisor = 2 ** 32;
-class Mulberry32 extends import_seeded.SeededRandomNumberGenerator {
+class Mulberry32 extends import_seeded_random_number_generator.SeededRandomNumberGenerator {
   state;
   constructor(seed) {
     super(maxValue);
@@ -48,6 +49,6 @@ class Mulberry32 extends import_seeded.SeededRandomNumberGenerator {
     return new Mulberry32(this.state);
   }
 }
-function mulberry32(seed) {
+function mulberry32(seed = (0, import_utils.random32BitSeed)()) {
   return new Mulberry32(seed);
 }

package/random/number-generator/random-number-generator-function.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generates a random value in interval [0, 1).
+ */
+export type RandomNumberGeneratorFn = () => number;
+export declare const defaultRandomNumberGeneratorFn: RandomNumberGeneratorFn;

package/random/number-generator/random-number-generator-function.js

@@ -0,0 +1,24 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var random_number_generator_function_exports = {};
+__export(random_number_generator_function_exports, {
+  defaultRandomNumberGeneratorFn: () => defaultRandomNumberGeneratorFn
+});
+module.exports = __toCommonJS(random_number_generator_function_exports);
+const defaultRandomNumberGeneratorFn = Math.random;

package/random/number-generator/random-number-generator.d.ts

@@ -0,0 +1,15 @@
+export declare abstract class RandomNumberGenerator {
+    /**
+     * Maximum value the generator will generate for {@link nextInt}
+     */
+    readonly maxValue: number;
+    constructor(maxValue: number);
+    /**
+     * Generate a random integer between 0 and {@link maxValue}
+     */
+    abstract nextInt(): number;
+    /**
+     * Generate a random float in interval [0, 1)
+     */
+    abstract next(): number;
+}

package/random/{number/seeded.js → number-generator/random-number-generator.js}

@@ -16,14 +16,14 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var seeded_exports = {};
-__export(seeded_exports, {
-  SeededRandomNumberGenerator: () => SeededRandomNumberGenerator
+var random_number_generator_exports = {};
+__export(random_number_generator_exports, {
+  RandomNumberGenerator: () => RandomNumberGenerator
 });
-module.exports = __toCommonJS(seeded_exports);
-class SeededRandomNumberGenerator {
+module.exports = __toCommonJS(random_number_generator_exports);
+class RandomNumberGenerator {
   /**
-   * maximum value the generator will generate for {@link nextInt}
+   * Maximum value the generator will generate for {@link nextInt}
    */
   maxValue;
   constructor(maxValue) {

package/random/number-generator/seeded-random-number-generator.d.ts

@@ -0,0 +1,12 @@
+import { RandomNumberGenerator } from './random-number-generator.js';
+export declare abstract class SeededRandomNumberGenerator extends RandomNumberGenerator {
+    constructor(maxValue: number);
+    /**
+     * Fork the rng based on the current state
+     */
+    abstract fork(): SeededRandomNumberGenerator;
+    /**
+     * Clone the rng with the current state
+     */
+    abstract clone(): SeededRandomNumberGenerator;
+}

package/random/number-generator/seeded-random-number-generator.js

@@ -0,0 +1,29 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var seeded_random_number_generator_exports = {};
+__export(seeded_random_number_generator_exports, {
+  SeededRandomNumberGenerator: () => SeededRandomNumberGenerator
+});
+module.exports = __toCommonJS(seeded_random_number_generator_exports);
+var import_random_number_generator = require("./random-number-generator.js");
+class SeededRandomNumberGenerator extends import_random_number_generator.RandomNumberGenerator {
+  constructor(maxValue) {
+    super(maxValue);
+  }
+}

package/random/{number → number-generator}/sfc32.d.ts

@@ -1,4 +1,4 @@
-import { SeededRandomNumberGenerator } from './seeded.js';
+import { SeededRandomNumberGenerator } from './seeded-random-number-generator.js';
 export declare class Sfc32 extends SeededRandomNumberGenerator {
     private state1;
     private state2;
@@ -13,7 +13,11 @@ export declare class Sfc32 extends SeededRandomNumberGenerator {
 /**
  * sfc32 - Small Fast Counter
  *
- * fast 32 bit random number generator with 128 bit state
- * @param seed 32 bit integer seed
+ * Fast 32 bit random number generator with 128 bit state
+ * @param seed1 32 bit integer seed 1
+ * @param seed2 32 bit integer seed 2
+ * @param seed3 32 bit integer seed 3
+ * @param seed4 32 bit integer seed 4
  */
+export declare function sfc32(): SeededRandomNumberGenerator;
 export declare function sfc32(seed1: number, seed2: number, seed3: number, seed4: number): SeededRandomNumberGenerator;

package/random/{number → number-generator}/sfc32.js

@@ -22,10 +22,11 @@ __export(sfc32_exports, {
   sfc32: () => sfc32
 });
 module.exports = __toCommonJS(sfc32_exports);
-var import_seeded = require("./seeded.js");
+var import_seeded_random_number_generator = require("./seeded-random-number-generator.js");
+var import_utils = require("./utils.js");
 const maxValue = 2 ** 32 - 1;
 const nextDivisor = 2 ** 32;
-class Sfc32 extends import_seeded.SeededRandomNumberGenerator {
+class Sfc32 extends import_seeded_random_number_generator.SeededRandomNumberGenerator {
   state1;
   state2;
   state3;
@@ -61,6 +62,6 @@ class Sfc32 extends import_seeded.SeededRandomNumberGenerator {
     return new Sfc32(this.state1, this.state2, this.state3, this.state4);
   }
 }
-function sfc32(seed1, seed2, seed3, seed4) {
+function sfc32(seed1 = (0, import_utils.random32BitSeed)(), seed2 = (0, import_utils.random32BitSeed)(), seed3 = (0, import_utils.random32BitSeed)(), seed4 = (0, import_utils.random32BitSeed)()) {
   return new Sfc32(seed1, seed2, seed3, seed4);
 }

package/random/number-generator/utils.d.ts

@@ -0,0 +1 @@
+export declare function random32BitSeed(): number;

package/random/number-generator/utils.js

@@ -0,0 +1,26 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var utils_exports = {};
+__export(utils_exports, {
+  random32BitSeed: () => random32BitSeed
+});
+module.exports = __toCommonJS(utils_exports);
+function random32BitSeed() {
+  return Math.floor(Math.random() * 2 ** 32);
+}

package/random/series.d.ts

@@ -0,0 +1,52 @@
+import type { RandomNumberGeneratorFn } from './number-generator/random-number-generator-function.js';
+export type RandomSeriesOptions = {
+    /**
+     * Initial value of series. If [number, number] is provided, a random value in that range is generated. If not provided but {@link RandomSeriesOptions.bounds} are, their values are used.
+     */
+    initial?: number | [min: number, max: number];
+    /**
+     * Bounds for generated values. If provided, a regression toward the mean is used.
+     * If {@link RandomSeriesOptions.volatility} is to high, bounds may be exceeded.
+     */
+    bounds?: [lower: number, upper: number];
+    /**
+     * Exponent to use for regression toward the mean (if bounds are provided). Practical values are in the interval [0.5, 15], depending on {@link RandomSeriesOptions.volatility}.
+     * High values have (nearly) no regression inside the most part of the {@link RandomSeriesOptions.bounds}, with exponentially higher regression towards the bounds.
+     * Value of 1 has a linear "strength" of regression the further it is from the mean of the bounds.
+     * Values < 1 already have a strong regression around the mean with only logarithmically stronger regression toward the edges. This results in the value staying close at the mean.
+     */
+    regressionExponent?: number;
+    /**
+     * Relative volatility of the series (ratio of value). Practical values are in the interval (0, 0.25), depending on {@link RandomSeriesOptions.regressionExponent}.
+     * You can also provide an Iterator of numbers to represent volatile/dynamic volatility. Passes current value as parameter for {@link Iterator.next}.
+     */
+    volatility?: number | Iterator<number, any, any>;
+    /**
+     * Whether volatility is relative to current value or initial value.
+     */
+    relativeTo?: 'current' | 'initial';
+    /**
+     * Random number generator to use (useful if seeded generator is used to generate static series for each run).
+     */
+    generator?: RandomNumberGeneratorFn;
+};
+/**
+ * Generator to create random series data like stock charts or measurements over time.
+ *
+ * @example
+ *
+ * // very simple: series starting at 1 without bounds
+ * randomSeries();
+ *
+ * // bounded: series between 100 and 200
+ * randomSeries({ bounds: [100, 200] });
+ *
+ * // complex: series between 5 and 50 with dynamic volatility like a stock chart
+ * randomSeries({
+ *   bounds: [5, 50],
+ *   volatility: randomSeries({ bounds: [0.01, 0.2], volatility: 0.2, regressionExponent: 2 }),
+ *   relativeTo: 'current',
+ *   regressionExponent: 8
+ * });
+ */
+export declare function randomSeries({ bounds, initial, volatility, relativeTo, generator, regressionExponent }?: RandomSeriesOptions): Generator<number>;

package/random/series.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var series_exports = {};
+__export(series_exports, {
+  randomSeries: () => randomSeries
+});
+module.exports = __toCommonJS(series_exports);
+var import_math = require("../utils/math.js");
+var import_type_guards = require("../utils/type-guards.js");
+var import_random_number_generator_function = require("./number-generator/random-number-generator-function.js");
+function* randomSeries({ bounds, initial = bounds ?? 1, volatility = 0.025, relativeTo = "initial", generator = import_random_number_generator_function.defaultRandomNumberGeneratorFn, regressionExponent = 10 } = {}) {
+  const initialValue = (0, import_type_guards.isNumber)(initial) ? initial : (0, import_math.randomInt)(initial[0], initial[1]);
+  const isRelativeToCurrent = relativeTo == "current";
+  const hasBounds = (0, import_type_guards.isDefined)(bounds);
+  const min = hasBounds ? bounds[0] : void 0;
+  const max = hasBounds ? bounds[1] : void 0;
+  const volatilityProvider = (0, import_type_guards.isNumber)(volatility) ? () => volatility : (value2) => volatility.next(value2).value;
+  let value = initialValue;
+  while (true) {
+    const currentVolatility = volatilityProvider(value);
+    let changePercent = currentVolatility * ((0.5 - generator()) * 2);
+    if (hasBounds) {
+      const normalizedDeltaFromMean = (0, import_math.linearInterpolate)(value, min, max, -1, 1);
+      const regressFactor = (0, import_math.clamp)(Math.abs(normalizedDeltaFromMean) ** regressionExponent * Math.sign(normalizedDeltaFromMean), -1.5, 1.5);
+      changePercent -= currentVolatility * regressFactor;
+    }
+    yield value += isRelativeToCurrent ? value * changePercent : initialValue * changePercent;
+  }
+}

package/utils/math.d.ts

@@ -1,7 +1,4 @@
-/**
- * Generates a random value in interval [0, 1).
- */
-export type RandomNumberGenerator = () => number;
+import type { RandomNumberGeneratorFn } from '../random/number-generator/random-number-generator-function.js';
 /**
  * Generate a random float in interval [min, max).
  * @param min minimum value
@@ -9,7 +6,7 @@ export type RandomNumberGenerator = () => number;
  * @param generator Random number generator to use, defaults to `Math.random`. Must return a number in interval [0, 1).
  * @returns random number (float)
  */
-export declare function randomFloat(min: number, max: number, generator?: RandomNumberGenerator): number;
+export declare function randomFloat(min: number, max: number, generator?: RandomNumberGeneratorFn): number;
 /**
  * Generate a random integer in interval [min, max].
  * @param min minimum value
@@ -17,7 +14,7 @@ export declare function randomFloat(min: number, max: number, generator?: Random
  * @param generator random number generator to use, defaults to `Math.random`. Must return a number in interval [0, 1)
  * @returns random number (integer)
  */
-export declare function randomInt(min: number, max: number, generator?: RandomNumberGenerator): number;
+export declare function randomInt(min: number, max: number, generator?: RandomNumberGeneratorFn): number;
 /**
  * Calculate the sum of all values.
  * @param values values to sum

package/utils/math.js

@@ -32,11 +32,11 @@ __export(math_exports, {
 });
 module.exports = __toCommonJS(math_exports);
 var import_not_supported_error = require("../error/not-supported.error.js");
-const defaultRandomNumberGenerator = () => Math.random();
-function randomFloat(min, max, generator = defaultRandomNumberGenerator) {
+var import_random_number_generator_function = require("../random/number-generator/random-number-generator-function.js");
+function randomFloat(min, max, generator = import_random_number_generator_function.defaultRandomNumberGeneratorFn) {
   return linearInterpolateFloat(generator(), min, max);
 }
-function randomInt(min, max, generator = defaultRandomNumberGenerator) {
+function randomInt(min, max, generator = import_random_number_generator_function.defaultRandomNumberGeneratorFn) {
   return Math.floor(linearInterpolateFloat(generator(), min, max + 1));
 }
 function sum(values) {

package/random/number/seeded.d.ts

@@ -1,24 +0,0 @@
-export declare abstract class SeededRandomNumberGenerator {
-    /**
-     * maximum value the generator will generate for {@link nextInt}
-     */
-    readonly maxValue: number;
-    constructor(maxValue: number);
-    /**
-     * generate a random integer between 0 and {@link maxValue}
-     * @see maxValue
-     */
-    abstract nextInt(): number;
-    /**
-     * generate a random float in interval [0, 1)
-     */
-    abstract next(): number;
-    /**
-     * fork the rng based on the current state
-     */
-    abstract fork(): SeededRandomNumberGenerator;
-    /**
-     * clone the rng with the current state
-     */
-    abstract clone(): SeededRandomNumberGenerator;
-}