@sansenjian/qq-music-api 2.2.1 → 2.2.7

package/tests/integration/middleware/cors.test.ts

@@ -1,41 +0,0 @@
-// CORS 中间件单元测试
-
-import cors from '../../../middlewares/koa-cors';
-
-describe('CORS Middleware', () => {
-  test('should set CORS headers', async () => {
-    const ctx = {
-      method: 'GET',
-      set: jest.fn(),
-      get: jest.fn().mockReturnValue('http://localhost:3000'),
-      vary: jest.fn(),
-      status: 200,
-      body: {}
-    } as unknown as Parameters<ReturnType<typeof cors>>[0];
-    
-    const next = jest.fn().mockResolvedValue(undefined);
-
-    await cors()(ctx, next);
-
-    expect(ctx.set).toHaveBeenCalled();
-    expect(ctx.vary).toHaveBeenCalledWith('Origin');
-    expect(next).toHaveBeenCalled();
-  });
-
-  test('should handle preflight request', async () => {
-    const ctx = {
-      method: 'OPTIONS',
-      set: jest.fn(),
-      get: jest.fn().mockReturnValue('GET'),
-      vary: jest.fn(),
-      status: 200
-    } as unknown as Parameters<ReturnType<typeof cors>>[0];
-    
-    const next = jest.fn().mockResolvedValue(undefined);
-
-    await cors()(ctx, next);
-
-    expect(ctx.status).toBe(204);
-    expect(ctx.set).toHaveBeenCalledWith('Access-Control-Allow-Methods', expect.any(String));
-  });
-});

package/tests/setup/jest.setup.ts

@@ -1,15 +0,0 @@
-// Jest 测试环境设置文件
-// 扩展 Jest 的 expect 断言
-
-// 设置测试超时时间
-jest.setTimeout(10000);
-
-// 抑制测试中的 console.log 输出（可选）
-// global.console = {
-//   ...console,
-//   log: jest.fn(),
-//   debug: jest.fn(),
-//   info: jest.fn(),
-//   warn: jest.fn(),
-//   error: jest.fn(),
-// };

package/tests/setup/testUtils.ts

@@ -1,35 +0,0 @@
-// 测试工具函数
-
-import Koa from 'koa';
-
-/**
- * 创建测试用的 Koa 应用实例
- */
-export function createTestApp(): Koa {
-  return new Koa();
-}
-
-/**
- * 等待指定毫秒数
- */
-export function sleep(ms: number): Promise<void> {
-  return new Promise(resolve => setTimeout(resolve, ms));
-}
-
-/**
- * 生成随机字符串
- */
-export function randomString(length: number = 10): string {
-  return Math.random().toString(36).substring(2, length + 2);
-}
-
-/**
- * Mock 响应数据生成器
- */
-export function createMockResponse<T>(data: T, code: number = 0) {
-  return {
-    code,
-    data,
-    message: code === 0 ? 'success' : 'error',
-  };
-}

package/tests/unit/util/request.test.ts

