@alemonjs/qq-bot 2.1.33 → 2.1.34

package/lib/types.d.ts

@@ -1,48 +1,59 @@
-export type DataArkListTip = {
-    type: 'Ark.listTip';
-    value: {
-        desc: string;
-        prompt: string;
-    };
+//#region src/types.d.ts
+/**
+ * QQ-Bot 平台专用类型定义
+ * 这些类型仅在 QQ-Bot 平台使用，不属于框架标准格式
+ */
+type DataArkListTip = {
+  type: 'Ark.listTip';
+  value: {
+    desc: string;
+    prompt: string;
+  };
 };
-export type DataArkListItem = {
-    type: 'Ark.listItem';
-    value: string | {
-        title: string;
-        link: string;
-    };
+type DataArkListItem = {
+  type: 'Ark.listItem';
+  value: string | {
+    title: string;
+    link: string;
+  };
 };
-export type DataArkListContent = {
-    type: 'Ark.listContent';
-    value: DataArkListItem[];
+type DataArkListContent = {
+  type: 'Ark.listContent';
+  value: DataArkListItem[];
 };
-export type DataArkList = {
-    type: 'Ark.list';
-    value: [DataArkListTip, DataArkListContent];
+type DataArkList = {
+  type: 'Ark.list';
+  value: [DataArkListTip, DataArkListContent];
 };
-export type DataArkCard = {
-    type: 'Ark.Card';
-    value: {
-        title: string;
-        cover: string;
-        link: string;
-        subtitle: string;
-        decs: string;
-        prompt: string;
-        metadecs: string;
-    };
+type DataArkCard = {
+  type: 'Ark.Card';
+  value: {
+    title: string;
+    cover: string;
+    link: string;
+    subtitle: string;
+    decs: string;
+    prompt: string;
+    metadecs: string;
+  };
 };
-export type DataArkBigCard = {
-    type: 'Ark.BigCard';
-    value: {
-        title: string;
-        subtitle: string;
-        cover: string;
-        link: string;
-        prompt: string;
-    };
+type DataArkBigCard = {
+  type: 'Ark.BigCard';
+  value: {
+    title: string;
+    subtitle: string;
+    cover: string;
+    link: string;
+    prompt: string;
+  };
 };
-export type DataButtonTemplate = {
-    type: 'ButtonTemplate';
-    value: string;
+/**
+ * 按钮模板数据
+ * value 为 QQ Bot 平台侧的模板 ID
+ */
+type DataButtonTemplate = {
+  type: 'ButtonTemplate';
+  value: string;
 };
+//#endregion
+export { DataArkBigCard, DataArkCard, DataArkList, DataArkListContent, DataArkListItem, DataArkListTip, DataButtonTemplate };

package/lib/types.js

@@ -1 +1 @@
-
+export {  };

package/lib/upload.d.ts

@@ -1,21 +1,50 @@
-import type { QQBotAPI } from './sdk/api';
-import { FileType } from './sdk/typing';
-export declare const CHUNK_THRESHOLD = 10002432;
-export declare const fileDataToBuffer: (fileData: any) => Buffer | null;
-export declare const computeFileDigests: (filePath: string) => {
-    buffer: NonSharedBuffer;
-    md5: string;
-    sha1: string;
-    md5_10m: string;
+import { FileType } from "./sdk/typing.js";
+import { QQBotAPI } from "./sdk/api.js";
+//#region src/upload.d.ts
+/**
+ * 分片上传辅助
+ * 流程：upload_prepare 拿 upload_id 与每片 presigned_url
+ * → 分片字节 PUT 直传 COS 预签名地址
+ * → 每片成功后 upload_part_finish 上报
+ * → 全部完成后 postRichMediaByUser/ByGroup 携带 upload_id 合并，得到 file_info
+ */
+/**
+ * 大文件分片上传阈值（字节），即 md5_10m 计算区间大小（约 10MB）
+ */
+declare const CHUNK_THRESHOLD = 10002432;
+/**
+ * 将 file_data（base64 字符串或 Buffer）转为 Buffer
+ * @param fileData 文件数据
+ */
+declare const fileDataToBuffer: (fileData: any) => Buffer | null;
+/**
+ * 计算文件摘要
+ * @param filePath 本地文件路径
+ */
+declare const computeFileDigests: (filePath: string) => {
+  buffer: NonSharedBuffer;
+  md5: string;
+  sha1: string;
+  md5_10m: string;
 };
-export declare const chunkedUpload: (client: QQBotAPI, scope: "user" | "group", openId: string, file: string | Buffer, options: {
-    file_type: FileType;
-    file_name?: string;
-    srv_send_msg?: boolean;
+/**
+ * 分片上传完整流程
+ * @param client QQBot API 客户端
+ * @param scope user 单聊 / group 群聊
+ * @param openId 用户或群的 OpenID
+ * @param file 本地文件路径或文件内容
+ * @param options 上传选项
+ */
+declare const chunkedUpload: (client: QQBotAPI, scope: 'user' | 'group', openId: string, file: string | Buffer, options: {
+  file_type: FileType;
+  file_name?: string;
+  srv_send_msg?: boolean;
 }) => Promise<{
-    file_uuid: string;
-    file_info: string;
-    ttl: number;
-    id?: string;
-    raw_url?: string;
+  file_uuid: string;
+  file_info: string;
+  ttl: number;
+  id?: string;
+  raw_url?: string;
 }>;
+//#endregion
+export { CHUNK_THRESHOLD, chunkedUpload, computeFileDigests, fileDataToBuffer };

package/lib/upload.js

@@ -1,60 +1,89 @@
-import { createHash } from 'crypto';
-import { readFileSync } from 'fs';
+import { readFileSync } from "fs";
+import { createHash } from "crypto";
 
+//#region src/upload.ts
+/**
+* 分片上传辅助
+* 流程：upload_prepare 拿 upload_id 与每片 presigned_url
+* → 分片字节 PUT 直传 COS 预签名地址
+* → 每片成功后 upload_part_finish 上报
+* → 全部完成后 postRichMediaByUser/ByGroup 携带 upload_id 合并，得到 file_info
+*/
+/**
+* 大文件分片上传阈值（字节），即 md5_10m 计算区间大小（约 10MB）
+*/
 const CHUNK_THRESHOLD = 10002432;
+/**
+* 将 file_data（base64 字符串或 Buffer）转为 Buffer
+* @param fileData 文件数据
+*/
 const fileDataToBuffer = (fileData) => {
-    if (!fileData) {
-        return null;
-    }
-    if (Buffer.isBuffer(fileData)) {
-        return fileData;
-    }
-    if (typeof fileData === 'string') {
-        if (fileData.indexOf('base64://') === 0) {
-            return Buffer.from(fileData.replace('base64://', ''), 'base64');
-        }
-        return Buffer.from(fileData, 'base64');
-    }
-    return null;
+	if (!fileData) return null;
+	if (Buffer.isBuffer(fileData)) return fileData;
+	if (typeof fileData === "string") {
+		if (fileData.indexOf("base64://") === 0) return Buffer.from(fileData.replace("base64://", ""), "base64");
+		return Buffer.from(fileData, "base64");
+	}
+	return null;
 };
+/**
+* 计算文件摘要
+* @param filePath 本地文件路径
+*/
 const computeFileDigests = (filePath) => {
-    const buffer = readFileSync(filePath);
-    const md5 = createHash('md5').update(buffer).digest('hex');
-    const sha1 = createHash('sha1').update(buffer).digest('hex');
-    const md5_10m = createHash('md5').update(buffer.subarray(0, CHUNK_THRESHOLD)).digest('hex');
-    return { buffer, md5, sha1, md5_10m };
+	const buffer = readFileSync(filePath);
+	return {
+		buffer,
+		md5: createHash("md5").update(buffer).digest("hex"),
+		sha1: createHash("sha1").update(buffer).digest("hex"),
+		md5_10m: createHash("md5").update(buffer.subarray(0, CHUNK_THRESHOLD)).digest("hex")
+	};
 };
+/**
+* 分片上传完整流程
+* @param client QQBot API 客户端
+* @param scope user 单聊 / group 群聊
+* @param openId 用户或群的 OpenID
+* @param file 本地文件路径或文件内容
+* @param options 上传选项
+*/
 const chunkedUpload = async (client, scope, openId, file, options) => {
-    const buffer = typeof file === 'string' ? readFileSync(file) : file;
-    const md5 = createHash('md5').update(buffer).digest('hex');
-    const sha1 = createHash('sha1').update(buffer).digest('hex');
-    const md5_10m = createHash('md5').update(buffer.subarray(0, CHUNK_THRESHOLD)).digest('hex');
-    const file_name = options.file_name ?? (typeof file === 'string' ? (file.split(/[\\/]/).pop() ?? 'file') : 'file');
-    const prepareData = {
-        file_type: options.file_type,
-        file_name,
-        file_size: String(buffer.byteLength),
-        md5,
-        sha1,
-        md5_10m
-    };
-    const prepare = await (scope === 'user' ? client.usersUploadPrepare(openId, prepareData) : client.groupUploadPrepare(openId, prepareData));
-    const blockSize = Number(prepare.block_size);
-    for (const part of prepare.parts) {
-        const start = part.index * blockSize;
-        const chunk = Buffer.from(buffer.subarray(start, start + Number(part.block_size)));
-        const partMd5 = createHash('md5').update(chunk).digest('hex');
-        await client.uploadPartDirect(part.presigned_url, chunk);
-        const finishData = {
-            upload_id: prepare.upload_id,
-            part_index: part.index,
-            block_size: part.block_size,
-            md5: partMd5
-        };
-        await (scope === 'user' ? client.usersUploadPartFinish(openId, finishData) : client.groupUploadPartFinish(openId, finishData));
-    }
-    const merge = { file_type: options.file_type, upload_id: prepare.upload_id, file_name, srv_send_msg: options.srv_send_msg };
-    return scope === 'user' ? client.postRichMediaByUser(openId, merge) : client.postRichMediaByGroup(openId, merge);
+	const buffer = typeof file === "string" ? readFileSync(file) : file;
+	const md5 = createHash("md5").update(buffer).digest("hex");
+	const sha1 = createHash("sha1").update(buffer).digest("hex");
+	const md5_10m = createHash("md5").update(buffer.subarray(0, CHUNK_THRESHOLD)).digest("hex");
+	const file_name = options.file_name ?? (typeof file === "string" ? file.split(/[\\/]/).pop() ?? "file" : "file");
+	const prepareData = {
+		file_type: options.file_type,
+		file_name,
+		file_size: String(buffer.byteLength),
+		md5,
+		sha1,
+		md5_10m
+	};
+	const prepare = await (scope === "user" ? client.usersUploadPrepare(openId, prepareData) : client.groupUploadPrepare(openId, prepareData));
+	const blockSize = Number(prepare.block_size);
+	for (const part of prepare.parts) {
+		const start = part.index * blockSize;
+		const chunk = Buffer.from(buffer.subarray(start, start + Number(part.block_size)));
+		const partMd5 = createHash("md5").update(chunk).digest("hex");
+		await client.uploadPartDirect(part.presigned_url, chunk);
+		const finishData = {
+			upload_id: prepare.upload_id,
+			part_index: part.index,
+			block_size: part.block_size,
+			md5: partMd5
+		};
+		await (scope === "user" ? client.usersUploadPartFinish(openId, finishData) : client.groupUploadPartFinish(openId, finishData));
+	}
+	const merge = {
+		file_type: options.file_type,
+		upload_id: prepare.upload_id,
+		file_name,
+		srv_send_msg: options.srv_send_msg
+	};
+	return scope === "user" ? client.postRichMediaByUser(openId, merge) : client.postRichMediaByGroup(openId, merge);
 };
 
-export { CHUNK_THRESHOLD, chunkedUpload, computeFileDigests, fileDataToBuffer };
+//#endregion
+export { CHUNK_THRESHOLD, chunkedUpload, computeFileDigests, fileDataToBuffer };

package/lib/utils.d.ts

@@ -1 +1,9 @@
-export declare const isGuild: (str: string) => boolean;
+//#region src/utils.d.ts
+/**
+ *
+ * @param str
+ * @returns
+ */
+declare const isGuild: (str: string) => boolean;
+//#endregion
+export { isGuild };

package/lib/utils.js

@@ -1,8 +1,13 @@
+//#region src/utils.ts
+/**
+*
+* @param str
+* @returns
+*/
 const isGuild = (str) => {
-    if (isNaN(Number(str.substring(0, 6)))) {
-        return false;
-    }
-    return true;
+	if (isNaN(Number(str.substring(0, 6)))) return false;
+	return true;
 };
 
-export { isGuild };
+//#endregion
+export { isGuild };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alemonjs/qq-bot",
-  "version": "2.1.33",
+  "version": "2.1.34",
   "description": "QQ官方平台",
   "author": "lemonade",
   "license": "MIT",
@@ -8,7 +8,9 @@
   "main": "lib/index.js",
   "scripts": {
     "build": "lvy build",
-    "test:ws": "yarn build && node tests/websocket.integration.mjs"
+    "test:ws": "yarn build && node tests/websocket.integration.mjs",
+    "test:send": "yarn build && node tests/use-send.notice.mjs",
+    "test:qr": "yarn build && node tests/qr-auth.mjs"
   },
   "dependencies": {
     "@noble/curves": "^1.7.0",
@@ -24,7 +26,8 @@
     "public-ip": "^6.0.1",
     "qrcode": "^1.5.3",
     "uuid": "^14.0.1",
-    "ws": "^8.13.0"
+    "ws": "^8.13.0",
+    "yaml": "^2.5.1"
   },
   "peerDependencies": {
     "alemonjs": "^2.1.0-alpha.15"
@@ -44,13 +47,13 @@
       {
         "name": "app_id",
         "type": "string",
-        "required": true,
+        "required": false,
         "description": "app_id"
       },
       {
         "name": "secret",
         "type": "string",
-        "required": true,
+        "required": false,
         "description": "secret"
       }
     ],
@@ -94,5 +97,5 @@
     "type": "git",
     "url": "https://github.com/lemonade-lab/alemonjs.git"
   },
-  "gitHead": "6c93b0455b8db78ffa1a83becc1c2de19ba544db"
+  "gitHead": "8e6c0d91889ff7926fc7bc58ac8dc664c8f721ea"
 }