@hkdigital/lib-core 0.4.40 → 0.4.42

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;
@@ -77,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 {
 

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

@@ -1,5 +1,9 @@
 declare const _default: {};
 export default _default;
+/**
+ * // property ...
+ */
+export type SourceConfig = object;
 export type MemorySourceParams = {
     /**
      * - Source identifier
@@ -14,7 +18,8 @@ export type MemorySourceParams = {
      */
     config?: object | undefined;
 };
-/**
- * // property ...
- */
-export type SourceConfig = object;
+export type MemorySource = {
+    label: string;
+    audioLoader: import("./AudioLoader.svelte.js").default;
+    config?: object | undefined;
+};

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

@@ -1,3 +1,8 @@
+/**
+ * @typedef {object} SourceConfig
+ * // property ...
+ */
+
 /**
  * @typedef {object} MemorySourceParams
  * @property {string} label - Source identifier
@@ -6,8 +11,10 @@
  */
 
 /**
- * @typedef {object} SourceConfig
- * // property ...
+ * @typedef {object} MemorySource
+ * @property {string} label
+ * @property {import('./AudioLoader.svelte.js').default} audioLoader
+ * @property {SourceConfig} [config]
  */
 
 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/ImageScene.svelte.d.ts

@@ -1,7 +1,3 @@
-/**
- * @typedef {object} SourceConfig
- * // property ...
- */
 /**
  * @typedef {object} ImageSceneSource
  * @property {string} label
@@ -63,10 +59,6 @@ export default class ImageScene extends SceneBase {
     #private;
 }
 export type ImageMeta = import("./typedef.js").ImageMeta;
-/**
- * // property ...
- */
-export type SourceConfig = object;
 export type ImageSceneSource = {
     label: string;
     imageLoader: ImageLoader;

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

@@ -5,11 +5,6 @@ import * as expect from '../../../util/expect.js';
 import SceneBase from '../base/SceneBase.svelte.js';
 import ImageLoader from './ImageLoader.svelte.js';
 
-/**
- * @typedef {object} SourceConfig
- * // property ...
- */
-
 /**
  * @typedef {object} ImageSceneSource
  * @property {string} label

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

@@ -1,3 +1,6 @@
+export * from "./audio/typedef.js";
+export * from "./base/typedef.js";
+export * from "./image/typedef.js";
 declare const _default: {};
 export default _default;
 export type ObjectPosition = "center" | "top" | "bottom" | "left" | "right" | "left top" | "left center" | "left bottom" | "center top" | "center center" | "center bottom" | "right top" | "right center" | "right bottom" | string;

package/dist/network/loaders/typedef.js

@@ -23,4 +23,8 @@
  * "2em center"       // Length + keyword
  */
 
+export * from './audio/typedef.js';
+export * from './base/typedef.js';
+export * from './image/typedef.js';
+
 export default {};

package/package.json

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