@sv443-network/userutils 9.2.1 → 9.4.0

package/dist/lib/Mixins.d.ts

@@ -0,0 +1,127 @@
+/**
+ * @module lib/Mixins  
+ * Allows for defining and applying mixin functions to allow multiple sources to modify a value in a controlled way.  
+ */
+import type { Prettify } from "./types.js";
+/** Full mixin object (either sync or async), as it is stored in the instance's mixin array. */
+export type MixinObj<TArg, TCtx> = Prettify<MixinObjSync<TArg, TCtx> | MixinObjAsync<TArg, TCtx>>;
+/** Asynchronous mixin object, as it is stored in the instance's mixin array. */
+export type MixinObjSync<TArg, TCtx> = Prettify<{
+    /** The mixin function */
+    fn: (arg: TArg, ctx?: TCtx) => TArg;
+} & MixinObjBase>;
+/** Synchronous mixin object, as it is stored in the instance's mixin array. */
+export type MixinObjAsync<TArg, TCtx> = Prettify<{
+    /** The mixin function */
+    fn: (arg: TArg, ctx?: TCtx) => TArg | Promise<TArg>;
+} & MixinObjBase>;
+/** Base type for mixin objects */
+type MixinObjBase = Prettify<{
+    /** The public identifier key (purpose) of the mixin */
+    key: string;
+} & MixinConfig>;
+/** Configuration object for a mixin function */
+export type MixinConfig = {
+    /** The higher, the earlier the mixin will be applied. Supports floating-point and negative numbers too. 0 by default. */
+    priority: number;
+    /** If true, no further mixins will be applied after this one. */
+    stopPropagation: boolean;
+    /** If set, the mixin will only be applied if the given signal is not aborted. */
+    signal?: AbortSignal;
+};
+/** Configuration object for the Mixins class */
+export type MixinsConstructorConfig = {
+    /**
+     * If true, when no priority is specified, an auto-incrementing integer priority will be used, starting at `defaultPriority` or 0 (unique per mixin key). Defaults to false.  
+     * If a priority value is already used, it will be incremented until a unique value is found.  
+     * This is useful to ensure that mixins are applied in the order they were added, even if they don't specify a priority.  
+     * It also allows for a finer level of interjection when the priority is a floating point number.  
+     */
+    autoIncrementPriority: boolean;
+    /** The default priority for mixins that do not specify one. Defaults to 0. */
+    defaultPriority: number;
+    /** The default stopPropagation value for mixins that do not specify one. Defaults to false. */
+    defaultStopPropagation: boolean;
+    /** The default AbortSignal for mixins that do not specify one. Defaults to undefined. */
+    defaultSignal?: AbortSignal;
+};
+/**
+ * The mixin class allows for defining and applying mixin functions to allow multiple sources to modify values in a controlled way.  
+ * Mixins are identified via their string key and can be added with {@linkcode add()}  
+ * When calling {@linkcode resolve()}, all registered mixin functions with the same key will be applied to the input value in the order of their priority.  
+ * If a mixin has the stopPropagation flag set to true, no further mixins will be applied after it.  
+ * @template TMixinMap A map of mixin keys to their respective function signatures. The first argument of the function is the input value, the second argument is an optional context object. If it is defined here, it must be passed as the third argument in {@linkcode resolve()}.  
+ * @example ```ts  
+ * const ac = new AbortController();  
+ * const { abort: removeAllMixins } = ac;  
+ *  
+ * const mathMixins = new Mixins<{  
+ *   // supports sync and async functions:  
+ *   foo: (val: number, ctx: { baz: string }) => Promise<number>;  
+ *   // first argument and return value have to be of the same type:  
+ *   bar: (val: bigint) => bigint;  
+ *   // ...  
+ * }>({  
+ *   autoIncrementPriority: true,  
+ *   defaultPriority: 0,  
+ *   defaultSignal: ac.signal,  
+ * });  
+ *  
+ * // will be applied last due to base priority of 0:  
+ * mathMixins.add("foo", (val, ctx) => Promise.resolve(val * 2 + ctx.baz.length));  
+ * // will be applied second due to manually set priority of 1:  
+ * mathMixins.add("foo", (val) => val + 1, { priority: 1 });  
+ * // will be applied first, even though the above ones were called first, because of the auto-incrementing priority of 2:  
+ * mathMixins.add("foo", (val) => val / 2);  
+ *  
+ * const result = await mathMixins.resolve("foo", 10, { baz: "this has a length of 23" });  
+ * // order of application:  
+ * // input value: 10  
+ * // 10 / 2 = 5  
+ * // 5 + 1 = 6  
+ * // 6 * 2 + 23 = 35  
+ * // result = 35  
+ *  
+ * // removes all mixins added without a `signal` property:  
+ * removeAllMixins();  
+ * ```  
+ */
+export declare class Mixins<TMixinMap extends Record<string, (arg: any, ctx?: any) => any>, TMixinKey extends Extract<keyof TMixinMap, string> = Extract<keyof TMixinMap, string>> {
+    /** List of all registered mixins */
+    protected mixins: MixinObj<any, any>[];
+    /** Default configuration object for mixins */
+    protected readonly defaultMixinCfg: MixinConfig;
+    /** Whether the priorities should auto-increment if not specified */
+    protected readonly autoIncPrioEnabled: boolean;
+    /** The current auto-increment priority counter */
+    protected autoIncPrioCounter: Map<TMixinKey, number>;
+    /**
+     * Creates a new Mixins instance.  
+     * @param config Configuration object to customize the behavior.  
+     */
+    constructor(config?: Partial<MixinsConstructorConfig>);
+    /**
+     * Adds a mixin function to the given {@linkcode mixinKey}.  
+     * If no priority is specified, it will be calculated via the protected method {@linkcode calcPriority()} based on the constructor configuration, or fall back to the default priority.  
+     * @param mixinKey The key to identify the mixin function.  
+     * @param mixinFn The function to be called to apply the mixin. The first argument is the input value, the second argument is the context object (if any).  
+     * @param config Configuration object to customize the mixin behavior, or just the priority if a number is passed.  
+     * @returns Returns a cleanup function, to be called when this mixin is no longer needed.  
+     */
+    add<TKey extends TMixinKey, TArg extends Parameters<TMixinMap[TKey]>[0], TCtx extends Parameters<TMixinMap[TKey]>[1]>(mixinKey: TKey, mixinFn: (arg: TArg, ...ctx: TCtx extends undefined ? [void] : [TCtx]) => ReturnType<TMixinMap[TKey]> extends Promise<any> ? ReturnType<TMixinMap[TKey]> | Awaited<ReturnType<TMixinMap[TKey]>> : ReturnType<TMixinMap[TKey]>, config?: Partial<MixinConfig> | number): () => void;
+    /** Returns a list of all added mixins with their keys and configuration objects, but not their functions */
+    list(): ({
+        key: string;
+    } & MixinConfig)[];
+    /**
+     * Applies all mixins with the given key to the input value, respecting the priority and stopPropagation settings.  
+     * If additional context is set in the MixinMap, it will need to be passed as the third argument.  
+     * @returns The modified value after all mixins have been applied.  
+     */
+    resolve<TKey extends TMixinKey, TArg extends Parameters<TMixinMap[TKey]>[0], TCtx extends Parameters<TMixinMap[TKey]>[1]>(mixinKey: TKey, inputValue: TArg, ...inputCtx: TCtx extends undefined ? [void] : [TCtx]): ReturnType<TMixinMap[TKey]> extends Promise<any> ? ReturnType<TMixinMap[TKey]> : ReturnType<TMixinMap[TKey]>;
+    /** Calculates the priority for a mixin based on the given configuration and the current auto-increment state of the instance */
+    protected calcPriority(mixinKey: TMixinKey, config: Partial<MixinConfig>): number | undefined;
+    /** Removes all mixins with the given key */
+    protected removeAll(mixinKey: TMixinKey): void;
+}
+export {};

