@hkdigital/lib-sveltekit 0.0.58 → 0.0.61

package/dist/util/expect/index.js

@@ -32,7 +32,7 @@ const ObjectSchema = v.custom(isObject, `Invalid type: Expected object`);
 /**
  * Throws a validation error if value is not a string
  *
- * @param {*} value
+ * @param {any} value
  */
 export function string(value) {
 	v.parse(v.string(), value);
@@ -41,7 +41,7 @@ export function string(value) {
 /**
  * Throws a validation error if value is not a boolean
  *
- * @param {*} value
+ * @param {any} value
  */
 export function boolean(value) {
 	v.parse(v.boolean(), value);
@@ -50,7 +50,7 @@ export function boolean(value) {
 /**
  * Throws a validation error if value is not a number
  *
- * @param {*} value
+ * @param {any} value
  */
 export function number(value) {
 	v.parse(v.number(), value);
@@ -59,29 +59,36 @@ export function number(value) {
 /**
  * Throws a validation error if value is not a Symbol
  *
- * @param {*} value
+ * @param {any} value
  */
 export function symbol(value) {
 	v.parse(v.symbol(), value);
 }
 
 /**
- * Throws a validation error if value is undefined
+ * Throws a validation error if value is not defined
  *
- * @param {*} value
+ * @param {any} value
  */
-function undefined_(value) {
-	v.parse(v.undefined(), value);
-}
+export function defined(value) {
+	v.parse(
+		v.custom((value) => {
+			if (value === undefined) {
+				return false;
+			}
 
-export { undefined_ as undefined };
+			return true;
+		}, 'Invalid type: Expected any value, but received undefined'),
+		value
+	);
+}
 
 // > Base objects
 
 /**
  * Throws a validation error if value is not an object
  *
- * @param {*} value
+ * @param {any} value
  */
 function object_(value) {
 	v.parse(ObjectSchema, value);
@@ -93,7 +100,7 @@ export { object_ as object };
 /**
  * Throws a validation error if value is not an array
  *
- * @param {*} value
+ * @param {any} value
  */
 function array_(value) {
 	v.parse(v.instance(Array), value);
@@ -104,7 +111,7 @@ export { array_ as array };
 /**
  * Throws a validation error if value is not an array of strings
  *
- * @param {*} value
+ * @param {any} value
  */
 export function stringArray(value) {
 	v.parse(v.array(v.string()), value);
@@ -113,7 +120,7 @@ export function stringArray(value) {
 /**
  * Throws a validation error if value is not an array of objects
  *
- * @param {*} value
+ * @param {any} value
  */
 export function objectArray(value) {
 	v.parse(v.array(v.looseObject({})), value);
@@ -122,22 +129,22 @@ export function objectArray(value) {
 /**
  * Throws a validation error if value is not a function
  *
- * @param {*} value
+ * @param {any} value
  */
-function _function(value) {
+function function_(value) {
 	v.parse(v.function(), value);
 }
 
-export { _function as function };
+export { function_ as function };
 
-export { _function as class };
+export { function_ as class };
 
 /**
  * Throws a validation error if value is not a Promise
  *
- * @param {*} value
+ * @param {any} value
  */
-export function promise_(value) {
+function promise_(value) {
 	v.parse(v.instance(Promise), value);
 }
 
@@ -146,9 +153,9 @@ export { promise_ as promise };
 /**
  * Throws a validation error if value is not a Map
  *
- * @param {*} value
+ * @param {any} value
  */
-export function map_(value) {
+function map_(value) {
 	v.parse(v.instance(Map), value);
 }
 
@@ -157,9 +164,9 @@ export { map_ as map };
 /**
  * Throws a validation error if value is not a Set
  *
- * @param {*} value
+ * @param {any} value
  */
-export function set_(value) {
+function set_(value) {
 	v.parse(v.instance(Set), value);
 }
 
@@ -168,7 +175,7 @@ export { set_ as set };
 /**
  * Throws a validation error if value is not an Error instance
  *
- * @param {*} value
+ * @param {any} value
  */
 export function error_(value) {
 	v.parse(v.instance(Map), value);
@@ -181,7 +188,7 @@ export { error_ as error };
 /**
  * Expect a value not to be null
  *
- * @param {*} value
+ * @param {any} value
  */
 export function notNull(value) {
 	v.notValue(null, value);
@@ -190,7 +197,7 @@ export function notNull(value) {
 /**
  * Expect a value to be a boolean and true
  *
- * @param {*} value
+ * @param {any} value
  */
 export function _true(value) {
 	v.value(true, value);
@@ -211,7 +218,7 @@ export { _true as true };
 /**
  * Throws a validation error if value is not a string
  *
- * @param {*} value
+ * @param {any} value
  */
 export function notEmptyString(value) {
 	const schema = v.pipe(v.string(), v.minLength(1));
@@ -227,7 +234,7 @@ export function notEmptyString(value) {
 /**
  * Throws a validation error if value is not iterable
  *
- * @param {*} value
+ * @param {any} value
  */
 export function iterable(value) {
 	const schema = v.pipe(v.looseObject({ [Symbol.iterator]: v.function() }));
@@ -241,7 +248,7 @@ export function iterable(value) {
  * Throws a validation error if value is not a a store (has not subscribe
  * method)
  *
- * @param {*} value
+ * @param {any} value
  */
 export function store(value) {
 	v.parse(
@@ -262,7 +269,7 @@ export function store(value) {
  * Throws a validation error if value is not array like
  * - Checks if the value is an object and has a property `length`
  *
- * @param {*} value
+ * @param {any} value
  */
 export function arrayLike(value) {
 	v.parse(v.object({ length: v.number() }), value);
@@ -277,7 +284,7 @@ export function arrayLike(value) {
  * Throws a validation error if value is not an object or the value
  * is an array
  *
- * @param {*} value
+ * @param {any} value
  */
 export function objectNoArray(value) {
 	v.parse(
@@ -296,7 +303,7 @@ export function objectNoArray(value) {
  * Throws a validation error if value is not an object or the value
  * is a function
  *
- * @param {*} value
+ * @param {any} value
  */
 export function objectNoFunction(value) {
 	v.parse(
@@ -314,7 +321,7 @@ export function objectNoFunction(value) {
 /**
  * Throws a validation error if value is not an object or null
  *
- * @param {*} value
+ * @param {any} value
  */
 export function objectOrNull(value) {
 	v.parse(v.union([v.value(null), v.looseObject({})]), value);
@@ -326,7 +333,7 @@ export function objectOrNull(value) {
 /**
  * Throws a validation error if value is not an array or Set
  *
- * @param {*} value
+ * @param {any} value
  */
 export function arrayOrSet(value) {
 	v.parse(v.union([v.instance(Array), v.instance(Set)]), value);

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

@@ -0,0 +1,18 @@
+/**
+ * Try to get error information from the server error response
+ *
+ * This method tries to get error info from JSON responses. The
+ * error info may be set as one of the following properties
+ *
+ * - message
+ * - error
+ * - messages (array)
+ * - errors (array)
+ *
+ * Otherwise tris method will use the plain text response
+ *
+ * @param {object} response
+ *
+ * @returns {Error} error
+ */
+export function getErrorFromResponse(response: object): Error;

package/dist/util/http/errors.js

@@ -0,0 +1,97 @@
+import * as expect from '../expect/index.js';
+
+import { CONTENT_TYPE } from '../../constants/http/index.js';
+
+import { APPLICATION_JSON } from '../../constants/mime/index.js';
+
+/**
+ * Try to get error information from the server error response
+ *
+ * This method tries to get error info from JSON responses. The
+ * error info may be set as one of the following properties
+ *
+ * - message
+ * - error
+ * - messages (array)
+ * - errors (array)
+ *
+ * Otherwise tris method will use the plain text response
+ *
+ * @param {object} response
+ *
+ * @returns {Error} error
+ */
+export async function getErrorFromResponse(response) {
+	expect.object(response);
+
+	let message;
+	let details = null;
+
+	const headers = response.headers;
+	const contentType = headers.get(CONTENT_TYPE);
+
+	let content;
+
+	if (contentType === APPLICATION_JSON) {
+		content = await response.json();
+
+		if (content instanceof Object) {
+			if (typeof content.message === 'string') {
+				// Use string propery 'message' as error message
+				message = content.message;
+			} else if (typeof content.error === 'string') {
+				// Use string propery 'error' as error message
+				message = content.error;
+			} else {
+				if (Array.isArray(content.errors)) {
+					// Use array propery 'errors' for error messages
+
+					details = content.errors;
+				} else if (Array.isArray(content.messages)) {
+					// Use array propery 'messages' for error messages
+
+					details = content.messages;
+				}
+
+				if (details) {
+					// Multiple error messages (array) =>
+					//   create string respresentation by combining
+					//   text parts from all error messages
+					const tmp = [];
+
+					for (const current of details) {
+						if (typeof current === 'string') {
+							// Error is a string
+							tmp.push(current);
+						} else if (current instanceof Object && typeof current.message === 'string') {
+							// Error is an object with string property 'message'
+							tmp.push(current.message);
+						} else {
+							// JSON stringify everything else
+							tmp.push(JSON.stringify(current));
+						}
+					} // end for
+
+					message = tmp.join(', ');
+				}
+			}
+		}
+	} else {
+		const tmp = await response.text();
+
+		if (tmp.length) {
+			message = tmp;
+		} else {
+			message = response.statusText;
+		}
+	}
+	// console.log( "message", message );
+
+	const error = new Error(message);
+
+	if (details) {
+		error.details = details;
+	}
+
+	return error;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Set headers in an existing `Headers` object
+ * - Existing headers with the same name will be overwritten
+ * - The supplied `Headers` object will be updated, this function does not
+ *   return any value
+ *
+ * @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.
+ */
+export function setRequestHeaders(target: Headers, nameValuePairs?: object): void;

package/dist/util/http/headers.js

@@ -0,0 +1,39 @@
+import * as expect from '../expect/index.js';
+
+/**
+ * Set headers in an existing `Headers` object
+ * - Existing headers with the same name will be overwritten
+ * - The supplied `Headers` object will be updated, this function does not
+ *   return any value
+ *
+ * @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.
+ */
+export function setRequestHeaders(target, nameValuePairs) {
+	if (!(target instanceof Headers)) {
+		throw new Error('Invalid parameter [target] (expected Headers object)');
+	}
+
+	expect.objectNoArray(nameValuePairs);
+
+	if (nameValuePairs instanceof Headers) {
+		throw new Error('Invalid parameter [nameValuePairs] (should not be a Headers object)');
+	}
+
+	for (const name in nameValuePairs) {
+		expect.notEmptyString(name);
+
+		const value = nameValuePairs[name];
+
+		expect.notEmptyString(value);
+
+		//
+		// Headers should be encoded lowercase in HTTP2
+		//
+		const nameLower = name.toLowerCase();
+
+		target.set(nameLower, value); /* overwrites existing value */
+	}
+}

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

@@ -0,0 +1,78 @@
+/**
+ * Make GET request
+ *
+ * @param {string|URL} url - Url string or URL object
+ *
+ * @param {object} [urlSearchParams]
+ *   Parameters that should be added to the request url
+ *
+ * @param {object} [headers]
+ *   Object that contains custom headers. A header is a name, value pair.
+ *
+ *   e.g. options.headers = { "content-type": "application/json" }
+ *
+ * @param {function} [requestHandler]
+ *   If defined, this function will receive the abort handler function
+ *
+ * @param {number} [timeoutMs]
+ *   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
+ */
+export function httpGet({ url, urlSearchParams, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+/**
+ * Make POST request
+ *
+ * @param {string|URL} url - Url string or URL object
+ *
+ * @param {any} [body] - POST data
+ *
+ * @param {object} [headers]
+ *   Object that contains custom headers. A header is a name, value pair.
+ *
+ *   e.g. options.headers = { "content-type": "application/json" }
+ *
+ * @param {function} [requestHandler]
+ *   If defined, this function will receive the abort handler function
+ *
+ * @param {number} [timeoutMs]
+ *   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
+ */
+export function httpPost({ url, body, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;
+/**
+ * Make an HTTP request
+ * - This is a low level function, consider using
+ *   httpGet, httpPost, jsonGet or jsonPost instead
+ *
+ * @param {string|URL} url - Url string or URL object
+ *
+ * @param {string} method - Request method: METHOD_GET | METHOD_POST
+ *
+ * @param {object} [urlSearchParams] - URL search parameters as key-value pairs
+ *
+ * @param {any} [body] - POST data
+ *
+ * @param {object} [headers]
+ *   Object that contains custom headers. A header is a name, value pair.
+ *
+ *   e.g. options.headers = { "content-type": "application/json" }
+ *
+ * @param {function} [requestHandler]
+ *   If defined, this function will receive the abort handler function
+ *
+ * @param {number} [timeoutMs]
+ *   If defined, this request will abort after the specified number of
+ *   milliseconds. Values above the the built-in request timeout won't work.
+ *
+ * @throws TypeError - If a network error occurred
+ *
+ * @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
+ */
+export function httpRequest({ method, url, urlSearchParams, body, headers, requestHandler, timeoutMs }: string | URL): Promise<any>;