Renamed sleepUntil to sleepWhile, it was misleading

.github/workflows/build.yaml

@@ -9,39 +9,28 @@ jobs:
   build:
     name: Build NPM Project
     runs-on: ubuntu-latest
-    container:
+    container: node:20-alpine
-      image: node
-      volumes:
-        - '/mnt/swarm/gitea/runner/cache:/cache'
     steps:
       -   name: Clone Repository
           uses: ztimson/actions/clone@develop
 
-      -   name: Restore node_modules
+      -   name: Install & Build
-          uses: ztimson/actions/cache/restore@develop
+          run: |
-          with:
+            npm i
-            key: node_modules
+            npm run build
-
-      -   name: Install Dependencies
-          run: npm i
-
-      -   name: Build Project
-          run: npm run build
 
       -   name: Test
           run: npm run test:coverage
 
-      -   name: Cache node_modules
+      -   name: Upload to Registry
-          uses: ztimson/actions/cache@develop
+          uses: ztimson/actions/npm/publish@develop
-          with:
-            key: node_modules
-            pattern: node_modules
 
-      -   name: Cache Artifacts
+      -   name: Upload to NPM
-          uses: ztimson/actions/cache@develop
+          uses: ztimson/actions/npm/publish@develop
           with:
-            key: dist
+              owner: ztimson
-            pattern: dist
+              registry: https://registry.npmjs.org/
+              token: ${{secrets.NPM_TOKEN}}
   tag:
     name: Tag Version
     needs: build
@@ -60,30 +49,12 @@ jobs:
           with:
             tag: ${{env.VERSION}}
 
-  publish:
+
-    name: Publish
+  docs:
+    name: Publish Documentation
     needs: build
-    if: ${{github.ref_name}} == 'release'
+    uses: ztimson/actions/.github/workflows/docker.yaml@develop
-    runs-on: ubuntu-latest
+    with:
-    container:
+        name: ztimson/utils
-      image: node
+        repository: ${{github.server_url}}/${{github.repository}}.git
-      volumes:
+        pass: ${{secrets.DEPLOY_TOKEN}}
-        - '/mnt/swarm/gitea/runner/cache:/cache'
-    steps:
-      -   name: Clone Repository
-          uses: ztimson/actions/clone@develop
-
-      -   name: Restore Artifacts
-          uses: ztimson/actions/cache/restore@develop
-          with:
-            key: dist
-
-      -   name: Upload to Registry
-          uses: ztimson/actions/npm/publish@develop
-
-      -   name: Upload to NPM
-          uses: ztimson/actions/npm/publish@develop
-          with:
-            owner: ztimson
-            registry: https://registry.npmjs.org/
-            token: ${{secrets.NPM_TOKEN}}

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "docs"]
+	path = docs
+	url = git@git.zakscode.com:ztimson/utils.wiki.git
+	branch = master
+	ignore = all

Dockerfile

@@ -0,0 +1,13 @@
+# Build application
+FROM node:alpine as build
+
+RUN mkdir /app
+WORKDIR /app
+COPY . .
+RUN if [ ! -d "node_modules" ]; then npm i; fi && \
+    if [ ! -d "dist" ]; then npm run docs; fi
+
+# Use Nginx to serve
+FROM nginx:1.23-alpine
+
+COPY --from=build /app/docs /usr/share/nginx/html

README.md

