hana-music-api 1.0.0

package/README.md

@@ -0,0 +1,109 @@
+# hana-music-api
+
+`hana-music-api` 是一个第三方网易云音乐 API 库，可直接在代码里调用，也可以作为 Bun 服务自行部署。
+
+## 安装
+
+```bash
+npm install hana-music-api
+```
+
+SDK 运行环境：
+
+- Node.js `>=24`
+- ESM 项目
+
+## 直接调用
+
+最省事的方式是先创建一个 client：
+
+```ts
+import { createHanaMusicApi } from 'hana-music-api'
+
+const hana = createHanaMusicApi({
+  cookie: 'MUSIC_U=your-cookie',
+})
+
+const result = await hana.search({
+  keywords: '周杰伦',
+  limit: 5,
+})
+
+console.log(result.body)
+```
+
+如果你只想调少量接口，也可以直接导入单个函数：
+
+```ts
+import { songUrl } from 'hana-music-api'
+
+const result = await songUrl(
+  {
+    id: '347230',
+  },
+  {
+    cookie: 'MUSIC_U=your-cookie',
+  },
+)
+
+console.log(result.body)
+```
+
+如果模块名来自运行时字符串，可以用 `invokeModule()`：
+
+```ts
+import { invokeModule } from 'hana-music-api'
+
+const result = await invokeModule(
+  'user_account',
+  {},
+  {
+    cookie: 'MUSIC_U=your-cookie',
+  },
+)
+
+console.log(result.body)
+```
+
+## 启动 HTTP 服务
+
+如果你想自己部署服务，可以直接运行仓库里的 Bun 服务：
+
+```bash
+bun install --frozen-lockfile
+bun start
+```
+
+默认地址：
+
+- 服务首页：`http://127.0.0.1:3021/`
+- 文档：`http://127.0.0.1:3021/docs`
+- 健康检查：`http://127.0.0.1:3021/health`
+
+快速试一下：
+
+```bash
+curl "http://127.0.0.1:3021/search?keywords=周杰伦&limit=5"
+```
+
+## 常用入口
+
+- `createHanaMusicApi()`：适合连续调用多个接口
+- camelCase 原始函数：适合按需导入少量接口
+- `invokeModule()`：适合动态模块名场景
+
+## 常见注意事项
+
+- 账号信息、歌单管理、云盘、私信、签到这类接口通常需要有效 Cookie
+- SDK 调用时，把 `cookie`、`proxy`、`fetcher` 这类执行配置放到 `config`，不要混进业务参数
+- 轮询二维码状态、刷新登录状态这类请求，建议带上时间戳，避免拿到缓存结果
+- 如果遇到区域限制或 `460` 一类问题，可以尝试 `proxy` 或 `realIP`
+- 这是第三方非官方实现，少数接口会跟着网易云上游变化
+
+## 文档
+
+- 快速开始：[docs/guide/getting-started.md](/Users/nonhana/code_life/Campanula/hana-music-api.omx-worktrees/sdk-release-exec/docs/guide/getting-started.md:1)
+- 编程式调用：[docs/guide/programmatic-api.md](/Users/nonhana/code_life/Campanula/hana-music-api.omx-worktrees/sdk-release-exec/docs/guide/programmatic-api.md:1)
+- 认证机制：[docs/guide/authentication.md](/Users/nonhana/code_life/Campanula/hana-music-api.omx-worktrees/sdk-release-exec/docs/guide/authentication.md:1)
+- 调用约定：[docs/guide/request-convention.md](/Users/nonhana/code_life/Campanula/hana-music-api.omx-worktrees/sdk-release-exec/docs/guide/request-convention.md:1)
+- API 参考：[docs/api/index.md](/Users/nonhana/code_life/Campanula/hana-music-api.omx-worktrees/sdk-release-exec/docs/api/index.md:1)

package/dist/api/activate_init_profile.d.ts

@@ -0,0 +1,2 @@
+import { n as activateInitProfile } from "../client.generated.js";
+export { activateInitProfile };

package/dist/api/activate_init_profile.js

@@ -0,0 +1,2 @@
+import { t as activateInitProfile } from "../client.generated.js";
+export { activateInitProfile };

package/dist/api/aidj_content_rcmd.d.ts

@@ -0,0 +1,2 @@
+import { r as aidjContentRcmd } from "../client.generated.js";
+export { aidjContentRcmd };

package/dist/api/aidj_content_rcmd.js

@@ -0,0 +1,2 @@
+import { n as aidjContentRcmd } from "../client.generated.js";
+export { aidjContentRcmd };

package/dist/api/album.d.ts

