tiny-essentials 1.29.0 → 1.29.2

package/dist/v1/libs/html/loader/beta/formats/TinyAudioLoader.cjs

@@ -0,0 +1,77 @@
+'use strict';
+
+var TinyContentLoader = require('./TinyContentLoader.cjs');
+
+/**
+ * @fileoverview Concrete loader for audio. Mirrors the VideoLoader API so the
+ * two are interchangeable inside a factory. Audio has no intrinsic dimensions,
+ * so width and height are always 0.
+ */
+
+/**
+ * Configuration options for {@link TinyAudioLoader}.
+ * @typedef {Object} AudioLoaderOptions
+ * @property {string} [src] - The audio source URL.
+ * @property {number} [timeout] - Maximum time in milliseconds before the load is aborted.
+ * @property {string|null} [crossOrigin] - The CORS mode applied to the audio.
+ * @property {boolean} [autoplay] - Whether the audio should autoplay.
+ * @property {boolean} [loop] - Whether the audio should loop.
+ * @property {boolean} [muted] - Whether the audio should be muted.
+ * @property {boolean} [controls] - Whether the audio should display controls (default true).
+ * @property {'none'|'metadata'|'auto'} [preload] - The preload strategy.
+ * @property {HTMLAudioElement|null} [element] - An existing DOM element to adopt.
+ * @property {boolean} [progressive] - Whether to render progressively during fetch (default true).
+ * @property {boolean} [autoReload] - Whether an external `src` change triggers a reload.
+ * @property {boolean} [stream] - Whether to download the audio through fetch for byte progress.
+ * @property {import('../../utils/TinyMediaCache.mjs').default|null} [cache] - An optional shared memory cache.
+ */
+
+/**
+ * Loads a single audio track with full lifecycle control.
+ * @extends {TinyContentLoader<HTMLAudioElement, 'audio'>}
+ * @beta
+ */
+class TinyAudioLoader extends TinyContentLoader {
+  /**
+   * Retrieves the uppercase tag name of the element this loader creates.
+   * @returns {string} The literal string `'AUDIO'`.
+   */
+  static get tagName() {
+    return 'AUDIO';
+  }
+
+  /**
+   * Creates a new audio loader and validates the provided options.
+   * @param {AudioLoaderOptions} [options] - The loader configuration.
+   * @throws {TypeError} If `crossOrigin` is not a string or null.
+   * @throws {TypeError} If `preload` is not a string.
+   */
+  constructor(options = {}) {
+    if (
+      options.element !== null &&
+      options.element !== undefined &&
+      !(options.element instanceof HTMLAudioElement)
+    ) {
+      throw new TypeError('The "element" option must be an HTMLAudioElement or null.');
+    }
+    /** @type {import('./TinyContentLoader.mjs').TypesToTry} */
+    const mimeType = {
+      mp4: ['audio/mp4; codecs="mp4a.40.2"'],
+      webm: ['audio/webm; codecs="opus"', 'audio/webm; codecs="vorbis"'],
+      mp3: ['audio/mpeg'],
+    };
+    mimeType.m4a = mimeType.mp4;
+    mimeType.mpeg = mimeType.mp3;
+    super('audio', mimeType, options);
+  }
+
+  /**
+   * The underlying `<audio>` element managed by the loader.
+   * @returns {HTMLAudioElement|null} The underlying `<audio>` element, or `null` before the load starts.
+   */
+  get audio() {
+    return this.media;
+  }
+}
+
+module.exports = TinyAudioLoader;

package/dist/v1/libs/html/loader/beta/formats/TinyAudioLoader.d.mts