@@ -1,177 +0,0 @@
-const mockService = jest.fn();
-const mockInterceptors = {
-  request: { use: jest.fn() },
-  response: { use: jest.fn() }
-};
-(mockService as jest.Mock & { interceptors: typeof mockInterceptors }).interceptors = mockInterceptors;
-
-jest.mock('axios', () => ({
-  __esModule: true,
-  default: {
-    create: jest.fn(() => mockService)
-  },
-  create: jest.fn(() => mockService)
-}));
-
-import type { AxiosRequestConfig } from 'axios';
-import request from '../../../util/request';
-
-describe('request util', () => {
-  beforeEach(() => {
-    mockService.mockClear();
-
-    global.userInfo = {
-      loginUin: '123456',
-      cookie: 'uin=o123456; qm_keyst=abc',
-      cookieList: ['uin=o123456', 'qm_keyst=abc'],
-      cookieObject: {
-        uin: 'o123456',
-        qm_keyst: 'abc'
-      },
-      refreshData: () => undefined
-    };
-  });
-
-  const getLastConfig = (): AxiosRequestConfig => {
-    expect(mockService).toHaveBeenCalled();
-    const calls = mockService.mock.calls;
-    return calls[calls.length - 1]?.[0] as AxiosRequestConfig;
-  };
-
-  const getRequestInterceptor = () => {
-    const interceptor = mockInterceptors.request.use.mock.calls[0]?.[0] as
-      | ((config: AxiosRequestConfig) => AxiosRequestConfig)
-      | undefined;
-
-    expect(interceptor).toBeDefined();
-    return interceptor as (config: AxiosRequestConfig) => AxiosRequestConfig;
-  };
-
-  test('should use c.y.qq.com as default base URL', async () => {
-    await request('/test-path');
-
-    expect(getLastConfig().url).toBe('https://c.y.qq.com/test-path');
-  });
-
-  test('should use y.qq.com when isUUrl is y', async () => {
-    await request({
-      url: '/test-path',
-      isUUrl: 'y'
-    });
-
-    expect(getLastConfig().url).toBe('https://y.qq.com/test-path');
-  });
-
-  test('should use raw url when isUUrl is u', async () => {
-    await request({
-      url: 'https://u.y.qq.com/cgi-bin/musicu.fcg',
-      isUUrl: 'u'
-    });
-
-    expect(getLastConfig().url).toBe('https://u.y.qq.com/cgi-bin/musicu.fcg');
-  });
-
-  test('should fallback to c.y.qq.com for unknown base type', async () => {
-    await request('/fallback-path', 'GET', undefined, 'c');
-
-    expect(getLastConfig().url).toBe('https://c.y.qq.com/fallback-path');
-  });
-
-  test('should inject Cookie from global.userInfo when no cookie header is provided', async () => {
-    await request({
-      url: '/cookie-test',
-      options: {
-        headers: {}
-      }
-    });
-
-    expect(getLastConfig().headers).toMatchObject({
-      Cookie: 'uin=o123456; qm_keyst=abc'
-    });
-  });
-
-  test('should preserve explicit Cookie header without overriding it', async () => {
-    await request({
-      url: '/cookie-test',
-      options: {
-        headers: {
-          Cookie: 'custom=value'
-        }
-      }
-    });
-
-    expect(getLastConfig().headers).toMatchObject({
-      Cookie: 'custom=value'
-    });
-  });
-
-  test('should move headers.cookies to Cookie and remove cookies field', async () => {
-    await request({
-      url: '/cookie-rename',
-      options: {
-        headers: {
-          cookies: 'foo=bar'
-        }
-      }
-    });
-
-    const headers = getLastConfig().headers as Record<string, string>;
-    expect(headers.Cookie).toBe('foo=bar');
-    expect(headers.cookies).toBeUndefined();
-  });
-
-  test('should set lowercase method in axios config', async () => {
-    await request({
-      url: '/method-test',
-      method: 'POST'
-    });
-
-    expect(getLastConfig().method).toBe('post');
-  });
-
-  test('should keep provided data on POST request', async () => {
-    const payload = { foo: 'bar' };
-
-    await request({
-      url: '/post-test',
-      method: 'POST',
-      options: {
-        data: payload
-      }
-    });
-
-    expect(getLastConfig().data).toEqual(payload);
-  });
-
-  test('should allow request interceptor to add default Content-Type for POST body', () => {
-    const interceptor = getRequestInterceptor();
-
-    const result = interceptor({
-      method: 'post',
-      data: { foo: 'bar' },
-      headers: {}
-    });
-
-    expect(result.headers).toMatchObject({
-      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
-      'User-Agent':
-        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36'
-    });
-  });
-
-  test('should not overwrite existing Content-Type in request interceptor', () => {
-    const interceptor = getRequestInterceptor();
-
-    const result = interceptor({
-      method: 'patch',
-      data: { foo: 'bar' },
-      headers: {
-        'Content-Type': 'application/json'
-      }
-    });
-
-    expect(result.headers).toMatchObject({
-      'Content-Type': 'application/json'
-    });
-  });
-});

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "ES2020",
-		"module": "commonjs",
-		"lib": ["es2020"],
-		"outDir": "dist",
-		"rootDir": "./",
-		"strict": true,
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"moduleResolution": "node",
-		"resolveJsonModule": true,
-		"noImplicitAny": true,
-		"typeRoots": ["./node_modules/@types", "./types"],
-		"types": ["node"]
-	},
-	"include": ["**/*.ts", "types/**/*.d.ts"],
-	"exclude": ["node_modules", "dist", "tests"]
-}

package/tsconfig.test.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["node", "jest"]
-  },
-  "include": ["tests/**/*.ts", "types/**/*.d.ts"],
-  "exclude": ["node_modules", "dist"]
-}

package/types/api.ts

