@hkdigital/lib-core 0.4.25 → 0.4.27

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

@@ -13,6 +13,30 @@ 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;
+    };
+    /**
+     * Get audio scene abort progress
+     */
+    get abortProgress(): {
+        sourcesAborted: number;
+        numberOfSources: number;
+    };
+    /**
+     * Start loading all audio sources
+     */
+    load(): void;
+    /**
+     * Abort loading all audio sources
+     */
+    abort(): void;
     destroy(): void;
     /**
      * Add in-memory audio source
@@ -28,16 +52,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 +60,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,12 +5,14 @@ import { LoadingStateMachine } from '../../../state/machines.js';
 import {
 	STATE_INITIAL,
 	STATE_LOADING,
-	STATE_UNLOADING,
 	STATE_LOADED,
-	STATE_CANCELLED,
+	STATE_ABORTING,
+	STATE_ABORTED,
 	STATE_ERROR,
 	LOAD,
-	LOADED
+	LOADED,
+	ABORT,
+	ABORTED
 } from '../../../state/machines.js';
 
 import AudioLoader from './AudioLoader.svelte.js';
@@ -30,10 +32,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;
 	});
@@ -87,6 +88,27 @@ export default class AudioScene {
 		};
 	});
 
+	#abortProgress = $derived.by(() => {
+		let sourcesAborted = 0;
+		const sources = this.#memorySources;
+		const numberOfSources = sources.length;
+
+		for (let j = 0; j < numberOfSources; j++) {
+			const source = sources[j];
+			const { audioLoader } = source;
+			const loaderState = audioLoader.state;
+
+			if (loaderState === STATE_ABORTED || loaderState === STATE_ERROR) {
+				sourcesAborted++;
+			}
+		} // end for
+
+		return {
+			sourcesAborted,
+			numberOfSources
+		};
+	});
+
 	/**
 	 * Construct AudioScene
 	 */
@@ -110,46 +132,62 @@ 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
+			if (state.current === STATE_ABORTING) {
+				const { sourcesAborted, numberOfSources } = this.#abortProgress;
 
-			this.state = state.current;
+				if (sourcesAborted === numberOfSources) {
+					// console.debug(`AudioScene: ${numberOfSources} sources aborted`);
+					this.#state.send(ABORTED);
+				}
+			}
 		});
