@hkdigital/lib-core 0.4.24 → 0.4.26

package/dist/network/loaders/audio/AudioScene.svelte.d.ts

@@ -13,6 +13,19 @@ export default class AudioScene {
     loaded: boolean;
     muted: boolean;
     targetGain: number;
+    /**
+   * Get audio scene loading progress
+   */
+    get progress(): {
+        totalBytesLoaded: number;
+        totalSize: number;
+        sourcesLoaded: number;
+        numberOfSources: number;
+    };
+    /**
+     * Start loading all audio sources
+     */
+    load(): void;
     destroy(): void;
     /**
      * Add in-memory audio source
@@ -28,16 +41,6 @@ export default class AudioScene {
         url: string;
         config?: SourceConfig;
     }): void;
-    /**
-     * Start loading all audio sources
-     */
-    load(): void;
-    /**
-     * Set an audio context to use
-     *
-     * @param {AudioContext} [audioContext]
-     */
-    setAudioContext(audioContext?: AudioContext): void;
     /**
      * Get a source that can be used to play the audio once
      *
@@ -46,6 +49,12 @@ export default class AudioScene {
      * @returns {Promise<AudioBufferSourceNode>}
      */
     getSourceNode(label: string): Promise<AudioBufferSourceNode>;
+    /**
+     * Set an audio context to use
+     *
+     * @param {AudioContext} [audioContext]
+     */
+    setAudioContext(audioContext?: AudioContext): void;
     /**
      * Set target gain
      *

package/dist/network/loaders/audio/AudioScene.svelte.js

@@ -5,10 +5,7 @@ import { LoadingStateMachine } from '../../../state/machines.js';
 import {
 	STATE_INITIAL,
 	STATE_LOADING,
-	STATE_UNLOADING,
 	STATE_LOADED,
-	STATE_CANCELLED,
-	STATE_ERROR,
 	LOAD,
 	LOADED
 } from '../../../state/machines.js';
@@ -30,10 +27,9 @@ import AudioLoader from './AudioLoader.svelte.js';
 export default class AudioScene {
 	#state = new LoadingStateMachine();
 
-	// @note this exported state is set by $effect's
+	// @note this exported state is set by onenter
 	state = $state(STATE_INITIAL);
 
-	// @note this exported state is set by $effect's
 	loaded = $derived.by(() => {
 		return this.state === STATE_LOADED;
 	});
@@ -109,47 +105,33 @@ export default class AudioScene {
 			}
 		});
 
-		$effect(() => {
-			switch (state.current) {
-				case STATE_LOADING:
-					{
-						// console.log('AudioScene:loading');
-						this.#startLoading();
-					}
-					break;
-
-				case STATE_UNLOADING:
-					{
-						// console.log('AudioScene:unloading');
-						// this.#startUnLoading();
-					}
-					break;
-
-				case STATE_LOADED:
-					{
-						// console.log('AudioScene:loaded');
-
-						// tODO
-						// this.#abortLoading = null;
-					}
-					break;
-
-				case STATE_CANCELLED:
-					{
-						// console.log('AudioScene:cancelled');
-						// TODO
-					}
-					break;
-
-				case STATE_ERROR:
-					{
-						console.error('AudioScene:error', state.error);
-					}
-					break;
-			} // end switch
+		state.onenter = ( currentState ) => {
+      // console.log('onenter', currentState );
+
+			if(currentState === STATE_LOADING )
+			{
+				// console.log('AudioScene:loading');
+				this.#startLoading();
+			}
 
 			this.state = state.current;
-		});
+		};
+	}
+
+	/* ==== Common loader interface */
+
+	/**
+   * Get audio scene loading progress
+   */
+  get progress() {
+    return this.#progress;
+  }
+
+	/**
+	 * Start loading all audio sources
+	 */
+	load() {
+		this.#state.send(LOAD);
 	}
 
 	destroy() {
@@ -157,6 +139,8 @@ export default class AudioScene {
 		// TODO: Unload AUdioLoaders?
 	}
 
+	/* ==== Source definitions */
+
 	/**
 	 * Add in-memory audio source
 	 * - Uses an AudioLoader instance to load audio data from network
@@ -175,36 +159,7 @@ export default class AudioScene {
 		this.#memorySources.push({ label, audioLoader, config });
 	}
 
-	/**
-	 * Start loading all audio sources
-	 */
-	load() {
-		this.#state.send(LOAD);
-
-		// FIXME: in unit test when moved to startloading it hangs!
-
-		for (const { audioLoader } of this.#memorySources) {
-			audioLoader.load();
-		}
-	}
-
-	/**
- 	 * Set an audio context to use
- 	 *
-	 * @param {AudioContext} [audioContext]
-	 */
-	setAudioContext( audioContext ) {
-		this.#audioContext = audioContext;
-	}
-
-	async #startLoading() {
-		// console.log('#startLoading');
-
-		// FIXME: in unit test when moved to startloading it hangs!
-		// for (const { audioLoader } of this.#memorySources) {
-		//   audioLoader.load();
-		// }
-	}
+	/* ==== Resource access */
 
 	/**
 	 * Get a source that can be used to play the audio once
@@ -240,6 +195,25 @@ export default class AudioScene {
 		return sourceNode;
 	}
 
+	/**
+ 	 * Set an audio context to use
+ 	 *
+	 * @param {AudioContext} [audioContext]
+	 */
+	setAudioContext( audioContext ) {
+		this.#audioContext = audioContext;
+	}
+
+	async #startLoading() {
+		// console.log('#startLoading');
+
+		for (const { audioLoader } of this.#memorySources) {
+		  audioLoader.load();
+		}
+	}
+
+	/* ==== Audio specific */
+
 	/**
 	 * Set target gain
 	 *
@@ -281,6 +255,7 @@ export default class AudioScene {
 		this.setTargetGain(this.#unmutedTargetGain);
 	}
 
+	/* ==== Internals */
 
 	#getGainNode()
 	{
@@ -322,4 +297,4 @@ export default class AudioScene {
 
 		throw new Error(`Source [${label}] has not been defined`);
 	}
-}
+} // end class