package/dist/lib/NanoEmitter.d.ts

@@ -7,18 +7,65 @@ export interface NanoEmitterOptions {
     /** If set to true, allows emitting events through the public method emit() */
     publicEmit: boolean;
 }
-/** Class that can be extended or instantiated by itself to create an event emitter with helper methods and a strongly typed event map */
+/**
+ * Class that can be extended or instantiated by itself to create a lightweight event emitter with helper methods and a strongly typed event map.  
+ * If extended from, you can use `this.events.emit()` to emit events, even if the `emit()` method doesn't work because `publicEmit` is not set to true in the constructor.  
+ */
 export declare class NanoEmitter<TEvtMap extends EventsMap = DefaultEvents> {
     protected readonly events: Emitter<TEvtMap>;
     protected eventUnsubscribes: Unsubscribe[];
     protected emitterOptions: NanoEmitterOptions;
+    /** Creates a new instance of NanoEmitter - a lightweight event emitter with helper methods and a strongly typed event map */
     constructor(options?: Partial<NanoEmitterOptions>);
-    /** Subscribes to an event - returns a function that unsubscribes the event listener */
+    /**
+     * Subscribes to an event and calls the callback when it's emitted.  
+     * @param event The event to subscribe to. Use `as "_"` in case your event names aren't thoroughly typed (like when using a template literal, e.g. \`event-${val}\` as "_")  
+     * @returns Returns a function that can be called to unsubscribe the event listener  
+     * @example ```ts  
+     * const emitter = new NanoEmitter<{  
+     *   foo: (bar: string) => void;  
+     * }>({  
+     *   publicEmit: true,  
+     * });  
+     *  
+     * let i = 0;  
+     * const unsub = emitter.on("foo", (bar) => {  
+     *   // unsubscribe after 10 events:  
+     *   if(++i === 10) unsub();  
+     *   console.log(bar);  
+     * });  
+     *  
+     * emitter.emit("foo", "bar");  
+     * ```  
+     */
     on<TKey extends keyof TEvtMap>(event: TKey | "_", cb: TEvtMap[TKey]): () => void;
-    /** Subscribes to an event and calls the callback or resolves the Promise only once */
+    /**
+     * Subscribes to an event and calls the callback or resolves the Promise only once when it's emitted.  
+     * @param event The event to subscribe to. Use `as "_"` in case your event names aren't thoroughly typed (like when using a template literal, e.g. \`event-${val}\` as "_")  
+     * @param cb The callback to call when the event is emitted - if provided or not, the returned Promise will resolve with the event arguments  
+     * @returns Returns a Promise that resolves with the event arguments when the event is emitted  
+     * @example ```ts  
+     * const emitter = new NanoEmitter<{  
+     *   foo: (bar: string) => void;  
+     * }>();  
+     *  
+     * // Promise syntax:  
+     * const [bar] = await emitter.once("foo");  
+     * console.log(bar);  
+     *  
+     * // Callback syntax:  
+     * emitter.once("foo", (bar) => console.log(bar));  
+     * ```  
+     */
     once<TKey extends keyof TEvtMap>(event: TKey | "_", cb?: TEvtMap[TKey]): Promise<Parameters<TEvtMap[TKey]>>;
-    /** Emits an event on this instance - Needs `publicEmit` to be set to true in the constructor! */
+    /**
+     * Emits an event on this instance.  
+     * ⚠️ Needs `publicEmit` to be set to true in the NanoEmitter constructor or super() call!  
+     * @param event The event to emit  
+     * @param args The arguments to pass to the event listeners  
+     * @returns Returns true if `publicEmit` is true and the event was emitted successfully  
+     */
     emit<TKey extends keyof TEvtMap>(event: TKey, ...args: Parameters<TEvtMap[TKey]>): boolean;
-    /** Unsubscribes all event listeners */
+    /** Unsubscribes all event listeners from this instance */
     unsubscribeAll(): void;
 }

