@khang07/zing-mp3-api 1.1.0 → 1.3.4

package/dist/esm/utils/refined.js

@@ -0,0 +1,132 @@
+function createArtistRef(data) {
+    return {
+        alias: data.alias,
+        name: data.name,
+        thumbnail: {
+            w240: data.thumbnail,
+            w600: data.thumbnailM
+        },
+        ...(typeof data.totalFollow === 'number' ? {
+            followCount: data.totalFollow
+        } : {})
+    };
+}
+function createSearchArtist(data) {
+    return {
+        alias: data.alias,
+        name: data.name,
+        thumbnail: {
+            w240: data.thumbnail,
+            w600: data.thumbnailM
+        },
+        followCount: data.totalFollow
+    };
+}
+function createArtist(data) {
+    return {
+        alias: data.alias,
+        birthday: data.birthday,
+        realname: data.realname,
+        thumbnail: {
+            w240: data.thumbnail,
+            w600: data.thumbnailM
+        },
+        followCount: data.totalFollow,
+        name: data.name,
+        national: data.national,
+        biography: data.biography
+    };
+}
+function createAlbum(data) {
+    return {
+        id: data.encodeId,
+        name: data.title,
+        isOffical: data.isoffical,
+        releaseDate: data.releaseDate,
+        releasedAt: data.releasedAt,
+        artists: data.artists.map(createArtistRef),
+        thumbnail: {
+            w165: data.thumbnail
+        }
+    };
+}
+function createMedia(data) {
+    return {
+        id: data.encodeId,
+        name: data.title,
+        alias: data.alias,
+        isOffical: data.isOffical,
+        username: data.username,
+        artists: data.artists.map(createArtistRef),
+        isWorldWide: data.isWorldWide,
+        thumbnail: {
+            w94: data.thumbnail,
+            w240: data.thumbnailM
+        },
+        duration: data.duration,
+        isPrivate: data.isPrivate,
+        releaseDate: data.releaseDate,
+        album: createAlbum(data.album),
+        hasLyric: !!data.hasLyric
+    };
+}
+function createSearchMedia(data) {
+    return {
+        id: data.encodeId,
+        name: data.title,
+        alias: data.alias,
+        isOffical: data.isOffical,
+        username: data.username,
+        artists: data.artists.map(createArtistRef),
+        isWorldWide: data.isWorldWide,
+        thumbnail: {
+            w94: data.thumbnail,
+            w240: data.thumbnailM
+        },
+        duration: data.duration,
+        hasLyric: !!data.hasLyric
+    };
+}
+function createPlayList(data) {
+    return {
+        id: data.encodeId,
+        name: data.title,
+        thumbnail: {
+            w165: data.thumbnail,
+            w320: data.thumbnailM
+        },
+        isOffical: data.isoffical,
+        releaseDate: data.releaseDate,
+        releasedAt: data.releasedAt,
+        artists: data.artists.map(createArtistRef),
+        isPrivate: data.isPrivate,
+        isSingle: data.isSingle,
+        description: data.description,
+        alias: data.aliasTitle,
+        updatedAt: data.contentLastUpdate,
+        likeCount: data.like,
+        listenCount: data.listen,
+        mediaCount: data.song.total,
+        duration: data.song.totalDuration,
+        media: data.song.items.map(createMedia)
+    };
+}
+function createSearchPlayList(data) {
+    return {
+        id: data.encodeId,
+        name: data.title,
+        thumbnail: {
+            w165: data.thumbnail,
+            w320: data.thumbnailM
+        },
+        isOffical: data.isoffical,
+        releaseDate: data.releaseDate,
+        releasedAt: data.releasedAt,
+        artists: data.artists.map(createArtistRef),
+        isPrivate: data.isPrivate,
+        isSingle: data.isSingle,
+        alias: data.aliasTitle
+    };
+}
+export { createArtist, createMedia, createPlayList, createSearchMedia, createSearchPlayList, createSearchArtist };
+//# sourceMappingURL=refined.js.map

