@lowentry/utils 1.25.2 → 2.0.2

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Low Entry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+

package/README.md

@@ -2,7 +2,6 @@
 
 Provides utilities for general JavaScript development.
 
-
 ## Description
 
 This plugin adds utility functions and classes to make it easier to program general JavaScript.
@@ -17,7 +16,6 @@ Think about things such as:
 
 It's basically just a collection of general JavaScript utilities.
 
-
 ## Final words
 
 I hope this plugin will be useful to you. If you have any questions or suggestions, please feel free to get in touch at [LowEntry.com](https://lowentry.com/).

package/package.json

@@ -1,55 +1,54 @@
 {
-  "name": "@lowentry/utils",
-  "version": "1.25.2",
-  "private": false,
-  "type": "module",
-  "main": "./index.js",
-  "description": "Provides utilities for general JavaScript development.",
-  "author": "Low Entry",
-  "license": "MIT",
-  "keywords": [
-    "plugin",
-    "utility",
-    "utilities"
-  ],
-  "homepage": "https://github.com/LowEntry/lowentry-js-utils",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/LowEntry/lowentry-js-utils.git"
-  },
-  "scripts": {
-    "build": "npm exec -- rollup -c",
-    "prepublishOnly": "rm -r build && rm -r tests && rm -r src && mv dist/* ./ && rm -r dist",
-    "test": "npx tsc && vitest run"
-  },
-  "dependencies": {
-    "@babel/runtime": "*",
-    "clone-deep": "^4"
-  },
-  "peerDependencies": {
-    "@babel/runtime": "*",
-    "clone-deep": "^4"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/plugin-transform-runtime": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
-    "@babel/preset-react": "^7.24.7",
-    "@microsoft/api-extractor": "^7.52.8",
-    "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-url": "^8.0.2",
-    "autoprefixer": "^10.4.19",
-    "cssnano": "^7.0.2",
-    "fs-extra": "^11.2.0",
-    "less": "^4.2.0",
-    "rollup": "^2.79.1",
-    "rollup-plugin-execute": "^1.1.1",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-postcss": "^4.0.2",
-    "sass": "^1.77.5",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4"
-  }
+	"name": "@lowentry/utils",
+	"version": "2.0.2",
+	"description": "Provides utilities for general JavaScript development.",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint .",
+		"format": "eslint . --fix",
+		"test": "npm run type-check && npm run lint && vitest run",
+		"type-check": "tsc --noEmit",
+		"test:watch": "vitest",
+		"test:coverage": "vitest run --coverage",
+		"clean": "rm -rf dist coverage",
+		"prepublishOnly": "npm run clean && npm test && npm run build"
+	},
+	"devDependencies": {
+		"@stylistic/eslint-plugin": "^5.7.1",
+		"eslint": "^9.39.2",
+		"eslint-plugin-jsonc": "^2.21.0",
+		"jsdom": "^27.4.0",
+		"jsonc-eslint-parser": "^2.4.2",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.53.1",
+		"vitest": "^4.0.18"
+	},
+	"keywords": [
+		"lowentry",
+		"utils",
+		"utilities",
+		"typescript"
+	],
+	"author": "Low Entry",
+	"license": "MIT",
+	"homepage": "https://github.com/LowEntry/lowentry-js-utils",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/LowEntry/lowentry-js-utils.git"
+	},
+	"bugs": {
+		"url": "https://github.com/LowEntry/lowentry-js-utils/issues"
+	}
 }

package/api-extractor.json

