@sansenjian/qq-music-api 2.2.1 → 2.2.9

package/AGENTS.md

@@ -1,153 +0,0 @@
-# AGENTS.md
-
-## 项目概览
-
-这是一个基于 Koa 的 QQ 音乐 API 服务项目，当前代码库已完成从 JavaScript 到 TypeScript 的迁移。
-
-- 运行时：Node.js 20+
-- 开发语言：TypeScript
-- Web 框架：Koa 2
-- 路由系统：@koa/router
-- 文档系统：VitePress
-- 测试框架：Jest
-
-## 启动与构建
-
-### 安装依赖
-
-```bash
-npm install
-```
-
-### 开发模式
-
-```bash
-npm run dev
-```
-
-默认启动入口为 `app.ts`，默认端口为 `3200`。
-
-### 生产构建
-
-```bash
-npm run build
-```
-
-### 生产运行
-
-```bash
-npm run start
-```
-
-## 常用命令
-
-```bash
-npm run dev            # 本地开发
-npm run build          # TypeScript 编译
-npm run start          # 运行 dist/app.js
-npm run test           # 运行测试
-npm run test:watch     # 测试监听模式
-npm run test:coverage  # 测试覆盖率
-npm run docs:dev       # 启动文档站点
-npm run docs:build     # 构建文档
-npm run eslint         # 执行 ESLint 自动修复
-npm run prettier       # 执行 Prettier 格式化
-```
-
-## 目录结构
-
-```text
-app.ts                 应用启动入口
-index.ts               包导出入口
-module/                API 请求封装层
-routers/               HTTP 控制器与路由注册
-middlewares/           Koa 中间件
-util/                  通用工具函数
-config/                运行时配置
-types/                 全局类型与公共类型定义
-docs/                  VitePress 文档站点
-tests/                 单元测试与集成测试
-public/                静态资源
-scripts/               辅助脚本
-```
-
-## 分层说明
-
-### module/
-
-负责直接请求 QQ 音乐相关接口，通常只处理：
-
-- 请求参数拼装
-- 调用上游接口
-- 基础数据格式转换
-- 返回统一响应结构
-
-### routers/context/
-
-负责 HTTP 层控制器逻辑，通常只处理：
-
-- 读取 `ctx.query` 或 `ctx.request.body`
-- 参数校验
-- 调用 `module/` 中对应能力
-- 设置 `ctx.body` 与 `ctx.status`
-
-### routers/router.ts
-
-负责统一注册所有路由。
-
-### util/
-
-放置跨模块复用的通用逻辑，例如响应包装、颜色输出等。
-
-## 编码约定
-
-1. 新增功能时，优先保持现有目录分层，不要把路由逻辑和接口请求逻辑混写。
-2. 新增接口时，通常需要同时补充：
-   - `module/apis/...` 中的接口实现
-   - `routers/context/...` 中的控制器
-   - `routers/context/index.ts` 或相关导出
-   - `routers/router.ts` 中的路由注册
-   - 必要时补充文档与测试
-3. 统一使用 TypeScript，避免继续引入新的 `.js` 业务文件。
-4. 尽量复用已有类型定义，公共类型优先放到 `types/`。
-5. 保持返回结构一致，优先复用已有响应工具。
-6. 修改全局配置或 Cookie 相关逻辑时，注意兼容扫码登录相关接口。
-
-## 测试与验证
-
-提交前建议至少执行：
-
-```bash
-npm run build
-npm run test
-```
-
-如果修改了文档，再执行：
-
-```bash
-npm run docs:build
-```
-
-如果修改了格式或风格敏感文件，再执行：
-
-```bash
-npm run eslint
-npm run prettier
-```
-
-## 关键注意事项
-
-1. 项目默认端口为 `3200`。
-2. 生产启动依赖 `dist/` 目录，因此发布前必须先执行构建。
-3. 当前仓库包含扫码登录相关接口实现，不要在未理解流程前随意调整登录状态字段。
-4. 文档内容位于 `docs/`，接口能力变更时要同步更新文档。
-5. 现有测试以 Jest 为主，新增行为建议补充对应测试。
-
-## 建议的开发流程
-
-1. 阅读相关模块现有实现。
-2. 在 `module/` 增加或调整接口能力。
-3. 在 `routers/context/` 接入 HTTP 控制器。
-4. 在路由层完成注册。
-5. 补充类型、测试与文档。
-6. 执行构建和测试，确认无误后再提交。