@@ -0,0 +1,103 @@
+/**
+ * @fileoverview Concrete loader for audio. Mirrors the VideoLoader API so the
+ * two are interchangeable inside a factory. Audio has no intrinsic dimensions,
+ * so width and height are always 0.
+ */
+import TinyContentLoader from './TinyContentLoader.mjs';
+export type AudioLoaderOptions = {
+    /**
+     * - The audio source URL.
+     */
+    src?: string;
+    /**
+     * - Maximum time in milliseconds before the load is aborted.
+     */
+    timeout?: number;
+    /**
+     * - The CORS mode applied to the audio.
+     */
+    crossOrigin?: string | null;
+    /**
+     * - Whether the audio should autoplay.
+     */
+    autoplay?: boolean;
+    /**
+     * - Whether the audio should loop.
+     */
+    loop?: boolean;
+    /**
+     * - Whether the audio should be muted.
+     */
+    muted?: boolean;
+    /**
+     * - Whether the audio should display controls (default true).
+     */
+    controls?: boolean;
+    /**
+     * - The preload strategy.
+     */
+    preload?: 'none' | 'metadata' | 'auto';
+    /**
+     * - An existing DOM element to adopt.
+     */
+    element?: HTMLAudioElement | null;
+    /**
+     * - Whether to render progressively during fetch (default true).
+     */
+    progressive?: boolean;
+    /**
+     * - Whether an external `src` change triggers a reload.
+     */
+    autoReload?: boolean;
+    /**
+     * - Whether to download the audio through fetch for byte progress.
+     */
+    stream?: boolean;
+    /**
+     * - An optional shared memory cache.
+     */
+    cache?: import('../../utils/TinyMediaCache.mjs').default | null;
+};
+/**
+ * Configuration options for {@link TinyAudioLoader}.
+ * @typedef {Object} AudioLoaderOptions
+ * @property {string} [src] - The audio source URL.
+ * @property {number} [timeout] - Maximum time in milliseconds before the load is aborted.
+ * @property {string|null} [crossOrigin] - The CORS mode applied to the audio.
+ * @property {boolean} [autoplay] - Whether the audio should autoplay.
+ * @property {boolean} [loop] - Whether the audio should loop.
+ * @property {boolean} [muted] - Whether the audio should be muted.
+ * @property {boolean} [controls] - Whether the audio should display controls (default true).
+ * @property {'none'|'metadata'|'auto'} [preload] - The preload strategy.
+ * @property {HTMLAudioElement|null} [element] - An existing DOM element to adopt.
+ * @property {boolean} [progressive] - Whether to render progressively during fetch (default true).
+ * @property {boolean} [autoReload] - Whether an external `src` change triggers a reload.
+ * @property {boolean} [stream] - Whether to download the audio through fetch for byte progress.
+ * @property {import('../../utils/TinyMediaCache.mjs').default|null} [cache] - An optional shared memory cache.
+ */
+/**
+ * Loads a single audio track with full lifecycle control.
+ * @extends {TinyContentLoader<HTMLAudioElement, 'audio'>}
+ * @beta
+ */
+declare class TinyAudioLoader extends TinyContentLoader<HTMLAudioElement, 'audio'> {
+    /**
+     * Retrieves the uppercase tag name of the element this loader creates.
+     * @returns {string} The literal string `'AUDIO'`.
+     */
+    static get tagName(): string;
+    /**
+     * Creates a new audio loader and validates the provided options.
+     * @param {AudioLoaderOptions} [options] - The loader configuration.
+     * @throws {TypeError} If `crossOrigin` is not a string or null.
+     * @throws {TypeError} If `preload` is not a string.
+     */
+    constructor(options?: AudioLoaderOptions);
+    /**
+     * The underlying `<audio>` element managed by the loader.
+     * @returns {HTMLAudioElement|null} The underlying `<audio>` element, or `null` before the load starts.
+     */
+    get audio(): HTMLAudioElement | null;
+}
+export default TinyAudioLoader;
+//# sourceMappingURL=TinyAudioLoader.d.mts.map

package/dist/v1/libs/html/loader/beta/formats/TinyAudioLoader.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TinyAudioLoader.d.mts","sourceRoot":"","sources":["../../../../../../../src/v1/libs/html/loader/beta/formats/TinyAudioLoader.mjs"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AAIrD,YAAkB,kBAAkB,GACpC;;;;IAAoB,GAAG,AAAvB,CACA,EADW,MAAM,CACjB;;;;IAAoB,OAAO,AAA3B,CACA,EADW,MAAM,CACjB;;;;IAAyB,WAAW,AAApC,CACA,EADW,MAAM,GAAC,IAAI,CACtB;;;;IAAqB,QAAQ,AAA7B,CACA,EADW,OAAO,CAClB;;;;IAAqB,IAAI,AAAzB,CACA,EADW,OAAO,CAClB;;;;IAAqB,KAAK,AAA1B,CACA,EADW,OAAO,CAClB;;;;IAAqB,QAAQ,AAA7B,CACA,EADW,OAAO,CAClB;;;;IAAsC,OAAO,AAA7C,CACA,EADW,MAAM,GAAC,UAAU,GAAC,MAAM,CACnC;;;;IAAmC,OAAO,AAA1C,CACA,EADW,gBAAgB,GAAC,IAAI,CAChC;;;;IAAqB,WAAW,AAAhC,CACA,EADW,OAAO,CAClB;;;;IAAqB,UAAU,AAA/B,CACA,EADW,OAAO,CAClB;;;;IAAqB,MAAM,AAA3B,CACA,EADW,OAAO,CAClB;;;;IAAmE,KAAK,AAAxE,CACF,EADa,OAAO,gCAAgC,EAAE,OAAO,GAAC,IAAI,CAClE;CAAA,CAAA;AAhBD;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;GAIG;AACH,cAAM,eAAgB,SAAQ,iBAAiB,CAHhB,gBAAgB,EAAE,OAAO,CAGT;IAC7C;;;OAGG;IACH,MAAM,KAAK,OAAO,IAFL,MAAM,CAIlB;IAED;;;;;OAKG;IACH,YAAY,OAAO,AAJhB,CACA,EADQ,kBAIa,EAiBvB;IAED;;;OAGG;IACH,IAAI,KAAK,IAFI,gBAAgB,GAAC,IAAI,CAIjC;CACF;eAEc,eAAe"}