package/dist/network/loaders/image/ImageScene.svelte.d.ts

@@ -10,6 +10,19 @@
 export default class ImageScene {
     state: string;
     loaded: boolean;
+    /**
+     * Get image scene loading progress
+     */
+    get progress(): {
+        totalBytesLoaded: number;
+        totalSize: number;
+        sourcesLoaded: number;
+        numberOfSources: number;
+    };
+    /**
+     * Start loading all image sources
+     */
+    load(): void;
     destroy(): void;
     /**
      * Add image source
@@ -23,19 +36,6 @@ export default class ImageScene {
         label: string;
         imageSource: import("../../../config/typedef.js").ImageSource;
     }): void;
-    /**
-     * Start loading all image sources
-     */
-    load(): void;
-    /**
-     * Get image scene loading progress
-     */
-    get progress(): {
-        totalBytesLoaded: number;
-        totalSize: number;
-        sourcesLoaded: number;
-        numberOfSources: number;
-    };
     /**
      * Get an image loader
      *

package/dist/network/loaders/image/ImageScene.svelte.js

@@ -7,10 +7,7 @@ import { LoadingStateMachine } from '../../../state/machines.js';
 import {
   STATE_INITIAL,
   STATE_LOADING,
-  STATE_UNLOADING,
   STATE_LOADED,
-  STATE_CANCELLED,
-  STATE_ERROR,
   LOAD,
   LOADED
 } from '../../../state/machines.js';
@@ -31,10 +28,9 @@ import ImageLoader from './ImageLoader.svelte.js';
 export default class ImageScene {
   #state = new LoadingStateMachine();
 
-  // @note this exported state is set by $effect's
+  // @note this exported state is set by onenter
   state = $state(STATE_INITIAL);
 
-  // @note this exported state is set by $effect's
   loaded = $derived.by(() => {
     return this.state === STATE_LOADED;
   });
@@ -92,55 +88,42 @@ export default class ImageScene {
       }
     } );
 
-    state.onenter = ( state ) => {
-      // console.log('onenter', state );
-
-      switch (state) {
-        case STATE_LOADING:
-          {
-            // console.log('ImageScene:loading');
-            this.#startLoading();
-          }
-          break;
-
-        case STATE_UNLOADING:
-          {
-            // console.log('ImageScene:unloading');
-            // this.#startUnLoading();
-          }
-          break;
-
-        case STATE_LOADED:
-          {
-            // console.log('ImageScene:loaded');
-            // TODO
-            // this.#abortLoading = null;
-          }
-          break;
-
-        case STATE_CANCELLED:
-          {
-            // console.log('ImageScene:cancelled');
-            // TODO
-          }
-          break;
-
-        case STATE_ERROR:
-          {
-            console.log('ImageScene:error', state);
-          }
-          break;
-      } // end switch
-
-      this.state = state;
+    state.onenter = ( currentState ) => {
+      // console.log('onenter', currentState );
+
+      if(currentState === STATE_LOADING )
+      {
+        // console.log('ImageScene:loading');
+        this.#startLoading();
+      }
+
+      this.state = currentState;
     };
   }
 
+  /* ==== Common loader interface */
+
+  /**
+   * Get image scene loading progress
+   */
+  get progress() {
+    return this.#progress;
+  }
+
+  /**
+   * Start loading all image sources
+   */
+  load() {
+    this.#state.send(LOAD);
+  }
+
   destroy() {
     // TODO: disconnect all image sources?
     // TODO: Unload ImageLoaders?
   }
 
+  /* ==== Source definitions */
+
   /**
    * Add image source
    * - Uses an ImageLoader instance to load image data from network
@@ -159,42 +142,7 @@ export default class ImageScene {
     this.#imageSources.push({ label, imageLoader });
   }
 
-  /**
-   * Start loading all image sources
-   */
-  load() {
-    this.#state.send(LOAD);
-  }
-
-  async #startLoading() {
-    for (const { imageLoader } of this.#imageSources) {
-      imageLoader.load();
-    }
-  }
-
-  /**
-   * Get Image source
-   *
-   * @param {string} label
-   *
-   * @returns {ImageSceneSource}
-   */
-  #getImageSceneSource(label) {
-    for (const source of this.#imageSources) {
-      if (label === source.label) {
-        return source;
-      }
-    }
-
-    throw new Error(`Source [${label}] has not been defined`);
-  }
-
-  /**
-   * Get image scene loading progress
-   */
-  get progress() {
-    return this.#progress;
-  }
+  /* ==== Resource access */
 
   /**
    * Get an image loader
@@ -236,4 +184,29 @@ export default class ImageScene {
 
     return source.imageLoader.getObjectURL();
   }
-}
+
+  async #startLoading() {
+    for (const { imageLoader } of this.#imageSources) {
+      imageLoader.load();
+    }
+  }
+
+  /* ==== Internals */
+
+  /**
+   * Get Image source
+   *
+   * @param {string} label
+   *
+   * @returns {ImageSceneSource}
+   */
+  #getImageSceneSource(label) {
+    for (const source of this.#imageSources) {
+      if (label === source.label) {
+        return source;
+      }
+    }
+
+    throw new Error(`Source [${label}] has not been defined`);
+  }
+} // end class