@@ -1,105 +0,0 @@
-/**
- * API 响应基础结构
- */
-export interface ApiResponse {
-  status: number;
-  body: {
-    response?: any;
-    error?: any;
-    message?: string;
-    isOk?: boolean;
-    refresh?: boolean;
-    data?: any;
-    [key: string]: any;
-  };
-}
-
-/**
- * API 函数参数选项
- */
-export interface ApiOptions {
-  method?: string;
-  params?: Record<string, any>;
-  option?: any;
-  isFormat?: boolean | string;
-  [key: string]: any;
-}
-
-export interface HandleApiOptions<TInput = any, TOutput = any> {
-  /** 成功时的数据转换函数 */
-  transformData?: (data: TInput) => TOutput;
-  /** 自定义状态码 */
-  customStatus?: number;
-  /** 是否记录错误日志 */
-  logError?: boolean;
-}
-
-/**
- * API 函数类型定义
- */
-export type ApiFunction<T extends ApiOptions = ApiOptions> = (
-  options: T
-) => Promise<ApiResponse>;
-
-/**
- * 成功响应创建器
- */
-export function createSuccessResponse(
-  data: any,
-  status: number = 200
-): ApiResponse {
-  return {
-    status,
-    body: {
-      response: data,
-    },
-  };
-}
-
-/**
- * 错误响应创建器
- */
-export function createErrorResponse(
-  error: any,
-  status: number = 500
-): ApiResponse {
-  return {
-    status,
-    body: {
-      error,
-    },
-  };
-}
-
-/**
- * API Promise 处理器 - 自动处理成功和错误情况
- */
-export async function handleApi<TInput = any, TOutput = TInput>(
-  promise: Promise<TInput>,
-  options?: HandleApiOptions<TInput, TOutput>
-): Promise<ApiResponse> {
-  try {
-    const result = await promise;
-    const responseData = options?.transformData
-      ? options.transformData((result as any).data || result)
-      : (result as any).data || result;
-
-    return {
-      status: options?.customStatus || 200,
-      body: {
-        response: responseData,
-      },
-    };
-  } catch (error) {
-    if (options?.logError !== false) {
-      console.log('API error:', error);
-    }
-
-    return {
-      status: options?.customStatus || 500,
-      body: {
-        error,
-      },
-    };
-  }
-}

package/types/global.d.ts

@@ -1,26 +0,0 @@
-/**
- * 全局 UserInfo 类型定义
- * 用于 global.userInfo 的类型声明
- * 注意：实际运行时 userInfo 还包含 uin, cookieList, cookieObject 等属性
- */
-export interface UserInfo {
-  loginUin: string;
-  uin?: string;
-  cookie: string;
-  cookieList: string[];
-  cookieObject: Record<string, string>;
-  refreshData: (cookie: string) => any;
-  [key: string]: any; // 允许索引签名以支持其他动态属性
-}
-
-/**
- * 全局变量声明
- */
-declare global {
-  var userInfo: UserInfo;
-}
-
-/**
- * 导出类型供其他模块使用
- */
-export type { UserInfo };

package/types/index.d.ts

@@ -1,97 +0,0 @@
-import type { UserInfo } from './global';
-
-declare global {
-	var userInfo: UserInfo;
-}
-
-// 导出 UserInfo 类型供其他模块使用
-export type { UserInfo };
-
-declare module 'koa' {
-	interface Context {
-		request: Request & {
-			body?: any;
-			rawBody?: string;
-		};
-		response: Response;
-		req: any;
-		res: any;
-		app: Application;
-		cookies: {
-			get: (name: string) => string | undefined;
-			set: (name: string, value: string, options?: any) => void;
-		};
-		query: Record<string, any>;
-		params: Record<string, string>;
-		path: string;
-		url: string;
-		method: string;
-		headers: Record<string, string>;
-		status: number;
-		body: any;
-		get: (field: string) => string;
-		set: (field: string, value: string) => void;
-	}
-
-	interface Request {
-		header: Record<string, string>;
-		headers: Record<string, string>;
-		method: string;
-		url: string;
-		path: string;
-		query: Record<string, any>;
-		body?: any;
-		rawBody?: string;
-	}
-
-	interface Response {
-		status: number;
-		body: any;
-		headers: Record<string, string>;
-		get: (field: string) => string;
-		set: (field: string, value: string) => void;
-	}
-
-	interface Application {
-		use: (middleware: any) => this;
-		listen: (port: number, callback?: () => void) => any;
-	}
-
-	type Middleware = (ctx: Context, next: () => Promise<void>) => Promise<void>;
-
-	export class Koa {
-		constructor();
-		use(fn: Middleware): this;
-		listen(port: number, hostname?: string, backlog?: number, listeningListener?: () => void): any;
-	}
-
-	export default Koa;
-	export { Context, Request, Response, Middleware };
-}
-
-declare module 'koa-bodyparser' {
-	function bodyParser(options?: any): any;
-	export = bodyParser;
-}
-
-declare module 'koa-static' {
-	function serve(root: string, opts?: any): any;
-	export = serve;
-}
-
-declare module '@koa/router' {
-	class Router {
-		constructor(opts?: any);
-		get(path: string, ...middleware: any[]): this;
-		post(path: string, ...middleware: any[]): this;
-		use(...middleware: any[]): this;
-		routes(): any;
-		allowedMethods(): any;
-	}
-	export = Router;
-}
-
-declare module 'koa-cors' {
-	function cors(options?: any): any;
-	export = cors;
-}

