@sv443-network/userutils 9.0.1 → 9.0.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @sv443-network/userutils
 
+## 9.0.3
+
+### Patch Changes
+
+- e3f1e6a: Fixed `Debouncer` TS types as to not break backwards compat
+- 5861bb4: Fixed broken ambiguity of DataStore's migration function type
+
+## 9.0.2
+
+### Patch Changes
+
+- 69c4dd1: Fixed wrong readme being included in JSR package and added `@module` comments
+
 ## 9.0.1
 
 ### Patch Changes

package/dist/index.global.js

@@ -8,7 +8,7 @@
 // ==UserLibrary==
 // @name         UserUtils
 // @description  Lightweight library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more
-// @version      9.0.1
+// @version      9.0.3
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 

package/dist/lib/DataStore.d.ts

@@ -1,6 +1,12 @@
+/**
+ * @module lib/DataStore  
+ * This module contains the DataStore class, which is a general purpose, sync and async persistent JSON database - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastore)  
+ */
 import type { Prettify } from "./types.js";
+/** Function that takes the data in the old format and returns the data in the new format. Also supports an asynchronous migration. */
+type MigrationFunc = (oldData: any) => any | Promise<any>;
 /** Dictionary of format version numbers and the function that migrates to them from the previous whole integer */
-export type DataMigrationsDict = Record<number, ((oldData: unknown) => unknown | Promise<unknown>)>;
+export type DataMigrationsDict = Record<number, MigrationFunc>;
 /** Options for the DataStore instance */
 export type DataStoreOptions<TData> = Prettify<{
     /**
@@ -155,3 +161,4 @@ export declare class DataStore<TData extends object = object> {
     /** Deletes a value from persistent storage - can be overwritten in a subclass if you want to use something other than the default storage methods */
     protected deleteValue(name: string): Promise<void>;
 }
+export {};

package/dist/lib/DataStoreSerializer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/DataStoreSerializer  
+ * This module contains the DataStoreSerializer class, which allows you to import and export serialized DataStore data - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastoreserializer)  
+ */
 import { type DataStore } from "./index.js";
 export type DataStoreSerializerOptions = {
     /** Whether to add a checksum to the exported data */

package/dist/lib/Debouncer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/Debouncer  
+ * This module contains the Debouncer class and debounce function that allow you to reduce the amount of calls in rapidly firing event listeners and such - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer)  
+ */
 import { NanoEmitter } from "./NanoEmitter.js";
 /**
  * The type of edge to use for the debouncer - [see the docs for a diagram and explanation.](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer)  
@@ -14,11 +18,15 @@ import { NanoEmitter } from "./NanoEmitter.js";
  *     - Calls could get stuck in the queue indefinitely if there is no downtime between calls that is greater than the `timeoutDuration`  
  */
 export type DebouncerType = "immediate" | "idle";
-export type DebouncerFunc<TArgs> = (...args: TArgs[]) => void | unknown;
+type AnyFunc = (...args: any) => any;
+/** The debounced function type that is returned by the {@linkcode debounce} function */
+export type DebouncedFunction<TFunc extends AnyFunc> = ((...args: Parameters<TFunc>) => ReturnType<TFunc>) & {
+    debouncer: Debouncer<TFunc>;
+};
 /** Event map for the {@linkcode Debouncer} */
