@sv443-network/userutils 2.0.1 → 4.0.0

package/dist/lib/misc.d.ts

@@ -3,7 +3,20 @@ export type Stringifiable = string | {
     toString(): string;
 };
 /**
- * Automatically appends an `s` to the passed `word`, if `num` is not equal to 1
+ * 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.
+ */
+export type LooseUnion<TUnion extends string | number | object> = (TUnion) | (TUnion extends string ? (string & {}) : (TUnion extends number ? (number & {}) : (TUnion extends Record<keyof any, unknown> ? (object & {}) : never)));
+/**
+ * A type that allows all strings except for empty ones
+ * @example
+ * function foo<T extends string>(bar: NonEmptyString<T>) {
+ *   console.log(bar);
+ * }
+ */
+export type NonEmptyString<TString extends string> = TString extends "" ? never : TString;
+/**
+ * Automatically appends an `s` to the passed {@linkcode word}, if {@linkcode num} is not equal to 1
  * @param word A word in singular form, to auto-convert to plural
  * @param num If this is an array or NodeList, the amount of items is used
  */
@@ -11,8 +24,8 @@ export declare function autoPlural(word: Stringifiable, num: number | unknown[]
 /** Pauses async execution for the specified time in ms */
 export declare function pauseFor(time: number): Promise<void>;
 /**
- * Calls the passed `func` after the specified `timeout` in ms (defaults to 300).
- * Any subsequent calls to this function will reset the timer and discard previous calls.
+ * Calls the passed {@linkcode func} after the specified {@linkcode timeout} in ms (defaults to 300).
+ * Any subsequent calls to this function will reset the timer and discard all previous calls.
  */
 export declare function debounce<TFunc extends (...args: TArgs[]) => void, TArgs = any>(func: TFunc, timeout?: number): (...args: TArgs[]) => void;
 /** Options for the `fetchAdvanced()` function */
@@ -25,7 +38,15 @@ export declare function fetchAdvanced(url: string, options?: FetchAdvancedOpts):
 /**
  * Inserts the passed values into a string at the respective placeholders.
  * The placeholder format is `%n`, where `n` is the 1-indexed argument number.
- * @param str The string to insert the values into
+ * @param input The string to insert the values into
  * @param values The values to insert, in order, starting at `%1`
  */
-export declare function insertValues(str: string, ...values: Stringifiable[]): string;
+export declare function insertValues(input: string, ...values: Stringifiable[]): string;
+/** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as a base64 string */
+export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType?: "base64"): Promise<string>;
+/** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as an ArrayBuffer */
+export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType: "arrayBuffer"): Promise<ArrayBuffer>;
+/** Decompresses a previously compressed base64 string or ArrayBuffer, with the format passed by {@linkcode compressionFormat}, converted to a string */
+export declare function decompress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType?: "string"): Promise<string>;
+/** Decompresses a previously compressed base64 string or ArrayBuffer, with the format passed by {@linkcode compressionFormat}, converted to an ArrayBuffer */
+export declare function decompress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType: "arrayBuffer"): Promise<ArrayBuffer>;

package/dist/lib/translation.d.ts

@@ -1,9 +1,9 @@
 import { Stringifiable } from "./misc";
 /**
- * Returns the translated text for the specified key in the current language set by `setLanguage()`
+ * Returns the translated text for the specified key in the current language set by {@linkcode tr.setLanguage()}
  * If the key is not found in the previously registered translation, the key itself is returned.
  *
- * ⚠️ Remember to register a language with `tr.addLanguage()` and set it as active with `tr.setLanguage()` before using this function, otherwise it will always return the key itself.
+ * ⚠️ Remember to register a language with {@linkcode tr.addLanguage()} and set it as active with {@linkcode tr.setLanguage()} before using this function, otherwise it will always return the key itself.
  * @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
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sv443-network/userutils",
-  "version": "2.0.1",
+  "version": "4.0.0",
   "description": "Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, manage persistent user configurations, modify the DOM more easily and more",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -14,7 +14,10 @@
     "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.\"",
     "publish-package": "changeset publish",
-    "node-ts": "node --no-warnings=ExperimentalWarning --enable-source-maps --loader ts-node/esm"
+    "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",
@@ -35,14 +38,17 @@
   "homepage": "https://github.com/Sv443-Network/UserUtils",
   "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.2.0",
+    "tsup": "^7.1.0",
     "typescript": "^5.1.6"
   },
   "files": [
@@ -55,4 +61,4 @@
     "/CHANGELOG.md",
     "/LICENSE.txt"
   ]
-}
+}

package/dist/lib/onSelector.d.ts

@@ -1,40 +0,0 @@
-/** Options for the `onSelector()` function */
-export type OnSelectorOpts<TElem extends Element = HTMLElement> = SelectorOptsOne<TElem> | SelectorOptsAll<TElem>;
-type SelectorOptsOne<TElem extends Element> = SelectorOptsCommon & {
-    /** 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> = SelectorOptsCommon & {
-    /** 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 SelectorOptsCommon = {
-    /** Whether to call the listener continuously instead of once - default is false */
-    continuous?: boolean;
-};
-/**
- * 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.
- * @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)
- */
-export declare function onSelector<TElem extends Element = HTMLElement>(selector: string, options: OnSelectorOpts<TElem>): void;
-/**
- * Removes all listeners registered in `onSelector()` that have the given selector
- * @returns Returns true when all listeners with the associated selector were found and removed, false otherwise
- */
-export 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 options For fine-tuning what triggers the MutationObserver's checking function - `subtree` and `childList` are set to true by default
- */
-export declare function initOnSelector(options?: MutationObserverInit): void;
-/** Returns all currently registered selectors, as a map of selector strings to their associated options */
-export declare function getSelectorMap(): Map<string, OnSelectorOpts<HTMLElement>[]>;
-export {};