@@ -0,0 +1,2 @@
+import { i as album } from "../client.generated.js";
+export { album };

package/dist/api/album.js

@@ -0,0 +1,2 @@
+import { r as album } from "../client.generated.js";
+export { album };

package/dist/api/album_detail.d.ts

@@ -0,0 +1,2 @@
+import { a as albumDetail } from "../client.generated.js";
+export { albumDetail };

package/dist/api/album_detail.js

@@ -0,0 +1,2 @@
+import { i as albumDetail } from "../client.generated.js";
+export { albumDetail };

package/dist/api/album_detail_dynamic.d.ts

@@ -0,0 +1,2 @@
+import { o as albumDetailDynamic } from "../client.generated.js";
+export { albumDetailDynamic };

package/dist/api/album_detail_dynamic.js

@@ -0,0 +1,2 @@
+import { a as albumDetailDynamic } from "../client.generated.js";
+export { albumDetailDynamic };

package/dist/api/album_list.d.ts

@@ -0,0 +1,2 @@
+import { s as albumList } from "../client.generated.js";
+export { albumList };

package/dist/api/album_list.js

@@ -0,0 +1,2 @@
+import { o as albumList } from "../client.generated.js";
+export { albumList };

package/dist/api/album_list_style.d.ts

@@ -0,0 +1,2 @@
+import { c as albumListStyle } from "../client.generated.js";
+export { albumListStyle };

package/dist/api/album_list_style.js

@@ -0,0 +1,2 @@
+import { s as albumListStyle } from "../client.generated.js";
+export { albumListStyle };

package/dist/api/album_new.d.ts

@@ -0,0 +1,2 @@
+import { l as albumNew } from "../client.generated.js";
+export { albumNew };

package/dist/api/album_new.js

@@ -0,0 +1,2 @@
+import { c as albumNew } from "../client.generated.js";
+export { albumNew };

package/dist/api/album_newest.d.ts

@@ -0,0 +1,2 @@
+import { u as albumNewest } from "../client.generated.js";
+export { albumNewest };

package/dist/api/album_newest.js

@@ -0,0 +1,2 @@
+import { l as albumNewest } from "../client.generated.js";
+export { albumNewest };

package/dist/api/album_privilege.d.ts

@@ -0,0 +1,2 @@
+import { d as albumPrivilege } from "../client.generated.js";
+export { albumPrivilege };

package/dist/api/album_privilege.js

@@ -0,0 +1,2 @@
+import { u as albumPrivilege } from "../client.generated.js";
+export { albumPrivilege };

package/dist/api/album_songsaleboard.d.ts

@@ -0,0 +1,2 @@
+import { f as albumSongsaleboard } from "../client.generated.js";
+export { albumSongsaleboard };

package/dist/api/album_songsaleboard.js

@@ -0,0 +1,2 @@
+import { d as albumSongsaleboard } from "../client.generated.js";
+export { albumSongsaleboard };

package/dist/api/album_sub.d.ts

@@ -0,0 +1,2 @@
+import { p as albumSub } from "../client.generated.js";
+export { albumSub };

package/dist/api/album_sub.js

@@ -0,0 +1,2 @@
+import { f as albumSub } from "../client.generated.js";
+export { albumSub };

package/dist/api/album_sublist.d.ts

@@ -0,0 +1,2 @@
+import { m as albumSublist } from "../client.generated.js";
+export { albumSublist };

package/dist/api/album_sublist.js

@@ -0,0 +1,2 @@
+import { p as albumSublist } from "../client.generated.js";
+export { albumSublist };

package/dist/api/artist_album.d.ts

@@ -0,0 +1,2 @@
+import { h as artistAlbum } from "../client.generated.js";
+export { artistAlbum };

package/dist/api/artist_album.js

@@ -0,0 +1,2 @@
+import { m as artistAlbum } from "../client.generated.js";
+export { artistAlbum };

package/dist/api/artist_desc.d.ts

@@ -0,0 +1,2 @@
+import { g as artistDesc } from "../client.generated.js";
+export { artistDesc };

package/dist/api/artist_desc.js

@@ -0,0 +1,2 @@
+import { h as artistDesc } from "../client.generated.js";
+export { artistDesc };

package/dist/api/artist_detail.d.ts

@@ -0,0 +1,2 @@
+import { _ as artistDetail } from "../client.generated.js";
+export { artistDetail };

package/dist/api/artist_detail.js

@@ -0,0 +1,2 @@
+import { g as artistDetail } from "../client.generated.js";
+export { artistDetail };

package/dist/api/artist_detail_dynamic.d.ts