@@ -1,43 +0,0 @@
-{
-  "projectFolder": ".",
-  "mainEntryPointFilePath": "<projectFolder>/build/index.d.ts",
-  "bundledPackages": [],
-  "compiler": {
-    "tsconfigFilePath": "<projectFolder>/tsconfig.json"
-  },
-  "dtsRollup": {
-    "enabled": true,
-    "untrimmedFilePath": "<projectFolder>/dist/index.d.ts"
-  },
-  "apiReport": {
-    "enabled": false,
-    "includeForgottenExports": true
-  },
-  "docModel": {
-    "enabled": false,
-    "includeForgottenExports": true
-  },
-  "tsdocMetadata": {
-    "enabled": false
-  },
-  "messages": {
-    "compilerMessageReporting": {
-      "default": {
-        "logLevel": "none"
-      }
-    },
-    "extractorMessageReporting": {
-      "default": {
-        "logLevel": "none"
-      },
-      "ae-wrong-input-file-type": {
-        "logLevel": "none"
-      }
-    },
-    "tsdocMessageReporting": {
-      "default": {
-        "logLevel": "none"
-      }
-    }
-  }
-}

package/index.d.ts

@@ -1,454 +0,0 @@
-export declare function ARRAY(value: any): any[];
-
-export declare function BOOL(value: any): boolean;
-
-export declare function BOOL_ANY(...values: any): boolean;
-
-/**
- * A simple event emitter class that allows you to register listeners for events, emit events, and remove listeners.
- */
-export declare class EventEmitter {
-    /**
-     * Registers a listener for a specific event.
-     *
-     * @param {string} event - The name of the event to listen for.
-     * @param {Function} listener - The function to call when the event is emitted.
-     * @returns {{remove:(()=>void)}}
-     */
-    on(event: string, listener: Function): {
-        remove: (() => void);
-    };
-    /**
-     * Registers a listener for a specific event, this listener will be called only once.
-     *
-     * @param {string} event - The name of the event to listen for.
-     * @param {Function} listener - The function to call when the event is emitted.
-     * @returns {{remove:()=>void}}
-     */
-    once(event: string, listener: Function): {
-        remove: () => void;
-    };
-    /**
-     * Removes a listener for a specific event.
-     *
-     * @param {string} event - The name of the event to stop listening for.
-     * @param {Function} listener - The function to remove from the event listeners.
-     */
-    off(event: string, listener: Function): void;
-    /**
-     * Emits an event, calling all registered listeners with the provided arguments.
-     *
-     * @param {string} event - The name of the event to emit.
-     * @param {...*} args - The arguments to pass to the listeners.
-     */
-    emit(event: string, ...args: any[]): void;
-    /**
-     * Clears all listeners for a specific event or all events if no event is specified.
-     *
-     * @param {string} [event] - The name of the event to clear listeners for. If not provided, all events will be cleared.
-     */
-    clear(event?: string): void;
-    #private;
-}
-
-export declare function FLOAT(value: any): number;
-
-export declare function FLOAT_ANY(...values: any): number;
-
-export declare function FLOAT_LAX(value: any): number;
-
-export declare function FLOAT_LAX_ANY(...values: any): number;
-
-export declare function INT(value: any): number;
-
-export declare function INT_ANY(...values: any): number;
-
-export declare function INT_LAX(value: any): number;
-
-export declare function INT_LAX_ANY(...values: any): number;
-
-export declare function IS_ARRAY(value: any): boolean;
-
-export declare function IS_OBJECT(value: any): boolean;
-
-export declare function ISSET(value: any): boolean;
-
-export declare namespace LeUtils {
-    export function equals(a: any, b: any): boolean;
-    export function equalsMapLike(elementsA: any, elementsB: any, ignoreKeys?: any[]): boolean;
-    export function clone(value: any): any;
-    export function onDomReady(callback: Function): {
-        remove: Function;
-    };
-    export function parseVersionString(versionString: string | any): {
-        major: (number);
-        minor: (number);
-        patch: (number);
-        toString: (() => string);
-        equals: ((arg0: string | any) => boolean);
-        smallerThan: ((arg0: string | any) => boolean);
-        smallerThanOrEquals: ((arg0: string | any) => boolean);
-        largerThan: ((arg0: string | any) => boolean);
-        largerThanOrEquals: ((arg0: string | any) => boolean);
-    };
-    export function contains(array: any[] | any | Function, value: any): boolean;
-    export function containsCaseInsensitive(array: any[] | any | Function, value: any): boolean;
-    export function containsAll(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function containsAllCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function containsAny(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function containsAnyCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function containsNone(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function containsNoneCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    export function findIndexValue(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): {
-        index: any;
-        value: any;
-    } | null;
-    export function findIndex(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any | null;
-    export function find(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any | null;
-    export function getValueAtIndex(elements: any, index: any, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    export function supportsEach(elements: any): boolean;
-    export function eachIterator(elements: any, optionalSkipHasOwnPropertyCheck?: boolean): Generator<any, void, unknown>;
-    export function each(elements: any, callback: (value: any, index?: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    export function eachAsync(elements: any, asyncCallback: any, parallelCount?: number, optionalSkipHasOwnPropertyCheck?: boolean): Promise<any>;
-    export function getEmptySimplifiedCollection(elements: any): [boolean, any[] | any | Map<any, any>, (value: any, index: any) => void];
-    export function filter(elements: any, callback?: (value: any, index: any) => boolean | undefined, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    export function map(elements: any, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    export function mapToArray(elements: any, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    export function mapToArraySorted(elements: any, comparator: (valueA: any, valueB: any) => number, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    export function sortKeys(elements: any, comparator: (valueA: any, valueB: any) => number, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    export function flattenArray(array: any): any[];
-    export function flattenToArray(elements: any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    export function compare(a: any, b: any): number;
-    export function compareNumbers(a: number, b: number): number;
-    export function compareNumericStrings(a: string | number, b: string | number): number;
-    export function compareNaturalStrings(a: string, b: string): number;
-    export function compareTimestampStrings(a: string, b: string): number;
-    export function isEmptyObject(obj: any, optionalSkipHasOwnPropertyCheck?: boolean | undefined): boolean;
-    export function getObjectFieldsCount(obj: any, optionalSkipHasOwnPropertyCheck?: boolean | undefined): number;
-    export function isGeneratorFunction(func: any): any;
-    export function setTimeout(callback: (deltaTime: number) => any, ms: number): {
-        remove: Function;
-    };
-    export function setInterval(callback: (deltaTime: number) => any, intervalMs?: number, fireImmediately?: boolean): {
-        remove: Function;
-    };
-    export function setAnimationFrameTimeout(callback: (deltaTime: number) => any, frames?: number): {
-        remove: Function;
-    };
-    export function setAnimationFrameInterval(callback: (deltaTime: number) => any, intervalFrames?: number, fireImmediately?: boolean): {
-        remove: Function;
-    };
-    export function promiseTimeout(ms: number): Promise<number>;
-    export function promiseAnimationFrameTimeout(frames: number): Promise<number>;
-    export function fetch(url: string, options?: {
-        retries?: number | null;
-        delay?: number | ((attempt: number) => number) | null;
-    } | any | null): {
-        then: Function;
-        catch: Function;
-        finally: Function;
-        remove: Function;
-        isRemoved: Function;
-    };
-    export function cachedFetch(url: any, options: any, responseFunction: any): Promise<any>;
-    export function platformIsMobile(): boolean;
-    export function platformHasCursor(): boolean;
-    export function capitalize(string: string): string;
-    export function endsWithAny(string: string, endingCharsStringOrArray: string | string[]): boolean;
-    export function startsWithAny(string: string, startingCharsStringOrArray: string | string[]): boolean;
-    export function trimEnd(string: string, trimCharsStringOrArray: string | string[]): string;
-    export function trimStart(string: string, trimCharsStringOrArray: string | string[]): string;
-    export function trim(string: string, trimCharsStringOrArray: string | string[]): string;
-    export function purgeSentence(sentence: string): string;
-    export function purgeErrorMessage(error: any): string;
-    export function generateNamePermutations(...names: string[]): string[];
-    export function increaseNumericStringByOne(string: string): string;
-    export function uniqueId(): string;
-    export function timestamp(now?: number | null | undefined): string;
-    export function getEmptyImageSrc(): string;
-    export function getPercentage(part: number | string, total: number | string): number;
-    export function getImagePixels(image: HTMLImageElement): Uint8ClampedArray;
-    export function getColoredImage(image: HTMLImageElement, color: string): string;
-    export function rgbToHex(rgb: number[]): string;
-    export function hexToRgb(hexstring: string): number[];
-    export function rgbToHsl(rgb: number[]): number[];
-    export function hslToRgb(hsl: any): number[];
-    export function rgbToLab(rgb: number[]): number[];
-    export function getDifferenceBetweenRgb(rgbA: number[], rgbB: number[]): number;
-    export function getDifferenceBetweenLab(labA: number[], labB: number[]): number;
-    export function getRgbOfGradient(gradient: {
-        percentage?: number[];
-    }, percentage: number): number[];
-    export function getRgbBetween(startRgb: number[], endRgb: number[], percentage: number): number[];
-    export function btoa(string: string): string;
-    export function atob(base64string: string): string;
-    export function utf8ToBase64(string: string): string;
-    export function base64ToUtf8(base64string: string): string;
-    export function base64ToHex(base64string: string): string;
-    export function hexToBase64(hexstring: string): string;
-    export function base64ToBytes(base64string: string): Uint8Array;
-    export function bytesToBase64(arraybuffer: ArrayLike<number> | ArrayBuffer): string;
-    export function downloadFile(base64string: string, fileName?: string, mimeType?: string): void;
-    export function localStorageGet(id: string): any;
-    export function localStorageSet(id: string, data: any): void;
-    export function localStorageRemove(id: string): void;
-    export function isCurrentHostPrivate(): boolean;
-    export function isGivenHostPrivate(host: string): boolean;
-    export function createTransactionalValue(value?: any): {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    };
-    export function isTransactionalValueValid(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): boolean;
-    export function transactionalValueToString(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): string;
-    export function transactionSetAndCommit(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, value: any): void;
-    export function transactionSetWithoutCommitting(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, value: any): string;
-    export function transactionCommitChange(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    export function transactionCancelChange(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    export function transactionIsChangeRelevant(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    export function transactionGetCommittedValue(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): any;
-    export function transactionGetValue(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): any;
-    export function createWorkerThread(name: string): {
-        worker: Worker | null;
-        sendMessage: (data: any, options: {
-            timeout: number | undefined;
-        } | undefined) => Promise<any>;
-    };
-    export function sendWorkerMessage(workerName: any, data: any, options: any): any;
-    export function purgeEmail(email: string): string;
-    export function isFocusClear(): boolean;
-    export function getUserLocale(): any;
-    export function getUserLocaleDateFormat(): any;
-}
-
-export declare class LinkedList {
-    /**
-     * Returns the number of elements in the list.
-     *
-     * @returns {number}
-     */
-    get size(): number;
-    /**
-     * Adds a new value to the beginning of the list.
-     *
-     * @param {*} value
-     */
-    unshift(value: any): void;
-    /**
-     * Adds a new value to the end of the list.
-     *
-     * @param {*} value
-     */
-    push(value: any): void;
-    /**
-     * Removes the first value from the list and returns it.
-     *
-     * @returns {*|undefined}
-     */
-    shift(): any | undefined;
-    /**
-     * Removes the last value from the list and returns it.
-     *
-     * @returns {*|undefined}
-     */
-    pop(): any | undefined;
-    #private;
-}
-
-export declare function OBJECT(value: any): any;
-
-/**
- * SerializableMap class extends the native Map to provide a JSON representation.
- *
- * This class can only have string keys, as JSON does not support non-string keys.
- */
-export declare class SerializableMap extends Map<any, any> {
-    constructor();
-    constructor(entries?: readonly (readonly [any, any])[] | null | undefined);
-    constructor();
-    constructor(iterable?: Iterable<readonly [any, any]> | null | undefined);
-    /**
-     * Returns a JSON representation of the map.
-     *
-     * @returns {Object}
-     */
-    toJSON(): any;
-}
-
-export declare function STRING(value: any): string;
-
-export declare function STRING_ANY(...values: any): string;
-
-/**
- * A TreeSet is a set of elements, sorted by a comparator.
- * Binary search is used to find elements, which makes it very fast to find elements.
- *
- * The comparator is also used to determine if two values are equal to each other.
- * This way, you can have values that aren't the same be treated as if they are. This can be used to deal with issues such as floating point errors for example.
- */
-export declare class TreeSet {
-    /**
-     * Creates a new TreeSet with the given elements and comparator.
-     *
-     * @param {*[]} [elements=[]] - The initial elements of the set.
-     * @param {(valueA:*, valueB:*) => number} [comparator=LeUtils.compare] - The comparator function to use for sorting.
-     */
-    constructor(elements?: any[], comparator?: (valueA: any, valueB: any) => number);
-    /**
-     *
-     *
-     * @param {*} value - The value to search for in the set.
-     * @returns {{found:boolean, index:number, value:*|undefined}} - An object containing whether the value was found, the index where it would be inserted, and the value at that index (if found).
-     * @private
-     */
-    private binarySearch;
-    /**
-     * Returns the elements of the set.
-     */
-    getElements(): any[];
-    /**
-     * Returns the comparator of the set.
-     *
-     * @returns {(valueA:*, valueB:*) => number}
-     */
-    getComparator(): (valueA: any, valueB: any) => number;
-    /**
-     * Returns the size of the set.
-     *
-     * @returns {number}
-     */
-    size(): number;
-    /**
-     * Returns true if the set is empty, false otherwise.
-     *
-     * @returns {boolean}
-     */
-    isEmpty(): boolean;
-    /**
-     * Returns true if the set contains a value that is equal to the given value, returns false otherwise.
-     *
-     * @param {*} value - The value to check for in the set.
-     * @return {boolean} - True if the set contains the value, false otherwise.
-     */
-    contains(value: any): boolean;
-    /**
-     * Returns the first element of the set, or undefined if it is empty.
-     *
-     * @return {*|undefined} - The first element of the set, or undefined if it is empty.
-     */
-    first(): any | undefined;
-    /**
-     * Returns the last element of the set, or undefined if it is empty.
-     *
-     * @return {*|undefined} - The last element of the set, or undefined if it is empty.
-     */
-    last(): any | undefined;
-    /**
-     * Removes and returns the first element of the set, or undefined if it is empty.
-     *
-     * @returns {*|undefined} - The first element of the set, or undefined if it is empty.
-     */
-    pollFirst(): any | undefined;
-    /**
-     * Removes and returns the last element of the set, or undefined if it is empty.
-     *
-     * @returns {*|undefined} - The last element of the set, or undefined if it is empty.
-     */
-    pollLast(): any | undefined;
-    /**
-     * Adds the given value to the set. Will only do so if no equal value already exists.
-     * @param {*} value - The value to add to the set.
-     */
-    add(value: any): void;
-    /**
-     * Adds all the given values to the set. Will only do so if no equal value already exists.
-     *
-     * @param {*} values - The values to add to the set.
-     */
-    addAll(values: any): void;
-    /**
-     * Returns an equal value that's already in the tree set, or undefined if no equal values in it exist.
-     *
-     * @param {*} value - The value to search for in the set.
-     * @return {*|undefined} - The equal value if found, or undefined if not found.
-     */
-    getEqualValue(value: any): any | undefined;
-    /**
-     * Returns an equal value that's already in the tree set. If no equal values in it exist, the given value will be added and returned.
-     *
-     * @param {*} value - The value to search for in the set.
-     * @return {*} - The equal value if found, or the added value if not found.
-     */
-    getEqualValueOrAdd(value: any): any;
-    /**
-     * Returns a string representation of the TreeSet.
-     *
-     * @returns {string} - A string representation of the TreeSet, including its elements and comparator.
-     */
-    toString(): string;
-    /**
-     * Returns a JSON representation of the TreeSet.
-     *
-     * @returns {Object} - An object containing the elements and comparator of the TreeSet.
-     */
-    toJSON(): any;
-    #private;
-}
-
-export { }