ziplayer 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +150 -0
  2. package/dist/index.d.ts +8 -0
  3. package/dist/index.d.ts.map +1 -0
  4. package/dist/index.js +29 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/plugins/BasePlugin.d.ts +17 -0
  7. package/dist/plugins/BasePlugin.d.ts.map +1 -0
  8. package/dist/plugins/BasePlugin.js +19 -0
  9. package/dist/plugins/BasePlugin.js.map +1 -0
  10. package/dist/plugins/SoundCloudPlugin.d.ts +22 -0
  11. package/dist/plugins/SoundCloudPlugin.d.ts.map +1 -0
  12. package/dist/plugins/SoundCloudPlugin.js +171 -0
  13. package/dist/plugins/SoundCloudPlugin.js.map +1 -0
  14. package/dist/plugins/SpotifyPlugin.d.ts +26 -0
  15. package/dist/plugins/SpotifyPlugin.d.ts.map +1 -0
  16. package/dist/plugins/SpotifyPlugin.js +183 -0
  17. package/dist/plugins/SpotifyPlugin.js.map +1 -0
  18. package/dist/plugins/YouTubePlugin.d.ts +25 -0
  19. package/dist/plugins/YouTubePlugin.d.ts.map +1 -0
  20. package/dist/plugins/YouTubePlugin.js +314 -0
  21. package/dist/plugins/YouTubePlugin.js.map +1 -0
  22. package/dist/plugins/index.d.ts +12 -0
  23. package/dist/plugins/index.d.ts.map +1 -0
  24. package/dist/plugins/index.js +31 -0
  25. package/dist/plugins/index.js.map +1 -0
  26. package/dist/structures/Player.d.ts +54 -0
  27. package/dist/structures/Player.d.ts.map +1 -0
  28. package/dist/structures/Player.js +444 -0
  29. package/dist/structures/Player.js.map +1 -0
  30. package/dist/structures/PlayerManager.d.ts +16 -0
  31. package/dist/structures/PlayerManager.d.ts.map +1 -0
  32. package/dist/structures/PlayerManager.js +77 -0
  33. package/dist/structures/PlayerManager.js.map +1 -0
  34. package/dist/structures/Queue.d.ts +24 -0
  35. package/dist/structures/Queue.d.ts.map +1 -0
  36. package/dist/structures/Queue.js +78 -0
  37. package/dist/structures/Queue.js.map +1 -0
  38. package/dist/types/index.d.ts +75 -0
  39. package/dist/types/index.d.ts.map +1 -0
  40. package/dist/types/index.js +3 -0
  41. package/dist/types/index.js.map +1 -0
  42. package/package.json +29 -0
  43. package/src/index.ts +10 -0
  44. package/src/plugins/BasePlugin.ts +29 -0
  45. package/src/plugins/index.ts +32 -0
  46. package/src/structures/Player.ts +526 -0
  47. package/src/structures/PlayerManager.ts +86 -0
  48. package/src/structures/Queue.ts +87 -0
  49. package/src/types/index.ts +82 -0
  50. package/tsconfig.json +23 -0
