@sv443-network/userutils 9.0.2 → 9.0.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @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

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.2
+// @version      9.0.3
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 

package/dist/lib/DataStore.d.ts

@@ -3,8 +3,10 @@
  * 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<{
     /**
@@ -159,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/Debouncer.d.ts

@@ -18,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;
 };
@@ -35,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  
@@ -51,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 */
@@ -67,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.  
@@ -76,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "9.0.2",
+  "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",