Fixed Spotify Search issues.

play-dl/Spotify/classes.ts

@@ -535,3 +535,158 @@ export class SpotifyAlbum {
         };
     }
 }
+
+export class SpotifySearchPlaylist{
+    /**
+    * Spotify Playlist Name
+    */
+    name: string;
+    /**
+     * Spotify Class type. == "playlist"
+     */
+    type: 'track' | 'playlist' | 'album';
+    /**
+     * Spotify Playlist collaborative boolean.
+     */
+    collaborative: boolean;
+    /**
+     * Spotify Playlist Description
+     */
+    description: string;
+    /**
+     * Spotify Playlist URL
+     */
+    url: string;
+    /**
+     * Spotify Playlist ID
+     */
+    id: string;
+    /**
+     * Spotify Playlist Thumbnail Data
+     */
+    thumbnail: SpotifyThumbnail;
+    /**
+     * Spotify Playlist Owner Artist data
+     */
+    owner: SpotifyArtists;
+    /**
+     * Spotify Playlist total tracks Count
+     */
+    tracksCount: number;
+
+    constructor(data : any){
+        this.name = data.name;
+        this.type = 'playlist';
+        this.collaborative = data.collaborative;
+        this.description = data.description;
+        this.url = data.external_urls.spotify;
+        this.id = data.id;
+        this.thumbnail = data.images[0];
+        this.owner = {
+            name: data.owner.display_name,
+            url: data.owner.external_urls.spotify,
+            id: data.owner.id
+        };
+        this.tracksCount = Number(data.tracks.total);
+    }
+
+    /**
+     * Converts Class to JSON
+     * @returns JSON data
+     */
+     toJSON(): PlaylistJSON {
+        return {
+            name: this.name,
+            collaborative: this.collaborative,
+            description: this.description,
+            url: this.url,
+            id: this.id,
+            thumbnail: this.thumbnail,
+            owner: this.owner,
+            tracksCount: this.tracksCount
+        };
+    }
+}
+
+export class SpotifySearchAlbum{
+    /**
+    * Spotify Album Name
+    */
+    name: string;
+    /**
+     * Spotify Class type. == "album"
+     */
+    type: 'track' | 'playlist' | 'album';
+    /**
+     * Spotify Album url
+     */
+    url: string;
+    /**
+     * Spotify Album id
+     */
+    id: string;
+    /**
+     * Spotify Album Thumbnail data
+     */
+    thumbnail: SpotifyThumbnail;
+    /**
+     * Spotify Album artists [ array ]
+     */
+    artists: SpotifyArtists[];
+    /**
+     * Spotify Album copyright data [ array ]
+     */
+    copyrights: SpotifyCopyright[];
+    /**
+     * Spotify Album Release date
+     */
+    release_date: string;
+    /**
+     * Spotify Album Release Date **precise**
+     */
+    release_date_precision: string;
+    /**
+     * Spotify Album total no of tracks
+     */
+    tracksCount: number;
+    /**
+     * Spotify Album Spotify data
+     *
+     * @private
+     */
+    constructor(data : any){
+        this.name = data.name;
+        this.type = 'album';
+        this.id = data.id;
+        this.url = data.external_urls.spotify;
+        this.thumbnail = data.images[0];
+        const artists: SpotifyArtists[] = [];
+        data.artists.forEach((v: any) => {
+            artists.push({
+                name: v.name,
+                id: v.id,
+                url: v.external_urls.spotify
+            });
+        });
+        this.artists = artists;
+        this.copyrights = data.copyrights;
+        this.release_date = data.release_date;
+        this.release_date_precision = data.release_date_precision;
+        this.tracksCount = data.total_tracks;
+    }
+
+    toJSON(): AlbumJSON {
+        return {
+            name: this.name,
+            id: this.id,
+            type: this.type,
+            url: this.url,
+            thumbnail: this.thumbnail,
+            artists: this.artists,
+            copyrights: this.copyrights,
+            release_date: this.release_date,
+            release_date_precision: this.release_date_precision,
+            tracksCount: this.tracksCount
+        };
+    }
+}

play-dl/Spotify/index.ts

@@ -1,5 +1,5 @@
 import { request } from '../Request';
-import { SpotifyAlbum, SpotifyPlaylist, SpotifyTrack } from './classes';
+import { SpotifyAlbum, SpotifyPlaylist, SpotifySearchAlbum, SpotifySearchPlaylist, SpotifyTrack } from './classes';
 import { existsSync, readFileSync, writeFileSync } from 'node:fs';
 
 let spotifyData: SpotifyDataOptions;
@@ -158,9 +158,13 @@ export function is_expired(): boolean {
     else return false;
 }
 /**
- * type for Spotify Class
+ * type for Spotify Classes
  */
 export type Spotify = SpotifyAlbum | SpotifyPlaylist | SpotifyTrack;
+/**
+ * type for Spotify Searched Classes
+ */
+export type SpotifySearch = SpotifyTrack | SpotifySearchPlaylist | SpotifySearchAlbum
 /**
  * Function for searching songs on Spotify
  * @param query searching query
@@ -172,8 +176,8 @@ export async function sp_search(
     query: string,
     type: 'album' | 'playlist' | 'track',
     limit: number = 10
-): Promise<Spotify[]> {
-    const results: Spotify[] = [];
+): Promise<SpotifySearch[]> {
+    const results: SpotifySearch[] = [];
     if (!spotifyData) throw new Error('Spotify Data is missing\nDid you forgot to do authorization ?');
     if (query.length === 0) throw new Error('Pass some query to search.');
     if (limit > 50 || limit < 0) throw new Error(`You crossed limit range of Spotify [ 0 - 50 ]`);
@@ -195,11 +199,11 @@ export async function sp_search(
         });
     } else if (type === 'album') {
         json_data.albums.items.forEach((album: any) => {
-            results.push(new SpotifyAlbum(album, spotifyData));
+            results.push(new SpotifySearchAlbum(album));
         });
     } else if (type === 'playlist') {
         json_data.playlists.items.forEach((playlist: any) => {
-            results.push(new SpotifyPlaylist(playlist, spotifyData));
+            results.push(new SpotifySearchPlaylist(playlist));
         });
     }
     return results;

play-dl/index.ts

@@ -19,7 +19,8 @@ export {
     SpotifyAlbum,
     SpotifyPlaylist,
     SpotifyTrack,
-    Spotify
+    Spotify,
+    SpotifySearch
 } from './Spotify';
 export {
     soundcloud,
@@ -72,7 +73,7 @@ import {
     SoundCloud,
     Spotify
 } from '.';
-import { SpotifyAuthorize, sp_search } from './Spotify';
+import { SpotifyAuthorize, SpotifySearch, sp_search } from './Spotify';
 import { check_id, so_search, stream as so_stream, stream_from_info as so_stream_info } from './SoundCloud';
 import { stream as yt_stream, StreamOptions, stream_from_info as yt_stream_info } from './YouTube/stream';
 import { SoundCloudPlaylist, SoundCloudTrack } from './SoundCloud/classes';
@@ -213,7 +214,7 @@ export async function search(query: string, options?: SearchOptions): Promise<Yo
 export async function search(
     query: string,
     options: SearchOptions = {}
-): Promise<YouTube[] | Spotify[] | SoundCloud[] | Deezer[]> {
+): Promise<YouTube[] | SpotifySearch[] | SoundCloud[] | Deezer[]> {
     if (!options.source) options.source = { youtube: 'video' };
     query = encodeURIComponent(query);
     if (options.source.youtube) return await yt_search(query, { limit: options.limit, type: options.source.youtube });