package/dist/network/states/NetworkLoader.svelte.d.ts

@@ -42,6 +42,12 @@ export default class NetworkLoader {
      * Unoad all network data
      */
     unload(): void;
+    /**
+     * Abort the current loading operation
+     * - Only works when in STATE_LOADING
+     * - Aborts network requests and transitions to STATE_CANCELLED
+     */
+    doAbort(): void;
     /**
      * Get network data size in bytes
      * - Info comes from the content length response header

package/dist/network/states/NetworkLoader.svelte.js

@@ -13,7 +13,8 @@ import {
   ERROR,
   LOADED,
   UNLOAD,
-  INITIAL
+  INITIAL,
+  CANCEL
 } from '../../state/machines.js';
 
 import * as expect from '../../util/expect.js';
@@ -89,10 +90,6 @@ export default class NetworkLoader {
     const state = this._state;
     // const progress = this.progress;
 
-    //
-    // ISSUE: $effect is not triggered by  this._state changes,
-    //        using onenter instead
-    //
     this._state.onenter = () => {
       switch (state.current) {
         case STATE_LOADING:
@@ -129,7 +126,10 @@ export default class NetworkLoader {
         case STATE_CANCELLED:
           {
             // console.log('NetworkLoader:cancelled');
-            // TODO
+            if (this._abortLoading) {
+              this._abortLoading();
+              this._abortLoading = null;
+            }
           }
           break;
 
@@ -157,6 +157,15 @@ export default class NetworkLoader {
     this._state.send(UNLOAD);
   }
 
+  /**
+   * Abort the current loading operation
+   * - Only works when in STATE_LOADING
+   * - Aborts network requests and transitions to STATE_CANCELLED
+   */
+  doAbort() {
+    this._state.send(CANCEL);
+  }
+
   /**
    * Get network data size in bytes
    * - Info comes from the content length response header

package/dist/services/service-base/ServiceBase.d.ts

@@ -156,36 +156,40 @@ export class ServiceBase extends EventEmitter {
     /**
      * Set the service state and emit event
      *
-     * @private
+     * @protected
+     *
      * @param {ServiceState} newState - New state value
      * @emits {StateChangeEvent} EVENT_STATE_CHANGED
      */
-    private _setState;
+    protected _setState(newState: ServiceState): void;
     /**
      * Set the service target state and emit event
      *
-     * @private
+     * @protected
+     *
      * @param {ServiceState} newTargetState - New target state value
      * @emits {TargetStateChangeEvent} EVENT_TARGET_STATE_CHANGED
      */
-    private _setTargetState;
+    protected _setTargetState(newTargetState: ServiceState): void;
     /**
      * Set the health status and emit event if changed
      *
-     * @private
+     * @protected
+     *
      * @param {boolean} healthy - New health status
      * @emits {HealthChangeEvent} EVENT_HEALTH_CHANGED
      */
-    private _setHealthy;
+    protected _setHealthy(healthy: boolean): void;
     /**
      * Set error state and emit error event
      *
-     * @private
+     * @protected
+     *
      * @param {string} operation - Operation that failed
      * @param {Error} error - Error that occurred
      * @emits {ServiceErrorEvent} EVENT_ERROR
      */
-    private _setError;
+    protected _setError(operation: string, error: Error): void;
     #private;
 }
 export default ServiceBase;