package/dist/esm/utils/refined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refined.js","sourceRoot":"source/","sources":["utils/refined.ts"],"names":[],"mappings":"AAsBA,SAAS,eAAe,CAAC,IAAmB;IACxC,OAAO;QACH,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,GAAG,CAAC,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC;YACvC,WAAW,EAAE,IAAI,CAAC,WAAW;SAChC,CAAC,CAAC,CAAC,EAAE,CAAC;KACV,CAAA;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAqB;IAC7C,OAAO;QACH,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,WAAW,EAAE,IAAI,CAAC,WAAW;KAChC,CAAA;AACL,CAAC;AAED,SAAS,YAAY,CAAC,IAAe;IACjC,OAAO;QACH,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC5B,CAAA;AACL,CAAC;AAED,SAAS,WAAW,CAAC,IAAc;IAC/B,OAAO;QACH,EAAE,EAAE,IAAI,CAAC,QAAQ;QACjB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;SACvB;KACJ,CAAA;AACL,CAAC;AAED,SAAS,WAAW,CAAC,IAAc;IAC/B,OAAO;QACH,EAAE,EAAE,IAAI,CAAC,QAAQ;QACjB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE;YACP,GAAG,EAAE,IAAI,CAAC,SAAS;YACnB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ;KAC5B,CAAA;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAoB;IAC3C,OAAO;QACH,EAAE,EAAE,IAAI,CAAC,QAAQ;QACjB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE;YACP,GAAG,EAAE,IAAI,CAAC,SAAS;YACnB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ;KAC5B,CAAA;AACL,CAAC;AAED,SAAS,cAAc,CAAC,IAAiB;IACrC,OAAO;QACH,EAAE,EAAE,IAAI,CAAC,QAAQ;QACjB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,KAAK,EAAE,IAAI,CAAC,UAAU;QACtB,SAAS,EAAE,IAAI,CAAC,iBAAiB;QACjC,SAAS,EAAE,IAAI,CAAC,IAAI;QACpB,WAAW,EAAE,IAAI,CAAC,MAAM;QACxB,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;QAC3B,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;QACjC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC;KAC1C,CAAA;AACL,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAuB;IACjD,OAAO;QACH,EAAE,EAAE,IAAI,CAAC,QAAQ;QACjB,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,SAAS,EAAE;YACP,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,UAAU;SACxB;QACD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,KAAK,EAAE,IAAI,CAAC,UAAU;KACzB,CAAA;AACL,CAAC;AAED,OAAO,EACH,YAAY,EACZ,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EACrB,CAAA"}

package/dist/types/index.d.ts

