ziplayer 0.1.4 → 0.1.5

package/src/structures/PlayerManager.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from "events";
 import { Player } from "./Player";
-import { PlayerManagerOptions, PlayerOptions, Track, SourcePlugin, SearchResult } from "../types";
+import { PlayerManagerOptions, PlayerOptions, Track, SourcePlugin, SearchResult, ManagerEvents } from "../types";
 import type { BaseExtension } from "../extensions";
 import { withTimeout } from "../utils/timeout";
 
@@ -25,6 +25,11 @@ const setGlobalManager = (instance: PlayerManager): void => {
 	}
 };
 
+export declare interface PlayerManager {
+	on<K extends keyof ManagerEvents>(event: K, listener: (...args: ManagerEvents[K]) => void): this;
+	emit<K extends keyof ManagerEvents>(event: K, ...args: ManagerEvents[K]): boolean;
+}
+
 /**
  * The main class for managing players across multiple Discord guilds.
  *
@@ -212,18 +217,18 @@ export class PlayerManager extends EventEmitter {
 		}
 
 		// Forward all player events
-		player.on("willPlay", (track, tracks) => this.emit("willPlay", player, track, tracks));
-		player.on("trackStart", (track) => this.emit("trackStart", player, track));
-		player.on("trackEnd", (track) => this.emit("trackEnd", player, track));
+		player.on("willPlay", (track, tracks) => this.emit("willPlay", player, track as Track, tracks as Track[]));
+		player.on("trackStart", (track) => this.emit("trackStart", player, track as Track));
+		player.on("trackEnd", (track) => this.emit("trackEnd", player, track as Track));
 		player.on("queueEnd", () => this.emit("queueEnd", player));
-		player.on("playerError", (error, track) => this.emit("playerError", player, error, track));
+		player.on("playerError", (error, track) => this.emit("playerError", player, error, track as Track));
 		player.on("connectionError", (error) => this.emit("connectionError", player, error));
-		player.on("volumeChange", (old, volume) => this.emit("volumeChange", player, old, volume));
-		player.on("queueAdd", (track) => this.emit("queueAdd", player, track));
-		player.on("queueAddList", (tracks) => this.emit("queueAddList", player, tracks));
-		player.on("queueRemove", (track, index) => this.emit("queueRemove", player, track, index));
-		player.on("playerPause", (track) => this.emit("playerPause", player, track));
-		player.on("playerResume", (track) => this.emit("playerResume", player, track));
+		player.on("volumeChange", (old, volume) => this.emit("volumeChange", player, old as number, volume as number));
+		player.on("queueAdd", (track) => this.emit("queueAdd", player, track as Track));
+		player.on("queueAddList", (tracks) => this.emit("queueAddList", player, tracks as Track[]));
+		player.on("queueRemove", (track, index) => this.emit("queueRemove", player, track as Track, index));
+		player.on("playerPause", (track) => this.emit("playerPause", player, track as Track));
+		player.on("playerResume", (track) => this.emit("playerResume", player, track as Track));
 		player.on("playerStop", () => this.emit("playerStop", player));
 		player.on("playerDestroy", () => {
 			this.emit("playerDestroy", player);

package/src/types/index.ts

@@ -232,6 +232,27 @@ export interface ProgressBarOptions {
 	progressChar?: string;
 }
 
+/**
+ * Options for saving tracks
+ *
+ * @example
+ * const options: SaveOptions = {
+ *   filename: "my-song.mp3",
+ *   quality: "high",
+ *   timeout: 30000
+ * };
+ */
+export interface SaveOptions {
+	/** Optional filename for the saved file */
+	filename?: string;
+	/** Quality of the saved audio ("high" | "low") */
+	quality?: "high" | "low";
+	/** Timeout in milliseconds for the save operation */
+	timeout?: number;
+	/** Additional metadata to include */
+	metadata?: Record<string, any>;
+}
+
 export type LoopMode = "off" | "track" | "queue";
 
 /**
@@ -332,70 +353,89 @@ export interface ExtensionSearchRequest {
  *
  * @example
  *
- * player.on("willPlay", (player, track) => {
+ * manager.on("willPlay", (player, track) => {
  *   console.log(`Up next: ${track.title}`);
  * });
  *
- * player.on("trackEnd", (player, track) => {
+ * manager.on("trackEnd", (player, track) => {
  *   console.log(`Now playing: ${track.title}`);
  * });
  *
- * player.on("queueAdd", (player, track) => {
+ * manager.on("queueAdd", (player, track) => {
  *   console.log(`Queue added: ${track.title}`);
  * });
  *
- * player.on("queueAddList", (player, tracks) => {
+ * manager.on("queueAddList", (player, tracks) => {
  *   console.log(`Queue added: ${tracks.length} tracks`);
  * });
  *
- * player.on("queueRemove", (player, track, index) => {
+ * manager.on("queueRemove", (player, track, index) => {
  *   console.log(`Queue removed: ${track.title} at index ${index}`);
  * });
  *
- * player.on("playerPause", (player, track) => {
+ * manager.on("playerPause", (player, track) => {
  *   console.log(`Player paused: ${track.title}`);
  * });
  *
- * player.on("playerResume", (player, track) => {
+ * manager.on("playerResume", (player, track) => {
  *   console.log(`Player resumed: ${track.title}`);
  * });
  *
- * player.on("playerStop", (player) => {
+ * manager.on("playerStop", (player) => {
  *   console.log("Player stopped");
  * });
  *
- * player.on("playerDestroy", (player) => {
+ * manager.on("playerDestroy", (player) => {
  *   console.log("Player destroyed");
  * });
  *
- * player.on("ttsStart", (player, payload) => {
+ * manager.on("ttsStart", (player, payload) => {
  *   console.log(`TTS started: ${payload.text}`);
  * });
  *
- * player.on("ttsEnd", (player) => {
+ * manager.on("ttsEnd", (player) => {
  *   console.log("TTS ended");
  * });
  *
- * player.on("playerError", (player, error, track) => {
+ * manager.on("playerError", (player, error, track) => {
  *   console.log(`Player error: ${error.message}`);
  * });
  *
- * player.on("connectionError", (player, error) => {
+ * manager.on("connectionError", (player, error) => {
  *   console.log(`Connection error: ${error.message}`);
  * });
- * player.on("trackStart", (player, track) => {
+ * manager.on("trackStart", (player, track) => {
  *   console.log(`Track started: ${track.title}`);
  * });
  *
- * player.on("volumeChange", (player, oldVolume, newVolume) => {
+ * manager.on("volumeChange", (player, oldVolume, newVolume) => {
  *   console.log(`Volume changed: ${oldVolume} -> ${newVolume}`);
  * });
  *
- * player.on("queueEnd", (player) => {
+ * manager.on("queueEnd", (player) => {
  *   console.log("Queue finished");
  * });
  *
  */
+export interface ManagerEvents {
+	debug: [message: string, ...args: any[]];
+	willPlay: [player: Player, track: Track, upcomingTracks: Track[]];
+	trackStart: [player: Player, track: Track];
+	trackEnd: [player: Player, track: Track];
+	queueEnd: [player: Player];
+	playerError: [player: Player, error: Error, track?: Track];
+	connectionError: [player: Player, error: Error];
+	volumeChange: [player: Player, oldVolume: number, newVolume: number];
+	queueAdd: [player: Player, track: Track];
+	queueAddList: [player: Player, tracks: Track[]];
+	queueRemove: [player: Player, track: Track, index: number];
+	playerPause: [player: Player, track: Track];
+	playerResume: [player: Player, track: Track];
+	playerStop: [player: Player];
+	playerDestroy: [player: Player];
+	ttsStart: [player: Player, payload: { text?: string; track?: Track }];
+	ttsEnd: [player: Player];
+}
 export interface PlayerEvents {
 	debug: [message: string, ...args: any[]];
 	willPlay: [track: Track, upcomingTracks: Track[]];