@hkdigital/lib-core 0.3.11 → 0.3.13

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

@@ -3,13 +3,14 @@
  * to the originating Error
  * - The originating Error is set as `cause` property
  *
- * @param {string} message - Additional message to prepend
- * @param {Error|string} error - Original error
+ * @param {string} message - New error message
+ * @param {Error|string} originalError
  * @param {string|Object.<string, any>|null} [details]
+ *   New error details (a DetailError will be thrown)
  *
  * @throws {DetailedError}
  * @returns {never} This function never returns
  */
-export function rethrow(message: string, error: Error | string, details?: string | {
+export function rethrow(message: string, originalError: Error | string, details?: string | {
     [x: string]: any;
 } | null): never;

package/dist/util/exceptions/index.js

@@ -1,23 +1,26 @@
-
-import { DetailedError } from "../../errors/generic.js";
-
-/**
- * Creates a new Error from the error message and throws it with a reference
- * to the originating Error
- * - The originating Error is set as `cause` property
- *
- * @param {string} message - Additional message to prepend
- * @param {Error|string} error - Original error
- * @param {string|Object.<string, any>|null} [details]
- *
- * @throws {DetailedError}
- * @returns {never} This function never returns
- */
-export function rethrow(message, error, details ) {
-  if (!(error instanceof Error)) {
-    // Convert non-Error values to Error objects
-    error = new Error(String(error));
-  }
-
-  throw new DetailedError(message, details, error );
-}
+
+import { DetailedError } from "../../errors/generic.js";
+
+/**
+ * Creates a new Error from the error message and throws it with a reference
+ * to the originating Error
+ * - The originating Error is set as `cause` property
+ *
+ * @param {string} message - New error message
+ * @param {Error|string} originalError
+ * @param {string|Object.<string, any>|null} [details]
+ *   New error details (a DetailError will be thrown)
+ *
+ * @throws {DetailedError}
+ * @returns {never} This function never returns
+ */
+export function rethrow(message, originalError, details ) {
+  let error;
+
+  if (!(originalError instanceof Error)) {
+    // Convert non-Error values to Error objects
+    error = new Error(String(originalError));
+  }
+
+  throw new DetailedError(message, details, error ?? originalError );
+}

package/dist/util/expect/arrays.js

@@ -1,47 +1,47 @@
-import * as v from 'valibot';
-
-/**
- * Throws a validation error if value is not an array
- *
- * @param {any} value
- */
-function array_(value) {
-	v.parse(v.instance(Array), value);
-}
-
-export { array_ as array };
-
-/**
- * Throws a validation error if value is not an array of strings
- *
- * @param {any} value
- */
-export function stringArray(value) {
-	v.parse(v.array(v.string()), value);
-}
-
-/**
- * Throws a validation error if value is not an array of objects
- *
- * @param {any} value
- */
-export function objectArray(value) {
-	v.parse(v.array(v.looseObject({})), value);
-}
-
-/**
- * Throws an exception if the value is not an Array or the array is empty
- */
-export function notEmptyArray(value) {
-	v.parse(v.pipe(v.instance(Array), v.nonEmpty()), value);
-}
-
-/**
- * Throws a validation error if value is not array like
- * - Checks if the value is an object and has a property `length`
- *
- * @param {any} value
- */
-export function arrayLike(value) {
-	v.parse(v.object({ length: v.number() }), value);
-}
+import * as v from 'valibot';
+
+/**
+ * Throws a validation error if value is not an array
+ *
+ * @param {any} value
+ */
+function array_(value) {
+	v.parse(v.instance(Array), value);
+}
+
+export { array_ as array };
+
+/**
+ * Throws a validation error if value is not an array of strings
+ *
+ * @param {any} value
+ */
+export function stringArray(value) {
+	v.parse(v.array(v.string()), value);
+}
+
+/**
+ * Throws a validation error if value is not an array of objects
+ *
+ * @param {any} value
+ */
+export function objectArray(value) {
+	v.parse(v.array(v.looseObject({})), value);
+}
+
+/**
+ * Throws an exception if the value is not an Array or the array is empty
+ */
+export function notEmptyArray(value) {
+	v.parse(v.pipe(v.instance(Array), v.nonEmpty()), value);
+}
+
+/**
+ * Throws a validation error if value is not array like
+ * - Checks if the value is an object and has a property `length`
+ *
+ * @param {any} value
+ */
+export function arrayLike(value) {
+	v.parse(v.object({ length: v.number() }), value);
+}

package/dist/util/expect/index.js

@@ -1,259 +1,259 @@
-/**
- * Validation functions that can be used as safe guards in your code
- *
- * @example
- *
- * import * as expect from '<path>/expect.js';
- *
- * function logText( text )
- * {
- *   expect.string( text );
- *   expect.true( 1 > 0 );
- *
- *   console.log( text );
- * }
- *
- * logText( 'Hello' );
- * logText( 123 );      // <- Will throw an exception
- */
-
-import * as v from 'valibot';
-
-import * as is from '../is/index.js';
-
-/** Internals */
-
-const ObjectSchema = v.custom(is.object, `Invalid type: Expected object`);
-
-/** Exports */
-
-export * from './arrays.js';
-export * from './primitives.js';
-export * from './url.js';
-
-// > Base objects
-
-/**
- * Throws a validation error if value is not an object
- *
- * @param {any} value
- */
-function object_(value) {
-	v.parse(ObjectSchema, value);
-	// v.parse(v.looseObject({}), value);
-}
-
-export { object_ as object };
-
-/**
- * Throws a validation error if value is not a function
- *
- * @param {any} value
- */
-function function_(value) {
-	v.parse(v.function(), value);
-}
-
-export { function_ as function };
-
-export { function_ as class };
-
-/**
- * Throws a validation error if value is not a Promise
- *
- * @param {any} value
- */
-function promise_(value) {
-	v.parse(v.instance(Promise), value);
-}
-
-export { promise_ as promise };
-
-/**
- * Throws a validation error if value is not a Map
- *
- * @param {any} value
- */
-function map_(value) {
-	v.parse(v.instance(Map), value);
-}
-
-export { map_ as map };
-
-/**
- * Throws a validation error if value is not a Set
- *
- * @param {any} value
- */
-function set_(value) {
-	v.parse(v.instance(Set), value);
-}
-
-export { set_ as set };
-
-/**
- * Throws a validation error if value is not an Error instance
- *
- * @param {any} value
- */
-export function error_(value) {
-	v.parse(v.instance(Map), value);
-}
-
-export { error_ as error };
-
-// > Common values
-
-/**
- * Expect a value not to be null
- *
- * @param {any} value
- */
-export function notNull(value) {
-	v.notValue(null, value);
-}
-
-/**
- * Expect a value to be a boolean and true
- *
- * @param {any} value
- */
-export function _true(value) {
-	v.value(true, value);
-}
-
-export { _true as true };
-
-// > Compounds
-
-/**
- * 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
-
-// stringOrNull
-// stringOrUndefined
-
-/**
- * Throws a validation error if value is not a string
- *
- * @param {any} value
- */
-export function notEmptyString(value) {
-	const schema = v.pipe(v.string(), v.minLength(1));
-
-	v.parse(schema, value);
-}
-
-// notEmptyStringOrNull
-
-// asyncIterator
-// iterable
-
-/**
- * Throws a validation error if value is not iterable
- *
- * @param {any} value
- */
-export function iterable(value) {
-	const schema = v.pipe(v.looseObject({ [Symbol.iterator]: v.function() }));
-
-	v.parse(schema, value);
-}
-
-// iterator
-
-/**
- * Throws a validation error if value is not a a store (has not subscribe
- * method)
- *
- * @param {any} value
- */
-export function store(value) {
-	v.parse(
-		v.custom((value) => {
-			if (!is.object(value) || typeof value.subscribe !== 'function') {
-				return false;
-			}
-
-			return true;
-		}),
-		value
-	);
-}
-
-// ArrayBuffer
-// arrayOrUndefined
-// arangoCollectionId
-// uriComponent
-
-/**
- * Throws a validation error if value is not an object or the value
- * is an array
- *
- * @param {any} value
- */
-export function objectNoArray(value) {
-	v.parse(
-		v.custom((value) => {
-			if (!is.object(value) || value instanceof Array) {
-				return false;
-			}
-
-			return true;
-		}),
-		value
-	);
-}
-
-/**
- * Throws a validation error if value is not an object or the value
- * is a function
- *
- * @param {any} value
- */
-export function objectNoFunction(value) {
-	v.parse(
-		v.custom((value) => {
-			if (!is.object(value) || typeof value === 'function') {
-				return false;
-			}
-
-			return true;
-		}),
-		value
-	);
-}
-
-/**
- * Throws a validation error if value is not an object or null
- *
- * @param {any} value
- */
-export function objectOrNull(value) {
-	v.parse(v.union([v.value(null), v.looseObject({})]), value);
-}
-
-// objectOrUndefined
-// objectPath
-
-/**
- * Throws a validation error if value is not an array or Set
- *
- * @param {any} value
- */
-export function arrayOrSet(value) {
-	v.parse(v.union([v.instance(Array), v.instance(Set)]), value);
-}
-
-// setOfStrings
-// emptyStringOrSymbol
+/**
+ * Validation functions that can be used as safe guards in your code
+ *
+ * @example
+ *
+ * import * as expect from '<path>/expect.js';
+ *
+ * function logText( text )
+ * {
+ *   expect.string( text );
+ *   expect.true( 1 > 0 );
+ *
+ *   console.log( text );
+ * }
+ *
+ * logText( 'Hello' );
+ * logText( 123 );      // <- Will throw an exception
+ */
+
+import * as v from 'valibot';
+
+import * as is from '../is/index.js';
+
+/** Internals */
+
+const ObjectSchema = v.custom(is.object, `Invalid type: Expected object`);
+
+/** Exports */
+
+export * from './arrays.js';
+export * from './primitives.js';
+export * from './url.js';
+
+// > Base objects
+
+/**
+ * Throws a validation error if value is not an object
+ *
+ * @param {any} value
+ */
+function object_(value) {
+	v.parse(ObjectSchema, value);
+	// v.parse(v.looseObject({}), value);
+}
+
+export { object_ as object };
+
+/**
+ * Throws a validation error if value is not a function
+ *
+ * @param {any} value
+ */
+function function_(value) {
+	v.parse(v.function(), value);
+}
+
+export { function_ as function };
+
+export { function_ as class };
+
+/**
+ * Throws a validation error if value is not a Promise
+ *
+ * @param {any} value
+ */
+function promise_(value) {
+	v.parse(v.instance(Promise), value);
+}
+
+export { promise_ as promise };
+
+/**
+ * Throws a validation error if value is not a Map
+ *
+ * @param {any} value
+ */
+function map_(value) {
+	v.parse(v.instance(Map), value);
+}
+
+export { map_ as map };
+
+/**
+ * Throws a validation error if value is not a Set
+ *
+ * @param {any} value
+ */
+function set_(value) {
+	v.parse(v.instance(Set), value);
+}
+
+export { set_ as set };
+
+/**
+ * Throws a validation error if value is not an Error instance
+ *
+ * @param {any} value
+ */
+export function error_(value) {
+	v.parse(v.instance(Map), value);
+}
+
+export { error_ as error };
+
+// > Common values
+
+/**
+ * Expect a value not to be null
+ *
+ * @param {any} value
+ */
+export function notNull(value) {
+	v.notValue(null, value);
+}
+
+/**
+ * Expect a value to be a boolean and true
+ *
+ * @param {any} value
+ */
+export function _true(value) {
+	v.value(true, value);
+}
+
+export { _true as true };
+
+// > Compounds
+
+/**
+ * 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
+
+// stringOrNull
+// stringOrUndefined
+
+/**
+ * Throws a validation error if value is not a string
+ *
+ * @param {any} value
+ */
+export function notEmptyString(value) {
+	const schema = v.pipe(v.string(), v.minLength(1));
+
+	v.parse(schema, value);
+}
+
+// notEmptyStringOrNull
+
+// asyncIterator
+// iterable
+
+/**
+ * Throws a validation error if value is not iterable
+ *
+ * @param {any} value
+ */
+export function iterable(value) {
+	const schema = v.pipe(v.looseObject({ [Symbol.iterator]: v.function() }));
+
+	v.parse(schema, value);
+}
+
+// iterator
+
+/**
+ * Throws a validation error if value is not a a store (has not subscribe
+ * method)
+ *
+ * @param {any} value
+ */
+export function store(value) {
+	v.parse(
+		v.custom((value) => {
+			if (!is.object(value) || typeof value.subscribe !== 'function') {
+				return false;
+			}
+
+			return true;
+		}),
+		value
+	);
+}
+
+// ArrayBuffer
+// arrayOrUndefined
+// arangoCollectionId
+// uriComponent
+
+/**
+ * Throws a validation error if value is not an object or the value
+ * is an array
+ *
+ * @param {any} value
+ */
+export function objectNoArray(value) {
+	v.parse(
+		v.custom((value) => {
+			if (!is.object(value) || value instanceof Array) {
+				return false;
+			}
+
+			return true;
+		}),
+		value
+	);
+}
+
+/**
+ * Throws a validation error if value is not an object or the value
+ * is a function
+ *
+ * @param {any} value
+ */
+export function objectNoFunction(value) {
+	v.parse(
+		v.custom((value) => {
+			if (!is.object(value) || typeof value === 'function') {
+				return false;
+			}
+
+			return true;
+		}),
+		value
+	);
+}
+
+/**
+ * Throws a validation error if value is not an object or null
+ *
+ * @param {any} value
+ */
+export function objectOrNull(value) {
+	v.parse(v.union([v.value(null), v.looseObject({})]), value);
+}
+
+// objectOrUndefined
+// objectPath
+
+/**
+ * Throws a validation error if value is not an array or Set
+ *
+ * @param {any} value
+ */
+export function arrayOrSet(value) {
+	v.parse(v.union([v.instance(Array), v.instance(Set)]), value);
+}
+
+// setOfStrings
+// emptyStringOrSymbol