package/util/apiResponse.ts

@@ -1,97 +0,0 @@
-import type { ApiResponse } from '../types/api';
-
-/**
- * 创建成功的 API 响应
- * @param data 响应数据
- * @param status HTTP 状态码，默认 200
- */
-export function successResponse(data: any, status: number = 200): ApiResponse {
-  return {
-    status,
-    body: {
-      response: data,
-    },
-  };
-}
-
-/**
- * 创建错误的 API 响应
- * @param error 错误信息
- * @param status HTTP 状态码，默认 500
- */
-export function errorResponse(error: any, status: number = 500): ApiResponse {
-  return {
-    status,
-    body: {
-      error,
-    },
-  };
-}
-
-/**
- * 处理 API Promise，自动包装成功和错误响应
- * @param promise API 请求 Promise
- * @param options 可选配置
- */
-export async function handleApi<T = any>(
-  promise: Promise<T>,
-  options?: {
-    /** 成功时的数据转换函数 */
-    transformData?: (data: T) => any;
-    /** 自定义状态码 */
-    customStatus?: number;
-    /** 是否记录错误日志 */
-    logError?: boolean;
-  }
-): Promise<ApiResponse> {
-  try {
-    const result = await promise;
-    const resultAny = result as any;
-    const responseData = options?.transformData
-      ? options.transformData(resultAny.data || result)
-      : resultAny.data || result;
-
-    return {
-      status: options?.customStatus || 200,
-      body: {
-        response: responseData,
-      },
-    };
-  } catch (error) {
-    if (options?.logError !== false) {
-      console.log('API error:', error);
-    }
-
-    return {
-      status: options?.customStatus || 500,
-      body: {
-        error,
-      },
-    };
-  }
-}
-
-/**
- * 创建自定义结构的响应
- * @param body 响应体
- * @param status HTTP 状态码
- */
-export function customResponse(body: any, status: number = 200): ApiResponse {
-  return {
-    status,
-    body,
-  };
-}
-
-/**
- * 处理 400 错误响应（参数错误）
- * @param message 错误消息
- */
-export function badRequest(message: string): ApiResponse {
-  return {
-    status: 400,
-    body: {
-      response: message,
-    },
-  };
-}

package/util/colors.ts

@@ -1,31 +0,0 @@
-import chalk from 'chalk';
-
-type ColorFunction = (text: string) => string;
-
-interface Colors {
-	silly: ColorFunction;
-	input: ColorFunction;
-	verbose: ColorFunction;
-	prompt: ColorFunction;
-	info: ColorFunction;
-	data: ColorFunction;
-	help: ColorFunction;
-	warn: ColorFunction;
-	debug: ColorFunction;
-	error: ColorFunction;
-}
-
-const colors: Colors = {
-	silly: (text: string) => chalk.hex('#ff69b4')(text),
-	input: (text: string) => chalk.grey(text),
-	verbose: (text: string) => chalk.cyan(text),
-	prompt: (text: string) => chalk.white(text),
-	info: (text: string) => chalk.green(text),
-	data: (text: string) => chalk.grey(text),
-	help: (text: string) => chalk.cyan(text),
-	warn: (text: string) => chalk.yellow(text),
-	debug: (text: string) => chalk.blue(text),
-	error: (text: string) => chalk.red(text)
-};
-
-export default colors;

package/util/cookie.ts

@@ -1,40 +0,0 @@
-import { Context, Next } from 'koa';
-
-// Define the shape of global.userInfo
-declare global {
-  var userInfo: {
-    cookie?: string;
-    cookieList?: string[];
-    loginUin?: string;
-  };
-}
-
-const SAFE_COOKIE_NAMES = new Set(['qqmusic_key', 'qqmusic_uin']);
-
-const cookieMiddleware = () => async (ctx: Context, next: Next) => {
-	if (global.userInfo?.cookie) {
-    // Extend Request interface if needed, or just cast
-		(ctx.request as any).cookie = global.userInfo.cookie;
-	}
-
-	if (Array.isArray(global.userInfo?.cookieList)) {
-		global.userInfo.cookieList.forEach((cookie: string) => {
-			const [key, ...valueParts] = cookie.split('=');
-        const normalizedKey = key?.trim();
-        const value = valueParts.join('=').trim();
-
-			if (normalizedKey && value && SAFE_COOKIE_NAMES.has(normalizedKey)) {
-				ctx.cookies.set(normalizedKey, value, {
-					// 仅同步前端业务必需且可公开的 Cookie，避免敏感登录态透传
-					overwrite: true,
-            httpOnly: false,
-            sameSite: 'lax'
-				});
-			}
-		});
-	}
-
-	await next();
-};
-
-export default cookieMiddleware;