tiny-essentials 1.28.4 → 1.28.6

package/dist/v1/libs/TinyMediaPlayer/index.d.mts

@@ -0,0 +1,162 @@
+import { EventEmitter } from 'events';
+export type PictureDataType = import('../../basics/mediaContent.mjs').PictureDataType;
+export type MediaContent = import('../../basics/mediaContent.mjs').MediaContent<PictureDataType>;
+export type ContentTimeData = {
+    /**
+     * - The total duration of the media in milliseconds.
+     */
+    total: number;
+    /**
+     * - The current playback position in milliseconds.
+     */
+    current: number;
+    /**
+     * - The remaining time until the media ends in milliseconds.
+     */
+    remaining: number;
+    /**
+     * - The percentage of the media that has been played (0 to 100).
+     */
+    playbackPercentage: number;
+};
+export type ContentData = {
+    /**
+     * - The unique identifier for the content.
+     */
+    id: string;
+    /**
+     * - The timestamp indicating when the content was created.
+     */
+    createdAt: string;
+    /**
+     * - The title of the content.
+     */
+    title: string;
+    /**
+     * - The duration of the content.
+     */
+    duration: number;
+    /**
+     * - The unique identifier for the artist.
+     */
+    artistId: string;
+    /**
+     * - The name of the artist (optional).
+     */
+    artistName?: string;
+    /**
+     * - A brief description of the content (optional).
+     */
+    description?: string;
+    /**
+     * - The URL for the artist's avatar image (optional).
+     */
+    avatar?: string;
+    /**
+     * - The URL to access the content (optional).
+     */
+    url?: string;
+};
+/**
+ * Interface definition for a Media Provider Adapter.
+ * All specific API wrappers must extend and implement this class.
+ * @abstract
+ */
+declare class BaseMediaAdapter extends EventEmitter {
+    #private;
+    constructor();
+    get destroyed(): boolean;
+    /**
+     * Determines if this adapter can play the provided content.
+     * @param {MediaContent} content - The media content to evaluate.
+     * @returns {boolean} True if the adapter can handle the content, false otherwise.
+     */
+    static canHandle(content: MediaContent): boolean;
+    /**
+     * Synchronously checks whether the media adapter is fully initialized and ready.
+     * @returns {boolean} True if the adapter is ready, false otherwise.
+     */
+    isReady(): boolean;
+    /**
+     * Asynchronously waits until the content media adapter is fully initialized and ready.
+     * @returns {Promise<void>} A promise that resolves once the adapter is ready.
+     */
+    waitIsReady(): Promise<void>;
+    /**
+     * Determines if this adapter can play the provided content.
+     * @param {MediaContent} content - The media content to evaluate.
+     * @returns {boolean} True if the adapter can handle the content, false otherwise.
+     */
+    canHandle(content: MediaContent): boolean;
+    /**
+     * Starts or resumes playback of the provided content.
+     * @param {MediaContent} content - The media content to play.
+     * @returns {Promise<void>}
+     */
+    play(content: MediaContent): Promise<void>;
+    /**
+     * Pauses the current playback.
+     * @returns {Promise<void>}
+     */
+    pause(): Promise<void>;
+    /**
+     * Stops the playback completely and resets the internal platform state.
+     * @returns {Promise<void>}
+     */
+    stop(): Promise<void>;
+    /**
+     * Seeks to a specific time in the media timeline.
+     * @param {number} timeMs - The target time in milliseconds.
+     * @returns {Promise<void>}
+     */
+    seek(timeMs: number): Promise<void>;
+    /**
+     * Retrieves the current playback time from the underlying API.
+     * @returns {number} The current time in milliseconds.
+     */
+    getCurrentTime(): number;
+    /**
+     * Gets the total duration of the content.
+     * @returns {number} The total duration in milliseconds.
+     */
+    getTotalDuration(): number;
+    /**
+     * Gets the remaining time until the content ends.
+     * @returns {number} The remaining time in milliseconds.
+     */
+    getRemainingTime(): number;
+    /**
+     * Gets the percentage of the content that has been played.
+     * @returns {number} The percentage from 0 to 100.
+     */
+    getPlaybackPercentage(): number;
+    /**
+     * Retrieves a consolidated object containing all time-related metrics for the current media content.
+     * @returns {ContentTimeData} An object containing total, current, remaining time, and playback percentage.
+     */
+    getTimeData(): ContentTimeData;
+    /**
+     * Sets the playback volume for the underlying API.
+     * @param {number} volume - The volume level from 0.0 to 1.0.
+     * @returns {void}
+     */
+    setVolume(volume: number): void;
+    /**
+     * Gets the playback volume for the underlying API.
+     * @returns {number} - The volume level from 0.0 to 1.0.
+     */
+    getVolume(): number;
+    /**
+     * Retrieves the metadata of the currently loaded content, returning a structured
+     * object containing details such as the content ID, title, author, and duration.
+     * @returns {Promise<ContentData>}
+     */
+    getContentData(): Promise<ContentData>;
+    /**
+     * Cleans up the instance.
+     * @returns {void}
+     */
+    destroy(): void;
+}
+export { BaseMediaAdapter };
+//# sourceMappingURL=index.d.mts.map

package/dist/v1/libs/TinyMediaPlayer/index.mjs

