@lowentry/utils 1.22.1 → 1.23.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowentry/utils",
-  "version": "1.22.1",
+  "version": "1.23.1",
   "private": false,
   "type": "module",
   "main": "./index.js",
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "build": "npm exec -- rollup -c",
-    "prepublishOnly": "rm -r src && mv dist/* ./ && rm -r dist",
+    "prepublishOnly": "rm -r build && rm -r tests && rm -r src && mv dist/* ./ && rm -r dist",
     "test": "npx tsc && vitest run"
   },
   "dependencies": {

package/src/LeUtils.js

@@ -586,43 +586,42 @@ export const LeUtils = {
 			{
 				return index;
 			}
-			if(ArrayBuffer.isView(elements) && !(elements instanceof DataView))
+			if(typeof elements !== 'string')
 			{
-				return elements[index];
-			}
-			if(typeof elements === 'string')
-			{
-				return elements.charAt(index);
-			}
-			if(typeof elements?.[Symbol.iterator] === 'function')
-			{
-				let i = 0;
-				for(const value of elements)
+				if(ArrayBuffer.isView(elements) && !(elements instanceof DataView))
 				{
-					if(i === index)
-					{
-						return value;
-					}
-					i++;
+					return elements[index];
 				}
-				return undefined;
-			}
-			if(typeof elements?.forEach === 'function')
-			{
-				let result = undefined;
-				let shouldContinue = true;
-				elements.forEach((value, i) =>
+				if(typeof elements?.[Symbol.iterator] === 'function')
 				{
-					if(shouldContinue)
+					let i = 0;
+					for(const value of elements)
 					{
 						if(i === index)
 						{
-							result = value;
-							shouldContinue = false;
+							return value;
 						}
+						i++;
 					}
-				});
-				return result;
+					return undefined;
+				}
+				if(typeof elements?.forEach === 'function')
+				{
+					let result = undefined;
+					let shouldContinue = true;
+					elements.forEach((value, i) =>
+					{
+						if(shouldContinue)
+						{
+							if(i === index)
+							{
+								result = value;
+								shouldContinue = false;
+							}
+						}
+					});
+					return result;
+				}
 			}
 			if((typeof elements === 'object') || (typeof elements === 'function'))
 			{
@@ -644,14 +643,13 @@ export const LeUtils = {
 	supportsEach:
 		(elements) =>
 		{
-			if((elements === null) || (typeof elements === 'undefined'))
+			if((elements === null) || (typeof elements === 'undefined') || (typeof elements === 'string'))
 			{
 				return false;
 			}
 			return !!(
 				(Array.isArray(elements))
 				|| ((typeof elements === 'object') && (elements?.constructor === Object))
-				|| (typeof elements === 'string')
 				|| (typeof elements?.[Symbol.iterator] === 'function')
 				|| (typeof elements?.forEach === 'function')
 				|| ((typeof elements === 'object') || (typeof elements === 'function'))
@@ -707,36 +705,31 @@ export const LeUtils = {
 				}
 				return;
 			}
-			if(typeof elements === 'string')
+			if(typeof elements !== 'string')
 			{
-				for(let i = 0; i < elements.length; i++)
+				if(typeof elements?.[Symbol.iterator] === 'function')
 				{
-					yield [elements.charAt(i), i];
+					let i = 0;
+					for(const value of elements)
+					{
+						yield [value, i];
+						i++;
+					}
+					return;
 				}
-				return;
-			}
-			if(typeof elements?.[Symbol.iterator] === 'function')
-			{
-				let i = 0;
-				for(const value of elements)
+				if(typeof elements?.forEach === 'function')
 				{
-					yield [value, i];
-					i++;
-				}
-				return;
-			}
-			if(typeof elements?.forEach === 'function')
-			{
-				const buffer = [];
-				elements.forEach((value, i) =>
-				{
-					buffer.push([value, i]);
-				});
-				for(const entry of buffer)
-				{
-					yield entry;
+					const buffer = [];
+					elements.forEach((value, i) =>
+					{
+						buffer.push([value, i]);
+					});
+					for(const entry of buffer)
+					{
+						yield entry;
+					}
+					return;
 				}
-				return;
 			}
 			if((typeof elements === 'object') || (typeof elements === 'function'))
 			{
@@ -898,7 +891,7 @@ export const LeUtils = {
 					collection.set(index, value);
 				};
 			}
-			else if((typeof elements === 'string') || (typeof elements?.[Symbol.iterator] === 'function') || (typeof elements?.forEach === 'function'))
+			else if((typeof elements !== 'string') && ((typeof elements?.[Symbol.iterator] === 'function') || (typeof elements?.forEach === 'function')))
 			{
 				collection = [];
 				add = (value, index) =>
@@ -1119,7 +1112,7 @@ export const LeUtils = {
 		{
 			const flattenToArrayRecursive = (result, elements, optionalSkipHasOwnPropertyCheck) =>
 			{
-				if(!LeUtils.supportsEach(elements) || (typeof elements === 'string'))
+				if(!LeUtils.supportsEach(elements))
 				{
 					result.push(elements);
 					return;
@@ -1132,7 +1125,7 @@ export const LeUtils = {
 			
 			return (elements, optionalSkipHasOwnPropertyCheck = false) =>
 			{
-				if(!LeUtils.supportsEach(elements) || (typeof elements === 'string'))
+				if(!LeUtils.supportsEach(elements))
 				{
 					return [elements];
 				}
@@ -2055,7 +2048,7 @@ export const LeUtils = {
 	generateNamePermutations:
 		(...names) =>
 		{
-			names = LeUtils.flattenArray(names)
+			names = LeUtils.flattenToArray(names)
 				.map(name => STRING(name).trim().toLowerCase())
 				.filter(name => (name.length > 0));
 			let results = [];

package/build/LeTypes.d.ts

@@ -1,15 +0,0 @@
-export function ISSET(value: any): boolean;
-export function IS_ARRAY(value: any): boolean;
-export function ARRAY(value: any): any[];
-export function IS_OBJECT(value: any): boolean;
-export function OBJECT(value: any): any;
-export function STRING(value: any): string;
-export function STRING_ANY(...values: any): string;
-export function INT(value: any): number;
-export function INT_ANY(...values: any): number;
-export function FLOAT(value: any): number;
-export function FLOAT_ANY(...values: any): number;
-export function INT_LAX(value: any): number;
-export function INT_LAX_ANY(...values: any): number;
-export function FLOAT_LAX(value: any): number;
-export function FLOAT_LAX_ANY(...values: any): number;

package/build/LeUtils.d.ts

@@ -1,203 +0,0 @@
-export namespace LeUtils {
-    function equals(value: any, other: any): boolean;
-    function equalsMapLike(elementsA: any, elementsB: any, ignoreKeys?: any[]): boolean;
-    function clone(value: any): any;
-    function onDomReady(callback: Function): {
-        remove: Function;
-    };
-    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);
-    };
-    function contains(array: any[] | any | Function, value: any): boolean;
-    function containsCaseInsensitive(array: any[] | any | Function, value: any): boolean;
-    function containsAll(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function containsAllCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function containsAny(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function containsAnyCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function containsNone(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function containsNoneCaseInsensitive(array: any[] | any | Function, values: any[] | any | Function): boolean;
-    function findIndexValue(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): {
-        index: any;
-        value: any;
-    } | null;
-    function findIndex(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any | null;
-    function find(elements: any[] | any | Function, callback: (value: any, index: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any | null;
-    function getValueAtIndex(elements: any, index: any, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    function supportsEach(elements: any): boolean;
-    function eachIterator(elements: any, optionalSkipHasOwnPropertyCheck?: boolean): Generator<any, void, unknown>;
-    function each(elements: any, callback: (value: any, index?: any) => boolean | void, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    function eachAsync(elements: any, asyncCallback: any, parallelCount?: number, optionalSkipHasOwnPropertyCheck?: boolean): Promise<any>;
-    function getEmptySimplifiedCollection(elements: any): [boolean, any[] | any | Map<any, any>, (value: any, index: any) => void];
-    function filter(elements: any, callback?: (value: any, index: any) => boolean | undefined, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    function map(elements: any, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any;
-    function mapToArray(elements: any, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    function mapToArraySorted(elements: any, comparator: (valueA: any, valueB: any) => number, callback?: (value: any, index: any) => any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    function sortKeys(elements: any, comparator: (valueA: any, valueB: any) => number, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    function flattenArray(array: any): any[];
-    function flattenToArray(elements: any, optionalSkipHasOwnPropertyCheck?: boolean): any[];
-    function compare(a: any, b: any): number;
-    function compareNumbers(a: number, b: number): number;
-    function compareNumericStrings(a: string | number, b: string | number): number;
-    function compareNaturalStrings(a: string, b: string): number;
-    function compareTimestampStrings(a: string, b: string): number;
-    function isEmptyObject(obj: any, optionalSkipHasOwnPropertyCheck?: boolean | undefined): boolean;
-    function getObjectFieldsCount(obj: any, optionalSkipHasOwnPropertyCheck?: boolean | undefined): number;
-    function isGeneratorFunction(func: any): any;
-    function setTimeout(callback: (deltaTime: number) => any, ms: number): {
-        remove: Function;
-    };
-    function setInterval(callback: (deltaTime: number) => any, intervalMs?: number, fireImmediately?: boolean): {
-        remove: Function;
-    };
-    function setAnimationFrameTimeout(callback: (deltaTime: number) => any, frames?: number): {
-        remove: Function;
-    };
-    function setAnimationFrameInterval(callback: (deltaTime: number) => any, intervalFrames?: number, fireImmediately?: boolean): {
-        remove: Function;
-    };
-    function promiseTimeout(ms: number): Promise<number>;
-    function promiseAnimationFrameTimeout(frames: number): Promise<number>;
-    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;
-    };
-    function cachedFetch(url: any, options: any, responseFunction: any): Promise<any>;
-    function platformIsMobile(): boolean;
-    function platformHasCursor(): boolean;
-    function capitalize(string: string): string;
-    function endsWithAny(string: string, endingCharsStringOrArray: string | string[]): boolean;
-    function startsWithAny(string: string, startingCharsStringOrArray: string | string[]): boolean;
-    function trimEnd(string: string, trimCharsStringOrArray: string | string[]): string;
-    function trimStart(string: string, trimCharsStringOrArray: string | string[]): string;
-    function trim(string: string, trimCharsStringOrArray: string | string[]): string;
-    function purgeSentence(sentence: string): string;
-    function purgeErrorMessage(error: any): string;
-    function generateNamePermutations(...names: string[]): string[];
-    function increaseNumericStringByOne(string: string): string;
-    function uniqueId(): string;
-    function timestamp(now?: number | null | undefined): string;
-    function getEmptyImageSrc(): string;
-    function getPercentage(part: number | string, total: number | string): number;
-    function getImagePixels(image: HTMLImageElement): Uint8ClampedArray;
-    function getColoredImage(image: HTMLImageElement, color: string): string;
-    function rgbToHex(rgb: number[]): string;
-    function hexToRgb(hexstring: string): number[];
-    function rgbToHsl(rgb: number[]): number[];
-    function hslToRgb(hsl: any): number[];
-    function rgbToLab(rgb: number[]): number[];
-    function getDifferenceBetweenRgb(rgbA: number[], rgbB: number[]): number;
-    function getDifferenceBetweenLab(labA: number[], labB: number[]): number;
-    function getRgbOfGradient(gradient: {
-        percentage?: number[];
-    }, percentage: number): number[];
-    function getRgbBetween(startRgb: number[], endRgb: number[], percentage: number): number[];
-    function btoa(string: string): string;
-    function atob(base64string: string): string;
-    function utf8ToBase64(string: string): string;
-    function base64ToUtf8(base64string: string): string;
-    function base64ToHex(base64string: string): string;
-    function hexToBase64(hexstring: string): string;
-    function base64ToBytes(base64string: string): Uint8Array;
-    function bytesToBase64(arraybuffer: ArrayLike<number> | ArrayBuffer): string;
-    function downloadFile(base64string: string, fileName?: string, mimeType?: string): void;
-    function localStorageGet(id: string): any;
-    function localStorageSet(id: string, data: any): void;
-    function localStorageRemove(id: string): void;
-    function isCurrentHostPrivate(): boolean;
-    function isGivenHostPrivate(host: string): boolean;
-    function createTransactionalValue(value?: any): {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    };
-    function isTransactionalValueValid(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): boolean;
-    function transactionalValueToString(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): string;
-    function transactionSetAndCommit(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, value: any): void;
-    function transactionSetWithoutCommitting(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, value: any): string;
-    function transactionCommitChange(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    function transactionCancelChange(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    function transactionIsChangeRelevant(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }, changeId: string): boolean;
-    function transactionGetCommittedValue(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): any;
-    function transactionGetValue(transactionalValue: {
-        value: any;
-        changes: {
-            id: string;
-            value: any;
-        }[];
-    }): any;
-    function createWorkerThread(name: string): {
-        worker: Worker | null;
-        sendMessage: (data: any, options: {
-            timeout: number | undefined;
-        } | undefined) => Promise<any>;
-    };
-    function sendWorkerMessage(workerName: any, data: any, options: any): any;
-    function purgeEmail(email: string): string;
-    function isFocusClear(): boolean;
-    function getUserLocale(): any;
-    function getUserLocaleDateFormat(): any;
-}

package/build/classes/EventEmitter.d.ts

@@ -1,46 +0,0 @@
-/**
- * A simple event emitter class that allows you to register listeners for events, emit events, and remove listeners.
- */
-export 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;
-}

package/build/classes/LinkedList.d.ts

@@ -1,33 +0,0 @@
-export 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;
-}

package/build/classes/SerializableMap.d.ts

@@ -1,17 +0,0 @@
-/**
- * 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 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;
-}

package/build/classes/TreeSet.d.ts

@@ -1,115 +0,0 @@
-/**
- * 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 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;
-}

package/build/index.d.ts

@@ -1,6 +0,0 @@
-export { LeUtils } from "./LeUtils.js";
-export { EventEmitter } from "./classes/EventEmitter.js";
-export { LinkedList } from "./classes/LinkedList.js";
-export { SerializableMap } from "./classes/SerializableMap.js";
-export { TreeSet } from "./classes/TreeSet.js";
-export { ISSET, IS_ARRAY, ARRAY, IS_OBJECT, OBJECT, STRING, STRING_ANY, INT, INT_ANY, FLOAT, FLOAT_ANY, INT_LAX, INT_LAX_ANY, FLOAT_LAX, FLOAT_LAX_ANY } from "./LeTypes.js";