@hkdigital/lib-core 0.4.39 → 0.4.41

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

@@ -1,13 +1,4 @@
-/**
- * @typedef {object} SourceConfig
- * // property ...
- */
-/**
- * @typedef {object} MemorySource
- * @property {string} label
- * @property {AudioLoader} audioLoader
- * @property {SourceConfig} [config]
- */
+/** @typedef {import('./typedef.js').MemorySource} MemorySource */
 export default class AudioScene extends SceneBase {
     muted: boolean;
     targetGain: number;
@@ -29,16 +20,9 @@ export default class AudioScene extends SceneBase {
      * Add in-memory audio source
      * - Uses an AudioLoader instance to load audio data from network
      *
-     * @param {object} _
-     * @param {string} _.label
-     * @param {string} _.url
-     * @param {SourceConfig} [_.config]
+     * @param {import('./typedef.js').MemorySourceParams} params
      */
-    defineMemorySource({ label, url, config }: {
-        label: string;
-        url: string;
-        config?: object | undefined;
-    }): void;
+    defineMemorySource({ label, url, config }: import("./typedef.js").MemorySourceParams): void;
     /**
      * Get a source that can be used to play the audio once
      *
@@ -63,9 +47,9 @@ export default class AudioScene extends SceneBase {
      */
     setTargetGain(value: number): void;
     /**
-     * Get the current target gain (volume level)
+     * Get the current target gain
      *
-     * @returns {number} Target gain value (0.0 to 1.0+)
+     * @returns {number}
      */
     getTargetGain(): number;
     /**
@@ -84,14 +68,6 @@ export default class AudioScene extends SceneBase {
     unmute(): void;
     #private;
 }
-/**
- * // property ...
- */
-export type SourceConfig = object;
-export type MemorySource = {
-    label: string;
-    audioLoader: AudioLoader;
-    config?: object | undefined;
-};
+export type MemorySource = import("./typedef.js").MemorySource;
 import SceneBase from '../base/SceneBase.svelte.js';
 import AudioLoader from './AudioLoader.svelte.js';

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

@@ -3,17 +3,7 @@ import * as expect from '../../../util/expect.js';
 import SceneBase from '../base/SceneBase.svelte.js';
 import AudioLoader from './AudioLoader.svelte.js';
 
-/**
- * @typedef {object} SourceConfig
- * // property ...
- */
-
-/**
- * @typedef {object} MemorySource
- * @property {string} label
- * @property {AudioLoader} audioLoader
- * @property {SourceConfig} [config]
- */
+/** @typedef {import('./typedef.js').MemorySource} MemorySource */
 
 export default class AudioScene extends SceneBase {
 
@@ -25,19 +15,16 @@ export default class AudioScene extends SceneBase {
 
 	targetGain = $derived( this.#targetGain );
 
-	/** @type {AudioContext|null} */
-	#audioContext = null;
+	/** @type {AudioContext|undefined} */
+	#audioContext;
 
-	/** {GainNode} */
-	#targetGainNode = null;
+	/** @type {GainNode|undefined} */
+	#targetGainNode;
 
 	/** @type {MemorySource[]} */
 	#memorySources = $state([]);
 
 
-	/**
-	 * Construct AudioScene
-	 */
 	constructor() {
 		super();
 	}
@@ -71,10 +58,7 @@ export default class AudioScene extends SceneBase {
 	 * Add in-memory audio source
 	 * - Uses an AudioLoader instance to load audio data from network
 	 *
-	 * @param {object} _
-	 * @param {string} _.label
-	 * @param {string} _.url
-	 * @param {SourceConfig} [_.config]
+	 * @param {import('./typedef.js').MemorySourceParams} params
 	 */
 	defineMemorySource({ label, url, config }) {
 		expect.notEmptyString(label);
@@ -95,8 +79,10 @@ export default class AudioScene extends SceneBase {
 	 * @returns {Promise<AudioBufferSourceNode>}
 	 */
 	async getSourceNode(label) {
+
 		// @note Gain setup
-		// https://stackoverflow.com/questions/46203191/should-i-disconnect-nodes-that-cant-be-used-anymore
+		// https://stackoverflow.com/
+		//   questions/46203191/should-i-disconnect-nodes-that-cant-be-used-anymore
 
 		const { audioLoader /*, config */ } = this.#getMemorySource(label);
 
@@ -149,9 +135,9 @@ export default class AudioScene extends SceneBase {
 	}
 
 	/**
-	 * Get the current target gain (volume level)
+	 * Get the current target gain
 	 *
-	 * @returns {number} Target gain value (0.0 to 1.0+)
+	 * @returns {number}
 	 */
 	getTargetGain()
 	{
@@ -191,6 +177,11 @@ export default class AudioScene extends SceneBase {
 
 	/* ==== Internals */
 
+	/**
+	 * Get or create the master gain node
+	 *
+	 * @returns {GainNode}
+	 */
 	#getGainNode()
 	{
 		if( !this.#targetGainNode )
@@ -205,6 +196,11 @@ export default class AudioScene extends SceneBase {
 		return this.#targetGainNode;
 	}
 
+	/**
+	 * Get or create the audio context
+	 *
+	 * @returns {AudioContext}
+	 */
 	#getAudioContext()
 	{
 		if( !this.#audioContext )
@@ -216,7 +212,7 @@ export default class AudioScene extends SceneBase {
 	}
 
 	/**
-	 * Get memory source
+	 * Find memory source by label
 	 *
 	 * @param {string} label
 	 *

package/dist/network/loaders/audio/typedef.d.ts

@@ -0,0 +1,25 @@
+declare const _default: {};
+export default _default;
+export type MemorySourceParams = {
+    /**
+     * - Source identifier
+     */
+    label: string;
+    /**
+     * - Audio file URL
+     */
+    url: string;
+    /**
+     * - Optional source configuration
+     */
+    config?: object | undefined;
+};
+export type MemorySource = {
+    label: string;
+    audioLoader: import("./AudioLoader.svelte.js").default;
+    config?: object | undefined;
+};
+/**
+ * // property ...
+ */
+export type SourceConfig = object;

package/dist/network/loaders/audio/typedef.js

@@ -0,0 +1,20 @@
+/**
+ * @typedef {object} MemorySourceParams
+ * @property {string} label - Source identifier
+ * @property {string} url - Audio file URL
+ * @property {SourceConfig} [config] - Optional source configuration
+ */
+
+/**
+ * @typedef {object} MemorySource
+ * @property {string} label
+ * @property {import('./AudioLoader.svelte.js').default} audioLoader
+ * @property {SourceConfig} [config]
+ */
+
+/**
+ * @typedef {object} SourceConfig
+ * // property ...
+ */
+
+export default {};

package/dist/network/loaders/base/SceneBase.svelte.d.ts

@@ -1,3 +1,4 @@
+/** @typedef {import('./typedef.js').SceneLoadingProgress} SceneLoadingProgress */
 /**
  * Base class for scene loaders that manage collections of media sources
  */
@@ -13,20 +14,15 @@ export default class SceneBase {
     /**
      * Extract the loader from a source object
      *
-     * @param {*} source
+     * @param {object} source - Source object
      *
-     * @returns {*} Loader object with progress and state properties
+     * @returns {import('../../states/index.js').NetworkLoader} loader
      */
-    getLoaderFromSource(source: any): any;
+    getLoaderFromSource(source: object): import("../../states/index.js").NetworkLoader;
     /**
      * Get scene loading progress
      */
-    get progress(): {
-        totalBytesLoaded: number;
-        totalSize: number;
-        sourcesLoaded: number;
-        numberOfSources: number;
-    };
+    get progress(): import("./typedef.js").SceneLoadingProgress;
     /**
      * Get scene abort progress
      */
@@ -44,22 +40,24 @@ export default class SceneBase {
     abort(): void;
     /**
      * Preload all sources with progress tracking and abort capability
-     * - Starts loading and waits for completion
-     * - Supports timeout and progress callbacks
-     * - Returns object with promise and abort function
      *
      * @param {object} [options]
-     * @param {number} [options.timeoutMs=10000] - Timeout in milliseconds
-     * @param {Function} [options.onProgress] - Progress callback function
+     * @param {number} [options.timeoutMs=10000]
+     *   Timeout in milliseconds
+     * @param {(progress: SceneLoadingProgress) => void} [options.onProgress]
+     *   Progress callback function
      *
-     * @returns {object} Object with promise and abort function
-     * @returns {Promise<SceneBase>} returns.promise - Promise that resolves when loaded
-     * @returns {Function} returns.abort - Function to abort preloading
+     * @returns {{promise: Promise<SceneBase>, abort: Function}}
+     *   Object with promise that resolves when loaded and abort function
      */
     preload({ timeoutMs, onProgress }?: {
         timeoutMs?: number | undefined;
-        onProgress?: Function | undefined;
-    }): object;
+        onProgress?: ((progress: SceneLoadingProgress) => void) | undefined;
+    }): {
+        promise: Promise<SceneBase>;
+        abort: Function;
+    };
     destroy(): void;
     #private;
 }
+export type SceneLoadingProgress = import("./typedef.js").SceneLoadingProgress;

package/dist/network/loaders/base/SceneBase.svelte.js

@@ -15,6 +15,8 @@ import {
 
 import { waitForState } from '../../../util/svelte.js';
 
+/** @typedef {import('./typedef.js').SceneLoadingProgress} SceneLoadingProgress */
+
 /**
  * Base class for scene loaders that manage collections of media sources
  */
@@ -28,6 +30,7 @@ export default class SceneBase {
     return this.state === STATE_LOADED;
   });
 
+  /** @type {SceneLoadingProgress} */
   #progress = $derived.by(() => {
     let totalSize = 0;
     let totalBytesLoaded = 0;
@@ -130,9 +133,9 @@ export default class SceneBase {
   /**
    * Extract the loader from a source object
    *
-   * @param {*} source
+   * @param {object} source - Source object
    *
-   * @returns {*} Loader object with progress and state properties
+   * @returns {import('../../states/index.js').NetworkLoader} loader
    */
   // eslint-disable-next-line no-unused-vars
   getLoaderFromSource(source) {
@@ -171,21 +174,24 @@ export default class SceneBase {
 
   /**
    * Preload all sources with progress tracking and abort capability
-   * - Starts loading and waits for completion
-   * - Supports timeout and progress callbacks
-   * - Returns object with promise and abort function
    *
    * @param {object} [options]
-   * @param {number} [options.timeoutMs=10000] - Timeout in milliseconds
-   * @param {Function} [options.onProgress] - Progress callback function
+   * @param {number} [options.timeoutMs=10000]
+   *   Timeout in milliseconds
+   * @param {(progress: SceneLoadingProgress) => void} [options.onProgress]
+   *   Progress callback function
    *
-   * @returns {object} Object with promise and abort function
-   * @returns {Promise<SceneBase>} returns.promise - Promise that resolves when loaded
-   * @returns {Function} returns.abort - Function to abort preloading
+   * @returns {{promise: Promise<SceneBase>, abort: Function}}
+   *   Object with promise that resolves when loaded and abort function
    */
   preload({ timeoutMs = 10000, onProgress } = {}) {
+
+    /** @type {number|NodeJS.Timeout|null} */
     let timeoutId = null;
+
+    /** @type {number|NodeJS.Timeout|null} */
     let progressIntervalId = null;
+
     let isAborted = false;
 
     const abort = () => {

package/dist/network/loaders/base/typedef.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {};
+export default _default;
+export type SceneLoadingProgress = {
+    /**
+     * - Total bytes loaded across all sources
+     */
+    totalBytesLoaded: number;
+    /**
+     * - Total size across all sources
+     */
+    totalSize: number;
+    /**
+     * - Number of sources fully loaded
+     */
+    sourcesLoaded: number;
+    /**
+     * - Total number of sources
+     */
+    numberOfSources: number;
+};

package/dist/network/loaders/base/typedef.js

@@ -0,0 +1,9 @@
+/**
+ * @typedef {Object} SceneLoadingProgress
+ * @property {number} totalBytesLoaded - Total bytes loaded across all sources
+ * @property {number} totalSize - Total size across all sources
+ * @property {number} sourcesLoaded - Number of sources fully loaded
+ * @property {number} numberOfSources - Total number of sources
+ */
+
+export default {};

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

@@ -8,7 +8,7 @@ export default class ImageLoader extends NetworkLoader {
      * @param {import('../../../config/typedef.js').ImageSource} imageSource
      */
     constructor(imageSource: import("../../../config/typedef.js").ImageSource);
-    get imageMeta(): import("./typedef.js").ImageMeta;
+    get imageMeta(): import("../../../config/typedef.js").ImageMeta;
     get url(): string | null;
     #private;
 }

package/dist/network/loaders/image/typedef.d.ts

@@ -1,16 +1,3 @@
 declare const _default: {};
 export default _default;
-export type ImageMeta = {
-    /**
-     * - URL of the image
-     */
-    src: string;
-    /**
-     * - Width of the image
-     */
-    width: number;
-    /**
-     * - Height of the image
-     */
-    height: number;
-};
+export type ImageMeta = import("../../../config/typedef.js").ImageMeta;

package/dist/network/loaders/image/typedef.js

@@ -1,8 +1,3 @@
-/**
- * @typedef {Object} ImageMeta
- * @property {string} src - URL of the image
- * @property {number} width - Width of the image
- * @property {number} height - Height of the image
- */
+/** @typedef {import('../../../config/typedef.js').ImageMeta} ImageMeta */
 
 export default {};

package/dist/services/service-manager/ServiceManager.js

@@ -422,7 +422,7 @@ export class ServiceManager extends EventEmitter {
       if (!result.ok) {
         // Create detailed error with the actual service failure
         const detailedError = new DetailedError(
-          `Failed to start service [${name}], stopping`,
+          `Failed to start service [${name}]`,
           null,
           result.error
         );

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-core",
-	"version": "0.4.39",
+	"version": "0.4.41",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"