tiny-essentials 1.28.5 → 1.28.6

package/dist/v1/libs/TinyMediaPlayer.mjs

@@ -14,6 +14,7 @@ const checkDestroy = createCheckDestroyed('TinyMediaPlayer');
  * @typedef {import('../basics/mediaContent.mjs').MediaLoadingErrorData} MediaLoadingErrorData
  * @typedef {import('../basics/mediaContent.mjs').UnknownArtistGetter} UnknownArtistGetter
  * @typedef {import('./TinyMediaPlayer/index.mjs').ContentTimeData} ContentTimeData
+ * @typedef {import('./TinyMediaPlayer/index.mjs').ContentData} ContentData
  */
 /**
  * The loop configuration modes.
@@ -1223,6 +1224,43 @@ class TinyMediaPlayer extends EventEmitter {
             return 0;
         }
     }
+    /**
+     * 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);
+        const defaultData = {
+            id: '',
+            createdAt: '',
+            artistId: '',
+            artistName: '',
+            description: '',
+            title: '',
+            duration: 0,
+            avatar: '',
+            url: '',
+        };
+        try {
+            const adapter = this.#getActiveAdapter();
+            return adapter ? adapter.getContentData() : defaultData;
+        }
+        catch {
+            return defaultData;
+        }
+    }
+    /**
+     * 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);
+        const adapter = this.#getActiveAdapter();
+        if (!adapter)
+            return;
+        return adapter.waitIsReady();
+    }
     // ==========================================
     // DESTROYER
     // ==========================================

package/docs/v1/libs/TinyMediaPlayer.md

@@ -9,17 +9,29 @@
 To support different media platforms, `TinyMediaPlayer` relies on **Adapters**. You must create a class that extends `BaseMediaAdapter` for every new service you wish to support.
 
 ### 🛠️ `BaseMediaAdapter` (Abstract Class)
-*This class cannot be instantiated directly. It serves as an interface.*
+*This class cannot be instantiated directly. It serves as an interface that all specific API wrappers must extend and implement.*
 
+#### Properties
+| Property | Type | Description |
+| :--- | :--- | :--- |
+| `destroyed` | `boolean` | Indicates if the adapter instance has been destroyed. |
+
+#### Methods
 | Method | Description | Parameters | Returns |
 | :--- | :--- | :--- | :--- |
-| `canHandle` | Checks if the adapter supports a specific content item. | `content: MediaContent` | `boolean` |
-| `play` | Starts or resumes playback. | `content: MediaContent` | `Promise<void>` |
+| `canHandle` | Determines if the adapter can play the provided content. | `content: MediaContent` | `boolean` |
+| `play` | Starts or resumes playback of the provided content. | `content: MediaContent` | `Promise<void>` |
 | `pause` | Pauses the current playback. | None | `Promise<void>` |
-| `stop` | Stops playback and resets the platform state. | None | `Promise<void>` |
-| `seek` | Jumps to a specific time. | `timeMs: number` | `Promise<void>` |
-| `getCurrentTime` | Gets the current playback position. | None | `number` (ms) |
-| `setVolume` | Sets the volume level. | `volume: number` (0.0 to 1.0) | `void` |
+| `stop` | Stops the playback completely and resets the platform state. | None | `Promise<void>` |
+| `seek` | Seeks to a specific time in the media timeline. | `timeMs: number` | `Promise<void>` |
+| `getCurrentTime` | Retrieves the current playback position. | None | `number` (ms) |
+| `getTotalDuration` | Gets the total duration of the content. | None | `number` (ms) |
+| `getRemainingTime` | Gets the remaining time until the content ends. | None | `number` (ms) |
+| `getPlaybackPercentage` | Gets the percentage of the content that has been played. | None | `number` (0 to 100) |
+| `getTimeData` | Retrieves a consolidated object containing all time-related metrics. | None | `ContentTimeData` |
+| `setVolume` | Sets the playback volume for the underlying API. | `volume: number` (0.0 to 1.0) | `void` |
+| `getVolume` | Gets the current playback volume. | None | `number` (0.0 to 1.0) |
+| `destroy` | Cleans up the instance, removes listeners, and marks it as destroyed. | None | `void` |
 
 ---
 
@@ -31,7 +43,8 @@ You can integrate `TinyMediaPlayer` into your project using two methods: using t
 The library provides several optimized adapters for common media sources. You can import them and register them directly with your player instance.
 
 **Available Adapters:**
-* `YoutubeMediaAdapter` from `tiny-essentials/libs/TinyMediaPlayer/Youtube`
+* `YoutubeMediaAdapter` from `tiny-essentials/libs/TinyMediaPlayer/Youtube` (https://www.youtube.com/watch?v=XXXXXXXXXXX)
+* `SoundCloudMediaAdapter` from `tiny-essentials/libs/TinyMediaPlayer/SoundCloud` (https://api.soundcloud.com/tracks/XXXXXXXXX (From SoundCloud Embed))
 * `HtmlAudioAdapter` from `tiny-essentials/libs/TinyMediaPlayer/HtmlAudio`
 * `HtmlVideoAdapter` from `tiny-essentials/libs/TinyMediaPlayer/HtmlVideo`
 
@@ -76,10 +89,19 @@ class MyCustomServiceAdapter extends BaseMediaAdapter {
    * @param {MediaContent} content - The media content to check.
    * @returns {boolean} - True if the URL matches the service.
    */
