@hkdigital/lib-sveltekit 0.0.70 → 0.0.72

package/dist/classes/promise/HkPromise.d.ts

@@ -1,8 +1,13 @@
 /**
  * HkPromise extends the default javascript Promise class
+ * - Exposes methods to interact with the state of the
+ *   promise, such as 'resolve' and 'reject'
  */
 export default class HkPromise extends Promise<any> {
-    constructor(initFn: any);
+    /**
+     * @param {()=>void} [initFn]
+     */
+    constructor(initFn?: () => void);
     /**
      * Get value of property [resolved]
      *

package/dist/classes/promise/HkPromise.js

@@ -45,8 +45,24 @@ const hasThen$ = Symbol('hasThen');
 
 /**
  * HkPromise extends the default javascript Promise class
+ * - Exposes methods to interact with the state of the
+ *   promise, such as 'resolve' and 'reject'
  */
 export default class HkPromise extends Promise {
+	// > TODO: convert to JS private properties
+	// #resolveFn
+	// #rejectFn
+	// #pending
+	// #resolved
+	// #rejected
+	// #cancelled
+	// #timeout
+	// #timeoutTimer
+	// #hasThen
+
+	/**
+	 * @param {()=>void} [initFn]
+	 */
 	constructor(initFn) {
 		let _resolveFn;
 		let _rejectFn;
@@ -81,8 +97,6 @@ export default class HkPromise extends Promise {
 		// this[ timeoutTimer$ ] = undefined;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Get value of property [resolved]
 	 *
@@ -92,8 +106,6 @@ export default class HkPromise extends Promise {
 		return this[resolved$] ? true : false;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Get value of property [rejected]
 	 *
@@ -103,8 +115,6 @@ export default class HkPromise extends Promise {
 		return this[rejected$] ? true : false;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Get value of property [pending]
 	 *
@@ -114,8 +124,6 @@ export default class HkPromise extends Promise {
 		return this[pending$];
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Get value of property [cancelled]
 	 *
@@ -125,8 +133,6 @@ export default class HkPromise extends Promise {
 		return this[cancelled$] ? true : false;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Get value of property [timeout]
 	 *
@@ -136,8 +142,6 @@ export default class HkPromise extends Promise {
 		return this[timeout$] ? true : false;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Resolve the promise
 	 *
@@ -191,8 +195,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Reject the promise
 	 *
@@ -238,8 +240,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Reject the promise if the promise is still pending
 	 *
@@ -256,8 +256,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Reject the promise and set this.cancelled=true
 	 *
@@ -283,8 +281,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Reject the promise and set this.cancelled=true
 	 *
@@ -301,8 +297,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Specify the number of milliseconds until the promise should time out.
 	 * - When a timeout occurs: the promise is cancelled and the following
@@ -360,8 +354,6 @@ export default class HkPromise extends Promise {
 		return this;
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Register a callback that is called when the promise resolves
 	 *
@@ -373,8 +365,6 @@ export default class HkPromise extends Promise {
 		return super.then(...arguments);
 	}
 
-	// -------------------------------------------------------------------- Method
-
 	/**
 	 * Register a callback that is called when the promise rejects, is
 	 * cancelled or times out

package/dist/util/http/http-request.d.ts

@@ -7,7 +7,7 @@
 /**
  * Make GET request
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -25,13 +25,19 @@
  *   If defined, this request will abort after the specified number of
  *   milliseconds. Values above the the built-in request timeout won't work.
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
-export function httpGet({ url, urlSearchParams, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+export function httpGet({ url, urlSearchParams, headers, requestHandler, timeoutMs }: {
+    url: string | URL;
+    urlSearchParams?: object;
+    headers?: object;
+    requestHandler?: requestHandler;
+    timeoutMs?: number;
+}): Promise<Response>;
 /**
  * Make POST request
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -48,15 +54,21 @@ export function httpGet({ url, urlSearchParams, headers, requestHandler, timeout
  *   If defined, this request will abort after the specified number of
  *   milliseconds. Values above the the built-in request timeout won't work.
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
-export function httpPost({ url, body, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+export function httpPost({ url, body, headers, requestHandler, timeoutMs }: {
+    url: string | URL;
+    body?: any;
+    headers?: object;
+    requestHandler?: requestHandler;
+    timeoutMs?: number;
+}): Promise<Response>;
 /**
  * Make an HTTP request
  * - This is a low level function, consider using
  *   httpGet, httpPost, jsonGet or jsonPost instead
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -82,7 +94,15 @@ export function httpPost({ url, body, headers, requestHandler, timeoutMs }: stri
  * @note Check the `ok` property of the resolved response to check if the
  *       response was successfull (e.g. in case of a 404, ok is false)
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
-export function httpRequest({ method, url, urlSearchParams, body, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+export function httpRequest({ method, url, urlSearchParams, body, headers, requestHandler, timeoutMs }: {
+    url: string | URL;
+    method: string;
+    urlSearchParams?: object;
+    body?: any;
+    headers?: object;
+    requestHandler?: requestHandler;
+    timeoutMs?: number;
+}): Promise<Response>;
 export type requestHandler = (controller: AbortController, abort: (reason?: Error) => void, timeout: (delayMs: number) => void) => any;

package/dist/util/http/http-request.js

@@ -21,7 +21,7 @@ import { waitForAndCheckResponse } from './response.js';
 /**
  * Make GET request
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -39,7 +39,7 @@ import { waitForAndCheckResponse } from './response.js';
  *   If defined, this request will abort after the specified number of
  *   milliseconds. Values above the the built-in request timeout won't work.
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
 export async function httpGet({ url, urlSearchParams, headers, requestHandler, timeoutMs }) {
 	const responsePromise = httpRequest({
@@ -57,7 +57,7 @@ export async function httpGet({ url, urlSearchParams, headers, requestHandler, t
 /**
  * Make POST request
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -74,7 +74,7 @@ export async function httpGet({ url, urlSearchParams, headers, requestHandler, t
  *   If defined, this request will abort after the specified number of
  *   milliseconds. Values above the the built-in request timeout won't work.
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
 export async function httpPost({ url, body = null, headers, requestHandler, timeoutMs }) {
 	const responsePromise = httpRequest({
@@ -96,7 +96,7 @@ export async function httpPost({ url, body = null, headers, requestHandler, time
  * - This is a low level function, consider using
  *   httpGet, httpPost, jsonGet or jsonPost instead
  *
- * @paramm {object} _
+ * @param {object} _
  *
  * @param {string|URL} _.url - Url string or URL object
  *
@@ -122,7 +122,7 @@ export async function httpPost({ url, body = null, headers, requestHandler, time
  * @note Check the `ok` property of the resolved response to check if the
  *       response was successfull (e.g. in case of a 404, ok is false)
  *
- * @returns {Promise<*>} responsePromise
+ * @returns {Promise<Response>} responsePromise
  */
 export async function httpRequest({
 	method,

package/dist/util/http/response.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @callback progressCallback
+ * @param {object} _
+ * @param {number} _.bytesLoaded
+ * @param {number} _.size
+ */
 /**
  * Check if the response status is ok
  *
@@ -30,3 +36,21 @@ export function getResponseSize(response: Response): number;
  * @returns {object} response
  */
 export function waitForAndCheckResponse(responsePromise: Promise<object>, url: URL): object;
+/**
+ * Load response body as ArrayBuffer
+ * - Progress can be monitored by suppying an onProgress callback
+ * - Loading can be aborted by calling the returned abort function
+ *
+ * @param {Response} response - Fetch response
+ * @param {progressCallback} onProgress
+ *
+ * @returns {{ bufferPromise: Promise<ArrayBuffer>, abort: () => void }}
+ */
+export function loadResponseBuffer(response: Response, onProgress: progressCallback): {
+    bufferPromise: Promise<ArrayBuffer>;
+    abort: () => void;
+};
+export type progressCallback = (_: {
+    bytesLoaded: number;
+    size: number;
+}) => any;

package/dist/util/http/response.js

@@ -7,6 +7,17 @@ import { href } from './url.js';
 
 import { getErrorFromResponse } from './errors.js';
 
+// > Types
+
+/**
+ * @callback progressCallback
+ * @param {object} _
+ * @param {number} _.bytesLoaded
+ * @param {number} _.size
+ */
+
+// > Exports
+
 /**
  * Check if the response status is ok
  *
@@ -116,3 +127,91 @@ export async function waitForAndCheckResponse(responsePromise, url) {
 
 	return response;
 }
+
+/**
+ * Load response body as ArrayBuffer
+ * - Progress can be monitored by suppying an onProgress callback
+ * - Loading can be aborted by calling the returned abort function
+ *
+ * @param {Response} response - Fetch response
+ * @param {progressCallback} onProgress
+ *
+ * @returns {{ bufferPromise: Promise<ArrayBuffer>, abort: () => void }}
+ */
+export function loadResponseBuffer(response, onProgress) {
+	// @note size might be 0
+	const size = getResponseSize(response);
+
+	let bytesLoaded = 0;
+
+	if (onProgress && size) {
+		onProgress({ bytesLoaded, size });
+	}
+
+	if (!response.body) {
+		throw new Error('Missing [response.body]');
+	}
+
+	const reader = response.body.getReader();
+
+	let aborted = false;
+
+	/**
+	 * @returns {Promise<ArrayBuffer>}
+	 */
+	async function read() {
+		let loading = true;
+		let chunks = [];
+
+		// - Use flag 'loading'
+		// - Check if #abortLoading still exists
+		while (loading) {
+			const { done, value } = await reader.read();
+
+			if (done || aborted) {
+				// Loading complete or this.#abortLoading has been cleared,
+				// which is done when the request has been cancelled
+				loading = false;
+			} else {
+				bytesLoaded += value.length;
+
+				if (size && bytesLoaded > size) {
+					throw new Error(`Received more bytes that specified by header content-length`);
+				}
+
+				chunks.push(value);
+
+				if (onProgress && size) {
+					onProgress({ bytesLoaded, size });
+				}
+			}
+		} // end while
+
+		if (size && bytesLoaded !== size) {
+			throw new Error(`Received [${bytesLoaded}], but expected [${size}] bytes`);
+		}
+
+		// Concat the chinks into a single array
+		let buffer = new ArrayBuffer(bytesLoaded);
+		let body = new Uint8Array(buffer);
+
+		let offset = 0;
+
+		// Place the chunks in the buffer
+		for (let chunk of chunks) {
+			body.set(chunk, offset);
+			offset += chunk.length;
+		} // end for
+
+		return buffer;
+	}
+
+	const bufferPromise = read();
+
+	return {
+		bufferPromise,
+		abort: () => {
+			aborted = true;
+		}
+	};
+} // end fn

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-sveltekit",
-	"version": "0.0.70",
+	"version": "0.0.72",
 	"author": "Jens Kleinhout, HKdigital (https://hkdigital.nl)",
 	"license": "ISC",
 	"repository": {