package/Dockerfile

@@ -1,18 +0,0 @@
-FROM node:22
-
-LABEL maintainer="Rain120 <1085131904@qq.com>"
-
-# Create app directory
-WORKDIR /app
-
-COPY package.json .
-
-RUN yarn install --registry=https://registry.npmmirror.com
-
-COPY . .
-
-EXPOSE 3200
-
-ENTRYPOINT ["npm", "run"]
-
-CMD ["start"]

package/app.ts

@@ -1,68 +0,0 @@
-import 'reflect-metadata';
-import Koa from 'koa';
-import bodyParser from 'koa-bodyparser';
-import path from 'path';
-import koaStatic from 'koa-static';
-import chalk from 'chalk';
-import cors from './middlewares/koa-cors';
-import router from './routers/router';
-import cookieMiddleware from './util/cookie';
-import colors from './util/colors';
-import userInfoImport from './config/user-info';
-import pkg from './package.json';
-import type { UserInfo } from './types/global';
-
-const app = new Koa();
-
-global.userInfo = userInfoImport as UserInfo;
-
-console.log(chalk.green('\n🥳🎉 We had supported config the user cookies. \n'));
-console.log(colors.info(`Current Version: ${pkg.version}`));
-
-if(!((global.userInfo as any).loginUin || (global.userInfo as any).uin)){
-  console.log(chalk.yellow(`😔 The configuration ${chalk.red('loginUin')} or your ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
-}
-
-if (!(global.userInfo as any).cookie) {
-  console.log(chalk.yellow(`😔 The configuration ${chalk.red('cookie')} in file ${chalk.green('config/user-info')} has not configured. \n`));
-}
-
-app.use(bodyParser());
-app.use(cookieMiddleware() as any);
-app.use(koaStatic(
-  path.join(__dirname,  'public')
-));
-
-// logger
-app.use(async (ctx, next) => {
-  await next();
-  const rt = ctx.response.get('X-Response-Time');
-  console.log(colors.prompt(`${ctx.method} ${ctx.url} - ${rt}`));
-});
-
-// cors
-app.use(cors({
-  origin: ctx => (ctx.request as any).header?.origin || '*',
-  exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'],
-  maxAge: 5,
-  credentials: true,
-  allowMethods: ['GET', 'POST', 'DELETE'],
-  allowHeaders: ['Content-Type', 'Authorization', 'Accept'],
-}) as any);
-
-// x-response-time
-app.use(async (ctx, next) => {
-  const start = Date.now();
-  await next();
-  const ms = Date.now() - start;
-  ctx.set('X-Response-Time', `${ms}ms`);
-});
-
-app.use(router.routes())
-  .use(router.allowedMethods());
-
-const PORT: number = typeof process.env.PORT === 'string' ? parseInt(process.env.PORT, 10) : (process.env.PORT || 3200);
-
-(app.listen as any)(PORT, () => {
-  console.log(colors.prompt(`server running @ http://localhost:${PORT}`));
-});

package/commitlint.config.js

@@ -1,20 +0,0 @@
-/*
- * @Author: Rainy
- * @Date: 2020-07-03 18:47:30
- * @LastEditors: Rainy
- * @LastEditTime: 2020-07-03 18:51:11
- */
-
-module.exports = {
-	extends: ['@commitlint/config-conventional'],
-	rules: {
-		'type-enum': [
-			2,
-			'always',
-			['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert', 'config'],
-		],
-		'subject-full-stop': [0, 'never'],
-		'subject-case': [0, 'never'],
-		'header-max-length': [0, 'always', 150],
-	},
-};

package/config/user-info.ts

@@ -1,71 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-interface UserInfo {
-  loginUin: string;
-  uin?: string;
-  cookie: string;
-  cookieList: string[];
-  cookieObject: Record<string, string>;
-  refreshData: (cookie: string) => any;
-  [key: string]: any;
-}
-
-let userInfo: UserInfo = { loginUin: '', cookie: '', cookieList: [], cookieObject: {}, refreshData: () => ({}) };
-let cookieList: string[] = [];
-let cookieObject: Record<string, string> = {};
-
-const infoPath = path.join(__dirname, './user-info.json');
-if (!fs.existsSync(infoPath)) {
-  fs.writeFileSync(infoPath, '{}', 'utf-8');
-}
-
-const initData = () => {
-	try {
-		const parsed = JSON.parse(fs.readFileSync(infoPath, 'utf-8'));
-		userInfo = { 
-      loginUin: parsed.loginUin || '', 
-      cookie: parsed.cookie || '', 
-      cookieList: [],
-      cookieObject: {},
-      refreshData: () => ({})
-    };
-	} catch (e) {
-		userInfo = { loginUin: '', cookie: '', cookieList: [], cookieObject: {}, refreshData: () => ({}) };
-	}
-	cookieList = (userInfo.cookie || '').split('; ').map(_ => _.trim());
-
-	cookieObject = {};
-	cookieList.filter(Boolean).forEach(_ => {
-		if (_) {
-			const [key, value = ''] = _.split('=');
-			cookieObject[key] = value;
-		}
-	});
-};
-
-const refreshData = (cookie: string) => {
-	const uinMatch = cookie.match(/ uin=([^;]+)/);
-	const uin = uinMatch ? uinMatch[1] : '';
-	fs.writeFileSync(infoPath, JSON.stringify({ loginUin: uin, cookie }), 'utf-8');
-	initData();
-	return {
-		...userInfo,
-		uin: userInfo.loginUin || cookieObject.uin,
-		cookieList,
-		cookieObject
-	};
-};
-
-initData();
-
-const exportObj: UserInfo = {
-  loginUin: userInfo?.loginUin || '',
-  uin: userInfo?.loginUin || cookieObject?.uin || '',
-  cookie: userInfo?.cookie || '',
-  cookieList: cookieList || [],
-  cookieObject: cookieObject || {},
-  refreshData
-};
-
-export default exportObj as UserInfo;

package/index.ts

@@ -1 +0,0 @@
-import './app';

package/jest.config.ts

@@ -1,41 +0,0 @@
-import type { Config } from 'jest';
-
-const config: Config = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testMatch: ['**/tests/**/*.test.ts'],
-  collectCoverageFrom: [
-    'module/**/*.ts',
-    'routers/**/*.ts',
-    'util/**/*.ts',
-    '!**/node_modules/**',
-    '!**/tests/**',
-    '!**/dist/**'
-  ],
-  coverageDirectory: 'coverage',
-  coverageReporters: ['text', 'lcov', 'html'],
-  coverageThreshold: {
-    global: {
-      branches: 50,
-      functions: 50,
-      lines: 50,
-      statements: 50
-    }
-  },
-  setupFilesAfterEnv: ['<rootDir>/tests/setup/jest.setup.ts'],
-  modulePathIgnorePatterns: ['<rootDir>/dist/'],
-  testTimeout: 10000,
-  verbose: true,
-  moduleNameMapper: {
-    '^@module/(.*)$': '<rootDir>/module/$1',
-    '^@routers/(.*)$': '<rootDir>/routers/$1',
-    '^@util/(.*)$': '<rootDir>/util/$1'
-  },
-  transform: {
-    '^.+\.ts$': ['ts-jest', {
-      tsconfig: 'tsconfig.test.json'
-    }]
-  }
-};
-
-export default config;

