@sv443-network/userutils 8.3.2 → 8.4.0

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.3.2
+// @version      8.4.0
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 
@@ -48,10 +48,7 @@ var UserUtils = (function (exports) {
       }
     return target;
   };
-  var __publicField = (obj, key, value) => {
-    __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-    return value;
-  };
+  var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   var __async = (__this, __arguments, generator) => {
     return new Promise((resolve, reject) => {
       var fulfilled = (value) => {
@@ -75,14 +72,17 @@ var UserUtils = (function (exports) {
 
   // lib/math.ts
   function clamp(value, min, max) {
+    if (typeof max !== "number") {
+      max = min;
+      min = 0;
+    }
     return Math.max(Math.min(value, max), min);
   }
   function mapRange(value, range1min, range1max, range2min, range2max) {
-    if (typeof range2min === "undefined" || range2max === void 0) {
+    if (typeof range2min === "undefined" || typeof range2max === "undefined") {
       range2max = range1max;
-      range2min = 0;
       range1max = range1min;
-      range1min = 0;
+      range2min = range1min = 0;
     }
     if (Number(range1min) === 0 && Number(range2min) === 0)
       return value * (range2max / range1max);
@@ -96,7 +96,7 @@ var UserUtils = (function (exports) {
       min = 0;
       [max] = args;
     } else
-      throw new TypeError(`Wrong parameter(s) provided - expected: "number" and "number|undefined", got: "${typeof args[0]}" and "${typeof args[1]}"`);
+      throw new TypeError(`Wrong parameter(s) provided - expected (number, boolean|undefined) or (number, number, boolean|undefined) but got (${args.map((a) => typeof a).join(", ")}) instead`);
     if (typeof args[2] === "boolean")
       enhancedEntropy = args[2];
     else if (typeof args[1] === "boolean")
@@ -117,6 +117,14 @@ var UserUtils = (function (exports) {
     } else
       return Math.floor(Math.random() * (max - min + 1)) + min;
   }
+  function digitCount(num) {
+    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
+    );
+  }
 
   // lib/array.ts
   function randomItem(array) {
@@ -766,10 +774,10 @@ Has: ${checksum}`);
     }
   };
 
-  // node_modules/nanoevents/index.js
+  // node_modules/.pnpm/nanoevents@9.1.0/node_modules/nanoevents/index.js
   var createNanoEvents = () => ({
     emit(event, ...args) {
-      for (let i = 0, callbacks = this.events[event] || [], length = callbacks.length; i < length; i++) {
+      for (let callbacks = this.events[event] || [], i = 0, length = callbacks.length; i < length; i++) {
         callbacks[i](...args);
       }
     },
@@ -1181,8 +1189,7 @@ Has: ${checksum}`);
           if (interactionKeys.includes(e.key)) {
             preventDefault && e.preventDefault();
             stopPropagation && e.stopPropagation();
-          } else
-            return;
+          } else return;
         } else if (e instanceof MouseEvent) {
           preventDefault && e.preventDefault();
           stopPropagation && e.stopPropagation();
@@ -1308,6 +1315,18 @@ Has: ${checksum}`);
       }
     });
   }
+  function consumeGen(valGen) {
+    return __async(this, null, function* () {
+      return yield typeof valGen === "function" ? valGen() : valGen;
+    });
+  }
+  function consumeStringGen(strGen) {
+    return __async(this, null, function* () {
+      return typeof strGen === "string" ? strGen : String(
+        typeof strGen === "function" ? yield strGen() : strGen
+      );
+    });
+  }
 
   // lib/SelectorObserver.ts
   var domLoaded = false;
@@ -1487,23 +1506,28 @@ Has: ${checksum}`);
 
   // lib/translation.ts
   var trans = {};
-  var curLang;
-  var trLang = (language, key, ...args) => {
+  var curLang = "";
+  function translate(language, key, ...args) {
     var _a;
-    if (!language)
-      return key;
-    const trText = (_a = trans[language]) == null ? void 0 : _a[key];
-    if (!trText)
+    const trObj = (_a = trans[language]) == null ? void 0 : _a.data;
+    if (typeof language !== "string" || typeof trObj !== "object" || trObj === null)
       return key;
-    if (args.length > 0 && trText.match(/%\d/)) {
-      return insertValues(trText, ...args);
-    }
-    return trText;
-  };
-  function tr(key, ...args) {
-    return trLang(curLang, key, ...args);
+    const keyParts = key.split(".");
+    let value = trObj;
+    for (const part of keyParts) {
+      if (typeof value !== "object" || value === null)
+        break;
+      value = value == null ? void 0 : value[part];
+    }
+    if (typeof value === "string")
+      return insertValues(value, args);
+    value = trObj == null ? void 0 : trObj[key];
+    if (typeof value === "string")
+      return insertValues(value, args);
+    return key;
   }
-  tr.forLang = trLang;
+  var tr = (key, ...args) => translate(curLang, key, ...args);
+  tr.forLang = translate;
   tr.addLanguage = (language, translations) => {
     trans[language] = translations;
   };
@@ -1528,11 +1552,14 @@ Has: ${checksum}`);
   exports.clamp = clamp;
   exports.compress = compress;
   exports.computeHash = computeHash;
+  exports.consumeGen = consumeGen;
+  exports.consumeStringGen = consumeStringGen;
   exports.darkenColor = darkenColor;
   exports.debounce = debounce;
   exports.decompress = decompress;
   exports.defaultDialogCss = defaultDialogCss;
   exports.defaultStrings = defaultStrings;
+  exports.digitCount = digitCount;
   exports.fetchAdvanced = fetchAdvanced;
   exports.getSiblingsFrame = getSiblingsFrame;
   exports.getUnsafeWindow = getUnsafeWindow;

package/dist/index.js

@@ -28,10 +28,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -55,14 +52,17 @@ var __async = (__this, __arguments, generator) => {
 
 // lib/math.ts
 function clamp(value, min, max) {
+  if (typeof max !== "number") {
+    max = min;
+    min = 0;
+  }
   return Math.max(Math.min(value, max), min);
 }
 function mapRange(value, range1min, range1max, range2min, range2max) {
-  if (typeof range2min === "undefined" || range2max === void 0) {
+  if (typeof range2min === "undefined" || typeof range2max === "undefined") {
     range2max = range1max;
-    range2min = 0;
     range1max = range1min;
-    range1min = 0;
+    range2min = range1min = 0;
   }
   if (Number(range1min) === 0 && Number(range2min) === 0)
     return value * (range2max / range1max);
@@ -76,7 +76,7 @@ function randRange(...args) {
     min = 0;
     [max] = args;
   } else
-    throw new TypeError(`Wrong parameter(s) provided - expected: "number" and "number|undefined", got: "${typeof args[0]}" and "${typeof args[1]}"`);
+    throw new TypeError(`Wrong parameter(s) provided - expected (number, boolean|undefined) or (number, number, boolean|undefined) but got (${args.map((a) => typeof a).join(", ")}) instead`);
   if (typeof args[2] === "boolean")
     enhancedEntropy = args[2];
   else if (typeof args[1] === "boolean")
@@ -97,6 +97,14 @@ function randRange(...args) {
   } else
     return Math.floor(Math.random() * (max - min + 1)) + min;
 }
+function digitCount(num) {
+  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
+  );
+}
 
 // lib/array.ts
 function randomItem(array) {
@@ -1141,8 +1149,7 @@ var Dialog = class _Dialog extends NanoEmitter {
         if (interactionKeys.includes(e.key)) {
           preventDefault && e.preventDefault();
           stopPropagation && e.stopPropagation();
-        } else
-          return;
+        } else return;
       } else if (e instanceof MouseEvent) {
         preventDefault && e.preventDefault();
         stopPropagation && e.stopPropagation();
@@ -1268,6 +1275,18 @@ function fetchAdvanced(_0) {
     }
   });
 }
+function consumeGen(valGen) {
+  return __async(this, null, function* () {
+    return yield typeof valGen === "function" ? valGen() : valGen;
+  });
+}
+function consumeStringGen(strGen) {
+  return __async(this, null, function* () {
+    return typeof strGen === "string" ? strGen : String(
+      typeof strGen === "function" ? yield strGen() : strGen
+    );
+  });
+}
 
 // lib/SelectorObserver.ts
 var domLoaded = false;
@@ -1447,23 +1466,28 @@ var SelectorObserver = class {
 
 // lib/translation.ts
 var trans = {};
-var curLang;
-var trLang = (language, key, ...args) => {
+var curLang = "";
+function translate(language, key, ...args) {
   var _a;
-  if (!language)
+  const trObj = (_a = trans[language]) == null ? void 0 : _a.data;
+  if (typeof language !== "string" || typeof trObj !== "object" || trObj === null)
     return key;
-  const trText = (_a = trans[language]) == null ? void 0 : _a[key];
-  if (!trText)
-    return key;
-  if (args.length > 0 && trText.match(/%\d/)) {
-    return insertValues(trText, ...args);
+  const keyParts = key.split(".");
+  let value = trObj;
+  for (const part of keyParts) {
+    if (typeof value !== "object" || value === null)
+      break;
+    value = value == null ? void 0 : value[part];
   }
-  return trText;
-};
-function tr(key, ...args) {
-  return trLang(curLang, key, ...args);
+  if (typeof value === "string")
+    return insertValues(value, args);
+  value = trObj == null ? void 0 : trObj[key];
+  if (typeof value === "string")
+    return insertValues(value, args);
+  return key;
 }
-tr.forLang = trLang;
+var tr = (key, ...args) => translate(curLang, key, ...args);
+tr.forLang = translate;
 tr.addLanguage = (language, translations) => {
   trans[language] = translations;
 };
@@ -1477,4 +1501,4 @@ tr.getTranslations = (language) => {
   return trans[language != null ? language : curLang];
 };
 
-export { DataStore, DataStoreSerializer, Dialog, NanoEmitter, SelectorObserver, addGlobalStyle, addParent, autoPlural, clamp, compress, computeHash, currentDialogId, darkenColor, debounce, decompress, defaultDialogCss, defaultStrings, fetchAdvanced, getSiblingsFrame, getUnsafeWindow, hexToRgb, insertValues, interceptEvent, interceptWindowEvent, isScrollable, lightenColor, mapRange, observeElementProp, openDialogs, openInNewTab, pauseFor, preloadImages, randRange, randomId, randomItem, randomItemIndex, randomizeArray, rgbToHex, setInnerHtmlUnsafe, takeRandomItem, tr };
+export { DataStore, DataStoreSerializer, Dialog, NanoEmitter, SelectorObserver, addGlobalStyle, addParent, autoPlural, clamp, compress, computeHash, consumeGen, consumeStringGen, currentDialogId, darkenColor, debounce, decompress, defaultDialogCss, defaultStrings, digitCount, fetchAdvanced, getSiblingsFrame, getUnsafeWindow, hexToRgb, insertValues, interceptEvent, interceptWindowEvent, isScrollable, lightenColor, mapRange, observeElementProp, openDialogs, openInNewTab, pauseFor, preloadImages, randRange, randomId, randomItem, randomItemIndex, randomizeArray, rgbToHex, setInnerHtmlUnsafe, takeRandomItem, tr };

package/dist/lib/DataStore.d.ts

@@ -1,4 +1,3 @@
-/// <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>;

package/dist/lib/math.d.ts

@@ -1,5 +1,8 @@
+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;
+/** Ensures the passed {@linkcode value} always stays between 0 and {@linkcode max} */
+export declare function clamp(value: number, max: number): number;
 /**
  * Transforms the value parameter from the numerical range `range1min` to `range1max` to the numerical range `range2min` to `range2max`
  * For example, you can map the value 2 in the range of 0-5 to the range of 0-10 and you'd get a 4 as a result.
@@ -20,3 +23,5 @@ export declare function randRange(min: number, max: number, enhancedEntropy?: bo
  * Set {@linkcode enhancedEntropy} to true to use `crypto.getRandomValues()` for better cryptographic randomness (this also makes it take longer to generate)
  */
 export declare function randRange(max: number, enhancedEntropy?: boolean): number;
+/** Calculates the amount of digits in the given number - the given number or string will be passed to the `Number()` constructor. Returns NaN if the number is invalid. */
+export declare function digitCount(num: number | Stringifiable): number;

package/dist/lib/misc.d.ts

@@ -29,4 +29,25 @@ export type FetchAdvancedOpts = Prettify<Partial<{
     timeout: number;
 }> & RequestInit>;
 /** Calls the fetch API with special options like a timeout */
-export declare function fetchAdvanced(input: RequestInfo | URL, options?: FetchAdvancedOpts): Promise<Response>;
+export declare function fetchAdvanced(input: string | RequestInfo | URL, options?: FetchAdvancedOpts): Promise<Response>;
+/**
+ * A ValueGen value is either its type, a promise that resolves to its type, or a function that returns its type, either synchronous or asynchronous.
+ * ValueGen allows for the utmost flexibility when applied to any type, as long as {@linkcode consumeGen()} is used to get the final value.
+ * @template TValueType The type of the value that the ValueGen should yield
+ */
+export type ValueGen<TValueType> = TValueType | Promise<TValueType> | (() => TValueType | Promise<TValueType>);
+/**
+ * Turns a {@linkcode ValueGen} into its final value.
+ * @template TValueType The type of the value that the ValueGen should yield
+ */
+export declare function consumeGen<TValueType>(valGen: ValueGen<TValueType>): Promise<TValueType>;
+/**
+ * A StringGen value is either a string, anything that can be converted to a string, or a function that returns one of the previous two, either synchronous or asynchronous, or a promise that returns a string.
+ * StringGen allows for the utmost flexibility when dealing with strings, as long as {@linkcode consumeStringGen()} is used to get the final string.
+ */
+export type StringGen = ValueGen<Stringifiable>;
+/**
+ * Turns a {@linkcode StringGen} into its final string value.
+ * @template TStrUnion The union of strings that the StringGen should yield - this allows for finer type control compared to {@linkcode consumeGen()}
+ */
+export declare function consumeStringGen<TStrUnion extends string>(strGen: StringGen): Promise<TStrUnion>;

package/dist/lib/translation.d.ts

@@ -1,4 +1,28 @@
 import type { Stringifiable } from "./types.js";
+/**
+ * Translation object to pass to {@linkcode tr.addLanguage()}
+ * Can be a flat object of identifier keys and the translation text as the value, or an infinitely nestable object containing the same.
+ *
+ * @example
+ * // Flat object:
+ * const tr_en: TrObject = {
+ *   hello: "Hello, %1!",
+ *   foo: "Foo",
+ * };
+ *
+ * // Nested object:
+ * const tr_de: TrObject = {
+ *   hello: "Hallo, %1!",
+ *   foo: {
+ *     bar: "Foo bar",
+ *   },
+ * };
+ */
+export interface TrObject {
+    [key: string]: string | TrObject;
+}
+/** Common function to resolve the translation text in a specific language. */
+declare function translate(language: string, key: string, ...args: Stringifiable[]): string;
 /**
  * Returns the translated text for the specified key in the current language set by {@linkcode tr.setLanguage()}
  * Use {@linkcode tr.forLang()} to get the translation for a specific language instead of the currently set one.
@@ -8,12 +32,21 @@ import type { Stringifiable } from "./types.js";
  * @param key Key of the translation to return
  * @param args Optional arguments to be passed to the translated text. They will replace placeholders in the format `%n`, where `n` is the 1-indexed argument number
  */
-declare function tr(key: string, ...args: Stringifiable[]): string;
-declare namespace tr {
-    var forLang: (language: string, key: string, ...args: Stringifiable[]) => string;
-    var addLanguage: (language: string, translations: Record<string, string>) => void;
-    var setLanguage: (language: string) => void;
-    var getLanguage: () => string;
-    var getTranslations: (language?: string | undefined) => Record<string, string> | undefined;
-}
+declare const tr: {
+    (key: string, ...args: Stringifiable[]): string;
+    /**
+     * Returns the translated text for the specified key in the specified language.
+     * If the key is not found in the specified previously registered translation, the key itself is returned.
+     *
+     * ⚠️ Remember to register a language with {@linkcode tr.addLanguage()} before using this function, otherwise it will always return the key itself.
+     * @param language Language to use for the translation
+     * @param key Key of the translation to return
+     * @param args Optional arguments to be passed to the translated text. They will replace placeholders in the format `%n`, where `n` is the 1-indexed argument number
+     */
+    forLang: typeof translate;
+    addLanguage(language: string, translations: TrObject): void;
+    setLanguage(language: string): void;
+    getLanguage(): string;
+    getTranslations(language?: string): TrObject | undefined;
+};
 export { tr };

package/dist/lib/types.d.ts

@@ -1,7 +1,9 @@
 /** 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;
-};
+} | {
+    [Symbol.toStringTag]: string;
+} | number | boolean | null | undefined;
 /**
  * A type that offers autocomplete for the passed union but also allows any arbitrary value of the same type to be passed.
  * Supports unions of strings, numbers and objects.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "8.3.2",
+  "version": "8.4.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",
@@ -15,24 +15,6 @@
     }
   },
   "type": "module",
-  "scripts": {
-    "lint": "tsc --noEmit && eslint .",
-    "build-types": "tsc --emitDeclarationOnly --declaration --outDir dist",
-    "build-common": "tsup lib/index.ts --format cjs,esm --clean --treeshake",
-    "build-all": "tsup lib/index.ts --format cjs,esm,iife --treeshake --onSuccess \"npm run build-types && npm run post-build-global && echo Finished building.\"",
-    "build": "npm run build-common -- && npm run build-types",
-    "post-build-global": "npm run node-ts -- ./tools/post-build-global.mts",
-    "dev": "npm run build-common -- --sourcemap --watch --onSuccess \"npm run build-types && echo Finished building.\"",
-    "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 --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",
-    "test": "concurrently \"npm run test-serve\" \"npm run test-dev\""
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Sv443-Network/UserUtils.git"
@@ -51,25 +33,26 @@
   },
   "homepage": "https://github.com/Sv443-Network/UserUtils",
   "dependencies": {
-    "nanoevents": "^9.0.0"
+    "nanoevents": "^9.1.0"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.26.2",
-    "@types/express": "^4.17.19",
-    "@types/greasemonkey": "^4.0.4",
-    "@types/node": "^20.5.9",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
-    "concurrently": "^8.2.1",
-    "eslint": "^8.46.0",
-    "express": "^4.18.2",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.6.1",
-    "tsup": "^7.1.0",
-    "typescript": "^5.1.6"
+    "@changesets/cli": "^2.27.11",
+    "@types/express": "^4.17.21",
+    "@types/greasemonkey": "^4.0.7",
+    "@types/node": "^20.17.10",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.1",
+    "express": "^4.21.2",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.8.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
   },
   "files": [
     "/dist/index.js",
+    "/dist/index.cjs",
     "/dist/index.mjs",
     "/dist/index.global.js",
     "/dist/lib/**.d.ts",
@@ -77,5 +60,23 @@
     "/README.md",
     "/CHANGELOG.md",
     "/LICENSE.txt"
-  ]
+  ],
+  "scripts": {
+    "lint": "eslint . && tsc --noEmit",
+    "build-types": "tsc --emitDeclarationOnly --declaration --outDir dist",
+    "build-common": "tsup lib/index.ts --format cjs,esm --clean --treeshake",
+    "build-all": "tsup lib/index.ts --format cjs,esm,iife --treeshake --onSuccess \"npm run build-types && npm run post-build-global && echo Finished building.\"",
+    "build": "npm run build-common -- && npm run build-types",
+    "post-build-global": "npm run node-ts -- ./tools/post-build-global.mts",
+    "dev": "npm run build-common -- --sourcemap --watch --onSuccess \"npm run build-types && echo Finished building.\"",
+    "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 --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",
+    "test": "concurrently \"npm run test-serve\" \"npm run test-dev\""
+  }
 }