-export type DebouncerEventMap<TArgs> = {
+export type DebouncerEventMap<TFunc extends AnyFunc> = {
     /** Emitted when the debouncer calls all registered listeners, as a pub-sub alternative */
-    call: DebouncerFunc<TArgs>;
+    call: TFunc;
     /** Emitted when the timeout or edge type is changed after the instance was created */
     change: (timeout: number, type: DebouncerType) => void;
 };
@@ -31,15 +39,15 @@ export type DebouncerEventMap<TArgs> = {
  * - `call` - emitted when the debouncer calls all listeners - use this as a pub-sub alternative to the default callback-style listeners  
  * - `change` - emitted when the timeout or edge type is changed after the instance was created  
  */
-export declare class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArgs>> {
+export declare class Debouncer<TFunc extends AnyFunc> extends NanoEmitter<DebouncerEventMap<TFunc>> {
     protected timeout: number;
     protected type: DebouncerType;
     /** All registered listener functions and the time they were attached */
-    protected listeners: DebouncerFunc<TArgs>[];
+    protected listeners: TFunc[];
     /** The currently active timeout */
     protected activeTimeout: ReturnType<typeof setTimeout> | undefined;
     /** The latest queued call */
-    protected queuedCall: DebouncerFunc<TArgs> | undefined;
+    protected queuedCall: (() => void) | undefined;
     /**
      * Creates a new debouncer with the specified timeout and edge type.  
      * @param timeout Timeout in milliseconds between letting through calls - defaults to 200  
@@ -47,9 +55,9 @@ export declare class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArg
      */
     constructor(timeout?: number, type?: DebouncerType);
     /** Adds a listener function that will be called on timeout */
-    addListener(fn: DebouncerFunc<TArgs>): void;
+    addListener(fn: TFunc): void;
     /** Removes the listener with the specified function reference */
-    removeListener(fn: DebouncerFunc<TArgs>): void;
+    removeListener(fn: TFunc): void;
     /** Removes all listeners */
     removeAllListeners(): void;
     /** Sets the timeout for the debouncer */
@@ -63,7 +71,7 @@ export declare class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArg
     /** Returns the current edge type */
     getType(): DebouncerType;
     /** Use this to call the debouncer with the specified arguments that will be passed to all listener functions registered with {@linkcode addListener()} */
-    call(...args: TArgs[]): void;
+    call(...args: Parameters<TFunc>): void;
 }
 /**
  * Creates a {@linkcode Debouncer} instance with the specified timeout and edge type and attaches the passed function as a listener.  
@@ -72,6 +80,5 @@ export declare class Debouncer<TArgs> extends NanoEmitter<DebouncerEventMap<TArg
  *  
  * Refer to the {@linkcode Debouncer} class definition or the [Debouncer documentation](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer) for more information.  
  */
-export declare function debounce<TFunc extends DebouncerFunc<TArgs>, TArgs>(fn: TFunc, timeout?: number, type?: DebouncerType): DebouncerFunc<TArgs> & {
-    debouncer: Debouncer<TArgs>;
-};
+export declare function debounce<TFunc extends (...args: any[]) => any>(fn: TFunc, timeout?: number, type?: DebouncerType): DebouncedFunction<TFunc>;
+export {};

package/dist/lib/Dialog.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/Dialog  
+ * This module contains the Dialog class, which allows you to quickly and easily create modal dialogs - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#dialog)  
+ */
 import { NanoEmitter } from "./NanoEmitter.js";
 export declare const defaultDialogCss: string;
 /** ID of the last opened (top-most) dialog */

package/dist/lib/NanoEmitter.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/NanoEmitter  
+ * This module contains the NanoEmitter class, which is a tiny event emitter powered by [nanoevents](https://www.npmjs.com/package/nanoevents) - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#nanoemitter)  
+ */
 import { type DefaultEvents, type Emitter, type EventsMap, type Unsubscribe } from "nanoevents";
 export interface NanoEmitterOptions {
     /** If set to true, allows emitting events through the public method emit() */

package/dist/lib/SelectorObserver.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/SelectorObserver  
+ * This module contains the SelectorObserver class, allowing you to register listeners that get called whenever the element(s) behind a selector exist in the DOM - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#selectorobserver)  
+ */
 import { type DebouncerType } from "./Debouncer.js";
 import type { Prettify } from "./types.js";
 /** Options for the `onSelector()` method of {@linkcode SelectorObserver} */

package/dist/lib/array.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/array  
+ * This module contains various functions for working with arrays - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#arrays)  
+ */
 /** Describes an array with at least one item */
 export type NonEmptyArray<TArray = unknown> = [TArray, ...TArray[]];
 /** Returns a random item from the passed array */

package/dist/lib/colors.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/colors  
+ * This module contains various functions for working with colors - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#colors)  
+ */
 /**
  * Converts a hex color string in the format `#RRGGBB`, `#RRGGBBAA` (or even `RRGGBB` and `RGB`) to a tuple.  
  * @returns Returns a tuple array where R, G and B are an integer from 0-255 and alpha is a float from 0 to 1, or undefined if no alpha channel exists.  

package/dist/lib/crypto.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/crypto  
+ * This module contains various cryptographic functions using the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#table-of-contents)  
+ */
 /** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as a base64 string */
 export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType?: "string"): Promise<string>;
 /** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as an ArrayBuffer */

package/dist/lib/dom.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/dom  
+ * This module contains various functions for working with the DOM - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#dom)  
+ */
 /**
  * Returns `unsafeWindow` if the `@grant unsafeWindow` is given, otherwise falls back to the regular `window`  
  */

package/dist/lib/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module UserUtils  
+ * UserUtils is a lightweight library with various utilities for userscripts, allowing you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more  
+ */
 export * from "./array.js";
 export * from "./colors.js";
 export * from "./crypto.js";

package/dist/lib/math.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/math  
+ * This module contains various math functions - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#math)  
+ */
 import type { Stringifiable } from "./types.js";
 /** Ensures the passed {@linkcode value} always stays between {@linkcode min} and {@linkcode max} */
 export declare function clamp(value: number, min: number, max: number): number;

package/dist/lib/misc.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/misc  
+ * This module contains miscellaneous functions that don't fit in another category - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#misc)  
+ */
 import type { Prettify, Stringifiable } from "./types.js";
 /**
  * Automatically appends an `s` to the passed {@linkcode word}, if {@linkcode num} is not equal to 1  

package/dist/lib/translation.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/translation  
+ * This module contains a translation system that supports flat and nested JSON objects and value transformation functions - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#translation)  
+ */
 import type { Stringifiable } from "./types.js";
 /**
  * Translation object to pass to {@linkcode tr.addTranslations()}  

package/dist/lib/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/types  
+ * This module contains various TS types - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#utility-types)  
+ */
 /** Represents any value that is either a string itself or can be converted to one (implicitly and explicitly) because it has a toString() method */
 export type Stringifiable = string | {
     toString(): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "9.0.1",
+  "version": "9.0.3",
   "description": "Lightweight library with various utilities for userscripts - 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",