@ikenxuan/amagi 5.1.1 → 5.3.0

package/README.md

@@ -20,19 +20,8 @@ amagi 将作为一个独立的上游模块，提供给下游 [karin-plugin-kkk](
 pnpm add @ikenxuan/amagi@latest
 ```
 
-## 版本说明 📋
 
-### v4 版本 (推荐) 🔄
-
-v4 版本保持向后兼容，是默认导入版本，适合现有项目的平滑迁移。
-
-### v5 版本 (测试中 慎用) 🆕
-
-v5 版本是当前的主要开发版本，提供了更好的错误处理、统一的响应格式和更强的类型安全性。
-
-## 快速开始 (v4 版本) 🚀
-
-### 基本用法 ✨
+## 基本用法 ✨
 主要就两个方法，`getDouyinData` 和 `getBilibiliData`。
 
 > 它接收三个参数，
@@ -73,22 +62,6 @@ async function example() {
 example()
 ```
 
-## v5 版本完整指南 🆕
-
-### v5 版本使用方式
-
-```javascript
-// v5 版本导入方式
-import { createAmagiClient } from '@ikenxuan/amagi/v5'
-// 或者
-import amagi from '@ikenxuan/amagi/v5'
-
-const client = createAmagiClient({ douyin: 'your_cookie' })
-const result = await client.getDouyinData('搜索数据', { keyword: '测试' })
-```
-
-### v5 版本主要变化
-
 #### 1. 统一的响应格式 📦
 
 v5 版本所有 API 返回统一的响应格式：
@@ -116,6 +89,8 @@ if (result.success) {
 
 #### 3. 类型模式控制 🎯
 
+> 接口返回数据的类型类型为自动生成，仅供参考，不保证 100% 准确。
+
 支持 `strict` 和 `loose` 两种类型模式：
 
 ```javascript
@@ -132,94 +107,6 @@ const looseResult = await client.getDouyinData(
 )
 ```
 
-#### 4. 强化的参数验证 🔍
-v5 版本引入了 Zod 进行运行时参数验证，确保数据类型安全和参数完整性。
-PS: 当前更改已在 v4.5.0 往后的版本实装
-
-```javascript
-// 自动参数验证
-const result = await client.getDouyinData('搜索数据', {
-  keyword: '测试',        // ✅ 必需参数
-  offset: 0,             // ✅ 可选参数，类型正确
-  count: 20              // ✅ 可选参数，类型正确
-})
-
-// 参数验证失败示例
-const invalidResult = await client.getDouyinData('搜索数据', {
-  // ❌ 缺少必需参数 keyword
-  offset: 'invalid'      // ❌ 类型错误，应为 number
-})
-// 返回: { success: false, message: '参数验证失败: ...', code: 400 }
-```
-
-验证特性：
-
-- 🔒 类型安全 ：确保参数类型正确
-- ✅ 必需参数检查 ：自动验证必需参数是否存在
-- 🎯 值范围验证 ：验证数值范围、字符串长度等
-- 🛡️ 注入防护 ：防止恶意参数注入
-- 📝 详细错误信息 ：提供具体的验证失败原因
-
-```javascript
-// 验证错误响应示例
-{
-  code: 400,
-  message: "参数验证失败",
-  data: null,
-  errors: [
-    {
-      path: ["keyword"],
-      message: "必需参数",
-      code: "invalid_type"
-    },
-    {
-      path: ["offset"],
-      message: "期望 number 类型，收到 string",
-      code: "invalid_type"
-    }
-  ]
-}
-```
-
-### v5 版本兼容性更改 🔄
-
-#### 向后兼容性 ✅
-
-- **v4 API 完全兼容**：现有的 v4 代码无需修改即可继续使用
-- **默认导入保持 v4**：`import Client from '@ikenxuan/amagi'` 仍然使用 v4 版本
-- **渐进式迁移**：可以逐步迁移到 v5 版本，无需一次性重写
-
-#### 迁移指南 📖
-
-##### 从 v4 迁移到 v5
-
-1. **更新导入语句**：
-```javascript
-// v4
-import Client from '@ikenxuan/amagi'
-
-// v5
-import Client from '@ikenxuan/amagi/v5'
-```
-
-2. **处理响应格式**：
-```javascript
-// v4 - 直接返回数据
-const data = await amagi.getDouyinData('搜索数据', { keyword: '测试' })
-
-// v5 - 包装的响应格式
-const response = await client.getDouyinData('搜索数据', { keyword: '测试' })
-const data = response.data
-```
-
-#### 破坏性变更 ⚠️
-
-v5 版本的破坏性变更：
-
-1. **响应格式变更**：所有 API 返回包装的响应对象而非直接数据
-2. **服务器方法重命名**：`startClient()` 重命名为 `startServer()`
-3. **错误处理方式**：错误不再抛出异常，而是在响应对象中返回
-
 ## 高级用法 🔧
 
 ### 启动本地 HTTP 服务 🌐
@@ -240,86 +127,7 @@ const app = amagi.startClient()
 - 抖音 API: `http://localhost:4567/api/douyin/...` 📱
 - bilibili API: `http://localhost:4567/api/bilibili/...` 📺
 
-API 文档: https://amagi.apifox.cn 📝
-
-## 平台功能模块 🧩
-
-PS: 以下功能模块的使用方法与上述基本用法类似，我也不知道为什么要写这个。。。
-
-### 抖音功能模块 📱
-
-抖音相关功能模块提供了一系列工具和 API 接口，用于获取抖音平台的数据。
-
-```javascript
-import { douyinUtils } from '@ikenxuan/amagi'
-
-// 使用签名算法
-const mstoken = douyinUtils.sign.Mstoken(107)
-const verifyFp = douyinUtils.sign.VerifyFpManager()
-const abSign = douyinUtils.sign.AB('需要签名的地址')
-
-// 使用 API 接口
-const videoData = await douyinUtils.api.getWorkInfo(
-  { ...opt },
-  'cookies'
-)
-
-const userInfo = await douyinUtils.api.getUserProfile(
-  { ...opt },
-  'cookies'
-)
-
-// 直接获取数据
-const searchResult = await douyinUtils.getDouyinData(
-  '搜索数据',
-  { ...opt }
-  )
-```
-
-主要功能：
-
-- 📹 视频/图集作品数据获取
-- 👤 用户信息获取
-- 💬 评论数据获取
-- 🔍 搜索功能
-- 🎬 直播间信息
-- 🎵 音乐数据
-- 😄 表情数据
-
-### bilibili 功能模块 📺
-
-bilibili 相关功能模块提供了获取 bilibili 平台数据的工具和 API。
-
-```javascript
-import { bilibiliUtils } from '@ikenxuan/amagi'
-
-// 获取视频信息
-const videoInfo = await bilibiliUtils.api.getVideoInfo({ ...opt })
-
-// 获取评论数据
-const comments = await bilibiliUtils.api.getComments({ ...opt })
-
-// 直接获取数据
-const userInfo = await bilibiliUtils.getBilibiliData(
-  '用户主页数据',
-  { ...opt }
-  )
-```
-
-主要功能：
-
-- 📹 视频信息获取
-- 💬 评论数据获取
-- 👤 用户信息获取
-- 🎬 番剧信息获取
-- 📡 直播间信息
-- 📊 动态数据获取
-- 🔄 AV/BV 号转换
-
-## 类型支持 🧰
-
-该库提供完整的 TypeScript 类型支持，可以获得良好的代码提示和类型检查。✅
-虽有类型但写得和迷宫一样
+API 文档: https://amagi.apifox.cn 或 https://ikenxuan.github.io/amagi📝
 
 ## 许可证 📜
 

package/dist/default/cjs/index.cjs

@@ -27,7 +27,7 @@ var express__default = /*#__PURE__*/_interopDefault(express);
  * GPL-3.0 Licensed
  */
 
-// node_modules/.pnpm/tsup@8.5.0_@swc+core@1.13.4_tsx@4.20.4_typescript@5.9.2/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@8.5.0_@swc+core@1.13.5_tsx@4.20.5_typescript@5.9.2_yaml@2.8.1/node_modules/tsup/assets/cjs_shims.js
 var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 var getPackageLogsPath = () => {
@@ -1763,6 +1763,7 @@ var DouyinData = async (data2, cookie, requestConfig) => {
   const userAgent = (_a = baseRequestConfig.headers) == null ? void 0 : _a["User-Agent"];
   const douyinApiUrls3 = createDouyinApiUrls(userAgent);
   switch (data2.methodType) {
+    case "\u6587\u5B57\u4F5C\u54C1\u6570\u636E":
     case "\u805A\u5408\u89E3\u6790":
     case "\u89C6\u9891\u4F5C\u54C1\u6570\u636E":
     case "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E":
@@ -2233,7 +2234,7 @@ var smartPositiveInteger = (errorMessage) => {
 
 // src/validation/douyin.ts
 var DouyinWorkParamsSchema = zod.z.object({
-  methodType: zod.z.enum(["\u89C6\u9891\u4F5C\u54C1\u6570\u636E", "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E", "\u5408\u8F91\u4F5C\u54C1\u6570\u636E", "\u805A\u5408\u89E3\u6790"]),
+  methodType: zod.z.enum(["\u6587\u5B57\u4F5C\u54C1\u6570\u636E", "\u89C6\u9891\u4F5C\u54C1\u6570\u636E", "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E", "\u5408\u8F91\u4F5C\u54C1\u6570\u636E", "\u805A\u5408\u89E3\u6790"]),
   aweme_id: zod.z.string({ required_error: "\u89C6\u9891ID\u4E0D\u80FD\u4E3A\u7A7A" }).min(1, "\u89C6\u9891ID\u4E0D\u80FD\u4E3A\u7A7A")
 });
 var DouyinCommentParamsSchema = zod.z.object({
@@ -2274,6 +2275,7 @@ var DouyinEmojiProParamsSchema = zod.z.object({
   methodType: zod.z.literal("\u52A8\u6001\u8868\u60C5\u6570\u636E")
 });
 var DouyinValidationSchemas2 = {
+  "\u6587\u5B57\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
   "\u805A\u5408\u89E3\u6790": DouyinWorkParamsSchema,
   "\u89C6\u9891\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
   "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
@@ -2999,6 +3001,13 @@ var createBoundDouyinApiMethod = (methodType, cookie, requestConfig) => {
   };
 };
 var douyin = {
+  /**
+   * 获取文字作品数据
+   * @param options 请求参数，包含 aweme_id 和可选的 typeMode
+   * @param cookie 有效的用户 Cookie
+   * @returns 统一格式的API响应，包含文字作品详细信息
+   */
+  getTextWorkInfo: createDouyinApiMethod("\u6587\u5B57\u4F5C\u54C1\u6570\u636E"),
   /**
    * 聚合解析 (视频/图集/合辑)
    * @param options 请求参数，包含 aweme_id 和可选的 typeMode
@@ -3100,6 +3109,12 @@ var douyin = {
 };
 var createBoundDouyinApi = (cookie, requestConfig) => {
   return {
+    /**
+     * 获取文字作品数据
+     * @param options 请求参数，包含 aweme_id 和可选的 typeMode
+     * @returns 统一格式的API响应，包含文字作品详细信息
+     */
+    getTextWorkInfo: createBoundDouyinApiMethod("\u6587\u5B57\u4F5C\u54C1\u6570\u636E", cookie, requestConfig),
     /**
      * 聚合解析 (视频/图集/合辑)
      * @param options 请求参数，包含 aweme_id 和可选的 typeMode
@@ -3471,6 +3486,19 @@ var MajorType = /* @__PURE__ */ ((MajorType2) => {
   MajorType2["UPOWER_COMMON"] = "MAJOR_TYPE_UPOWER_COMMON";
   return MajorType2;
 })(MajorType || {});
+var AdditionalType = /* @__PURE__ */ ((AdditionalType2) => {
+  AdditionalType2["NONE"] = "ADDITIONAL_TYPE_NONE";
+  AdditionalType2["PGC"] = "ADDITIONAL_TYPE_PGC";
+  AdditionalType2["GOODS"] = "ADDITIONAL_TYPE_GOODS";
+  AdditionalType2["VOTE"] = "ADDITIONAL_TYPE_VOTE";
+  AdditionalType2["COMMON"] = "ADDITIONAL_TYPE_COMMON";
+  AdditionalType2["MATCH"] = "ADDITIONAL_TYPE_MATCH";
+  AdditionalType2["UP_RCMD"] = "ADDITIONAL_TYPE_UP_RCMD";
+  AdditionalType2["UGC"] = "ADDITIONAL_TYPE_UGC";
+  AdditionalType2["RESERVE"] = "ADDITIONAL_TYPE_RESERVE";
+  AdditionalType2["UPOWER_LOTTERY"] = "ADDITIONAL_TYPE_UPOWER_LOTTERY";
+  return AdditionalType2;
+})(AdditionalType || {});
 
 // src/index.ts
 var amagiClient = createAmagiClient;
@@ -3495,6 +3523,7 @@ var amagi = Client;
  * GPL-3.0 Licensed
  */
 
+exports.AdditionalType = AdditionalType;
 exports.ApiError = ApiError;
 exports.BilibiliAv2BvParamsSchema = BilibiliAv2BvParamsSchema;
 exports.BilibiliBangumiInfoParamsSchema = BilibiliBangumiInfoParamsSchema;

package/dist/default/esm/index.mjs

@@ -1747,6 +1747,7 @@ var DouyinData = async (data2, cookie, requestConfig) => {
   const userAgent = (_a = baseRequestConfig.headers) == null ? void 0 : _a["User-Agent"];
   const douyinApiUrls3 = createDouyinApiUrls(userAgent);
   switch (data2.methodType) {
+    case "\u6587\u5B57\u4F5C\u54C1\u6570\u636E":
     case "\u805A\u5408\u89E3\u6790":
     case "\u89C6\u9891\u4F5C\u54C1\u6570\u636E":
     case "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E":
@@ -2217,7 +2218,7 @@ var smartPositiveInteger = (errorMessage) => {
 
 // src/validation/douyin.ts
 var DouyinWorkParamsSchema = z.object({
-  methodType: z.enum(["\u89C6\u9891\u4F5C\u54C1\u6570\u636E", "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E", "\u5408\u8F91\u4F5C\u54C1\u6570\u636E", "\u805A\u5408\u89E3\u6790"]),
+  methodType: z.enum(["\u6587\u5B57\u4F5C\u54C1\u6570\u636E", "\u89C6\u9891\u4F5C\u54C1\u6570\u636E", "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E", "\u5408\u8F91\u4F5C\u54C1\u6570\u636E", "\u805A\u5408\u89E3\u6790"]),
   aweme_id: z.string({ required_error: "\u89C6\u9891ID\u4E0D\u80FD\u4E3A\u7A7A" }).min(1, "\u89C6\u9891ID\u4E0D\u80FD\u4E3A\u7A7A")
 });
 var DouyinCommentParamsSchema = z.object({
@@ -2258,6 +2259,7 @@ var DouyinEmojiProParamsSchema = z.object({
   methodType: z.literal("\u52A8\u6001\u8868\u60C5\u6570\u636E")
 });
 var DouyinValidationSchemas2 = {
+  "\u6587\u5B57\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
   "\u805A\u5408\u89E3\u6790": DouyinWorkParamsSchema,
   "\u89C6\u9891\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
   "\u56FE\u96C6\u4F5C\u54C1\u6570\u636E": DouyinWorkParamsSchema,
@@ -2983,6 +2985,13 @@ var createBoundDouyinApiMethod = (methodType, cookie, requestConfig) => {
   };
 };
 var douyin = {
+  /**
+   * 获取文字作品数据
+   * @param options 请求参数，包含 aweme_id 和可选的 typeMode
+   * @param cookie 有效的用户 Cookie
+   * @returns 统一格式的API响应，包含文字作品详细信息
+   */
+  getTextWorkInfo: createDouyinApiMethod("\u6587\u5B57\u4F5C\u54C1\u6570\u636E"),
   /**
    * 聚合解析 (视频/图集/合辑)
    * @param options 请求参数，包含 aweme_id 和可选的 typeMode
@@ -3084,6 +3093,12 @@ var douyin = {
 };
 var createBoundDouyinApi = (cookie, requestConfig) => {
   return {
+    /**
+     * 获取文字作品数据
+     * @param options 请求参数，包含 aweme_id 和可选的 typeMode
+     * @returns 统一格式的API响应，包含文字作品详细信息
+     */
+    getTextWorkInfo: createBoundDouyinApiMethod("\u6587\u5B57\u4F5C\u54C1\u6570\u636E", cookie, requestConfig),
     /**
      * 聚合解析 (视频/图集/合辑)
      * @param options 请求参数，包含 aweme_id 和可选的 typeMode
@@ -3455,6 +3470,19 @@ var MajorType = /* @__PURE__ */ ((MajorType2) => {
   MajorType2["UPOWER_COMMON"] = "MAJOR_TYPE_UPOWER_COMMON";
   return MajorType2;
 })(MajorType || {});
+var AdditionalType = /* @__PURE__ */ ((AdditionalType2) => {
+  AdditionalType2["NONE"] = "ADDITIONAL_TYPE_NONE";
+  AdditionalType2["PGC"] = "ADDITIONAL_TYPE_PGC";
+  AdditionalType2["GOODS"] = "ADDITIONAL_TYPE_GOODS";
+  AdditionalType2["VOTE"] = "ADDITIONAL_TYPE_VOTE";
+  AdditionalType2["COMMON"] = "ADDITIONAL_TYPE_COMMON";
+  AdditionalType2["MATCH"] = "ADDITIONAL_TYPE_MATCH";
+  AdditionalType2["UP_RCMD"] = "ADDITIONAL_TYPE_UP_RCMD";
+  AdditionalType2["UGC"] = "ADDITIONAL_TYPE_UGC";
+  AdditionalType2["RESERVE"] = "ADDITIONAL_TYPE_RESERVE";
+  AdditionalType2["UPOWER_LOTTERY"] = "ADDITIONAL_TYPE_UPOWER_LOTTERY";
+  return AdditionalType2;
+})(AdditionalType || {});
 
 // src/index.ts
 var amagiClient = createAmagiClient;
@@ -3479,4 +3507,4 @@ var amagi = Client;
  * GPL-3.0 Licensed
  */
 
-export { ApiError, BilibiliAv2BvParamsSchema, BilibiliBangumiInfoParamsSchema, BilibiliBangumiStreamParamsSchema, BilibiliBv2AvParamsSchema, BilibiliCommentParamsSchema, BilibiliDynamicParamsSchema, BilibiliEmojiParamsSchema, BilibiliLiveParamsSchema, BilibiliLoginParamsSchema, BilibiliQrcodeParamsSchema, BilibiliQrcodeStatusParamsSchema, BilibiliUserParamsSchema, BilibiliValidationSchemas2 as BilibiliValidationSchemas, BilibiliVideoDownloadParamsSchema, BilibiliVideoParamsSchema, CreateApp, DouyinCommentParamsSchema, DouyinCommentReplyParamsSchema, DouyinEmojiListParamsSchema, DouyinEmojiProParamsSchema, DouyinMusicParamsSchema, DouyinQrcodeParamsSchema, DouyinSearchParamsSchema, DouyinUserParamsSchema, DouyinValidationSchemas2 as DouyinValidationSchemas, DouyinWorkParamsSchema, DynamicType, KuaishouCommentParamsSchema, KuaishouEmojiParamsSchema, KuaishouValidationSchemas2 as KuaishouValidationSchemas, KuaishouVideoParamsSchema, MajorType, ValidationError, amagi, amagiClient, av2bv, bilibili, bilibiliApiUrls, bilibiliErrorCodeMap, bilibiliUtils, bv2av, createAmagiClient, createBilibiliRoutes, createBoundBilibiliApi, createBoundDouyinApi, createBoundKuaishouApi, createDouyinRoutes, createErrorResponse, createKuaishouRoutes, createSuccessResponse, Client as default, douyin, douyinApiUrls, douyinSign, douyinUtils, fetchData, fetchResponse, getBilibiliData, getDouyinData, getHeadersAndData, getKuaishouData, handleError, httpLogger, kuaishou, kuaishouApiUrls, kuaishouUtils, logMiddleware, logger, qtparam, createBilibiliRoutes as registerBilibiliRoutes, createDouyinRoutes as registerDouyinRoutes, createKuaishouRoutes as registerKuaishouRoutes, validateBilibiliParams, validateDouyinParams, validateKuaishouParams, wbi_sign };
+export { AdditionalType, ApiError, BilibiliAv2BvParamsSchema, BilibiliBangumiInfoParamsSchema, BilibiliBangumiStreamParamsSchema, BilibiliBv2AvParamsSchema, BilibiliCommentParamsSchema, BilibiliDynamicParamsSchema, BilibiliEmojiParamsSchema, BilibiliLiveParamsSchema, BilibiliLoginParamsSchema, BilibiliQrcodeParamsSchema, BilibiliQrcodeStatusParamsSchema, BilibiliUserParamsSchema, BilibiliValidationSchemas2 as BilibiliValidationSchemas, BilibiliVideoDownloadParamsSchema, BilibiliVideoParamsSchema, CreateApp, DouyinCommentParamsSchema, DouyinCommentReplyParamsSchema, DouyinEmojiListParamsSchema, DouyinEmojiProParamsSchema, DouyinMusicParamsSchema, DouyinQrcodeParamsSchema, DouyinSearchParamsSchema, DouyinUserParamsSchema, DouyinValidationSchemas2 as DouyinValidationSchemas, DouyinWorkParamsSchema, DynamicType, KuaishouCommentParamsSchema, KuaishouEmojiParamsSchema, KuaishouValidationSchemas2 as KuaishouValidationSchemas, KuaishouVideoParamsSchema, MajorType, ValidationError, amagi, amagiClient, av2bv, bilibili, bilibiliApiUrls, bilibiliErrorCodeMap, bilibiliUtils, bv2av, createAmagiClient, createBilibiliRoutes, createBoundBilibiliApi, createBoundDouyinApi, createBoundKuaishouApi, createDouyinRoutes, createErrorResponse, createKuaishouRoutes, createSuccessResponse, Client as default, douyin, douyinApiUrls, douyinSign, douyinUtils, fetchData, fetchResponse, getBilibiliData, getDouyinData, getHeadersAndData, getKuaishouData, handleError, httpLogger, kuaishou, kuaishouApiUrls, kuaishouUtils, logMiddleware, logger, qtparam, createBilibiliRoutes as registerBilibiliRoutes, createDouyinRoutes as registerDouyinRoutes, createKuaishouRoutes as registerKuaishouRoutes, validateBilibiliParams, validateDouyinParams, validateKuaishouParams, wbi_sign };