-  canHandle(content) {
+  static canHandle(content) {
     return content.url.startsWith('https://example.com/');
   }
 
+  /**
+   * Determines if this adapter can play the given content.
+   * @param {MediaContent} content - The media content to check.
+   * @returns {boolean} - True if the URL matches the service.
+   */
+  canHandle(content) {
+    return MyCustomServiceAdapter.canHandle(content);
+  }
+
   /**
    * Starts playback for the provided content.
    * @param {MediaContent} content - The content to play.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.28.5",
+  "version": "1.28.6",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "bin": {
     "tiny-essentials-fork": "./TinyFork.mjs"
@@ -108,6 +108,10 @@
       "require": "./dist/v1/basics/text.cjs",
       "import": "./dist/v1/basics/text.mjs"
     },
+    "./basics/promiseUtils": {
+      "require": "./dist/v1/basics/promiseUtils.cjs",
+      "import": "./dist/v1/basics/promiseUtils.mjs"
+    },
     "./fileManager": {
       "require": "./dist/v1/fileManager/index.cjs",
       "import": "./dist/v1/fileManager/index.mjs"
@@ -140,6 +144,10 @@
       "require": "./dist/v1/libs/TinyMediaPlayer/Youtube.cjs",
       "import": "./dist/v1/libs/TinyMediaPlayer/Youtube.mjs"
     },
+    "./libs/TinyMediaPlayer/SoundCloud": {
+      "require": "./dist/v1/libs/TinyMediaPlayer/SoundCloud.cjs",
+      "import": "./dist/v1/libs/TinyMediaPlayer/SoundCloud.mjs"
+    },
     "./libs/TinyMediaPlayer/HtmlAudio": {
       "require": "./dist/v1/libs/TinyMediaPlayer/HtmlAudio.cjs",
       "import": "./dist/v1/libs/TinyMediaPlayer/HtmlAudio.mjs"
@@ -503,23 +511,16 @@
   },
   "keywords": [
     "tiny-essentials",
-    "timeout",
+    "utility-library",
     "storage",
     "text-editor",
     "color-converter",
     "clock",
     "time",
-    "text",
-    "text-range",
-    "input-editor",
-    "string-utils",
     "string-manipulation",
     "obj-type",
     "type-checker",
-    "simple-math",
-    "math-utils",
     "shuffle-array",
-    "array-utils",
     "json",
     "json-utils",
     "json-color",
@@ -536,7 +537,47 @@
     "toolkit",
     "frontend-utils",
     "backend-utils",
-    "nodejs-utils"
+    "nodejs-utils",
+    "array-utils",
+    "object-utils",
+    "string-utils",
+    "math-utils",
+    "dom-utils",
+    "html-utils",
+    "css-utils",
+    "modular-scripts",
+    "type-validation",
+    "text-manipulation",
+    "text-formatting",
+    "color-management",
+    "color-conversion",
+    "color-validation",
+    "drag-and-drop",
+    "scroll-management",
+    "clipboard-management",
+    "notifications",
+    "toast-notifications",
+    "loading-screen",
+    "cookie-consent",
+    "i18n",
+    "iframe-communication",
+    "window-communication",
+    "media-playback",
+    "audio-processing",
+    "gamepad-api",
+    "input-handling",
+    "file-upload",
+    "inventory-management",
+    "level-up-system",
+    "raffle-system",
+    "day-night-cycle",
+    "rate-limiting",
+    "promise-queue",
+    "file-management",
+    "terminal-ui",
+    "json-formatting",
+    "fuzzy-logic",
+    "text-range-editor"
   ],
   "author": "Yasmin Seidel (Jasmin Dreasond)",
   "license": "LGPL-3.0-only",