audio-channel-queue 1.4.0 → 1.5.0

package/src/utils.ts

@@ -0,0 +1,109 @@
+/**
+ * @fileoverview Utility functions for the audio-channel-queue package
+ */
+
+import { AudioInfo, QueueSnapshot, ExtendedAudioQueueChannel, QueueItem } from './types';
+
+/**
+ * Extracts the filename from a URL string
+ * @param url - The URL to extract the filename from
+ * @returns The extracted filename or 'unknown' if extraction fails
+ * @example
+ * ```typescript
+ * extractFileName('https://example.com/audio/song.mp3') // Returns: 'song.mp3'
+ * extractFileName('/path/to/audio.wav') // Returns: 'audio.wav'
+ * ```
+ */
+export const extractFileName = (url: string): string => {
+  try {
+    const urlObj: URL = new URL(url);
+    const pathname: string = urlObj.pathname;
+    const segments: string[] = pathname.split('/');
+    const fileName: string = segments[segments.length - 1];
+    return fileName || 'unknown';
+  } catch {
+    // If URL parsing fails, try simple string manipulation
+    const segments: string[] = url.split('/');
+    const fileName: string = segments[segments.length - 1];
+    return fileName || 'unknown';
+  }
+};
+
+/**
+ * Extracts comprehensive audio information from an HTMLAudioElement
+ * @param audio - The HTML audio element to extract information from
+ * @returns AudioInfo object with current playback state or null if audio is invalid
+ * @example
+ * ```typescript
+ * const audioElement = new Audio('song.mp3');
+ * const info = getAudioInfoFromElement(audioElement);
+ * console.log(info?.progress); // Current progress as decimal (0-1)
+ * ```
+ */
+export const getAudioInfoFromElement = (audio: HTMLAudioElement): AudioInfo | null => {
+  if (!audio) return null;
+
+  const duration: number = isNaN(audio.duration) ? 0 : audio.duration * 1000; // Convert to milliseconds
+  const currentTime: number = isNaN(audio.currentTime) ? 0 : audio.currentTime * 1000; // Convert to milliseconds
+  const progress: number = duration > 0 ? Math.min(currentTime / duration, 1) : 0;
+  const isPlaying: boolean = !audio.paused && !audio.ended && audio.readyState > 2;
+
+  return {
+    currentTime,
+    duration,
+    fileName: extractFileName(audio.src),
+    isPlaying,
+    progress,
+    src: audio.src
+  };
+};
+
+/**
+ * Creates a complete snapshot of a queue's current state
+ * @param channelNumber - The channel number to create a snapshot for
+ * @param audioChannels - Array of audio channels
+ * @returns QueueSnapshot object or null if channel doesn't exist
+ * @example
+ * ```typescript
+ * const snapshot = createQueueSnapshot(0, audioChannels);
+ * console.log(`Queue has ${snapshot?.totalItems} items`);
+ * ```
+ */
+export const createQueueSnapshot = (
+  channelNumber: number, 
+  audioChannels: ExtendedAudioQueueChannel[]
+): QueueSnapshot | null => {
+  const channel: ExtendedAudioQueueChannel = audioChannels[channelNumber];
+  if (!channel) return null;
+
+  const items: QueueItem[] = channel.queue.map((audio: HTMLAudioElement, index: number) => ({
+    duration: isNaN(audio.duration) ? 0 : audio.duration * 1000,
+    fileName: extractFileName(audio.src),
+    isCurrentlyPlaying: index === 0 && !audio.paused && !audio.ended,
+    src: audio.src
+  }));
+
+  return {
+    channelNumber,
+    currentIndex: 0, // Current playing is always index 0 in our queue structure
+    items,
+    totalItems: channel.queue.length
+  };
+};
+
+/**
+ * Removes webpack hash patterns from filenames to get clean, readable names
+ * @param fileName - The filename that may contain webpack hashes
+ * @returns The cleaned filename with webpack hashes removed
+ * @example
+ * ```typescript
+ * cleanWebpackFilename('song.a1b2c3d4.mp3') // Returns: 'song.mp3'
+ * cleanWebpackFilename('notification.1a2b3c4d5e6f7890.wav') // Returns: 'notification.wav'
+ * cleanWebpackFilename('music.12345678.ogg') // Returns: 'music.ogg'
+ * cleanWebpackFilename('clean-file.mp3') // Returns: 'clean-file.mp3' (unchanged)
+ * ```
+ */
+export const cleanWebpackFilename = (fileName: string): string => {
+  // Remove webpack hash pattern: filename.hash.ext → filename.ext
+  return fileName.replace(/\.[a-f0-9]{8,}\./i, '.');
+}; 

