@ziplayer/plugin 0.1.33 → 0.1.41

package/src/index.ts

@@ -1,103 +1,103 @@
-/**
- * @fileoverview Main export file for ZiPlayer plugins.
- *
- * This module exports all available plugins for the ZiPlayer music bot framework.
- * Each plugin provides support for different audio sources and services.
- *
- * @example
- * import { YouTubePlugin, SoundCloudPlugin, SpotifyPlugin, TTSPlugin } from "ziplayer/plugins";
- *
- * const manager = new PlayerManager({
- *   plugins: [
- *     new YouTubePlugin(),
- *     new SoundCloudPlugin(),
- *     new SpotifyPlugin(),
- *     new TTSPlugin({ defaultLang: "en" })
- *   ]
- * });
- *
- * @since 1.0.0
- */
-
-/**
- * YouTube plugin for handling YouTube videos, playlists, and search.
- *
- * Provides comprehensive support for YouTube content including:
- * - Video URLs (youtube.com, youtu.be, music.youtube.com)
- * - Playlist URLs and dynamic mixes
- * - Search functionality
- * - Audio stream extraction
- * - Related track recommendations
- *
- * @example
- * const youtubePlugin = new YouTubePlugin();
- * const result = await youtubePlugin.search("Never Gonna Give You Up", "user123");
- */
-export { YouTubePlugin } from "./YouTubePlugin";
-
-/**
- * SoundCloud plugin for handling SoundCloud tracks, playlists, and search.
- *
- * Provides comprehensive support for SoundCloud content including:
- * - Track URLs (soundcloud.com)
- * - Playlist URLs
- * - Search functionality
- * - Audio stream extraction
- * - Related track recommendations
- *
- * @example
- * const soundcloudPlugin = new SoundCloudPlugin();
- * const result = await soundcloudPlugin.search("chill music", "user123");
- */
-export { SoundCloudPlugin } from "./SoundCloudPlugin";
-
-/**
- * Spotify plugin for metadata extraction and display purposes.
- *
- * **Note:** This plugin only provides metadata extraction and does not support
- * audio streaming. It uses Spotify's public oEmbed endpoint for display purposes.
- *
- * Provides support for:
- * - Track URLs/URIs (spotify:track:...)
- * - Playlist URLs/URIs (spotify:playlist:...)
- * - Album URLs/URIs (spotify:album:...)
- * - Metadata extraction using oEmbed API
- *
- * @example
- * const spotifyPlugin = new SpotifyPlugin();
- * const result = await spotifyPlugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
- */
-export { SpotifyPlugin } from "./SpotifyPlugin";
-
-/**
- * Text-to-Speech (TTS) plugin for converting text to audio.
- *
- * Provides comprehensive TTS functionality including:
- * - Google TTS integration
- * - Custom TTS provider support
- * - Multiple language support
- * - Configurable speech rate
- * - Flexible query parsing
- *
- * @example
- * const ttsPlugin = new TTSPlugin({ defaultLang: "en" });
- * const result = await ttsPlugin.search("tts:Hello world", "user123");
- */
-export { TTSPlugin } from "./TTSPlugin";
-
-/**
- * YTSR plugin for advanced YouTube search without streaming.
- *
- * Provides comprehensive YouTube search functionality including:
- * - Advanced video search with filters (duration, upload date, sort by)
- * - Playlist and channel search
- * - Multiple search types (video, playlist, channel, all)
- * - Metadata extraction without streaming
- * - Support for YouTube URLs
- *
- * @example
- * const ytsrPlugin = new YTSRPlugin();
- * const result = await ytsrPlugin.search("Never Gonna Give You Up", "user123");
- * const playlistResult = await ytsrPlugin.searchPlaylist("chill music", "user123");
- */
-export { YTSRPlugin } from "./YTSRPlugin";
+/**
+ * @fileoverview Main export file for ZiPlayer plugins.
+ *
+ * This module exports all available plugins for the ZiPlayer music bot framework.
+ * Each plugin provides support for different audio sources and services.
+ *
+ * @example
+ * import { YouTubePlugin, SoundCloudPlugin, SpotifyPlugin, TTSPlugin } from "ziplayer/plugins";
+ *
+ * const manager = new PlayerManager({
+ *   plugins: [
+ *     new YouTubePlugin(),
+ *     new SoundCloudPlugin(),
+ *     new SpotifyPlugin(),
+ *     new TTSPlugin({ defaultLang: "en" })
+ *   ]
+ * });
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * YouTube plugin for handling YouTube videos, playlists, and search.
+ *
+ * Provides comprehensive support for YouTube content including:
+ * - Video URLs (youtube.com, youtu.be, music.youtube.com)
+ * - Playlist URLs and dynamic mixes
+ * - Search functionality
+ * - Audio stream extraction
+ * - Related track recommendations
+ *
+ * @example
+ * const youtubePlugin = new YouTubePlugin();
+ * const result = await youtubePlugin.search("Never Gonna Give You Up", "user123");
+ */
+export { YouTubePlugin } from "./YouTubePlugin";
+
+/**
+ * SoundCloud plugin for handling SoundCloud tracks, playlists, and search.
+ *
+ * Provides comprehensive support for SoundCloud content including:
+ * - Track URLs (soundcloud.com)
+ * - Playlist URLs
+ * - Search functionality
+ * - Audio stream extraction
+ * - Related track recommendations
+ *
+ * @example
+ * const soundcloudPlugin = new SoundCloudPlugin();
+ * const result = await soundcloudPlugin.search("chill music", "user123");
+ */
+export { SoundCloudPlugin } from "./SoundCloudPlugin";
+
+/**
+ * Spotify plugin for metadata extraction and display purposes.
+ *
+ * **Note:** This plugin only provides metadata extraction and does not support
+ * audio streaming. It uses Spotify's public oEmbed endpoint for display purposes.
+ *
+ * Provides support for:
+ * - Track URLs/URIs (spotify:track:...)
+ * - Playlist URLs/URIs (spotify:playlist:...)
+ * - Album URLs/URIs (spotify:album:...)
+ * - Metadata extraction using oEmbed API
+ *
+ * @example
+ * const spotifyPlugin = new SpotifyPlugin();
+ * const result = await spotifyPlugin.search("spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "user123");
+ */
+export { SpotifyPlugin } from "./SpotifyPlugin";
+
+/**
+ * Text-to-Speech (TTS) plugin for converting text to audio.
+ *
+ * Provides comprehensive TTS functionality including:
+ * - Google TTS integration
+ * - Custom TTS provider support
+ * - Multiple language support
+ * - Configurable speech rate
+ * - Flexible query parsing
+ *
+ * @example
+ * const ttsPlugin = new TTSPlugin({ defaultLang: "en" });
+ * const result = await ttsPlugin.search("tts:Hello world", "user123");
+ */
+export { TTSPlugin } from "./TTSPlugin";
+
+/**
+ * YTSR plugin for advanced YouTube search without streaming.
+ *
+ * Provides comprehensive YouTube search functionality including:
+ * - Advanced video search with filters (duration, upload date, sort by)
+ * - Playlist and channel search
+ * - Multiple search types (video, playlist, channel, all)
+ * - Metadata extraction without streaming
+ * - Support for YouTube URLs
+ *
+ * @example
+ * const ytsrPlugin = new YTSRPlugin();
+ * const result = await ytsrPlugin.search("Never Gonna Give You Up", "user123");
+ * const playlistResult = await ytsrPlugin.searchPlaylist("chill music", "user123");
+ */
+export { YTSRPlugin } from "./YTSRPlugin";

