@hkdigital/lib-sveltekit 0.0.75 → 0.0.76

package/dist/components/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/components/tab-bar/HkTabBar.state.svelte.d.ts

@@ -51,4 +51,4 @@ export class HkTabBarState {
 export const createOrGetState: (instanceKey?: string | Symbol) => HkTabBarState;
 export const createState: (instanceKey?: string | Symbol) => HkTabBarState;
 export const getState: (instanceKey?: string | Symbol) => HkTabBarState;
-export type Tab = import("./typedef.js").Tab;
+export type Tab = any;

package/dist/components/tab-bar/index.d.ts

@@ -1,5 +1,4 @@
 export { default as HkTabBar } from "./HkTabBar.svelte";
 export { default as HkTabBarSelector } from "./HkTabBarSelector.svelte";
-export * from "./typedef.js";
 export { createOrGetState as createOrGetTabBarState, createState as createTabBarState, getState as getTabBarState } from "./HkTabBar.state.svelte.js";
 export { createOrGetState as createOrGetTabBarSelectorState, createState as createTabBarSelectorState, getState as getTabBarSelectorState } from "./HkTabBarSelector.state.svelte.js";

package/dist/components/tab-bar/typedef.d.ts

@@ -1,4 +1,4 @@
-export type Tab = {
+type Tab = {
     icon: import("../icon/typedef.js").IconSource;
     label?: string;
     route?: string;

package/dist/constants/mime/application.d.ts

@@ -1,2 +1,3 @@
 export const APPLICATION_JSON: "application/json";
 export const APPLICATION_XML: "application/xml";
+export const OCTET_STREAM: "application/octet-stream";

package/dist/constants/mime/application.js

@@ -1,2 +1,5 @@
 export const APPLICATION_JSON = 'application/json';
 export const APPLICATION_XML = 'application/xml';
+
+// "arbitrary binary data"as defined in RFC 2046
+export const OCTET_STREAM = 'application/octet-stream';

package/dist/constants/mime/audio.d.ts

@@ -0,0 +1,10 @@
+export const AUDIO_BASIC: "audio/basic";
+export const AUDIO_MIDI: "audio/mid";
+export const AUDIO_WAV: "audio/vnd.wav";
+export const AUDIO_MP3: "audio/mpeg";
+export const AUDIO_MP4: "audio/mp4";
+export const AUDIO_AIF: "audio/x-aiff";
+export const AUDIO_AIFC: "audio/x-aiff";
+export const AUDIO_AIFF: "audio/x-aiff";
+export const AUDIO_M3U: "audio/x-mpegurl";
+export const AUDIO_OGG: "audio/ogg";

package/dist/constants/mime/audio.js

@@ -0,0 +1,13 @@
+export const AUDIO_BASIC = 'audio/basic';
+export const AUDIO_MIDI = 'audio/mid';
+export const AUDIO_WAV = 'audio/vnd.wav';
+
+export const AUDIO_MP3 = 'audio/mpeg';
+export const AUDIO_MP4 = 'audio/mp4';
+
+export const AUDIO_AIF = 'audio/x-aiff';
+export const AUDIO_AIFC = 'audio/x-aiff';
+export const AUDIO_AIFF = 'audio/x-aiff';
+
+export const AUDIO_M3U = 'audio/x-mpegurl';
+export const AUDIO_OGG = 'audio/ogg';

package/dist/constants/mime/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./application.js";
+export * from "./audio.js";
 export * from "./text.js";
 export * from "./image.js";

package/dist/constants/mime/index.js

@@ -1,3 +1,4 @@
 export * from './application.js';
+export * from './audio.js';
 export * from './text.js';
 export * from './image.js';

package/dist/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/util/expect/index.d.ts

@@ -16,6 +16,12 @@ export function notNull(value: any): void;
  * @param {any} value
  */
 export function _true(value: any): void;
+/**
+ * Expect a positive number
+ *
+ * @param {any} value
+ */
+export function positiveNumber(value: any): void;
 /**
  * Throws a validation error if value is not a string
  *

package/dist/util/expect/index.js

@@ -126,7 +126,16 @@ export { _true as true };
 
 // > Compounds
 
-// positiveNumber
+/**
+ * Expect a positive number
+ *
+ * @param {any} value
+ */
+export function positiveNumber(value) {
+	const schema = v.pipe(v.number(), v.minValue(0));
+	v.parse(schema, value);
+}
+
 // notNegativeNumber
 // positiveInteger
 // notNegativeInteger

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

@@ -6,7 +6,6 @@
  *
  * @param {Headers} target - Headers object to set the extra headers in
  *
- * @param {object} [nameValuePairs]
- *   Object that contains custom headers. A header is a name, value pair.
+ * @param {null|object|[string, string][]} [pairs]
  */
-export function setRequestHeaders(target: Headers, nameValuePairs?: object): void;
+export function setRequestHeaders(target: Headers, pairs?: null | object | [string, string][]): void;

package/dist/util/http/headers.js

@@ -8,30 +8,36 @@ import * as expect from '../expect/index.js';
  *
  * @param {Headers} target - Headers object to set the extra headers in
  *
- * @param {object} [nameValuePairs]
- *   Object that contains custom headers. A header is a name, value pair.
+ * @param {null|object|[string, string][]} [pairs]
  */
-export function setRequestHeaders(target, nameValuePairs) {
+export function setRequestHeaders(target, pairs) {
 	if (!(target instanceof Headers)) {
 		throw new Error('Invalid parameter [target] (expected Headers object)');
 	}
 
-	expect.objectNoArray(nameValuePairs);
+	// expect.objectNoArray(pairs);
 
-	if (nameValuePairs instanceof Headers) {
-		throw new Error('Invalid parameter [nameValuePairs] (should not be a Headers object)');
+	if (pairs instanceof Headers) {
+		throw new Error('Invalid parameter [pairs] (should not be a Headers object)');
 	}
 
-	for (const name in nameValuePairs) {
-		expect.notEmptyString(name);
+	if (!pairs) {
+		return;
+	}
+
+	if (typeof pairs !== 'object') {
+		throw new Error('Invalid value for parameter [pairs]');
+	}
 
-		const value = nameValuePairs[name];
+	if (!Array.isArray(pairs)) {
+		pairs = Object.entries(pairs);
+	}
 
+	for (const [name, value] of pairs) {
+		expect.notEmptyString(name);
 		expect.notEmptyString(value);
 
-		//
-		// Headers should be encoded lowercase in HTTP2
-		//
+		// @note Headers should be encoded lowercase in HTTP2
 		const nameLower = name.toLowerCase();
 
 		target.set(nameLower, value); /* overwrites existing value */

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

@@ -230,7 +230,7 @@ export async function httpRequest({
 
 	if (requestHandler || timeoutMs) {
 		/**
-		 * @type {(any?: reason) => void}
+		 * @type {(reason?: any) => void}
 		 */
 		const abort = (reason) => {
 			if (!reason) {

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

@@ -2,12 +2,13 @@
  * Make a GET request to fetch JSON encoded data
  * - Expect JSON response from server
  *
- * @param {string|URL} url - Url string or URL object
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
  *
- * @param {object} [urlSearchParams]
+ * @param {object} [_.urlSearchParams]
  *   Parameters that should be added to the request url
  *
- * @param {array[]} [headers]
+ * @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" ]
@@ -15,26 +16,31 @@
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
- * @returns {any} parsed JSON data
+ * @returns {Promise<any>} parsed JSON data
  */
-export function jsonGet({ url, urlSearchParams, headers }: string | URL): any;
+export function jsonGet({ url, urlSearchParams, headers }: {
+    url: string | URL;
+    urlSearchParams?: object;
+    headers?: [string, string][];
+}): Promise<any>;
 /**
  * Make a POST request to fetch JSON encoded data
  * - Expect JSON response from server
  *
- * @param {string|URL} url - Url string or URL object
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
  *
- * @param {any} body
+ * @param {any} _.body
  *   Data that will be converted to a JSON encoded string and send to the server
  *
- * @param {object} [urlSearchParams]
+ * @param {object} [_.urlSearchParams]
  *   Parameters that should be added to the request url.
  *
- *   @note
- *   Be careful when using urlSearchParams in POST requests, it can be
- *   confusing since the parameters usually go in the body part of the request.
+ *   - 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 {array[]} [headers]
+ * @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" ]
@@ -42,6 +48,11 @@ export function jsonGet({ url, urlSearchParams, headers }: string | URL): any;
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
- * @returns {any} parsed JSON data
+ * @returns {Promise<any>} parsed JSON data
  */
-export function jsonPost({ url, body, urlSearchParams, headers }: string | URL): any;
+export function jsonPost({ url, body, urlSearchParams, headers }: {
+    url: string | URL;
+    body: any;
+    urlSearchParams?: object;
+    headers?: [string, string][];
+}): Promise<any>;

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

@@ -16,12 +16,13 @@ const ACCEPT = 'accept';
  * Make a GET request to fetch JSON encoded data
  * - Expect JSON response from server
  *
- * @param {string|URL} url - Url string or URL object
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
  *
- * @param {object} [urlSearchParams]
+ * @param {object} [_.urlSearchParams]
  *   Parameters that should be added to the request url
  *
- * @param {array[]} [headers]
+ * @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" ]
@@ -29,13 +30,13 @@ const ACCEPT = 'accept';
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
- * @returns {any} parsed JSON data
+ * @returns {Promise<any>} parsed JSON data
  */
 export async function jsonGet({ url, urlSearchParams, headers }) {
 	url = toURL(url);
 
 	if (!headers) {
-		headers = {};
+		headers = [];
 	}
 
 	headers[ACCEPT] = APPLICATION_JSON;
@@ -75,19 +76,20 @@ export async function jsonGet({ url, urlSearchParams, headers }) {
  * Make a POST request to fetch JSON encoded data
  * - Expect JSON response from server
  *
- * @param {string|URL} url - Url string or URL object
+ * @param {object} _
+ * @param {string|URL} _.url - Url string or URL object
  *
- * @param {any} body
+ * @param {any} _.body
  *   Data that will be converted to a JSON encoded string and send to the server
  *
- * @param {object} [urlSearchParams]
+ * @param {object} [_.urlSearchParams]
  *   Parameters that should be added to the request url.
  *
- *   @note
- *   Be careful when using urlSearchParams in POST requests, it can be
- *   confusing since the parameters usually go in the body part of the request.
+ *   - 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 {array[]} [headers]
+ * @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" ]
@@ -95,13 +97,13 @@ export async function jsonGet({ url, urlSearchParams, headers }) {
  * @throws ResponseError
  *   If a network error occurred or the response was not ok
  *
- * @returns {any} parsed JSON data
+ * @returns {Promise<any>} parsed JSON data
  */
 export async function jsonPost({ url, body, urlSearchParams, headers }) {
 	url = toURL(url);
 
 	if (!headers) {
-		headers = {};
+		headers = [];
 	} else {
 		expect.object(headers);
 	}
@@ -111,7 +113,7 @@ export async function jsonPost({ url, body, urlSearchParams, headers }) {
 	headers[ACCEPT] = APPLICATION_JSON;
 	headers[CONTENT_TYPE] = APPLICATION_JSON;
 
-	const responsePromise = httpRequest({ METHOD_POST, url, body, urlSearchParams, headers });
+	const responsePromise = httpRequest({ method: METHOD_POST, url, body, urlSearchParams, headers });
 
 	const response = await waitForAndCheckResponse(responsePromise, url);
 

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

@@ -10,3 +10,11 @@
 export function createJsonFetchResponse<T>(data: T): {
     json: () => Promise<T>;
 };
+/**
+ * Create a response value that can be used by a mocked fetch function
+ *
+ * @param {ArrayBuffer} arrayBuffer
+ *
+ * @returns {Response}
+ */
+export function createStreamedResponse(arrayBuffer: ArrayBuffer): Response;

package/dist/util/http/mocks.js

@@ -1,3 +1,7 @@
+import { CONTENT_TYPE, CONTENT_LENGTH } from '@hkdigital/lib-sveltekit/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
  *
@@ -10,3 +14,52 @@
 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;
+}

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

@@ -28,14 +28,14 @@ export function getResponseSize(response: Response): number;
  * @example
  *   const response = await waitForAndCheckResponse( responsePromise );
  *
- * @param {Promise<object>} responsePromise
- * @param {URL} url - An url that is used for error messages
+ * @param {Promise<Response>} responsePromise
+ * @param {string|URL} url - An url that is used for error messages
  *
  * @throws ResponseError - A response error if something went wrong
  *
- * @returns {object} response
+ * @returns {Promise<Response>} response
  */
-export function waitForAndCheckResponse(responsePromise: Promise<object>, url: URL): object;
+export function waitForAndCheckResponse(responsePromise: Promise<Response>, url: string | URL): Promise<Response>;
 /**
  * Load response body as ArrayBuffer
  * - Progress can be monitored by suppying an onProgress callback

package/dist/util/http/response.js

@@ -1,5 +1,6 @@
 import { ResponseError } from '../../constants/errors/index.js';
 import * as expect from '../expect/index.js';
+import { toURL } from './url.js';
 
 import { WWW_AUTHENTICATE, CONTENT_LENGTH } from '../../constants/http/headers.js';
 
@@ -96,16 +97,18 @@ export function getResponseSize(response) {
  * @example
  *   const response = await waitForAndCheckResponse( responsePromise );
  *
- * @param {Promise<object>} responsePromise
- * @param {URL} url - An url that is used for error messages
+ * @param {Promise<Response>} responsePromise
+ * @param {string|URL} url - An url that is used for error messages
  *
  * @throws ResponseError - A response error if something went wrong
  *
- * @returns {object} response
+ * @returns {Promise<Response>} response
  */
 export async function waitForAndCheckResponse(responsePromise, url) {
 	expect.promise(responsePromise);
 
+	url = toURL(url);
+
 	let response;
 
 	try {
@@ -157,23 +160,25 @@ export function loadResponseBuffer(response, onProgress) {
 	let aborted = false;
 
 	/**
+	 * Read chunks from response body using reader
+	 *
 	 * @returns {Promise<ArrayBuffer>}
 	 */
 	async function read() {
-		let loading = true;
 		let chunks = [];
 
 		// - Use flag 'loading'
 		// - Check if #abortLoading still exists
-		while (loading) {
+		for (;;) {
 			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 (value) {
+				// @note value is an ArrayBuffer
+				bytesLoaded += value.byteLength;
+
+				// console.log({ done, value, byteLength: value.byteLength, bytesLoaded });
+
+				// console.log({ size, bytesLoaded, value });
 
 				if (size && bytesLoaded > size) {
 					throw new Error(`Received more bytes that specified by header content-length`);
@@ -185,6 +190,11 @@ export function loadResponseBuffer(response, onProgress) {
 					onProgress({ bytesLoaded, size });
 				}
 			}
+
+			if (done || aborted) {
+				// Loading complete or aborted by user
+				break;
+			}
 		} // end while
 
 		if (size && bytesLoaded !== size) {
@@ -200,7 +210,7 @@ export function loadResponseBuffer(response, onProgress) {
 		// Place the chunks in the buffer
 		for (let chunk of chunks) {
 			body.set(chunk, offset);
-			offset += chunk.length;
+			offset += chunk.byteLength;
 		} // end for
 
 		return buffer;

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

@@ -20,6 +20,6 @@ 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
+ * @param {string|URL} url
  */
-export function href(url: string): string;
+export function href(url: string | URL): string;

package/dist/util/http/url.js

@@ -44,7 +44,7 @@ export function hasProtocol(url) {
  * Convert an url to an absolute url and apply decodeURI to
  * convert URI encoded characters to normal characters
  *
- * @param {string} url
+ * @param {string|URL} url
  */
 export function href(url) {
 	const urlObj = toURL(url);

package/package.json

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