@ikenxuan/amagi 4.4.8 → 4.4.10

package/README.md

@@ -1,116 +1,190 @@
-# amagi（泥干嘛哈哈... 🎉
+# amagi /ˈæmədʒi/ 🎵
 
-* 抖音、B站的 web 端相关数据接口基于 Node.js 的实现，支持最低node版本为 v16
+抖音、bilibili 的 web 端相关数据接口基于 Node.js 的实现。支持最低 node 版本为 v18 🚀
 
-![amagi](https://socialify.git.ci/ikenxuan/amagi/image?font=Source%20Code%20Pro&forks=1&issues=1&language=1&name=1&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Auto)
+## 我是真爱粉 🧩
 
+"amagi" /ˈæmədʒi/ 名称灵感来源于网络流行的"你干嘛~哎呦~"视频，这是由歌手 cxk 的一段采访视频衍生而来的网络文化现象。这个梗在抖音和 bilibili [BV1St41137jm](https://www.bilibili.com/video/BV1St41137jm) 上广泛传播，成为了中国互联网文化的一部分。选择这个名称也象征着本项目与这些平台内容的紧密联系。🎤💃
 
-## 使用 📦
-```
-pnpm add @ikenxuan/amagi
-```
-## 快速上手 🚀
+此生必看 [BV1DL411X7jE](https://www.bilibili.com/video/BV1DL411X7jE)
 
-**_直接获取相关数据_**
-```js
-import Client, { getDouyinData, getBilibiliData  } from '@ikenxuan/amagi'
+## 项目简介 📝
 
-const douyinck = '你的抖音ck'
-const bilibilick = '你的B站ck'
+本项目最初的代码从 [kkkkkk-10086](https://github.com/ikenxuan/kkkkkk-10086) 抽离。主要负责相关数据接口的封装。
 
-// 方法1
-getDouyinData('单个视频作品数据', douyinck, { aweme_id: '7403311630219578660' })
-  .then(data => console.log('抖音：' + data))
-  .catch(err => console.error(err))
+amagi 将作为一个独立的上游模块，提供给下游 [karin-plugin-kkk](https://github.com/ikenxuan/karin-plugin-kkk) 和 [kkkkkk-10086](https://github.com/ikenxuan/kkkkkk-10086) 进行视频解析相关业务使用。这两个项目的主要业务基本已经完成，所以如果它们没有什么特殊新业务需求，amagi 大概也不会有新的 API 更新。
 
-getBilibiliData('单个视频作品数据', bilibilick, { bvid: 'BV1Nx4y147n3' })
-  .then(data => console.log('B站' + data))
-  .catch(err => console.error(err))
+当然，如果你的下游有新的业务需求，欢迎提 issue 或 pr。（其实作者本人很菜，issue 不一定能解决）
 
-// 方法2
-const amagi = new Client({
-  douyin: douyinck,
-  bilibili: bilibilick
-})
-amagi.getDouyinData('评论数据', { aweme_id: '7403311630219578660', number: 25 })
-  .then(data => console.log(data))
-  .catch(err => console.error(err))
+## 安装 📦
+
+```bash
+pnpm add @ikenxuan/amagi@latest
 ```
 
-* 参数一详见 [**抖音数据类型**](./src/types/DouyinAPIParams.ts) [**B站数据类型**](./src/types/BilibiliAPIParams.ts)
+## 默认导出使用方法 🚀
 
-* 传递对象的参数 **同上** 或参照 [**API 文档**](https://amagi.apifox.cn)
+### 基本用法 ✨
 
----
+```javascript
+import Client from '@ikenxuan/amagi'
 
-**_本地部署一个服务端_**
-* API 文档: [**Apifox**](https://amagi.apifox.cn)
+// 创建客户端实例
+const amagi = new Client({
+  douyin: '', // 抖音 cookie（可选）
+  bilibili: '', // B站 cookie（可选）
+})
 
-```js
-import amagi from '@ikenxuan/amagi'
+// 使用示例
+async function example() {
+  // 获取抖音搜索数据
+  const searchData = await amagi.getDouyinData('搜索数据', {
+    query: '热门视频',
+    number: 10,
+  })
 
-const Client = new amagi({
-  douyin: '你的抖音ck',
-  bilibili: '你的B站ck'
-})
+  // 获取B站视频数据
+  const videoData = await amagi.getBilibiliData('单个视频作品数据', {
+    bvid: 'BV1fK4y1q79u',
+  })
+
+  console.log(searchData)
+}
 
-Client.startClient(4567) // 监听端口
+example()
 ```
 
-**如果你是使用的 `commonjs` 模块，请使用 `require()` 导入**
-```js
-const Client = require('@ikenxuan/amagi').default
-const { getBilibiliData } = require('@ikenxuan/amagi')
+### 启动本地 HTTP 服务 🌐
 
-const douyinck = '你的抖音ck'
-const bilibilick = '你的B站ck'
+```javascript
+import Client from '@ikenxuan/amagi'
 
-// 初始化
 const amagi = new Client({
-  douyin: douyinck,
-  bilibili: bilibilick
+  douyin: '你的抖音cookie',
+  bilibili: '你的B站cookie',
 })
 
-// 启动http服务
-amagi.startClient(6666)
+// 启动本地服务，默认端口 4567
+const app = amagi.startClient()
+// 或指定端口
+// const app = amagi.startClient(8080)
+```
 
-// 获取抖音评论数据
-amagi.getDouyinData('评论数据', { aweme_id: '7403311630219578660', number: 25 })
-  .then(data => console.log('抖音：' + data))
-  .catch(err => console.error(err))
+启动后可通过以下路径访问 API：
 
-// 获取B站视频信息
-getBilibiliData('单个视频作品数据', bilibilick, { bvid: 'BV1Nx4y147n3' })
-  .then(data => console.log('B站' + data))
-  .catch(err => console.error(err))
-```
+- 抖音 API: `http://localhost:4567/api/douyin/...` 📱
+- bilibili API: `http://localhost:4567/api/bilibili/...` 📺
 
-## 开发构建 🛠️
+API 文档: https://amagi.apifox.cn 📝
 
-> [!IMPORTANT]
-> **开发环境下，支持最低node版本为 v18**
+## 平台功能模块 🧩
 
-* [**fork**](https://github.com/ikenxuan/amagi/fork) 项目到自己的仓库并克隆到本地
-* 安装依赖
-```
-pnpm install
-```
-* 编译
+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(
+  {
+    aweme_id: '视频ID',
+  },
+  '有效的用户 Cookie'
+)
+
+const userInfo = await douyinUtils.api.getUserProfile(
+  {
+    sec_uid: '用户ID',
+  },
+  '有效的用户 Cookie'
+)
+
+// 直接获取数据
+const searchResult = await douyinUtils.getDouyinData('搜索数据', {
+  query: '搜索关键词',
+  number: 10,
+})
 ```
-pnpm build
+
+主要功能：
+
+- 📹 视频/图集作品数据获取
+- 👤 用户信息获取
+- 💬 评论数据获取
+- 🔍 搜索功能
+- 🎬 直播间信息
+- 🎵 音乐数据
+- 😄 表情数据
+
+### bilibili 功能模块 📺
+
+bilibili 相关功能模块提供了获取 bilibili 平台数据的工具和 API。
+
+```javascript
+import { bilibiliUtils } from '@ikenxuan/amagi'
+
+// 获取视频信息
+const videoInfo = await bilibiliUtils.api.getVideoInfo({
+  bvid: 'BV1fK4y1q79u',
+})
+
+// 获取评论数据
+const comments = await bilibiliUtils.api.getComments({
+  oid: 111111, // 稿件ID，也就是AV号去除前缀后的内容
+  type: 1,
+})
+
+// 直接获取数据
+const userInfo = await bilibiliUtils.getBilibiliData('用户主页数据', {
+  host_mid: 1340190821, // 用户ID
+})
 ```
 
-## License 📜
-[GPL-3.0](https://github.com/ikenxuan/amagi/blob/main/LICENSE)
+主要功能：
+
+- 📹 视频信息获取
+- 💬 评论数据获取
+- 👤 用户信息获取
+- 🎬 番剧信息获取
+- 📡 直播间信息
+- 📊 动态数据获取
+- 🔄 AV/BV 号转换
+
+## 类型支持 🧰
+
+该库提供完整的 TypeScript 类型支持，可以获得良好的代码提示和类型检查。✅
+
+## 许可证 📜
+
+[GPL-3.0](https://github.com/ikenxuan/amagi/blob/main/LICENSE) ⚖️
+
+## 免责声明 ⚠️
+
+- ⭐ 这个项目免费开源，不存在收费。
+- 🛡️ 本项目的作者不承担任何责任，包括但不限于因使用本项目而导致的任何损失或损害。
+- 📚 本项目仅供学习和研究使用，不得用于任何商业目的。
+- 🔒 本项目的作者不对因使用本项目而产生的任何后果负责。
+- 📝 本项目的使用者在下载、安装、运行或使用本工具时，即表示已阅读并同意本免责声明。如有异议，请立即停止使用本工具，并删除所有相关文件。
+- 🔄 本项目的作者保留随时修改、更新、删除或终止本工具的权利，无需事先通知或承担任何义务。
+
+🔐 本仓库没有后门，本仓库不会上传有关你的任何信息到第三方。
+
+🍪 所传递的用户 cookies 只会用于请求官方 API 接口
 
-## 声明 ⚠️
-本库没有后门，本库不会上传有关你的任何信息到第三方。
-所配置的ck只会用于请求官方API接口
+## 鸣谢 🙏
 
-<h2>未经同意，禁止将本项目的开源代码用于任何商业目的。因使用本项目产生的一切问题与后果由使用者自行承担，项目开发者不承担任何责任</h2>
+amagi 的诞生参考了以下开源项目：
 
-## amagi 的诞生参考了以下开源项目 🙏:
-- [SocialSisterYi/bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect)
-- [NearHuiwen/TiktokDouyinCrawler](https://github.com/NearHuiwen/TiktokDouyinCrawler)
-- [Evil0ctal/Douyin_TikTok_Download_API](https://github.com/Evil0ctal/Douyin_TikTok_Download_API)
-- [Johnserf-Seed/f2](https://github.com/Johnserf-Seed/f2)
+- 🎬 [SocialSisterYi/bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect)
+- 📱 [NearHuiwen/TiktokDouyinCrawler](https://github.com/NearHuiwen/TiktokDouyinCrawler)
+- 📥 [Evil0ctal/Douyin_TikTok_Download_API](https://github.com/Evil0ctal/Douyin_TikTok_Download_API)
+- 🔄 [Johnserf-Seed/f2](https://github.com/Johnserf-Seed/f2)