package/middlewares/koa-cors.ts

@@ -1,81 +0,0 @@
-import { Context, Next } from 'koa';
-
-export interface CorsOptions {
-  origin?: string | ((ctx: Context) => string);
-  exposeHeaders?: string[];
-  maxAge?: number;
-  credentials?: boolean;
-  allowMethods?: string[];
-  allowHeaders?: string[];
-}
-
-function crossOrigin(options: CorsOptions = {}) {
-  const defaultOptions: CorsOptions = {
-    allowMethods: ['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS'],
-  };
-
-  options = Object.assign({}, defaultOptions, options);
-
-  return async function cors(ctx: Context, next: Next) {
-    ctx.vary('Origin');
-
-    let origin: string;
-    if (typeof options.origin === 'function') {
-      origin = options.origin(ctx);
-    } else {
-      origin = options.origin || ctx.get('Origin') || '*';
-    }
-    
-    if (!origin) {
-      return await next();
-    }
-
-    ctx.set('Access-Control-Allow-Origin', origin);
-
-    if (ctx.method === 'OPTIONS') {
-      if (!ctx.get('Access-Control-Request-Method')) {
-        return await next();
-      }
-
-      if (options.maxAge) {
-        ctx.set('Access-Control-Max-Age', String(options.maxAge));
-      }
-
-      if (options.credentials === true) {
-        ctx.set('Access-Control-Allow-Credentials', 'true');
-      }
-
-      if (options.allowMethods) {
-        ctx.set('Access-Control-Allow-Methods', options.allowMethods.join(','));
-      }
-
-      if (options.allowHeaders) {
-        ctx.set('Access-Control-Allow-Headers', options.allowHeaders.join(','));
-      } else {
-        ctx.set('Access-Control-Allow-Headers', ctx.get('Access-Control-Request-Headers'));
-      }
-
-      ctx.status = 204;
-    } else {
-      if (options.credentials === true) {
-        if (origin === '*') {
-          ctx.remove('Access-Control-Allow-Credentials');
-        } else {
-          ctx.set('Access-Control-Allow-Credentials', 'true');
-        }
-      }
-
-      if (options.exposeHeaders) {
-        ctx.set('Access-Control-Expose-Headers', options.exposeHeaders.join(','));
-      }
-
-      try {
-        await next();
-      } catch (err) {
-        throw err;
-      }
-    }
-  };
-}
-
-export default crossOrigin;