@@ -0,0 +1,2 @@
+import { v as artistDetailDynamic } from "../client.generated.js";
+export { artistDetailDynamic };

package/dist/api/artist_detail_dynamic.js

@@ -0,0 +1,2 @@
+import { _ as artistDetailDynamic } from "../client.generated.js";
+export { artistDetailDynamic };

package/dist/api/artist_fans.d.ts

@@ -0,0 +1,2 @@
+import { y as artistFans } from "../client.generated.js";
+export { artistFans };

package/dist/api/artist_fans.js

@@ -0,0 +1,2 @@
+import { v as artistFans } from "../client.generated.js";
+export { artistFans };

package/dist/api/artist_follow_count.d.ts

@@ -0,0 +1,2 @@
+import { b as artistFollowCount } from "../client.generated.js";
+export { artistFollowCount };

package/dist/api/artist_follow_count.js

@@ -0,0 +1,2 @@
+import { y as artistFollowCount } from "../client.generated.js";
+export { artistFollowCount };

package/dist/api/artist_list.d.ts

@@ -0,0 +1,2 @@
+import { x as artistList } from "../client.generated.js";
+export { artistList };

package/dist/api/artist_list.js

@@ -0,0 +1,2 @@
+import { b as artistList } from "../client.generated.js";
+export { artistList };

package/dist/api/artist_mv.d.ts

@@ -0,0 +1,2 @@
+import { S as artistMv } from "../client.generated.js";
+export { artistMv };

package/dist/api/artist_mv.js

@@ -0,0 +1,2 @@
+import { x as artistMv } from "../client.generated.js";
+export { artistMv };

package/dist/api/artist_new_mv.d.ts

@@ -0,0 +1,2 @@
+import { C as artistNewMv } from "../client.generated.js";
+export { artistNewMv };

package/dist/api/artist_new_mv.js

@@ -0,0 +1,2 @@
+import { S as artistNewMv } from "../client.generated.js";
+export { artistNewMv };

package/dist/api/artist_new_song.d.ts

@@ -0,0 +1,2 @@
+import { w as artistNewSong } from "../client.generated.js";
+export { artistNewSong };

package/dist/api/artist_new_song.js

@@ -0,0 +1,2 @@
+import { C as artistNewSong } from "../client.generated.js";
+export { artistNewSong };

package/dist/api/artist_songs.d.ts

@@ -0,0 +1,2 @@
+import { T as artistSongs } from "../client.generated.js";
+export { artistSongs };

package/dist/api/artist_songs.js

@@ -0,0 +1,2 @@
+import { w as artistSongs } from "../client.generated.js";
+export { artistSongs };

package/dist/api/artist_sub.d.ts

@@ -0,0 +1,2 @@
+import { E as artistSub } from "../client.generated.js";
+export { artistSub };

package/dist/api/artist_sub.js

@@ -0,0 +1,2 @@
+import { T as artistSub } from "../client.generated.js";
+export { artistSub };

package/dist/api/artist_sublist.d.ts

@@ -0,0 +1,2 @@
+import { D as artistSublist } from "../client.generated.js";
+export { artistSublist };

package/dist/api/artist_sublist.js

@@ -0,0 +1,2 @@
+import { E as artistSublist } from "../client.generated.js";
+export { artistSublist };

package/dist/api/artist_top_song.d.ts

@@ -0,0 +1,2 @@
+import { O as artistTopSong } from "../client.generated.js";
+export { artistTopSong };

package/dist/api/artist_top_song.js

@@ -0,0 +1,2 @@
+import { D as artistTopSong } from "../client.generated.js";
+export { artistTopSong };

package/dist/api/artist_video.d.ts

@@ -0,0 +1,2 @@
+import { k as artistVideo } from "../client.generated.js";
+export { artistVideo };

package/dist/api/artist_video.js

@@ -0,0 +1,2 @@
+import { O as artistVideo } from "../client.generated.js";
+export { artistVideo };

package/dist/api/artists.d.ts

@@ -0,0 +1,2 @@
+import { A as artists } from "../client.generated.js";
+export { artists };

package/dist/api/artists.js

@@ -0,0 +1,2 @@
+import { k as artists } from "../client.generated.js";
+export { artists };

package/dist/api/audio_match.d.ts

@@ -0,0 +1,2 @@
+import { j as audioMatch } from "../client.generated.js";
+export { audioMatch };

package/dist/api/audio_match.js

@@ -0,0 +1,2 @@
+import { A as audioMatch } from "../client.generated.js";
+export { audioMatch };

package/dist/api/avatar_upload.d.ts

@@ -0,0 +1,2 @@
+import { M as avatarUpload } from "../client.generated.js";
+export { avatarUpload };

