@sansenjian/qq-music-api 2.1.1 → 2.2.1

package/module/apis/user/getUserPlaylists.ts

@@ -0,0 +1,163 @@
+import request from '../../../util/request';
+import { customResponse, errorResponse } from '../../../util/apiResponse';
+import type { ApiResponse } from '../../../types/api';
+
+interface UserPlaylistItem {
+  [key: string]: unknown;
+}
+
+const DEBUG_ENABLED = process.env.DEBUG === 'true';
+
+const debugLog = (message: string, payload?: unknown) => {
+  if (DEBUG_ENABLED) {
+    console.log(`[getUserPlaylists] ${message}`, payload ?? '');
+  }
+};
+
+const getNamedCandidateEntries = (payload: Record<string, any>) => [
+  ['data.mydiss.list', payload?.data?.mydiss?.list],
+  ['data.mymusic', payload?.data?.mymusic],
+  ['data.createdDissList', payload?.data?.createdDissList],
+  ['data.createdList', payload?.data?.createdList],
+  ['data.creator', payload?.data?.creator],
+  ['data.creator.playlist', payload?.data?.creator?.playlist],
+  ['data.creator.playlists', payload?.data?.creator?.playlists],
+  ['data.playlist', payload?.data?.playlist],
+  ['data.playlists', payload?.data?.playlists],
+  ['mydiss.list', payload?.mydiss?.list],
+  ['mymusic', payload?.mymusic],
+  ['createdDissList', payload?.createdDissList],
+  ['createdList', payload?.createdList],
+  ['creator', payload?.creator],
+  ['creator.playlist', payload?.creator?.playlist],
+  ['creator.playlists', payload?.creator?.playlists],
+  ['playlist', payload?.playlist],
+  ['playlists', payload?.playlists]
+] as const;
+
+const extractPlaylists = (payload: Record<string, any>): UserPlaylistItem[] => {
+  debugLog('payload top-level keys', Object.keys(payload || {}));
+  debugLog('payload.data keys', payload?.data && typeof payload.data === 'object' ? Object.keys(payload.data) : []);
+
+  const matchedEntry = getNamedCandidateEntries(payload).find(([, candidate]) => Array.isArray(candidate));
+
+  if (matchedEntry) {
+    const [candidatePath, playlists] = matchedEntry;
+    debugLog('matched playlist candidate', {
+      candidatePath,
+      length: (playlists as unknown[]).length
+    });
+    return playlists as UserPlaylistItem[];
+  }
+
+  debugLog(
+    'playlist candidates summary',
+    getNamedCandidateEntries(payload).map(([candidatePath, candidate]) => ({
+      candidatePath,
+      type: Array.isArray(candidate) ? 'array' : typeof candidate,
+      keys: candidate && typeof candidate === 'object' && !Array.isArray(candidate) ? Object.keys(candidate) : undefined
+    }))
+  );
+
+  throw new Error('用户歌单响应中未找到歌单列表字段');
+};
+
+const getErrorMessage = (payload: Record<string, any>): string => {
+  const candidates = [payload.message, payload.msg, payload.errmsg, payload.error];
+  const matched = candidates.find(candidate => typeof candidate === 'string' && candidate.trim() !== '');
+  return (matched as string | undefined) || '获取用户歌单失败';
+};
+
+// 获取用户创建的歌单
+// 注意：此接口需要有效的 QQ 音乐 Cookie 才能正常工作
+export const getUserPlaylists = async (params: {
+  uin: string;
+  offset?: number;
+  limit?: number;
+}): Promise<ApiResponse> => {
+  const { uin, offset = 0, limit = 30 } = params;
+
+  // 使用 c6.y.qq.com/rsc/fcgi-bin/fcg_get_profile_homepage.fcg 接口
+  // 这是通过 Chrome DevTools 抓包发现的实际使用的接口
+  const url = 'https://c6.y.qq.com/rsc/fcgi-bin/fcg_get_profile_homepage.fcg';
+  const pageOffset = offset % limit;
+
+  try {
+    debugLog('request meta', {
+      url,
+      uin,
+      offset,
+      limit,
+      pageOffset,
+      hasGlobalCookie: Boolean(global.userInfo?.cookie),
+      cookieLength: global.userInfo?.cookie?.length || 0
+    });
+
+    const response = await request<Record<string, any>>({
+      url,
+      method: 'GET',
+      isUUrl: 'u',
+      options: {
+        params: {
+          _: Date.now(),
+          cv: 4747474,
+          ct: 24,
+          format: 'json',
+          inCharset: 'utf-8',
+          outCharset: 'utf-8',
+          notice: 0,
+          platform: 'yqq.json',
+          needNewCode: 0,
+          uin: Number.parseInt(uin, 10),
+          g_tk_new_20200303: 0,
+          g_tk: 0,
+          cid: 205360838,
+          userid: Number.parseInt(uin, 10),
+          reqfrom: 1,
+          reqtype: 0,
+          hostUin: 0,
+          loginUin: Number.parseInt(uin, 10)
+        },
+        headers: {
+          Referer: `https://y.qq.com/portal/profile.html?uin=${uin}`,
+          Cookie: global.userInfo?.cookie || ''
+        }
+      }
+    });
+
+    const payload = response.data;
+
+    debugLog('upstream payload summary', {
+      topLevelKeys: payload && typeof payload === 'object' ? Object.keys(payload) : null,
+      code: payload?.code,
+      hasData: Boolean(payload?.data),
+      dataKeys: payload?.data && typeof payload.data === 'object' ? Object.keys(payload.data) : []
+    });
+
+    if (!payload || typeof payload !== 'object') {
+      debugLog('invalid payload received', payload);
+      return errorResponse('用户歌单响应格式无效', 502);
+    }
+
+    if (typeof payload.code === 'number' && payload.code !== 0) {
+      debugLog('upstream business error payload', payload);
+      return errorResponse(getErrorMessage(payload), 502);
+    }
+
+    const upstreamPlaylists = extractPlaylists(payload);
+    const playlists = pageOffset > 0 ? upstreamPlaylists.slice(pageOffset, pageOffset + limit) : upstreamPlaylists;
+
+    debugLog('final response contract', {
+      wrapper: 'customResponse',
+      expectedBodyShape: { response: { code: 0, data: { playlists: '...' } } },
+      upstreamLength: upstreamPlaylists.length,
+      normalizedLength: playlists.length
+    });
+
+    return customResponse({ response: { code: 0, data: { playlists } } }, 200);
+  } catch (error) {
+    console.error('获取用户歌单失败:', error);
+    return errorResponse((error as Error).message || '获取用户歌单失败', 502);
+  }
+};
+