package/README.md ADDED
@@ -0,0 +1,150 @@
1
+ # ziplayer
2
+
3
+ A modular Discord voice player with plugin system for @discordjs/voice.
4
+
5
+ ## Features
6
+
7
+ - 🎵 **Plugin-based architecture** - Easy to extend with new sources
8
+ - 🎶 **Multiple source support** - YouTube, SoundCloud, Spotify (with fallback)
9
+ - 🔊 **Queue management** - Add, remove, shuffle, clear
10
+ - 🎚️ **Volume control** - 0-200% volume range
11
+ - ⏯️ **Playback control** - Play, pause, resume, stop, skip
12
+ - 🔁 **Auto play** - Automatically replay the queue when it ends
13
+ - 📊 **Progress bar** - Display playback progress with customizable icons
14
+ - 🔔 **Event-driven** - Rich event system for all player actions
15
+ - 🎭 **Multi-guild support** - Manage players across multiple Discord servers
16
+ - 🗃️ **User data** - Attach custom data to each player for later use
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ npm install ziplayer @ziplayer/plugin @discordjs/voice discord.js
22
+ ```
23
+
24
+ ## Quick Start
25
+
26
+ ```typescript
27
+ import { PlayerManager } from "ziplayer";
28
+ import { SoundCloudPlugin, YouTubePlugin, SpotifyPlugin } from "@ziplayer/plugin";
29
+
30
+ const soundcloudPlugin = new SoundCloudPlugin();
31
+ const youtubePlugin = new YouTubePlugin();
32
+ const spotifyPlugin = new SpotifyPlugin();
33
+
34
+ // Create player manager with YouTube and SoundCloud plugins
35
+ const manager = new PlayerManager({
36
+ plugins: [soundcloudPlugin, youtubePlugin, spotifyPlugin],
37
+ });
38
+
39
+ // Create player
40
+ const player = manager.create(guildId, {
41
+ leaveOnEnd: true,
42
+ leaveTimeout: 30000,
43
+ userdata: { channel: textChannel }, // store channel for events
44
+ });
45
+
46
+ // Connect and play
47
+ await player.connect(voiceChannel);
48
+ await player.play("Never Gonna Give You Up", userId);
49
+
50
+ // Play a full YouTube playlist
51
+ await player.play("https://www.youtube.com/playlist?list=PL123", userId);
52
+
53
+ // Enable autoplay
54
+ player.queue.autoPlay(true);
55
+
56
+ // Play a full SoundCloud playlist
57
+ await player.play("https://soundcloud.com/artist/sets/playlist", userId);
58
+
59
+ // Events
60
+ player.on("willPlay", (track) => {
61
+ console.log(`Up next: ${track.title}`);
62
+ });
63
+ player.on("trackStart", (track) => {
64
+ console.log(`Now playing: ${track.title}`);
65
+ player.userdata?.channel?.send(`Now playing: ${track.title}`);
66
+ });
67
+ ```
68
+
69
+ ## Available Plugins
70
+
71
+ ### YouTubePlugin
72
+
73
+ Supports YouTube videos and playlists.
74
+
75
+ ```typescript
76
+ import { YouTubePlugin } from "@ziplayer/plugin";
77
+ const youtube = new YouTubePlugin();
78
+ ```
79
+
80
+ ### SoundCloudPlugin
81
+
82
+ Supports SoundCloud tracks and playlists.
83
+
84
+ ```typescript
85
+ import { SoundCloudPlugin } from "@ziplayer/plugin";
86
+ const soundcloud = new SoundCloudPlugin();
87
+ ```
88
+
89
+ ### SpotifyPlugin
90
+
91
+ Supports Spotify tracks, albums, and playlists (requires fallback plugin for streaming).
92
+
93
+ ```typescript
94
+ import { SpotifyPlugin } from "@ziplayer/plugin";
95
+ const spotify = new SpotifyPlugin();
96
+ ```
97
+
98
+ ## Creating Custom Plugins
99
+
100
+ ```typescript
101
+ import { BasePlugin, Track, SearchResult, StreamInfo } from "@zibot/player";
102
+
103
+ export class MyPlugin extends BasePlugin {
104
+ name = "myplugin";
105
+ version = "1.0.0";
106
+
107
+ canHandle(query: string): boolean {
108
+ return query.includes("mysite.com");
109
+ }
110
+
111
+ async search(query: string, requestedBy: string): Promise<SearchResult> {
112
+ // Implement search logic
113
+ return {
114
+ tracks: [
115
+ /* ... */
116
+ ],
117
+ };
118
+ }
119
+
120
+ async getStream(track: Track): Promise<StreamInfo> {
121
+ // Return audio stream
122
+ return { stream, type: "arbitrary" };
123
+ }
124
+ }
125
+ ```
126
+
127
+ ## Events
128
+
129
+ All player events are forwarded through the PlayerManager:
130
+
131
+ - `trackStart` - When a track starts playing
132
+ - `willPlay` - Before a track begins playing
133
+ - `trackEnd` - When a track finishes
134
+ - `queueEnd` - When the queue is empty
135
+ - `playerError` - When an error occurs
136
+ - `queueAdd` - When a track is added
137
+ - `volumeChange` - When volume changes
138
+ - And more...
139
+
140
+ ## Progress Bar
141
+
142
+ Display the current playback progress with `getProgressBar`:
143
+
144
+ ```typescript
145
+ console.log(player.getProgressBar({ size: 30, barChar: "-", progressChar: "🔘" }));
146
+ ```
147
+
148
+ ## License
149
+
150
+ MIT License
@@ -0,0 +1,8 @@
1
+ import { PlayerManager } from "./structures/PlayerManager";
2
+ export { Player } from "./structures/Player";
3
+ export { Queue } from "./structures/Queue";
4
+ export { PlayerManager } from "./structures/PlayerManager";
5
+ export * from "./types";
6
+ export * from "./plugins";
7
+ export default PlayerManager;
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAG1B,eAAe,aAAa,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.PlayerManager = exports.Queue = exports.Player = void 0;
18
+ const PlayerManager_1 = require("./structures/PlayerManager");
19
+ var Player_1 = require("./structures/Player");
20
+ Object.defineProperty(exports, "Player", { enumerable: true, get: function () { return Player_1.Player; } });
21
+ var Queue_1 = require("./structures/Queue");
22
+ Object.defineProperty(exports, "Queue", { enumerable: true, get: function () { return Queue_1.Queue; } });
23
+ var PlayerManager_2 = require("./structures/PlayerManager");
24
+ Object.defineProperty(exports, "PlayerManager", { enumerable: true, get: function () { return PlayerManager_2.PlayerManager; } });
25
+ __exportStar(require("./types"), exports);
26
+ __exportStar(require("./plugins"), exports);
27
+ // Default export
28
+ exports.default = PlayerManager_1.PlayerManager;
29
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8DAA2D;AAE3D,8CAA6C;AAApC,gGAAA,MAAM,OAAA;AACf,4CAA2C;AAAlC,8FAAA,KAAK,OAAA;AACd,4DAA2D;AAAlD,8GAAA,aAAa,OAAA;AACtB,0CAAwB;AACxB,4CAA0B;AAE1B,iBAAiB;AACjB,kBAAe,6BAAa,CAAC"}
@@ -0,0 +1,17 @@
1
+ import { SourcePlugin, Track, SearchResult, StreamInfo } from "../types";
2
+ export declare abstract class BasePlugin implements SourcePlugin {
3
+ abstract name: string;
4
+ abstract version: string;
5
+ abstract canHandle(query: string): boolean;
6
+ abstract search(query: string, requestedBy: string): Promise<SearchResult>;
7
+ abstract getStream(track: Track): Promise<StreamInfo>;
8
+ getFallback?(track: Track): Promise<StreamInfo>;
9
+ getRelatedTracks?(trackURL: string, opts?: {
10
+ limit?: number;
11
+ offset?: number;
12
+ history?: Track[];
13
+ }): Promise<Track[]>;
14
+ validate?(url: string): boolean;
15
+ extractPlaylist?(url: string, requestedBy: string): Promise<Track[]>;
16
+ }
17
+ //# sourceMappingURL=BasePlugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BasePlugin.d.ts","sourceRoot":"","sources":["../../src/plugins/BasePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEzE,8BAAsB,UAAW,YAAW,YAAY;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAC1C,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAC1E,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAErD,WAAW,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAI/C,gBAAgB,CAAC,CACf,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAA;KAAE,GAC5D,OAAO,CAAC,KAAK,EAAE,CAAC;IAInB,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAI/B,eAAe,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;CAGrE"}
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BasePlugin = void 0;
4
+ class BasePlugin {
5
+ getFallback(track) {
6
+ throw new Error("getFallback not implemented");
7
+ }
8
+ getRelatedTracks(trackURL, opts) {
9
+ return Promise.resolve([]);
10
+ }
11
+ validate(url) {
12
+ return this.canHandle(url);
13
+ }
14
+ extractPlaylist(url, requestedBy) {
15
+ return Promise.resolve([]);
16
+ }
17
+ }
18
+ exports.BasePlugin = BasePlugin;
19
+ //# sourceMappingURL=BasePlugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"BasePlugin.js","sourceRoot":"","sources":["../../src/plugins/BasePlugin.ts"],"names":[],"mappings":";;;AAEA,MAAsB,UAAU;IAQ9B,WAAW,CAAE,KAAY;QACvB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB,CACd,QAAgB,EAChB,IAA6D;QAE7D,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED,QAAQ,CAAE,GAAW;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe,CAAE,GAAW,EAAE,WAAmB;QAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;CACF;AA1BD,gCA0BC"}
@@ -0,0 +1,22 @@
1
+ import { BasePlugin } from "./BasePlugin";
2
+ import { Track, SearchResult, StreamInfo } from "../types";
3
+ export declare class SoundCloudPlugin extends BasePlugin {
4
+ name: string;
5
+ version: string;
6
+ private client;
7
+ private ready;
8
+ constructor();
9
+ private init;
10
+ canHandle(query: string): boolean;
11
+ validate(url: string): boolean;
12
+ search(query: string, requestedBy: string): Promise<SearchResult>;
13
+ getStream(track: Track): Promise<StreamInfo>;
14
+ getRelatedTracks(trackURL: string | number, opts?: {
15
+ limit?: number;
16
+ offset?: number;
17
+ history?: Track[];
18
+ }): Promise<Track[]>;
19
+ getFallback(track: Track): Promise<StreamInfo>;
20
+ extractPlaylist(url: string, requestedBy: string): Promise<Track[]>;
21
+ }
22
+ //# sourceMappingURL=SoundCloudPlugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SoundCloudPlugin.d.ts","sourceRoot":"","sources":["../../src/plugins/SoundCloudPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAI3D,qBAAa,gBAAiB,SAAQ,UAAU;IAC9C,IAAI,SAAgB;IACpB,OAAO,SAAW;IAClB,OAAO,CAAC,MAAM,CAAM;IACpB,OAAO,CAAC,KAAK,CAAgB;;YAOf,IAAI;IAKlB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAOjC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIxB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAsEjE,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAmB5C,gBAAgB,CACpB,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAA;KAAO,GAChE,OAAO,CAAC,KAAK,EAAE,CAAC;IAoCb,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAS9C,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;CAsB1E"}
@@ -0,0 +1,171 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SoundCloudPlugin = void 0;
4
+ const BasePlugin_1 = require("./BasePlugin");
5
+ const SoundCloud = require("@zibot/scdl");
6
+ class SoundCloudPlugin extends BasePlugin_1.BasePlugin {
7
+ constructor() {
8
+ super();
9
+ this.name = "soundcloud";
10
+ this.version = "1.0.0";
11
+ this.ready = this.init();
12
+ }
13
+ async init() {
14
+ this.client = new SoundCloud({ init: false });
15
+ await this.client.init();
16
+ }
17
+ canHandle(query) {
18
+ return (query.includes("soundcloud.com") ||
19
+ (!query.startsWith("http") && !query.includes("youtube")));
20
+ }
21
+ validate(url) {
22
+ return url.includes("soundcloud.com");
23
+ }
24
+ async search(query, requestedBy) {
25
+ await this.ready;
26
+ try {
27
+ if (query.includes("soundcloud.com")) {
28
+ try {
29
+ const info = await this.client.getTrackDetails(query);
30
+ const track = {
31
+ id: info.id.toString(),
32
+ title: info.title,
33
+ url: info.permalink_url || query,
34
+ duration: info.duration,
35
+ thumbnail: info.artwork_url,
36
+ requestedBy,
37
+ source: this.name,
38
+ metadata: {
39
+ author: info.user?.username,
40
+ plays: info.playback_count,
41
+ },
42
+ };
43
+ return { tracks: [track] };
44
+ }
45
+ catch {
46
+ const playlist = await this.client.getPlaylistDetails(query);
47
+ const tracks = playlist.tracks.map((t) => ({
48
+ id: t.id.toString(),
49
+ title: t.title,
50
+ url: t.permalink_url,
51
+ duration: t.duration,
52
+ thumbnail: t.artwork_url || playlist.artwork_url,
53
+ requestedBy,
54
+ source: this.name,
55
+ metadata: {
56
+ author: t.user?.username,
57
+ plays: t.playback_count,
58
+ playlist: playlist.id?.toString(),
59
+ },
60
+ }));
61
+ return {
62
+ tracks,
63
+ playlist: {
64
+ name: playlist.title,
65
+ url: playlist.permalink_url || query,
66
+ thumbnail: playlist.artwork_url,
67
+ },
68
+ };
69
+ }
70
+ }
71
+ const results = await this.client.searchTracks({ query, limit: 15 });
72
+ const tracks = results.slice(0, 10).map((track) => ({
73
+ id: track.id.toString(),
74
+ title: track.title,
75
+ url: track.permalink_url,
76
+ duration: track.duration,
77
+ thumbnail: track.artwork_url,
78
+ requestedBy,
79
+ source: this.name,
80
+ metadata: {
81
+ author: track.user?.username,
82
+ plays: track.playback_count,
83
+ },
84
+ }));
85
+ return { tracks };
86
+ }
87
+ catch (error) {
88
+ throw new Error(`SoundCloud search failed: ${error?.message}`);
89
+ }
90
+ }
91
+ async getStream(track) {
92
+ await this.ready;
93
+ try {
94
+ const stream = await this.client.downloadTrack(track.url);
95
+ if (!stream) {
96
+ throw new Error("SoundCloud download returned null");
97
+ }
98
+ return {
99
+ stream,
100
+ type: "arbitrary",
101
+ metadata: track.metadata,
102
+ };
103
+ }
104
+ catch (error) {
105
+ throw new Error(`Failed to get SoundCloud stream: ${error.message}`);
106
+ }
107
+ }
108
+ async getRelatedTracks(trackURL, opts = {}) {
109
+ await this.ready;
110
+ try {
111
+ const tracks = await this.client.getRelatedTracks(trackURL, {
112
+ limit: 30,
113
+ filter: "tracks",
114
+ });
115
+ if (!tracks || !tracks?.length) {
116
+ return [];
117
+ }
118
+ const relatedfilter = tracks.filter((tr) => !(opts?.history ?? []).some((t) => t.url === tr.permalink_url));
119
+ const related = relatedfilter.slice(0, opts.limit || 1);
120
+ return related.map((t) => ({
121
+ id: t.id.toString(),
122
+ title: t.title,
123
+ url: t.permalink_url,
124
+ duration: t.duration,
125
+ thumbnail: t.artwork_url,
126
+ requestedBy: "auto",
127
+ source: this.name,
128
+ metadata: {
129
+ author: t.user?.username,
130
+ plays: t.playback_count,
131
+ },
132
+ }));
133
+ }
134
+ catch {
135
+ return [];
136
+ }
137
+ }
138
+ async getFallback(track) {
139
+ const trackfall = await this.search(track.title, track.requestedBy);
140
+ const fallbackTrack = trackfall.tracks?.[0];
141
+ if (!fallbackTrack) {
142
+ throw new Error(`No fallback track found for ${track.title}`);
143
+ }
144
+ return await this.getStream(fallbackTrack);
145
+ }
146
+ async extractPlaylist(url, requestedBy) {
147
+ await this.ready;
148
+ try {
149
+ const playlist = await this.client.getPlaylistDetails(url);
150
+ return playlist.tracks.map((t) => ({
151
+ id: t.id.toString(),
152
+ title: t.title,
153
+ url: t.permalink_url,
154
+ duration: t.duration,
155
+ thumbnail: t.artwork_url || playlist.artwork_url,
156
+ requestedBy,
157
+ source: this.name,
158
+ metadata: {
159
+ author: t.user?.username,
160
+ plays: t.playback_count,
161
+ playlist: playlist.id?.toString(),
162
+ },
163
+ }));
164
+ }
165
+ catch {
166
+ return [];
167
+ }
168
+ }
169
+ }
170
+ exports.SoundCloudPlugin = SoundCloudPlugin;
171
+ //# sourceMappingURL=SoundCloudPlugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SoundCloudPlugin.js","sourceRoot":"","sources":["../../src/plugins/SoundCloudPlugin.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;AAE1C,MAAa,gBAAiB,SAAQ,uBAAU;IAM9C;QACE,KAAK,EAAE,CAAC;QANV,SAAI,GAAG,YAAY,CAAC;QACpB,YAAO,GAAG,OAAO,CAAC;QAMhB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,KAAa;QACrB,OAAO,CACL,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAChC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,GAAW;QAClB,OAAO,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,WAAmB;QAC7C,MAAM,IAAI,CAAC,KAAK,CAAC;QAEjB,IAAI,CAAC;YACH,IAAI,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;oBACtD,MAAM,KAAK,GAAU;wBACnB,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE;wBACtB,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,GAAG,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK;wBAChC,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,SAAS,EAAE,IAAI,CAAC,WAAW;wBAC3B,WAAW;wBACX,MAAM,EAAE,IAAI,CAAC,IAAI;wBACjB,QAAQ,EAAE;4BACR,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ;4BAC3B,KAAK,EAAE,IAAI,CAAC,cAAc;yBAC3B;qBACF,CAAC;oBACF,OAAO,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;oBAC7D,MAAM,MAAM,GAAY,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;wBACvD,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;wBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;wBACd,GAAG,EAAE,CAAC,CAAC,aAAa;wBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;wBACpB,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW;wBAChD,WAAW;wBACX,MAAM,EAAE,IAAI,CAAC,IAAI;wBACjB,QAAQ,EAAE;4BACR,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;4BACxB,KAAK,EAAE,CAAC,CAAC,cAAc;4BACvB,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE;yBAClC;qBACF,CAAC,CAAC,CAAC;oBAEJ,OAAO;wBACL,MAAM;wBACN,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ,CAAC,KAAK;4BACpB,GAAG,EAAE,QAAQ,CAAC,aAAa,IAAI,KAAK;4BACpC,SAAS,EAAE,QAAQ,CAAC,WAAW;yBAChC;qBACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACrE,MAAM,MAAM,GAAY,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAChE,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACvB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,EAAE,KAAK,CAAC,aAAa;gBACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,SAAS,EAAE,KAAK,CAAC,WAAW;gBAC5B,WAAW;gBACX,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACR,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ;oBAC5B,KAAK,EAAE,KAAK,CAAC,cAAc;iBAC5B;aACF,CAAC,CAAC,CAAC;YAEJ,OAAO,EAAE,MAAM,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAY;QAC1B,MAAM,IAAI,CAAC,KAAK,CAAC;QAEjB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;YACvD,CAAC;YAED,OAAO;gBACL,MAAM;gBACN,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,QAAyB,EACzB,OAA+D,EAAE;QAEjE,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE;gBAC1D,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,QAAQ;aACjB,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;gBAC/B,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CACjC,CAAC,EAAO,EAAE,EAAE,CACV,CAAC,CAAC,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,aAAa,CAAC,CACjE,CAAC;YAEF,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;YAExD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;gBAC9B,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,GAAG,EAAE,CAAC,CAAC,aAAa;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,SAAS,EAAE,CAAC,CAAC,WAAW;gBACxB,WAAW,EAAE,MAAM;gBACnB,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACR,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;oBACxB,KAAK,EAAE,CAAC,CAAC,cAAc;iBACxB;aACF,CAAC,CAAC,CAAC;QACN,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAY;QAC5B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW,EAAE,WAAmB;QACpD,MAAM,IAAI,CAAC,KAAK,CAAC;QACjB,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;gBACtC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE;gBACnB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,GAAG,EAAE,CAAC,CAAC,aAAa;gBACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ;gBACpB,SAAS,EAAE,CAAC,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW;gBAChD,WAAW;gBACX,MAAM,EAAE,IAAI,CAAC,IAAI;gBACjB,QAAQ,EAAE;oBACR,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ;oBACxB,KAAK,EAAE,CAAC,CAAC,cAAc;oBACvB,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,EAAE;iBAClC;aACF,CAAC,CAAC,CAAC;QACN,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AA1LD,4CA0LC"}
@@ -0,0 +1,26 @@
1
+ import { BasePlugin } from "./BasePlugin";
2
+ import { Track, SearchResult, StreamInfo } from "../types";
3
+ /**
4
+ * This minimal Spotify plugin:
5
+ * - Parses Spotify URLs/URIs (track/playlist/album)
6
+ * - Uses Spotify's public oEmbed endpoint to fetch *display metadata* (no auth, no SDK)
7
+ * - Does NOT provide audio streams (player is expected to redirect/fallback upstream)
8
+ * - Does NOT expand playlists/albums (no SDK; oEmbed doesn't enumerate items)
9
+ */
10
+ export declare class SpotifyPlugin extends BasePlugin {
11
+ name: string;
12
+ version: string;
13
+ canHandle(query: string): boolean;
14
+ validate(url: string): boolean;
15
+ search(query: string, requestedBy: string): Promise<SearchResult>;
16
+ extractPlaylist(_input: string, _requestedBy: string): Promise<Track[]>;
17
+ extractAlbum(_input: string, _requestedBy: string): Promise<Track[]>;
18
+ getStream(_track: Track): Promise<StreamInfo>;
19
+ private identifyKind;
20
+ private extractId;
21
+ private buildTrackFromUrlOrUri;
22
+ private buildHeaderItem;
23
+ private toShareUrl;
24
+ private fetchOEmbed;
25
+ }
26
+ //# sourceMappingURL=SpotifyPlugin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SpotifyPlugin.d.ts","sourceRoot":"","sources":["../../src/plugins/SpotifyPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3D;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,UAAU;IAC3C,IAAI,SAAa;IACjB,OAAO,SAAW;IAElB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAWjC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAUxB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAyBjE,eAAe,CACnB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,KAAK,EAAE,CAAC;IAIb,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAIpE,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAInD,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,SAAS;YAeH,sBAAsB;YA6BtB,eAAe;IA8B7B,OAAO,CAAC,UAAU;YAeJ,WAAW;CAkB1B"}
@@ -0,0 +1,183 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SpotifyPlugin = void 0;
4
+ const BasePlugin_1 = require("./BasePlugin");
5
+ /**
6
+ * This minimal Spotify plugin:
7
+ * - Parses Spotify URLs/URIs (track/playlist/album)
8
+ * - Uses Spotify's public oEmbed endpoint to fetch *display metadata* (no auth, no SDK)
9
+ * - Does NOT provide audio streams (player is expected to redirect/fallback upstream)
10
+ * - Does NOT expand playlists/albums (no SDK; oEmbed doesn't enumerate items)
11
+ */
12
+ class SpotifyPlugin extends BasePlugin_1.BasePlugin {
13
+ constructor() {
14
+ super(...arguments);
15
+ this.name = "spotify";
16
+ this.version = "1.1.0";
17
+ }
18
+ canHandle(query) {
19
+ const q = query.toLowerCase().trim();
20
+ if (q.startsWith("spotify:"))
21
+ return true;
22
+ try {
23
+ const u = new URL(q);
24
+ return u.hostname.includes("open.spotify.com");
25
+ }
26
+ catch {
27
+ return false;
28
+ }
29
+ }
30
+ validate(url) {
31
+ if (url.startsWith("spotify:"))
32
+ return true;
33
+ try {
34
+ const u = new URL(url);
35
+ return u.hostname.includes("open.spotify.com");
36
+ }
37
+ catch {
38
+ return false;
39
+ }
40
+ }
41
+ async search(query, requestedBy) {
42
+ if (!this.validate(query)) {
43
+ return { tracks: [] };
44
+ }
45
+ const kind = this.identifyKind(query);
46
+ if (kind === "track") {
47
+ const t = await this.buildTrackFromUrlOrUri(query, requestedBy);
48
+ return { tracks: t ? [t] : [] };
49
+ }
50
+ if (kind === "playlist") {
51
+ const t = await this.buildHeaderItem(query, requestedBy, "playlist");
52
+ return { tracks: t ? [t] : [] };
53
+ }
54
+ if (kind === "album") {
55
+ const t = await this.buildHeaderItem(query, requestedBy, "album");
56
+ return { tracks: t ? [t] : [] };
57
+ }
58
+ return { tracks: [] };
59
+ }
60
+ async extractPlaylist(_input, _requestedBy) {
61
+ return [];
62
+ }
63
+ async extractAlbum(_input, _requestedBy) {
64
+ return [];
65
+ }
66
+ async getStream(_track) {
67
+ throw new Error("Spotify streaming is not supported by this plugin");
68
+ }
69
+ identifyKind(input) {
70
+ if (input.startsWith("spotify:")) {
71
+ if (input.includes(":track:"))
72
+ return "track";
73
+ if (input.includes(":playlist:"))
74
+ return "playlist";
75
+ if (input.includes(":album:"))
76
+ return "album";
77
+ return "unknown";
78
+ }
79
+ try {
80
+ const u = new URL(input);
81
+ const parts = u.pathname.split("/").filter(Boolean);
82
+ const kind = parts[0];
83
+ if (kind === "track")
84
+ return "track";
85
+ if (kind === "playlist")
86
+ return "playlist";
87
+ if (kind === "album")
88
+ return "album";
89
+ return "unknown";
90
+ }
91
+ catch {
92
+ return "unknown";
93
+ }
94
+ }
95
+ extractId(input) {
96
+ if (!input)
97
+ return null;
98
+ if (input.startsWith("spotify:")) {
99
+ const parts = input.split(":");
100
+ return parts[2] || null;
101
+ }
102
+ try {
103
+ const u = new URL(input);
104
+ const parts = u.pathname.split("/").filter(Boolean);
105
+ return parts[1] || null; // /track/<id>
106
+ }
107
+ catch {
108
+ return null;
109
+ }
110
+ }
111
+ async buildTrackFromUrlOrUri(input, requestedBy) {
112
+ const id = this.extractId(input);
113
+ if (!id)
114
+ return null;
115
+ const url = this.toShareUrl(input, "track", id);
116
+ const meta = await this.fetchOEmbed(url).catch(() => undefined);
117
+ const title = meta?.title || `Spotify Track ${id}`;
118
+ const thumbnail = meta?.thumbnail_url;
119
+ const track = {
120
+ id,
121
+ title,
122
+ url,
123
+ duration: 0,
124
+ thumbnail,
125
+ requestedBy,
126
+ source: this.name,
127
+ metadata: {
128
+ author: meta?.author_name,
129
+ provider: meta?.provider_name,
130
+ spotify_id: id,
131
+ },
132
+ };
133
+ return track;
134
+ }
135
+ async buildHeaderItem(input, requestedBy, kind) {
136
+ const id = this.extractId(input);
137
+ if (!id)
138
+ return null;
139
+ const url = this.toShareUrl(input, kind, id);
140
+ const meta = await this.fetchOEmbed(url).catch(() => undefined);
141
+ const title = meta?.title || `Spotify ${kind} ${id}`;
142
+ const thumbnail = meta?.thumbnail_url;
143
+ return {
144
+ id,
145
+ title,
146
+ url,
147
+ duration: 0,
148
+ thumbnail,
149
+ requestedBy,
150
+ source: this.name,
151
+ metadata: {
152
+ author: meta?.author_name,
153
+ provider: meta?.provider_name,
154
+ spotify_id: id,
155
+ kind,
156
+ },
157
+ };
158
+ }
159
+ toShareUrl(input, expectedKind, id) {
160
+ if (input.startsWith("spotify:")) {
161
+ return `https://open.spotify.com/${expectedKind}/${id}`;
162
+ }
163
+ try {
164
+ const u = new URL(input);
165
+ const parts = u.pathname.split("/").filter(Boolean);
166
+ const kind = parts[0] || expectedKind;
167
+ const realId = parts[1] || id;
168
+ return `https://open.spotify.com/${kind}/${realId}`;
169
+ }
170
+ catch {
171
+ return `https://open.spotify.com/${expectedKind}/${id}`;
172
+ }
173
+ }
174
+ async fetchOEmbed(pageUrl) {
175
+ const endpoint = `https://open.spotify.com/oembed?url=${encodeURIComponent(pageUrl)}`;
176
+ const res = await fetch(endpoint);
177
+ if (!res.ok)
178
+ throw new Error(`oEmbed HTTP ${res.status}`);
179
+ return res.json();
180
+ }
181
+ }
182
+ exports.SpotifyPlugin = SpotifyPlugin;
183
+ //# sourceMappingURL=SpotifyPlugin.js.map