package/dist/api/avatar_upload.js

@@ -0,0 +1,2 @@
+import { j as avatarUpload } from "../client.generated.js";
+export { avatarUpload };

package/dist/api/banner.d.ts

@@ -0,0 +1,2 @@
+import { N as banner } from "../client.generated.js";
+export { banner };

package/dist/api/banner.js

@@ -0,0 +1,2 @@
+import { M as banner } from "../client.generated.js";
+export { banner };

package/dist/api/batch.d.ts

@@ -0,0 +1,2 @@
+import { P as batch } from "../client.generated.js";
+export { batch };

package/dist/api/batch.js

@@ -0,0 +1,2 @@
+import { N as batch } from "../client.generated.js";
+export { batch };

package/dist/api/broadcast_category_region_get.d.ts

@@ -0,0 +1,2 @@
+import { F as broadcastCategoryRegionGet } from "../client.generated.js";
+export { broadcastCategoryRegionGet };

package/dist/api/broadcast_category_region_get.js

@@ -0,0 +1,2 @@
+import { P as broadcastCategoryRegionGet } from "../client.generated.js";
+export { broadcastCategoryRegionGet };

package/dist/api/broadcast_channel_collect_list.d.ts

@@ -0,0 +1,2 @@
+import { I as broadcastChannelCollectList } from "../client.generated.js";
+export { broadcastChannelCollectList };

package/dist/api/broadcast_channel_collect_list.js

@@ -0,0 +1,2 @@
+import { F as broadcastChannelCollectList } from "../client.generated.js";
+export { broadcastChannelCollectList };

package/dist/api/broadcast_channel_currentinfo.d.ts

@@ -0,0 +1,2 @@
+import { L as broadcastChannelCurrentinfo } from "../client.generated.js";
+export { broadcastChannelCurrentinfo };

package/dist/api/broadcast_channel_currentinfo.js

@@ -0,0 +1,2 @@
+import { I as broadcastChannelCurrentinfo } from "../client.generated.js";
+export { broadcastChannelCurrentinfo };

package/dist/api/broadcast_channel_list.d.ts

@@ -0,0 +1,2 @@
+import { R as broadcastChannelList } from "../client.generated.js";
+export { broadcastChannelList };

package/dist/api/broadcast_channel_list.js

@@ -0,0 +1,2 @@
+import { L as broadcastChannelList } from "../client.generated.js";
+export { broadcastChannelList };

package/dist/api/broadcast_sub.d.ts

@@ -0,0 +1,2 @@
+import { z as broadcastSub } from "../client.generated.js";
+export { broadcastSub };

package/dist/api/broadcast_sub.js

@@ -0,0 +1,2 @@
+import { R as broadcastSub } from "../client.generated.js";
+export { broadcastSub };

package/dist/api/calendar.d.ts

@@ -0,0 +1,2 @@
+import { B as calendar } from "../client.generated.js";
+export { calendar };

package/dist/api/calendar.js

@@ -0,0 +1,2 @@
+import { z as calendar } from "../client.generated.js";
+export { calendar };

package/dist/api/captcha_sent.d.ts

@@ -0,0 +1,2 @@
+import { V as captchaSent } from "../client.generated.js";
+export { captchaSent };

package/dist/api/captcha_sent.js

@@ -0,0 +1,2 @@
+import { B as captchaSent } from "../client.generated.js";
+export { captchaSent };

package/dist/api/captcha_verify.d.ts

@@ -0,0 +1,2 @@
+import { H as captchaVerify } from "../client.generated.js";
+export { captchaVerify };

package/dist/api/captcha_verify.js

@@ -0,0 +1,2 @@
+import { V as captchaVerify } from "../client.generated.js";
+export { captchaVerify };

package/dist/api/cellphone_existence_check.d.ts

@@ -0,0 +1,2 @@
+import { U as cellphoneExistenceCheck } from "../client.generated.js";
+export { cellphoneExistenceCheck };

package/dist/api/cellphone_existence_check.js

@@ -0,0 +1,2 @@
+import { H as cellphoneExistenceCheck } from "../client.generated.js";
+export { cellphoneExistenceCheck };

package/dist/api/check_music.d.ts

@@ -0,0 +1,2 @@
+import { W as checkMusic } from "../client.generated.js";
+export { checkMusic };

package/dist/api/check_music.js

@@ -0,0 +1,2 @@
+import { U as checkMusic } from "../client.generated.js";
+export { checkMusic };

package/dist/api/cloud.d.ts

@@ -0,0 +1,2 @@
+import { G as cloud } from "../client.generated.js";
+export { cloud };

package/dist/api/cloud.js