package/module/apis/UCommon/UCommon.ts

@@ -1,13 +0,0 @@
-import { AxiosRequestConfig, Method } from 'axios';
-import u_common from '../u_common';
-
-interface UCommonParams {
-	method?: Method | string;
-	params?: any;
-	option?: AxiosRequestConfig;
-}
-
-export default ({ method = 'get', params = {}, option = {} }: UCommonParams) => {
-	const options: AxiosRequestConfig = { ...option, params };
-	return u_common({ method, options });
-};

package/module/apis/album/getAlbumInfo.ts

@@ -1,22 +0,0 @@
-import { handleApi } from '../../../util/apiResponse';
-import y_common from '../y_common';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {} }: ApiOptions) => {
-	const data = {
-		...params,
-		format: 'json',
-		outCharset: 'utf-8'
-	};
-	const options = {
-		...option,
-		params: data
-	};
-	return handleApi(
-		y_common({
-			url: '/v8/fcg-bin/fcg_v8_album_info_cp.fcg',
-			method: method as string,
-			options
-		})
-	);
-};

package/module/apis/comments/getComments.ts

@@ -1,23 +0,0 @@
-import { handleApi } from '../../../util/apiResponse';
-import y_common from '../y_common';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {} }: ApiOptions) => {
-	const data = {
-		...params,
-		format: 'json',
-		outCharset: 'GB2312',
-		domain: 'qq.com',
-		ct: 24,
-		cv: 10101010,
-		needmusiccrit: 0
-	};
-	const options = { ...option, params: data };
-	return handleApi(
-		y_common({
-			url: '/base/fcgi-bin/fcg_global_comment_h5.fcg',
-			method: method as string,
-			options
-		})
-	);
-};

package/module/apis/digitalAlbum/getDigitalAlbumLists.ts

@@ -1,23 +0,0 @@
-import request from '../../../util/request';
-import { handleApi } from '../../../util/apiResponse';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {} }: ApiOptions) => {
-  const data = Object.assign(params, {
-    format: 'json',
-    outCharset: 'utf-8',
-    cmd: 'pc_index_new'
-  });
-  
-  const options = Object.assign(option, {
-    params: data
-  });
-  
-  return handleApi(
-    request({
-      url: '/v8/fcg-bin/musicmall.fcg',
-      method: method as import('axios').Method,
-      options
-    })
-  );
-};