package/dist/audio.d.ts

@@ -1,10 +0,0 @@
-export type AudioQueue = HTMLAudioElement[];
-export type AudioQueueChannel = {
-    queue: AudioQueue;
-};
-export declare const audioChannels: AudioQueueChannel[];
-export declare const queueAudio: (audioUrl: string, channelNumber?: number) => Promise<void>;
-export declare const playAudioQueue: (channelNumber: number) => Promise<void>;
-export declare const stopCurrentAudioInChannel: (channelNumber?: number) => void;
-export declare const stopAllAudioInChannel: (channelNumber?: number) => void;
-export declare const stopAllAudio: () => void;

package/dist/audio.js

@@ -1,66 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stopAllAudio = exports.stopAllAudioInChannel = exports.stopCurrentAudioInChannel = exports.playAudioQueue = exports.queueAudio = exports.audioChannels = void 0;
-exports.audioChannels = [];
-const queueAudio = (audioUrl_1, ...args_1) => __awaiter(void 0, [audioUrl_1, ...args_1], void 0, function* (audioUrl, channelNumber = 0) {
-    if (!exports.audioChannels[channelNumber]) {
-        exports.audioChannels[channelNumber] = { queue: [] };
-    }
-    const audio = new Audio(audioUrl);
-    exports.audioChannels[channelNumber].queue.push(audio);
-    if (exports.audioChannels[channelNumber].queue.length === 1) {
-        return (0, exports.playAudioQueue)(channelNumber);
-    }
-});
-exports.queueAudio = queueAudio;
-const playAudioQueue = (channelNumber) => __awaiter(void 0, void 0, void 0, function* () {
-    const channel = exports.audioChannels[channelNumber];
-    if (channel.queue.length === 0)
-        return;
-    const currentAudio = channel.queue[0];
-    return new Promise((resolve) => {
-        currentAudio.addEventListener('ended', () => __awaiter(void 0, void 0, void 0, function* () {
-            channel.queue.shift();
-            yield (0, exports.playAudioQueue)(channelNumber);
-            resolve();
-        }));
-        currentAudio.play();
-    });
-});
-exports.playAudioQueue = playAudioQueue;
-const stopCurrentAudioInChannel = (channelNumber = 0) => {
-    const channel = exports.audioChannels[channelNumber];
-    if (channel && channel.queue.length > 0) {
-        const currentAudio = channel.queue[0];
-        currentAudio.pause();
-        channel.queue.shift();
-        (0, exports.playAudioQueue)(channelNumber);
-    }
-};
-exports.stopCurrentAudioInChannel = stopCurrentAudioInChannel;
-const stopAllAudioInChannel = (channelNumber = 0) => {
-    const channel = exports.audioChannels[channelNumber];
-    if (channel) {
-        if (channel.queue.length > 0) {
-            const currentAudio = channel.queue[0];
-            currentAudio.pause();
-        }
-        channel.queue = [];
-    }
-};
-exports.stopAllAudioInChannel = stopAllAudioInChannel;
-const stopAllAudio = () => {
-    exports.audioChannels.forEach((_channel, index) => {
-        (0, exports.stopAllAudioInChannel)(index);
-    });
-};
-exports.stopAllAudio = stopAllAudio;