npm - @sv443-network/userutils - Versions diffs - 0.1.1 → 0.2.0 - Mend

@sv443-network/userutils 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,11 @@
 # @sv443-network/userutils
+## 0.2.0
+### Minor Changes
+- 0cf2254: add onSelector() to call a listener once a selector is found in the DOM
 ## 0.1.1
 ### Patch Changes

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 ## UserUtils
 Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, modify the DOM more easily and more.
-Contains builtin TypeScript definitions.
+Contains builtin TypeScript declarations.
 <br>
@@ -8,6 +8,7 @@ Contains builtin TypeScript definitions.
 - [Installation](#installation)
 - [Features](#features)
   - [onSelector()](#onselector) - call a listener once a selector is found in the DOM
+  - [initOnSelector()](#initonselector) - needs to be called once to be able to use `onSelector()`
   - [autoPlural()](#autoplural) - automatically pluralize a string
   - [clamp()](#clamp) - clamp a number between a min and max value
   - [pauseFor()](#pausefor) - pause the execution of a function for a given amount of time
@@ -54,16 +55,89 @@ If you like using this library, please consider [supporting development](https:/
 ## Features:
 ### onSelector()
-\- UNFINISHED -
+Usage:
+```ts
+onSelector<TElement = HTMLElement>(selector: string, options: {
+  listener: (elements: TElement | NodeListOf<TElement>) => void,
+  all?: boolean,
+  continuous?: boolean,
+}): void
+```
 Registers a listener to be called whenever the element(s) behind a selector is/are found in the DOM.
-In order to use this function, the MutationObservers have to be initialized with `initOnSelector()` first.
+If the selector already exists, the listener will be called immediately.
+If `all` is set to `true`, querySelectorAll() will be used instead and the listener will return a NodeList of matching elements.
+This will also include elements that were already found in a previous listener call.
+If set to `false` (default), querySelector() will be used and only the first element will be returned.
+If `continuous` is set to `true`, the listener will not be deregistered after it was called once (defaults to false).
-Example:
+When using TypeScript, the generic `TElement` can be used to specify the type of the element(s) that the listener will return.
+⚠️ In order to use this function, [`initOnSelector()`](#initonselector) has to be called as soon as possible.
+This initialization function has to be called after `DOMContentLoaded` is fired (or immediately if `@run-at document-end` is set).
+Calling onSelector() before `DOMContentLoaded` is fired will not throw an error, but it also won't trigger listeners until the DOM is accessible.
+<details><summary><b>Example - click to view</b></summary>
 ```ts
-// TODO
+document.addEventListener("DOMContentLoaded", initOnSelector);
+// Continuously checks if `div` elements are added to the DOM, then returns all of them (even previously detected ones) in a NodeList
+onSelector("div", {
+  listener: (element) => {
+    console.log("Elements found:", element);
+  },
+  all: true,
+  continuous: true,
+});
+// Checks if an input element with a value attribute of "5" is added to the DOM, then returns it and deregisters the listener
+onSelector("input[value=\"5\"]", {
+  listener: (element) => {
+    console.log("Element found:", element);
+  },
+});
 ```
+</details>
+<br>
+### initOnSelector()
+Usage:
+```ts
+initOnSelector(options: {
+  attributes?: boolean,
+  characterData?: boolean,
+}): void
+```
+Initializes the MutationObserver that is used by [`onSelector()`](#onselector) to check for the registered selectors whenever a DOM change occurs on the `<body>`
+By default, this only checks if elements are added or removed (at any depth).
+Set `attributes` to `true` to also check for attribute changes on every single descendant of the `<body>` (defaults to false).
+Set `characterData` to `true` to also check for character data changes on every single descendant of the `<body>` (defaults to false).
+⚠️ Using these extra options can have a performance impact on larger sites or sites with a constantly changing DOM.
+⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
+<details><summary><b>Example - click to view</b></summary>
+```ts
+document.addEventListener("DOMContentLoaded", () => {
+  initOnSelector({
+    attributes: true,
+    characterData: true,
+  });
+});
+```
+</details>
 <br>
 ### autoPlural()
@@ -72,7 +146,8 @@ Usage: `autoPlural(str: string, num: number | Array | NodeList): string`
 Automatically pluralizes a string if the given number is not 1.
 If an array or NodeList is passed, the length of it will be used.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 autoPlural("apple", 0); // "apples"
 autoPlural("apple", 1); // "apple"
@@ -82,6 +157,8 @@ autoPlural("apple", [1]);    // "apple"
 autoPlural("apple", [1, 2]); // "apples"
 ```
+</details>
 <br>
 ### clamp()
@@ -89,13 +166,16 @@ Usage: `clamp(num: number, min: number, max: number): number`
 Clamps a number between a min and max value.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 clamp(5, 0, 10);        // 5
 clamp(-1, 0, 10);       // 0
 clamp(Infinity, 0, 10); // 10
 ```
+</details>
 <br>
 ### pauseFor()
@@ -103,7 +183,8 @@ Usage: `pauseFor(ms: number): Promise<void>`
 Pauses async execution for a given amount of time.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 async function run() {
   console.log("Hello");
@@ -112,6 +193,8 @@ async function run() {
 }
 ```
+</details>
 <br>
 ### debounce()
@@ -121,13 +204,16 @@ Debounces a function, meaning that it will only be called once after a given amo
 This is very useful for functions that are called repeatedly, like event listeners, to remove extraneous calls.
 The timeout will default to 300ms if left undefined.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 window.addEventListener("resize", debounce((event) => {
   console.log("Window was resized:", event);
 }, 500)); // 500ms timeout
 ```
+</details>
 <br>
 ### getUnsafeWindow()
@@ -136,7 +222,8 @@ Usage: `getUnsafeWindow(): Window`
 Returns the unsafeWindow object or falls back to the regular window object if the `@grant unsafeWindow` is not given.
 Userscripts are sandboxed and do not have access to the regular window object, so this function is useful for websites that reject some events that were dispatched by the userscript.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 const mouseEvent = new MouseEvent("click", {
   view: getUnsafeWindow(),
@@ -144,15 +231,20 @@ const mouseEvent = new MouseEvent("click", {
 document.body.dispatchEvent(mouseEvent);
 ```
+</details>
 <br>
 ### insertAfter()
 Usage: `insertAfter(beforeElement: HTMLElement, afterElement: HTMLElement): HTMLElement`
 Inserts the element passed as `afterElement` as a sibling after the passed `beforeElement`.
-The `afterElement` will be returned.
+The passed `afterElement` will be returned.
+⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 const beforeElement = document.querySelector("#before");
 const afterElement = document.createElement("div");
@@ -160,15 +252,20 @@ afterElement.innerText = "After";
 insertAfter(beforeElement, afterElement);
 ```
+</details>
 <br>
 ### addParent()
 Usage: `addParent(element: HTMLElement, newParent: HTMLElement): HTMLElement`
 Adds a parent element around the passed `element` and returns the new parent.
-Previously registered event listeners should be kept intact.
+Previously registered event listeners are kept intact.
-Example:
+⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 const element = document.querySelector("#element");
 const newParent = document.createElement("a");
@@ -176,15 +273,18 @@ newParent.href = "https://example.org/";
 addParent(element, newParent);
 ```
+</details>
 <br>
 ### addGlobalStyle()
 Usage: `addGlobalStyle(css: string): void`
 Adds a global style to the page in form of a `<style>` element that's inserted into the `<head>`.
-This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
+⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 document.addEventListener("DOMContentLoaded", () => {
   addGlobalStyle(`
@@ -195,43 +295,61 @@ document.addEventListener("DOMContentLoaded", () => {
 });
 ```
+</details>
 <br>
 ### preloadImages()
-Usage: `preloadImages(...urls: string[]): Promise<void>`
+Usage: `preloadImages(urls: string[], rejects?: boolean): Promise<void>`
 Preloads images into browser cache by creating an invisible `<img>` element for each URL passed.
 The images will be loaded in parallel and the returned Promise will only resolve once all images have been loaded.
-The resulting PromiseSettledResult array will contain the image elements if resolved, or an ErrorEvent if rejected.
+The resulting PromiseSettledResult array will contain the image elements if resolved, or an ErrorEvent if rejected, but only if `rejects` is set to true.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
-preloadImages(
+preloadImages([
   "https://example.org/image1.png",
   "https://example.org/image2.png",
   "https://example.org/image3.png",
-).then((results) => {
-  console.log("Images preloaded. Results:", results);
-});
+], true)
+  .then((results) => {
+    console.log("Images preloaded. Results:", results);
+  });
 ```
+</details>
 <br>
 ### fetchAdvanced()
-Usage: `fetchAdvanced(url: string, options?: FetchAdvancedOptions): Promise<Response>`
+Usage:
+```ts
+fetchAdvanced(url: string, options?: {
+  timeout?: number,
+  // any other options from fetch() except for signal
+}): Promise<Response>
+```
 A wrapper around the native `fetch()` function that adds options like a timeout property.
 The timeout will default to 10 seconds if left undefined.
-Example:
+<details><summary><b>Example - click to view</b></summary>
 ```ts
-fetchAdvanced("https://example.org/", {
+fetchAdvanced("https://api.example.org/data", {
   timeout: 5000,
-}).then((response) => {
-  console.log("Response:", response);
+  headers: {
+    "Accept": "application/json",
+  },
+}).then(async (response) => {
+  console.log("Data:", await response.json());
 });
 ```
+</details>
 <br>
 ### openInNewTab()
@@ -241,29 +359,38 @@ Creates an invisible anchor with a `_blank` target and clicks it.
 Contrary to `window.open()`, this has a lesser chance to get blocked by the browser's popup blocker and doesn't open the URL as a new window.
 This function has to be run in relatively quick succession in response to a user interaction event, else the browser might reject it.
-Example:
+⚠️ This function needs to be run after the DOM has loaded (when using `@run-at document-end` or after `DOMContentLoaded` has fired).
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 document.querySelector("#button").addEventListener("click", () => {
   openInNewTab("https://example.org/");
 });
 ```
+</details>
 <br>
 ### interceptEvent()
 Usage: `interceptEvent(eventObject: EventTarget, eventName: string, predicate: () => boolean): void`
 Intercepts all events dispatched on the `eventObject` and prevents the listeners from being called as long as the predicate function returns a truthy value.
-This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are added after this function is called.
 Calling this function will set the `Error.stackTraceLimit` to 1000 to ensure the stack trace is preserved.
-Example:
+⚠️ This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are *attached* after this function is called.
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 interceptEvent(document.body, "click", () => {
   return true; // prevent all click events on the body
 });
 ```
+</details>
 <br>
 ### interceptWindowEvent()
@@ -272,13 +399,18 @@ Usage: `interceptWindowEvent(eventName: string, predicate: () => boolean): void`
 Intercepts all events dispatched on the `window` object and prevents the listeners from being called as long as the predicate function returns a truthy value.
 This is essentially the same as [`interceptEvent()`](#interceptevent), but automatically uses the `unsafeWindow` (or falls back to regular `window`).
-Example:
+⚠️ This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are *attached* after this function is called.
+<details><summary><b>Example - click to view</b></summary>
 ```ts
 interceptWindowEvent("beforeunload", () => {
   return true; // prevent the pesky "Are you sure you want to leave this page?" popup
 });
 ```
+</details>
 <br><br>

package/dist/index.d.mts CHANGED Viewed

@@ -1,12 +1,28 @@
-type SelectorExistsOpts = {
-    /** The selector to check for */
-    selector: string;
-    /** Whether to use `querySelectorAll()` instead */
-    all?: boolean;
-    /** Whether to call the listener continuously instead of once */
+type InitOnSelectorOpts = {
+    /** Set to true if mutations to any element's attributes are to also trigger the onSelector check (warning: this might draw a lot of performance on larger sites) */
+    attributes?: boolean;
+    /** Set to true if mutations to any element's character data are to also trigger the onSelector check (warning: this might draw a lot of performance on larger sites) */
+    characterData?: boolean;
+};
+type OnSelectorOpts<TElem extends Element = HTMLElement> = SelectorOptsOne<TElem> | SelectorOptsAll<TElem>;
+type SelectorOptsOne<TElem extends Element> = SelectorOptsBase & {
+    /** Whether to use `querySelectorAll()` instead - default is false */
+    all?: false;
+    /** Gets called whenever the selector was found in the DOM */
+    listener: (element: TElem) => void;
+};
+type SelectorOptsAll<TElem extends Element> = SelectorOptsBase & {
+    /** Whether to use `querySelectorAll()` instead - default is false */
+    all: true;
+    /** Gets called whenever the selector was found in the DOM */
+    listener: (elements: NodeListOf<TElem>) => void;
+};
+type SelectorOptsBase = {
+    /** Whether to call the listener continuously instead of once - default is false */
     continuous?: boolean;
 };
 type FetchAdvancedOpts = RequestInit & Partial<{
+    /** Timeout in milliseconds after which the fetch call will be canceled with an AbortController signal */
     timeout: number;
 }>;
@@ -62,12 +78,14 @@ declare function fetchAdvanced(url: string, options?: FetchAdvancedOpts): Promis
 declare function openInNewTab(href: string): void;
 /**
  * Intercepts the specified event on the passed object and prevents it from being called if the called `predicate` function returns a truthy value.
- * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.
+ * This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are added after this function is called.
+ * Calling this function will set the `Error.stackTraceLimit` to 1000 to ensure the stack trace is preserved.
  */
 declare function interceptEvent<TEvtObj extends EventTarget>(eventObject: TEvtObj, eventName: Parameters<TEvtObj["addEventListener"]>[0], predicate: () => boolean): void;
 /**
  * Intercepts the specified event on the window object and prevents it from being called if the called `predicate` function returns a truthy value.
- * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.
+ * This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are added after this function is called.
+ * Calling this function will set the `Error.stackTraceLimit` to 1000 to ensure the stack trace is preserved.
  */
 declare function interceptWindowEvent(eventName: keyof WindowEventMap, predicate: () => boolean): void;
@@ -75,10 +93,17 @@ declare function interceptWindowEvent(eventName: keyof WindowEventMap, predicate
  * Calls the `listener` as soon as the `selector` exists in the DOM.
  * Listeners are deleted when they are called once, unless `options.continuous` is set.
  * Multiple listeners with the same selector may be registered.
- * @template TElem The type of element that this selector will return - FIXME: listener inferring doesn't work when this generic is given
+ * @param selector The selector to listen for
+ * @param options Used for switching to `querySelectorAll()` and for calling the listener continuously
+ * @template TElem The type of element that the listener will return as its argument (defaults to the generic HTMLElement)
+ */
+declare function onSelector<TElem extends Element = HTMLElement>(selector: string, options: OnSelectorOpts<TElem>): void;
+/** Removes all listeners registered in `onSelector()` that have the given selector */
+declare function removeOnSelector(selector: string): boolean;
+/**
+ * Initializes a MutationObserver that checks for all registered selectors whenever an element is added to or removed from the `<body>`
+ * @param opts For fine-tuning when the MutationObserver checks for the selectors
  */
-declare function onSelector<TElem = HTMLElement, TOpts extends SelectorExistsOpts = SelectorExistsOpts>(options: TOpts, listener: (element: TOpts["all"] extends true ? (TElem extends HTMLElement ? NodeListOf<TElem> : TElem) : TElem) => void): void;
-/** Removes all listeners registered in `onSelector()` with a matching selector property */
-declare function removeOnSelector(selector: string): void;
+declare function initOnSelector(opts?: InitOnSelectorOpts): void;
-export { FetchAdvancedOpts, SelectorExistsOpts, addGlobalStyle, addParent, autoPlural, clamp, debounce, fetchAdvanced, getUnsafeWindow, insertAfter, interceptEvent, interceptWindowEvent, onSelector, openInNewTab, pauseFor, preloadImages, removeOnSelector };
+export { FetchAdvancedOpts, InitOnSelectorOpts, OnSelectorOpts, addGlobalStyle, addParent, autoPlural, clamp, debounce, fetchAdvanced, getUnsafeWindow, initOnSelector, insertAfter, interceptEvent, interceptWindowEvent, onSelector, openInNewTab, pauseFor, preloadImages, removeOnSelector };

package/dist/index.d.ts CHANGED Viewed

@@ -1,12 +1,28 @@
-type SelectorExistsOpts = {
-    /** The selector to check for */
-    selector: string;
-    /** Whether to use `querySelectorAll()` instead */
-    all?: boolean;
-    /** Whether to call the listener continuously instead of once */
+type InitOnSelectorOpts = {
+    /** Set to true if mutations to any element's attributes are to also trigger the onSelector check (warning: this might draw a lot of performance on larger sites) */
+    attributes?: boolean;
+    /** Set to true if mutations to any element's character data are to also trigger the onSelector check (warning: this might draw a lot of performance on larger sites) */
+    characterData?: boolean;
+};
+type OnSelectorOpts<TElem extends Element = HTMLElement> = SelectorOptsOne<TElem> | SelectorOptsAll<TElem>;
+type SelectorOptsOne<TElem extends Element> = SelectorOptsBase & {
+    /** Whether to use `querySelectorAll()` instead - default is false */
+    all?: false;
+    /** Gets called whenever the selector was found in the DOM */
+    listener: (element: TElem) => void;
+};
+type SelectorOptsAll<TElem extends Element> = SelectorOptsBase & {
+    /** Whether to use `querySelectorAll()` instead - default is false */
+    all: true;
+    /** Gets called whenever the selector was found in the DOM */
+    listener: (elements: NodeListOf<TElem>) => void;
+};
+type SelectorOptsBase = {
+    /** Whether to call the listener continuously instead of once - default is false */
     continuous?: boolean;
 };
 type FetchAdvancedOpts = RequestInit & Partial<{
+    /** Timeout in milliseconds after which the fetch call will be canceled with an AbortController signal */
     timeout: number;
 }>;
@@ -62,12 +78,14 @@ declare function fetchAdvanced(url: string, options?: FetchAdvancedOpts): Promis
 declare function openInNewTab(href: string): void;
 /**
  * Intercepts the specified event on the passed object and prevents it from being called if the called `predicate` function returns a truthy value.
- * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.
+ * This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are added after this function is called.
+ * Calling this function will set the `Error.stackTraceLimit` to 1000 to ensure the stack trace is preserved.
  */
 declare function interceptEvent<TEvtObj extends EventTarget>(eventObject: TEvtObj, eventName: Parameters<TEvtObj["addEventListener"]>[0], predicate: () => boolean): void;
 /**
  * Intercepts the specified event on the window object and prevents it from being called if the called `predicate` function returns a truthy value.
- * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.
+ * This function should be called as soon as possible (I recommend using `@run-at document-start`), as it will only intercept events that are added after this function is called.
+ * Calling this function will set the `Error.stackTraceLimit` to 1000 to ensure the stack trace is preserved.
  */
 declare function interceptWindowEvent(eventName: keyof WindowEventMap, predicate: () => boolean): void;
@@ -75,10 +93,17 @@ declare function interceptWindowEvent(eventName: keyof WindowEventMap, predicate
  * Calls the `listener` as soon as the `selector` exists in the DOM.
  * Listeners are deleted when they are called once, unless `options.continuous` is set.
  * Multiple listeners with the same selector may be registered.
- * @template TElem The type of element that this selector will return - FIXME: listener inferring doesn't work when this generic is given
+ * @param selector The selector to listen for
+ * @param options Used for switching to `querySelectorAll()` and for calling the listener continuously
+ * @template TElem The type of element that the listener will return as its argument (defaults to the generic HTMLElement)
+ */
+declare function onSelector<TElem extends Element = HTMLElement>(selector: string, options: OnSelectorOpts<TElem>): void;
+/** Removes all listeners registered in `onSelector()` that have the given selector */
+declare function removeOnSelector(selector: string): boolean;
+/**
+ * Initializes a MutationObserver that checks for all registered selectors whenever an element is added to or removed from the `<body>`
+ * @param opts For fine-tuning when the MutationObserver checks for the selectors
  */
-declare function onSelector<TElem = HTMLElement, TOpts extends SelectorExistsOpts = SelectorExistsOpts>(options: TOpts, listener: (element: TOpts["all"] extends true ? (TElem extends HTMLElement ? NodeListOf<TElem> : TElem) : TElem) => void): void;
-/** Removes all listeners registered in `onSelector()` with a matching selector property */
-declare function removeOnSelector(selector: string): void;
+declare function initOnSelector(opts?: InitOnSelectorOpts): void;
-export { FetchAdvancedOpts, SelectorExistsOpts, addGlobalStyle, addParent, autoPlural, clamp, debounce, fetchAdvanced, getUnsafeWindow, insertAfter, interceptEvent, interceptWindowEvent, onSelector, openInNewTab, pauseFor, preloadImages, removeOnSelector };
+export { FetchAdvancedOpts, InitOnSelectorOpts, OnSelectorOpts, addGlobalStyle, addParent, autoPlural, clamp, debounce, fetchAdvanced, getUnsafeWindow, initOnSelector, insertAfter, interceptEvent, interceptWindowEvent, onSelector, openInNewTab, pauseFor, preloadImages, removeOnSelector };

package/dist/index.js CHANGED Viewed

@@ -1,162 +1,20 @@
 'use strict';
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
+var b=Object.defineProperty,v=Object.defineProperties;var y=Object.getOwnPropertyDescriptors;var m=Object.getOwnPropertySymbols;var x=Object.prototype.hasOwnProperty,g=Object.prototype.propertyIsEnumerable;var f=(t,e,n)=>e in t?b(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,u=(t,e)=>{for(var n in e||(e={}))x.call(e,n)&&f(t,n,e[n]);if(m)for(var n of m(e))g.call(e,n)&&f(t,n,e[n]);return t},d=(t,e)=>v(t,y(e));var E=(t,e,n)=>new Promise((r,o)=>{var s=c=>{try{l(n.next(c));}catch(p){o(p);}},i=c=>{try{l(n.throw(c));}catch(p){o(p);}},l=c=>c.done?r(c.value):Promise.resolve(c.value).then(s,i);l((n=n.apply(t,e)).next());});function w(t,e){return (Array.isArray(e)||e instanceof NodeList)&&(e=e.length),`${t}${e===1?"":"s"}`}function M(t,e,n){return Math.max(Math.min(t,n),e)}function S(t){return new Promise(e=>{setTimeout(e,t);})}function A(t,e=300){let n;return function(...r){clearTimeout(n),n=setTimeout(()=>t.apply(this,r),e);}}function h(){try{return unsafeWindow}catch(t){return window}}function _(t,e){var n;return (n=t.parentNode)==null||n.insertBefore(e,t.nextSibling),e}function k(t,e){let n=t.parentNode;if(!n)throw new Error("Element doesn't have a parent node");return n.replaceChild(e,t),e.appendChild(t),e}function H(t){let e=document.createElement("style");e.innerHTML=t,document.head.appendChild(e);}function I(t,e=!1){let n=t.map(r=>new Promise((o,s)=>{let i=new Image;i.src=r,i.addEventListener("load",()=>o(i)),i.addEventListener("error",l=>e&&s(l));}));return Promise.allSettled(n)}function j(n){return E(this,arguments,function*(t,e={}){let{timeout:r=1e4}=e,o=new AbortController,s=setTimeout(()=>o.abort(),r),i=yield fetch(t,d(u({},e),{signal:o.signal}));return clearTimeout(s),i})}function N(t){let e=document.createElement("a");Object.assign(e,{className:"userutils-open-in-new-tab",target:"_blank",rel:"noopener noreferrer",href:t}),e.style.display="none",document.body.appendChild(e),e.click(),setTimeout(e.remove,50);}function O(t,e,n){typeof Error.stackTraceLimit=="number"&&Error.stackTraceLimit<1e3&&(Error.stackTraceLimit=1e3),function(r){element.__proto__.addEventListener=function(...o){if(!(o[0]===e&&n()))return r.apply(this,o)};}(t.__proto__.addEventListener);}function P(t,e){return O(h(),t,e)}var a=new Map;function W(t,e){let n=[];a.has(t)&&(n=a.get(t)),n.push(e),a.set(t,n),T(t,n);}function q(t){return a.delete(t)}function T(t,e){let n=[];e.forEach((r,o)=>{try{let s=r.all?document.querySelectorAll(t):document.querySelector(t);s&&(r.listener(s),r.continuous||n.push(o));}catch(s){}}),n.length>0&&a.set(t,e.filter((r,o)=>!n.includes(o)));}function $(t={}){new MutationObserver(()=>{for(let[n,r]of a.entries())T(n,r);}).observe(document.body,d(u({},t),{childList:!0}));}
-// lib/utils.ts
-function autoPlural(word, num) {
-  if (Array.isArray(num) || num instanceof NodeList)
-    num = num.length;
-  return `${word}${num === 1 ? "" : "s"}`;
-}
-function clamp(value, min, max) {
-  return Math.max(Math.min(value, max), min);
-}
-function pauseFor(time) {
-  return new Promise((res) => {
-    setTimeout(res, time);
-  });
-}
-function debounce(func, timeout = 300) {
-  let timer;
-  return function(...args) {
-    clearTimeout(timer);
-    timer = setTimeout(() => func.apply(this, args), timeout);
-  };
-}
-function getUnsafeWindow() {
-  try {
-    return unsafeWindow;
-  } catch (e) {
-    return window;
-  }
-}
-function insertAfter(beforeElement, afterElement) {
-  var _a;
-  (_a = beforeElement.parentNode) == null ? void 0 : _a.insertBefore(afterElement, beforeElement.nextSibling);
-  return afterElement;
-}
-function addParent(element2, newParent) {
-  const oldParent = element2.parentNode;
-  if (!oldParent)
-    throw new Error("Element doesn't have a parent node");
-  oldParent.replaceChild(newParent, element2);
-  newParent.appendChild(element2);
-  return newParent;
-}
-function addGlobalStyle(style) {
-  const styleElem = document.createElement("style");
-  styleElem.innerHTML = style;
-  document.head.appendChild(styleElem);
-}
-function preloadImages(srcUrls, rejects = false) {
-  const promises = srcUrls.map((src) => new Promise((res, rej) => {
-    const image = new Image();
-    image.src = src;
-    image.addEventListener("load", () => res(image));
-    image.addEventListener("error", (evt) => rejects && rej(evt));
-  }));
-  return Promise.allSettled(promises);
-}
-function fetchAdvanced(_0) {
-  return __async(this, arguments, function* (url, options = {}) {
-    const { timeout = 1e4 } = options;
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), timeout);
-    const res = yield fetch(url, __spreadProps(__spreadValues({}, options), {
-      signal: controller.signal
-    }));
-    clearTimeout(id);
-    return res;
-  });
-}
-function openInNewTab(href) {
-  const openElem = document.createElement("a");
-  Object.assign(openElem, {
-    className: "userutils-open-in-new-tab",
-    target: "_blank",
-    rel: "noopener noreferrer",
-    href
-  });
-  openElem.style.display = "none";
-  document.body.appendChild(openElem);
-  openElem.click();
-  setTimeout(openElem.remove, 50);
-}
-function interceptEvent(eventObject, eventName, predicate) {
-  if (Error.stackTraceLimit < 1e3) {
-    Error.stackTraceLimit = 1e3;
-  }
-  (function(original) {
-    element.__proto__.addEventListener = function(...args) {
-      if (args[0] === eventName && predicate())
-        return;
-      else
-        return original.apply(this, args);
-    };
-  })(eventObject.__proto__.addEventListener);
-}
-function interceptWindowEvent(eventName, predicate) {
-  return interceptEvent(getUnsafeWindow(), eventName, predicate);
-}
-// lib/onSelector.ts
-function onSelector(options, listener) {
-}
-function removeOnSelector(selector) {
-}
-exports.addGlobalStyle = addGlobalStyle;
-exports.addParent = addParent;
-exports.autoPlural = autoPlural;
-exports.clamp = clamp;
-exports.debounce = debounce;
-exports.fetchAdvanced = fetchAdvanced;
-exports.getUnsafeWindow = getUnsafeWindow;
-exports.insertAfter = insertAfter;
-exports.interceptEvent = interceptEvent;
-exports.interceptWindowEvent = interceptWindowEvent;
-exports.onSelector = onSelector;
-exports.openInNewTab = openInNewTab;
-exports.pauseFor = pauseFor;
-exports.preloadImages = preloadImages;
-exports.removeOnSelector = removeOnSelector;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.js.map
+exports.addGlobalStyle = H;
+exports.addParent = k;
+exports.autoPlural = w;
+exports.clamp = M;
+exports.debounce = A;
+exports.fetchAdvanced = j;
+exports.getUnsafeWindow = h;
+exports.initOnSelector = $;
+exports.insertAfter = _;
+exports.interceptEvent = O;
+exports.interceptWindowEvent = P;
+exports.onSelector = W;
+exports.openInNewTab = N;
+exports.pauseFor = S;
+exports.preloadImages = I;
+exports.removeOnSelector = q;

package/dist/index.mjs CHANGED Viewed

@@ -1,146 +1,3 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
+var b=Object.defineProperty,v=Object.defineProperties;var y=Object.getOwnPropertyDescriptors;var m=Object.getOwnPropertySymbols;var x=Object.prototype.hasOwnProperty,g=Object.prototype.propertyIsEnumerable;var f=(t,e,n)=>e in t?b(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,u=(t,e)=>{for(var n in e||(e={}))x.call(e,n)&&f(t,n,e[n]);if(m)for(var n of m(e))g.call(e,n)&&f(t,n,e[n]);return t},d=(t,e)=>v(t,y(e));var E=(t,e,n)=>new Promise((r,o)=>{var s=c=>{try{l(n.next(c));}catch(p){o(p);}},i=c=>{try{l(n.throw(c));}catch(p){o(p);}},l=c=>c.done?r(c.value):Promise.resolve(c.value).then(s,i);l((n=n.apply(t,e)).next());});function w(t,e){return (Array.isArray(e)||e instanceof NodeList)&&(e=e.length),`${t}${e===1?"":"s"}`}function M(t,e,n){return Math.max(Math.min(t,n),e)}function S(t){return new Promise(e=>{setTimeout(e,t);})}function A(t,e=300){let n;return function(...r){clearTimeout(n),n=setTimeout(()=>t.apply(this,r),e);}}function h(){try{return unsafeWindow}catch(t){return window}}function _(t,e){var n;return (n=t.parentNode)==null||n.insertBefore(e,t.nextSibling),e}function k(t,e){let n=t.parentNode;if(!n)throw new Error("Element doesn't have a parent node");return n.replaceChild(e,t),e.appendChild(t),e}function H(t){let e=document.createElement("style");e.innerHTML=t,document.head.appendChild(e);}function I(t,e=!1){let n=t.map(r=>new Promise((o,s)=>{let i=new Image;i.src=r,i.addEventListener("load",()=>o(i)),i.addEventListener("error",l=>e&&s(l));}));return Promise.allSettled(n)}function j(n){return E(this,arguments,function*(t,e={}){let{timeout:r=1e4}=e,o=new AbortController,s=setTimeout(()=>o.abort(),r),i=yield fetch(t,d(u({},e),{signal:o.signal}));return clearTimeout(s),i})}function N(t){let e=document.createElement("a");Object.assign(e,{className:"userutils-open-in-new-tab",target:"_blank",rel:"noopener noreferrer",href:t}),e.style.display="none",document.body.appendChild(e),e.click(),setTimeout(e.remove,50);}function O(t,e,n){typeof Error.stackTraceLimit=="number"&&Error.stackTraceLimit<1e3&&(Error.stackTraceLimit=1e3),function(r){element.__proto__.addEventListener=function(...o){if(!(o[0]===e&&n()))return r.apply(this,o)};}(t.__proto__.addEventListener);}function P(t,e){return O(h(),t,e)}var a=new Map;function W(t,e){let n=[];a.has(t)&&(n=a.get(t)),n.push(e),a.set(t,n),T(t,n);}function q(t){return a.delete(t)}function T(t,e){let n=[];e.forEach((r,o)=>{try{let s=r.all?document.querySelectorAll(t):document.querySelector(t);s&&(r.listener(s),r.continuous||n.push(o));}catch(s){}}),n.length>0&&a.set(t,e.filter((r,o)=>!n.includes(o)));}function $(t={}){new MutationObserver(()=>{for(let[n,r]of a.entries())T(n,r);}).observe(document.body,d(u({},t),{childList:!0}));}
-// lib/utils.ts
-function autoPlural(word, num) {
-  if (Array.isArray(num) || num instanceof NodeList)
-    num = num.length;
-  return `${word}${num === 1 ? "" : "s"}`;
-}
-function clamp(value, min, max) {
-  return Math.max(Math.min(value, max), min);
-}
-function pauseFor(time) {
-  return new Promise((res) => {
-    setTimeout(res, time);
-  });
-}
-function debounce(func, timeout = 300) {
-  let timer;
-  return function(...args) {
-    clearTimeout(timer);
-    timer = setTimeout(() => func.apply(this, args), timeout);
-  };
-}
-function getUnsafeWindow() {
-  try {
-    return unsafeWindow;
-  } catch (e) {
-    return window;
-  }
-}
-function insertAfter(beforeElement, afterElement) {
-  var _a;
-  (_a = beforeElement.parentNode) == null ? void 0 : _a.insertBefore(afterElement, beforeElement.nextSibling);
-  return afterElement;
-}
-function addParent(element2, newParent) {
-  const oldParent = element2.parentNode;
-  if (!oldParent)
-    throw new Error("Element doesn't have a parent node");
-  oldParent.replaceChild(newParent, element2);
-  newParent.appendChild(element2);
-  return newParent;
-}
-function addGlobalStyle(style) {
-  const styleElem = document.createElement("style");
-  styleElem.innerHTML = style;
-  document.head.appendChild(styleElem);
-}
-function preloadImages(srcUrls, rejects = false) {
-  const promises = srcUrls.map((src) => new Promise((res, rej) => {
-    const image = new Image();
-    image.src = src;
-    image.addEventListener("load", () => res(image));
-    image.addEventListener("error", (evt) => rejects && rej(evt));
-  }));
-  return Promise.allSettled(promises);
-}
-function fetchAdvanced(_0) {
-  return __async(this, arguments, function* (url, options = {}) {
-    const { timeout = 1e4 } = options;
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), timeout);
-    const res = yield fetch(url, __spreadProps(__spreadValues({}, options), {
-      signal: controller.signal
-    }));
-    clearTimeout(id);
-    return res;
-  });
-}
-function openInNewTab(href) {
-  const openElem = document.createElement("a");
-  Object.assign(openElem, {
-    className: "userutils-open-in-new-tab",
-    target: "_blank",
-    rel: "noopener noreferrer",
-    href
-  });
-  openElem.style.display = "none";
-  document.body.appendChild(openElem);
-  openElem.click();
-  setTimeout(openElem.remove, 50);
-}
-function interceptEvent(eventObject, eventName, predicate) {
-  if (Error.stackTraceLimit < 1e3) {
-    Error.stackTraceLimit = 1e3;
-  }
-  (function(original) {
-    element.__proto__.addEventListener = function(...args) {
-      if (args[0] === eventName && predicate())
-        return;
-      else
-        return original.apply(this, args);
-    };
-  })(eventObject.__proto__.addEventListener);
-}
-function interceptWindowEvent(eventName, predicate) {
-  return interceptEvent(getUnsafeWindow(), eventName, predicate);
-}
-// lib/onSelector.ts
-function onSelector(options, listener) {
-}
-function removeOnSelector(selector) {
-}
-export { addGlobalStyle, addParent, autoPlural, clamp, debounce, fetchAdvanced, getUnsafeWindow, insertAfter, interceptEvent, interceptWindowEvent, onSelector, openInNewTab, pauseFor, preloadImages, removeOnSelector };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map
+export { H as addGlobalStyle, k as addParent, w as autoPlural, M as clamp, A as debounce, j as fetchAdvanced, h as getUnsafeWindow, $ as initOnSelector, _ as insertAfter, O as interceptEvent, P as interceptWindowEvent, W as onSelector, N as openInNewTab, S as pauseFor, I as preloadImages, q as removeOnSelector };

package/package.json CHANGED Viewed

@@ -1,15 +1,16 @@
 {
   "name": "@sv443-network/userutils",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, modify the DOM more easily and more ",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "scripts": {
     "lint": "tsc && eslint .",
-    "prepare-build": "tsup lib/index.ts --format cjs,esm --dts --clean --treeshake",
-    "build": "npm run prepare-build -- --minify",
-    "build-dev": "npm run prepare-build -- --sourcemap --watch"
+    "build-common": "tsup lib/index.ts --format cjs,esm --dts --clean --treeshake",
+    "build": "npm run build-common -- --minify",
+    "dev": "npm run build-common -- --sourcemap --watch",
+    "publish-package": "npm run build && changeset publish"
   },
   "repository": {
     "type": "git",
@@ -43,4 +44,4 @@
     "> 1%",
     "not dead"
   ]
-}
+}

package/dist/index.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"sources":["../lib/utils.ts","../lib/onSelector.ts"],"names":["element"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOO,SAAS,WAAW,MAAc,KAAoC;AAC3E,MAAG,MAAM,QAAQ,GAAG,KAAK,eAAe;AACtC,UAAM,IAAI;AACZ,SAAO,GAAG,IAAI,GAAG,QAAQ,IAAI,KAAK,GAAG;AACvC;AAGO,SAAS,MAAM,OAAe,KAAa,KAAa;AAC7D,SAAO,KAAK,IAAI,KAAK,IAAI,OAAO,GAAG,GAAG,GAAG;AAC3C;AAGO,SAAS,SAAS,MAAc;AACrC,SAAO,IAAI,QAAQ,CAAC,QAAQ;AAC1B,eAAW,KAAK,IAAI;AAAA,EACtB,CAAC;AACH;AAMO,SAAS,SAAgE,MAAa,UAAU,KAAK;AAC1G,MAAI;AACJ,SAAO,YAAY,MAAe;AAChC,iBAAa,KAAK;AAClB,YAAQ,WAAW,MAAM,KAAK,MAAM,MAAM,IAAI,GAAG,OAAO;AAAA,EAC1D;AACF;AAKO,SAAS,kBAAkB;AAChC,MAAI;AAEF,WAAO;AAAA,EACT,SACM,GAAG;AACP,WAAO;AAAA,EACT;AACF;AAMO,SAAS,YAAY,eAA4B,cAA2B;AAtDnF;AAuDE,sBAAc,eAAd,mBAA0B,aAAa,cAAc,cAAc;AACnE,SAAO;AACT;AAMO,SAAS,UAAUA,UAAsB,WAAwB;AACtE,QAAM,YAAYA,SAAQ;AAE1B,MAAG,CAAC;AACF,UAAM,IAAI,MAAM,oCAAoC;AAEtD,YAAU,aAAa,WAAWA,QAAO;AACzC,YAAU,YAAYA,QAAO;AAE7B,SAAO;AACT;AAOO,SAAS,eAAe,OAAe;AAC5C,QAAM,YAAY,SAAS,cAAc,OAAO;AAChD,YAAU,YAAY;AACtB,WAAS,KAAK,YAAY,SAAS;AACrC;AAOO,SAAS,cAAc,SAAmB,UAAU,OAAO;AAChE,QAAM,WAAW,QAAQ,IAAI,SAAO,IAAI,QAAQ,CAAC,KAAK,QAAQ;AAC5D,UAAM,QAAQ,IAAI,MAAM;AACxB,UAAM,MAAM;AACZ,UAAM,iBAAiB,QAAQ,MAAM,IAAI,KAAK,CAAC;AAC/C,UAAM,iBAAiB,SAAS,CAAC,QAAQ,WAAW,IAAI,GAAG,CAAC;AAAA,EAC9D,CAAC,CAAC;AAEF,SAAO,QAAQ,WAAW,QAAQ;AACpC;AAGA,SAAsB,cAAc,IAA8C;AAAA,6CAA9C,KAAa,UAA6B,CAAC,GAAG;AAChF,UAAM,EAAE,UAAU,IAAM,IAAI;AAE5B,UAAM,aAAa,IAAI,gBAAgB;AACvC,UAAM,KAAK,WAAW,MAAM,WAAW,MAAM,GAAG,OAAO;AAEvD,UAAM,MAAM,MAAM,MAAM,KAAK,iCACxB,UADwB;AAAA,MAE3B,QAAQ,WAAW;AAAA,IACrB,EAAC;AAED,iBAAa,EAAE;AACf,WAAO;AAAA,EACT;AAAA;AAQO,SAAS,aAAa,MAAc;AACzC,QAAM,WAAW,SAAS,cAAc,GAAG;AAC3C,SAAO,OAAO,UAAU;AAAA,IACtB,WAAW;AAAA,IACX,QAAQ;AAAA,IACR,KAAK;AAAA,IACL;AAAA,EACF,CAAC;AACD,WAAS,MAAM,UAAU;AAEzB,WAAS,KAAK,YAAY,QAAQ;AAClC,WAAS,MAAM;AAEf,aAAW,SAAS,QAAQ,EAAE;AAChC;AAMO,SAAS,eAA4C,aAAsB,WAAuD,WAA0B;AAGjK,MAAG,MAAM,kBAAkB,KAAM;AAE/B,UAAM,kBAAkB;AAAA,EAC1B;AAEA,GAAC,SAAS,UAA+C;AAEvD,YAAQ,UAAU,mBAAmB,YAAY,MAAuD;AACtG,UAAG,KAAK,CAAC,MAAM,aAAa,UAAU;AACpC;AAAA;AAEA,eAAO,SAAS,MAAM,MAAM,IAAI;AAAA,IACpC;AAAA,EAEF,GAAG,YAAY,UAAU,gBAAgB;AAC3C;AAMO,SAAS,qBAAqB,WAAiC,WAA0B;AAC9F,SAAO,eAAe,gBAAgB,GAAG,WAAW,SAAS;AAC/D;;;AClKO,SAAS,WACd,SACA,UACA;AAGF;AAGO,SAAS,iBAAiB,UAAkB;AAGnD","sourcesContent":["import type { FetchAdvancedOpts } from \"./types\";\n\n/**\n * Automatically appends an `s` to the passed `word`, if `num` is not equal to 1\n * @param word A word in singular form, to auto-convert to plural\n * @param num If this is an array or NodeList, the amount of items is used\n */\nexport function autoPlural(word: string, num: number | unknown[] | NodeList) {\n if(Array.isArray(num) || num instanceof NodeList)\n num = num.length;\n return `${word}${num === 1 ? \"\" : \"s\"}`;\n}\n\n/** Ensures the passed `value` always stays between `min` and `max` */\nexport function clamp(value: number, min: number, max: number) {\n return Math.max(Math.min(value, max), min);\n}\n\n/** Pauses async execution for the specified time in ms */\nexport function pauseFor(time: number) {\n return new Promise((res) => {\n setTimeout(res, time);\n });\n}\n\n/**\n * Calls the passed `func` after the specified `timeout` in ms. \n * Any subsequent calls to this function will reset the timer and discard previous calls.\n */\nexport function debounce<TFunc extends (...args: TArgs[]) => void, TArgs = any>(func: TFunc, timeout = 300) { // eslint-disable-line @typescript-eslint/no-explicit-any\n let timer: number | undefined;\n return function(...args: TArgs[]) {\n clearTimeout(timer);\n timer = setTimeout(() => func.apply(this, args), timeout) as unknown as number;\n };\n}\n\n/**\n * Returns `unsafeWindow` if the `@grant unsafeWindow` is given, otherwise falls back to the regular `window`\n */\nexport function getUnsafeWindow() {\n try {\n // throws ReferenceError if the \"@grant unsafeWindow\" isn't present\n return unsafeWindow;\n }\n catch(e) {\n return window;\n }\n}\n\n/**\n * Inserts `afterElement` as a sibling just after the provided `beforeElement`\n * @returns Returns the `afterElement`\n */\nexport function insertAfter(beforeElement: HTMLElement, afterElement: HTMLElement) {\n beforeElement.parentNode?.insertBefore(afterElement, beforeElement.nextSibling);\n return afterElement;\n}\n\n/**\n * Adds a parent container around the provided element\n * @returns Returns the new parent element\n */\nexport function addParent(element: HTMLElement, newParent: HTMLElement) {\n const oldParent = element.parentNode;\n\n if(!oldParent)\n throw new Error(\"Element doesn't have a parent node\");\n\n oldParent.replaceChild(newParent, element);\n newParent.appendChild(element);\n\n return newParent;\n}\n\n/**\n * Adds global CSS style in the form of a `<style>` element in the document's `<head>` \n * This needs to be run after the `DOMContentLoaded` event has fired on the document object (or instantly if `@run-at document-end` is used).\n * @param style CSS string\n */\nexport function addGlobalStyle(style: string) {\n const styleElem = document.createElement(\"style\");\n styleElem.innerHTML = style;\n document.head.appendChild(styleElem);\n}\n\n/**\n * Preloads an array of image URLs so they can be loaded instantly from the browser cache later on\n * @param rejects If set to `true`, the returned PromiseSettledResults will contain rejections for any of the images that failed to load\n * @returns Returns an array of `PromiseSettledResult` - each resolved result will contain the loaded image element, while each rejected result will contain an `ErrorEvent`\n */\nexport function preloadImages(srcUrls: string[], rejects = false) {\n const promises = srcUrls.map(src => new Promise((res, rej) => {\n const image = new Image();\n image.src = src;\n image.addEventListener(\"load\", () => res(image));\n image.addEventListener(\"error\", (evt) => rejects && rej(evt));\n }));\n\n return Promise.allSettled(promises);\n}\n\n/** Calls the fetch API with special options like a timeout */\nexport async function fetchAdvanced(url: string, options: FetchAdvancedOpts = {}) {\n const { timeout = 10000 } = options;\n\n const controller = new AbortController();\n const id = setTimeout(() => controller.abort(), timeout);\n\n const res = await fetch(url, {\n ...options,\n signal: controller.signal,\n });\n\n clearTimeout(id);\n return res;\n}\n\n/**\n * Creates an invisible anchor with a `_blank` target and clicks it. \n * Contrary to `window.open()`, this has a lesser chance to get blocked by the browser's popup blocker and doesn't open the URL as a new window. \n * \n * This function has to be run in relatively quick succession in response to a user interaction event, else the browser might reject it.\n */\nexport function openInNewTab(href: string) {\n const openElem = document.createElement(\"a\");\n Object.assign(openElem, {\n className: \"userutils-open-in-new-tab\",\n target: \"_blank\",\n rel: \"noopener noreferrer\",\n href,\n });\n openElem.style.display = \"none\";\n\n document.body.appendChild(openElem);\n openElem.click();\n // timeout just to be safe\n setTimeout(openElem.remove, 50);\n}\n\n/**\n * Intercepts the specified event on the passed object and prevents it from being called if the called `predicate` function returns a truthy value. \n * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.\n */\nexport function interceptEvent<TEvtObj extends EventTarget>(eventObject: TEvtObj, eventName: Parameters<TEvtObj[\"addEventListener\"]>[0], predicate: () => boolean) { \n // default is between 10 and 100 on conventional browsers so this should hopefully be more than enough\n // @ts-ignore\n if(Error.stackTraceLimit < 1000) {\n // @ts-ignore\n Error.stackTraceLimit = 1000;\n }\n\n (function(original: typeof eventObject.addEventListener) {\n // @ts-ignore\n element.__proto__.addEventListener = function(...args: Parameters<typeof eventObject.addEventListener>) {\n if(args[0] === eventName && predicate())\n return;\n else\n return original.apply(this, args);\n };\n // @ts-ignore\n })(eventObject.__proto__.addEventListener);\n}\n\n/**\n * Intercepts the specified event on the window object and prevents it from being called if the called `predicate` function returns a truthy value. \n * Calling this function will set the `stackTraceLimit` to 1000 to ensure the stack trace is preserved.\n */\nexport function interceptWindowEvent(eventName: keyof WindowEventMap, predicate: () => boolean) { \n return interceptEvent(getUnsafeWindow(), eventName, predicate);\n}\n","import { SelectorExistsOpts } from \"./types\";\n\n/**\n * Calls the `listener` as soon as the `selector` exists in the DOM. \n * Listeners are deleted when they are called once, unless `options.continuous` is set. \n * Multiple listeners with the same selector may be registered.\n * @template TElem The type of element that this selector will return - FIXME: listener inferring doesn't work when this generic is given\n */\nexport function onSelector<TElem = HTMLElement, TOpts extends SelectorExistsOpts = SelectorExistsOpts>(\n options: TOpts,\n listener: (element: TOpts[\"all\"] extends true ? (TElem extends HTMLElement ? NodeListOf<TElem> : TElem) : TElem) => void,\n) {\n // TODO:\n void [options, listener];\n}\n\n/** Removes all listeners registered in `onSelector()` with a matching selector property */\nexport function removeOnSelector(selector: string) {\n // TODO:\n void [selector];\n}\n"]}

package/dist/index.mjs.map DELETED Viewed

@@ -1 +0,0 @@