package/dist/lib/dom.d.ts

@@ -20,7 +20,7 @@ export declare function addParent<TElem extends Element, TParentElem extends Ele
 export declare function addGlobalStyle(style: string): HTMLStyleElement;
 /**
  * Preloads an array of image URLs so they can be loaded instantly from the browser cache later on  
- * @param rejects If set to `true`, the returned PromiseSettledResults will contain rejections for any of the images that failed to load  
+ * @param rejects If set to `true`, the returned PromiseSettledResults will contain rejections for any of the images that failed to load. Is set to `false` by default.  
  * @returns Returns an array of `PromiseSettledResult` - each resolved result will contain the loaded image element, while each rejected result will contain an `ErrorEvent`  
  */
 export declare function preloadImages(srcUrls: string[], rejects?: boolean): Promise<PromiseSettledResult<HTMLImageElement>[]>;

package/dist/lib/index.d.ts

@@ -13,6 +13,7 @@ export * from "./dom.js";
 export * from "./errors.js";
 export * from "./math.js";
 export * from "./misc.js";
+export * from "./Mixins.js";
 export * from "./NanoEmitter.js";
 export * from "./SelectorObserver.js";
 export * from "./translation.js";

package/dist/lib/misc.d.ts

@@ -61,3 +61,9 @@ export declare function consumeStringGen<TStrUnion extends string>(strGen: Strin
  * Set {@linkcode zeroOnInvalid} to false to return NaN instead of 0 if the object doesn't have any of the properties.  
  */
 export declare function getListLength(obj: ListWithLength, zeroOnInvalid?: boolean): number;
+/**
+ * Turns the passed object into a "pure" object without a prototype chain, meaning it won't have any default properties like `toString`, `__proto__`, `__defineGetter__`, etc.  
+ * This makes the object immune to prototype pollution attacks and allows for cleaner object literals, at the cost of being harder to work with in some cases.  
+ * It also effectively transforms a `Stringifiable` value into one that will throw a TypeError when stringified instead of defaulting to `[object Object]`  
+ */
+export declare function purifyObj<TObj extends object>(obj: TObj): TObj;

package/dist/lib/translation.d.ts

@@ -165,7 +165,7 @@ declare function addTransform<TTrKey extends string = string>(transform: Transfo
  * @param patternOrFn A reference to the regular expression of the transform function, a string matching the original pattern, or a reference to the transform function to delete  
  * @returns Returns true if the transform function was found and deleted, false if it wasn't found  
  */
-declare function deleteTransform(patternOrFn: RegExp | string | TransformFn): boolean;
+declare function deleteTransform(patternOrFn: RegExp | TransformFn): boolean;
 declare const tr: {
     for: <TTrKey extends string = string>(language: string, key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]) => ReturnType<typeof trFor<TTrKey>>;
     use: <TTrKey extends string = string>(language: string) => ReturnType<typeof useTr<TTrKey>>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "9.2.1",
+  "version": "9.4.0",
   "description": "General purpose DOM/GreaseMonkey library that allows you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -14,6 +14,11 @@
       "import": "./dist/index.js"
     }
   },