package/module/apis/downloadQQMusic.ts

@@ -1,51 +0,0 @@
-import { AxiosRequestConfig, Method } from 'axios';
-import request from '../../util/request';
-
-interface DownloadOptions {
-	method?: Method | string;
-	params?: any;
-	option?: AxiosRequestConfig;
-}
-
-export default ({ method = 'get', params = {}, option = {} }: DownloadOptions) => {
-	const data = {
-		...params,
-		format: 'jsonp',
-		jsonpCallback: 'MusicJsonCallback',
-		platform: 'yqq'
-	};
-	const options: AxiosRequestConfig = {
-		...option,
-		headers: {
-			host: 'y.qq.com',
-			referer: 'https://y.qq.com/',
-			...(option.headers || {})
-		},
-		params: data
-	};
-	return request('/download/download.js', method as Method, options, 'y')
-		.then(res => {
-			let response = res.data;
-			if (typeof response === 'string') {
-				const reg = /^\w+\(({[^()]+})\)$/;
-				const matches = response.match(reg);
-				if (matches) {
-					response = JSON.parse(matches[1]);
-				}
-			}
-			return {
-				status: 200,
-				body: {
-					response
-				}
-			};
-		})
-		.catch(error => {
-			console.log('error', error);
-			return {
-				body: {
-					error
-				}
-			};
-		});
-};

package/module/apis/music/getLyric.ts

@@ -1,34 +0,0 @@
-import { lyricParse } from '../../../util/lyricParse';
-import request from '../../../util/request';
-import { handleApi } from '../../../util/apiResponse';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {}, isFormat = false }: ApiOptions) => {
-  const data = Object.assign(params, {
-    format: 'json',
-    outCharset: 'utf-8',
-    pcachetime: Date.now()
-  });
-  
-  const options = Object.assign(option, {
-    params: data
-  });
-  
-  return handleApi(
-    request({
-      url: '/lyric/fcgi-bin/fcg_query_lyric_new.fcg',
-      method: method as import('axios').Method,
-      options
-    }),
-    {
-      transformData: (resData: Record<string, any>) => {
-        const lyricString = resData && resData.lyric && Buffer.from(resData.lyric, 'base64').toString();
-        const lyric = isFormat && lyricString ? lyricParse(lyricString) : lyricString;
-        return {
-          ...resData,
-          lyric
-        };
-      }
-    }
-  );
-};

package/module/apis/mv/getMvByTag.ts

@@ -1,24 +0,0 @@
-import request from '../../../util/request';
-import { handleApi } from '../../../util/apiResponse';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {} }: ApiOptions) => {
-  const data = Object.assign(params, {
-    format: 'json',
-    outCharset: 'GB2312',
-    cmd: 'shoubo',
-    lan: 'all'
-  });
-  
-  const options = Object.assign(option, {
-    params: data
-  });
-  
-  return handleApi(
-    request({
-      url: '/mv/fcgi-bin/getmv_by_tag',
-      method: method as import('axios').Method,
-      options
-    })
-  );
-};

package/module/apis/radio/getRadioLists.ts

@@ -1,27 +0,0 @@
-import request from '../../../util/request';
-import { handleApi } from '../../../util/apiResponse';
-import type { ApiOptions } from '../../../types/api';
-
-export default async ({ method = 'get', params = {}, option = {} }: ApiOptions) => {
-  const data = Object.assign(params, {
-    format: 'json',
-    outCharset: 'utf-8',
-    channel: 'radio',
-    page: 'index',
-    tpl: 'wk',
-    new: 1,
-    p: Math.round(1)
-  });
-  
-  const options = Object.assign(option, {
-    params: data
-  });
-  
-  return handleApi(
-    request({
-      url: '/v8/fcg-bin/fcg_v8_radiolist.fcg',
-      method: method as import('axios').Method,
-      options
-    })
-  );
-};