@rdjksp/node-napcat-ts 0.4.20

package/dist/Structs.js

@@ -0,0 +1,230 @@
+export const Structs = {
+    /**
+     * 发送文字消息
+     * @param text 要发送的文字
+     * @returns { type: 'text', data: { text } }
+     */
+    text: function (text) {
+        return { type: 'text', data: { text } };
+    },
+    /**
+     * @某人
+     * @param qq at的QQ号
+     * @returns { type: 'at', data: { qq } }
+     */
+    at: function (qq) {
+        return { type: 'at', data: { qq: qq.toString() } };
+    },
+    /**
+     * 回复消息
+     * @param id 回复的消息id
+     * @returns { type: 'reply', data: { id } }
+     */
+    reply: function (id) {
+        return { type: 'reply', data: { id: id.toString() } };
+    },
+    /**
+     * 发送QQ表情
+     * @param id QQ 表情 ID
+     * @returns { type: 'face', data: { id, resultId, chainCount } }
+     */
+    face: function (id) {
+        return { type: 'face', data: { id: id.toString() } };
+    },
+    /**
+     * 发送QQ表情包
+     * @param emoji_id 表情id
+     * @param emoji_package_id 表情包id
+     * @param key 未知(必要)
+     * @param summary 表情简介,可选
+     * @returns { type: 'mface', data: { summary, emoji_id, emoji_package_id, key } }
+     */
+    mface: function (emoji_id, emoji_package_id, key, summary) {
+        return {
+            type: 'mface',
+            data: {
+                summary,
+                emoji_id: emoji_id.toString(),
+                emoji_package_id: emoji_package_id.toString(),
+                key,
+            },
+        };
+    },
+    /**
+     * 发送图片
+     * @param file 网络图片地址, 文件路径或者Buffer
+     * @param name 图片名
+     * @param summary 图片简介
+     * @param sub_type 图片类型
+     * @returns { type: 'image', data: { file, summary, sub_type } }
+     */
+    image: function (file, summary, sub_type) {
+        return {
+            type: 'image',
+            data: {
+                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
+                summary,
+                sub_type: sub_type?.toString(),
+            },
+        };
+    },
+    /**
+     * 发文件
+     * @param file 网络文件地址, 文件路径或者Buffer
+     * @param name 文件名
+     * @returns { type: 'file', data: { file, name } }
+     */
+    file: function (file, name) {
+        return {
+            type: 'file',
+            data: {
+                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
+                name,
+            },
+        };
+    },
+    /**
+     * 发视频
+     * @param file 网络视频地址, 文件路径或者Buffer
+     * @param name 视频名
+     * @param thumb 预览图
+     * @returns { type: 'video', data: { file, name, thumb } }
+     */
+    video: function (file, name, thumb) {
+        return {
+            type: 'video',
+            data: {
+                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
+                name,
+                thumb,
+            },
+        };
+    },
+    /**
+     * 发语音
+     * @param file 网络语音地址, 文件路径或者Buffer
+     * @param name 语音备注
+     * @returns { type: 'record', data: { file, name } }
+     */
+    record: function (file) {
+        return {
+            type: 'record',
+            data: {
+                file: Buffer.isBuffer(file) ? `base64://${file.toString('base64')}` : file,
+            },
+        };
+    },
+    /**
+     * 发送json消息
+     * @param data json信息(序列化后)
+     * @returns { type: 'json', data: { data } }
+     */
+    json: function (data) {
+        return { type: 'json', data: { data } };
+    },
+    /**
+     * 发送骰子魔法表情
+     * @returns { type: 'dice', data: {} }
+     */
+    dice: function () {
+        return { type: 'dice', data: {} };
+    },
+    /**
+     * 发送猜拳魔法
+     * @returns { type: 'rps', data: {} }
+     */
+    rps: function () {
+        return { type: 'rps', data: {} };
+    },
+    /**
+     * 发送markdown
+     * @param data markdown内容
+     * @returns { type: 'markdown', data: {} }
+     */
+    markdown: function (content) {
+        return { type: 'markdown', data: { content } };
+    },
+    /**
+     * 音乐分享
+     * @param type QQ音乐或网易云音乐QQ音乐
+     * @param id 音乐id
+     * @returns { type: 'music', data: { type, id } }
+     */
+    music: function (type, id) {
+        return { type: 'music', data: { type, id: id.toString() } };
+    },
+    /**
+     * 分享非qq、网易云音乐 需要配置签名服务器
+     * @param url 点击后跳转目标 URL
+     * @param audio 音乐 URL
+     * @param title 标题
+     * @param image 发送时可选，内容描述
+     * @param singer 发送时可选，图片 URL
+     * @returns { type: 'music', data: { type: 'custom', url, audio, title, image, singer } }
+     */
+    customMusic: function (type, url, image, audio, title, singer) {
+        return { type: 'music', data: { type, url, audio, title, image, singer } };
+    },
+    /**
+     * 转发消息节点
+     * @param id 消息id
+     * @param user_id 消息id
+     * @param nickname 消息id
+     * @param source 消息id
+     * @param id 消息id
+     * @param id 消息id
+     * @returns { type: 'node', data: { id } }
+     */
+    node: function (id, user_id, nickname, source, news, summary, prompt, time) {
+        return {
+            type: 'node',
+            data: {
+                id: id.toString(),
+                user_id: user_id?.toString(),
+                nickname,
+                source,
+                news,
+                summary,
+                prompt,
+                time: time?.toString(),
+            },
+        };
+    },
+    /**
+     * 自定义转发消息节点
+     * @param content 消息内容
+     * @returns { type: 'node', data: { content } }
+     */
+    customNode: function (content, user_id, nickname, source, news, summary, prompt, time) {
+        return {
+            type: 'node',
+            data: {
+                content,
+                user_id: user_id?.toString(),
+                nickname,
+                source,
+                news,
+                summary,
+                prompt,
+                time: time?.toString(),
+            },
+        };
+    },
+    /**
+     * 转发消息
+     * @param message_id 消息id
+     * @return { type: 'forward', data: { id }}
+     */
+    forward: function (message_id) {
+        return { type: 'forward', data: { id: message_id.toString() } };
+    },
+    /**
+     * 发送名片
+     * @param type 名片类型
+     * @param id 联系人QQ号
+     * @returns { type: 'contact', data: { id } }
+     */
+    contact: function (type, id) {
+        return { type: 'contact', data: { type, id: id.toString() } };
+    },
+};

