refactor(api)!: 平台 id 改两字母短码——qian→bd、joox→jx、5sing→5s、bili→bl

对外 id 统一为两字母短码,与既有的 kw/kg/tx/wy/qs/xm/me/qt/lr 对齐;
migu 与 apple 保持原样(Apple Music 没有自然的短码)。

**破坏性变更**:id 出现在所有 URL、/sources 返回、OpenAPI 示例以及
data/auth.json 的凭据键里,这四个平台已存的登录态会失效,需重新登录。

- sdk/index.ts:id 与 supportQuality 映射键
- sdk/types.ts:Source 联合类型
- src/routes.ts 与 routes-login.ts:路由路径与 schema 描述
  (/login/bili/qr → /login/bl/qr 等)、/login/status 的响应键
- test/smoke-test.ts、README.md、docs/API.md 同步

有意未改:sdk 目录与文件名仍用平台名(sdk/qian/、sdk/apis/joox.ts …),
规则定为「目录=平台名,id=对外短码」,映射只在 SUPPORTED_SOURCES 一处声明。
域名与正则(joox.com、5sing.kugou.com、/joox\.com\//)、jooxSign 等标识符、
错误文案里的中文平台名、以及 kg 榜单名(含「joox本地热歌榜」)全部保持原样——
它们只是恰好含平台名,并不是 id。

验证:typecheck ✓、pnpm test 112/112 ✓;另起临时实例实证 /sources 与
/login/status 的新 id 与展示名,新旧 id 均无残留。
This commit is contained in:
snowy-yang committed 2026-10-03 11:03:06 +08:00
1 parent 14f7295fd4
commit 3381e9b906
33 files changed
+155 -155

No files matched your search

+5 -5
View File
@@ -40,7 +40,7 @@ const fetchAlbumTracks = async(albumId: string, page: number, limit: number) =>
const total = firstNonZero(body?.tracks?.total_count, body?.tracks?.list_count, list.length)
return {
source: 'joox' as const,
source: 'jx' as const,
info: {
name: String(firstNonEmpty(body?.name, albumId)),
img: pickJooxImage(body?.images) || null,
@@ -95,7 +95,7 @@ export const getAlbumDetailFromPage = async(rawId: string, page = 1, limit = 50)
const total = firstNonZero(albumData?.trackList?.total_count, albumData?.trackList?.list_count, items.length)
return {
source: 'joox' as const,
source: 'jx' as const,
info: {
name: String(firstNonEmpty(albumData?.title, albumId)),
img: cover || null,
@@ -120,7 +120,7 @@ export const searchAlbum = async(keyword: string, page = 1, limit = 20) => {
const url = `${SEARCH_URL}?country=sg&lang=zh_cn&keyword=${encodeURIComponent(String(keyword ?? ''))}`
const { statusCode, body } = await httpFetch(url, { headers: jooxHeaders(), timeout: 20000 }).promise as any
if (statusCode != 200 || !body?.section_list) {
return { list: [], total: 0, page, limit, source: 'joox' as const }
return { list: [], total: 0, page, limit, source: 'jx' as const }
}
const list: any[] = []
@@ -142,12 +142,12 @@ export const searchAlbum = async(keyword: string, page = 1, limit = 20) => {
publishDate: String(album.publish_date ?? '').trim(),
trackCount: 0,
link: jooxAlbumLink(id),
source: 'joox' as const,
source: 'jx' as const,
})
}
}
return { list: list.slice(0, limit), total: list.length, page, limit, source: 'joox' as const }
return { list: list.slice(0, limit), total: list.length, page, limit, source: 'jx' as const }
}
/** 专辑链接解析(上游 ParseAlbum) */
+3 -3
View File
@@ -7,7 +7,7 @@
// - 取流/歌曲详情/专辑曲目/歌单曲目:cache.api.joox.com/openjoox2/v1(需 md5 签名,见 util.jooxSign)
// - 歌词:api.joox.com/web-fcgi-bin/web_lyric(旧接口仍可用;失败回退 openjoox2 lrc_content)
// - 分类/歌单/专辑 SSR 兜底:www.joox.com __NEXT_DATA__
// 上游 New(cookie):默认游客 Cookie 来自 joox.go 常量;/login/joox 绑定后从 sdk/auth/store.ts 读取,
// 上游 New(cookie):默认游客 Cookie 来自 joox.go 常量;/login/jx 绑定后从 sdk/auth/store.ts 读取,
// 登录 cookie 的 wmid/session_key 会作为 uid/usk 参与 openjoox2 签名(VIP 完整曲目依赖它)。
// userPlaylist:上游 joox/user_playlist.go 返回 ErrUserPlaylistsUnsupported,未实现(不造)。
import jooxApi from '../apis/joox.ts'
@@ -35,7 +35,7 @@ const joox = {
album,
playlist,
// 契约别名:JOOX 的「分类/列表」能力即 playlist.go 的歌单分类,没有独立的 songList 接口,
// 这里把同一套分类/分类歌单挂到 songList 键,便于 /song-list/joox 路由复用。
// 这里把同一套分类/分类歌单挂到 songList 键,便于 /song-list/jx 路由复用。
songList: {
sortList: [{ name: '全部', id: '' }],
getTags() {
@@ -53,7 +53,7 @@ const joox = {
/** 登录状态(凭据存在性判断;无在线校验接口) */
export const status = () => {
const cred = getCredentials('joox') as { cookie?: string, updatedAt?: string } | null
const cred = getCredentials('jx') as { cookie?: string, updatedAt?: string } | null
return cred?.cookie
? { logged: true, updatedAt: cred.updatedAt }
: { logged: false }
+2 -2
View File
@@ -14,7 +14,7 @@ export const search = async(keyword: string, page = 1, limit = 20) => {
const url = `${SEARCH_URL}?country=sg&lang=zh_cn&keyword=${encodeURIComponent(String(keyword ?? ''))}`
const { statusCode, body } = await httpFetch(url, { headers: jooxHeaders(), timeout: 20000 }).promise as any
if (statusCode != 200 || !body?.section_list) {
return { list: [], allPage: 0, total: 0, limit, source: 'joox' as const }
return { list: [], allPage: 0, total: 0, limit, source: 'jx' as const }
}
const list: any[] = []
@@ -35,7 +35,7 @@ export const search = async(keyword: string, page = 1, limit = 20) => {
allPage: 1,
total: list.length,
limit,
source: 'joox' as const,
source: 'jx' as const,
}
}
+8 -8
View File
@@ -39,7 +39,7 @@ const mapPlaylistSummary = (item: any) => {
creator: '',
description: '',
link: jooxPlaylistLink(id),
source: 'joox' as const,
source: 'jx' as const,
}
}
@@ -60,7 +60,7 @@ const fetchPlaylistTracks = async(playlistId: string, page: number, limit: numbe
const total = firstNonZero(body?.tracks?.total_count, body?.tracks?.list_count, body?.track_count, list.length)
return {
source: 'joox' as const,
source: 'jx' as const,
info: {
name: String(firstNonEmpty(body?.name, playlistId)),
img: pickJooxImage(body?.images) || null,
@@ -136,7 +136,7 @@ export const getPlaylistDetailFromPage = async(rawId: string) => {
.filter(Boolean)
if (!list.length) throw new Error('joox 歌单无歌曲')
return {
source: 'joox' as const,
source: 'jx' as const,
info: {
name: String(parsed.name || pageId),
img: cover || null,
@@ -185,7 +185,7 @@ export const searchPlaylist = async(keyword: string, page = 1, limit = 20) => {
const url = `${SEARCH_URL}?country=sg&lang=zh_cn&keyword=${encodeURIComponent(String(keyword ?? ''))}`
const { statusCode, body } = await httpFetch(url, { headers: jooxHeaders(), timeout: 20000 }).promise as any
if (statusCode != 200 || !body?.section_list) {
return { list: [], total: 0, page, limit, source: 'joox' as const }
return { list: [], total: 0, page, limit, source: 'jx' as const }
}
const list: any[] = []
@@ -200,7 +200,7 @@ export const searchPlaylist = async(keyword: string, page = 1, limit = 20) => {
}
}
return { list: list.slice(0, limit), total: list.length, page, limit, source: 'joox' as const }
return { list: list.slice(0, limit), total: list.length, page, limit, source: 'jx' as const }
}
/** 歌单分类页原始数据(上游 fetchJooxPlaylistCategoriesPage) */
@@ -230,7 +230,7 @@ export const getCategories = async() => {
list.push({ id: String(index), name, group: 'JOOX', hot: false, count: items.length })
})
if (list.length === 1) throw new Error('joox 歌单分类不存在')
return { source: 'joox' as const, list }
return { source: 'jx' as const, list }
}
/** 分类下歌单(上游 GetCategoryPlaylists) */
@@ -282,13 +282,13 @@ export const getCategoryPlaylists = async(categoryId = '', page = 1, limit = 20)
link: jooxPlaylistLink(id),
categoryId: cid,
categoryName,
source: 'joox' as const,
source: 'jx' as const,
}
})
.filter(Boolean)
if (!list.length) throw new Error('joox 分类下无歌单')
return { list, total: items.length, page, limit, source: 'joox' as const }
return { list, total: items.length, page, limit, source: 'jx' as const }
}
/** 歌单链接解析(上游 ParsePlaylist) */
+2 -2
View File
@@ -45,7 +45,7 @@ export const jooxSongFromTrack = (
vip: Number(item?.vip_flag ?? 0) === 1,
types: [],
_types: {},
source: 'joox' as const,
source: 'jx' as const,
}
}
@@ -65,7 +65,7 @@ export const jooxSongFromDetail = (detail: any, playUrl = ''): any => {
lrc: null,
types: [],
_types: {},
source: 'joox' as const,
source: 'jx' as const,
}
if (playUrl) song.url = playUrl
song.vip = Number(detail?.vip_flag ?? 0) === 1
+1 -1
View File
@@ -33,7 +33,7 @@ export const jooxSign = (params: Record<string, any>): string =>
/** 绑定到 sdk/auth/store.ts 的登录 cookie(未登录返回空串,不回退游客 cookie) */
export const jooxLoginCookie = (): string => {
const cred = getCredentials('joox') as { cookie?: string } | null
const cred = getCredentials('jx') as { cookie?: string } | null
return cred?.cookie || ''
}