package/src/types/googlevideo.d.ts

@@ -0,0 +1,45 @@
+export interface SabrPlaybackOptions {
+	preferWebM?: boolean;
+	preferOpus?: boolean;
+	videoQuality?: string;
+	audioQuality?: string;
+	enabledTrackTypes?: any;
+}
+
+export interface StreamResult {
+	videoStream: ReadableStream;
+	audioStream: ReadableStream;
+	selectedFormats: {
+		videoFormat: any;
+		audioFormat: any;
+	};
+	videoTitle: string;
+}
+
+declare module "googlevideo/sabr-stream" {
+	export interface SabrPlaybackOptions {
+		preferWebM?: boolean;
+		preferOpus?: boolean;
+		videoQuality?: string;
+		audioQuality?: string;
+		enabledTrackTypes?: any;
+	}
+
+	export interface StreamResult {
+		videoStream: ReadableStream;
+		audioStream: ReadableStream;
+		selectedFormats: {
+			videoFormat: any;
+			audioFormat: any;
+		};
+		videoTitle: string;
+	}
+
+	export function createSabrStream(videoId: string, options: SabrPlaybackOptions): Promise<{ streamResults: StreamResult }>;
+}
+
+declare module "googlevideo/utils" {
+	export enum EnabledTrackTypes {
+		VIDEO_AND_AUDIO = "VIDEO_AND_AUDIO",
+	}
+}

package/src/utils/sabr-stream-factory.ts