+  "engines": {
+    "pnpm": ">=9",
+    "npm": "please-use-pnpm",
+    "yarn": "please-use-pnpm"
+  },
   "type": "module",
   "repository": {
     "type": "git",
@@ -38,6 +43,8 @@
   "devDependencies": {
     "@changesets/cli": "^2.27.11",
     "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.23.0",
+    "@testing-library/dom": "^10.4.0",
     "@types/express": "^4.17.21",
     "@types/greasemonkey": "^4.0.7",
     "@types/node": "^22.10.5",
@@ -45,15 +52,18 @@
     "@typescript-eslint/eslint-plugin": "^8.21.0",
     "@typescript-eslint/parser": "^8.21.0",
     "@typescript-eslint/utils": "^8.21.0",
+    "@vitest/coverage-v8": "^3.0.9",
     "concurrently": "^8.2.2",
     "eslint": "^9.18.0",
     "express": "^4.21.2",
     "globals": "^15.14.0",
+    "jsdom": "^26.0.0",
     "kleur": "^4.1.5",
     "tslib": "^2.8.1",
     "tsup": "^8.3.5",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.9"
   },
   "files": [
     "/dist/index.js",
@@ -63,7 +73,7 @@
     "/dist/index.umd.js",
     "/dist/lib/**.d.ts",
     "/package.json",
-    "/README-summary.md",
+    "/README.md",
     "/CHANGELOG.md",
     "/LICENSE.txt"
   ],
@@ -81,8 +91,10 @@
     "publish-package-jsr": "pnpm update-jsr-version && npx jsr publish --allow-dirty",
     "check-jsr": "npx jsr publish --allow-dirty --dry-run",
     "change": "changeset",
-    "test-serve": "node --import tsx ./test/TestPage/server.mts",
-    "test-dev": "cd test/TestScript && pnpm dev",
-    "test": "concurrently \"pnpm test-serve\" \"pnpm test-dev\""
+    "test-gm-serve": "node --import tsx ./test/TestPage/server.mts",
+    "test-gm-dev": "cd test/TestScript && pnpm dev",
+    "test-gm": "concurrently \"pnpm test-gm-serve\" \"pnpm test-gm-dev\"",
+    "test": "vitest --passWithNoTests",
+    "test-coverage": "vitest --passWithNoTests --coverage"
   }
 }