@@ -0,0 +1,190 @@
+import { EventEmitter } from 'events';
+import { createCheckDestroyed } from '../utils.mjs';
+/**
+ * @typedef {import('../../basics/mediaContent.mjs').PictureDataType} PictureDataType
+ * @typedef {import('../../basics/mediaContent.mjs').MediaContent<PictureDataType>} MediaContent
+ */
+/**
+ * @typedef {Object} ContentTimeData
+ * @property {number} total - The total duration of the media in milliseconds.
+ * @property {number} current - The current playback position in milliseconds.
+ * @property {number} remaining - The remaining time until the media ends in milliseconds.
+ * @property {number} playbackPercentage - The percentage of the media that has been played (0 to 100).
+ */
+/**
+ * Represents the data structure for a piece of content.
+ * @typedef {Object} ContentData
+ * @property {string} id - The unique identifier for the content.
+ * @property {string} createdAt - The timestamp indicating when the content was created.
+ * @property {string} title - The title of the content.
+ * @property {number} duration - The duration of the content.
+ * @property {string} artistId - The unique identifier for the artist.
+ * @property {string} [artistName] - The name of the artist (optional).
+ * @property {string} [description] - A brief description of the content (optional).
+ * @property {string} [avatar] - The URL for the artist's avatar image (optional).
+ * @property {string} [url] - The URL to access the content (optional).
+ */
+const checkDestroy = createCheckDestroyed('BaseMediaAdapter');
+/**
+ * Interface definition for a Media Provider Adapter.
+ * All specific API wrappers must extend and implement this class.
+ * @abstract
+ */
+class BaseMediaAdapter extends EventEmitter {
+    constructor() {
+        if (new.target === BaseMediaAdapter) {
+            throw new Error('BaseMediaAdapter is an abstract class and cannot be instantiated directly.');
+        }
+        super();
+    }
+    /** @type {boolean} */
+    #destroyed = false;
+    get destroyed() {
+        return this.#destroyed;
+    }
+    /**
+     * Determines if this adapter can play the provided content.
+     * @param {MediaContent} content - The media content to evaluate.
+     * @returns {boolean} True if the adapter can handle the content, false otherwise.
+     */
+    static canHandle(content) {
+        throw new Error('Method "canHandle" must be implemented by the subclass.');
+    }
+    /**
+     * Synchronously checks whether the media adapter is fully initialized and ready.
+     * @returns {boolean} True if the adapter is ready, false otherwise.
+     */
+    isReady() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "isReady" must be implemented by the subclass.');
+    }
+    /**
+     * Asynchronously waits until the content media adapter is fully initialized and ready.
+     * @returns {Promise<void>} A promise that resolves once the adapter is ready.
+     */
+    async waitIsReady() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "waitIsReady" must be implemented by the subclass.');
+    }
+    /**
+     * Determines if this adapter can play the provided content.
+     * @param {MediaContent} content - The media content to evaluate.
+     * @returns {boolean} True if the adapter can handle the content, false otherwise.
+     */
+    canHandle(content) {
+        checkDestroy(this.#destroyed);
+        return BaseMediaAdapter.canHandle(content);
+    }
+    /**
+     * Starts or resumes playback of the provided content.
+     * @param {MediaContent} content - The media content to play.
+     * @returns {Promise<void>}
+     */
+    async play(content) {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "play" must be implemented by the subclass.');
+    }
+    /**
+     * Pauses the current playback.
+     * @returns {Promise<void>}
+     */
+    async pause() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "pause" must be implemented by the subclass.');
+    }
+    /**
+     * Stops the playback completely and resets the internal platform state.
+     * @returns {Promise<void>}
+     */
+    async stop() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "stop" must be implemented by the subclass.');
+    }
+    /**
+     * Seeks to a specific time in the media timeline.
+     * @param {number} timeMs - The target time in milliseconds.
+     * @returns {Promise<void>}
+     */
+    async seek(timeMs) {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "seek" must be implemented by the subclass.');
+    }
+    /**
+     * Retrieves the current playback time from the underlying API.
+     * @returns {number} The current time in milliseconds.
+     */
+    getCurrentTime() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getCurrentTime" must be implemented by the subclass.');
+    }
+    /**
+     * Gets the total duration of the content.
+     * @returns {number} The total duration in milliseconds.
+     */
+    getTotalDuration() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getTotalDuration" must be implemented by the subclass.');
+    }
+    /**
+     * Gets the remaining time until the content ends.
+     * @returns {number} The remaining time in milliseconds.
+     */
+    getRemainingTime() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getRemainingTime" must be implemented by the subclass.');
+    }
+    /**
+     * Gets the percentage of the content that has been played.
+     * @returns {number} The percentage from 0 to 100.
+     */
+    getPlaybackPercentage() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getPlaybackPercentage" must be implemented by the subclass.');
+    }
+    /**
+     * Retrieves a consolidated object containing all time-related metrics for the current media content.
+     * @returns {ContentTimeData} An object containing total, current, remaining time, and playback percentage.
+     */
+    getTimeData() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getTimeData" must be implemented by the subclass.');
+    }
+    /**
+     * Sets the playback volume for the underlying API.
+     * @param {number} volume - The volume level from 0.0 to 1.0.
+     * @returns {void}
+     */
+    setVolume(volume) {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "setVolume" must be implemented by the subclass.');
+    }
+    /**
+     * Gets the playback volume for the underlying API.
+     * @returns {number} - The volume level from 0.0 to 1.0.
+     */
+    getVolume() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getVolume" must be implemented by the subclass.');
+    }
+    /**
+     * Retrieves the metadata of the currently loaded content, returning a structured
+     * object containing details such as the content ID, title, author, and duration.
+     * @returns {Promise<ContentData>}
+     */
+    async getContentData() {
+        checkDestroy(this.#destroyed);
+        throw new Error('Method "getContentData" must be implemented by the subclass.');
+    }
+    /**
+     * Cleans up the instance.
+     * @returns {void}
+     */
+    destroy() {
+        if (this.#destroyed)
+            return;
+        this.removeAllListeners();
+        this.#destroyed = true;
+        this.emit('destroyed');
+    }
+}
+export { BaseMediaAdapter };