@@ -0,0 +1,96 @@
+import { createWriteStream } from "fs";
+import { join } from "path";
+import { tmpdir } from "os";
+
+// Import type declarations
+import type { SabrPlaybackOptions, StreamResult } from "../types/googlevideo";
+
+// Re-export types for external use
+export type { StreamResult, SabrPlaybackOptions };
+
+export interface OutputStream {
+	stream: NodeJS.WritableStream;
+	filePath: string;
+}
+
+/**
+ * Creates a sabr stream for YouTube video download
+ */
+export async function createSabrStream(videoId: string, options: SabrPlaybackOptions): Promise<{ streamResults: StreamResult }> {
+	try {
+		// Dynamic import to avoid build-time errors
+		const sabrModule = require("googlevideo/sabr-stream") as any;
+		const createSabrStreamImpl = sabrModule.createSabrStream;
+
+		const streamResults = await createSabrStreamImpl(videoId, options);
+
+		return { streamResults };
+	} catch (error) {
+		// Fallback implementation if sabr download is not available
+		throw new Error(`Sabr download not available: ${error}`);
+	}
+}
+
+/**
+ * Creates an output stream for writing downloaded content
+ */
+export function createOutputStream(videoTitle: string, mimeType: string): OutputStream {
+	const sanitizedTitle = videoTitle.replace(/[<>:"/\\|?*]/g, "_").substring(0, 100);
+	const extension = getExtensionFromMimeType(mimeType);
+	const fileName = `${sanitizedTitle}.${extension}`;
+	const filePath = join(tmpdir(), fileName);
+
+	const stream = createWriteStream(filePath);
+
+	return {
+		stream,
+		filePath,
+	};
+}
+
+/**
+ * Creates a stream sink for piping data with progress tracking
+ */
+export function createStreamSink(format: any, outputStream: NodeJS.WritableStream, progressBar: any) {
+	return new WritableStream({
+		start() {
+			// Initialize progress tracking
+		},
+		write(chunk) {
+			outputStream.write(chunk);
+			if (progressBar) {
+				progressBar.increment(chunk.length);
+			}
+		},
+		close() {
+			outputStream.end();
+		},
+	});
+}
+
+/**
+ * Gets file extension from MIME type
+ */
+function getExtensionFromMimeType(mimeType: string): string {
+	const mimeMap: { [key: string]: string } = {
+		"audio/mp4": "m4a",
+		"audio/webm": "webm",
+		"audio/ogg": "ogg",
+		"video/mp4": "mp4",
+		"video/webm": "webm",
+		"video/ogg": "ogv",
+	};
+
+	return mimeMap[mimeType] || "bin";
+}
+
+/**
+ * Default sabr playback options
+ */
+export const DEFAULT_SABR_OPTIONS: SabrPlaybackOptions = {
+	preferWebM: true,
+	preferOpus: true,
+	videoQuality: "720p",
+	audioQuality: "AUDIO_QUALITY_MEDIUM",
+	enabledTrackTypes: "VIDEO_AND_AUDIO",
+};

package/src/utils/stream-converter.ts

@@ -0,0 +1,79 @@
+import { Readable } from "stream";
+
+/**
+ * Converts a Web ReadableStream to a Node.js Readable stream
+ */
+export function webStreamToNodeStream(webStream: ReadableStream): Readable {
+	const nodeStream = new Readable({
+		read() {
+			// This will be handled by the Web Stream reader
+		},
+	});
+
+	// Create a reader from the Web Stream
+	const reader = webStream.getReader();
+
+	// Read chunks and push to Node.js stream
+	const pump = async () => {
+		try {
+			while (true) {
+				const { done, value } = await reader.read();
+				if (done) {
+					nodeStream.push(null); // End the stream
+					break;
+				}
+				nodeStream.push(Buffer.from(value));
+			}
+		} catch (error) {
+			nodeStream.destroy(error as Error);
+		}
+	};
+
+	// Start pumping data
+	pump();
+
+	return nodeStream;
+}
+
+/**
+ * Converts a Web ReadableStream to a Node.js Readable stream with progress tracking
+ */
+export function webStreamToNodeStreamWithProgress(
+	webStream: ReadableStream,
+	progressCallback?: (bytesRead: number) => void,
+): Readable {
+	const nodeStream = new Readable({
+		read() {
+			// This will be handled by the Web Stream reader
+		},
+	});
+
+	let bytesRead = 0;
+	const reader = webStream.getReader();
+
+	const pump = async () => {
+		try {
+			while (true) {
+				const { done, value } = await reader.read();
+				if (done) {
+					nodeStream.push(null); // End the stream
+					break;
+				}
+
+				const buffer = Buffer.from(value);
+				nodeStream.push(buffer);
+
+				bytesRead += buffer.length;
+				if (progressCallback) {
+					progressCallback(bytesRead);
+				}
+			}
+		} catch (error) {
+			nodeStream.destroy(error as Error);
+		}
+	};
+
+	pump();
+
+	return nodeStream;
+}

package/tsconfig.json

@@ -1,23 +1,23 @@
-{
-	"compilerOptions": {
-		"target": "ES2020",
-		"module": "commonjs",
-		"lib": ["ES2020"],
-		"outDir": "./dist",
-		"rootDir": "./src",
-		"strict": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"declaration": true,
-		"declarationMap": true,
-		"sourceMap": true,
-		"moduleResolution": "node",
-		"allowSyntheticDefaultImports": true,
-		"experimentalDecorators": true,
-		"emitDecoratorMetadata": true,
-		"resolveJsonModule": true
-	},
-	"include": ["src/*"],
-	"exclude": ["node_modules", "dist", "examples"]
-}
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "commonjs",
+		"lib": ["ES2020"],
+		"outDir": "./dist",
+		"rootDir": "./src",
+		"strict": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"declaration": true,
+		"declarationMap": true,
+		"sourceMap": true,
+		"moduleResolution": "node",
+		"allowSyntheticDefaultImports": true,
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"resolveJsonModule": true
+	},
+	"include": ["src/*", "src/types/*"],
+	"exclude": ["node_modules", "dist", "examples"]
+}