@lowentry/utils 1.25.3 → 2.0.2

package/src/classes/EventEmitter.js

@@ -1,124 +0,0 @@
-/**
- * A simple event emitter class that allows you to register listeners for events, emit events, and remove listeners.
- */
-export class EventEmitter
-{
-	/** @type {Map<string, Set<Function>>} */
-	#events;
-	
-	
-	/**
-	 * Creates a new EventEmitter instance.
-	 */
-	constructor()
-	{
-		this.#events = new Map();
-	}
-	
-	
-	/**
-	 * 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, listener)
-	{
-		if(!this.#events.has(event))
-		{
-			this.#events.set(event, new Set());
-		}
-		this.#events.get(event)?.add(listener);
-		
-		return {
-			remove:
-				() => this.off(event, listener),
-		};
-	}
-	
-	/**
-	 * 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, listener)
-	{
-		const wrapper = (/** @type {*[]} */ ...args) =>
-		{
-			this.off(event, wrapper);
-			listener(...args);
-		};
-		
-		this.on(event, wrapper);
-		
-		return {
-			remove:
-				() => this.off(event, wrapper),
-		};
-	}
-	
-	/**
-	 * 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, listener)
-	{
-		const listeners = this.#events.get(event);
-		if(listeners)
-		{
-			listeners.delete(listener);
-			if(listeners.size === 0)
-			{
-				this.#events.delete(event);
-			}
-		}
-	}
-	
-	/**
-	 * 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, ...args)
-	{
-		const listeners = this.#events.get(event);
-		if(listeners)
-		{
-			const snapshot = [...listeners];
-			for(const listener of snapshot)
-			{
-				try
-				{
-					listener(...args);
-				}
-				catch(err)
-				{
-					console.error(`Error in listener for "${event}":`, err);
-				}
-			}
-		}
-	}
-	
-	/**
-	 * 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)
-	{
-		if(event !== undefined)
-		{
-			this.#events.delete(event);
-		}
-		else
-		{
-			this.#events.clear();
-		}
-	}
-}

package/src/classes/LinkedList.js

@@ -1,145 +0,0 @@
-class LinkedListNode
-{
-	/** @type {*} */
-	value;
-	
-	/** @type {LinkedListNode|null} */
-	next = null;
-	
-	/** @type {LinkedListNode|null} */
-	previous = null;
-	
-	/**
-	 * @param {*} value
-	 */
-	constructor(value)
-	{
-		this.value = value;
-	}
-}
-
-export class LinkedList
-{
-	/** @type {LinkedListNode|null} */
-	#head = null;
-	
-	/** @type {LinkedListNode|null} */
-	#tail = null;
-	
-	/** @type {number} */
-	#size = 0;
-	
-	constructor()
-	{
-	}
-	
-	/**
-	 * Returns the number of elements in the list.
-	 *
-	 * @returns {number}
-	 */
-	get size()
-	{
-		return this.#size;
-	}
-	
-	/**
-	 * Adds a new value to the beginning of the list.
-	 *
-	 * @param {*} value
-	 */
-	unshift(value)
-	{
-		const newNode = new LinkedListNode(value);
-		if(this.#head === null)
-		{
-			this.#head = newNode;
-			this.#tail = newNode;
-		}
-		else
-		{
-			newNode.next = this.#head;
-			this.#head.previous = newNode;
-			this.#head = newNode;
-		}
-		this.#size++;
-	}
-	
-	/**
-	 * Adds a new value to the end of the list.
-	 *
-	 * @param {*} value
-	 */
-	push(value)
-	{
-		const newNode = new LinkedListNode(value);
-		if(this.#tail === null)
-		{
-			this.#head = newNode;
-			this.#tail = newNode;
-		}
-		else
-		{
-			newNode.previous = this.#tail;
-			this.#tail.next = newNode;
-			this.#tail = newNode;
-		}
-		this.#size++;
-	}
-	
-	/**
-	 * Removes the first value from the list and returns it.
-	 *
-	 * @returns {*|undefined}
-	 */
-	shift()
-	{
-		if(this.#head === null)
-		{
-			return undefined;
-		}
-		
-		const value = this.#head.value;
-		this.#head = this.#head.next;
-		
-		if(this.#head !== null)
-		{
-			this.#head.previous = null;
-		}
-		else
-		{
-			this.#tail = null;
-		}
-		
-		this.#size--;
-		return value;
-	}
-	
-	/**
-	 * Removes the last value from the list and returns it.
-	 *
-	 * @returns {*|undefined}
-	 */
-	pop()
-	{
-		if(this.#tail === null)
-		{
-			return undefined;
-		}
-		
-		const value = this.#tail.value;
-		this.#tail = this.#tail.previous;
-		
-		if(this.#tail !== null)
-		{
-			this.#tail.next = null;
-		}
-		else
-		{
-			this.#head = null;
-		}
-		
-		this.#size--;
-		return value;
-	}
-}

package/src/classes/SerializableMap.js

@@ -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
-{
-	/**
-	 * Returns a JSON representation of the map.
-	 *
-	 * @returns {Object}
-	 */
-	toJSON()
-	{
-		return Object.fromEntries(this);
-	}
-}

package/src/classes/TreeSet.js

@@ -1,235 +0,0 @@
-import {LeUtils} from '../LeUtils.js';
-
-
-/**
- * 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
-{
-	/** @type {*[]} */
-	#elements;
-	
-	/** @type {(valueA:*, valueB:*) => number} */
-	#comparator;
-	
-	
-	/**
-	 * 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, comparator)
-	{
-		this.#comparator = comparator || LeUtils.compare;
-		this.#elements = elements || [];
-		this.#elements.sort(this.#comparator);
-	}
-	
-	
-	/**
-	 *
-	 *
-	 * @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
-	 */
-	binarySearch(value)
-	{
-		let low = 0;
-		let high = this.#elements.length - 1;
-		while(low <= high)
-		{
-			const mid = Math.floor((low + high) / 2);
-			const midValue = this.#elements[mid];
-			const cmp = this.#comparator(midValue, value);
-			if(cmp < 0)
-			{
-				low = mid + 1;
-			}
-			else if(cmp > 0)
-			{
-				high = mid - 1;
-			}
-			else
-			{
-				return {found:true, index:mid, value:midValue};
-			}
-		}
-		return {found:false, index:low, value:undefined};
-	};
-	
-	
-	/**
-	 * Returns the elements of the set.
-	 */
-	getElements()
-	{
-		return this.#elements;
-	}
-	
-	/**
-	 * Returns the comparator of the set.
-	 *
-	 * @returns {(valueA:*, valueB:*) => number}
-	 */
-	getComparator()
-	{
-		return this.#comparator;
-	}
-	
-	/**
-	 * Returns the size of the set.
-	 *
-	 * @returns {number}
-	 */
-	size()
-	{
-		return this.#elements.length;
-	}
-	
-	/**
-	 * Returns true if the set is empty, false otherwise.
-	 *
-	 * @returns {boolean}
-	 */
-	isEmpty()
-	{
-		return (this.#elements.length <= 0);
-	}
-	
-	/**
-	 * 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)
-	{
-		return this.binarySearch(value).found;
-	}
-	
-	/**
-	 * 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()
-	{
-		return (this.#elements.length > 0) ? this.#elements[0] : 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()
-	{
-		return (this.#elements.length > 0) ? this.#elements[this.#elements.length - 1] : 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()
-	{
-		return (this.#elements.length > 0) ? this.#elements.splice(0, 1)[0] : 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()
-	{
-		return (this.#elements.length > 0) ? this.#elements.splice(this.#elements.length - 1, 1)[0] : 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)
-	{
-		const result = this.binarySearch(value);
-		if(result.found)
-		{
-			return;
-		}
-		this.#elements.splice(result.index, 0, value);
-	}
-	
-	/**
-	 * 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)
-	{
-		LeUtils.each(values, this.add.bind(this));
-	}
-	
-	/**
-	 * 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)
-	{
-		const result = this.binarySearch(value);
-		if(result.found)
-		{
-			return result.value;
-		}
-		return 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)
-	{
-		const result = this.binarySearch(value);
-		if(result.found)
-		{
-			return result.value;
-		}
-		this.#elements.splice(result.index, 0, value);
-		return value;
-	}
-	
-	/**
-	 * Returns a string representation of the TreeSet.
-	 *
-	 * @returns {string} - A string representation of the TreeSet, including its elements and comparator.
-	 */
-	toString()
-	{
-		return `TreeSet{elements:${this.#elements}, comparator:${this.#comparator}}`;
-	}
-	
-	/**
-	 * Returns a JSON representation of the TreeSet.
-	 *
-	 * @returns {Object} - An object containing the elements and comparator of the TreeSet.
-	 */
-	toJSON()
-	{
-		return {
-			elements:  this.#elements,
-			comparator:this.#comparator.toString(),
-		};
-	}
-}

package/src/index.js

@@ -1,6 +0,0 @@
-export {LeUtils} from './LeUtils.js';
-export {ISSET, IS_ARRAY, ARRAY, IS_OBJECT, OBJECT, STRING, STRING_ANY, BOOL, BOOL_ANY, INT, INT_ANY, FLOAT, FLOAT_ANY, INT_LAX, INT_LAX_ANY, FLOAT_LAX, FLOAT_LAX_ANY} from './LeTypes.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';

package/tsconfig.d.ts

@@ -1 +0,0 @@
-/// <reference lib="esnext" />

package/tsconfig.json

@@ -1,39 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    "noImplicitAny": false,
-    "noImplicitThis": false,
-    "alwaysStrict": true,
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "jsx": "react-jsx",
-    "target": "esnext",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "skipLibCheck": true,
-    "types": [],
-    "noEmit": false,
-    "declaration": true,
-    "declarationMap": false,
-    "outDir": "./build",
-    "removeComments": false,
-    "stripInternal": true,
-    "emitDeclarationOnly": true
-  },
-  "include": [
-    "tsconfig.d.ts",
-    "src"
-  ],
-  "exclude": [
-    "node_modules"
-  ],
-  "typeAcquisition": {
-    "include": [
-      "react",
-      "react-dom"
-    ]
-  }
-}