@sv443-network/userutils 9.0.4 → 9.2.0

package/dist/index.global.js

@@ -7,8 +7,8 @@
 
 // ==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.4
+// @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
+// @version      9.2.0
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 
@@ -117,13 +117,21 @@ var UserUtils = (function (exports) {
     } else
       return Math.floor(Math.random() * (max - min + 1)) + min;
   }
-  function digitCount(num) {
+  function digitCount(num, withDecimals = true) {
     num = Number(!["string", "number"].includes(typeof num) ? String(num) : num);
     if (typeof num === "number" && isNaN(num))
       return NaN;
-    return num === 0 ? 1 : Math.floor(
-      Math.log10(Math.abs(Number(num))) + 1
-    );
+    const [intPart, decPart] = num.toString().split(".");
+    const intDigits = intPart === "0" ? 1 : Math.floor(Math.log10(Math.abs(Number(intPart))) + 1);
+    const decDigits = withDecimals && decPart ? decPart.length : 0;
+    return intDigits + decDigits;
+  }
+  function roundFixed(num, fractionDigits) {
+    const scale = 10 ** fractionDigits;
+    return Math.round(num * scale) / scale;
+  }
+  function bitSetHas(bitSet, checkVal) {
+    return (bitSet & checkVal) === checkVal;
   }
 
   // lib/array.ts
@@ -148,7 +156,7 @@ var UserUtils = (function (exports) {
     if (array.length === 0)
       return retArray;
     for (let i = retArray.length - 1; i > 0; i--) {
-      const j = Math.floor(randRange(0, 1e4) / 1e4 * (i + 1));
+      const j = Math.floor(Math.random() * (i + 1));
       [retArray[i], retArray[j]] = [retArray[j], retArray[i]];
     }
     return retArray;
@@ -191,10 +199,10 @@ var UserUtils = (function (exports) {
     else if (color.startsWith("rgb")) {
       const rgbValues = (_a = color.match(/\d+(\.\d+)?/g)) == null ? undefined : _a.map(Number);
       if (!rgbValues)
-        throw new Error("Invalid RGB/RGBA color format");
+        throw new TypeError("Invalid RGB/RGBA color format");
       [r, g, b, a] = rgbValues;
     } else
-      throw new Error("Unsupported color format");
+      throw new TypeError("Unsupported color format");
     [r, g, b] = darkenRgb(r, g, b, percent);
     if (isHexCol)
       return rgbToHex(r, g, b, a, color.startsWith("#"), upperCase);
@@ -203,10 +211,39 @@ var UserUtils = (function (exports) {
     else if (color.startsWith("rgb"))
       return `rgb(${r}, ${g}, ${b})`;
     else
-      throw new Error("Unsupported color format");
+      throw new TypeError("Unsupported color format");
   }
 
+  // lib/errors.ts
+  var UUError = class extends Error {
+    constructor(message, options) {
+      super(message, options);
+      __publicField(this, "date");
+      this.date = /* @__PURE__ */ new Date();
+    }
+  };
+  var ChecksumMismatchError = class extends UUError {
+    constructor(message, options) {
+      super(message, options);
+      this.name = "ChecksumMismatchError";
+    }
+  };
+  var MigrationError = class extends UUError {
+    constructor(message, options) {
+      super(message, options);
+      this.name = "MigrationError";
+    }
+  };
+  var PlatformError = class extends UUError {
+    constructor(message, options) {
+      super(message, options);
+      this.name = "PlatformError";
+    }
+  };
+
   // lib/dom.ts
+  var domReady = false;
+  document.addEventListener("DOMContentLoaded", () => domReady = true);
   function getUnsafeWindow() {
     try {
       return unsafeWindow;
@@ -262,8 +299,8 @@ var UserUtils = (function (exports) {
   }
   function interceptEvent(eventObject, eventName, predicate = () => true) {
     var _a;
-    if ((eventObject === window || eventObject === getUnsafeWindow()) && ((_a = GM == null ? undefined : GM.info) == null ? undefined : _a.scriptHandler) && GM.info.scriptHandler === "FireMonkey")
-      throw new Error("Intercepting window events is not supported on FireMonkey due to the isolated context the userscript runs in.");
+    if (((_a = GM == null ? undefined : GM.info) == null ? undefined : _a.scriptHandler) && GM.info.scriptHandler === "FireMonkey" && (eventObject === window || eventObject === getUnsafeWindow()))
+      throw new PlatformError("Intercepting window events is not supported on FireMonkey due to the isolated context the userscript runs in.");
     Error.stackTraceLimit = Math.max(Error.stackTraceLimit, 100);
     if (isNaN(Error.stackTraceLimit))
       Error.stackTraceLimit = 100;
@@ -345,6 +382,36 @@ var UserUtils = (function (exports) {
     element.innerHTML = (_c = (_b = ttPolicy == null ? undefined : ttPolicy.createHTML) == null ? undefined : _b.call(ttPolicy, html)) != null ? _c : html;
     return element;
   }
+  function probeElementStyle(probeStyle, element, hideOffscreen = true, parentElement = document.body) {
+    const el = element ? typeof element === "function" ? element() : element : document.createElement("span");
+    if (hideOffscreen) {
+      el.style.position = "absolute";
+      el.style.left = "-9999px";
+      el.style.top = "-9999px";
+      el.style.zIndex = "-9999";
+    }
+    el.classList.add("_uu_probe_element");
+    parentElement.appendChild(el);
+    const style = window.getComputedStyle(el);
+    const result = probeStyle(style, el);
+    setTimeout(() => el.remove(), 1);
+    return result;
+  }
+  function isDomLoaded() {
+    return domReady;
+  }
+  function onDomLoad(cb) {
+    return new Promise((res) => {
+      if (domReady) {
+        cb == null ? undefined : cb();
+        res();
+      } else
+        document.addEventListener("DOMContentLoaded", () => {
+          cb == null ? undefined : cb();
+          res();
+        });
+    });
+  }
 
   // lib/crypto.ts
   function compress(input, compressionFormat, outputType = "string") {
@@ -392,6 +459,8 @@ var UserUtils = (function (exports) {
     });
   }
   function randomId(length = 16, radix = 16, enhancedEntropy = false, randomCase = true) {
+    if (radix < 2 || radix > 36)
+      throw new RangeError("The radix argument must be between 2 and 36");
     let arr = [];
     const caseArr = randomCase ? [0, 1] : [0];
     if (enhancedEntropy) {
@@ -565,8 +634,7 @@ var UserUtils = (function (exports) {
               lastFmtVer = oldFmtVer = ver;
             } catch (err) {
               if (!resetOnError)
-                throw new Error(`Error while running migration function for format version '${fmtVer}'`);
-              console.error(`Error while running migration function for format version '${fmtVer}' - resetting to the default value.`, err);
+                throw new MigrationError(`Error while running migration function for format version '${fmtVer}'`, { cause: err });
               yield this.saveDefaultData();
               return this.getData();
             }
@@ -627,7 +695,6 @@ var UserUtils = (function (exports) {
         return JSON.parse(decRes != null ? decRes : data);
       });
     }
-    //#region misc
     /** Copies a JSON-compatible object and loses all its internal references in the process */
     deepCopy(obj) {
       return JSON.parse(JSON.stringify(obj));
@@ -679,7 +746,7 @@ var UserUtils = (function (exports) {
   };
 
   // lib/DataStoreSerializer.ts
-  var DataStoreSerializer = class {
+  var DataStoreSerializer = class _DataStoreSerializer {
     constructor(stores, options = {}) {
       __publicField(this, "stores");
       __publicField(this, "options");
@@ -697,27 +764,25 @@ var UserUtils = (function (exports) {
         return computeHash(input, "SHA-256");
       });
     }
-    /** Serializes a DataStore instance */
-    serializeStore(storeInst) {
-      return __async(this, null, function* () {
-        const data = storeInst.encodingEnabled() ? yield storeInst.encodeData(JSON.stringify(storeInst.getData())) : JSON.stringify(storeInst.getData());
-        const checksum = this.options.addChecksum ? yield this.calcChecksum(data) : undefined;
-        return {
-          id: storeInst.id,
-          data,
-          formatVersion: storeInst.formatVersion,
-          encoded: storeInst.encodingEnabled(),
-          checksum
-        };
-      });
-    }
-    /** Serializes the data stores into a string */
-    serialize() {
+    /**
+     * Serializes the data stores into a string.  
+     * @param useEncoding Whether to encode the data using each DataStore's `encodeData()` method
+     * @param stringified Whether to return the result as a string or as an array of `SerializedDataStore` objects
+     */
+    serialize(useEncoding = true, stringified = true) {
       return __async(this, null, function* () {
         const serData = [];
-        for (const store of this.stores)
-          serData.push(yield this.serializeStore(store));
-        return JSON.stringify(serData);
+        for (const storeInst of this.stores) {
+          const data = useEncoding && storeInst.encodingEnabled() ? yield storeInst.encodeData(JSON.stringify(storeInst.getData())) : JSON.stringify(storeInst.getData());
+          serData.push({
+            id: storeInst.id,
+            data,
+            formatVersion: storeInst.formatVersion,
+            encoded: useEncoding && storeInst.encodingEnabled(),
+            checksum: this.options.addChecksum ? yield this.calcChecksum(data) : undefined
+          });
+        }
+        return stringified ? JSON.stringify(serData) : serData;
       });
     }
     /**
@@ -726,7 +791,9 @@ var UserUtils = (function (exports) {
      */
     deserialize(serializedData) {
       return __async(this, null, function* () {
-        const deserStores = JSON.parse(serializedData);
+        const deserStores = typeof serializedData === "string" ? JSON.parse(serializedData) : serializedData;
+        if (!Array.isArray(deserStores) || !deserStores.every(_DataStoreSerializer.isSerializedDataStore))
+          throw new TypeError("Invalid serialized data format! Expected an array of SerializedDataStore objects.");
         for (const storeData of deserStores) {
           const storeInst = this.stores.find((s) => s.id === storeData.id);
           if (!storeInst)
@@ -734,7 +801,7 @@ var UserUtils = (function (exports) {
           if (this.options.ensureIntegrity && typeof storeData.checksum === "string") {
             const checksum = yield this.calcChecksum(storeData.data);
             if (checksum !== storeData.checksum)
-              throw new Error(`Checksum mismatch for DataStore with ID "${storeData.id}"!
+              throw new ChecksumMismatchError(`Checksum mismatch for DataStore with ID "${storeData.id}"!
 Expected: ${storeData.checksum}
 Has: ${checksum}`);
           }
@@ -778,6 +845,10 @@ Has: ${checksum}`);
         return Promise.allSettled(this.stores.map((store) => store.deleteData()));
       });
     }
+    /** Checks if a given value is a SerializedDataStore object */
+    static isSerializedDataStore(obj) {
+      return typeof obj === "object" && obj !== null && "id" in obj && "data" in obj && "formatVersion" in obj && "encoded" in obj;
+    }
   };
 
   // node_modules/.pnpm/nanoevents@9.1.0/node_modules/nanoevents/index.js
@@ -937,7 +1008,7 @@ Has: ${checksum}`);
           }, this.timeout);
           break;
         default:
-          throw new Error(`Invalid debouncer type: ${this.type}`);
+          throw new TypeError(`Invalid debouncer type: ${this.type}`);
       }
     }
   };
@@ -1369,10 +1440,23 @@ Has: ${checksum}`);
   };
 
   // lib/misc.ts
-  function autoPlural(word, num) {
-    if (Array.isArray(num) || num instanceof NodeList)
-      num = num.length;
-    return `${word}${num === 1 ? "" : "s"}`;
+  function autoPlural(term, num, pluralType = "auto") {
+    let n = num;
+    if (typeof n !== "number")
+      n = getListLength(n, false);
+    if (!["-s", "-ies"].includes(pluralType))
+      pluralType = "auto";
+    if (isNaN(n))
+      n = 2;
+    const pType = pluralType === "auto" ? String(term).endsWith("y") ? "-ies" : "-s" : pluralType;
+    switch (pType) {
+      case "-s":
+        return `${term}${n === 1 ? "" : "s"}`;
+      case "-ies":
+        return `${String(term).slice(0, -1)}${n === 1 ? "y" : "ies"}`;
+      default:
+        return String(term);
+    }
   }
   function insertValues(input, ...values) {
     return input.replace(/%\d/gm, (match) => {
@@ -1381,29 +1465,33 @@ Has: ${checksum}`);
       return (_b = (_a = values[argIndex]) != null ? _a : match) == null ? undefined : _b.toString();
     });
   }
-  function pauseFor(time) {
-    return new Promise((res) => {
-      setTimeout(() => res(), time);
+  function pauseFor(time, signal, rejectOnAbort = false) {
+    return new Promise((res, rej) => {
+      const timeout = setTimeout(() => res(), time);
+      signal == null ? undefined : signal.addEventListener("abort", () => {
+        clearTimeout(timeout);
+        rejectOnAbort ? rej(new Error("The pause was aborted")) : res();
+      });
     });
   }
   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 ? undefined : _a.addEventListener("abort", abort);
-      let signalOpts = {}, id = undefined;
+      const ctl = new AbortController();
+      const _a = options, { signal } = _a, restOpts = __objRest(_a, ["signal"]);
+      signal == null ? undefined : signal.addEventListener("abort", () => ctl.abort());
+      let sigOpts = {}, id = undefined;
       if (timeout >= 0) {
-        id = setTimeout(() => abort(), timeout);
-        signalOpts = { signal };
+        id = setTimeout(() => ctl.abort(), timeout);
+        sigOpts = { signal: ctl.signal };
       }
       try {
-        const res = yield fetch(input, __spreadValues(__spreadValues({}, options), signalOpts));
-        id && clearTimeout(id);
+        const res = yield fetch(input, __spreadValues(__spreadValues({}, restOpts), sigOpts));
+        typeof id !== "undefined" && clearTimeout(id);
         return res;
       } catch (err) {
-        id && clearTimeout(id);
-        throw err;
+        typeof id !== "undefined" && clearTimeout(id);
+        throw new Error("Error while calling fetch", { cause: err });
       }
     });
   }
@@ -1419,10 +1507,11 @@ Has: ${checksum}`);
       );
     });
   }
+  function getListLength(obj, zeroOnInvalid = true) {
+    return "length" in obj ? obj.length : "size" in obj ? obj.size : "count" in obj ? obj.count : zeroOnInvalid ? 0 : NaN;
+  }
 
   // lib/SelectorObserver.ts
-  var domLoaded = false;
-  document.addEventListener("DOMContentLoaded", () => domLoaded = true);
   var SelectorObserver = class {
     constructor(baseElement, options = {}) {
       __publicField(this, "enabled", false);
@@ -1463,7 +1552,7 @@ Has: ${checksum}`);
     }
     /** Call to check all selectors in the {@linkcode listenerMap} using {@linkcode checkSelector()} */
     checkAllSelectors() {
-      if (!this.enabled || !domLoaded)
+      if (!this.enabled || !isDomLoaded())
         return;
       for (const [selector, listeners] of this.listenerMap.entries())
         this.checkSelector(selector, listeners);
@@ -1607,9 +1696,9 @@ Has: ${checksum}`);
     if (typeof language !== "string" || language.length === 0 || typeof trObj !== "object" || trObj === null)
       return fallbackLang ? translate(fallbackLang, key, ...trArgs) : key;
     const transformTrVal = (trKey, trValue) => {
-      const tfs = valTransforms.filter(({ regex }) => new RegExp(regex).test(trValue));
+      const tfs = valTransforms.filter(({ regex }) => new RegExp(regex).test(String(trValue)));
       if (tfs.length === 0)
-        return trValue;
+        return String(trValue);
       let retStr = String(trValue);
       for (const tf of tfs) {
         const re = new RegExp(tf.regex);
@@ -1758,15 +1847,20 @@ Has: ${checksum}`);
     }
   };
 
+  exports.ChecksumMismatchError = ChecksumMismatchError;
   exports.DataStore = DataStore;
   exports.DataStoreSerializer = DataStoreSerializer;
   exports.Debouncer = Debouncer;
   exports.Dialog = Dialog;
+  exports.MigrationError = MigrationError;
   exports.NanoEmitter = NanoEmitter;
+  exports.PlatformError = PlatformError;
   exports.SelectorObserver = SelectorObserver;
+  exports.UUError = UUError;
   exports.addGlobalStyle = addGlobalStyle;
   exports.addParent = addParent;
   exports.autoPlural = autoPlural;
+  exports.bitSetHas = bitSetHas;
   exports.clamp = clamp;
   exports.compress = compress;
   exports.computeHash = computeHash;
@@ -1779,26 +1873,31 @@ Has: ${checksum}`);
   exports.defaultStrings = defaultStrings;
   exports.digitCount = digitCount;
   exports.fetchAdvanced = fetchAdvanced;
+  exports.getListLength = getListLength;
   exports.getSiblingsFrame = getSiblingsFrame;
   exports.getUnsafeWindow = getUnsafeWindow;
   exports.hexToRgb = hexToRgb;
   exports.insertValues = insertValues;
   exports.interceptEvent = interceptEvent;
   exports.interceptWindowEvent = interceptWindowEvent;
+  exports.isDomLoaded = isDomLoaded;
   exports.isScrollable = isScrollable;
   exports.lightenColor = lightenColor;
   exports.mapRange = mapRange;
   exports.observeElementProp = observeElementProp;
+  exports.onDomLoad = onDomLoad;
   exports.openDialogs = openDialogs;
   exports.openInNewTab = openInNewTab;
   exports.pauseFor = pauseFor;
   exports.preloadImages = preloadImages;
+  exports.probeElementStyle = probeElementStyle;
   exports.randRange = randRange;
   exports.randomId = randomId;
   exports.randomItem = randomItem;
   exports.randomItemIndex = randomItemIndex;
   exports.randomizeArray = randomizeArray;
   exports.rgbToHex = rgbToHex;
+  exports.roundFixed = roundFixed;
   exports.setInnerHtmlUnsafe = setInnerHtmlUnsafe;
   exports.takeRandomItem = takeRandomItem;
   exports.tr = tr;