@hkdigital/lib-core 0.3.10 → 0.3.12

package/dist/classes/promise/HkPromise.js

@@ -1,22 +1,35 @@
 /**
- * Hkpromise.js
+ * HkPromise.js
  *
  * @description
- * HkPromise extends the default Promise class. A HkPromise offers some
- * additional methods, e.g. resolve, reject and setTimeout, which makes it
- * easier to use than the build in Promise class in some code constructions.
+ * HkPromise extends the default Promise class with external control methods
+ * and timeout/cancellation support. Perfect for scenarios where you need to
+ * resolve/reject a promise from outside its constructor.
  *
  * @example
+ * // Basic external control
+ * const promise = new HkPromise();
+ * setTimeout(() => promise.resolve('done'), 1000);
+ * const result = await promise; // 'done'
  *
- *   import HkPromise from "./HkPromise.js";
- *
- *   function() {
- *     const promise = new HkPromise();
+ * @example
+ * // Timeout support
+ * const promise = new HkPromise()
+ *   .setTimeout(5000, 'Operation timed out');
+ * // Promise auto-rejects after 5 seconds
  *
- *     setTimeout( promise.resolve, 1000 );
+ * @example
+ * // Cancellation with details
+ * const promise = new HkPromise();
+ * promise.cancel({ reason: 'user_cancelled', userId: 123 });
+ * // Creates PromiseError with details property
  *
- *     return promise;
- *   }
+ * @example
+ * // State inspection
+ * const promise = new HkPromise();
+ * console.log(promise.pending); // true
+ * promise.resolve('success');
+ * console.log(promise.resolved); // true
  */
 
 /* ------------------------------------------------------------------ Imports */
@@ -25,21 +38,9 @@ import * as expect from '../../util/expect/index.js';
 
 import { noop } from '../../util/function/index.js';
 
-/* ---------------------------------------------------------------- Internals */
-
-const resolved$ = Symbol('resolved');
-const rejected$ = Symbol('rejected');
-const pending$ = Symbol('pending');
-
-const timeout$ = Symbol('timeout');
-const cancelled$ = Symbol('cancelled');
-
-const resolveFn$ = Symbol('resolveFn');
-const rejectFn$ = Symbol('rejectFn');
+import { PromiseError } from '../../errors/promise.js';
 
-const timeoutTimer$ = Symbol('timeoutTimer');
-
-const hasThen$ = Symbol('hasThen');
+/* ---------------------------------------------------------------- Internals */
 
 /* ------------------------------------------------------------------- Export */
 
@@ -49,19 +50,19 @@ const hasThen$ = Symbol('hasThen');
  *   promise, such as 'resolve' and 'reject'
  */
 export default class HkPromise extends Promise {
-	// > TODO: convert to JS private properties
-	// #resolveFn
-	// #rejectFn
-	// #pending
-	// #resolved
-	// #rejected
-	// #cancelled
-	// #timeout
-	// #timeoutTimer
-	// #hasThen
+	// Private fields using modern JavaScript syntax
+	#resolveFn;
+	#rejectFn;
+	#pending = true;
+	#resolved = false;
+	#rejected = false;
+	#cancelled = false;
+	#timeout = false;
+	#timeoutTimer;
+	#hasThen = false;
 
 	/**
-	 * @param {()=>void} [initFn]
+	 * @param {(resolveFn?:function, rejectFn?:function)=>void} [initFn]
 	 */
 	constructor(initFn) {
 		let _resolveFn;
@@ -80,21 +81,9 @@ export default class HkPromise extends Promise {
 			_rejectFn = rejectFn;
 		});
 
-		// @note some values are not initialized on purpose,
-		//       to save time during promise creation
-
-		this[resolveFn$] = _resolveFn;
-		this[rejectFn$] = _rejectFn;
-
-		// this[ resolved$ ] = false;
-		// this[ rejected$ ] = false;
-
-		this[pending$] = true;
-
-		// this[ cancelled$ ] = false;
-		// this[ timeout$ ] = false;
-
-		// this[ timeoutTimer$ ] = undefined;
+		// Store resolve and reject functions
+		this.#resolveFn = _resolveFn;
+		this.#rejectFn = _rejectFn;
 	}
 
 	/**
@@ -103,7 +92,7 @@ export default class HkPromise extends Promise {
 	 * @returns {boolean} true if the promise has been resolved
 	 */
 	get resolved() {
-		return this[resolved$] ? true : false;
+		return this.#resolved;
 	}
 
 	/**
@@ -112,7 +101,7 @@ export default class HkPromise extends Promise {
 	 * @returns {boolean} true if the promise was rejected
 	 */
 	get rejected() {
-		return this[rejected$] ? true : false;
+		return this.#rejected;
 	}
 
 	/**
@@ -121,7 +110,7 @@ export default class HkPromise extends Promise {
 	 * @returns {boolean} true if the promise is still pending
 	 */
 	get pending() {
-		return this[pending$];
+		return this.#pending;
 	}
 
 	/**
@@ -130,7 +119,7 @@ export default class HkPromise extends Promise {
 	 * @returns {boolean} true if the promise was cancelled
 	 */
 	get cancelled() {
-		return this[cancelled$] ? true : false;
+		return this.#cancelled;
 	}
 
 	/**
@@ -139,41 +128,43 @@ export default class HkPromise extends Promise {
 	 * @returns {boolean} true if the promise was cancelled due to a timeout
 	 */
 	get timeout() {
-		return this[timeout$] ? true : false;
+		return this.#timeout;
 	}
 
 	/**
 	 * Resolve the promise
 	 *
-	 * @param {any} [value] - Value to pass to the "then" callbacks
+	 * @param {...any} args - Values to pass to the "then" callbacks
 	 *
 	 * @returns {object} this
 	 */
