@ikenxuan/amagi 2.3.0 → 2.3.1

package/README.md

@@ -11,7 +11,8 @@
 pnpm add @ikenxuan/amagi
 ```
 ## 快速上手
-直接获取相关数据
+
+**_直接获取相关数据_**
 ```js
 import { GetDouyinData, GetBilibiliData  } from '@ikenxuan/amagi'
 
@@ -24,12 +25,11 @@ const Bilibili = await GetBilibiliData('单个视频作品数据', bilibilick, {
 ```
 * 参数一详见 [**API数据类型枚举**](./src/types/DataType.ts)
 
-* 传递对象的参数详见 [**抖音接口请求参数类型**](./src/types/DouyinAPIParams.ts)、[**B站接口请求参数类型**](./src/types/BilibiliAPIParams.ts) 
+* 传递对象的参数详见 [**抖音接口请求参数类型**](./src/types/DouyinAPIParams.ts)、[**B站接口请求参数类型**](./src/types/BilibiliAPIParams.ts) 或参照 [**API 文档**](https://amagi.apifox.cn)
 
 ---
 
-使用以下方法可以将 amagi 的内部 API 暴露出来，提供外部调用
-
+**_本地部署一个服务端_**
 * API 文档: [**Apifox**](https://amagi.apifox.cn)
 
 ```js

package/lib/index.d.ts

@@ -4,7 +4,7 @@ export * from "./server/index.js";
 export * from "./types/index.js";
 export { amagi as Amagi, amagi as default };
 import { client } from "./server/index.js";
-import { DouyinDataType, DouyinOptionsType, BilibiliDataType, BilibiliOptionsType } from './types/index.js';
+import { DouyinDataOptionsMap, BilibiliDataOptionsMap } from './types/index.js';
 declare const amagi: typeof client;
 /**
  *
@@ -13,7 +13,7 @@ declare const amagi: typeof client;
  * @param options 请求参数，是一个对象
  * @returns 返回接口的原始数据
  */
-export declare const GetDouyinData: (type: keyof typeof DouyinDataType, cookie?: string, options?: DouyinOptionsType) => Promise<any>;
+export declare const GetDouyinData: <T extends keyof DouyinDataOptionsMap>(type: T, cookie: string | undefined, options: DouyinDataOptionsMap[T]) => Promise<any>;
 /**
  *
  * @param type 请求数据类型
@@ -21,4 +21,4 @@ export declare const GetDouyinData: (type: keyof typeof DouyinDataType, cookie?:
  * @param options 请求参数，是一个对象
  * @returns 返回接口的原始数据
  */
-export declare const GetBilibiliData: (type: keyof typeof BilibiliDataType, cookie?: string, options?: BilibiliOptionsType) => Promise<any>;
+export declare const GetBilibiliData: <T extends keyof BilibiliDataOptionsMap>(type: T, cookie: string | undefined, options: BilibiliDataOptionsMap[T]) => Promise<any>;

package/lib/index.js

@@ -13,7 +13,7 @@ const amagi = client;
  * @param options 请求参数，是一个对象
  * @returns 返回接口的原始数据
  */
-export const GetDouyinData = async (type, cookie = '', options = {}) => {
+export const GetDouyinData = async (type, cookie = '', options) => {
     const data = await DouyinResult({ type, cookie }, options);
     return data.data;
 };
@@ -24,8 +24,8 @@ export const GetDouyinData = async (type, cookie = '', options = {}) => {
  * @param options 请求参数，是一个对象
  * @returns 返回接口的原始数据
  */
-export const GetBilibiliData = async (type, cookie = '', options = {}) => {
+export const GetBilibiliData = async (type, cookie = '', options) => {
     const data = await BilibiliResult({ type, cookie }, options);
     return data.data;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxnQkFBZ0IsQ0FBQTtBQUM5QixjQUFjLGFBQWEsQ0FBQTtBQUMzQixjQUFjLGNBQWMsQ0FBQTtBQUM1QixjQUFjLGFBQWEsQ0FBQTtBQUMzQixPQUFPLEVBQUUsS0FBSyxJQUFJLEtBQUssRUFBRSxLQUFLLElBQUksT0FBTyxFQUFFLENBQUE7QUFDM0MsT0FBTyxFQUFFLFlBQVksRUFBRSxjQUFjLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQTtBQUM3RCxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sY0FBYyxDQUFBO0FBR3JDLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQTtBQUVwQjs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxFQUFFLElBQWlDLEVBQUUsU0FBUyxFQUFZLEVBQUUsVUFBVSxFQUF1QixFQUFnQixFQUFFO0lBQy9JLE1BQU0sSUFBSSxHQUFHLE1BQU0sWUFBWSxDQUFDLEVBQUUsSUFBSSxFQUFFLE1BQU0sRUFBRSxFQUFFLE9BQU8sQ0FBQyxDQUFBO0lBQzFELE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQTtBQUNsQixDQUFDLENBQUE7QUFFRDs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsS0FBSyxFQUFFLElBQW1DLEVBQUUsU0FBUyxFQUFZLEVBQUUsVUFBVSxFQUF5QixFQUFnQixFQUFFO0lBQ3JKLE1BQU0sSUFBSSxHQUFHLE1BQU0sY0FBYyxDQUFDLEVBQUUsSUFBSSxFQUFFLE1BQU0sRUFBRSxFQUFFLE9BQU8sQ0FBQyxDQUFBO0lBQzVELE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQTtBQUNsQixDQUFDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxnQkFBZ0IsQ0FBQTtBQUM5QixjQUFjLGFBQWEsQ0FBQTtBQUMzQixjQUFjLGNBQWMsQ0FBQTtBQUM1QixjQUFjLGFBQWEsQ0FBQTtBQUMzQixPQUFPLEVBQUUsS0FBSyxJQUFJLEtBQUssRUFBRSxLQUFLLElBQUksT0FBTyxFQUFFLENBQUE7QUFDM0MsT0FBTyxFQUFFLFlBQVksRUFBRSxjQUFjLEVBQUUsTUFBTSxnQkFBZ0IsQ0FBQTtBQUM3RCxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sY0FBYyxDQUFBO0FBR3JDLE1BQU0sS0FBSyxHQUFHLE1BQU0sQ0FBQTtBQUVwQjs7Ozs7O0dBTUc7QUFDSCxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxFQUNoQyxJQUFPLEVBQ1AsU0FBUyxFQUFZLEVBQ3JCLE9BQWdDLEVBQ2xCLEVBQUU7SUFDaEIsTUFBTSxJQUFJLEdBQUcsTUFBTSxZQUFZLENBQUMsRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLEVBQUUsT0FBTyxDQUFDLENBQUE7SUFDMUQsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFBO0FBQ2xCLENBQUMsQ0FBQTtBQUVEOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBRyxLQUFLLEVBQ2xDLElBQU8sRUFDUCxTQUFTLEVBQVksRUFDckIsT0FBa0MsRUFDcEIsRUFBRTtJQUNoQixNQUFNLElBQUksR0FBRyxNQUFNLGNBQWMsQ0FBQyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsRUFBRSxPQUFPLENBQUMsQ0FBQTtJQUM1RCxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUE7QUFDbEIsQ0FBQyxDQUFBIn0=

package/lib/types/BilibiliAPIParams.d.ts

@@ -1,8 +1,13 @@
 type VideoInfoParams = {
-    /** ID类型 */
-    id_type: 'bvid' | 'aid';
+    /**
+     * 视频分享URL。建议使用 id_type 和 id 字段作为参数，url参数可能不稳定
+     * @deprecated
+     */
+    url?: string;
+    /** 稿件 ID 类型，一般为 bvid */
+    id_type?: 'bvid' | 'aid';
     /** 稿件ID */
-    id: string;
+    id?: string;
 };
 type VideoStreamParams = {
     /** 稿件AVID */
@@ -18,7 +23,7 @@ type CommentParams = {
     /** 稿件ID，也就是AVID */
     oid?: number | string;
     /** 获取的评论数量，默认最高20 */
-    number?: number;
+    number?: number | string;
 };
 type BangumiInfoParams = {
     /** 稿件ID是否为epid */
@@ -60,4 +65,21 @@ export type BilibiliAPIParams = {
     LiveRoomParams: LiveRoomParams;
     QrcodeParams: QrcodeParams;
 };
+export type BilibiliDataOptionsMap = {
+    '单个视频作品数据': VideoInfoParams;
+    '单个视频下载信息数据': VideoStreamParams;
+    '评论数据': CommentParams;
+    '用户主页数据': UserParams;
+    '用户主页动态列表数据': UserParams;
+    'emoji数据': {};
+    '番剧基本信息数据': BangumiInfoParams;
+    '番剧下载信息数据': BangumiStreamParams;
+    '动态详情数据': DynamicParams;
+    '动态卡片数据': DynamicParams;
+    '直播间信息': LiveRoomParams;
+    '直播间初始化信息': LiveRoomParams;
+    '登录基本信息': {};
+    '申请二维码': {};
+    '二维码状态': QrcodeParams;
+};
 export {}

package/lib/types/DouyinAPIParams.d.ts

@@ -1,6 +1,11 @@
 type WorkParams = {
+    /**
+     * 视频分享URL。建议使用 aweme_id 参数，url参数可能不稳定
+     * @deprecated
+     */
+    url?: string;
     /** 视频ID */
-    aweme_id: string;
+    aweme_id?: string;
     /** 获取的评论数量 */
     number?: number | string;
 };
@@ -42,4 +47,19 @@ export type DouyinAPIParams = {
     LiveRoomParams: LiveRoomParams;
     QrcodeParams: QrcodeParams;
 };
+export type DouyinDataOptionsMap = {
+    '二级评论数据': CommentParams;
+    '用户主页数据': UserParams;
+    '单个视频作品数据': WorkParams;
+    '评论数据': CommentParams;
+    '用户主页视频列表数据': UserParams;
+    '热点词数据': SearchParams;
+    '搜索数据': SearchParams;
+    '官方emoji数据': {};
+    '动态表情数据': {};
+    '音乐数据': MusicParams;
+    '图集作品数据': WorkParams;
+    '实况图片图集数据': WorkParams;
+    '直播间信息数据': LiveRoomParams;
+};
 export {}

package/lib/types/OptionsType.d.ts

@@ -29,7 +29,7 @@ export type DouyinOptionsType = {
     /**
      * 评论数量，单位条
      */
-    number?: number;
+    number?: number | string;
     /**
      * 直播间ID（虚拟的）
      */
@@ -86,7 +86,7 @@ export type BilibiliOptionsType = {
     /**
      * 评论数量，单位条
      */
-    number?: number;
+    number?: number | string;
     /**
      * 用户 Cookie
      */
@@ -98,9 +98,9 @@ export type BilibiliOptionsType = {
     /**
      * 评论区类型代码
      */
-    commentstype?: number;
+    commentstype?: number | string;
     /**
      * 评论区查询专属参数
      */
-    oid?: number;
+    oid?: number | string;
 };

package/lib/types/index.d.ts

@@ -1,9 +1,9 @@
-import { type BilibiliAPIParams } from './BilibiliAPIParams.js'
+import { type BilibiliAPIParams, type BilibiliDataOptionsMap } from './BilibiliAPIParams.js'
 import { type ConfigType } from './ConfigType.js'
 import { BilibiliDataType, DouyinDataType } from './DataType.js'
-import { type DouyinAPIParams } from './DouyinAPIParams.js'
+import { type DouyinAPIParams, type DouyinDataOptionsMap } from './DouyinAPIParams.js'
 import { type GetDataResponseType } from './GetDataResponseType.js'
 import { type NetworksConfigType } from './NetworksConfigType.js'
 import { type BilibiliOptionsType, type DouyinOptionsType } from './OptionsType.js'
 export * from './Request.js'
-export { BilibiliAPIParams, BilibiliDataType, BilibiliOptionsType, ConfigType, DouyinAPIParams, DouyinDataType, DouyinOptionsType, GetDataResponseType, NetworksConfigType }
+export { BilibiliAPIParams, BilibiliDataType, BilibiliOptionsType, ConfigType, DouyinAPIParams, DouyinDataType, DouyinOptionsType, GetDataResponseType, NetworksConfigType, DouyinDataOptionsMap, BilibiliDataOptionsMap }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikenxuan/amagi",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -29,7 +29,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "axios": "^1.7.5",
+    "axios": "^1.7.7",
     "fastify": "^4.28.1",
     "lodash": "^4.17.21",
     "log4js": "6.9.0",
@@ -39,12 +39,12 @@
   "devDependencies": {
     "@types/lodash": "^4.17.7",
     "@types/md5": "^2.3.5",
-    "@types/node": "^22.5.1",
-    "@typescript-eslint/parser": "^8.3.0",
-    "eslint": "^9.9.1",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/parser": "^8.5.0",
+    "eslint": "^9.10.0",
     "globals": "^15.9.0",
     "tsc-alias": "^1.8.10",
-    "tsx": "^4.19.0",
+    "tsx": "^4.19.1",
     "typescript": "^5.5.4"
   }
 }