package/dist/Utils.d.ts

@@ -0,0 +1,18 @@
+import type { Receive, SendMessageSegment, UnSafeStruct } from './Structs.js';
+export declare const logger: {
+    warn: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+    dir: (json: any) => void;
+};
+export declare const SPLIT: RegExp;
+export declare const CQ_TAG_REGEXP: RegExp;
+/**
+ * CQ码转JSON
+ */
+export declare function convertCQCodeToJSON(msg: string): Receive[keyof Receive][] | SendMessageSegment[];
+/**
+ * JSON转CQ码
+ */
+export declare function convertJSONToCQCode(json: UnSafeStruct | UnSafeStruct[]): string;
+export declare function CQCodeDecode(str: string | any): string;
+export declare function CQCodeEncode(str: string): string;

package/dist/Utils.js

@@ -0,0 +1,65 @@
+const getTime = () => new Date().toLocaleString();
+export const logger = {
+    warn: (...args) => {
+        console.warn(`[${getTime()}]`, ...args);
+    },
+    debug: (...args) => {
+        console.debug(`[${getTime()}]`, ...args);
+    },
+    dir: (json) => {
+        console.dir(json, { depth: null });
+    },
+};
+export const SPLIT = /(?=\[CQ:)|(?<=])/;
+export const CQ_TAG_REGEXP = /^\[CQ:([a-z]+)(?:,([^\]]+))?]$/;
+/**
+ * CQ码转JSON
+ */
+export function convertCQCodeToJSON(msg) {
+    return CQCodeDecode(msg)
+        .split(SPLIT)
+        .map((tagStr) => {
+        const match = CQ_TAG_REGEXP.exec(tagStr);
+        if (match === null)
+            return { type: 'text', data: { text: tagStr } };
+        const [, tagName, value] = match;
+        if (value === undefined)
+            return { type: tagName, data: {} };
+        const data = Object.fromEntries(value.split(',').map((item) => item.split('=')));
+        return { type: tagName, data };
+    });
+}
+const _conver = (json) => {
+    if (json.type === 'text')
+        return json.data.text;
+    return `[CQ:${json.type}${Object.entries(json.data)
+        .map(([k, v]) => (v ? `,${k}=${v}` : ''))
+        .join('')}]`;
+};
+/**
+ * JSON转CQ码
+ */
+export function convertJSONToCQCode(json) {
+    if (Array.isArray(json)) {
+        return json.map((item) => _conver(item)).join('');
+    }
+    else {
+        return _conver(json);
+    }
+}
+export function CQCodeDecode(str) {
+    if (typeof str !== 'string')
+        return String(str || ''); // 尝试转换为字符串，或返回空字符串
+    return str
+        .replace(/&#44;/g, ',')
+        .replace(/&#91;/g, '[')
+        .replace(/&#93;/g, ']')
+        .replace(/&amp;/g, '&');
+}
+export function CQCodeEncode(str) {
+    return str
+        .replace(/,/g, '&#44;')
+        .replace(/\[/g, '&#91;')
+        .replace(/]/g, '&#93;')
+        .replace(/&/g, '&amp;');
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './NCWebsocketApi.js';
+export * from './Interfaces.js';
+export * from './Structs.js';
+export * from './Utils.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './NCWebsocketApi.js';
+export * from './Interfaces.js';
+export * from './Structs.js';
+export * from './Utils.js';

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@rdjksp/node-napcat-ts",
+  "version": "0.4.20",
+  "description": "napcat SDK for Node",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/**/*"
+  ],
+  "keywords": [
+    "websocket",
+    "qq-robot",
+    "cq-websocket",
+    "onebot11",
+    "typescript",
+    "napcat"
+  ],
+  "author": {
+    "name": "huankong233",
+    "url": "https://github.com/huankong233"
+  },
+  "contributors": [
+    {
+      "name": "kanocence",
+      "url": "https://github.com/kanocence"
+    },
+    {
+      "name": "jacksixth",
+      "url": "https://github.com/jacksixth"
+    },
+    {
+      "name": "YunYouJun",
+      "url": "https://github.com/YunYouJun"
+    },
+    {
+      "name": "RongDuJiKsp",
+      "url": "https://github.com/RongDuJiKsp"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RongDuJiKsp/node-napcat-ts.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "nodemon",
+    "test": "tsx test/index.ts",
+    "typecheck": "tsc --noEmit",
+    "docs:dev": "pnpm -C docs run dev",
+    "docs:build": "pnpm -C docs run build",
+    "docs:preview": "pnpm -C docs run preview"
+  },
+  "dependencies": {
+    "isomorphic-ws": "^5.0.0",
+    "nanoid": "^5.1.5",
+    "ws": "^8.18.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.19",
+    "@types/ws": "^8.18.1",
+    "dotenv": "^16.5.0",
+    "nodemon": "^3.1.10",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "vue-demi"
+    ]
+  }
+}