@@ -0,0 +1,2 @@
+import { W as cloud } from "../client.generated.js";
+export { cloud };

package/dist/api/cloud_import.d.ts

@@ -0,0 +1,2 @@
+import { K as cloudImport } from "../client.generated.js";
+export { cloudImport };

package/dist/api/cloud_import.js

@@ -0,0 +1,2 @@
+import { G as cloudImport } from "../client.generated.js";
+export { cloudImport };

package/dist/api/cloud_match.d.ts

@@ -0,0 +1,2 @@
+import { q as cloudMatch } from "../client.generated.js";
+export { cloudMatch };

package/dist/api/cloud_match.js

@@ -0,0 +1,2 @@
+import { K as cloudMatch } from "../client.generated.js";
+export { cloudMatch };

package/dist/api/cloudsearch.d.ts

@@ -0,0 +1,2 @@
+import { J as cloudsearch } from "../client.generated.js";
+export { cloudsearch };

package/dist/api/cloudsearch.js

@@ -0,0 +1,2 @@
+import { q as cloudsearch } from "../client.generated.js";
+export { cloudsearch };

package/dist/api/comment.d.ts

@@ -0,0 +1,2 @@
+import { Y as comment } from "../client.generated.js";
+export { comment };

package/dist/api/comment.js

@@ -0,0 +1,2 @@
+import { J as comment } from "../client.generated.js";
+export { comment };

package/dist/api/comment_album.d.ts

@@ -0,0 +1,2 @@
+import { X as commentAlbum } from "../client.generated.js";
+export { commentAlbum };

package/dist/api/comment_album.js

@@ -0,0 +1,2 @@
+import { Y as commentAlbum } from "../client.generated.js";
+export { commentAlbum };

package/dist/api/comment_dj.d.ts

@@ -0,0 +1,2 @@
+import { Z as commentDj } from "../client.generated.js";
+export { commentDj };

package/dist/api/comment_dj.js

@@ -0,0 +1,2 @@
+import { X as commentDj } from "../client.generated.js";
+export { commentDj };

package/dist/api/comment_event.d.ts

@@ -0,0 +1,2 @@
+import { Q as commentEvent } from "../client.generated.js";
+export { commentEvent };

package/dist/api/comment_event.js

@@ -0,0 +1,2 @@
+import { Z as commentEvent } from "../client.generated.js";
+export { commentEvent };

package/dist/api/comment_floor.d.ts

@@ -0,0 +1,2 @@
+import { $ as commentFloor } from "../client.generated.js";
+export { commentFloor };

package/dist/api/comment_floor.js

@@ -0,0 +1,2 @@
+import { Q as commentFloor } from "../client.generated.js";
+export { commentFloor };

package/dist/api/comment_hot.d.ts

@@ -0,0 +1,2 @@
+import { et as commentHot } from "../client.generated.js";
+export { commentHot };

package/dist/api/comment_hot.js

@@ -0,0 +1,2 @@
+import { $ as commentHot } from "../client.generated.js";
+export { commentHot };

package/dist/api/comment_hug_list.d.ts

@@ -0,0 +1,2 @@
+import { tt as commentHugList } from "../client.generated.js";
+export { commentHugList };

package/dist/api/comment_hug_list.js

@@ -0,0 +1,2 @@
+import { et as commentHugList } from "../client.generated.js";
+export { commentHugList };

package/dist/api/comment_like.d.ts

@@ -0,0 +1,2 @@
+import { nt as commentLike } from "../client.generated.js";
+export { commentLike };

package/dist/api/comment_like.js

@@ -0,0 +1,2 @@
+import { tt as commentLike } from "../client.generated.js";
+export { commentLike };

package/dist/api/comment_music.d.ts

@@ -0,0 +1,2 @@
+import { rt as commentMusic } from "../client.generated.js";
+export { commentMusic };

package/dist/api/comment_music.js

@@ -0,0 +1,2 @@
+import { nt as commentMusic } from "../client.generated.js";
+export { commentMusic };

package/dist/api/comment_mv.d.ts

@@ -0,0 +1,2 @@
+import { it as commentMv } from "../client.generated.js";
+export { commentMv };

package/dist/api/comment_mv.js

@@ -0,0 +1,2 @@
+import { rt as commentMv } from "../client.generated.js";
+export { commentMv };

package/dist/api/comment_new.d.ts

@@ -0,0 +1,2 @@
+import { at as commentNew } from "../client.generated.js";
+export { commentNew };

package/dist/api/comment_new.js

@@ -0,0 +1,2 @@
+import { it as commentNew } from "../client.generated.js";
+export { commentNew };