package/dist/v1/libs/html/loader/beta/formats/TinyAudioLoader.mjs

@@ -0,0 +1,67 @@
+/**
+ * @fileoverview Concrete loader for audio. Mirrors the VideoLoader API so the
+ * two are interchangeable inside a factory. Audio has no intrinsic dimensions,
+ * so width and height are always 0.
+ */
+import TinyContentLoader from './TinyContentLoader.mjs';
+/**
+ * Configuration options for {@link TinyAudioLoader}.
+ * @typedef {Object} AudioLoaderOptions
+ * @property {string} [src] - The audio source URL.
+ * @property {number} [timeout] - Maximum time in milliseconds before the load is aborted.
+ * @property {string|null} [crossOrigin] - The CORS mode applied to the audio.
+ * @property {boolean} [autoplay] - Whether the audio should autoplay.
+ * @property {boolean} [loop] - Whether the audio should loop.
+ * @property {boolean} [muted] - Whether the audio should be muted.
+ * @property {boolean} [controls] - Whether the audio should display controls (default true).
+ * @property {'none'|'metadata'|'auto'} [preload] - The preload strategy.
+ * @property {HTMLAudioElement|null} [element] - An existing DOM element to adopt.
+ * @property {boolean} [progressive] - Whether to render progressively during fetch (default true).
+ * @property {boolean} [autoReload] - Whether an external `src` change triggers a reload.
+ * @property {boolean} [stream] - Whether to download the audio through fetch for byte progress.
+ * @property {import('../../utils/TinyMediaCache.mjs').default|null} [cache] - An optional shared memory cache.
+ */
+/**
+ * Loads a single audio track with full lifecycle control.
+ * @extends {TinyContentLoader<HTMLAudioElement, 'audio'>}
+ * @beta
+ */
+class TinyAudioLoader extends TinyContentLoader {
+    /**
+     * Retrieves the uppercase tag name of the element this loader creates.
+     * @returns {string} The literal string `'AUDIO'`.
+     */
+    static get tagName() {
+        return 'AUDIO';
+    }
+    /**
+     * Creates a new audio loader and validates the provided options.
+     * @param {AudioLoaderOptions} [options] - The loader configuration.
+     * @throws {TypeError} If `crossOrigin` is not a string or null.
+     * @throws {TypeError} If `preload` is not a string.
+     */
+    constructor(options = {}) {
+        if (options.element !== null &&
+            options.element !== undefined &&
+            !(options.element instanceof HTMLAudioElement)) {
+            throw new TypeError('The "element" option must be an HTMLAudioElement or null.');
+        }
+        /** @type {import('./TinyContentLoader.mjs').TypesToTry} */
+        const mimeType = {
+            mp4: ['audio/mp4; codecs="mp4a.40.2"'],
+            webm: ['audio/webm; codecs="opus"', 'audio/webm; codecs="vorbis"'],
+            mp3: ['audio/mpeg'],
+        };
+        mimeType.m4a = mimeType.mp4;
+        mimeType.mpeg = mimeType.mp3;
+        super('audio', mimeType, options);
+    }
+    /**
+     * The underlying `<audio>` element managed by the loader.
+     * @returns {HTMLAudioElement|null} The underlying `<audio>` element, or `null` before the load starts.
+     */
+    get audio() {
+        return this.media;
+    }
+}
+export default TinyAudioLoader;