-	resolve(/* value */) {
+	resolve(...args) {
 		// -- Check current Promise state
 
-		if (!this[pending$]) {
-			if (this[resolved$]) {
+		if (!this.#pending) {
+			if (this.#resolved) {
 				throw new Error('Cannot resolve Promise. Promise has already resolved');
 			} else {
-				throw new Error('Cannot resolve Promise. Promise has already been rejected');
+				throw new Error(
+					'Cannot resolve Promise. Promise has already been rejected'
+				);
 			}
 		}
 
 		// -- Clear timeout timer (if any)
 
-		if (undefined !== this[timeoutTimer$]) {
-			clearTimeout(this[timeoutTimer$]);
+		if (undefined !== this.#timeoutTimer) {
+			clearTimeout(this.#timeoutTimer);
 
-			this[timeoutTimer$] = undefined;
+			this.#timeoutTimer = undefined;
 		}
 
 		// -- Set flags and call resolve function
 
-		this[resolved$] = true;
-		this[pending$] = false;
+		this.#resolved = true;
+		this.#pending = false;
 
-		this[resolveFn$](...arguments);
+		this.#resolveFn(...args);
 
 		return this;
 	}
@@ -183,13 +174,13 @@ export default class HkPromise extends Promise {
 	/**
 	 * Resolve the promise if the promise is still pending
 	 *
-	 * @param {any} [value] - Value to pass to the "catch" callbacks
+	 * @param {...any} args - Values to pass to the "then" callbacks
 	 *
 	 * @returns {object} this
 	 */
-	tryResolve(/* value */) {
-		if (this[pending$]) {
-			this.resolve(...arguments);
+	tryResolve(...args) {
+		if (this.#pending) {
+			this.resolve(...args);
 		}
 
 		return this;
@@ -198,13 +189,13 @@ export default class HkPromise extends Promise {
 	/**
 	 * Reject the promise
 	 *
-	 * @param {Object} [errorOrInfo]
-	 *   Object to pass to the "catch" callbacks, usually an Error object
+	 * @param {...any} args
+	 *   Objects to pass to the "catch" callbacks, usually an Error object or details
 	 *
 	 * @returns {object} this
 	 */
-	reject(/* errorOrInfo */) {
-		if (!this[hasThen$]) {
+	reject(...args) {
+		if (!this.#hasThen) {
 			//
 			// No then (or await) has been used
 			// add catch to prevent useless unhandled promise rejection
@@ -214,28 +205,30 @@ export default class HkPromise extends Promise {
 
 		// -- Check current Promise state
 
-		if (!this[pending$]) {
-			if (this[resolved$]) {
+		if (!this.#pending) {
+			if (this.#resolved) {
 				throw new Error('Cannot reject Promise. Promise has already resolved');
 			} else {
-				throw new Error('Cannot reject Promise. Promise has already been rejected');
+				throw new Error(
+					'Cannot reject Promise. Promise has already been rejected'
+				);
 			}
 		}
 
 		// -- Clear timeout timer (if any)
 
-		if (undefined !== this[timeoutTimer$]) {
-			clearTimeout(this[timeoutTimer$]);
+		if (undefined !== this.#timeoutTimer) {
+			clearTimeout(this.#timeoutTimer);
 
-			this[timeoutTimer$] = undefined;
+			this.#timeoutTimer = undefined;
 		}
 
 		// -- Set flags and call reject function
 
-		this[rejected$] = true;
-		this[pending$] = false;
+		this.#rejected = true;
+		this.#pending = false;
 
-		this[rejectFn$](...arguments);
+		this.#rejectFn(...args);
 
 		return this;
 	}
@@ -243,14 +236,14 @@ export default class HkPromise extends Promise {
 	/**
 	 * Reject the promise if the promise is still pending
 	 *
-	 * @param {Object} [errorOrInfo]
-	 *   Object to pass to the "catch" callbacks, usually an Error object
+	 * @param {...any} args
+	 *   Objects to pass to the "catch" callbacks, usually an Error object or details
 	 *
 	 * @returns {object} this
 	 */
-	tryReject(/* errorOrInfo */) {
-		if (this[pending$]) {
-			this.reject(...arguments);
+	tryReject(...args) {
+		if (this.#pending) {
+			this.reject(...args);
 		}
 
 		return this;
@@ -259,39 +252,51 @@ export default class HkPromise extends Promise {
 	/**
 	 * Reject the promise and set this.cancelled=true
 	 *
-	 * @param {Object} [errorOrInfo]
-	 *   Object to pass to the "catch" callbacks, usually an Error object
+	 * @param {Error|*} [errorOrDetails]
+	 *   Error object or details to pass to the "catch" callbacks
 	 *
 	 * @returns {object} this
 	 */
-	cancel(errorOrInfo) {
-		if (errorOrInfo) {
-			if (!(errorOrInfo instanceof Object)) {
-				throw new Error('Invalid parameter [errorOrInfo] (expected (error) object');
-			}
+	cancel(errorOrDetails) {
+		let promiseError;
+
+		if (errorOrDetails instanceof Error) {
+			// If it's an Error, create error chain
+			promiseError = new PromiseError(
+				errorOrDetails.message,
+				{
+					cancelled: true,
+					cause: errorOrDetails
+				}
+			);
 		} else {
-			errorOrInfo = new Error('Cancelled');
+			// If it's details or undefined, use as details
+			promiseError = new PromiseError(
+				'Cancelled',
+				{
+					cancelled: true,
+					details: errorOrDetails
+				}
+			);
 		}
 
-		errorOrInfo.cancelled = true;
-
-		this[cancelled$] = true;
-		this.reject(...arguments);
+		this.#cancelled = true;
+		this.reject(promiseError);
 
 		return this;
 	}
 
 	/**
-	 * Reject the promise and set this.cancelled=true
+	 * Reject the promise and set this.cancelled=true if still pending
 	 *
-	 * @param {Object} [errorOrInfo]
-	 *   Object to pass to the "catch" callbacks, usually an Error object
+	 * @param {Error|*} [errorOrDetails]
+	 *   Error object or details to pass to the "catch" callbacks
 	 *
 	 * @returns {object} this
 	 */
-	tryCancel(/*errorOrInfo*/) {
-		if (this[pending$]) {
-			this.cancel(...arguments);
+	tryCancel(errorOrDetails) {
+		if (this.#pending) {
+			this.cancel(errorOrDetails);
 		}
 
 		return this;
@@ -317,37 +322,39 @@ export default class HkPromise extends Promise {
 
 		// -- Check current Promise state
 
-		if (!this[pending$]) {
-			if (this[resolved$]) {
+		if (!this.#pending) {
+			if (this.#resolved) {
 				throw new Error('Cannot set timeout. Promise has already resolved');
 			} else {
-				throw new Error('Cannot set timeout. Promise has already been rejected');
+				throw new Error(
+					'Cannot set timeout. Promise has already been rejected'
+				);
 			}
 		}
 
 		// -- Clear existing timeout (if any)
 
-		if (undefined !== this[timeoutTimer$]) {
-			clearTimeout(this[timeoutTimer$]);
+		if (undefined !== this.#timeoutTimer) {
+			clearTimeout(this.#timeoutTimer);
 		}
 
 		// -- Set timeout
 
-		const err = new Error(message);
-
-		this[timeoutTimer$] = setTimeout(() => {
-			if (!this[pending$]) {
+		this.#timeoutTimer = setTimeout(() => {
+			if (!this.#pending) {
 				// Promise has already been resolved (should not happen)
 				return;
 			}
 
-			this[timeout$] = true;
-			this[cancelled$] = true;
+			this.#timeout = true;
+			this.#cancelled = true;
 
-			err.timeout = true;
-			err.cancelled = true;
+			const timeoutError = new PromiseError(message, {
+				timeout: true,
+				cancelled: true
+			});
 
-			this.reject(err);
+			this.reject(timeoutError);
 		}, ms);
 
 		// return this -> chainable method
@@ -357,21 +364,21 @@ export default class HkPromise extends Promise {
 	/**
 	 * Register a callback that is called when the promise resolves
 	 *
-	 * @param {function} callback
+	 * @param {...any} args - Callback functions and options
 	 */
-	then(/* callback */) {
-		this[hasThen$] = true;
+	then(...args) {
+		this.#hasThen = true;
 
-		return super.then(...arguments);
+		return super.then(...args);
 	}
 
 	/**
 	 * Register a callback that is called when the promise rejects, is
 	 * cancelled or times out
 	 *
-	 * @param {function} callback
+	 * @param {...any} args - Callback functions and options
 	 */
-	catch(/* callback */) {
-		return super.catch(...arguments);
+	catch(...args) {
+		return super.catch(...args);
 	}
 } // end class

package/dist/classes/streams/ServerEventsStore.d.ts

@@ -1,10 +1,10 @@
 export default class ServerEventsStore {
     /**
      * @param {object} _
-     * @param {Zods.AbsOrRelUrl} _.url
+     * @param {string} _.url
      */
     constructor({ url }: {
-        url: Zods.AbsOrRelUrl;
+        url: string;
     });
     /** @type {SubscribersCount} */
     subscribersCount: SubscribersCount;
@@ -19,4 +19,3 @@ export default class ServerEventsStore {
     #private;
 }
 import SubscribersCount from '../stores/SubscribersCount.js';
-import * as Zods from '../../zod/all.js';

package/dist/classes/streams/ServerEventsStore.js

@@ -1,14 +1,15 @@
 import { writable } from 'svelte/store';
 
 // eslint-disable-next-line no-unused-vars
-import * as Zods from '../../zod/all.js';
+import * as v from 'valibot';
+import { AbsOrRelUrl } from '../../valibot/index.js';
 
 import SubscribersCount from '../stores/SubscribersCount.js';
 
 // > Class
 
 export default class ServerEventsStore {
-	/** @type {Zods.AbsOrRelUrl} */
+	/** @type {string} */
 	#url;
 
 	/** @type {import("svelte/store").Writable<object|null>} */
@@ -25,10 +26,10 @@ export default class ServerEventsStore {
 
 	/**
 	 * @param {object} _
-	 * @param {Zods.AbsOrRelUrl} _.url
+	 * @param {string} _.url
 	 */
 	constructor({ url }) {
-		this.#url = Zods.AbsOrRelUrl.parse(url);
+		this.#url = v.parse(AbsOrRelUrl, url);
 
 		this.#store = writable(null);
 

package/dist/classes/svelte/index.d.ts

@@ -1,9 +1 @@
-export { default as AudioScene } from "./audio/AudioScene.svelte.js";
-export { default as AudioLoader } from "./audio/AudioLoader.svelte.js";
 export { default as FiniteStateMachine } from "./finite-state-machine/FiniteStateMachine.svelte.js";
-export { default as ImageLoader } from "./image/ImageLoader.svelte.js";
-export { default as ImageScene } from "./image/ImageScene.svelte.js";
-export { default as ImageVariantsLoader } from "./image/ImageVariantsLoader.svelte.js";
-export { default as NetworkLoader } from "./network-loader/NetworkLoader.svelte.js";
-export * from "./image/typedef.js";
-export * from "./network-loader/typedef.js";

package/dist/classes/svelte/index.js

@@ -1,14 +1 @@
-
-export { default as AudioScene } from './audio/AudioScene.svelte.js';
-export { default as AudioLoader } from './audio/AudioLoader.svelte.js';
-
 export { default as FiniteStateMachine } from './finite-state-machine/FiniteStateMachine.svelte.js';
-
-export { default as ImageLoader } from './image/ImageLoader.svelte.js';
-export { default as ImageScene } from './image/ImageScene.svelte.js';
-export { default as ImageVariantsLoader } from './image/ImageVariantsLoader.svelte.js';
-
-export { default as NetworkLoader } from './network-loader/NetworkLoader.svelte.js';
-
-export * from './image/typedef.js';
-export * from './network-loader/typedef.js';