@hkdigital/lib-sveltekit 0.1.6 → 0.1.7

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

@@ -1,143 +1,143 @@
-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 { ResponseError } from '../../constants/errors/index.js';
-
-import * as expect from '../expect/index.js';
-
-import { toURL } from './url.js';
-import { httpRequest } from './http-request.js';
-import { waitForAndCheckResponse } from './response.js';
-
-const ACCEPT = 'accept';
-
-/**
- * Make a GET request to fetch JSON encoded data
- * - Expect JSON response from server
- *
- * @param {object} _
- * @param {string|URL} _.url - Url string or URL object
- *
- * @param {object} [_.urlSearchParams]
- *   Parameters that should be added to the request url
- *
- * @param {[string, string][]} [_.headers]
- *   List of custom headers. Each header is an array that contains
- *   the header name and the header value.
- *   E.g. [ "content-type", "application/json" ]
- *
- * @throws ResponseError
- *   If a network error occurred or the response was not ok
- *
- * @returns {Promise<any>} parsed JSON data
- */
-export async function jsonGet({ url, urlSearchParams, headers }) {
-	url = toURL(url);
-
-	if (!headers) {
-		headers = [];
-	}
-
-	headers[ACCEPT] = APPLICATION_JSON;
-
-	const responsePromise = httpRequest({
-		method: METHOD_GET,
-		url,
-		urlSearchParams,
-		headers
-	});
-
-	const response = await waitForAndCheckResponse(responsePromise, url);
-
-	let parsedResponse;
-
-	try {
-		//
-		// @note when security on the client side fails, an `opaque` response
-		//       is returned by the browser (empty body) -> parsing fails
-		//       (use CORS to fix this)
-		//
-		parsedResponse = await response.json();
-	} catch (e) {
-		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`, {
-			cause: e
-		});
-	}
-
-	if (parsedResponse.error) {
-		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
-	}
-
-	return parsedResponse;
-}
-
-/**
- * Make a POST request to fetch JSON encoded data
- * - Expect JSON response from server
- *
- * @param {object} _
- * @param {string|URL} _.url - Url string or URL object
- *
- * @param {any} _.body
- *   Data that will be converted to a JSON encoded string and send to the server
- *
- * @param {object} [_.urlSearchParams]
- *   Parameters that should be added to the request url.
- *
- *   - Be careful when using urlSearchParams in POST requests, it can be
- *     confusing since the parameters usually go in the body part of
- *     the request.
- *
- * @param {[string, string][]} [_.headers]
- *   List of custom headers. Each header is an array that contains
- *   the header name and the header value.
- *   E.g. [ "content-type", "application/json" ]
- *
- * @throws ResponseError
- *   If a network error occurred or the response was not ok
- *
- * @returns {Promise<any>} parsed JSON data
- */
-export async function jsonPost({ url, body, urlSearchParams, headers }) {
-	url = toURL(url);
-
-	if (!headers) {
-		headers = [];
-	} else {
-		expect.object(headers);
-	}
-
-	expect.defined(body);
-
-	headers[ACCEPT] = APPLICATION_JSON;
-	headers[CONTENT_TYPE] = APPLICATION_JSON;
-
-	const responsePromise = httpRequest({ method: METHOD_POST, url, body, urlSearchParams, headers });
-
-	const response = await waitForAndCheckResponse(responsePromise, url);
-
-	let parsedResponse;
-
-	try {
-		//
-		// @note when security on the client side fails, an `opaque` response
-		//       is returned by the browser (empty body) -> parsing fails
-		//       (use CORS to fix this)
-		//
-		parsedResponse = await response.json();
-	} catch (e) {
-		// console.log( response );
-		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`);
-	}
-
-	if (parsedResponse.error) {
-		//
-		// @note this is API specific, but it's quite logical
-		//
-		//
-		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
-	}
-
-	return parsedResponse;
-}
+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 { ResponseError } from '../../constants/errors/index.js';
+
+import * as expect from '../expect/index.js';
+
+import { toURL } from './url.js';
+import { httpRequest } from './http-request.js';
+import { waitForAndCheckResponse } from './response.js';
+
+const ACCEPT = 'accept';
+
+/**
+ * Make a GET request to fetch JSON encoded data
+ * - Expect JSON response from server
+ *
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
+ *
+ * @param {object} [_.urlSearchParams]
+ *   Parameters that should be added to the request url
+ *
+ * @param {[string, string][]} [_.headers]
+ *   List of custom headers. Each header is an array that contains
+ *   the header name and the header value.
+ *   E.g. [ "content-type", "application/json" ]
+ *
+ * @throws ResponseError
+ *   If a network error occurred or the response was not ok
+ *
+ * @returns {Promise<any>} parsed JSON data
+ */
+export async function jsonGet({ url, urlSearchParams, headers }) {
+	url = toURL(url);
+
+	if (!headers) {
+		headers = [];
+	}
+
+	headers[ACCEPT] = APPLICATION_JSON;
+
+	const responsePromise = httpRequest({
+		method: METHOD_GET,
+		url,
+		urlSearchParams,
+		headers
+	});
+
+	const response = await waitForAndCheckResponse(responsePromise, url);
+
+	let parsedResponse;
+
+	try {
+		//
+		// @note when security on the client side fails, an `opaque` response
+		//       is returned by the browser (empty body) -> parsing fails
+		//       (use CORS to fix this)
+		//
+		parsedResponse = await response.json();
+	} catch (e) {
+		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`, {
+			cause: e
+		});
+	}
+
+	if (parsedResponse.error) {
+		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
+	}
+
+	return parsedResponse;
+}
+
+/**
+ * Make a POST request to fetch JSON encoded data
+ * - Expect JSON response from server
+ *
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
+ *
+ * @param {any} _.body
+ *   Data that will be converted to a JSON encoded string and send to the server
+ *
+ * @param {object} [_.urlSearchParams]
+ *   Parameters that should be added to the request url.
+ *
+ *   - Be careful when using urlSearchParams in POST requests, it can be
+ *     confusing since the parameters usually go in the body part of
+ *     the request.
+ *
+ * @param {[string, string][]} [_.headers]
+ *   List of custom headers. Each header is an array that contains
+ *   the header name and the header value.
+ *   E.g. [ "content-type", "application/json" ]
+ *
+ * @throws ResponseError
+ *   If a network error occurred or the response was not ok
+ *
+ * @returns {Promise<any>} parsed JSON data
+ */
+export async function jsonPost({ url, body, urlSearchParams, headers }) {
+	url = toURL(url);
+
+	if (!headers) {
+		headers = [];
+	} else {
+		expect.object(headers);
+	}
+
+	expect.defined(body);
+
+	headers[ACCEPT] = APPLICATION_JSON;
+	headers[CONTENT_TYPE] = APPLICATION_JSON;
+
+	const responsePromise = httpRequest({ method: METHOD_POST, url, body, urlSearchParams, headers });
+
+	const response = await waitForAndCheckResponse(responsePromise, url);
+
+	let parsedResponse;
+
+	try {
+		//
+		// @note when security on the client side fails, an `opaque` response
+		//       is returned by the browser (empty body) -> parsing fails
+		//       (use CORS to fix this)
+		//
+		parsedResponse = await response.json();
+	} catch (e) {
+		// console.log( response );
+		throw new ResponseError(`Failed to JSON decode server response from [${decodeURI(url.href)}]`);
+	}
+
+	if (parsedResponse.error) {
+		//
+		// @note this is API specific, but it's quite logical
+		//
+		//
+		throw new ResponseError(`Server returned response error message [${parsedResponse.error}]`);
+	}
+
+	return parsedResponse;
+}

package/dist/util/http/mocks.js

@@ -1,65 +1,65 @@
-import { CONTENT_TYPE, CONTENT_LENGTH } from '../../constants/http/index.js';
-
-import { OCTET_STREAM } from '../../constants/mime/index.js';
-
-/**
- * Create a response value that can be used by a mocked fetch function
- *
- * @template T
- *
- * @param {T} data
- *
- * @returns {{ json: () => Promise<T>}}
- */
-export function createJsonFetchResponse(data /* , options */) {
-	return { json: () => new Promise((resolve) => resolve(data)) };
-}
-
-/**
- * Create a response value that can be used by a mocked fetch function
- *
- * @param {ArrayBuffer} arrayBuffer
- *
- * @returns {Response}
- */
-export function createStreamedResponse(arrayBuffer /*, options */) {
-	const byteLength = arrayBuffer.byteLength;
-	const chunkSize = Math.ceil(byteLength / 10);
-
-	const body = new ReadableStream({
-		start(controller) {
-			let offset = 0;
-
-			function pushChunk() {
-				if (offset >= byteLength) {
-					controller.close();
-					return;
-				}
-
-				// Calculate the size of the current chunk
-				const currentChunkSize = Math.min(chunkSize, byteLength - offset);
-
-				// Create a new ArrayBuffer for this chunk
-				const chunk = arrayBuffer.slice(offset, offset + currentChunkSize);
-
-				controller.enqueue(chunk);
-				offset += currentChunkSize;
-
-				// Schedule next chunk
-				setTimeout(pushChunk, 0);
-			}
-
-			// Start pushing chunks
-			pushChunk();
-		}
-	});
-
-	const response = new Response(body, {
-		headers: new Headers({
-			[CONTENT_TYPE]: OCTET_STREAM,
-			[CONTENT_LENGTH]: String(byteLength)
-		})
-	});
-
-	return response;
-}
+import { CONTENT_TYPE, CONTENT_LENGTH } from '../../constants/http/index.js';
+
+import { OCTET_STREAM } from '../../constants/mime/index.js';
+
+/**
+ * Create a response value that can be used by a mocked fetch function
+ *
+ * @template T
+ *
+ * @param {T} data
+ *
+ * @returns {{ json: () => Promise<T>}}
+ */
+export function createJsonFetchResponse(data /* , options */) {
+	return { json: () => new Promise((resolve) => resolve(data)) };
+}
+
+/**
+ * Create a response value that can be used by a mocked fetch function
+ *
+ * @param {ArrayBuffer} arrayBuffer
+ *
+ * @returns {Response}
+ */
+export function createStreamedResponse(arrayBuffer /*, options */) {
+	const byteLength = arrayBuffer.byteLength;
+	const chunkSize = Math.ceil(byteLength / 10);
+
+	const body = new ReadableStream({
+		start(controller) {
+			let offset = 0;
+
+			function pushChunk() {
+				if (offset >= byteLength) {
+					controller.close();
+					return;
+				}
+
+				// Calculate the size of the current chunk
+				const currentChunkSize = Math.min(chunkSize, byteLength - offset);
+
+				// Create a new ArrayBuffer for this chunk
+				const chunk = arrayBuffer.slice(offset, offset + currentChunkSize);
+
+				controller.enqueue(chunk);
+				offset += currentChunkSize;
+
+				// Schedule next chunk
+				setTimeout(pushChunk, 0);
+			}
+
+			// Start pushing chunks
+			pushChunk();
+		}
+	});
+
+	const response = new Response(body, {
+		headers: new Headers({
+			[CONTENT_TYPE]: OCTET_STREAM,
+			[CONTENT_LENGTH]: String(byteLength)
+		})
+	});
+
+	return response;
+}