package/module/apis/y_common.ts

@@ -0,0 +1,44 @@
+import { AxiosRequestConfig, Method } from 'axios';
+import request from '../../util/request';
+import * as config from '../config';
+
+interface YCommonOptions {
+	url: string;
+	method?: Method | string;
+	options?: AxiosRequestConfig;
+	hasCommonParams?: boolean;
+}
+
+export default ({ url, method = 'get', options = {}, hasCommonParams = true }: YCommonOptions) => {
+	const opts: AxiosRequestConfig = { ...options };
+
+	// Merge commonParams into params
+	// commonParams acts as defaults, specific params override them
+	if (hasCommonParams) {
+		opts.params = { ...config.commonParams, ...(opts.params || {}) };
+	} else {
+		opts.params = { ...(opts.params || {}) };
+	}
+
+	opts.headers = {
+		referer: 'https://c.y.qq.com/',
+		host: 'c.y.qq.com',
+		...(opts.headers || {})
+	};
+
+	if (process.env.DEBUG === 'true') {
+		const logOpts = { ...opts, headers: { ...opts.headers } };
+		const SENSITIVE_HEADER_KEYS = ['cookie', 'authorization', 'proxy-authorization'];
+
+		if (logOpts.headers) {
+			Object.keys(logOpts.headers).forEach(key => {
+				if (SENSITIVE_HEADER_KEYS.includes(key.toLowerCase())) {
+					(logOpts.headers as any)[key] = '[masked]';
+				}
+			});
+		}
+
+		console.log(url, { opts: logOpts });
+	}
+	return request(url, method as Method, opts);
+};

package/module/config.ts

@@ -0,0 +1,24 @@
+export const commonParams = {
+	g_tk: 1124214810,
+	loginUin: (global.userInfo as any)?.uin || '0',
+	hostUin: 0,
+	inCharset: 'utf8',
+	outCharset: 'utf-8',
+	// format: 'json',
+	notice: 0,
+	platform: 'yqq.json',
+	needNewCode: 0
+};
+
+export const _guid = (Math.round(2147483647 * Math.random()) * new Date().getUTCMilliseconds()) % 1e10;
+
+export const options = {
+	param: 'jsonpCallback',
+	prefix: 'tan'
+	// prefix: 'jp',
+};
+
+export const optionsPrefix = {
+	param: 'jsonpCallback',
+	prefix: 'playlistinfoCallback'
+};

package/module/index.ts

