@hkdigital/lib-sveltekit 0.0.67 → 0.0.69

package/dist/constants/http/headers.d.ts

@@ -1,4 +1,5 @@
 export const ACCEPT: "accept";
 export const CONTENT_TYPE: "content-type";
+export const CONTENT_LENGTH: "content-length";
 export const AUTHORIZATION: "authorization";
 export const WWW_AUTHENTICATE: "www-authenticate";

package/dist/constants/http/headers.js

@@ -1,5 +1,6 @@
 export const ACCEPT = 'accept';
 export const CONTENT_TYPE = 'content-type';
-export const AUTHORIZATION = 'authorization';
+export const CONTENT_LENGTH = 'content-length';
 
+export const AUTHORIZATION = 'authorization';
 export const WWW_AUTHENTICATE = 'www-authenticate';

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

@@ -1,3 +1,9 @@
+/**
+ * @callback requestHandler
+ * @param {AbortController} controller
+ * @param {( reason?: Error ) => void} abort
+ * @param {( delayMs: number) => void} timeout
+ */
 /**
  * Make GET request
  *
@@ -13,8 +19,7 @@
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {function} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -37,8 +42,7 @@ export function httpGet({ url, urlSearchParams, headers, requestHandler, timeout
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {function} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -67,8 +71,7 @@ export function httpPost({ url, body, headers, requestHandler, timeoutMs }: stri
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {( { controller: AbortController, abort: ( reason?: Error ) => void, timeout: number } )=> void} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -82,3 +85,12 @@ export function httpPost({ url, body, headers, requestHandler, timeoutMs }: stri
  * @returns {Promise<*>} responsePromise
  */
 export function httpRequest({ method, url, urlSearchParams, body, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+/**
+ * Get the response size from the content-length response header
+ *
+ * @param {Response} response
+ *
+ * @returns {number} response size or 0 if unknown
+ */
+export function getResponseSize(response: Response): number;
+export type requestHandler = (controller: AbortController, abort: (reason?: Error) => void, timeout: (delayMs: number) => void) => any;

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

@@ -1,7 +1,7 @@
 import { METHOD_GET, METHOD_POST } from '../../constants/http/methods.js';
 
 import { APPLICATION_JSON } from '../../constants/mime/application.js';
-import { CONTENT_TYPE } from '../../constants/http/headers.js';
+import { CONTENT_TYPE, CONTENT_LENGTH } from '../../constants/http/headers.js';
 
 import { AbortError, TimeoutError } from '../../constants/errors/api.js';
 
@@ -11,6 +11,13 @@ import { toURL } from './url.js';
 import { setRequestHeaders } from './headers.js';
 import { waitForAndCheckResponse } from './response.js';
 
+/**
+ * @callback requestHandler
+ * @param {AbortController} controller
+ * @param {( reason?: Error ) => void} abort
+ * @param {( delayMs: number) => void} timeout
+ */
+
 /**
  * Make GET request
  *
@@ -26,8 +33,7 @@ import { waitForAndCheckResponse } from './response.js';
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {function} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -62,8 +68,7 @@ export async function httpGet({ url, urlSearchParams, headers, requestHandler, t
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {function} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -106,8 +111,7 @@ export async function httpPost({ url, body = null, headers, requestHandler, time
  *
  *   e.g. options.headers = { "content-type": "application/json" }
  *
- * @param {( { controller: AbortController, abort: ( reason?: Error ) => void, timeout: number } )=> void} [_.requestHandler]
- *   If defined, this function will receive the abort handler function
+ * @param {requestHandler} [_.requestHandler]
  *
  * @param {number} [_.timeoutMs]
  *   If defined, this request will abort after the specified number of
@@ -261,5 +265,23 @@ export async function httpRequest({
 		}
 	}
 
+	// response promise
 	return promise;
 }
+
+/**
+ * Get the response size from the content-length response header
+ *
+ * @param {Response} response
+ *
+ * @returns {number} response size or 0 if unknown
+ */
+export function getResponseSize(response) {
+	const sizeStr = response.headers.get(CONTENT_LENGTH);
+
+	if (!sizeStr) {
+		return 0;
+	}
+
+	return parseInt(sizeStr, 10);
+}

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

@@ -8,6 +8,14 @@
  * @throws {Error} internal server error
  */
 export function expectResponseOk(response: object, url: string): Promise<void>;
+/**
+ * Get the response size from the content-length response header
+ *
+ * @param {Response} response
+ *
+ * @returns {number} response size or 0 if unknown
+ */
+export function getResponseSize(response: Response): number;
 /**
  * Wait for a response and check if the response is ok
  *

package/dist/util/http/response.js

@@ -1,9 +1,9 @@
 import { ResponseError } from '../../constants/errors/index.js';
 import * as expect from '../expect/index.js';
 
-import { WWW_AUTHENTICATE } from '../../constants/http/headers.js';
+import { WWW_AUTHENTICATE, CONTENT_LENGTH } from '../../constants/http/headers.js';
 
-import { toURL } from './url.js';
+import { href } from './url.js';
 
 import { getErrorFromResponse } from './errors.js';
 
@@ -19,8 +19,6 @@ import { getErrorFromResponse } from './errors.js';
 export async function expectResponseOk(response, url) {
 	expect.object(response);
 
-	url = toURL(url);
-
 	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200
 	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201
 
@@ -28,7 +26,7 @@ export async function expectResponseOk(response, url) {
 		if (!response.ok) {
 			throw new ResponseError(
 				`Server returned - ${response.status} ${response.statusText} ` +
-					`[response.ok=false] [url=${decodeURI(url.href)}]`
+					`[response.ok=false] [url=${href(url)}]`
 			);
 		}
 
@@ -49,7 +47,7 @@ export async function expectResponseOk(response, url) {
 			errorMessage += ` (${authValue})`;
 		}
 
-		errorMessage += ` [url=${decodeURI(url.href)}]`;
+		errorMessage += ` [url=${href(url)}]`;
 
 		throw new Error(errorMessage);
 	}
@@ -59,11 +57,28 @@ export async function expectResponseOk(response, url) {
 	const error = await getErrorFromResponse(response);
 
 	throw new ResponseError(
-		`Server returned - ${response.status} ${response.statusText} ` + `[url=${decodeURI(url.href)}]`,
+		`Server returned - ${response.status} ${response.statusText} ` + `[url=${href(url)}]`,
 		{ cause: error }
 	);
 }
 
+/**
+ * Get the response size from the content-length response header
+ *
+ * @param {Response} response
+ *
+ * @returns {number} response size or 0 if unknown
+ */
+export function getResponseSize(response) {
+	const sizeStr = response.headers.get(CONTENT_LENGTH);
+
+	if (!sizeStr) {
+		return 0;
+	}
+
+	return parseInt(sizeStr, 10);
+}
+
 /**
  * Wait for a response and check if the response is ok
  *
@@ -80,8 +95,6 @@ export async function expectResponseOk(response, url) {
 export async function waitForAndCheckResponse(responsePromise, url) {
 	expect.promise(responsePromise);
 
-	url = toURL(url);
-
 	let response;
 
 	try {
@@ -93,7 +106,7 @@ export async function waitForAndCheckResponse(responsePromise, url) {
 		}
 	} catch (e) {
 		if (e instanceof TypeError || response?.ok === false) {
-			throw new ResponseError(`A network error occurred for request [${decodeURI(url.href)}]`, {
+			throw new ResponseError(`A network error occurred for request [${href(url)}]`, {
 				cause: e
 			});
 		} else {

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

@@ -16,3 +16,10 @@ export function toURL(url: string | URL): URL;
  * @return {boolean} true if the value looks like an array
  */
 export function hasProtocol(url: string): boolean;
+/**
+ * Convert an url to an absolute url and apply decodeURI to
+ * convert URI encoded characters to normal characters
+ *
+ * @param {string} url
+ */
+export function href(url: string): string;

package/dist/util/http/url.js

@@ -39,3 +39,14 @@ export function hasProtocol(url) {
 
 	return false;
 }
+
+/**
+ * Convert an url to an absolute url and apply decodeURI to
+ * convert URI encoded characters to normal characters
+ *
+ * @param {string} url
+ */
+export function href(url) {
+	const urlObj = toURL(url);
+	return decodeURI(urlObj.href);
+}

package/package.json

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