package/README-summary.md

@@ -1,213 +0,0 @@
-## UserUtils
-General purpose DOM/GreaseMonkey library that allows you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more.  
-Contains builtin TypeScript declarations. Supports ESM and CJS imports via a bundler and global declaration via `@require`  
-The library works in any DOM environment with or without the [GreaseMonkey API](https://wiki.greasespot.net/Greasemonkey_Manual:API), but some features will be unavailable or limited.  
-  
-You may want to check out my [template for userscripts in TypeScript](https://github.com/Sv443/Userscript.ts) that you can use to get started quickly. It also includes this library by default.  
-  
-If you like using this library, please consider [supporting the development ❤️](https://github.com/sponsors/Sv443)
-
-<br>
-
-[![minified bundle size badge](https://badgen.net/bundlephobia/min/@sv443-network/userutils)](https://bundlephobia.com/package/@sv443-network/userutils)
-[![minified and gzipped bundle size badge](https://badgen.net/bundlephobia/minzip/@sv443-network/userutils)](https://bundlephobia.com/package/@sv443-network/userutils)
-[![tree shaking support badge](https://badgen.net/bundlephobia/tree-shaking/@sv443-network/userutils)](https://bundlephobia.com/package/@sv443-network/userutils)
-
-[![github stargazers badge](https://badgen.net/github/stars/Sv443-Network/UserUtils?icon=github)](https://github.com/Sv443-Network/UserUtils/stargazers)
-[![discord server badge](https://badgen.net/discord/online-members/aBH4uRG?icon=discord)](https://dc.sv443.net/)
-
-<br>
-
-## &gt; [Full documentation on GitHub](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#readme) &lt;
-
-<br>
-
-<span style="font-size: 0.8em;">
-
-View the documentation of previous major releases:  
-<a href="https://github.com/Sv443-Network/UserUtils/blob/v8.0.0/README.md" rel="noopener noreferrer">8.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v7.0.0/README.md" rel="noopener noreferrer">7.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v6.0.0/README.md" rel="noopener noreferrer">6.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v5.0.0/README.md" rel="noopener noreferrer">5.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v4.0.0/README.md" rel="noopener noreferrer">4.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v3.0.0/README.md" rel="noopener noreferrer">3.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v2.0.0/README.md" rel="noopener noreferrer">2.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v1.0.0/README.md" rel="noopener noreferrer">1.0.0</a>, <a href="https://github.com/Sv443-Network/UserUtils/blob/v0.5.3/README.md" rel="noopener noreferrer">0.5.3</a>
-<!-- <a href="https://github.com/Sv443-Network/UserUtils/blob/vX.0.0/docs.md" rel="noopener noreferrer">X.0.0</a>, -->
-</span>
-
-<br>
-
-<!-- https://github.com/Sv443-Network/UserUtils  < #foo    -->
-## Feature Summary:
-- **DOM:**
-    - [`SelectorObserver`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#selectorobserver) - class that manages listeners that are called when selectors are found in the DOM
-    - [`getUnsafeWindow()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#getunsafewindow) - get the unsafeWindow object or fall back to the regular window object
-    - [`isDomLoaded()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#isdomloaded) - check if the DOM has finished loading and can be queried and modified
-    - [`onDomLoad()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#ondomload) - run a function or pause async execution until the DOM has finished loading (or immediately if DOM is already loaded)
-    - [`addParent()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#addparent) - add a parent element around another element
-    - [`addGlobalStyle()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#addglobalstyle) - add a global style to the page
-    - [`preloadImages()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#preloadimages) - preload images into the browser cache for faster loading later on
-    - [`openInNewTab()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#openinnewtab) - open a link in a new tab
-    - [`interceptEvent()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#interceptevent) - conditionally intercepts events registered by `addEventListener()` on any given EventTarget object
-    - [`interceptWindowEvent()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#interceptwindowevent) - conditionally intercepts events registered by `addEventListener()` on the window object
-    - [`isScrollable()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#isscrollable) - check if an element has a horizontal or vertical scroll bar
-    - [`observeElementProp()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#observeelementprop) - observe changes to an element's property that can't be observed with MutationObserver
-    - [`getSiblingsFrame()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#getsiblingsframe) - returns a frame of an element's siblings, with a given alignment and size
-    - [`setInnerHtmlUnsafe()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#setinnerhtmlunsafe) - set the innerHTML of an element using a [Trusted Types policy](https://developer.mozilla.org/en-US/docs/Web/API/Trusted_Types_API) without sanitizing or escaping it
-    - [`probeElementStyle()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#probeelementstyle) - probe the computed style of a temporary element (get default font size, resolve CSS variables, etc.)
-- **Math:**
-    - [`clamp()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#clamp) - constrain a number between a min and max value
-    - [`mapRange()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#maprange) - map a number from one range to the same spot in another range
-    - [`randRange()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#randrange) - generate a random number between a min and max boundary
-    - [`digitCount()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#digitcount) - calculate the amount of digits in a number
-    - [`roundFixed()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#roundfixed) - round a floating-point number at the given amount of decimals, or to the given power of 10
-    - [`bitSetHas()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#bitsethas) - check if a bit is set in a [bitset](https://www.geeksforgeeks.org/cpp-bitset-and-its-application/)
-- **Misc:**
-    - [`DataStore`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastore) - class that manages a hybrid sync & async persistent JSON database, including data migration
-    - [`DataStoreSerializer`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastoreserializer) - class for importing & exporting data of multiple DataStore instances, including compression, checksumming and running migrations
-    - [`Dialog`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#dialog) - class for creating custom modal dialogs with a promise-based API and a generic, default style
-    - [`NanoEmitter`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#nanoemitter) - tiny event emitter class with a focus on performance and simplicity (based on [nanoevents](https://npmjs.com/package/nanoevents))
-    - [`Debouncer`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer) - class for debouncing function calls with a given timeout
-    - [`debounce()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debounce) - function wrapper for the Debouncer class for easier usage
-    - [`autoPlural()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#autoplural) - automatically pluralize a string
-    - [`pauseFor()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#pausefor) - pause the execution of a function for a given amount of time
-    - [`fetchAdvanced()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#fetchadvanced) - wrapper around the fetch API with a timeout option
-    - [`insertValues()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#insertvalues) - insert values into a string at specified placeholders
-    - [`compress()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#compress) - compress a string with Gzip or Deflate
-    - [`decompress()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#decompress) - decompress a previously compressed string
-    - [`computeHash()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#computehash) - compute the hash / checksum of a string or ArrayBuffer
-    - [`randomId()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#randomid) - generate a random ID of a given length and radix
-    - [`consumeGen()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#consumegen) - consumes a ValueGen and returns the value
-    - [`consumeStringGen()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#consumestringgen) - consumes a StringGen and returns the string
-    - [`getListLength()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#getlistlength) - get the length of any object with a numeric `length`, `count` or `size` property
-- **Arrays:**
-    - [`randomItem()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#randomitem) - returns a random item from an array
-    - [`randomItemIndex()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#randomitemindex) - returns a tuple of a random item and its index from an array
-    - [`takeRandomItem()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#takerandomitem) - returns a random item from an array and mutates it to remove the item
-    - [`randomizeArray()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#randomizearray) - returns a copy of the array with its items in a random order
-- **Translation:**
-    - [`tr.for()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trfor) - translates a key for the specified language
-    - [`tr.use()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#truse) - creates a translation function for the specified language
-    - [`tr.hasKey()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trhaskey) - checks if a key exists in the given language
-    - [`tr.addTranslations()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#traddtranslations) - add a flat or recursive translation object for a language
-    - [`tr.getTranslations()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trgettranslations) - returns the translation object for a language
-    - [`tr.deleteTranslations()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trdeletetranslations) - delete the translation object for a language
-    - [`tr.setFallbackLanguage()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trsetfallbacklanguage) - set the fallback language used when a key is not found in the given language
-    - [`tr.getFallbackLanguage()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trgetfallbacklanguage) - returns the fallback language
-    - [`tr.addTransform()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#traddtransform) - adds a transform function to the translation system for custom argument insertion and much more
-    - [`tr.deleteTransform()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trdeletetransform) - removes a transform function
-    - [`tr.transforms`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trtransforms) - predefined transform functions for quickly adding custom argument insertion
-    - [`TrKeys`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#trkeys) - generic type that extracts all keys from a flat or recursive translation object into a union
-- **Colors:**
-    - [`hexToRgb()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#hextorgb) - convert a hex color string to an RGB or RGBA value tuple
-    - [`rgbToHex()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#rgbtohex) - convert RGB or RGBA values to a hex color string
-    - [`lightenColor()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#lightencolor) - lighten a CSS color string (hex, rgb or rgba) by a given percentage
-    - [`darkenColor()`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#darkencolor) - darken a CSS color string (hex, rgb or rgba) by a given percentage
-- **Utility types for TypeScript:**
-    - [`Stringifiable`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#stringifiable) - any value that is a string or can be converted to one (implicitly or explicitly)
-    - [`NonEmptyArray`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#nonemptyarray) - any array that should have at least one item
-    - [`NonEmptyString`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#nonemptystring) - any string that should have at least one character
-    - [`LooseUnion`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#looseunion) - a union that gives autocomplete in the IDE but also allows any other value of the same type
-    - [`Prettify`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#prettify) - expands a complex type into a more readable format while keeping functionality the same
-    - [`ValueGen`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#valuegen) - a "generator" value that allows for super flexible value typing and declaration
-    - [`StringGen`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#stringgen) - a "generator" string that allows for super flexible string typing and declaration, including enhanced support for unions
-    - [`ListWithLength`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#listwithlength) - represents an array or object with a numeric `length`, `count` or `size` property
-- **Custom Error classes:**
-    - [`UUError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#uuerror) - base class for all custom UserUtils errors - has a custom `date` prop set to the time of creation
-    - [`ChecksumMismatchError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#checksummismatcherror) - thrown when a string of data doesn't match its checksum
-    - [`MigrationError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#migrationerror) - thrown when a data migration fails
-    - [`PlatformError`](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#platformerror) - thrown when a function is called in an unsupported environment
-
-<br><br>
-
-## Installation:
-Shameless plug: I made a [template for userscripts in TypeScript](https://github.com/Sv443/Userscript.ts) that you can use to get started quickly. It also includes this library by default.  
-  
-- If you are using a bundler (like webpack, rollup, vite, etc.), you can install this package in one of the following ways:
-    ```
-    npm i @sv443-network/userutils
-    pnpm i @sv443-network/userutils
-    yarn add @sv443-network/userutils
-    npx jsr install @sv443-network/userutils
-    deno add jsr:@sv443-network/userutils
-    ```
-    Then import it in your script as usual:  
-    
-    ```ts
-    // on Node:
-    import { addGlobalStyle } from "@sv443-network/userutils";
-
-    // on Deno:
-    import { addGlobalStyle } from "jsr:@sv443-network/userutils";
-
-    // you can also import the entire library as an object (not recommended because of worse treeshaking support):
-    import * as UserUtils from "@sv443-network/userutils";
-    ```
-
-
-<br>
-
-- If you are not using a bundler, want to reduce the size of your userscript, or declared the package as external in your bundler, you can include the latest release by adding one of these directives to the userscript header, depending on your preferred CDN:  
-    Versioned (recommended):  
-
-    ```
-    // @require https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js
-    // @require https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js
-    ```
-    Non-versioned (not recommended because auto-updating):  
-
-    ```
-    // @require https://update.greasyfork.org/scripts/472956/UserUtils.js
-    // @require https://openuserjs.org/src/libs/Sv443/UserUtils.js
-    ```
-
-- If you are using this library in a generic DOM environment without access to the GreaseMonkey API, either download the latest release from the [releases page](https://github.com/Sv443-Network/UserUtils/releases) to include in your project or add one of the following tags to the &lt;head&gt;:
-    ```html
-    <script src="https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>
-    <script src="https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>
-    ```
-
-> **Note:**  
-> In order for your userscript not to break on a major library update, use one the versioned URLs above after replacing `INSERT_VERSION` with the desired version (e.g. `8.3.2`) or the versioned URL that's shown [at the top of the GreasyFork page.](https://greasyfork.org/scripts/472956-userutils)  
-
-<br>
-
-- Then, access the functions on the global variable `UserUtils`:
-    ```ts
-    UserUtils.addGlobalStyle("body { background-color: red; }");
-
-    // or using object destructuring:
-
-    const { clamp } = UserUtils;
-    console.log(clamp(1, 5, 10)); // 5
-    ```
-
-<br>
-
-- If you're using TypeScript and it complains about the missing global variable `UserUtils`, install the library using the package manager of your choice and add the following inside any `.ts` file that is included in the final build:  
-    ```ts
-    declare const UserUtils: typeof import("@sv443-network/userutils");
-
-    declare global {
-        interface Window {
-            UserUtils: typeof UserUtils;
-        }
-    }
-    ```
-
-<br>
-
-- If you're using a linter like ESLint, it might complain about the global variable `UserUtils` not being defined. To fix this, add the following to your ESLint configuration file:
-    ```json
-    "globals": {
-        "UserUtils": "readonly"
-    }
-    ```
-
-<br><br>
-
-<!-- #region License -->
-## License:
-This library is licensed under the MIT License.  
-See the [license file](./LICENSE.txt) for details.
-
-<br><br>
-
----
-
-Made with ❤️ by [Sv443](https://github.com/Sv443)  
-If you like this library, please consider [supporting the development](https://github.com/sponsors/Sv443)