package/dist/services/service-base/ServiceBase.js

@@ -447,12 +447,11 @@ export class ServiceBase extends EventEmitter {
     return {};
   }
 
-  // Private methods
-
   /**
    * Set the service state and emit event
    *
-   * @private
+   * @protected
+   *
    * @param {ServiceState} newState - New state value
    * @emits {StateChangeEvent} EVENT_STATE_CHANGED
    */
@@ -473,7 +472,8 @@ export class ServiceBase extends EventEmitter {
   /**
    * Set the service target state and emit event
    *
-   * @private
+   * @protected
+   *
    * @param {ServiceState} newTargetState - New target state value
    * @emits {TargetStateChangeEvent} EVENT_TARGET_STATE_CHANGED
    */
@@ -493,7 +493,8 @@ export class ServiceBase extends EventEmitter {
   /**
    * Set the health status and emit event if changed
    *
-   * @private
+   * @protected
+   *
    * @param {boolean} healthy - New health status
    * @emits {HealthChangeEvent} EVENT_HEALTH_CHANGED
    */
@@ -515,7 +516,8 @@ export class ServiceBase extends EventEmitter {
   /**
    * Set error state and emit error event
    *
-   * @private
+   * @protected
+   *
    * @param {string} operation - Operation that failed
    * @param {Error} error - Error that occurred
    * @emits {ServiceErrorEvent} EVENT_ERROR

package/dist/state/machines/finite-state-machine/FiniteStateMachine.svelte.d.ts

@@ -1,9 +1,4 @@
-/**
- * Initial code borrowed from:
- *
- * @see {@link https://runed.dev/docs/utilities/finite-state-machine}
- */
-/** @typedef {import('./typedef.js').StateTransitionMetadata} StateTransitionMetadata */
+/** @typedef {import('./typedef.js').TransitionData} TransitionData */
 /** @typedef {import('./typedef.js').OnEnterCallback} OnEnterCallback */
 /** @typedef {import('./typedef.js').OnExitCallback} OnExitCallback */
 /**
@@ -13,9 +8,9 @@
  */
 export function isLifecycleFnMeta(meta: any): boolean;
 /**
- * Defines a Finite State Machine
+ * Defines a Finite State Machine that extends EventEmitter
  */
-export default class FiniteStateMachine {
+export default class FiniteStateMachine extends EventEmitter {
     /**
      * Constructor
      *
@@ -55,6 +50,7 @@ export default class FiniteStateMachine {
     get current(): any;
     #private;
 }
-export type StateTransitionMetadata = import("./typedef.js").StateTransitionMetadata;
+export type TransitionData = import("./typedef.js").TransitionData;
 export type OnEnterCallback = import("./typedef.js").OnEnterCallback;
 export type OnExitCallback = import("./typedef.js").OnExitCallback;
+import EventEmitter from '../../../generic/events/classes/EventEmitter.js';