@@ -1,8 +1,10 @@
-import { Readable } from 'node:stream';
-import type { ResponseSearch } from './types/fetch/response.js';
-import type { ClientOptions, RequiredClientOptions } from './types/index.js';
-export type { ResponseSearch, ClientOptions };
-declare class ZingClient {
+import { URL } from 'node:url';
+import { Cookies } from './utils/cookies.js';
+import type { Readable } from 'node:stream';
+import type { ClientOptions } from './types/index.js';
+import type { Artist, Media, SearchMedia, PlayList, SearchPlayList, SearchArtist } from './types/response.js';
+export type { Cookies, ClientOptions, PlayList, Artist, Media, SearchMedia, SearchPlayList, SearchArtist };
+declare class Client {
     static readonly BASE_URL: string;
     static readonly VERSION_URL_V1: string;
     static readonly VERSION_URL_V2: string;
@@ -10,16 +12,33 @@ declare class ZingClient {
     static readonly SECRET_KEY_V2: string;
     static readonly API_KEY_V1: string;
     static readonly API_KEY_V2: string;
-    readonly ctime: string;
-    private readonly jar;
+    static readonly API_VIDEO_PATH: string;
+    static readonly API_MUSIC_PATH: string;
+    static readonly EXTRA_API_MUSIC_PATH: string;
+    static readonly API_SEARCH_PATH: string;
+    static readonly API_PLAYLIST_PATH: string;
+    static readonly API_MEDIA_DETAILS_PATH: string;
+    static readonly API_ARTIST_PATH: string;
+    static getIDFromURL(url: string): string;
+    private readonly ctime;
     private readonly instance;
-    maxRate: RequiredClientOptions['maxRate'];
+    private readonly maxLoad;
+    private readonly maxHighWaterMark;
+    private readonly userAgent;
+    private readonly jar;
     constructor(options?: ClientOptions);
-    video(videoID: string): Promise<Readable>;
-    videoSyncLike(videoID: string): Readable;
-    music(musicID: string): Promise<Readable>;
-    musicSyncLike(musicID: string): Readable;
-    search(keyword: string): Promise<ResponseSearch[]>;
+    private ensureCookies;
+    video(videoID: string | URL): Promise<Readable>;
+    videoSync(videoID: string | URL): Readable;
+    music(musicID: string | URL): Promise<Readable>;
+    musicSync(musicID: string | URL): Readable;
+    playlist(playlistID: string | URL): Promise<PlayList>;
+    artist(aliasID: string | URL): Promise<Artist>;
+    mediaDetails(mediaID: string | URL): Promise<Media>;
+    searchMusic(query: string): Promise<SearchMedia[]>;
+    searchVideo(query: string): Promise<SearchMedia[]>;
+    searchList(query: string): Promise<SearchPlayList[]>;
+    searchArtist(query: string): Promise<SearchArtist[]>;
 }
-declare const client: ZingClient;
-export { client as default, ZingClient };
+declare const client: Client;
+export { client as default, Client };

package/dist/types/types/index.d.ts

@@ -1,7 +1,9 @@
+import type { Cookies } from '../utils/cookies.js';
+type SearchCategory = 'music' | 'video' | 'artist' | 'playlist';
 interface ClientOptions {
-    maxRate?: [Download?: number, HighWaterMark?: number];
+    maxLoad?: number;
+    maxHighWaterMark?: number;
+    userAgent?: string;
+    jar?: Cookies;
 }
-interface RequiredClientOptions {
-    maxRate: [Download: number, HighWaterMark: number];
-}
-export type { ClientOptions, RequiredClientOptions };
+export type { ClientOptions, SearchCategory };

package/dist/types/types/raw.d.ts

@@ -0,0 +1,89 @@
+type RawThumbnail = {
+    thumbnail: string;
+    thumbnailM: string;
+};
+type RawMusicQuality = '128' | '320';
+type RawVideoQuality = '360p' | '720p';
+type RawMusicStreaming = Partial<Record<'128', string>>;
+type RawVideoStreaming = Partial<Record<RawVideoQuality, string>>;
+interface ResponseData<Data> {
+    err: number;
+    data: Data;
+}
+interface RawMusic extends Partial<Record<RawMusicQuality, string>> {
+    streaming?: {
+        default?: RawMusicStreaming;
+    };
+}
+interface RawVideo {
+    streaming?: {
+        hls?: RawVideoStreaming;
+    };
+}
+interface RawArtistBase extends RawThumbnail {
+    alias: string;
+    name: string;
+}
+interface RawSearchArtist extends RawArtistBase {
+    totalFollow: number;
+}
+interface RawArtist extends RawArtistBase {
+    birthday: string;
+    biography: string;
+    national: string;
+    realname: string;
+    totalFollow: number;
+}
+type RawArtistItem = RawArtistBase & {
+    totalFollow?: number;
+};
+interface RawAlbum {
+    encodeId: string;
+    title: string;
+    thumbnail: string;
+    isoffical: boolean;
+    releaseDate: string;
+    releasedAt: number;
+    artists: RawArtistItem[];
+}
+interface RawMedia extends RawThumbnail {
+    encodeId: string;
+    title: string;
+    alias: string;
+    username: string;
+    artists: RawArtistItem[];
+    duration: number;
+    releaseDate: number;
+    album: RawAlbum;
+    hasLyric?: boolean;
+    isOffical: boolean;
+    isPrivate: boolean;
+    isWorldWide: boolean;
+}
+type RawSearchMedia = Omit<RawMedia, 'album'>;
+interface RawPlayListSong {
+    items: RawMedia[];
+    total: number;
+    totalDuration: number;
+}
+interface RawPlayList extends RawThumbnail {
+    encodeId: string;
+    title: string;
+    aliasTitle: string;
+    artists: RawArtistItem[];
+    contentLastUpdate: number;
+    description: string;
+    isoffical: boolean;
+    isPrivate: boolean;
+    isSingle: boolean;
+    like: number;
+    listen: number;
+    releaseDate: string;
+    releasedAt: number;
+    song: RawPlayListSong;
+}
+type RawSearchPlayList = Omit<RawPlayList, 'song' | 'listen' | 'like' | 'description' | 'contentLastUpdate'>;
+interface RawSearch<Data> {
+    items: Data[];
+}
+export type { ResponseData, RawAlbum, RawArtist, RawArtistBase, RawArtistItem, RawMedia, RawSearch, RawMusic, RawMusicQuality, RawMusicStreaming, RawPlayList, RawPlayListSong, RawSearchMedia, RawThumbnail, RawVideo, RawVideoQuality, RawVideoStreaming, RawSearchPlayList, RawSearchArtist };

package/dist/types/types/response.d.ts

@@ -0,0 +1,70 @@
+type CoverArtist = {
+    w240: string;
+    w600: string;
+};
+type CoverMedia = {
+    w94: string;
+    w240: string;
+};
+type CoverPlayList = {
+    w165: string;
+    w320: string;
+};
+interface Named {
+    id: string;
+    name: string;
+}
+interface ArtistRef {
+    alias: string;
+    followCount?: number;
+    name: string;
+    thumbnail: CoverArtist;
+}
+type SearchArtist = Required<ArtistRef>;
+interface Artist extends ArtistRef {
+    biography: string;
+    birthday: string;
+    followCount: number;
+    national: string;
+    realname: string;
+}
+interface Album extends Named {
+    artists: ArtistRef[];
+    isOffical: boolean;
+    releaseDate: string;
+    releasedAt: number;
+    thumbnail: Pick<CoverPlayList, 'w165'>;
+}
+interface Media extends Named {
+    album: Album;
+    alias: string;
+    artists: ArtistRef[];
+    duration: number;
+    hasLyric: boolean;
+    isOffical: boolean;
+    isPrivate: boolean;
+    isWorldWide: boolean;
+    releaseDate: number;
+    thumbnail: CoverMedia;
+    username: string;
+}
+type SearchMedia = Omit<Media, 'album' | 'isPrivate' | 'releaseDate'>;
+interface PlayList extends Named {
+    alias: string;
+    artists: ArtistRef[];
+    description: string;
+    duration: number;
+    isOffical: boolean;
+    isPrivate: boolean;
+    isSingle: boolean;
+    likeCount: number;
+    listenCount: number;
+    media: Media[];
+    mediaCount: number;
+    releaseDate: string;
+    releasedAt: number;
+    thumbnail: CoverPlayList;
+    updatedAt: number;
+}
+type SearchPlayList = Omit<PlayList, 'updatedAt' | 'mediaCount' | 'listenCount' | 'likeCount' | 'duration' | 'description' | 'media'>;
+export type { Album, Artist, ArtistRef, CoverArtist, CoverMedia, CoverPlayList, Media, SearchMedia, PlayList, SearchPlayList, SearchArtist };

package/dist/types/utils/refined.d.ts

@@ -0,0 +1,9 @@
+import type { RawArtist, RawMedia, RawPlayList, RawSearchMedia, RawSearchPlayList, RawSearchArtist } from '../types/raw.js';
+import type { Artist, Media, PlayList, SearchMedia, SearchPlayList, SearchArtist } from '../types/response.js';
+declare function createSearchArtist(data: RawSearchArtist): SearchArtist;
+declare function createArtist(data: RawArtist): Artist;
+declare function createMedia(data: RawMedia): Media;
+declare function createSearchMedia(data: RawSearchMedia): SearchMedia;
+declare function createPlayList(data: RawPlayList): PlayList;
+declare function createSearchPlayList(data: RawSearchPlayList): SearchPlayList;
+export { createArtist, createMedia, createPlayList, createSearchMedia, createSearchPlayList, createSearchArtist };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@khang07/zing-mp3-api",
-	"version": "1.1.0",
+	"version": "1.3.4",
 	"author": "GiaKhang <ngkhang9a5lqc11@gmail.com>",
 	"repository": {
 		"type": "git",
@@ -48,7 +48,6 @@
 	"scripts": {
 		"build:esm": "tsc -p tsconfig.json",
 		"build:cjs": "rollup -c",
-		"build": "rm -rf dist && bun run build:esm && bun run build:cjs && rm -fr dist/esm/types dist/cjs/types",
 		"test": "mocha"
 	},
 	"devDependencies": {

package/dist/types/types/fetch/response.d.ts

@@ -1,22 +0,0 @@
-export interface ResponseSearch {
-    id: string;
-    name: string;
-    alias: string;
-    isOffical: boolean;
-    username: string;
-    artists: {
-        id: string;
-        name: string;
-        alias: string;
-        thumbnail: {
-            w240: string;
-            w360: string;
-        };
-    }[];
-    thumbnail: {
-        w94: string;
-        w240: string;
-    };
-    duration: number;
-    releaseDate: number;
-}

package/dist/types/types/fetch/uri.d.ts

@@ -1,46 +0,0 @@
-export declare namespace Uri {
-    interface Music {
-        err: number;
-        data: {
-            128?: string;
-            streaming?: {
-                default?: {
-                    128?: string;
-                };
-            };
-        };
-    }
-    interface Video {
-        err: number;
-        data: {
-            streaming?: {
-                hls?: {
-                    '360p'?: string;
-                };
-            };
-        };
-    }
-    interface Search {
-        err: number;
-        data: {
-            songs?: {
-                encodeId: string;
-                title: string;
-                alias: string;
-                isOffical: boolean;
-                username: string;
-                artists: {
-                    id: string;
-                    name: string;
-                    alias: string;
-                    thumbnail: string;
-                    thumbnailM: string;
-                }[];
-                thumbnailM: string;
-                thumbnail: string;
-                duration: number;
-                releaseDate: number;
-            }[];
-        };
-    }
-}