@@ -0,0 +1,91 @@
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+
+  <!-- Logo -->
+  <img src="https://git.zakscode.com/repo-avatars/77dbab78e5fb3302dc9e751c4d6315a64df8d3a714d5cd5719b0dc39e6619119" alt="Logo" width="200" height="200">
+
+  <!-- Title -->
+### @ztimson/utils
+
+  <!-- Description -->
+Javascript/Typescript Utilities
+
+  <!-- Repo badges -->
+[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils/tags&query=$[0].name)](https://git.zakscode.com/ztimson/utils/tags)
+[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_pr_counter)](https://git.zakscode.com/ztimson/utils/pulls)
+[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/utils&query=open_issues_count)](https://git.zakscode.com/ztimson/utils/issues)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://utils.docs.zakscode.com" target="_blank">Documentation</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>
+
+## Table of Contents
+- [@ztimson/utils](#top)
+	- [About](#about)
+		- [Built With](#built-with)
+	- [Setup](#setup)
+		- [Production](#production)
+		- [Development](#development)
+	- [Documentation](https://utils.docs.zakscode.com/)
+	- [License](#license)
+
+## About
+
+A collection of utilities to make life a little easier
+
+### Built With
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+
+## Setup
+
+<details>
+<summary>
+  <h3 id="production" style="display: inline">
+    Production
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install persist: `npm i @ztimosn/utils`
+
+</details>
+
+<details>
+<summary>
+  <h3 id="development" style="display: inline">
+    Development
+  </h3>
+</summary>
+
+#### Prerequisites
+- [Node.js](https://nodejs.org/en/download)
+
+#### Instructions
+1. Install the dependencies: `npm i`
+2. Build library: `npm build`
+3. Run unit tests: `npm test`
+
+</details>
+
+## Documentation
+
+[Available Here](https://utils.docs.zakscode.com/)
+
+## License
+
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](_media/LICENSE) for more information.

package.json

@@ -1,7 +1,7 @@
 {
-	"name": "@ztimson/js-utilities",
+	"name": "@ztimson/utils",
-	"version": "0.1.0",
+	"version": "0.18.0",
-	"description": "JavaScript Utility library",
+	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
 	"private": false,
@@ -9,32 +9,37 @@
 		"type": "git",
 		"url": "https://git.zakscode.com/ztimson/js-utilities"
 	},
-	"main": "./dist/js-utilities.js",
+	"main": "./dist/index.cjs",
-	"module": "./dist/js-utilities.mjs",
+	"module": "./dist/index.mjs",
-	"types": "./dist/src/index.d.ts",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.mjs",
+			"require": "./dist/index.cjs",
+			"types": "./dist/index.d.ts"
+		}
+	},
 	"scripts": {
-		"build": "vite build",
+		"build": "npx tsc && npx vite build",
+		"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
 		"test": "npx jest",
 		"test:coverage": "npx jest --coverage",
-		"watch": "vite build --watch"
+		"watch": "npx vite build --watch"
 	},
 	"devDependencies": {
 		"@types/jest": "^29.5.12",
-		"@types/node": "^18.14.0",
 		"jest": "^29.7.0",
 		"jest-junit": "^16.0.0",
 		"ts-jest": "^29.1.2",
+		"typedoc": "^0.26.7",
 		"typescript": "^5.3.3",
 		"vite": "^5.0.12",
 		"vite-plugin-dts": "^3.7.2"
 	},
-	"exports": {
-		".": {
-			"import": "./dist/js-utilities.mjs",
-			"require": "./dist/js-utilities.js"
-		}
-	},
 	"files": [
 		"dist"
-	]
+	],
+	"dependencies": {
+		"var-persist": "^1.0.1"
+	}
 }

src/array.ts

@@ -1,10 +1,32 @@
 import {dotNotation, isEqual} from './objects';
 
+/**
+ * Only add element to array if it isn't already included
+ *
+ * @example
+ * ```js
+ * const arr = addUnique([1, 2, 3], 3);
+ * console.log(arr); // Output: [1, 2, 3]
+ * ```
+ *
+ * @param {T[]} array Target array element will be added to
+ * @param {T} el Unique element to add
+ * @return {T[]} Array with element if it was unique
+ * @deprecated Use ASet to create unique arrays
+ */
 export function addUnique<T>(array: T[], el: T): T[] {
 	if(array.indexOf(el) === -1) array.push(el);
 	return array;
 }
 
+/**
+ * Find all unique elements in arrays
+ *
+ * @param {any[]} a First array to compare
+ * @param {any[]} b Second array to compare
+ * @return {any[]} Unique elements
+ * @deprecated Use ASet to perform Set operations on arrays
+ */
 export function arrayDiff(a: any[], b: any[]): any[] {
 	return makeUnique([
 		...a.filter(v1 => !b.includes((v2: any) => isEqual(v1, v2))),
@@ -33,6 +55,25 @@ export function caseInsensitiveSort(prop: string) {
 	};
 }
 
+/**
+ * Shorthand to find objects with a property value
+ *
+ * @example
+ * ```js
+ * const found = [
+ *   {name: 'Batman'},
+ *   {name: 'Superman'},
+ * ].filter(findByProp('name', 'Batman'));
+ * ```
+ *
+ * @param {string} prop Property to compare (Dot nation supported)
+ * @param value Value property must have
+ * @return {(v: any) => boolean} Function used by `filter` or `find`
+ */
+export function findByProp(prop: string, value: any) {
+	return (v: any) => isEqual(dotNotation(v, prop), value);
+}
+
 /**
  * Recursively flatten nested arrays
  *
@@ -91,10 +132,13 @@ export function sortByProp(prop: string, reverse = false) {
 	};
 }
 
-export function findByProp(prop: string, value: any) {
+/**
-	return (v: any) => isEqual(v[prop], value);
+ * Make sure every element in array is unique
-}
+ *
-
+ * @param {any[]} arr Array that will be filtered in place
+ * @return {any[]} Original array
+ * @deprecated Please use ASet to create a guaranteed unique array
+ */
 export function makeUnique(arr: any[]) {
 	for(let i = arr.length - 1; i >= 0; i--) {
 		if(arr.slice(0, i).find(n => isEqual(n, arr[i]))) arr.splice(i, 1);
@@ -103,7 +147,8 @@ export function makeUnique(arr: any[]) {
 }
 
 /**
- * Make sure value is an array, if it isn't wrap it in one.
+ * Make sure value is an array, if it isn't wrap it in one
+ *
  * @param {T[] | T} value Value that should be an array
  * @returns {T[]} Value in an array
  */

src/aset.ts

@@ -0,0 +1,111 @@
+/**
+ * An array which functions as a set. It guarantees unique elements
+ * and provides set functions for comparisons
+ */
+export class ASet<T> extends Array {
+	/** Number of elements in set */
+	get size() {
+		return this.length;
+	}
+
+	/**
+	 * Array to create set from, duplicate values will be removed
+	 * @param {T[]} elements Elements which will be added to set
+	 */
+	constructor(elements: T[] = []) {
+		super();
+		if(!!elements?.['forEach'])
+			elements.forEach(el => this.add(el));
+	}
+
+	/**
+	 * Add elements to set if unique
+	 * @param items
+	 */
+	add(...items: T[]) {
+		items.filter(el => !this.has(el)).forEach(el => this.push(el));
+	}
+
+	/**
+	 * Delete elements from set
+	 * @param items Elements that will be deleted
+	 */
+	delete(...items: T[]) {
+		items.forEach(el => {
+			const index = this.indexOf(el);
+			if(index != -1) this.slice(index, 1);
+		})
+	}
+
+	/**
+	 * Create list of elements this set has which the comparison set does not
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {ASet<T>} Different elements
+	 */
+	difference(set: ASet<T>) {
+		return new ASet<T>(this.filter(el => !set.has(el)));
+	}
+
+	/**
+	 * Check if set includes element
+	 * @param {T} el Element to look for
+	 * @return {boolean} True if element was found, false otherwise
+	 */
+	has(el: T) {
+		return this.indexOf(el) != -1;
+	}
+
+	/**
+	 * Create list of elements this set has in common with the comparison set
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {boolean} Set of common elements
+	 */
+	intersection(set: ASet<T>) {
+		return new ASet<T>(this.filter(el => set.has(el)));
+	}
+
+	/**
+	 * Check if this set has no elements in common with the comparison set
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {boolean} True if nothing in common, false otherwise
+	 */
+	isDisjointFrom(set: ASet<T>) {
+		return this.intersection(set).size == 0;
+	}
+
+	/**
+	 * Check if all elements in this set are included in the comparison set
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {boolean} True if all elements are included, false otherwise
+	 */
+	isSubsetOf(set: ASet<T>) {
+		return this.findIndex(el => !set.has(el)) == -1;
+	}
+
+	/**
+	 * Check if all elements from comparison set are included in this set
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {boolean} True if all elements are included, false otherwise
+	 */
+	isSuperset(set: ASet<T>) {
+		return set.findIndex(el => !this.has(el)) == -1;
+	}
+
+	/**
+	 * Create list of elements that are only in one set but not both (XOR)
+	 * @param {ASet<T>} set Set to compare against
+	 * @return {ASet<T>} New set of unique elements
+	 */
+	symmetricDifference(set: ASet<T>) {
+		return new ASet([...this.difference(set), ...set.difference(this)]);
+	}
+
+	/**
+	 * Create joined list of elements included in this & the comparison set
+	 * @param {ASet<T>} set Set join
+	 * @return {ASet<T>} New set of both previous sets combined
+	 */
+	union(set: ASet<T> | Array<T>) {
+		return new ASet([...this, ...set]);
+	}
+}

src/cache.ts

@@ -0,0 +1,139 @@
+/**
+ * Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
+ */
+export class Cache<K extends string | number | symbol, T> {
+	private store = <Record<K, T>>{};
+
+	/** Support index lookups */
+	[key: string | number | symbol]: T | any;
+	/** Whether cache is complete */
+	complete = false;
+
+	/**
+	 * Create new cache
+	 *
+	 * @param {keyof T} key Default property to use as primary key
+	 * @param {number} ttl Default expiry in milliseconds
+	 */
+	constructor(public readonly key?: keyof T, public ttl?: number) {
+		return new Proxy(this, {
+			get: (target: this, prop: string | symbol) => {
+				if (prop in target) return (target as any)[prop];
+				return target.store[prop as K];
+			},
+			set: (target: this, prop: string | symbol, value: any) => {
+				if (prop in target) (target as any)[prop] = value;
+				else target.store[prop as K] = value;
+				return true;
+			}
+		});
+	}
+
+	private getKey(value: T): K {
+		if(!this.key) throw new Error('No key defined');
+		return <K>value[this.key];
+	}
+
+	/**
+	 * Get all cached items
+	 *
+	 * @return {T[]} Array of items
+	 */
+	all(): T[] {
+		return Object.values(this.store);
+	}
+
+	/**
+	 * Add a new item to the cache. Like set, but finds key automatically
+	 *
+	 * @param {T} value Item to add to cache
+	 * @param {number | undefined} ttl Override default expiry
+	 * @return {this}
+	 */
+	add(value: T, ttl = this.ttl): this {
+		const key = this.getKey(value);
+		this.set(key, value, ttl);
+		return this;
+	}
+
+	/**
+	 * Add several rows to the cache
+	 *
+	 * @param {T[]} rows Several items that will be cached using the default key
+	 * @param complete Mark cache as complete & reliable, defaults to true
+	 * @return {this}
+	 */
+	addAll(rows: T[], complete = true): this {
+		rows.forEach(r => this.add(r));
+		this.complete = complete;
+		return this;
+	}
+
+	/**
+	 * Delete an item from the cache
+	 *
+	 * @param {K} key Item's primary key
+	 */
+	delete(key: K) {
+		delete this.store[key];
+	}
+
+	/**
+	 * Return cache as an array of key-value pairs
+	 * @return {[K, T][]} Key-value pairs array
+	 */
+	entries(): [K, T][] {
+		return <[K, T][]>Object.entries(this.store);
+	}
+
+	/**
+	 * Get item from the cache
+	 * @param {K} key Key to lookup
+	 * @return {T} Cached item
+	 */
+	get(key: K): T {
+		return this.store[key];
+	}
+
+	/**
+	 * Get a list of cached keys
+	 *
+	 * @return {K[]} Array of keys
+	 */
+	keys(): K[] {
+		return <K[]>Object.keys(this.store);
+	}
+
+	/**
+	 * Get map of cached items
+	 *
+	 * @return {Record<K, T>}
+	 */
+	map(): Record<K, T> {
+		return structuredClone(this.store);
+	}
+
+	/**
+	 * Add an item to the cache manually specifying the key
+	 *
+	 * @param {K} key Key item will be cached under
+	 * @param {T} value Item to cache
+	 * @param {number | undefined} ttl Override default expiry
+	 * @return {this}
+	 */
+	set(key: K, value: T, ttl = this.ttl): this {
+		this.store[key] = value;
+		if(ttl) setTimeout(() => {
+			this.complete = false;
+			this.delete(key);
+		}, ttl);
+		return this;
+	}
+
+	/**
+	 * Get all cached items
+	 *
+	 * @return {T[]} Array of items
+	 */
+	values = this.all();
+}

src/csv.ts

@@ -0,0 +1,26 @@
+import {dotNotation, flattenObj} from './objects.ts';
+
+/**
+ * Convert an object to a CSV string
+ *
+ * @param {any[]} target Array of objects to create CSV from
+ * @param {boolean} flatten Should nested object be flattened or treated as values
+ * @return {string} CSV string
+ */
+export function csv(target: any[], flatten=true) {
+	const headers = target.reduce((acc, row) => {
+		Object.keys(flatten ? flattenObj(row) : row)
+			.forEach(key => { if(!acc.includes(key)) acc.push(key); });
+		return acc;
+	}, []);
+	return [
+		headers.join(','),
+		...target.map(row => headers.map((h: string) => {
+			const value = dotNotation<any>(row, h);
+			const type = typeof value;
+			if(type == 'string' && value.includes(',')) return `"${value}"`;
+			if(type == 'object') return `"${JSON.stringify(value)}"`;
+			return value;
+		}).join(','))
+	].join('\n');
+}

src/emitter.ts

@@ -1,18 +1,49 @@
 export type Listener = (...args: any[]) => any;
 export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...args: any[]) => any};
 
+export type NamespaceEvents<Namespace extends string, Events extends TypedEvents> = {
+	[K in keyof Events as `${Namespace}:${Extract<K, string>}`]: Events[K];
+};
+
 export class TypedEmitter<T extends TypedEvents = TypedEvents> {
-	private listeners: { [key in keyof T]?: Function[] } = {};
+	private static listeners: {[key: string]: Listener[]} = {};
+
+	private listeners: { [key in keyof T]?: Listener[] } = {};
+
+	static emit(event: any, ...args: any[]) {
+		(this.listeners['*'] || []).forEach(l => l(event, ...args));
+		(this.listeners[event.toString()] || []).forEach(l => l(...args));
+	};
+
+	static off(event: any, listener: Listener) {
+		const e = event.toString();
+		this.listeners[e] = (this.listeners[e] || []).filter(l => l === listener);
+	}
+
+	static on(event: any, listener: Listener) {
+		const e = event.toString();
+		if(!this.listeners[e]) this.listeners[e] = [];
+		this.listeners[e]?.push(listener);
+		return () => this.off(event, listener);
+	}
+
+	static once(event: any, listener?: Listener): Promise<any> {
+		return new Promise(res => {
+			const unsubscribe = this.on(event, <any>((...args: any) => {
+				res(args.length == 1 ? args[0] : args);
+				if(listener) listener(...args);
+				unsubscribe();
+			}));
+		});
+	}
 
 	emit<K extends keyof T>(event: K, ...args: Parameters<T[K]>) {
 		(this.listeners['*'] || []).forEach(l => l(event, ...args));
 		(this.listeners[event] || []).forEach(l => l(...args));
 	};
 
-	off<K extends keyof T = string>(event: K, listener: T[K]): this {
+	off<K extends keyof T = string>(event: K, listener: T[K]) {
-		console.log('cleared');
 		this.listeners[event] = (this.listeners[event] || []).filter(l => l === listener);
-		return this;
 	}
 
 	on<K extends keyof T = string>(event: K, listener: T[K]) {

src/errors.ts

@@ -1,15 +1,3 @@
-import {XHR} from './xhr';
-
-XHR.addInterceptor((resp: Response, next: () => {}) => {
-	if(resp.status == 200) return next();
-	if(resp.status == 400) throw new BadRequestError(resp.statusText);
-	if(resp.status == 401) throw new UnauthorizedError(resp.statusText);
-	if(resp.status == 403) throw new ForbiddenError(resp.statusText);
-	if(resp.status == 404) throw new NotFoundError(resp.statusText);
-	if(resp.status == 500) throw new InternalServerError(resp.statusText);
-	throw new CustomError(resp.statusText, resp.status);
-});
-
 export class CustomError extends Error {
 	static code = 500;
 
@@ -65,6 +53,18 @@ export class UnauthorizedError extends CustomError {
 	}
 }
 
+export class PaymentRequiredError extends CustomError {
+	static code = 402;
+
+	constructor(message: string = 'Payment Required') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
 export class ForbiddenError extends CustomError {
 	static code = 403;
 
@@ -89,6 +89,30 @@ export class NotFoundError extends CustomError {
 	}
 }
 
+export class MethodNotAllowedError extends CustomError {
+	static code = 405;
+
+	constructor(message: string = 'Method Not Allowed') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
+export class NotAcceptableError extends CustomError {
+	static code = 406;
+
+	constructor(message: string = 'Not Acceptable') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
 export class InternalServerError extends CustomError {
 	static code = 500;
 
@@ -100,3 +124,89 @@ export class InternalServerError extends CustomError {
 		return (<any>err).constructor.code == this.code;
 	}
 }
+
+export class NotImplementedError extends CustomError {
+	static code = 501;
+
+	constructor(message: string = 'Not Implemented') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
+export class BadGatewayError extends CustomError {
+	static code = 502;
+
+	constructor(message: string = 'Bad Gateway') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
+export class ServiceUnavailableError extends CustomError {
+	static code = 503;
+
+	constructor(message: string = 'Service Unavailable') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
+export class GatewayTimeoutError extends CustomError {
+	static code = 504;
+
+	constructor(message: string = 'Gateway Timeout') {
+		super(message);
+	}
+
+	static instanceof(err: Error) {
+		return (<any>err).constructor.code == this.code;
+	}
+}
+
+/**
+ * Create the correct error object from a status code
+ * @param {number} code Will be converted to respective error (ex. 404 -> NotFoundError)
+ * @param {string} message Override default error message
+ * @return {CustomError} The proper error type
+ */
+export function errorFromCode(code: number, message?: string) {
+	if(code >= 200 && code < 300) return null;
+	switch(code) {
+		case 400:
+			return new BadRequestError(message);
+		case 401:
+			return new UnauthorizedError(message);
+		case 402:
+			return new PaymentRequiredError(message);
+		case 403:
+			return new ForbiddenError(message);
+		case 404:
+			return new NotFoundError(message);
+		case 405:
+			return new MethodNotAllowedError(message);
+		case 406:
+			return new NotAcceptableError(message);
+		case 500:
+			return new InternalServerError(message);
+		case 501:
+			return new NotImplementedError(message);
+		case 502:
+			return new BadGatewayError(message);
+		case 503:
+			return new ServiceUnavailableError(message);
+		case 504:
+			return new GatewayTimeoutError(message);
+		default:
+			return new CustomError(message, code);
+	}
+}

src/files.ts

@@ -0,0 +1,95 @@
+import {makeArray} from './array.ts';
+import {JSONAttemptParse} from './objects.ts';
+import {PromiseProgress} from './promise-progress';
+
+/**
+ * Download blob as a file
+ *
+ * @param {Blob} blob File as a blob
+ * @param {string} name Name blob will be downloaded as
+ */
+export function downloadFile(blob: Blob | string | string[], name: string) {
+	if(!(blob instanceof Blob)) blob = new Blob(makeArray(blob));
+	const url = URL.createObjectURL(blob);
+	downloadUrl(url, name);
+	URL.revokeObjectURL(url);
+}
+
+/**
+ * Download a file from a URL
+ *
+ * @param href URL that will be downloaded
+ * @param {string} name Override download name
+ */
+export function downloadUrl(href: any, name?: string) {
+	const a = document.createElement('a');
+	a.href = href;
+	a.download = name || href.split('/').pop();
+	document.body.appendChild(a);
+	a.click();
+	document.body.removeChild(a);
+}
+
+/**
+ * Open filebrowser & return selected file
+ *
+ * @param {{accept?: string, multiple?: boolean}} options accept - selectable mimetypes, multiple - Allow selecting more than 1 file
+ * @return {Promise<File[]>} Array of selected files
+ */
+export function fileBrowser(options: {accept?: string, multiple?: boolean} = {}): Promise<File[]> {
+	return new Promise(res => {
+		const input = document.createElement('input');
+		input.type = 'file';
+		input.accept = options.accept || '*';
+		input.style.display='none';
+		input.multiple = !!options.multiple;
+		input.onblur = input.onchange = async () => {
+			res(Array.from(<any>input.files));
+			input.remove();
+		}
+		document.body.appendChild(input);
+		input.click();
+	});
+}
+
+/**
+ * Create timestamp intended for filenames from a date
+ *
+ * @param {string} name Name of file, `{{TIMESTAMP}}` will be replaced
+ * @param {Date | number | string} date Date to use for timestamp
+ * @return {string} Interpolated filename, or the raw timestamp if name was omitted
+ */
+export function timestampFilename(name?: string, date: Date | number | string = new Date()) {
+	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
+	const timestamp = `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}_${date.getHours().toString().padStart(2, '0')}-${date.getMinutes().toString().padStart(2, '0')}-${date.getSeconds().toString().padStart(2, '0')}`;
+	return name ? name.replace('{{TIMESTAMP}}', timestamp) : timestamp;
+}
+
+/**
+ * Upload file to URL with progress callback using PromiseProgress
+ *
+ * @param {{url: string, files: File[], headers?: {[p: string]: string}, withCredentials?: boolean}} options
+ * @return {PromiseProgress<T>} Promise of request with `onProgress` callback
+ */
+export function uploadWithProgress<T>(options: {
+	url: string;
+	files: File[];
+	headers?: {[key: string]: string};
+	withCredentials?: boolean;
+}): PromiseProgress<T> {
+	return new PromiseProgress<T>((res, rej, prog) => {
+		const xhr = new XMLHttpRequest();
+		const formData = new FormData();
+		options.files.forEach(f => formData.append('file', f));
+
+		xhr.withCredentials = !!options.withCredentials;
+		xhr.upload.addEventListener('progress', (event) => event.lengthComputable ? prog(event.loaded / event.total) : null);
+		xhr.addEventListener('loadend', () => res(<T>JSONAttemptParse(xhr.responseText)));
+		xhr.addEventListener('error', () => rej(JSONAttemptParse(xhr.responseText)));
+		xhr.addEventListener('timeout', () => rej({error: 'Request timed out'}));
+
+		xhr.open('POST', options.url);
+		Object.entries(options.headers || {}).forEach(([key, value]) => xhr.setRequestHeader(key, value));
+		xhr.send(formData);
+	});
+}

src/http.ts

@@ -0,0 +1,121 @@
+import {clean} from './objects';
+import {PromiseProgress} from './promise-progress';
+
+export type DecodedResponse<T> = Response & {data: T | null}
+
+export type HttpInterceptor = (response: Response, next: () => void) => void;
+
+export type HttpRequestOptions = {
+	body?: any;
+	decode?: boolean;
+	fragment?: string;
+	headers?: {[key: string | symbol]: string | null | undefined};
+	method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+	query?: {key: string, value: string}[] | {[key: string]: string};
+	url?: string;
+	[key: string]: any;
+}
+
+export type HttpDefaults = {
+	headers?: {[key: string | symbol]: string | null | undefined};
+	interceptors?: HttpInterceptor[];
+	url?: string;
+}
+
+export class Http {
+	private static interceptors: {[key: string]: HttpInterceptor} = {};
+
+	static headers: {[key: string]: string | null | undefined} = {};
+
+	private interceptors: {[key: string]: HttpInterceptor} = {}
+
+	headers: {[key: string]: string | null | undefined} = {}
+	url!: string | null;
+
+	constructor(defaults: HttpDefaults = {}) {
+		this.url = defaults.url ?? null;
+		this.headers = defaults.headers || {};
+		if(defaults.interceptors) {
+			defaults.interceptors.forEach(i => Http.addInterceptor(i));
+		}
+	}
+
+	static addInterceptor(fn: HttpInterceptor): () => void {
+		const key = Object.keys(Http.interceptors).length.toString();
+		Http.interceptors[key] = fn;
+		return () => { Http.interceptors[key] = <any>null; }
+	}
+
+	addInterceptor(fn: HttpInterceptor): () => void {
+		const key = Object.keys(this.interceptors).length.toString();
+		this.interceptors[key] = fn;
+		return () => { this.interceptors[key] = <any>null; }
+	}
+
+	request<T>(opts: HttpRequestOptions = {}): PromiseProgress<DecodedResponse<T>>  {
+		if(!this.url && !opts.url) throw new Error('URL needs to be set');
+		let url = (opts.url?.startsWith('http') ? opts.url : (this.url || '') + (opts.url || '')).replace(/([^:]\/)\/+/g, '$1');
+		if(opts.fragment) url.includes('#') ? url.replace(/#.*(\?|\n)/g, (match, arg1) => `#${opts.fragment}${arg1}`) : url += '#' + opts.fragment;
+		if(opts.query) {
+			const q = Array.isArray(opts.query) ? opts.query :
+				Object.keys(opts.query).map(k => ({key: k, value: (<any>opts.query)[k]}))
+			url += (url.includes('?') ? '&' : '?') + q.map(q => `${q.key}=${q.value}`).join('&');
+		}
+
+		// Prep headers
+		const headers = <any>clean({
+			'Content-Type': !opts.body ? undefined : (opts.body instanceof FormData ? 'multipart/form-data' : 'application/json'),
+			...Http.headers,
+			...this.headers,
+			...opts.headers
+		});
+
+		if(typeof opts.body == 'object' && opts.body != null && headers['Content-Type'] == 'application/json')
+			opts.body = JSON.stringify(opts.body);
+
+		// Send request
+		return new PromiseProgress((res, rej, prog) => {
+			fetch(url, {
+				headers,
+				method: opts.method || (opts.body ? 'POST' : 'GET'),
+				body: opts.body
+			}).then(async (resp: any) => {
+				for(let fn of [...Object.values(Http.interceptors), ...Object.values(this.interceptors)]) {
+					await new Promise<void>(res => fn(resp, () => res()));
+				}
+
+				const contentLength = resp.headers.get('Content-Length');
+				const total = contentLength ? parseInt(contentLength, 10) : 0;
+				let loaded = 0;
+
+				const reader = resp.body?.getReader();
+				const stream = new ReadableStream({
+					start(controller) {
+						function push() {
+							reader?.read().then((event: any) => {
+								if(event.done) return controller.close();
+								loaded += event.value.byteLength;
+								prog(loaded / total);
+								controller.enqueue(event.value);
+								push();
+							}).catch((error: any) => controller.error(error));
+						}
+						push();
+					}
+				});
+
+				resp.data = new Response(stream);
+				if(opts.decode == null || opts.decode) {
+					const content = resp.headers.get('Content-Type')?.toLowerCase();
+					if(content?.includes('form')) resp.data = <T>await resp.data.formData();
+					else if(content?.includes('json')) resp.data = <T>await resp.data.json();
+					else if(content?.includes('text')) resp.data = <T>await resp.data.text();
+					else if(content?.includes('application')) resp.data = <T>await resp.data.blob();
+				}
+
+				if(resp.ok) res(resp);
+				else rej(resp);
+			})
+		});
+	}
+}

src/index.ts

@@ -1,10 +1,18 @@
 export * from './array';
+export * from './aset';
+export * from './cache';
+export * from './csv';
+export * from './files';
 export * from './emitter';
 export * from './errors';
+export * from './http';
+export * from './jwt';
 export * from './logger';
+export * from './math';
 export * from './misc';
 export * from './objects';
-// export * from './redis';
+export * from './promise-progress';
 export * from './string';
 export * from './time';
-export * from './xhr';
+export * from './types';
+export * from 'var-persist';

src/jwt.ts

@@ -0,0 +1,15 @@
+import {JSONAttemptParse} from './objects.ts';
+
+/**
+ * Decode a JWT payload, this will not check for tampering so be careful
+ *
+ * @param {string} token JWT to decode
+ * @return {unknown} JWT payload
+ */
+export function jwtDecode<T>(token: string): T {
+	const base64 = token.split('.')[1]
+		.replace(/-/g, '+').replace(/_/g, '/');
+	return <T>JSONAttemptParse(decodeURIComponent(atob(base64).split('').map(function(c) {
+		return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
+	}).join('')));
+}

src/logger.ts

@@ -1,3 +1,5 @@
+import {TypedEmitter, TypedEvents} from './emitter';
+
 export const CliEffects = {
 	CLEAR: "\x1b[0m",
 	BRIGHT: "\x1b[1m",
@@ -9,15 +11,22 @@ export const CliEffects = {
 }
 
 export const CliForeground = {
-	BLACK: "\x1b[30m",
+	BLACK: '\x1b[30m',
-	RED: "\x1b[31m",
+	RED: '\x1b[31m',
-	GREEN: "\x1b[32m",
+	GREEN: '\x1b[32m',
-	YELLOW: "\x1b[33m",
+	YELLOW: '\x1b[33m',
-	BLUE: "\x1b[34m",
+	BLUE: '\x1b[34m',
-	MAGENTA: "\x1b[35m",
+	MAGENTA: '\x1b[35m',
-	CYAN: "\x1b[36m",
+	CYAN: '\x1b[36m',
-	WHITE: "\x1b[37m",
+	LIGHT_GREY: '\x1b[37m',
-	GREY: "\x1b[90m",
+	GREY: '\x1b[90m',
+	LIGHT_RED: '\x1b[91m',
+	LIGHT_GREEN: '\x1b[92m',
+	LIGHT_YELLOW: '\x1b[93m',
+	LIGHT_BLUE: '\x1b[94m',
+	LIGHT_MAGENTA: '\x1b[95m',
+	LIGHT_CYAN: '\x1b[96m',
+	WHITE: '\x1b[97m',
 }
 
 export const CliBackground = {
@@ -32,34 +41,75 @@ export const CliBackground = {
 	GREY: "\x1b[100m",
 }
 
-export class Logger {
+export enum LOG_LEVEL {
-	constructor(public readonly namespace: string) { }
+	ERROR = 0,
+	WARN = 1,
+	INFO = 2,
+	LOG = 3,
+	DEBUG = 4,
+}
+
+export type LoggerEvents = TypedEvents & {
+	'ERROR': (...args: any[]) => any;
+	'WARN': (...args: any[]) => any;
+	'INFO': (...args: any[]) => any;
+	'LOG': (...args: any[]) => any;
+	'DEBUG': (...args: any[]) => any;
+};
+
+export class Logger extends TypedEmitter<LoggerEvents> {
+	static LOG_LEVEL: LOG_LEVEL = LOG_LEVEL.DEBUG;
+
+	constructor(public readonly namespace?: string) {
+		super();
+	}
+
+	private pad(text: any, length: number, char: string, end = false) {
+		const t = text.toString();
+		const l = length - t.length;
+		if(l <= 0) return t;
+		const padding = Array(~~(l / char.length)).fill(char).join('');
+		return !end ? padding + t : t + padding;
+	}
 
 	private format(...text: string[]): string {
-		return `${new Date().toISOString()} [${this.namespace}] ${text.join(' ')}`;
+		const now = new Date();
+		const timestamp = `${now.getFullYear()}-${now.getMonth() + 1}-${now.getDate()} ${this.pad(now.getHours().toString(), 2, '0')}:${this.pad(now.getMinutes().toString(), 2, '0')}:${this.pad(now.getSeconds().toString(), 2, '0')}.${this.pad(now.getMilliseconds().toString(), 3, '0', true)}`;
+		return `${timestamp}${this.namespace ? ` [${this.namespace}]` : ''} ${text.join(' ')}`;
 	}
 
 	debug(...args: string[]) {
-		console.log(CliForeground.MAGENTA + this.format(...args) + CliEffects.CLEAR);
+		if(Logger.LOG_LEVEL < LOG_LEVEL.DEBUG) return;
-	}
+		const str = this.format(...args);
-
+		Logger.emit(LOG_LEVEL.DEBUG, str);
-	error(...args: string[]) {
+		console.debug(CliForeground.LIGHT_GREY + str + CliEffects.CLEAR);
-		console.log(CliForeground.RED + this.format(...args) + CliEffects.CLEAR);
-	}
-
-	info(...args: string[]) {
-		console.log(CliForeground.CYAN + this.format(...args) + CliEffects.CLEAR);
 	}
 
 	log(...args: string[]) {
-		console.log(CliEffects.CLEAR + this.format(...args));
+		if(Logger.LOG_LEVEL < LOG_LEVEL.LOG) return;
+		const str = this.format(...args);
+		Logger.emit(LOG_LEVEL.LOG, str);
+		console.log(CliEffects.CLEAR + str);
+	}
+
+	info(...args: string[]) {
+		if(Logger.LOG_LEVEL < LOG_LEVEL.INFO) return;
+		const str = this.format(...args);
+		Logger.emit(LOG_LEVEL.INFO, str);
+		console.info(CliForeground.BLUE + str + CliEffects.CLEAR);
 	}
 
 	warn(...args: string[]) {
-		console.log(CliForeground.YELLOW + this.format(...args) + CliEffects.CLEAR);
+		if(Logger.LOG_LEVEL < LOG_LEVEL.WARN) return;
+		const str = this.format(...args);
+		Logger.emit(LOG_LEVEL.WARN, str);
+		console.warn(CliForeground.YELLOW + str + CliEffects.CLEAR);
 	}
 
-	verbose(...args: string[]) {
+	error(...args: string[]) {
-		console.log(CliForeground.WHITE + this.format(...args) + CliEffects.CLEAR);
+		if(Logger.LOG_LEVEL < LOG_LEVEL.ERROR) return;
+		const str = this.format(...args);
+		Logger.emit(LOG_LEVEL.ERROR, str);
+		console.error(CliForeground.RED + str + CliEffects.CLEAR);
 	}
 }

src/math.ts

@@ -0,0 +1,45 @@
+/**
+ * Convert decimal number to fraction
+ *
+ * @example
+ * ```js
+ * dec2Frac(1.25) // Outputs: "1 1/4"
+ * ```
+ *
+ * @param {number} num Number to convert
+ * @return {string} Fraction with remainder
+ */
+export function dec2Frac(num: number) {
+	const gcd = (a: number, b: number): number => {
+		if (b < 0.0000001) return a;
+		return gcd(b, ~~(a % b));
+	};
+
+	const len = num.toString().length - 2;
+	let denominator = Math.pow(10, len);
+	let numerator = num * denominator;
+	const divisor = gcd(numerator, denominator);
+	numerator = ~~(numerator / divisor);
+	denominator = ~~(denominator / divisor)
+	const remainder = ~~(numerator / denominator);
+	numerator -= remainder * denominator;
+	return `${remainder ? remainder + ' ' : ''}${~~(numerator)}/${~~(denominator)}`;
+}
+
+/**
+ * Convert fraction to decimal number
+ *
+ * @example
+ * ```js
+ * fracToDec('1 1/4') // Outputs: 1.25
+ * ```
+ *
+ * @param {string} frac Fraction to convert
+ * @return {number} Faction as a decimal
+ */
+export function fracToDec(frac: string) {
+	let split = frac.split(' ');
+	const whole = split.length == 2 ? Number(split[0]) : 0;
+	split = (<string>split.pop()).split('/');
+	return whole + (Number(split[0]) / Number(split[1]));
+}

src/misc.ts

@@ -1,63 +1,13 @@
 import {md5} from './string';
 
-/**
- * Convert data into a form encoded format.
- *
- * @param {any} data - data to convert
- * @returns {string} - Ecodeded form data
- */
-export function formEncode(data: any): string {
-	return Object.entries(data).map(([key, value]) =>
-		encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
-	).join('&');
-}
-
 /**
  * Get profile image from Gravatar
  *
  * @param {string} email Account email address
+ * @param {string} def Default image, can be a link or '404', see: https://docs.gravatar.com/general/images/
  * @returns {string} Gravatar URL
  */
-export function gravatar(email: string) {
+export function gravatar(email: string, def='mp') {
 	if(!email) return '';
-	return `https://www.gravatar.com/avatar/${md5(email)}`;
+	return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
-}
-
-/** Parts of a URL */
-export type ParsedUrl = {
-	protocol?: string,
-	subdomain?: string,
-	domain: string,
-	host: string,
-	port?: number,
-	path?: string,
-	query?: {[name: string]: string}
-	fragment?: string
-}
-
-/**
- *
- * @param {string} url
- * @returns {RegExpExecArray}
- */
-export function urlParser(url: string): ParsedUrl {
-	const processed = new RegExp(
-		'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
-		'gm').exec(url);
-	const groups: ParsedUrl = <any>processed?.groups ?? {};
-	const domains = groups.domain.split('.');
-	if(groups['port'] != null) groups.port = Number(groups.port);
-	if(domains.length > 2) {
-		groups.domain = domains.splice(-2, 2).join('.');
-		groups.subdomain = domains.join('.');
-	}
-	if(groups.query) {
-		const split = (<any>groups.query).split('&'), query: any = {};
-		split.forEach((q: any) => {
-			const [key, val] = q.split('=');
-			query[key] = val;
-		});
-		groups.query = query;
-	}
-	return groups;
 }

src/objects.ts

@@ -1,5 +1,5 @@
 /**
- *  Removes any null values from an object in-place
+ * Removes any null values from an object in-place
  *
  * @example
  * ```ts
@@ -27,12 +27,33 @@ export function clean<T>(obj: T, undefinedOnly = false): Partial<T> {
  * Create a deep copy of an object (vs. a shallow copy of references)
  *
  * Should be replaced by `structuredClone` once released.
- *
  * @param {T} value Object to copy
  * @returns {T} Type
+ * @deprecated Please use `structuredClone`
  */
 export function deepCopy<T>(value: T): T {
-	return JSON.parse(JSON.stringify(value));
+	return structuredClone(value);
+}
+
+/**
+ * Merge any number of objects into the target
+ *
+ * @param target Destination of all properties
+ * @param sources Objects that will copied into target
+ * @return {any} The des
+ */
+export function deepMerge<T>(target: any, ...sources: any[]): T {
+	sources.forEach(s => {
+		for(const key in s) {
+			if(s[key] && typeof s[key] == 'object' && !Array.isArray(s[key])) {
+				if(!target[key]) target[key] = {};
+				deepMerge(target[key], s[key]);
+			} else {
+				target[key] = s[key];
+			}
+		}
+	});
+	return target;
 }
 
 /**
@@ -70,8 +91,28 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
 	}, obj);
 }
 
+
 /**
- * Recursively flatten a nested object, while maintaining key structure.
+ * Convert object into URL encoded query string
+ *
+ * @example
+ * ```js
+ * const query = encodeQuery({page: 1, size: 20});
+ * console.log(query); // Output: "page=1&size=20"
+ * ```
+ *
+ * @param {any} data - data to convert
+ * @returns {string} - Encoded form data
+ */
+export function encodeQuery(data: any): string {
+	return Object.entries(data).map(([key, value]) =>
+		encodeURIComponent(key) + '=' + encodeURIComponent(<any>value)
+	).join('&');
+}
+
+
+/**
+ * Recursively flatten a nested object, while maintaining key structure
  *
  * @example
  * ```ts
@@ -98,6 +139,18 @@ export function flattenObj(obj: any, parent?: any, result: any = {}) {
 	}
 }
 
+/**
+ * Convert object to FormData
+ *
+ * @param target - Object to convert
+ * @return {FormData} - Form object
+ */
+export function formData(target: any): FormData {
+	const data = new FormData();
+	Object.entries(target).forEach(([key, value]) => data.append(key, <any>value));
+	return data;
+}
+
 /**
  * Check that an object has the following values
  *
@@ -115,7 +168,7 @@ export function flattenObj(obj: any, parent?: any, result: any = {}) {
  */
 export function includes(target: any, values: any, allowMissing = false): boolean {
 	if(target == undefined) return allowMissing;
-	if(Array.isArray(values)) return values.findIndex((e, i) => !includes(target[i], values[i], allowMissing)) == -1;
+	if(Array.isArray(values)) return values.findIndex((e: any, i: number) => !includes(target[i], values[i], allowMissing)) == -1;
 	const type = typeof values;
 	if(type != typeof target) return false;
 	if(type == 'object') {
@@ -140,3 +193,51 @@ export function isEqual(a: any, b: any): boolean {
 	if(keys.length != Object.keys(b).length) return false;
 	return Object.keys(a).every(key => isEqual(a[key], b[key]));
 }
+
+/**
+ * Experimental: Combine multiple object prototypes into one
+ *
+ * @param target Object that will have prototypes added
+ * @param {any[]} constructors Additionally prototypes that should be merged into target
+ */
+export function mixin(target: any, constructors: any[]) {
+	constructors.forEach(c => {
+		Object.getOwnPropertyNames(c.prototype).forEach((name) => {
+			Object.defineProperty(
+				target.prototype,
+				name,
+				Object.getOwnPropertyDescriptor(c.prototype, name) ||
+				Object.create(null)
+			);
+		});
+	});
+}
+
+/**
+ * Parse JSON but return the original string if it fails
+ *
+ * @param {string} json JSON string to parse
+ * @return {string | T} Object if successful, original string otherwise
+ */
+export function JSONAttemptParse<T>(json: string): T | string {
+	try { return JSON.parse(json); }
+	catch { return json; }
+}
+
+/**
+ * Convert an object to a JSON string avoiding any circular references.
+ *
+ * @param obj Object to convert to JSON
+ * @param {number} space Format the JSON with spaces
+ * @return {string} JSON string
+ */
+export function JSONSanitize(obj: any, space?: number): string {
+	let cache: any[] = [];
+	return JSON.stringify(obj, (key, value) => {
+		if (typeof value === 'object' && value !== null) {
+			if (cache.includes(value)) return;
+			cache.push(value);
+		}
+		return value;
+	}, space);
+}

src/promise-progress.ts

@@ -0,0 +1,72 @@
+export type ProgressCallback = (progress: number) => any;
+
+/**
+ * A promise that fires the `onProgress` callback on incremental progress
+ *
+ * @example
+ * ```js
+ * const promise = new Promise((resolve, reject, progress) => {
+ *   const max = 10;
+ * 	 for(let i = 0; i < max; i++) progress(i / max);
+ * 	 resolve(1);
+ * });
+ *
+ * console.log(promise.progress);
+ *
+ * promise.onProgress(console.log)
+ *        .then(console.log)
+ *        .catch(console.error)
+ *        .finally(...);
+ *
+ * ```
+ */
+export class PromiseProgress<T> extends Promise<T> {
+	private listeners: ProgressCallback[] = [];
+
+	private _progress = 0;
+	get progress() { return this._progress; }
+	set progress(p: number) {
+		if(p == this._progress) return;
+		this._progress = p;
+		this.listeners.forEach(l => l(p));
+	}
+
+	constructor(executor: (resolve: (value: T) => any, reject: (reason: any) => void, progress: (progress: number) => any) => void) {
+		super((resolve, reject) => executor(
+			(value: T) => resolve(value),
+			(reason: any) => reject(reason),
+			(progress: number) => this.progress = progress,
+		));
+	}
+
+	static from<T>(promise: Promise<T>): PromiseProgress<T> {
+		if(promise instanceof PromiseProgress) return promise;
+		return new PromiseProgress<T>((res, rej) => promise
+			.then((...args) => res(...args))
+			.catch((...args) => rej(...args)));
+	}
+
+	private from(promise: Promise<T>): PromiseProgress<T> {
+		const newPromise = PromiseProgress.from(promise);
+		this.onProgress(p => newPromise.progress = p);
+		return newPromise;
+	}
+
+	onProgress(callback: ProgressCallback) {
+		this.listeners.push(callback);
+		return this;
+	}
+
+	then(res?: (v: T) => any, rej?: (err: any) => any): PromiseProgress<any> {
+		const resp = super.then(res, rej);
+		return this.from(resp);
+	}
+
+	catch(rej?: (err: any) => any): PromiseProgress<any> {
+		return this.from(super.catch(rej));
+	}
+
+	finally(res?: () => any): PromiseProgress<any> {
+		return this.from(super.finally(res));
+	}
+}

src/redis.ts

@@ -1,72 +0,0 @@
-// import {createClient, RedisClientType} from 'redis';
-// import {environment} from '../environments/environment';
-//
-// export type RedisKey = string | string[];
-//
-// export let Redis!: RedisClientType & {
-// 	// get/set shimmed for JSON
-// 	jGet: (redisKey: string) => Promise<any>,
-// 	jSet: (redisKey: string, obj: any, opts?: any) => Promise<void>,
-// 	// hGet/hSet shimmed for objects
-// 	oGet: (redisKey: string) => Promise<any>;
-// 	oSet: (redisKey: string, obj: any) => Promise<void>,
-// 	// Helpers
-// 	findKeys: (filter: RedisKey) => Promise<string[]>,
-// 	forEach: (filter: RedisKey, cb: (key: string) => any) => Promise<void>,
-// };
-//
-// export async function connectRedis(retry = 3) {
-// 	Redis = <any>createClient({
-// 		url: `redis://host:port`
-// 	});
-// 	if(!Redis && retry > 0) {
-// 		await connectRedis(retry - 1);
-// 	} else if(!!Redis) {
-// 		Redis.jGet = async (redisKey: string) => {
-// 			const val = await Redis.get(redisKey);
-// 			return val ? JSON.parse(val) || val : null;
-// 		};
-// 		Redis.jSet = (redisKey: string, obj: any, opts?: any) => {
-// 			return Redis.set(redisKey, JSON.stringify(obj), opts).then(() => {});
-// 		};
-// 		Redis.oGet = async (redisKey: string) => {
-// 			if(!(await Redis.hLen(redisKey))) return null;
-// 			const val = await Redis.hGetAll(redisKey);
-// 			Object.entries(val).forEach(([key, v]) => val[key] = JSON.parse(v));
-// 			return val;
-// 		};
-// 		Redis.oSet = (redisKey: string, obj: any) => {
-// 			const r = Redis.multi();
-// 			Object.entries(obj).forEach(([key, val]) => {
-// 				r.hSet(redisKey, key, JSON.stringify(val));
-// 			});
-// 			return r.exec().then(() => {});
-// 		};
-// 		Redis.findKeys = async (filter: RedisKey): Promise<string[]> => {
-// 			const found: string[] = [];
-// 			await Redis.forEach(filter, (key: string) => found.push(key));
-// 			return found;
-// 		}
-// 		Redis.forEach = async (filter: RedisKey, cb: (key: string) => any): Promise<void> => {
-// 			for await (const k of Redis.scanIterator({MATCH: createKey(filter)})) {
-// 				const rtn = cb(k);
-// 				if(rtn instanceof Promise) await rtn;
-// 			}
-// 		}
-// 		await Redis.connect();
-// 	}
-// }
-//
-// export function createKey(...keys: (string | string[])[]) {
-// 	return keys.flat().map(k => k == null ? '*' : k).join(':');
-// }
-//
-// export function namespacedKey(namespace: string, key: RedisKey): string {
-// 	return createKey(namespace, ...(Array.isArray(key) ? key : [key]));
-// }
-//
-// export function nameSpacer(namespace: string) {
-// 	return (key: RedisKey) => {
-// 		return namespacedKey(namespace, key);
-// 	};
-// }

src/string.ts

@@ -1,20 +1,12 @@
-export function countChars(text: string, pattern: RegExp) {
+import {dotNotation, flattenObj} from './objects.ts';
-	return text.length - text.replaceAll(pattern, '').length;
-}
-
-export function createHex(length: number) {
-	return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
-}
 
 /**
  * String of all letters
- *
  */
 const LETTER_LIST = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
 
 /**
  * String of all numbers
- *
  */
 const NUMBER_LIST = '0123456789';
 
@@ -28,6 +20,27 @@ const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
  */
 const CHAR_LIST = LETTER_LIST + NUMBER_LIST + SYMBOL_LIST;
 
+/**
+ * Convert number of bytes into a human-readable size
+ *
+ * @param {number} bytes Number of bytes
+ * @param {number} decimals Decimal places to preserve
+ * @return {string} Formated size
+ */
+export function formatBytes(bytes: number, decimals = 2) {
+	if (bytes === 0) return '0 Bytes';
+	const k = 1024;
+	const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+	const i = Math.floor(Math.log(bytes) / Math.log(k));
+	return parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + ' ' + sizes[i];
+}
+
+/**
+ * Extract numbers from a string & create a formated phone number: +1 (123) 456-7890
+ *
+ * @param {string} number String that will be parsed for numbers
+ * @return {string} Formated phone number
+ */
 export function formatPhoneNumber(number: string) {
 	const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
 	if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
@@ -38,7 +51,7 @@ export function formatPhoneNumber(number: string) {
  * Insert a string into another string at a given position
  *
  * @example
- * ```
+ * ```js
  * console.log(insertAt('Hello world!', ' glorious', 5);
  * // Output: Hello glorious world!
  * ```
@@ -52,6 +65,38 @@ export function insertAt(target: string, str: string, index: number): String {
 	return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
 }
 
+/**
+ * Add padding to string
+ *
+ * @example
+ * ```js
+ * const now = new Date();
+ * const padded = now.getHours() + ':' + pad(now.getMinutes(), 2, '0');
+ * console.log(padded); // Output: "2:05"
+ * ```
+ *
+ * @param text Text that will be padded
+ * @param {number} length Target length
+ * @param {string} char Character to use as padding, defaults to space
+ * @param {boolean} start Will pad start of text if true, or the end if false
+ * @return {string} Padded string
+ * @deprecated Please use `String.padStart` & `String.padEnd`
+ */
+export function pad(text: any, length: number, char: string = ' ', start = true) {
+	if(start) return text.toString().padStart(length, char);
+	return text.toString().padEnd(length, char);
+}
+
+/**
+ * Generate a random hexadecimal value
+ *
+ * @param {number} length Number of hexadecimal place values
+ * @return {string} Hexadecimal number as a string
+ */
+export function randomHex(length: number) {
+	return Array(length).fill(null).map(() => Math.round(Math.random() * 0xF).toString(16)).join('');
+}
+
 /**
  * Generate a string of random characters.
  *
@@ -133,8 +178,50 @@ export function matchAll(value: string, regex: RegExp | string): RegExpExecArray
 	return ret;
 }
 
+/** Parts of a URL */
+export type ParsedUrl = {
+	protocol?: string,
+	subdomain?: string,
+	domain: string,
+	host: string,
+	port?: number,
+	path?: string,
+	query?: {[name: string]: string}
+	fragment?: string
+}
+
+/**
+ * Break a URL string into its parts for easy parsing
+ *
+ * @param {string} url URL string that will be parsed
+ * @returns {RegExpExecArray} Parts of URL
+ */
+export function parseUrl(url: string): ParsedUrl {
+	const processed = new RegExp(
+		'(?:(?<protocol>[\\w\\d]+)\\:\\/\\/)?(?:(?<user>.+)\\@)?(?<host>(?<domain>[^:\\/\\?#@\\n]+)(?:\\:(?<port>\\d*))?)(?<path>\\/.*?)?(?:\\?(?<query>.*?))?(?:#(?<fragment>.*?))?$',
+		'gm').exec(url);
+	const groups: ParsedUrl = <any>processed?.groups ?? {};
+	const domains = groups.domain.split('.');
+	if(groups['port'] != null) groups.port = Number(groups.port);
+	if(domains.length > 2) {
+		groups.domain = domains.splice(-2, 2).join('.');
+		groups.subdomain = domains.join('.');
+	}
+	if(groups.query) {
+		const split = (<any>groups.query).split('&'), query: any = {};
+		split.forEach((q: any) => {
+			const [key, val] = q.split('=');
+			query[key] = val;
+		});
+		groups.query = query;
+	}
+	return groups;
+}
+
+
 /**
  * Create MD5 hash using native javascript
+ *
  * @param d String to hash
  * @returns {string} Hashed string
  */

src/time.ts

@@ -1,3 +1,52 @@
+/**
+ * Return date formated highest to lowest: YYYY-MM-DD H:mm AM
+ *
+ * @param {Date | number | string} date Date or timestamp to convert to string
+ * @return {string} Formated date
+ */
+export function formatDate(date: Date | number | string): string {
+	if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
+	let hours = date.getHours(), postfix = 'AM';
+	if(hours >= 12) {
+		if(hours > 12) hours -= 12;
+		postfix = 'PM';
+	} else if(hours == 0) hours = 12;
+	return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}, ${hours}:${date.getMinutes().toString().padStart(2, '0')} ${postfix}`;
+}
+
+/**
+ * Use in conjunction with `await` to pause an async script
+ *
+ * @example
+ * ```js
+ * await sleep(1000) // Pause for 1 second
+ * ```
+ *
+ * @param {number} ms - Time to pause for in milliseconds
+ * @returns {Promise<unknown>} - Resolves promise when it's time to resume
+ */
+export function sleep(ms: number): Promise<void> {
+	return new Promise(res => setTimeout(res, ms));
+}
+
+/**
+ * Sleep while function returns true
+ *
+ * @example
+ * ```js
+ * let loading = true;
+ * setTimeout(() => wait = false, 1000);
+ * await sleepWhile(() => loading); // Won't continue until loading flag is false
+ * ```
+ *
+ * @param {() => boolean | Promise<boolean>} fn Return true to continue
+ * @param {number} checkInterval Run function ever x milliseconds
+ * @return {Promise<void>} Callback when sleep is over
+ */
+export async function sleepWhile(fn : () => boolean | Promise<boolean>, checkInterval = 100): Promise<void> {
+	while(await fn()) await sleep(checkInterval);
+}
+
 /**
  * Calculate the number of milliseconds until date/time
  *
@@ -7,34 +56,3 @@
 export function timeUntil(date: Date | number): number {
 	return (date instanceof Date ? date.getTime() : date) - (new Date()).getTime();
 }
-
-/**
- * Use in conjunction with `await` to pause an async script
- *
- * @example
- * ```ts
- * async () => {
- *      ...
- *      await sleep(1000) // Pause for 1 second
- *	    ...
- * }
- * ```
- *
- * @param {number} ms - Time to pause for in milliseconds
- * @returns {Promise<unknown>} - Resolves promise when it's time to resume
- */
-export function sleep(ms: number) {
-	return new Promise(res => setTimeout(res, ms));
-}
-
-export function formatDate(date: Date | number | string) {
-	const d = date instanceof Date ? date : new Date(date);
-	return new Intl.DateTimeFormat("en-us", {
-		weekday: "long",
-		month: "short",
-		day: "numeric",
-		hour: "numeric",
-		minute: "numeric",
-		hour12: true
-	}).format(d);
-}

src/types.ts

@@ -0,0 +1,20 @@
+/**
+ * Return keys on a type as an array of strings
+ *
+ * @example
+ * ```ts
+ * type Person = {
+ * 	  firstName: string;
+ * 	  lastName: string;
+ * 	  age: number;
+ * }
+ *
+ * const keys = typeKeys<Person>();
+ * console.log(keys); // Output: ["firstName", "lastName", "age"]
+ * ```
+ *
+ * @return {Array<keyof T>} Available keys
+ */
+export function tyoeKeys<T extends object>() {
+	return Object.keys(<T>{}) as Array<keyof T>;
+}

src/xhr.ts

@@ -1,92 +0,0 @@
-export type FetchInterceptor = (resp: Response, next: () => any) => any;
-
-export class XHR<T> {
-	private static interceptors: {[key: number]: FetchInterceptor} = {};
-	static headers: Record<string, string | null> = {};
-
-	private interceptors: {[key: string]: FetchInterceptor} = {};
-
-	constructor(public readonly baseUrl: string,
-				public readonly headers: Record<string, string | null> = {}
-	) { }
-
-	static addInterceptor(fn: FetchInterceptor): () => {};
-	static addInterceptor(key: string, fn: FetchInterceptor): () => {};
-	static addInterceptor(keyOrFn: string | FetchInterceptor, fn?: FetchInterceptor): () => {} {
-		const func: any = fn ? fn : keyOrFn;
-		const key: string = typeof keyOrFn == 'string' ? keyOrFn :
-			`_${Object.keys(XHR.interceptors).length.toString()}`;
-		XHR.interceptors[<any>key] = func;
-		return () => delete XHR.interceptors[<any>key];
-	}
-
-	addInterceptor(fn: FetchInterceptor): () => {};
-	addInterceptor(key: string, fn: FetchInterceptor): () => {};
-	addInterceptor(keyOrFn: string | FetchInterceptor, fn?: FetchInterceptor): () => {} {
-		const func: any = fn ? fn : keyOrFn;
-		const key: string = typeof keyOrFn == 'string' ? keyOrFn :
-			`_${Object.keys(this.interceptors).length.toString()}`;
-		this.interceptors[<any>key] = func;
-		return () => delete this.interceptors[<any>key];
-	}
-
-	getInterceptors() {
-		return [...Object.values(XHR.interceptors), ...Object.values(this.interceptors)];
-	}
-
-	fetch<T2 = T>(href?: string, body?: any, opts: any = {}): Promise<T2> {
-		const headers =  {
-			'Content-Type': (body && !(body instanceof FormData)) ? 'application/json' : undefined,
-			...XHR.headers,
-			...this.headers,
-			...opts.headers
-		};
-		Object.keys(headers).forEach(h => { if(!headers[h]) delete headers[h]; });
-		return fetch(`${this.baseUrl}${href || ''}`.replace(/([^:]\/)\/+/g, '$1'), {
-			headers,
-			method: opts.method || (body ? 'POST' : 'GET'),
-			body: (headers['Content-Type']?.startsWith('application/json') && body) ? JSON.stringify(body) : body
-		}).then(async resp => {
-			for(let fn of this.getInterceptors()) {
-				const wait = new Promise(res =>
-					fn(resp, () => res(null)));
-				await wait;
-			}
-			if(resp.headers.has('Content-Type')) {
-				if(resp.headers.get('Content-Type')?.startsWith('application/json')) return await resp.json();
-				if(resp.headers.get('Content-Type')?.startsWith('text/plain')) return await resp.text();
-			}
-			return resp;
-		});
-	}
-
-	delete<T2 = void>(url?: string, opts?: any): Promise<T2> {
-		return this.fetch(url, null, {method: 'delete', ...opts});
-	}
-
-	get<T2 = T>(url?: string, opts?: any): Promise<T2> {
-		return this.fetch(url, null, {method: 'get', ...opts});
-	}
-
-	patch<T2 = T>(data: T2, url?: string, opts?: any): Promise<T2> {
-		return this.fetch(url, data, {method: 'patch', ...opts});
-	}
-
-	post<T2 = T>(data: T2, url?: string, opts?: any): Promise<T2> {
-		return this.fetch(url, data, {method: 'post', ...opts});
-	}
-
-	put<T2 = T>(data: Partial<T2>, url?: string, opts?: any): Promise<T2> {
-		return this.fetch(url, data, {method: 'put', ...opts});
-	}
-
-	new<T2 = T>(href: string, headers: Record<string, string | null>): XHR<T2> {
-		const fetch = new XHR<T2>(`${this.baseUrl}${href}`, {
-			...this.headers,
-			...headers,
-		});
-		Object.entries(this.interceptors).map(([key, value]) =>
-			fetch.addInterceptor(key, value));
-		return fetch;
-	}
-}

tests/misc.spec.ts

@@ -1,4 +1,4 @@
-import {sleep, urlParser} from '../src';
+import {sleep, parseUrl} from '../src';
 
 describe('Miscellanies Utilities', () => {
 	describe('sleep', () => {
@@ -12,7 +12,7 @@ describe('Miscellanies Utilities', () => {
 
 	describe('urlParser', () => {
 		test('localhost w/ port', () => {
-			const parsed = urlParser('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
+			const parsed = parseUrl('http://localhost:4200/some/path?q1=test1&q2=test2#frag');
 			expect(parsed.protocol).toStrictEqual('http');
 			expect(parsed.host).toStrictEqual('localhost:4200');
 			expect(parsed.domain).toStrictEqual('localhost');
@@ -23,7 +23,7 @@ describe('Miscellanies Utilities', () => {
 		});
 
 		test('advanced URL', () => {
-			const parsed = urlParser('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
+			const parsed = parseUrl('https://sub.domain.example.com/some/path?q1=test1&q2=test2#frag');
 			expect(parsed.protocol).toStrictEqual('https');
 			expect(parsed.host).toStrictEqual('sub.domain.example.com');
 			expect(parsed.domain).toStrictEqual('example.com');

tests/object.spec.ts

@@ -29,28 +29,6 @@ describe('Object Utilities', () => {
 		});
 	});
 
-	describe('deepCopy', () => {
-		const copy = deepCopy(TEST_OBJECT);
-		test('Array of arrays', () => {
-			const a = [[1, 2], [3, 4]];
-			const b = deepCopy(a);
-			b[0][1] = 5;
-			expect(a).not.toEqual(b);
-		});
-		test('Change array inside object', () => {
-			copy.b[1] = [1, 1, 1];
-			expect(copy.b[1]).not.toEqual(TEST_OBJECT.b[1]);
-		});
-		test('Change object inside object', () => {
-			copy.g = {h: Math.random()};
-			expect(copy.g).not.toEqual(TEST_OBJECT.g);
-		});
-		test('Change object property inside nested array', () => {
-			copy.c.d[0][0].e = -1;
-			expect(copy.c.d[0][0].e).not.toEqual(TEST_OBJECT.c.d[0][0].e);
-		});
-	});
-
 	describe('dotNotation', () => {
 		test('no object or properties', () => {
 			expect(dotNotation(undefined, 'z')).toStrictEqual(undefined);

tsconfig.json

@@ -1,18 +1,20 @@
 {
-	"include": [
+	"include": ["src"],
-		"src/**/*"
-	],
 	"compilerOptions": {
-		"composite": true,
+		"target": "ES2020",
-		"declaration": true,
+		"useDefineForClassFields": true,
-		"declarationMap": true,
+		"module": "ESNext",
-		"experimentalDecorators": true,
+		"lib": ["ESNext", "DOM", "DOM.Iterable"],
-		"esModuleInterop": true,
+		"skipLibCheck": true,
-		"lib": ["ESNext", "DOM"],
+
-		"module": "ES6",
+		/* Bundler mode */
-		"moduleResolution": "Node",
+		"moduleResolution": "bundler",
-		"outDir": "./dist",
+		"allowImportingTsExtensions": true,
-		"strict": true,
+		"resolveJsonModule": true,
-		"target": "ESNext"
+		"isolatedModules": true,
+		"noEmit": true,
+
+		/* Linting */
+		"strict": true
 	}
 }

vite.config.ts

@@ -1,17 +1,20 @@
-import { resolve } from 'path';
+import {resolve} from 'path';
-import { defineConfig } from 'vite';
+import {defineConfig} from 'vite';
 import dts from 'vite-plugin-dts';
 
 export default defineConfig({
 	build: {
 		lib: {
 			entry: resolve(process.cwd(), 'src/index.ts'),
-			name: 'js-utilities',
+			name: 'utils',
 			fileName: (module, entryName) => {
-				if(module == 'es') return 'js-utilities.mjs';
+				if(module == 'es') return 'index.mjs';
-				if(module == 'umd') return 'js-utilities.js';
+				if(module == 'umd') return 'index.cjs';
 			}
 		},
+		emptyOutDir: true,
+		minify: true,
+		sourcemap: true
 	},
 	plugins: [dts()],
 });