Allow disabling response decoding

.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
@@ -59,31 +48,3 @@ jobs:
           uses: ztimson/actions/tag@develop
           with:
             tag: ${{env.VERSION}}
-
-  publish:
-    name: Publish
-    needs: build
-    if: ${{github.ref_name}} == 'release'
-    runs-on: ubuntu-latest
-    container:
-      image: node
-      volumes:
-        - '/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}}

package-lock.json

@@ -1,12 +1,12 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.4.0",
+	"version": "0.10.4",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "@ztimson/utils",
-			"version": "0.4.0",
+			"version": "0.10.4",
 			"license": "MIT",
 			"devDependencies": {
 				"@types/jest": "^29.5.12",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.8.1",
+	"version": "0.14.7",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
@@ -9,9 +9,16 @@
 		"type": "git",
 		"url": "https://git.zakscode.com/ztimson/js-utilities"
 	},
-	"main": "./dist/utils.cjs",
+	"main": "./dist/index.cjs",
-	"module": "./dist/utils.mjs",
+	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.mjs",
+			"require": "./dist/index.cjs",
+			"types": "./dist/index.d.ts"
+		}
+	},
 	"scripts": {
 		"build": "npx tsc && npx vite build",
 		"test": "npx jest",

src/download.ts

@@ -1,53 +0,0 @@
-import {TypedEmitter, TypedEvents} from './emitter';
-
-export type DownloadEvents = TypedEvents & {
-	complete: (blob: Blob) => any;
-	failed: (error: Error) => any;
-	progress: (progress: number) => any;
-}
-
-export function download(href: any, name: string) {
-	const a = document.createElement('a');
-	a.href = href;
-	a.download = name;
-	document.body.appendChild(a);
-	a.click();
-	document.body.removeChild(a);
-}
-
-/**
- * Download a URL using fetch so progress can be tracked. Uses Typed Emitter to emit a "progress" &
- * "complete" event.
- *
- * @param {string} url
- * @param {string} downloadName
- * @return {TypedEmitter<DownloadEvents>}
- */
-export function downloadProgress(url: string, downloadName?: string) {
-	const progress = new TypedEmitter<DownloadEvents>();
-	fetch(url).then(response => {
-		if(!response.ok) return progress.emit('failed', new Error(response.statusText));
-		const contentLength = response.headers.get('Content-Length') || '0';
-		const total = parseInt(contentLength, 10);
-		let chunks: any[] = [], loaded = 0;
-		const reader = response.body?.getReader();
-		reader?.read().then(function processResult(result) {
-			if(result.done) {
-				const blob = new Blob(chunks);
-				if(downloadName) {
-					const url = URL.createObjectURL(blob);
-					download(url, downloadName);
-					URL.revokeObjectURL(url);
-				}
-				progress.emit('complete', blob);
-			} else {
-				const chunk = result.value;
-				chunks.push(chunk);
-				loaded += chunk.length;
-				progress.emit('progress', loaded / total);
-				reader.read().then(processResult);
-			}
-		});
-	}).catch(err => progress.emit('failed', err));
-	return progress;
-}

src/errors.ts

@@ -1,15 +1,3 @@
-import {XHR} from './xhr';
-
-XHR.addInterceptor((resp: Response, next: () => void) => {
-	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;
 

src/files.ts

@@ -0,0 +1,54 @@
+import {PromiseProgress} from './promise-progress';
+
+export function download(href: any, name: string) {
+	const a = document.createElement('a');
+	a.href = href;
+	a.download = name;
+	document.body.appendChild(a);
+	a.click();
+	document.body.removeChild(a);
+}
+
+export function downloadBlob(blob: Blob, name: string) {
+	const url = URL.createObjectURL(blob);
+	download(url, name);
+	URL.revokeObjectURL(url);
+}
+
+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();
+	});
+}
+
+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.upload.addEventListener('load', (resp) => res(<any>resp));
+		xhr.upload.addEventListener('error', (err) => rej(err));
+
+		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' | '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 !== false) {
+					const content = resp.headers.get('Content-Type')?.toLowerCase();
+					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('form')) resp.data = <T>await resp.data.formData();
+					else if(content?.includes('application')) resp.data = <T>await resp.data.blob();
+				}
+
+				if(resp.ok) res(resp);
+				else rej(resp);
+			})
+		});
+	}
+}

src/index.ts

@@ -1,12 +1,13 @@
 export * from './array';
 export * from './aset';
-export * from './download';
+export * from './files';
 export * from './emitter';
 export * from './errors';
+export * from './http';
 export * from './logger';
+export * from './math';
 export * from './misc';
 export * from './objects';
+export * from './promise-progress';
 export * from './string';
 export * from './time';
-export * from './upload';
-export * from './xhr';

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/objects.ts

