@kuriyona/cecilia 0.2.0 → 1.0.0

package/dist/index.d.mts

@@ -1,55 +1,451 @@
-//#region src/types/Lyric.d.ts
-interface Lyric {
-  lines: LyricLine[];
-  translator?: {
-    id: number;
-    nickname: string;
-  };
+//#region src/client.d.ts
+type Crypto = "eapi" | "weapi" | "api";
+interface RequestOptions {
+  cookie?: string | Record<string, string>;
+  realIP?: string;
+  timeout?: number;
+  ua?: string;
 }
-type LyricLine = {
-  time: number;
-  text: string;
-  translation?: string;
-};
+interface RawResponse {
+  status: number;
+  body: unknown;
+  cookies: string[];
+}
+declare function request(uri: string, data: Record<string, unknown>, crypto: Crypto, options?: RequestOptions, acceptCodes?: number[]): Promise<RawResponse>;
+//#endregion
+//#region src/types/common.d.ts
+/** 全库统一语义词表。字段名不得在本文件之外重新发明。 */
+interface UserRef {
+  id: number;
+  name: string;
+}
+interface ArtistRef {
+  id: number;
+  name: string;
+}
+interface AlbumRef {
+  id: number;
+  name: string;
+  coverUrl: string;
+}
+interface Song {
+  id: number;
+  name: string;
+  artists: ArtistRef[];
+  album: AlbumRef;
+  duration: number;
+  alias?: string[];
+  fee?: number;
+  available?: boolean;
+}
+interface Artist {
+  id: number;
+  name: string;
+  alias?: string[];
+  avatarUrl?: string;
+  briefDesc?: string;
+  albumCount?: number;
+  songCount?: number;
+  mvCount?: number;
+  followed?: boolean;
+  topSongs?: Song[];
+}
+interface Album {
+  id: number;
+  name: string;
+  coverUrl: string;
+  artists?: ArtistRef[];
+  publishTime?: number;
+  company?: string;
+  description?: string;
+  size?: number;
+  songs?: Song[];
+}
+interface PlaylistSummary {
+  id: number;
+  name: string;
+  coverUrl: string;
+  trackCount?: number;
+  playCount?: number;
+  creator?: UserRef;
+  description?: string;
+  updateTime?: number;
+  tags?: string[];
+}
+interface SongUrl {
+  id: number;
+  url: string | null;
+  br: number;
+  size: number;
+  level?: string;
+  fee?: number;
+  freeTrialInfo?: {
+    start: number;
+    end: number;
+  } | null;
+}
+interface MvRef {
+  id: number;
+  name: string;
+  coverUrl: string;
+  playCount?: number;
+  duration?: number;
+  artistName?: string;
+}
+interface VideoRef {
+  id: number;
+  name: string;
+  coverUrl: string;
+  playCount?: number;
+  duration?: number;
+  creator?: UserRef;
+}
+//#endregion
+//#region src/types/search.d.ts
+type SearchType = 1 | 10 | 100 | 1000 | 1002 | 1004 | 1006 | 1009 | 1014 | 2000;
+interface SearchLyric {
+  id: number;
+  name: string;
+  artists: ArtistRef[];
+}
+interface SearchRadio {
+  id: number;
+  name: string;
+  coverUrl: string;
+  djName?: string;
+}
+interface SearchResult {
+  songs?: Song[];
+  artists?: Artist[];
+  albums?: Album[];
+  playlists?: PlaylistSummary[];
+  users?: UserRef[];
+  mvs?: MvRef[];
+  videos?: VideoRef[];
+  lyrics?: SearchLyric[];
+  radios?: SearchRadio[];
+  total?: number;
+}
+interface SearchSuggest {
+  keywords: string[];
+  songs: Song[];
+  artists: Artist[];
+  albums: Album[];
+}
+interface HotSearchGroup {
+  first: string;
+  second?: string | number;
+  third?: string;
+}
+interface HotSearchItem {
+  keyword: string;
+  position: number;
+  content?: string;
+  iconUrl?: string;
+}
+//#endregion
+//#region src/types/params.d.ts
+interface SearchParams {
+  keywords: string;
+  type?: SearchType;
+  limit?: number;
+  offset?: number;
+}
+interface SearchSuggestParams {
+  keywords?: string;
+  mobile?: boolean;
+}
+interface SearchMultimatchParams {
+  keywords?: string;
+  type?: SearchType;
+}
+interface SongUrlParams {
+  id: number | number[];
+  br?: number;
+}
+interface CheckMusicParams {
+  id: number;
+  br?: number;
+}
+interface PlaylistTracksParams {
+  id: number;
+  limit?: number;
+  offset?: number;
+}
+interface TopPlaylistsParams {
+  cat?: string;
+  order?: "hot" | "new";
+  limit?: number;
+  offset?: number;
+}
+interface HighQualityPlaylistsParams {
+  cat?: string;
+  limit?: number;
+  before?: number;
+}
+interface ArtistSongsParams {
+  id: number;
+  order?: "hot" | "time";
+  limit?: number;
+  offset?: number;
+}
+interface ArtistAlbumsParams {
+  id: number;
+  limit?: number;
+  offset?: number;
+}
+interface ArtistListParams {
+  area?: number;
+  type?: number;
+  initial?: string | number;
+  limit?: number;
+  offset?: number;
+}
+interface ArtistMvsParams {
+  id: number;
+  limit?: number;
+  offset?: number;
+}
+interface ArtistVideosParams {
+  id: number;
+  size?: number;
+  cursor?: number;
+  order?: number;
+}
+interface AlbumSaleBoardParams {
+  albumType?: 0 | 1;
+  type?: "daily" | "week" | "year" | "total";
+  year?: number;
+}
+interface AlbumListParams {
+  area?: string;
+  type?: string;
+  limit?: number;
+  offset?: number;
+}
+//#endregion
+//#region src/types/album.d.ts
+interface AlbumPage {
+  total?: number;
+  more?: boolean;
+  albums: Album[];
+}
+interface AlbumProduct {
+  id: number;
+  name: string;
+  coverUrl: string;
+  artistName?: string;
+  price?: number;
+  publishTime?: number;
+  description?: string;
+}
+interface AlbumStats {
+  commentCount?: number;
+  shareCount?: number;
+  subCount?: number;
+  likedCount?: number;
+  isSub?: boolean;
+}
+interface AlbumSaleBoard {
+  albums: Album[];
+  updateTime?: number;
+}
+interface AlbumPrivilege {
+  id: number;
+  maxBrLevel?: string;
+  playMaxBrLevel?: string;
+  downloadMaxBrLevel?: string;
+  pl?: number;
+  dl?: number;
+  fl?: number;
+  st?: number;
+  fee?: number;
+}
+//#endregion
+//#region src/apis/album.d.ts
+declare const getAlbum: (id: number, options?: RequestOptions) => Promise<Album>;
+declare const getAlbumProduct: (id: number, options?: RequestOptions) => Promise<AlbumProduct>;
+declare const getAlbumDynamic: (id: number, options?: RequestOptions) => Promise<AlbumStats>;
+declare const getAlbumSaleBoard: (params: AlbumSaleBoardParams, options?: RequestOptions) => Promise<AlbumSaleBoard>;
+declare const getAlbumPrivileges: (id: number, options?: RequestOptions) => Promise<AlbumPrivilege[]>;
+declare const getAlbumList: (params: AlbumListParams, options?: RequestOptions) => Promise<AlbumPage>;
+declare const getNewestAlbums: (options?: RequestOptions) => Promise<Album[]>;
+//#endregion
+//#region src/types/artist.d.ts
+interface ArtistPage {
+  total?: number;
+  more?: boolean;
+  artists: Artist[];
+}
+interface ArtistDescription {
+  briefDesc: string;
+  sections: {
+    title: string;
+    text: string;
+  }[];
+}
+interface ArtistVideoPage {
+  hasMore: boolean;
+  videos: VideoRef[];
+}
+//#endregion
+//#region src/apis/artist.d.ts
+declare const getArtist: (id: number, options?: RequestOptions) => Promise<Artist>;
+declare const getArtistDetail: (id: number, options?: RequestOptions) => Promise<Artist>;
+declare const getArtistSongs: (params: ArtistSongsParams, options?: RequestOptions) => Promise<Song[]>;
+declare const getArtistTopSongs: (id: number, options?: RequestOptions) => Promise<Song[]>;
+declare const getArtistAlbums: (params: ArtistAlbumsParams, options?: RequestOptions) => Promise<AlbumPage>;
+declare const getArtistList: (params: ArtistListParams, options?: RequestOptions) => Promise<ArtistPage>;
+declare const getArtistDesc: (id: number, options?: RequestOptions) => Promise<ArtistDescription>;
+declare const getArtistMvs: (params: ArtistMvsParams, options?: RequestOptions) => Promise<MvRef[]>;
+declare const getArtistVideos: (params: ArtistVideosParams, options?: RequestOptions) => Promise<ArtistVideoPage>;
 //#endregion
 //#region src/types/PlaylistDetail.d.ts
-interface PlaylistDetails {
+interface PlaylistDetail {
   id: number;
   name: string;
-  coverImgId: number;
-  coverImgUrl: string;
-  userId: number;
+  creatorId: number;
+  coverUrl: string;
   createTime: number;
   songs: {
     id: number;
     addTime: number;
   }[];
 }
-//#endregion
-//#region src/types/SongDetails.d.ts
-type SongDetail = {
-  id: number;
+interface PlaylistStats {
+  commentCount?: number;
+  shareCount?: number;
+  playCount?: number;
+  subscribedCount?: number;
+  playedCount?: number;
+}
+interface PlaylistTag {
   name: string;
-  artists: {
-    id: number;
+  hot: boolean;
+}
+interface PlaylistPage {
+  total?: number;
+  more?: boolean;
+  playlists: PlaylistSummary[];
+}
+interface PlaylistCategory {
+  name: string;
+  subcategories: {
     name: string;
+    category: number;
   }[];
-  album: {
+}
+//#endregion
+//#region src/apis/playlist.d.ts
+declare const getPlaylistDetail: (id: number, options?: RequestOptions) => Promise<PlaylistDetail>;
+declare const getPlaylistTracks: (params: PlaylistTracksParams, options?: RequestOptions) => Promise<Song[]>;
+declare const getPlaylistDetailDynamic: (id: number, options?: RequestOptions) => Promise<PlaylistStats>;
+declare const getHighQualityTags: (options?: RequestOptions) => Promise<PlaylistTag[]>;
+declare const getTopPlaylists: (params: TopPlaylistsParams, options?: RequestOptions) => Promise<PlaylistPage>;
+declare const getHighQualityPlaylists: (params: HighQualityPlaylistsParams, options?: RequestOptions) => Promise<PlaylistPage>;
+declare const getPlaylistCategories: (options?: RequestOptions) => Promise<PlaylistCategory[]>;
+declare const getRelatedPlaylists: (id: number, options?: RequestOptions) => Promise<PlaylistSummary[]>;
+//#endregion
+//#region src/types/Lyric.d.ts
+interface Lyric {
+  lines: LyricLine[];
+  translator?: {
     id: number;
-    name: string;
-    picUrl: string;
+    nickname: string;
   };
-  duration: number;
+}
+type LyricLine = {
+  time: number;
+  text: string;
+  translation?: string;
 };
+interface WordLine {
+  time: number;
+  duration: number;
+  words: {
+    time: number;
+    duration: number;
+    text: string;
+  }[];
+}
+interface LyricNew {
+  lines: LyricLine[];
+  wordLines?: WordLine[];
+  romaLines?: LyricLine[];
+}
+//#endregion
+//#region src/types/SongDetails.d.ts
+type SongDetail = Song;
+interface MusicAvailability {
+  available: boolean;
+  message: string;
+}
+//#endregion
+//#region src/apis/song.d.ts
+declare const getSongsDetail: (ids: number[], options?: RequestOptions) => Promise<SongDetail[]>;
+declare const getSongUrl: (params: SongUrlParams, options?: RequestOptions) => Promise<SongUrl[]>;
+declare const getLyric: (id: number, options?: RequestOptions) => Promise<Lyric>;
+declare const getLyricNew: (id: number, options?: RequestOptions) => Promise<LyricNew>;
+declare const checkMusic: (params: CheckMusicParams, options?: RequestOptions) => Promise<MusicAvailability>;
+declare const getSimilarSongs: (id: number, options?: RequestOptions) => Promise<Song[]>;
+//#endregion
+//#region src/apis/search.d.ts
+declare const search: (params: SearchParams, options?: RequestOptions) => Promise<SearchResult>;
+declare const cloudSearch: (params: SearchParams, options?: RequestOptions) => Promise<SearchResult>;
+declare const getSearchSuggest: (params: SearchSuggestParams, options?: RequestOptions) => Promise<SearchSuggest>;
+declare const getHotSearches: (options?: RequestOptions) => Promise<HotSearchGroup[]>;
+declare const getHotSearchDetail: (options?: RequestOptions) => Promise<HotSearchItem[]>;
+declare const getDefaultSearchKeyword: (options?: RequestOptions) => Promise<string>;
+declare const searchMultimatch: (params: SearchMultimatchParams, options?: RequestOptions) => Promise<SearchResult>;
+//#endregion
+//#region src/errors.d.ts
+declare class NeteaseApiError extends Error {
+  readonly code: number;
+  readonly uri: string;
+  readonly status: number;
+  readonly body: unknown;
+  constructor(uri: string, code: number, status: number, body: unknown);
+}
 //#endregion
 //#region src/index.d.ts
-declare const getPlaylistDetail: (id: number) => Promise<PlaylistDetails>;
-declare const getLyric: (id: number) => Promise<Lyric>;
-declare const getSongsDetail: (ids: number[]) => Promise<SongDetail[]>;
 declare const _default: {
-  getPlaylistDetail: (id: number) => Promise<PlaylistDetails>;
-  getLyric: (id: number) => Promise<Lyric>;
-  getSongsDetail: (ids: number[]) => Promise<SongDetail[]>;
+  search: (params: SearchParams, options?: RequestOptions) => Promise<SearchResult>;
+  cloudSearch: (params: SearchParams, options?: RequestOptions) => Promise<SearchResult>;
+  getSearchSuggest: (params: SearchSuggestParams, options?: RequestOptions) => Promise<SearchSuggest>;
+  getHotSearches: (options?: RequestOptions) => Promise<HotSearchGroup[]>;
+  getHotSearchDetail: (options?: RequestOptions) => Promise<HotSearchItem[]>;
+  getDefaultSearchKeyword: (options?: RequestOptions) => Promise<string>;
+  searchMultimatch: (params: SearchMultimatchParams, options?: RequestOptions) => Promise<SearchResult>;
+  getSongsDetail: (ids: number[], options?: RequestOptions) => Promise<SongDetail[]>;
+  getSongUrl: (params: SongUrlParams, options?: RequestOptions) => Promise<SongUrl[]>;
+  getLyric: (id: number, options?: RequestOptions) => Promise<Lyric>;
+  getLyricNew: (id: number, options?: RequestOptions) => Promise<LyricNew>;
+  checkMusic: (params: CheckMusicParams, options?: RequestOptions) => Promise<MusicAvailability>;
+  getSimilarSongs: (id: number, options?: RequestOptions) => Promise<Song[]>;
+  getPlaylistDetail: (id: number, options?: RequestOptions) => Promise<PlaylistDetail>;
+  getPlaylistTracks: (params: PlaylistTracksParams, options?: RequestOptions) => Promise<Song[]>;
+  getPlaylistDetailDynamic: (id: number, options?: RequestOptions) => Promise<PlaylistStats>;
+  getHighQualityTags: (options?: RequestOptions) => Promise<PlaylistTag[]>;
+  getTopPlaylists: (params: TopPlaylistsParams, options?: RequestOptions) => Promise<PlaylistPage>;
+  getHighQualityPlaylists: (params: HighQualityPlaylistsParams, options?: RequestOptions) => Promise<PlaylistPage>;
+  getPlaylistCategories: (options?: RequestOptions) => Promise<PlaylistCategory[]>;
+  getRelatedPlaylists: (id: number, options?: RequestOptions) => Promise<PlaylistSummary[]>;
+  getArtist: (id: number, options?: RequestOptions) => Promise<Artist>;
+  getArtistDetail: (id: number, options?: RequestOptions) => Promise<Artist>;
+  getArtistSongs: (params: ArtistSongsParams, options?: RequestOptions) => Promise<Song[]>;
+  getArtistTopSongs: (id: number, options?: RequestOptions) => Promise<Song[]>;
+  getArtistAlbums: (params: ArtistAlbumsParams, options?: RequestOptions) => Promise<AlbumPage>;
+  getArtistList: (params: ArtistListParams, options?: RequestOptions) => Promise<ArtistPage>;
+  getArtistDesc: (id: number, options?: RequestOptions) => Promise<ArtistDescription>;
+  getArtistMvs: (params: ArtistMvsParams, options?: RequestOptions) => Promise<MvRef[]>;
+  getArtistVideos: (params: ArtistVideosParams, options?: RequestOptions) => Promise<ArtistVideoPage>;
+  getAlbum: (id: number, options?: RequestOptions) => Promise<Album>;
+  getAlbumProduct: (id: number, options?: RequestOptions) => Promise<AlbumProduct>;
+  getAlbumDynamic: (id: number, options?: RequestOptions) => Promise<AlbumStats>;
+  getAlbumSaleBoard: (params: AlbumSaleBoardParams, options?: RequestOptions) => Promise<AlbumSaleBoard>;
+  getAlbumPrivileges: (id: number, options?: RequestOptions) => Promise<AlbumPrivilege[]>;
+  getAlbumList: (params: AlbumListParams, options?: RequestOptions) => Promise<AlbumPage>;
+  getNewestAlbums: (options?: RequestOptions) => Promise<Album[]>;
 };
 //#endregion
-export { _default as default, getLyric, getPlaylistDetail, getSongsDetail };
+export { type Album, type AlbumListParams, type AlbumPage, type AlbumPrivilege, type AlbumProduct, type AlbumRef, type AlbumSaleBoard, type AlbumSaleBoardParams, type AlbumStats, type Artist, type ArtistAlbumsParams, type ArtistDescription, type ArtistListParams, type ArtistMvsParams, type ArtistPage, type ArtistRef, type ArtistSongsParams, type ArtistVideoPage, type ArtistVideosParams, type CheckMusicParams, type Crypto, type HighQualityPlaylistsParams, type HotSearchGroup, type HotSearchItem, type Lyric, type LyricLine, type LyricNew, type MusicAvailability, type MvRef, NeteaseApiError, type PlaylistCategory, type PlaylistDetail, type PlaylistPage, type PlaylistStats, type PlaylistSummary, type PlaylistTag, type PlaylistTracksParams, type RequestOptions, type SearchLyric, type SearchMultimatchParams, type SearchParams, type SearchRadio, type SearchResult, type SearchSuggest, type SearchSuggestParams, type SearchType, type Song, type SongDetail, type SongUrl, type SongUrlParams, type TopPlaylistsParams, type UserRef, type VideoRef, type WordLine, checkMusic, cloudSearch, _default as default, getAlbum, getAlbumDynamic, getAlbumList, getAlbumPrivileges, getAlbumProduct, getAlbumSaleBoard, getArtist, getArtistAlbums, getArtistDesc, getArtistDetail, getArtistList, getArtistMvs, getArtistSongs, getArtistTopSongs, getArtistVideos, getDefaultSearchKeyword, getHighQualityPlaylists, getHighQualityTags, getHotSearchDetail, getHotSearches, getLyric, getLyricNew, getNewestAlbums, getPlaylistCategories, getPlaylistDetail, getPlaylistDetailDynamic, getPlaylistTracks, getRelatedPlaylists, getSearchSuggest, getSimilarSongs, getSongUrl, getSongsDetail, getTopPlaylists, request, search, searchMultimatch };