+
+		state.onenter = ( currentState ) => {
+      // console.log('onenter', currentState );
+
+			if(currentState === STATE_LOADING )
+			{
+				// console.log('AudioScene:loading');
+				this.#startLoading();
+			}
+			else if(currentState === STATE_ABORTING )
+			{
+				// console.log('AudioScene:aborting');
+				this.#startAbort();
+			}
+
+			this.state = state.current;
+		};
+	}
+
+	/* ==== Common loader interface */
+
+	/**
+   * Get audio scene loading progress
+   */
+  get progress() {
+    return this.#progress;
+  }
+
+	/**
+	 * Get audio scene abort progress
+	 */
+	get abortProgress() {
+		return this.#abortProgress;
+	}
+
+	/**
+	 * Start loading all audio sources
+	 */
+	load() {
+		this.#state.send(LOAD);
+	}
+
+	/**
+	 * Abort loading all audio sources
+	 */
+	abort() {
+		this.#state.send(ABORT);
 	}
 
 	destroy() {
@@ -157,6 +195,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 +215,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 +251,33 @@ 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();
+		}
+	}
+
+	#startAbort() {
+		// console.log('#startAbort');
+
+		for (const { audioLoader } of this.#memorySources) {
+			audioLoader.abort();
+		}
+	}
+
+	/* ==== Audio specific */
+
 	/**
 	 * Set target gain
 	 *
@@ -281,6 +319,7 @@ export default class AudioScene {
 		this.setTargetGain(this.#unmutedTargetGain);
 	}
 
+	/* ==== Internals */
 
 	#getGainNode()
 	{
@@ -322,4 +361,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,30 @@
 export default class ImageScene {
     state: string;
     loaded: boolean;
+    /**
+     * Get image scene loading progress
+     */
+    get progress(): {
+        totalBytesLoaded: number;
+        totalSize: number;
+        sourcesLoaded: number;
+        numberOfSources: number;
+    };
+    /**
+     * Get image scene abort progress
+     */
+    get abortProgress(): {
+        sourcesAborted: number;
+        numberOfSources: number;
+    };
+    /**
+     * Start loading all image sources
+     */
+    load(): void;
+    /**
+     * Abort loading all image sources
+     */
+    abort(): void;
     destroy(): void;
     /**
      * Add image source
@@ -23,19 +47,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,12 +7,14 @@ import { LoadingStateMachine } from '../../../state/machines.js';
 import {
   STATE_INITIAL,
   STATE_LOADING,
-  STATE_UNLOADING,
   STATE_LOADED,
-  STATE_CANCELLED,
+  STATE_ABORTING,
+  STATE_ABORTED,
   STATE_ERROR,
   LOAD,
-  LOADED
+  LOADED,
+  ABORT,
+  ABORTED
 } from '../../../state/machines.js';
 
 import ImageLoader from './ImageLoader.svelte.js';
@@ -31,10 +33,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;
   });
@@ -74,6 +75,27 @@ export default class ImageScene {
     };
   });
 
+  #abortProgress = $derived.by(() => {
+    let sourcesAborted = 0;
+    const sources = this.#imageSources;
+    const numberOfSources = sources.length;
+
+    for (let j = 0; j < numberOfSources; j++) {
+      const source = sources[j];
+      const { imageLoader } = source;
+      const loaderState = imageLoader.state;
+
+      if (loaderState === STATE_ABORTED || loaderState === STATE_ERROR) {
+        sourcesAborted++;
+      }
+    } // end for
+
+    return {
+      sourcesAborted,
+      numberOfSources
+    };
+  });
+
   #sourcesLoaded = $derived( this.#progress.sourcesLoaded );
   #numberOfSources = $derived( this.#progress.numberOfSources );
 
@@ -92,55 +114,72 @@ 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;
+    $effect(() => {
+      if (state.current === STATE_ABORTING) {
+        const { sourcesAborted, numberOfSources } = this.#abortProgress;
+
+        if (sourcesAborted === numberOfSources) {
+          // console.debug(`ImageScene: ${numberOfSources} sources aborted`);
+          this.#state.send(ABORTED);
+        }
+      }
+    });
+
+    state.onenter = ( currentState ) => {
+      // console.log('onenter', currentState );
+
+      if(currentState === STATE_LOADING )
+      {
+        // console.log('ImageScene:loading');
+        this.#startLoading();
+      }
+      else if(currentState === STATE_ABORTING )
+      {
+        // console.log('ImageScene:aborting');
+        this.#startAbort();
+      }
+
+      this.state = currentState;
     };
   }
 
+  /* ==== Common loader interface */
+
+  /**
+   * Get image scene loading progress
+   */
+  get progress() {
+    return this.#progress;
+  }
+
+  /**
+   * Get image scene abort progress
+   */
+  get abortProgress() {
+    return this.#abortProgress;
+  }
+
+  /**
+   * Start loading all image sources
+   */
+  load() {
+    this.#state.send(LOAD);
+  }
+
+  /**
+   * Abort loading all image sources
+   */
+  abort() {
+    this.#state.send(ABORT);
+  }
+
   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 +198,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 +240,35 @@ export default class ImageScene {
 
     return source.imageLoader.getObjectURL();
   }
-}
+
+  async #startLoading() {
+    for (const { imageLoader } of this.#imageSources) {
+      imageLoader.load();
+    }
+  }
+
+  #startAbort() {
+    for (const { imageLoader } of this.#imageSources) {
+      imageLoader.abort();
+    }
+  }
+
+  /* ==== 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

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

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

@@ -7,14 +7,14 @@ import {
   STATE_LOADING,
   STATE_UNLOADING,
   STATE_LOADED,
-  STATE_CANCELLED,
-  STATE_ERROR,
+  STATE_ABORTING,
   LOAD,
   ERROR,
   LOADED,
   UNLOAD,
   INITIAL,
-  CANCEL
+  ABORT,
+  ABORTED
 } from '../../state/machines.js';
 
 import * as expect from '../../util/expect.js';
@@ -90,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:
@@ -127,21 +123,23 @@ export default class NetworkLoader {
           }
           break;
 
-        case STATE_CANCELLED:
+        case STATE_ABORTING:
           {
-            // console.log('NetworkLoader:cancelled');
+            // console.log('NetworkLoader:aborting');
             if (this._abortLoading) {
               this._abortLoading();
               this._abortLoading = null;
             }
+            // Transition to aborted state after abort completes
+            this._state.send(ABORTED);
           }
           break;
 
-        case STATE_ERROR:
-          {
-            console.log('NetworkLoader:error', state.error);
-          }
-          break;
+        // case STATE_ERROR:
+        //   {
+        //     console.log('NetworkLoader:error', state.error);
+        //   }
+        //   break;
       } // end switch
     };
   }
@@ -164,10 +162,10 @@ export default class NetworkLoader {
   /**
    * Abort the current loading operation
    * - Only works when in STATE_LOADING
-   * - Aborts network requests and transitions to STATE_CANCELLED
+   * - Aborts network requests and transitions to STATE_ABORTING
    */
-  doAbort() {
-    this._state.send(CANCEL);
+  abort() {
+    this._state.send(ABORT);
   }
 
   /**

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

@@ -1,4 +1,4 @@
-/** @typedef {import('./typedef.js').StateTransitionMetadata} StateTransitionMetadata */
+/** @typedef {import('./typedef.js').TransitionData} TransitionData */
 /** @typedef {import('./typedef.js').OnEnterCallback} OnEnterCallback */
 /** @typedef {import('./typedef.js').OnExitCallback} OnExitCallback */
 /**
@@ -50,7 +50,7 @@ export default class FiniteStateMachine extends EventEmitter {
     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';