@@ -35,6 +35,27 @@ export function deepCopy<T>(value: T): T {
 	return JSON.parse(JSON.stringify(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;
+}
+
 /**
  * Get/set a property of an object using dot notation
  *

src/promise-progress.ts

@@ -0,0 +1,52 @@
+export type ProgressCallback = (progress: number) => any;
+
+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/upload.ts

@@ -1,30 +0,0 @@
-import {TypedEmitter, TypedEvents} from './emitter';
-
-export type UploadEvents = TypedEvents & {
-	complete: () => any;
-	failed: (err: Error) => any;
-	progress: (progress: number) => any;
-}
-
-export function uploadProgress(files : File | FileList, url: string) {
-	const xhr = new XMLHttpRequest();
-	const progress = new TypedEmitter<UploadEvents>();
-	const formData = new FormData();
-	(Array.isArray(files) ? files : [files])
-		.forEach(f => formData.append('file', f));
-
-	xhr.upload.addEventListener("progress", (event) => {
-		if(event.lengthComputable) progress.emit('progress', event.loaded / event.total);
-	});
-
-	xhr.onreadystatechange = () => {
-		if (xhr.readyState === 4) {
-			if(xhr.status >= 200 && xhr.status < 300) progress.emit('complete');
-			else progress.emit('failed', new Error(xhr.responseText));
-		}
-	};
-
-	xhr.open("POST", url, true);
-	xhr.send(formData);
-	return progress;
-}

src/xhr.ts

@@ -1,77 +0,0 @@
-import {TypedEmitter, TypedEvents} from './emitter.ts';
-import {clean} from './objects';
-
-export type Interceptor = (request: Response, next: () => void) => void;
-
-export type RequestOptions = {
-	url?: string;
-	method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
-	body?: any;
-	headers?: {[key: string | symbol]: string | null | undefined};
-	skipConverting?: boolean;
-	[key: string]: any;
-}
-
-export type XhrOptions = {
-	headers?: {[key: string | symbol]: string | null | undefined};
-	interceptors?: Interceptor[];
-	url?: string;
-}
-
-export class XHR {
-	private static interceptors: {[key: string]: Interceptor} = {};
-
-	static headers: {[key: string]: string | null | undefined} = {};
-
-	private interceptors: {[key: string]: Interceptor} = {}
-
-	headers: {[key: string]: string | null | undefined} = {}
-
-	constructor(public readonly opts: XhrOptions = {}) {
-		this.headers = opts.headers || {};
-		if(opts.interceptors) {
-			opts.interceptors.forEach(i => XHR.addInterceptor(i));
-		}
-	}
-
-	static addInterceptor(fn: Interceptor): () => void {
-		const key = Object.keys(XHR.interceptors).length.toString();
-		XHR.interceptors[key] = fn;
-		return () => { XHR.interceptors[key] = <any>null; }
-	}
-
-	addInterceptor(fn: Interceptor): () => void {
-		const key = Object.keys(this.interceptors).length.toString();
-		this.interceptors[key] = fn;
-		return () => { this.interceptors[key] = <any>null; }
-	}
-
-	async request<T>(opts: RequestOptions = {}): Promise<T>  {
-		if(!this.opts.url && !opts.url) throw new Error('URL needs to be set');
-		const url = (opts.url?.startsWith('http') ? opts.url : (this.opts.url || '') + (opts.url || '')).replace(/([^:]\/)\/+/g, '$1');
-
-		// Prep headers
-		const headers = <any>clean({
-			'Content-Type': (opts.body && !(opts.body instanceof FormData)) ? 'application/json' : undefined,
-			...XHR.headers,
-			...this.headers,
-			...opts.headers
-		});
-
-		// Send request
-		return fetch(url, {
-			headers,
-			method: opts.method || (opts.body ? 'POST' : 'GET'),
-			body: (headers['Content-Type']?.startsWith('application/json') && opts.body) ? JSON.stringify(opts.body) : opts.body
-		}).then(async resp => {
-			for(let fn of [...Object.values(XHR.interceptors), ...Object.values(this.interceptors)]) {
-				await new Promise<void>(res => fn(resp, () => res()));
-			}
-
-			if(!resp.ok) throw new Error(resp.statusText);
-			if(!opts.skipConverting && resp.headers.get('Content-Type')?.startsWith('application/json')) return await resp.json();
-			if(!opts.skipConverting && resp.headers.get('Content-Type')?.startsWith('text/plain')) return await <any>resp.text();
-			return resp;
-		});
-	}
-}

vite.config.ts

@@ -8,8 +8,8 @@ export default defineConfig({
 			entry: resolve(process.cwd(), 'src/index.ts'),
 			name: 'utils',
 			fileName: (module, entryName) => {
-				if(module == 'es') return 'utils.mjs';
+				if(module == 'es') return 'index.mjs';
-				if(module == 'umd') return 'utils.cjs';
+				if(module == 'umd') return 'index.cjs';
 			}
 		},
 		emptyOutDir: true,