@@ -0,0 +1,95 @@
+import downloadQQMusic from './apis/downloadQQMusic';
+// search
+import getHotKey from './apis/search/getHotKey';
+import getSearchByKey from './apis/search/getSearchByKey';
+import getSmartbox from './apis/search/getSmartbox';
+
+// song list
+import songLists from './apis/songLists/songLists';
+import songListCategories from './apis/songLists/songListCategories';
+import songListDetail from './apis/songLists/songListDetail';
+
+// MV
+import getMvByTag from './apis/mv/getMvByTag';
+
+// singer
+import getSimilarSinger from './apis/singers/getSimilarSinger';
+import getSingerMv from './apis/singers/getSingerMv';
+import getSingerDesc from './apis/singers/getSingerDesc';
+import getSingerStarNum from './apis/singers/getSingerStarNum';
+
+// radio
+import getRadioLists from './apis/radio/getRadioLists';
+
+// DigitalAlbum
+import getDigitalAlbumLists from './apis/digitalAlbum/getDigitalAlbumLists';
+
+// music
+import getLyric from './apis/music/getLyric';
+
+// album
+import getAlbumInfo from './apis/album/getAlbumInfo';
+
+// comments
+import getComments from './apis/comments/getComments';
+
+// UCommon
+import UCommon from './apis/UCommon/UCommon';
+
+// getTopLists
+import getTopLists from './apis/rank/getTopLists';
+
+// getQQLoginQr
+import getQQLoginQr from './apis/user/getQQLoginQr';
+
+// checkQQLoginQr
+import checkQQLoginQr from './apis/user/checkQQLoginQr';
+
+// getUserPlaylists
+import { getUserPlaylists } from './apis/user/getUserPlaylists';
+
+// getUserAvatar
+import { getUserAvatar } from './apis/user/getUserAvatar';
+
+// getUserLikedSongs
+import { getUserLikedSongs } from './apis/user/getUserLikedSongs';
+
+export {
+	downloadQQMusic,
+	// search
+	getHotKey,
+	getSearchByKey,
+	getSmartbox,
+	// song lists
+	songLists,
+	songListCategories,
+	songListDetail,
+	// MV
+	getMvByTag,
+	// singer
+	getSimilarSinger,
+	getSingerMv,
+	getSingerDesc,
+	getSingerStarNum,
+	// radio
+	getRadioLists,
+	// DigitalAlbum
+	getDigitalAlbumLists,
+	// music
+	getLyric,
+	// album
+	getAlbumInfo,
+	// comments
+	getComments,
+	// UCommon
+	UCommon,
+	// getTopLists
+	getTopLists,
+	// login
+	getQQLoginQr,
+	checkQQLoginQr,
+	// user
+	getUserPlaylists,
+	getUserAvatar,
+	getUserLikedSongs
+};

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@sansenjian/qq-music-api",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "publishConfig": {
     "access": "public"
   },
   "description": "QQ Music API - QQ音乐API koa2实现",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
-    "dev": "nodemon app.js & npm run docs:dev",
-    "start": "node app.js",
+    "dev": "tsx app.ts",
+    "build": "tsc",
+    "start": "node dist/app.js",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
@@ -52,17 +53,30 @@
     "@koa/router": "^15.3.1",
     "axios": "^1.13.6",
     "date-fns": "^4.1.0",
-    "koa": "^2.15.0",
+    "is-generator-function": "1.0.10",
+    "koa": "^2.16.1",
     "koa-bodyparser": "^4.4.1",
-    "koa-static": "^5.0.0"
+    "koa-static": "^5.0.0",
+    "reflect-metadata": "^0.2.2"
+  },
+  "pnpm": {
+    "overrides": {
+      "is-generator-function": "^1.0.10"
+    }
   },
   "devDependencies": {
     "@babel/core": "^7.23.0",
     "@babel/plugin-transform-async-to-generator": "^7.23.0",
+    "@babel/preset-env": "^7.29.0",
+    "@babel/preset-typescript": "^7.28.5",
     "@babel/register": "^7.23.0",
     "@commitlint/cli": "^18.0.0",
     "@commitlint/config-conventional": "^18.0.0",
     "@types/jest": "^30.0.0",
+    "@types/koa": "^3.0.1",
+    "@types/koa__router": "^12.0.5",
+    "@types/koa-bodyparser": "^4.3.13",
+    "@types/node": "^25.3.3",
     "@types/supertest": "^7.2.0",
     "chalk": "^4.1.0",
     "conventional-changelog-cli": "^4.0.0",
@@ -76,8 +90,13 @@
     "lint-staged": "^15.0.0",
     "nodemon": "^3.1.14",
     "prettier": "^3.8.1",
+    "rimraf": "^6.1.3",
     "sinon": "^21.0.1",
     "supertest": "^7.2.2",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
+    "typescript": "5.7.3",
     "vitepress": "^1.6.4",
     "vue": "^3.5.29"
   },

package/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+onlyBuiltDependencies:
+  - esbuild