qqmusic-api-enhanced 1.0.7 → 1.0.9

package/LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2026 BakaGame
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Portions of this software are licensed under the Apache License, Version 2.0.
+See THIRD_PARTY_NOTICES.md and LICENSES/Apache-2.0.txt for details.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,12 +1,18 @@
 # qqmusic-api-enhanced
 
+[![npm](https://img.shields.io/npm/v/qqmusic-api-enhanced.svg)](https://www.npmjs.com/package/qqmusic-api-enhanced)
+[![CI](https://github.com/Cosmosuperbaka/qqmusic-api-enhanced/actions/workflows/ci.yml/badge.svg)](https://github.com/Cosmosuperbaka/qqmusic-api-enhanced/actions/workflows/ci.yml)
+[![License: MIT AND Apache-2.0](https://img.shields.io/badge/license-MIT%20AND%20Apache--2.0-blue.svg)](LICENSE)
+
 QQ 音乐增强版 Node.js / Bun API 客户端，基于 QQ 音乐逆向协议与签名机制实现。项目架构与设计风格严格对齐 `@neteasecloudmusicapienhanced/api`，旨在为音乐播放器、猜歌游戏（如 SonGuessr）、数据分析等应用提供开箱即用、零外部生产依赖的纯 TypeScript 解决方案。
 
+运行时：Node.js >= 20 或 Bun 1.x；生产依赖为零。
+
 ---
 
 ## 特性亮点
 
-- **零外部生产依赖**：纯 TypeScript 编写，直接利用 Node.js / Bun 原生 `crypto`、`zlib`、`fetch`，无需安装 heavy C++ 插件或额外加密包。
+- **零生产依赖**：纯 TypeScript 编写，直接利用 Node.js / Bun 原生 `crypto`、`zlib`、`fetch`；`devDependencies` 只用于构建与测试。
 - **全平台扫码登录**：支持手机 QQ 快捷扫码、微信网页扫码、QQ 音乐移动端 App 扫码，玩家可自主完成身份凭据提取与长效刷新。
 - **VKey 播放直链提取**：基于 `UrlGetVkey` 逆向调度，支持 128kbps (mp3)、320kbps (高品质 mp3)、FLAC (无损)、M4A 以及试听片段直链解析。
 - **QRC 逐字歌词解密**：内置原生定制版 Triple-DES（支持 QQ 音乐特定 PC-2 偏移置换）及 zlib 解压算法，自动将加密 QRC 转换为带时间戳的明文逐字歌词。
@@ -16,6 +22,8 @@ QQ 音乐增强版 Node.js / Bun API 客户端，基于 QQ 音乐逆向协议与
 
 ## 安装
 
+主包发布在 npmjs：
+
 ```bash
 # npm
 npm install qqmusic-api-enhanced
@@ -27,6 +35,9 @@ pnpm add qqmusic-api-enhanced
 bun add qqmusic-api-enhanced
 ```
 
+GitHub 仓库的 Packages 页另外提供 scoped 镜像 `@cosmosuperbaka/qqmusic-api-enhanced`；
+GitHub Packages 的 npm 安装需要带 GitHub token，日常使用请优先用上面的 npmjs 包。
+
 ---
 
 ## 快速上手
@@ -132,6 +143,21 @@ import {
 
 ---
 
+## 开发
+
+```bash
+bun install --frozen-lockfile
+bun run build
+bun test
+```
+
+构建会生成并覆盖仓库里的 `.js` / `.d.ts` 产物，提交 TypeScript 改动时请一并提交生成文件。
+贡献规范见 [CONTRIBUTING.md](CONTRIBUTING.md)，安全问题见 [SECURITY.md](SECURITY.md)。
+
+不要在日志、issue、测试或代码提交里放真实 Cookie、`qm_keyst`、`refresh_token` 或 AppSecret；如果凭据可能泄露，请先在 QQ 音乐侧退出登录/轮换。
+
+---
+
 ## 发布
 
 版本号在 `package.json`；发布由 GitHub Actions 自动完成：
@@ -150,6 +176,14 @@ import {
 
 ---
 
+## 许可证
+
+本项目自有代码以 MIT 许可发布。`util/des.ts` 的 QRC 解密实现移植自
+[lx-music-desktop](https://github.com/lyswhut/lx-music-desktop)（Apache-2.0），
+详见 `THIRD_PARTY_NOTICES.md` 与 `LICENSES/Apache-2.0.txt`。
+
+---
+
 ## 协议与免责声明
 
 本项目仅供个人学习、技术研究与教育用途。所有接口数据与媒体资源版权归腾讯公司所有。请勿将本项目用于任何商业用途或违反相关法律法规的场景。

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,16 @@
+# Third-Party Notices
+
+This package includes the following third-party source code.
+
+## lx-music-desktop `qrcDecode.js`
+
+- File: `util/des.ts`
+- Source: https://github.com/lyswhut/lx-music-desktop/blob/master/src/renderer/utils/musicSdk/tx/qrcDecode.js
+- Copyright: Copyright (c) lyswhut and lx-music-desktop contributors
+- License: Apache License, Version 2.0
+
+`util/des.ts` is a TypeScript port of the QRC 3DES decryption routine from
+lx-music-desktop. The algorithm is a QQ Music-specific DES variant (the S-box
+values differ from standard DES), so it is kept as-is.
+
+The full Apache-2.0 license text is in `LICENSES/Apache-2.0.txt`.

package/module/login_qr_check.d.ts

@@ -1,13 +1,52 @@
-import { request, type ApiResponse } from "../util/request.js";
+import { request, requestCgi, type ApiResponse } from "../util/request.js";
+import { type MobileQrDeps } from "../util/mobile_qr_session.js";
 /**
  * 轮询检查二维码登录状态.
  *
+ * 返回 `body.code` 约定：
+ * - 200 登录成功（保证带有 musickey，调用方可以直接落库）
+ * - 801 等待扫码 / 802 已扫码待确认
+ * - 800 二维码过期
+ * - 803 用户在手机上取消或拒绝授权
+ * - 500 上游协议失败：带 `reason`（见 {@link LoginFailureReason}）、`stage`、`upstreamCode`，
+ *   与“二维码过期 / 用户取消”区分开，调用方不应继续轮询同一个二维码
+ *
  * @param query.type 登录类型: 'qq' | 'wx' | 'mobile'
  * @param query.qrsig QQ 二维码凭证标识 (type=qq 时必填)
  * @param query.ptqrtoken QQ 二维码校验 token (type=qq 时必填)
  * @param query.uuid 微信登录会话 uuid (type=wx 时必填)
  * @param query.qrcodeID QQ 音乐 App 扫码 qrcodeID (type=mobile 时必填)
  */
+export type LoginFailureReason = "auth_invalid" | "rate_limited" | "device_limit" | "account_restricted" | "protocol";
+/** 测试注入点：真实调用不需要传。 */
+export interface LoginQrCheckDeps {
+    fetch?: typeof fetch;
+    cgi?: typeof requestCgi;
+    mobile?: MobileQrDeps;
+}
+/** 业务码 → 失败原因。码表来自各登录入口的公开实现与实测（无效授权码返回 104400）。 */
+export declare function classifyLoginCode(code: number | undefined): {
+    reason: LoginFailureReason;
+    message: string;
+};
+/** 简易 Cookie 罐：处理空值/过期即删除，避免把已清除的 Cookie 当成有效值回传。 */
+export declare class CookieJar {
+    private readonly values;
+    constructor(initial?: Record<string, string>);
+    apply(setCookies: string[]): void;
+    get(key: string): string;
+    toObject(): Record<string, string>;
+    header(): string;
+}
+/** 解析 ptqrlogin 的 `ptuiCB('码','…','URL','…','提示','昵称')` 回调。 */
+export declare function parsePtqrloginText(text: string): {
+    status: "expired" | "waiting" | "scanned" | "refused" | "success" | "unknown";
+    url?: string;
+};
+/** 从授权跳转里取 code；Location 之外也兜底扫描响应体里的跳转脚本。 */
+export declare function extractAuthCode(location: string, body?: string): string;
+/** 把 Location 概括成可安全进日志的形态：只留主机、路径和 error 类参数，不含 code/token。 */
+export declare function describeLocation(location: string): Record<string, string>;
 export default function login_qr_check(query?: {
     type?: "qq" | "wx" | "mobile";
     qrsig?: string;
@@ -16,4 +55,4 @@ export default function login_qr_check(query?: {
     qrcodeID?: string;
     key?: string;
     guid?: string;
-}, req?: typeof request): Promise<ApiResponse>;
+}, _req?: typeof request, deps?: LoginQrCheckDeps): Promise<ApiResponse>;