@sv443-network/userutils 8.2.0 → 8.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sv443-network/userutils
 
+## 8.3.0
+
+### Minor Changes
+
+- 1ecd63c: Added support for the `signal` property in `fetchAdvanced()`
+
 ## 8.2.0
 
 ### Minor Changes

package/README.md

@@ -1775,24 +1775,32 @@ fetchAdvanced(input: string | Request | URL, options?: {
   
 A drop-in replacement for the native `fetch()` function that adds options like a timeout property.  
 The timeout will default to 10 seconds if left undefined. Set it to a negative number to disable the timeout.  
-Note that the `signal` option will be overwritten if passed.  
   
 <details><summary><b>Example - click to view</b></summary>
 
 ```ts
 import { fetchAdvanced } from "@sv443-network/userutils";
 
+const { signal, abort } = new AbortController();
+
 fetchAdvanced("https://jokeapi.dev/joke/Any?safe-mode", {
+  // times out after 5 seconds:
   timeout: 5000,
-  // also accepts any other fetch options like headers:
+  // also accepts any other fetch options like headers and signal:
   headers: {
     "Accept": "text/plain",
   },
+  // makes the request abortable:
+  signal,
 }).then(async (response) => {
   console.log("Fetch data:", await response.text());
 }).catch((err) => {
   console.error("Fetch error:", err);
 });
+
+document.querySelector("button#cancel")?.addEventListener("click", () => {
+  abort();
+});
 ```
 </details>
 

package/dist/index.global.js

@@ -8,7 +8,7 @@
 // ==UserLibrary==
 // @name         UserUtils
 // @description  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 more
-// @version      8.2.0
+// @version      8.3.0
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 
@@ -1271,27 +1271,29 @@ Has: ${checksum}`);
     });
   }
   function debounce(func, timeout = 300, edge = "falling") {
-    let timer;
+    let id;
     return function(...args) {
       if (edge === "rising") {
-        if (!timer) {
+        if (!id) {
           func.apply(this, args);
-          timer = setTimeout(() => timer = void 0, timeout);
+          id = setTimeout(() => id = void 0, timeout);
         }
       } else {
-        clearTimeout(timer);
-        timer = setTimeout(() => func.apply(this, args), timeout);
+        clearTimeout(id);
+        id = setTimeout(() => func.apply(this, args), timeout);
       }
     };
   }
   function fetchAdvanced(_0) {
     return __async(this, arguments, function* (input, options = {}) {
+      var _a;
       const { timeout = 1e4 } = options;
+      const { signal, abort } = new AbortController();
+      (_a = options.signal) == null ? void 0 : _a.addEventListener("abort", abort);
       let signalOpts = {}, id = void 0;
       if (timeout >= 0) {
-        const controller = new AbortController();
-        id = setTimeout(() => controller.abort(), timeout);
-        signalOpts = { signal: controller.signal };
+        id = setTimeout(() => abort(), timeout);
+        signalOpts = { signal };
       }
       try {
         const res = yield fetch(input, __spreadValues(__spreadValues({}, options), signalOpts));

package/dist/index.js

@@ -1231,27 +1231,29 @@ function pauseFor(time) {
   });
 }
 function debounce(func, timeout = 300, edge = "falling") {
-  let timer;
+  let id;
   return function(...args) {
     if (edge === "rising") {
-      if (!timer) {
+      if (!id) {
         func.apply(this, args);
-        timer = setTimeout(() => timer = void 0, timeout);
+        id = setTimeout(() => id = void 0, timeout);
       }
     } else {
-      clearTimeout(timer);
-      timer = setTimeout(() => func.apply(this, args), timeout);
+      clearTimeout(id);
+      id = setTimeout(() => func.apply(this, args), timeout);
     }
   };
 }
 function fetchAdvanced(_0) {
   return __async(this, arguments, function* (input, options = {}) {
+    var _a;
     const { timeout = 1e4 } = options;
+    const { signal, abort } = new AbortController();
+    (_a = options.signal) == null ? void 0 : _a.addEventListener("abort", abort);
     let signalOpts = {}, id = void 0;
     if (timeout >= 0) {
-      const controller = new AbortController();
-      id = setTimeout(() => controller.abort(), timeout);
-      signalOpts = { signal: controller.signal };
+      id = setTimeout(() => abort(), timeout);
+      signalOpts = { signal };
     }
     try {
       const res = yield fetch(input, __spreadValues(__spreadValues({}, options), signalOpts));

package/dist/lib/DataStore.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="greasemonkey" />
+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, MigrationFunc>;
 /** Options for the DataStore instance */
-export type DataStoreOptions<TData> = {
+export type DataStoreOptions<TData> = Prettify<{
     /**
      * A unique internal ID for this data store.
      * To avoid conflicts with other scripts, it is recommended to use a prefix that is unique to your script.
@@ -66,7 +67,7 @@ export type DataStoreOptions<TData> = {
 } | {
     encodeData?: never;
     decodeData?: never;
-});
+})>;
 /**
  * Manages a hybrid synchronous & asynchronous persistent JSON database that is cached in memory and persistently saved across sessions using [GM storage](https://wiki.greasespot.net/GM.setValue) (default), [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) or [sessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage).
  * Supports migrating data from older format versions to newer ones and populating the cache with default data if no persistent data is found.

package/dist/lib/SelectorObserver.d.ts

@@ -1,5 +1,6 @@
+import type { Prettify } from "./types.js";
 /** Options for the `onSelector()` method of {@linkcode SelectorObserver} */
-export type SelectorListenerOptions<TElem extends Element = HTMLElement> = SelectorOptionsOne<TElem> | SelectorOptionsAll<TElem>;
+export type SelectorListenerOptions<TElem extends Element = HTMLElement> = Prettify<SelectorOptionsOne<TElem> | SelectorOptionsAll<TElem>>;
 type SelectorOptionsOne<TElem extends Element> = SelectorOptionsCommon & {
     /** Whether to use `querySelectorAll()` instead - default is false */
     all?: false;
@@ -36,7 +37,7 @@ export type SelectorObserverOptions = {
     /** If set to a number, the checks will be run on interval instead of on mutation events - in that case all MutationObserverInit props will be ignored */
     checkInterval?: number;
 };
-export type SelectorObserverConstructorOptions = MutationObserverInit & SelectorObserverOptions;
+export type SelectorObserverConstructorOptions = Prettify<SelectorObserverOptions & MutationObserverInit>;
 /** Observes the children of the given element for changes */
 export declare class SelectorObserver {
     private enabled;

package/dist/lib/misc.d.ts

@@ -1,4 +1,4 @@
-import type { Stringifiable } from "./types.js";
+import type { Prettify, Stringifiable } from "./types.js";
 /**
  * Automatically appends an `s` to the passed {@linkcode word}, if {@linkcode num} is not equal to 1
  * @param word A word in singular form, to auto-convert to plural
@@ -24,9 +24,9 @@ export declare function pauseFor(time: number): Promise<void>;
 export declare function debounce<TFunc extends (...args: TArgs[]) => void, // eslint-disable-next-line @typescript-eslint/no-explicit-any
 TArgs = any>(func: TFunc, timeout?: number, edge?: "rising" | "falling"): (...args: TArgs[]) => void;
 /** Options for the `fetchAdvanced()` function */
-export type FetchAdvancedOpts = Omit<RequestInit & Partial<{
+export type FetchAdvancedOpts = Prettify<Partial<{
     /** Timeout in milliseconds after which the fetch call will be canceled with an AbortController signal */
     timeout: number;
-}>, "signal">;
+}> & RequestInit>;
 /** Calls the fetch API with special options like a timeout */
 export declare function fetchAdvanced(input: RequestInfo | URL, options?: FetchAdvancedOpts): Promise<Response>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "description": "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 more",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -26,7 +26,8 @@
     "dev-all": "npm run build-all -- --watch",
     "update-jsr-version": "npm run node-ts -- ./tools/update-jsr-version.mts",
     "publish-package": "changeset publish",
-    "publish-package-jsr": "npm run update-jsr-version && npx jsr publish",
+    "publish-package-jsr": "npm run update-jsr-version && npx jsr publish --allow-dirty",
+    "change": "changeset",
     "node-ts": "node --no-warnings=ExperimentalWarning --enable-source-maps --loader ts-node/esm",
     "test-serve": "npm run node-ts -- ./test/TestPage/server.mts",
     "test-dev": "cd test/TestScript && npm run dev",