/config.yaml:/app/config.yaml lcjqyml/wechatbot:latest
109 | ```
110 | * 配置文件参考`config.yaml.example`
111 |
112 | 保存登陆记录，增加以下配置：
113 | ```bash
114 | touch ./memory-card.json
115 | docker run -v ./memory-card.json:/app/my-wechat-bot.memory-card.json ... lcjqyml/wechatbot:latest
116 | ```
117 | 遇到问题参考[ #30](https://github.com/lcjqyml/wechatbot/issues/30)
118 |
119 | 本项目与lss233项目部署在同一服务器时，执行以下命令：
120 |
121 | ```bash
122 | docker run -e CHATBOT_PROXY="http://chatgpt-qq_chatgpt_1:8080" --network chatgpt-qq_default lcjqyml/wechatbot:latest
123 | ```
124 | _PS: 以上chatgpt-qq_chatgpt_1, chatgpt-qq_default由docker-compose启动lss233项目时默认创建。_
125 |
126 | 启动后扫码登陆即可：
127 | * 扫码的微信号需要进过实名认证，否则会异常。
128 | * 尽量避免国外登陆或者异地登陆，防止封号。
129 | * 若二维码不清晰，可将二维码上方的链接copy至浏览器打开扫码。
130 |
131 | ### Railway或者Zeabur托管部署
132 |
133 | 参考`issue` https://github.com/lcjqyml/wechatbot/issues/20
134 |
135 | ### 本地部署(linux x86)
136 | 安装nodejs、npm
137 |
138 | 下载压缩包：
139 | ```
140 | curl -O https://nodejs.org/dist/v18.18.2/node-v18.18.2-linux-x64.tar.xz
141 | ```
142 | 解压压缩包：
143 | ```
144 | tar xf node-v18.18.2-linux-x64.tar.xz
145 | ```
146 | 移动压缩包：
147 | ```
148 | sudo mv node-v18.18.2-linux-x64 /usr/local/bin/
149 | ```
150 | 设置为全局命令：
151 | ```
152 | sudo ln -s /usr/local/bin/node-v18.18.2-linux-x64/bin/node /usr/local/bin/node
153 | sudo ln -s /usr/local/bin/node-v18.18.2-linux-x64/bin/npm /usr/local/bin/npm
154 | ```
155 | 如果现在使用```node -v```和```npm -v```命令可以正常输出版本信息，那么恭喜你，node和npm已经安装完成了，继续进行下面的步骤吧~
156 |
157 | 现在开始安装nodemon
158 |
159 | npm更换国内源：（如服务器在国外可以跳过此步骤）
160 | ```
161 | npm config set registry https://registry.npmmirror.com
162 | ```
163 | 安装nodemon：
164 | ```
165 | npm install -g nodemon
166 | ```
167 | 设置为全局命令：
168 | ```
169 | sudo ln -s /usr/local/bin/node-v18.18.2-linux-x64/bin/nodemon /usr/bin/nodemon
170 | ```
171 | 拉取项目：
172 | ```
173 | git clone https://github.com/lcjqyml/wechatbot.git
174 | ```
175 | 进入：
176 | ```
177 | cd wechatbot
178 | ```
179 | 安装依赖：（如果安装失败，多重试几次）
180 | ```
181 | npm install
182 | ```
183 | 设置环境变量：（如果使用```config.yml```进行配置，此处可掠过）
184 | ```
185 | vim .env
186 | ```
187 | 填入环境变量：（如果使用```config.yml```进行配置，此处可掠过）
188 | ```
189 | CHATBOT_PROXY="http://example.com:1234"
190 | ```
191 | 写一个小小的启动脚本，方便以后启动：
192 | ```
193 | vim start.sh
194 | ```
195 | 填入内容：（如果使用```config.yml```进行配置，此处的```source ./.env```不需要添加）
196 | ```
197 | source ./.env
198 | nodemon
199 | ```
200 | 给予运行权限：
201 | ```
202 | chmod +x start.sh
203 | ```
204 | 启动：
205 | ```
206 | ./start.sh
207 | ```
208 | 至此，linux本地部署完成，你可以把它放在一个screen窗口里运行，有关screen的用法请自行搜索
209 |
210 |
211 | ## 关联项目
212 | * [lss233/chatgpt-mirai-qq-bot][1] - （本项目需要配合此项目的http service使用）多平台、多AI引擎的AIGC整合项目。
213 | * [kx-Huang/ChatGPT-on-WeChat](https://github.com/kx-Huang/ChatGPT-on-WeChat) - 访问ChatGPT的微信聊天机器人
214 |
215 |
216 | ## 贡献者名单
217 |
218 | 欢迎提出新的点子、 Pull Request。
219 |
220 |
221 | 
222 |
223 | Made with [contrib.rocks](https://contrib.rocks).
224 |
225 | ## 支持我们
226 |
227 | 如果这个项目对你有所帮助，请给我们一颗星。
228 |
229 |
230 |
231 | 
232 |
233 |
234 | 
235 |
236 |
237 |
238 | [1]: https://github.com/lss233/chatgpt-mirai-qq-bot
239 |
--------------------------------------------------------------------------------
/config.yaml.example:
--------------------------------------------------------------------------------
1 | chatbotProxy: "http://your-server-ip:port"
2 | autoAcceptFriendShip: "true"
3 | autoAcceptRoomInvite: "true"
4 | privateChatTrigger: ""
5 | groupChatTrigger: ""
6 | responseQuote: "true"
7 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "wechatbot",
3 | "version": "1.0.0",
4 | "description": "",
5 | "main": "src/main.ts",
6 | "export": "src/main.ts",
7 | "scripts": {
8 | "dev": "nodemon --exec node --watch config.yaml --loader ts-node/esm src/main.ts",
9 | "build": "tsc"
10 | },
11 | "author": "Milin",
12 | "license": "ISC",
13 | "dependencies": {
14 | "dotenv": "^16.0.3",
15 | "qrcode": "^1.5.1",
16 | "uuid": "^9.0.0",
17 | "wechaty": "^1.20.2",
18 | "wechaty-puppet-wechat": "^1.18.4",
19 | "yaml": "^2.1.3",
20 | "nth-check": ">=2.0.1",
21 | "pinyin": "^2.11.2",
22 | "axios": "^1.3.4"
23 | },
24 | "devDependencies": {
25 | "@types/pinyin": "^2.10.0",
26 | "@types/qrcode": "^1.5.0",
27 | "@types/uuid": "^9.0.0",
28 | "nodemon": "^2.0.20",
29 | "ts-node": "^10.9.1",
30 | "nth-check": ">=2.0.1"
31 | },
32 | "nodemonConfig": {
33 | "watch": "src",
34 | "ext": "ts",
35 | "exec": "node --loader ts-node/esm src/main.ts",
36 | "delay": 500
37 | },
38 | "type": "module"
39 | }
40 |
--------------------------------------------------------------------------------
/poetry.lock:
--------------------------------------------------------------------------------
1 | [[package]]
2 | name = "certifi"
3 | version = "2022.12.7"
4 | description = "Python package for providing Mozilla's CA Bundle."
5 | category = "main"
6 | optional = false
7 | python-versions = ">=3.6"
8 |
9 | [metadata]
10 | lock-version = "1.1"
11 | python-versions = "^3.8"
12 | content-hash = "fafb334cb038533f851c23d0b63254223abf72ce4f02987e7064b0c95566699a"
13 |
14 | [metadata.files]
15 | certifi = [
16 | {file = "certifi-2022.12.7-py3-none-any.whl", hash = "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18"},
17 | {file = "certifi-2022.12.7.tar.gz", hash = "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3"},
18 | ]
19 |
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [tool.poetry]
2 | name = "wechatbot"
3 | version = "0.0.1"
4 | description = "WeChat Bot"
5 | authors = ["Milin <417156994@qq.com>"]
6 |
7 | [tool.poetry.dependencies]
8 | python = "^3.8"
9 |
10 | [tool.poetry.dev-dependencies]
11 |
12 | [build-system]
13 | requires = ["poetry-core>=1.0.0"]
14 | build-backend = "poetry.core.masonry.api"
15 | [experimental]
16 | new-installer = false
17 |
--------------------------------------------------------------------------------
/src/chatbot.ts:
--------------------------------------------------------------------------------
1 | import {Config, Constants, Logger} from "./config.js";
2 | import {Message, Wechaty} from "wechaty";
3 | import {ContactInterface, RoomInterface} from "wechaty/impls";
4 | import {FileBox} from 'file-box';
5 | import pinyin from "pinyin";
6 |
7 | import axios from 'axios';
8 |
9 | enum MessageType {
10 | Unknown = 0,
11 | Attachment = 1, // Attach(6),
12 | Audio = 2, // Audio(1), Voice(34)
13 | Contact = 3, // ShareCard(42)
14 | ChatHistory = 4, // ChatHistory(19)
15 | Emoticon = 5, // Sticker: Emoticon(15), Emoticon(47)
16 | Image = 6, // Img(2), Image(3)
17 | Text = 7, // Text(1)
18 | Location = 8, // Location(48)
19 | MiniProgram = 9, // MiniProgram(33)
20 | GroupNote = 10, // GroupNote(53)
21 | Transfer = 11, // Transfers(2000)
22 | RedEnvelope = 12, // RedEnvelopes(2001)
23 | Recalled = 13, // Recalled(10002)
24 | Url = 14, // Url(5)
25 | Video = 15, // Video(4), Video(43)
26 | Post = 16, // Moment, Channel, Tweet, etc
27 | }
28 |
29 | interface RequestBody {
30 | message: string;
31 | session_id: string;
32 | username: string;
33 | }
34 |
35 | interface ResponseData {
36 | result: string;
37 | message: string[];
38 | image: string[];
39 | voice: string[];
40 | }
41 |
42 | const getData = async (url: string): Promise => {
43 | const response = await axios.get(url);
44 | return response.data;
45 | }
46 |
47 | const postData = async (url: string, requestBody: RequestBody): Promise => {
48 | const response = await axios.post(url, requestBody);
49 | return response.data;
50 | };
51 |
52 | export class ChatBot {
53 | // chatbot name (WeChat account name)
54 | botName: string = "bot";
55 |
56 | // self-chat may cause some issue for some WeChat Account
57 | // please set to true if self-chat cause some errors
58 | disableSelfChat: boolean = false;
59 |
60 | // chatbot trigger keyword
61 | privateChatTrigger: string = Config.privateChatTrigger;
62 | groupChatTrigger: string = Config.groupChatTrigger;
63 | groupChatTriggerRegex: RegExp = this.groupChatTrigger ?
64 | new RegExp(`^(@${this.botName}\\s+)?${this.groupChatTrigger}`):
65 | new RegExp(`^@${this.botName}`);
66 |
67 | // message size for a single reply by the bot
68 | SINGLE_MESSAGE_MAX_SIZE: number = 500;
69 |
70 | weChatBot: Wechaty;
71 |
72 | errorResponse = "机器人异常，请稍后再试或联系管理员！";
73 |
74 | constructor(weChatBot: Wechaty) {
75 | this.weChatBot = weChatBot;
76 | }
77 |
78 | // set bot name during login stage
79 | setBotName(botName: string) {
80 | this.botName = botName;
81 | this.groupChatTriggerRegex = this.groupChatTrigger ?
82 | new RegExp(`^(@${this.botName}\\s+)?${this.groupChatTrigger}`):
83 | new RegExp(`^@${this.botName}`);
84 | }
85 |
86 | private static constructResponseData(result: string, message: string): ResponseData {
87 | return {
88 | result: result,
89 | message: [message],
90 | voice: [],
91 | image: []
92 | }
93 | }
94 |
95 | private cleanMessage(rawText: string, isPrivateChat: boolean): string {
96 | let text = rawText;
97 | const item = rawText.split("----------");
98 | if (item.length > 1) {
99 | text = item[item.length - 1].trim();
100 | }
101 | if (isPrivateChat && this.privateChatTrigger){
102 | return text.slice(this.privateChatTrigger.length).trim();
103 | }
104 | if (!isPrivateChat) {
105 | return text.replace(this.groupChatTriggerRegex, "").trim();
106 | }
107 | return text.trim();
108 | }
109 |
110 | // check whether chat bot can be triggered
111 | private triggerGPTMessage(
112 | text: string,
113 | isPrivateChat: boolean = false
114 | ): boolean {
115 | let triggered;
116 | if (isPrivateChat) {
117 | triggered = this.privateChatTrigger
118 | ? text.startsWith(this.privateChatTrigger)
119 | : true;
120 | } else {
121 | triggered = this.groupChatTriggerRegex.test(text);
122 | }
123 | if (triggered) {
124 | Logger.log(`🎯 ChatGPT triggered: ${text}`);
125 | }
126 | return triggered;
127 | }
128 |
129 | // filter out the message that does not need to be processed
130 | private isNonsense(
131 | talker: ContactInterface,
132 | messageType: MessageType,
133 | text: string
134 | ): boolean {
135 | return (
136 | (this.disableSelfChat && talker.self()) ||
137 | messageType != MessageType.Text ||
138 | talker.name() == "微信团队" ||
139 | // video or voice reminder
140 | text.includes("收到一条视频/语音聊天消息，请在手机上查看") ||
141 | // red pocket reminder
142 | text.includes("收到红包，请在手机上查看") ||
143 | // location information
144 | text.includes("/cgi-bin/mmwebwx-bin/webwxgetpubliclinkimg")
145 | );
146 | }
147 |
148 | private async onChat(text: string, sessionId: string, username: string, replyCallback: (responseData: ResponseData) => Promise) {
149 | text = text.trim();
150 | sessionId = sessionId.replace(/[^a-zA-Z0-9-]/g, '');
151 | await this.ask(sessionId, username, text, replyCallback);
152 | }
153 |
154 | private askResponse(requestId: string, replyCallback: (responseData: ResponseData) => Promise, intervalId: number) {
155 | const askUrl = `${Config.chatbotProxy}/v2/chat/response?request_id=${requestId}`;
156 | Logger.log(`🎯 Wait response: ${askUrl}`);
157 | getData(askUrl)
158 | .then((responseData: ResponseData) => {
159 | Logger.log(`🎯 Got response data data length ${JSON.stringify(responseData).length} -> ${JSON.stringify(responseData).substr(0, 100)}`)
160 | if (responseData.result === Constants.responseStatus.done || responseData.result === Constants.responseStatus.failed) {
161 | clearInterval(intervalId);
162 | if (responseData.result === Constants.responseStatus.failed) {
163 | return;
164 | }
165 | }
166 | replyCallback(responseData);
167 | }).catch((error) => {
168 | replyCallback(ChatBot.constructResponseData(Constants.responseStatus.failed, this.errorResponse));
169 | Logger.error(error);
170 | });
171 | }
172 |
173 | private async ask(sessionId: string, username: string, text: string, replyCallback: (responseData: ResponseData) => Promise) {
174 | const askUrl = `${Config.chatbotProxy}/v2/chat`;
175 | const requestBody: RequestBody = {
176 | message: text,
177 | session_id: sessionId,
178 | username: username,
179 | };
180 | const chatbot = this;
181 | Logger.log(`🎯 Chatbot triggered: ${askUrl}`);
182 | await postData(askUrl, requestBody)
183 | .then((requestId: string) => {
184 | Logger.log(`🎯 Got request id: ${requestId}`)
185 | let intervalCnt = 0;
186 | const intervalId = setInterval(
187 | async function () {
188 | // @ts-ignore
189 | await chatbot.askResponse(requestId, replyCallback, intervalId)
190 | if (++intervalCnt >= 60){
191 | clearInterval(intervalId);
192 | replyCallback(ChatBot.constructResponseData(Constants.responseStatus.failed, "响应超时，请重新尝试！"));
193 | }
194 | }, 2000);
195 | }).catch((error) => {
196 | replyCallback(ChatBot.constructResponseData(Constants.responseStatus.failed, this.errorResponse));
197 | Logger.error(error);
198 | });
199 | }
200 |
201 | private async replyText(
202 | talker: RoomInterface | ContactInterface,
203 | mesasge: string
204 | ): Promise {
205 | const messages: Array = [];
206 | Logger.log(`Reply text -> ${mesasge.substr(0, 50)}`);
207 | let message = mesasge;
208 | while (message.length > this.SINGLE_MESSAGE_MAX_SIZE) {
209 | messages.push(message.slice(0, this.SINGLE_MESSAGE_MAX_SIZE));
210 | message = message.slice(this.SINGLE_MESSAGE_MAX_SIZE);
211 | }
212 | messages.push(message);
213 | for (const msg of messages) {
214 | await talker.say(msg);
215 | }
216 | }
217 |
218 | private async replyVoice(
219 | talker: RoomInterface | ContactInterface,
220 | voice: string
221 | ): Promise {
222 | const voiceType = this.getFirstMatchTextFromRegex(voice, Constants.voiceTypeReg);
223 | if (voiceType === "mpeg") {
224 | Logger.log(`Reply voice.mp3 -> ${voice.substr(0, 50)}`);
225 | const tmpName = await this.generateTmpName(talker) + ".mp3";
226 | await talker.say(FileBox.fromDataURL(voice, tmpName));
227 | }
228 | }
229 |
230 | private async replyImage(
231 | talker: RoomInterface | ContactInterface,
232 | image: string
233 | ): Promise {
234 | const imageType = this.getFirstMatchTextFromRegex(image, Constants.imageTypeReg);
235 | if (imageType) {
236 | Logger.log(`Reply image.${imageType} -> ${image.substr(0, 50)}`);
237 | const tmpName = await this.generateTmpName(talker) + `.${imageType}`;
238 | await talker.say(FileBox.fromDataURL(image, tmpName));
239 | }
240 | }
241 |
242 | private async reply(talker: ContactInterface|RoomInterface, prompt: string, responseData: ResponseData) {
243 | if (responseData.message && responseData.message.length > 0) {
244 | for (let m of responseData.message) {
245 | if (Config.responseQuote && "topic" in talker) {
246 | m = `${prompt}\n----------\n${m}`;
247 | }
248 | await this.replyText(talker, m);
249 | }
250 | }
251 | if (responseData.voice && responseData.voice.length > 0) {
252 | for (const v of responseData.voice) {
253 | await this.replyVoice(talker, v);
254 | }
255 | }
256 | if (responseData.image && responseData.image.length > 0) {
257 | for (const i of responseData.image) {
258 | await this.replyImage(talker, i);
259 | }
260 | }
261 | }
262 |
263 | private triggerActions(talker: ContactInterface, text: string) {
264 | if (text !== Config.checkOnlineTrigger) {
265 | return false;
266 | }
267 | setInterval(async () => {
268 | await this.onPrivateMessage(talker, Config.checkOnlineCommand);
269 | }, Config.checkOnlineInterval);
270 | return true;
271 | }
272 |
273 | // reply to private message
274 | private async onPrivateMessage(talker: ContactInterface, text: string) {
275 | const sessionId = pinyin(talker.name(), {style: pinyin.STYLE_TONE2}).join("");
276 | const chatbot = this;
277 | if (this.triggerActions(talker, text)) {
278 | text = Config.checkOnlineCommand;
279 | }
280 | await this.onChat(text, `friend-${sessionId}`, sessionId,
281 | async function (responseData: ResponseData) {
282 | await chatbot.reply(talker, text, responseData);
283 | });
284 | }
285 |
286 | // reply to group message
287 | private async onGroupMessage(talker: ContactInterface, room: RoomInterface, text: string) {
288 | const sessionId = pinyin(await room.topic(), {style: pinyin.STYLE_TONE2}).join("");
289 | const username = pinyin(talker.name(), {style: pinyin.STYLE_TONE2}).join("");
290 | const chatbot = this;
291 | // get reply from chat bot
292 | await this.onChat(text, `group-${sessionId}`, username,
293 | async function (responseData: ResponseData) {
294 | await chatbot.reply(room, text, responseData);
295 | });
296 | }
297 |
298 | private getFirstMatchTextFromRegex(text: string, regex: RegExp): string {
299 | const results = Array.from(text.matchAll(regex), (match) => match[1]);
300 | if (results.length == 0) {
301 | return "";
302 | }
303 | return results[0];
304 | }
305 |
306 | // receive a message (main entry)
307 | async onMessage(message: Message) {
308 | const talker = message.talker();
309 | const rawText = message.text();
310 | const room = message.room();
311 | const messageType = message.type();
312 | const isPrivateChat = !room;
313 | Logger.log(`收到${isPrivateChat ? "" : room.topic()} > ${talker.name()}(${talker.id})的消息`)
314 | if (
315 | this.isNonsense(talker, messageType, rawText) ||
316 | !this.triggerGPTMessage(rawText, isPrivateChat)
317 | ) {
318 | return;
319 | }
320 | const text = this.cleanMessage(rawText, isPrivateChat);
321 | if (isPrivateChat) {
322 | return await this.onPrivateMessage(talker, text);
323 | } else {
324 | // @ts-ignore
325 | return await this.onGroupMessage(talker, room, text);
326 | }
327 | }
328 |
329 | private async generateTmpName(talker: RoomInterface | ContactInterface) {
330 | let tmpName = "";
331 | if ("topic" in talker) {
332 | tmpName = await talker.topic();
333 | } else {
334 | tmpName = talker.name();
335 | }
336 | tmpName = pinyin(tmpName, {style: pinyin.STYLE_FIRST_LETTER}).join("");
337 | const now = new Date();
338 | const hour = now.getHours().toString().padStart(2, "0");
339 | const minute = now.getMinutes().toString().padStart(2, "0");
340 | const second = now.getSeconds().toString().padStart(2, "0");
341 | tmpName += `-${hour}${minute}${second}`;
342 | return tmpName;
343 | }
344 | }
345 |
346 |
--------------------------------------------------------------------------------
/src/config.ts:
--------------------------------------------------------------------------------
1 | import * as dotenv from "dotenv";
2 | dotenv.config();
3 | import fs from "fs";
4 | import { parse } from "yaml";
5 | import { IConfig } from "./interface";
6 |
7 | export const Logger = {
8 | log: function (...args: any[]) {
9 | console.log(`[${new Date().toLocaleString()}]`, ...args);
10 | },
11 | error: function (...args: any[]) {
12 | console.error(`[${new Date().toLocaleString()}]`, ...args);
13 | },
14 | }
15 |
16 | let configFile: any = {};
17 |
18 | // get configurations from 'config.yaml' first
19 | if (fs.existsSync("./config.yaml")) {
20 | const file = fs.readFileSync("./config.yaml", "utf8");
21 | configFile = parse(file);
22 | }
23 | // if 'config.yaml' not exist, read them from env
24 | else {
25 | configFile = {
26 | chatbotProxy: process.env.CHATBOT_PROXY,
27 | autoAcceptFriendShip: process.env.AUTO_ACCEPT_FRIEND_SHIP,
28 | autoAcceptRoomInvite: process.env.AUTO_ACCEPT_ROOM_INVITE,
29 | privateChatTrigger: process.env.PRIVATE_CHAT_TRIGGER,
30 | groupChatTrigger: process.env.GROUP_CHAT_TRIGGER,
31 | responseQuote: process.env.RESPONSE_QUOTE,
32 | checkOnlineTrigger: process.env.CHECK_ONLINE_TRIGGER,
33 | checkOnlineCommand: process.env.CHECK_ONLINE_COMMAND,
34 | checkOnlineInterval: process.env.CHECK_ONLINE_INTERVAL,
35 | };
36 | }
37 |
38 | // warning if no OpenAI API key found
39 | if (configFile.chatbotProxy === undefined) {
40 | Logger.error(
41 | "⚠️ No CHATGPT_PROXY found in env, please export to env or configure in config.yaml"
42 | );
43 | }
44 |
45 | export const Config: IConfig = {
46 | chatbotProxy: configFile.chatbotProxy || "",
47 | autoAcceptFriendShip: configFile.autoAcceptFriendShip == "true",
48 | autoAcceptRoomInvite: configFile.autoAcceptRoomInvite == "true",
49 | privateChatTrigger: configFile.privateChatTrigger || "",
50 | groupChatTrigger: configFile.groupChatTrigger || "",
51 | responseQuote: configFile.responseQuote == "true",
52 | checkOnlineTrigger: configFile.checkOnlineTrigger || "__check__",
53 | checkOnlineCommand: configFile.checkOnlineCommand || "ping",
54 | checkOnlineInterval: configFile.checkOnlineInterval || 60 * 60 * 1000,
55 | };
56 |
57 | Logger.log("Config ->")
58 | Object.entries(Config).forEach(([key, value]) => {
59 | Logger.log(`${key}: ${value}`);
60 | });
61 |
62 | export const Constants = {
63 | imageTypeReg: /data:image\/(\w+);base64,/g,
64 | voiceTypeReg: /data:audio\/(\w+);base64,/g,
65 | responseStatus: {
66 | success: "SUCESS",
67 | failed: "FAILED",
68 | done: "DONE"
69 | }
70 | }
71 |
--------------------------------------------------------------------------------
/src/interface.ts:
--------------------------------------------------------------------------------
1 | export interface IConfig {
2 | chatbotProxy: string,
3 | autoAcceptFriendShip: boolean,
4 | autoAcceptRoomInvite: boolean,
5 | privateChatTrigger: string,
6 | groupChatTrigger: string,
7 | responseQuote: boolean,
8 | checkOnlineTrigger: string,
9 | checkOnlineCommand: string,
10 | checkOnlineInterval: number,
11 | }
12 |
--------------------------------------------------------------------------------
/src/main.ts:
--------------------------------------------------------------------------------
1 | import QRCode from "qrcode";
2 | import { WechatyBuilder } from "wechaty";
3 | import { ChatBot } from "./chatbot.js";
4 | import {Config, Logger} from "./config.js";
5 |
6 | // Wechaty instance
7 | const weChatBot = WechatyBuilder.build({
8 | name: "my-wechat-bot",
9 | });
10 | // chat bot instance
11 | const chatBot = new ChatBot(weChatBot);
12 | const launchTime = new Date().getTime();
13 | const READY_TIME = 15 * 1000;
14 |
15 | async function main() {
16 | weChatBot
17 | // scan QR code for login
18 | .on("scan", async (qrcode, status) => {
19 | const uri = encodeURIComponent(qrcode);
20 | const wechatyurl = `https://wechaty.js.org/qrcode/${uri}`;
21 | const sohuurl = `https://my.tv.sohu.com/user/a/wvideo/getQRCode.do?text=${uri}`;
22 | const qrserverurl = `https://api.qrserver.com/v1/create-qr-code/?size=150×150&data=${uri}`;
23 | Logger.log(`💡 Open any url below and scan QR code to login: \n${wechatyurl}\n${sohuurl}\n${qrserverurl}`);
24 | Logger.log("\nOr scan the QR code below to login:\n" + await QRCode.toString(qrcode, { type: "terminal", small: true })
25 | );
26 | })
27 | // login to WeChat desktop account
28 | .on("login", async (user: any) => {
29 | chatBot.setBotName(user.name());
30 | Logger.log(`✅ User ${user} has logged in`);
31 | })
32 | // message handler
33 | .on("message", async (message: any) => {
34 | try {
35 | const currentTime = new Date().getTime();
36 | if (currentTime - launchTime <= READY_TIME) {
37 | Logger.log(`📨 Skip message --> ${message}`);
38 | return;
39 | }
40 | Logger.log(`📨 ${message}`);
41 | // handle message for chatGPT bot
42 | await chatBot.onMessage(message);
43 | } catch (e) {
44 | Logger.error(`❌ ${(e as Error).stack}`);
45 | }
46 | }).on('friendship', async (friendship) => {
47 | const currentTime = new Date().getTime();
48 | if (currentTime - launchTime <= READY_TIME) {
49 | Logger.log(`📨 Skip friendship --> ${friendship.contact().name()}`);
50 | return;
51 | }
52 | if (friendship.type() === weChatBot.Friendship.Type.Receive && Config.autoAcceptFriendShip) {
53 | await friendship.accept();
54 | Logger.log(`Accepted friend request from ${friendship.contact().name()} automatically.`);
55 | }
56 | if (friendship.type() === weChatBot.Friendship.Type.Confirm) {
57 | Logger.log(`Confirmed friend request from ${friendship.contact().name()}.`);
58 | }
59 | }).on('room-invite', async (roomInvitation) => {
60 | const inviter = await roomInvitation.inviter();
61 | const currentTime = new Date().getTime();
62 | if (currentTime - launchTime <= READY_TIME) {
63 | Logger.log(`📨 Skip room invite --> ${inviter} -- ${roomInvitation.topic()}`);
64 | return;
65 | }
66 | if (Config.autoAcceptRoomInvite) {
67 | await roomInvitation.accept();
68 | Logger.log(`Accepted room invitation from ${inviter} in room ${roomInvitation.topic()}`);
69 | }
70 | });
71 |
72 | try {
73 | await weChatBot.start();
74 | } catch (e) {
75 | Logger.error(`❌ Your Bot failed to start: ${(e as Error).stack}`);
76 | Logger.log(
77 | "🤔 Can you login WeChat in browser? The bot works on the desktop WeChat"
78 | );
79 | }
80 | }
81 | main();
82 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | /* Visit https://aka.ms/tsconfig.json to read more about this file */
4 |
5 | /* Projects */
6 | // "incremental": true, /* Enable incremental compilation */
7 | // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8 | // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9 | // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10 | // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11 | // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12 |
13 | /* Language and Environment */
14 | "target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15 | // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16 | // "jsx": "preserve", /* Specify what JSX code is generated. */
17 | // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18 | // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19 | // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20 | // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21 | // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22 | // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23 | // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24 | // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25 |
26 | /* Modules */
27 | "module": "esnext", /* Specify what module code is generated. */
28 | "rootDir": "src", /* Specify the root folder within your source files. */
29 | "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
30 | // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31 | // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32 | // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33 | // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34 | // "types": [], /* Specify type package names to be included without being referenced in a source file. */
35 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
36 | "resolveJsonModule": true, /* Enable importing .json files */
37 | // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */
38 |
39 | /* JavaScript Support */
40 | // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
41 | // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
42 | // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
43 |
44 | /* Emit */
45 | // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
46 | // "declarationMap": true, /* Create sourcemaps for d.ts files. */
47 | // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
48 | // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
49 | // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
50 | "outDir": "dist", /* Specify an output folder for all emitted files. */
51 | // "removeComments": true, /* Disable emitting comments. */
52 | // "noEmit": true, /* Disable emitting files from a compilation. */
53 | // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
54 | // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
55 | // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
56 | // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
57 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
58 | // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
59 | // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
60 | // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
61 | // "newLine": "crlf", /* Set the newline character for emitting files. */
62 | // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
63 | // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
64 | // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
65 | // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
66 | // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
67 | // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
68 |
69 | /* Interop Constraints */
70 | // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
71 | // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
72 | "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
73 | // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
74 | "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
75 |
76 | /* Type Checking */
77 | "strict": true, /* Enable all strict type-checking options. */
78 | // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
79 | // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
80 | // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
81 | // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
82 | // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
83 | // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
84 | // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
85 | // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
86 | // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
87 | // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
88 | // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
89 | // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
90 | // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
91 | // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
92 | // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
93 | // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
94 | // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
95 | // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
96 |
97 | /* Completeness */
98 | // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
99 | "skipLibCheck": true /* Skip type checking all .d.ts files. */
100 | }
101 | }
102 |
--------------------------------------------------------------------------------
