From 865308ee31d567d4840b92b04ee13517888f6184 Mon Sep 17 00:00:00 2001 From: zhaoyingbo Date: Sun, 5 May 2024 02:34:16 +0000 Subject: [PATCH] feat: Update code formatting and fix minor issues --- .devcontainer/devcontainer.json | 62 +- .gitattributes | 2 +- .gitea/workflows/cicd.yaml | 114 ++-- .gitignore | 116 ++-- Dockerfile | 42 +- bun.lockb | Bin 5293 -> 5293 bytes db/index.ts | 18 +- db/messageGroup/index.ts | 26 +- db/messageGroup/typings.d.ts | 28 +- db/pbClient.ts | 10 +- db/tenantAccessToken/index.ts | 64 +- devTools/Dockerfile | 18 +- devTools/build.sh | 2 +- docker-compose.yml | 18 +- index.ts | 38 +- package.json | 36 +- routes/bot/activeMsg.ts | 116 ++-- routes/bot/eventMsg.ts | 196 +++---- routes/bot/index.ts | 30 +- routes/message/index.ts | 244 ++++---- routes/message/readme.md | 2 +- schedule/accessToken.ts | 38 +- schedule/index.ts | 18 +- service/index.ts | 16 +- test.ts | 10 +- thunder-tests/thunderActivity.json | 40 +- tsconfig.json | 44 +- typings.d.ts | 902 ++++++++++++++--------------- utils/msgTools.ts | 84 +-- utils/pbTools.ts | 22 +- utils/sendMsg.ts | 230 ++++---- 31 files changed, 1293 insertions(+), 1293 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f8bb848..a6f07b5 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,31 +1,31 @@ -{ - "name": "egg_server", - "image": "micr.cloud.mioffice.cn/zhaoyingbo/dev:bun", - "remoteUser": "bun", - "containerUser": "bun", - "forwardPorts": [3000], - "customizations": { - "vscode": { - "settings": { - "files.autoSave": "afterDelay", - "editor.guides.bracketPairs": true, - "editor.defaultFormatter": "esbenp.prettier-vscode", - "editor.formatOnSave": true - }, - "extensions": [ - "dbaeumer.vscode-eslint", - "esbenp.prettier-vscode", - "eamodio.gitlens", - "unifiedjs.vscode-mdx", - "litiany4.umijs-plugin-model", - "oderwat.indent-rainbow", - "jock.svg", - "ChakrounAnas.turbo-console-log", - "Gruntfuggly.todo-tree", - "MS-CEINTL.vscode-language-pack-zh-hans", - "Alibaba-Cloud.tongyi-lingma" - ] - } - }, - "postCreateCommand": "bash -i /workspaces/egg_server/.devcontainer/initial.bash" -} +{ + "name": "egg_server", + "image": "micr.cloud.mioffice.cn/zhaoyingbo/dev:bun", + "remoteUser": "bun", + "containerUser": "bun", + "forwardPorts": [3000], + "customizations": { + "vscode": { + "settings": { + "files.autoSave": "afterDelay", + "editor.guides.bracketPairs": true, + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true + }, + "extensions": [ + "dbaeumer.vscode-eslint", + "esbenp.prettier-vscode", + "eamodio.gitlens", + "unifiedjs.vscode-mdx", + "litiany4.umijs-plugin-model", + "oderwat.indent-rainbow", + "jock.svg", + "ChakrounAnas.turbo-console-log", + "Gruntfuggly.todo-tree", + "MS-CEINTL.vscode-language-pack-zh-hans", + "GitHub.copilot" + ] + } + }, + "postCreateCommand": "bash -i /workspaces/egg_server/.devcontainer/initial.bash" +} diff --git a/.gitattributes b/.gitattributes index 81c05ed..0baf79b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -*.lockb binary diff=lockb +*.lockb binary diff=lockb diff --git a/.gitea/workflows/cicd.yaml b/.gitea/workflows/cicd.yaml index fb6c342..327d201 100644 --- a/.gitea/workflows/cicd.yaml +++ b/.gitea/workflows/cicd.yaml @@ -1,57 +1,57 @@ -name: Egg CI/CD -on: [push] - -jobs: - build-image: - runs-on: ubuntu-latest - container: catthehacker/ubuntu:act-latest - steps: - - name: Check out repository code - uses: actions/checkout@v3 - - name: Set up QEMU - uses: docker/setup-qemu-action@v2 - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2 - - name: Login to Docker Hub - uses: docker/login-action@v2 - with: - registry: git.yingbo.im:333 - username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKER_PASSWORD }} - - name: Build and push - uses: docker/build-push-action@v4 - with: - push: true - tags: git.yingbo.im:333/zhaoyingbo/egg_server:${{ github.sha }} - - deploy: - needs: build-image - runs-on: ubuntu-latest - container: catthehacker/ubuntu:act-latest - steps: - # 检出代码 - - name: Check out repository code - uses: actions/checkout@v3 - # 使用scp命令将docker-compose.yml文件上传到服务器 - - name: Upload docker-compose.yml to server - uses: appleboy/scp-action@master - with: - host: ${{ secrets.SERVER_HOST }} - username: ${{ secrets.SERVER_USERNAME }} - key: ${{ secrets.SERVER_KEY }} - port: ${{ secrets.SERVER_PORT }} - source: docker-compose.yml - target: /home/${{ secrets.SERVER_USERNAME }}/docker/egg_server - # 登录服务器，执行docker-compose命令 - - name: Login to the server and execute docker-compose command - uses: appleboy/ssh-action@master - with: - host: ${{ secrets.SERVER_HOST }} - username: ${{ secrets.SERVER_USERNAME }} - key: ${{ secrets.SERVER_KEY }} - port: ${{ secrets.SERVER_PORT }} - script: | - docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} git.yingbo.im:333 - cd /home/${{ secrets.SERVER_USERNAME }}/docker/egg_server - sed -i "s/sha/${{ github.sha }}/g" docker-compose.yml - docker compose up -d --force-recreate --no-deps egg_server +name: Egg CI/CD +on: [push] + +jobs: + build-image: + runs-on: ubuntu-latest + container: catthehacker/ubuntu:act-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + - name: Set up QEMU + uses: docker/setup-qemu-action@v2 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + - name: Login to Docker Hub + uses: docker/login-action@v2 + with: + registry: git.yingbo.im:333 + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + - name: Build and push + uses: docker/build-push-action@v4 + with: + push: true + tags: git.yingbo.im:333/zhaoyingbo/egg_server:${{ github.sha }} + + deploy: + needs: build-image + runs-on: ubuntu-latest + container: catthehacker/ubuntu:act-latest + steps: + # 检出代码 + - name: Check out repository code + uses: actions/checkout@v3 + # 使用scp命令将docker-compose.yml文件上传到服务器 + - name: Upload docker-compose.yml to server + uses: appleboy/scp-action@master + with: + host: ${{ secrets.SERVER_HOST }} + username: ${{ secrets.SERVER_USERNAME }} + key: ${{ secrets.SERVER_KEY }} + port: ${{ secrets.SERVER_PORT }} + source: docker-compose.yml + target: /home/${{ secrets.SERVER_USERNAME }}/docker/egg_server + # 登录服务器，执行docker-compose命令 + - name: Login to the server and execute docker-compose command + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.SERVER_HOST }} + username: ${{ secrets.SERVER_USERNAME }} + key: ${{ secrets.SERVER_KEY }} + port: ${{ secrets.SERVER_PORT }} + script: | + docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }} git.yingbo.im:333 + cd /home/${{ secrets.SERVER_USERNAME }}/docker/egg_server + sed -i "s/sha/${{ github.sha }}/g" docker-compose.yml + docker compose up -d --force-recreate --no-deps egg_server diff --git a/.gitignore b/.gitignore index 52962c2..10e1165 100644 --- a/.gitignore +++ b/.gitignore @@ -1,58 +1,58 @@ -# Logs -logs -*.log -npm-debug.log* - -# Runtime data -pids -*.pid -*.seed - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage - -# nyc test coverage -.nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) -.grunt - -# node-waf configuration -.lock-wscript - -# Compiled binary addons (http://nodejs.org/api/addons.html) -build/Release - -# Dependency directories -node_modules -jspm_packages - -# Optional npm cache directory -.npm - -# Optional REPL history -.node_repl_history - -# 0x -profile-* - -# mac files -.DS_Store - -# vim swap files -*.swp - -# webstorm -.idea - -# vscode -.vscode -*code-workspace - -# clinic -profile* -*clinic* -*flamegraph* +# Logs +logs +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# Optional npm cache directory +.npm + +# Optional REPL history +.node_repl_history + +# 0x +profile-* + +# mac files +.DS_Store + +# vim swap files +*.swp + +# webstorm +.idea + +# vscode +.vscode +*code-workspace + +# clinic +profile* +*clinic* +*flamegraph* diff --git a/Dockerfile b/Dockerfile index 7d9ff85..6579a12 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,22 +1,22 @@ -FROM micr.cloud.mioffice.cn/zhaoyingbo/bun:alpine - -ENV TZ=Asia/Shanghai - -RUN apk update \ - && apk add tzdata \ - && cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ - && echo "Asia/Shanghai" > /etc/timezone - -WORKDIR /app - -COPY package*.json ./ - -COPY bun.lockb ./ - -RUN bun install - -COPY . . - -EXPOSE 3000 - +FROM micr.cloud.mioffice.cn/zhaoyingbo/bun:alpine + +ENV TZ=Asia/Shanghai + +RUN apk update \ + && apk add tzdata \ + && cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ + && echo "Asia/Shanghai" > /etc/timezone + +WORKDIR /app + +COPY package*.json ./ + +COPY bun.lockb ./ + +RUN bun install + +COPY . . + +EXPOSE 3000 + CMD ["bun", "run", "start"] \ No newline at end of file diff --git a/bun.lockb b/bun.lockb index e9c8673bc0c75828474c664a41c31806e9acffb4..e123de0d909c178735ebcccc1e31fdb0dd737590 100755 GIT binary patch delta 96 zcmZ3hxmI&SC@Ul5 delta 172 zcmZ3hxmI&SC@Ukwk(nPl*^yC - managePb404( - async () => await pbClient.collection("message_group").getOne(groupId) - ); - -const messageGroup = { - getOne, -}; - -export default messageGroup; +import { managePb404 } from "../../utils/pbTools"; +import pbClient from "../pbClient"; + +const getOne = (groupId: string) => + managePb404( + async () => await pbClient.collection("message_group").getOne(groupId) + ); + +const messageGroup = { + getOne, +}; + +export default messageGroup; diff --git a/db/messageGroup/typings.d.ts b/db/messageGroup/typings.d.ts index eaecbe5..d034865 100644 --- a/db/messageGroup/typings.d.ts +++ b/db/messageGroup/typings.d.ts @@ -1,14 +1,14 @@ -interface PBMessageGroup { - collectionId: string; - collectionName: string; - updated: string; - created: string; - desc: string; - id: string; - name: string; - email?: string[]; - chat_id?: string[]; - open_id?: string[]; - union_id?: string[]; - user_id?: string[]; -} +interface PBMessageGroup { + collectionId: string; + collectionName: string; + updated: string; + created: string; + desc: string; + id: string; + name: string; + email?: string[]; + chat_id?: string[]; + open_id?: string[]; + union_id?: string[]; + user_id?: string[]; +} diff --git a/db/pbClient.ts b/db/pbClient.ts index 4d7da78..5a005d7 100644 --- a/db/pbClient.ts +++ b/db/pbClient.ts @@ -1,5 +1,5 @@ -import PocketBase from 'pocketbase'; - -const pbClient = new PocketBase('https://eggpb.imoaix.cn') - -export default pbClient; +import PocketBase from 'pocketbase'; + +const pbClient = new PocketBase('https://eggpb.imoaix.cn') + +export default pbClient; diff --git a/db/tenantAccessToken/index.ts b/db/tenantAccessToken/index.ts index 5358b54..965f117 100644 --- a/db/tenantAccessToken/index.ts +++ b/db/tenantAccessToken/index.ts @@ -1,32 +1,32 @@ -import pbClient from "../pbClient"; - -let token = ""; - -/** - * 更新租户的token - * @param {string} value 新的token - */ -const update = async (value: string) => { - await pbClient.collection("config").update("ugel8f0cpk0rut6", { value }); - token = value; - console.log("reset access token success", value); -}; - -/** - * 获取租户的token - * @returns {string} 租户的token - */ -const get = async () => { - if (token) return token; - const { value } = await pbClient - .collection("config") - .getOne("ugel8f0cpk0rut6"); - return value as string; -}; - -const tenantAccessToken = { - update, - get, -}; - -export default tenantAccessToken; +import pbClient from "../pbClient"; + +let token = ""; + +/** + * 更新租户的token + * @param {string} value 新的token + */ +const update = async (value: string) => { + await pbClient.collection("config").update("ugel8f0cpk0rut6", { value }); + token = value; + console.log("reset access token success", value); +}; + +/** + * 获取租户的token + * @returns {string} 租户的token + */ +const get = async () => { + if (token) return token; + const { value } = await pbClient + .collection("config") + .getOne("ugel8f0cpk0rut6"); + return value as string; +}; + +const tenantAccessToken = { + update, + get, +}; + +export default tenantAccessToken; diff --git a/devTools/Dockerfile b/devTools/Dockerfile index ab13dc5..b75cd6a 100644 --- a/devTools/Dockerfile +++ b/devTools/Dockerfile @@ -1,10 +1,10 @@ -FROM node:18.17.1-alpine3.18 - -# 更换国内源 -RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.tuna.tsinghua.edu.cn/g' /etc/apk/repositories - -# 设置时区 -RUN apk update \ - && apk add tzdata \ - && cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ +FROM node:18.17.1-alpine3.18 + +# 更换国内源 +RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.tuna.tsinghua.edu.cn/g' /etc/apk/repositories + +# 设置时区 +RUN apk update \ + && apk add tzdata \ + && cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ && echo "Asia/Shanghai" > /etc/timezone \ No newline at end of file diff --git a/devTools/build.sh b/devTools/build.sh index 01f2dd5..177b991 100644 --- a/devTools/build.sh +++ b/devTools/build.sh @@ -1,2 +1,2 @@ -docker build -t micr.cloud.mioffice.cn/zhaoyingbo/node:18.17.1-alpine3.18 . +docker build -t micr.cloud.mioffice.cn/zhaoyingbo/node:18.17.1-alpine3.18 . docker push micr.cloud.mioffice.cn/zhaoyingbo/node:18.17.1-alpine3.18 \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index 818f2de..f802bf7 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,9 +1,9 @@ -version: "3" - -services: - egg_server: - image: git.yingbo.im:333/zhaoyingbo/egg_server:sha - container_name: egg_server - restart: always - ports: - - 3003:3000 +version: "3" + +services: + egg_server: + image: git.yingbo.im:333/zhaoyingbo/egg_server:sha + container_name: egg_server + restart: always + ports: + - 3003:3000 diff --git a/index.ts b/index.ts index a81b93a..e480f14 100644 --- a/index.ts +++ b/index.ts @@ -1,20 +1,20 @@ -import { manageBotReq } from "./routes/bot"; -import { manageMessageReq } from "./routes/message"; -import { initSchedule } from "./schedule"; - -initSchedule() - -Bun.serve({ - async fetch(req) { - const url = new URL(req.url); - // 根路由 - if (url.pathname === "/") return new Response("hello, glade to see you!"); - // 机器人 - if (url.pathname === '/bot') return await manageBotReq(req); - // 消息发送 - if (url.pathname === '/message') return await manageMessageReq(req); - // 其他 - return new Response('OK') - }, - port: 3000 +import { manageBotReq } from "./routes/bot"; +import { manageMessageReq } from "./routes/message"; +import { initSchedule } from "./schedule"; + +initSchedule() + +Bun.serve({ + async fetch(req) { + const url = new URL(req.url); + // 根路由 + if (url.pathname === "/") return new Response("hello, glade to see you!"); + // 机器人 + if (url.pathname === '/bot') return await manageBotReq(req); + // 消息发送 + if (url.pathname === '/message') return await manageMessageReq(req); + // 其他 + return new Response('OK') + }, + port: 3000 }); \ No newline at end of file diff --git a/package.json b/package.json index bb54114..4fa90fe 100644 --- a/package.json +++ b/package.json @@ -1,19 +1,19 @@ -{ - "name": "egg_server", - "module": "index.ts", - "type": "module", - "scripts": { - "start": "bun run index.ts" - }, - "devDependencies": { - "bun-types": "latest" - }, - "peerDependencies": { - "typescript": "^5.0.0" - }, - "dependencies": { - "@types/node-schedule": "^2.1.6", - "node-schedule": "^2.1.1", - "pocketbase": "^0.21.1" - } +{ + "name": "egg_server", + "module": "index.ts", + "type": "module", + "scripts": { + "start": "bun run index.ts" + }, + "devDependencies": { + "bun-types": "latest" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "dependencies": { + "@types/node-schedule": "^2.1.6", + "node-schedule": "^2.1.1", + "pocketbase": "^0.21.1" + } } \ No newline at end of file diff --git a/routes/bot/activeMsg.ts b/routes/bot/activeMsg.ts index 7336d0f..b71de06 100644 --- a/routes/bot/activeMsg.ts +++ b/routes/bot/activeMsg.ts @@ -1,58 +1,58 @@ -import { sleep } from "bun"; -import { fetchCIMonitor } from "../../service"; -import { getActionType, getIsActionMsg } from "../../utils/msgTools"; -import { updateCard } from "../../utils/sendMsg"; - -const makeChatIdCard = async (body: LarkUserAction) => { - await sleep(500); - return JSON.stringify({ - type: "template", - data: { - config: { - update_multi: true, - }, - template_id: "ctp_AAi3NnHb6zgK", - template_variable: { - chat_id: body.open_chat_id, - }, - }, - }); -}; - -const ACTION_MAP = { - chat_id: makeChatIdCard, - ci: fetchCIMonitor, -}; - -/** - * 处理按钮点击事件 - * @param {LarkUserAction} body - */ -const manageBtnClick = async (body: LarkUserAction) => { - const { action } = body?.action?.value as { - action: keyof typeof ACTION_MAP; - }; - if (!action) return; - const func = ACTION_MAP[action]; - if (!func) return; - const card = await func(body); - if (!card) return; - // 更新飞书的卡片 - await updateCard(body.open_message_id, card); -}; - -/** - * 处理Action消息 - * @param {LarkUserAction} body - */ -export const manageActionMsg = (body: LarkUserAction) => { - // 过滤非Action消息 - if (!getIsActionMsg(body)) { - return false; - } - const actionType = getActionType(body); - if (actionType === "button") { - manageBtnClick(body); - } - return true; -}; +import { sleep } from "bun"; +import { fetchCIMonitor } from "../../service"; +import { getActionType, getIsActionMsg } from "../../utils/msgTools"; +import { updateCard } from "../../utils/sendMsg"; + +const makeChatIdCard = async (body: LarkUserAction) => { + await sleep(500); + return JSON.stringify({ + type: "template", + data: { + config: { + update_multi: true, + }, + template_id: "ctp_AAi3NnHb6zgK", + template_variable: { + chat_id: body.open_chat_id, + }, + }, + }); +}; + +const ACTION_MAP = { + chat_id: makeChatIdCard, + ci: fetchCIMonitor, +}; + +/** + * 处理按钮点击事件 + * @param {LarkUserAction} body + */ +const manageBtnClick = async (body: LarkUserAction) => { + const { action } = body?.action?.value as { + action: keyof typeof ACTION_MAP; + }; + if (!action) return; + const func = ACTION_MAP[action]; + if (!func) return; + const card = await func(body); + if (!card) return; + // 更新飞书的卡片 + await updateCard(body.open_message_id, card); +}; + +/** + * 处理Action消息 + * @param {LarkUserAction} body + */ +export const manageActionMsg = (body: LarkUserAction) => { + // 过滤非Action消息 + if (!getIsActionMsg(body)) { + return false; + } + const actionType = getActionType(body); + if (actionType === "button") { + manageBtnClick(body); + } + return true; +}; diff --git a/routes/bot/eventMsg.ts b/routes/bot/eventMsg.ts index b3ad747..9055108 100644 --- a/routes/bot/eventMsg.ts +++ b/routes/bot/eventMsg.ts @@ -1,98 +1,98 @@ -import { getChatId, getIsEventMsg, getMsgType } from "../../utils/msgTools"; -import { sendMsg } from "../../utils/sendMsg"; - -/** - * 获取文本内容并剔除艾特信息 - * @param {LarkMessageEvent} body - * @returns {string} 文本内容 - */ -export const getMsgText = (body: LarkMessageEvent) => { - // TODO: 如果之后想支持单独提醒，这里需要做模板解析 - try { - const { text }: { text: string } = JSON.parse( - body?.event?.message?.content - ); - // 去掉@_user_1相关的内容，例如 '@_user_1 测试' -> '测试' - const textWithoutAt = text.replace(/@_user_\d+/g, ""); - // 去除空格和换行 - const textWithoutSpace = textWithoutAt.replace(/[\s\n]/g, ""); - return textWithoutSpace; - } catch (e) { - return ""; - } -}; - -/** - * 过滤出非法消息，如果发表情包就直接发回去 - * @param {LarkMessageEvent} body - * @returns {boolean} 是否为非法消息 - */ -const filterIllegalMsg = (body: LarkMessageEvent) => { - const chatId = getChatId(body); - if (!chatId) return true; - // 获取msgType - const msgType = getMsgType(body); - // 发表情包就直接发回去 - if (msgType === "sticker") { - const content = body?.event?.message?.content; - sendMsg("chat_id", chatId, "sticker", content); - return true; - } - // 剩下的非文字消息暂时不处理 - if (msgType !== "text") { - const textList = [ - "仅支持普通文本内容[黑脸]", - "唔...我只能处理普通文本哦[泣不成声]", - "噢！这似乎是个非普通文本[看]", - "哇！这是什么东东？我只懂普通文本啦！[可爱]", - "只能处理普通文本内容哦[捂脸]", - ]; - const content = JSON.stringify({ - text: textList[Math.floor(Math.random() * textList.length)], - }); - sendMsg("chat_id", chatId, "text", content); - return true; - } - // 还得过滤下艾特全体成员的消息 - if (getMsgText(body).includes("@_all")) { - return true; - } - return false; -}; - -/** - * 回复普通消息 - * @param {LarkMessageEvent} body - */ -const replyNomalMsg = async (body: LarkMessageEvent) => { - const chatId = getChatId(body); - const content = JSON.stringify({ - type: "template", - data: { - config: { - enable_forward: false, - update_multi: true, - }, - template_id: "ctp_AAyVx5R39xU9", - }, - }); - await sendMsg("chat_id", chatId, "interactive", content); -}; - -/** - * 处理Event消息 - * @param {LarkUserAction} body - */ -export const manageEventMsg = (body: LarkMessageEvent) => { - // 过滤非Event消息 - if (!getIsEventMsg(body)) { - return false; - } - // 过滤非法消息 - if (filterIllegalMsg(body)) { - return true; - } - // 临时返回消息 - replyNomalMsg(body); - return true; -}; +import { getChatId, getIsEventMsg, getMsgType } from "../../utils/msgTools"; +import { sendMsg } from "../../utils/sendMsg"; + +/** + * 获取文本内容并剔除艾特信息 + * @param {LarkMessageEvent} body + * @returns {string} 文本内容 + */ +export const getMsgText = (body: LarkMessageEvent) => { + // TODO: 如果之后想支持单独提醒，这里需要做模板解析 + try { + const { text }: { text: string } = JSON.parse( + body?.event?.message?.content + ); + // 去掉@_user_1相关的内容，例如 '@_user_1 测试' -> '测试' + const textWithoutAt = text.replace(/@_user_\d+/g, ""); + // 去除空格和换行 + const textWithoutSpace = textWithoutAt.replace(/[\s\n]/g, ""); + return textWithoutSpace; + } catch (e) { + return ""; + } +}; + +/** + * 过滤出非法消息，如果发表情包就直接发回去 + * @param {LarkMessageEvent} body + * @returns {boolean} 是否为非法消息 + */ +const filterIllegalMsg = (body: LarkMessageEvent) => { + const chatId = getChatId(body); + if (!chatId) return true; + // 获取msgType + const msgType = getMsgType(body); + // 发表情包就直接发回去 + if (msgType === "sticker") { + const content = body?.event?.message?.content; + sendMsg("chat_id", chatId, "sticker", content); + return true; + } + // 剩下的非文字消息暂时不处理 + if (msgType !== "text") { + const textList = [ + "仅支持普通文本内容[黑脸]", + "唔...我只能处理普通文本哦[泣不成声]", + "噢！这似乎是个非普通文本[看]", + "哇！这是什么东东？我只懂普通文本啦！[可爱]", + "只能处理普通文本内容哦[捂脸]", + ]; + const content = JSON.stringify({ + text: textList[Math.floor(Math.random() * textList.length)], + }); + sendMsg("chat_id", chatId, "text", content); + return true; + } + // 还得过滤下艾特全体成员的消息 + if (getMsgText(body).includes("@_all")) { + return true; + } + return false; +}; + +/** + * 回复普通消息 + * @param {LarkMessageEvent} body + */ +const replyNomalMsg = async (body: LarkMessageEvent) => { + const chatId = getChatId(body); + const content = JSON.stringify({ + type: "template", + data: { + config: { + enable_forward: false, + update_multi: true, + }, + template_id: "ctp_AAyVx5R39xU9", + }, + }); + await sendMsg("chat_id", chatId, "interactive", content); +}; + +/** + * 处理Event消息 + * @param {LarkUserAction} body + */ +export const manageEventMsg = (body: LarkMessageEvent) => { + // 过滤非Event消息 + if (!getIsEventMsg(body)) { + return false; + } + // 过滤非法消息 + if (filterIllegalMsg(body)) { + return true; + } + // 临时返回消息 + replyNomalMsg(body); + return true; +}; diff --git a/routes/bot/index.ts b/routes/bot/index.ts index 06b75ff..f63b9bd 100644 --- a/routes/bot/index.ts +++ b/routes/bot/index.ts @@ -1,15 +1,15 @@ -import { manageActionMsg } from "./activeMsg"; -import { manageEventMsg } from "./eventMsg"; - -export const manageBotReq = async (req: Request) => { - const body = (await req.json()) as any; - // 验证机器人 - if (body?.type === "url_verification") { - return Response.json({ challenge: body?.challenge }); - } - // 处理Event消息 - if (manageEventMsg(body)) return new Response("success"); - // 处理Action消息 - if (manageActionMsg(body)) return new Response("success"); - return new Response("hello, glade to see you!"); -}; +import { manageActionMsg } from "./activeMsg"; +import { manageEventMsg } from "./eventMsg"; + +export const manageBotReq = async (req: Request) => { + const body = (await req.json()) as any; + // 验证机器人 + if (body?.type === "url_verification") { + return Response.json({ challenge: body?.challenge }); + } + // 处理Event消息 + if (manageEventMsg(body)) return new Response("success"); + // 处理Action消息 + if (manageActionMsg(body)) return new Response("success"); + return new Response("hello, glade to see you!"); +}; diff --git a/routes/message/index.ts b/routes/message/index.ts index 3f6a44f..fbd6980 100644 --- a/routes/message/index.ts +++ b/routes/message/index.ts @@ -1,122 +1,122 @@ -import db from "../../db"; -import { sendMsg } from "../../utils/sendMsg"; - -interface BaseMsg { - msg_type: MsgType; - content: string; -} - -interface GroupMsg extends BaseMsg { - group_id: string; -} - -interface NormalMsg extends BaseMsg { - receive_id: string; - receive_id_type: ReceiveIDType; -} - -type MessageReqJson = GroupMsg & NormalMsg; - -const validateMessageReq = (body: MessageReqJson) => { - if (!body.group_id && !body.receive_id) { - return new Response("group_id or receive_id is required"); - } - if (body.receive_id && !body.receive_id_type) { - return new Response("receive_id_type is required"); - } - if (!body.msg_type) { - return new Response("msg_type is required"); - } - if (!body.content) { - return new Response("content is required"); - } - return false; -}; - -export const manageMessageReq = async (req: Request) => { - const body = (await req.json()) as MessageReqJson; - // 校验参数 - const validateRes = validateMessageReq(body); - if (validateRes) return validateRes; - - // 遍历所有id发送消息，保存所有对应的messageId - const sendRes = { - chat_id: {} as Record, - open_id: {} as Record, - union_id: {} as Record, - user_id: {} as Record, - email: {} as Record, - }; - - // 发送消息列表 - const sendList = [] as Promise[]; - - // 处理消息内容 - const finalContent = - typeof body.content !== "string" - ? JSON.stringify(body.content) - : body.content; - - if (body.group_id) { - // 获取所有接收者 - const group = (await db.messageGroup.getOne( - body.group_id! - )) as PBMessageGroup; - if (!group) { - return new Response("group not found"); - } - - const { chat_id, open_id, union_id, user_id, email } = group; - - // 构造发送消息函数 - const makeSendFunc = (receive_id_type: ReceiveIDType) => { - return (receive_id: string) => { - sendList.push( - sendMsg( - receive_id_type, - receive_id, - body.msg_type, - finalContent - ).then((res) => { - sendRes[receive_id_type][receive_id] = res; - }) - ); - }; - }; - - // 创建消息列表 - if (chat_id) chat_id.map(makeSendFunc("chat_id")); - if (open_id) open_id.map(makeSendFunc("open_id")); - if (union_id) union_id.map(makeSendFunc("union_id")); - if (user_id) user_id.map(makeSendFunc("user_id")); - if (email) email.map(makeSendFunc("email")); - } - - if (body.receive_id && body.receive_id_type) { - sendList.push( - sendMsg( - body.receive_id_type, - body.receive_id, - body.msg_type, - finalContent - ).then((res) => { - sendRes[body.receive_id_type][body.receive_id] = res; - }) - ); - } - - try { - await Promise.all(sendList); - return Response.json({ - code: 200, - msg: "ok", - data: sendRes, - }); - } catch { - return Response.json({ - code: 400, - msg: "send msg failed", - data: sendRes, - }); - } -}; +import db from "../../db"; +import { sendMsg } from "../../utils/sendMsg"; + +interface BaseMsg { + msg_type: MsgType; + content: string; +} + +interface GroupMsg extends BaseMsg { + group_id: string; +} + +interface NormalMsg extends BaseMsg { + receive_id: string; + receive_id_type: ReceiveIDType; +} + +type MessageReqJson = GroupMsg & NormalMsg; + +const validateMessageReq = (body: MessageReqJson) => { + if (!body.group_id && !body.receive_id) { + return new Response("group_id or receive_id is required"); + } + if (body.receive_id && !body.receive_id_type) { + return new Response("receive_id_type is required"); + } + if (!body.msg_type) { + return new Response("msg_type is required"); + } + if (!body.content) { + return new Response("content is required"); + } + return false; +}; + +export const manageMessageReq = async (req: Request) => { + const body = (await req.json()) as MessageReqJson; + // 校验参数 + const validateRes = validateMessageReq(body); + if (validateRes) return validateRes; + + // 遍历所有id发送消息，保存所有对应的messageId + const sendRes = { + chat_id: {} as Record, + open_id: {} as Record, + union_id: {} as Record, + user_id: {} as Record, + email: {} as Record, + }; + + // 发送消息列表 + const sendList = [] as Promise[]; + + // 处理消息内容 + const finalContent = + typeof body.content !== "string" + ? JSON.stringify(body.content) + : body.content; + + if (body.group_id) { + // 获取所有接收者 + const group = (await db.messageGroup.getOne( + body.group_id! + )) as PBMessageGroup; + if (!group) { + return new Response("group not found"); + } + + const { chat_id, open_id, union_id, user_id, email } = group; + + // 构造发送消息函数 + const makeSendFunc = (receive_id_type: ReceiveIDType) => { + return (receive_id: string) => { + sendList.push( + sendMsg( + receive_id_type, + receive_id, + body.msg_type, + finalContent + ).then((res) => { + sendRes[receive_id_type][receive_id] = res; + }) + ); + }; + }; + + // 创建消息列表 + if (chat_id) chat_id.map(makeSendFunc("chat_id")); + if (open_id) open_id.map(makeSendFunc("open_id")); + if (union_id) union_id.map(makeSendFunc("union_id")); + if (user_id) user_id.map(makeSendFunc("user_id")); + if (email) email.map(makeSendFunc("email")); + } + + if (body.receive_id && body.receive_id_type) { + sendList.push( + sendMsg( + body.receive_id_type, + body.receive_id, + body.msg_type, + finalContent + ).then((res) => { + sendRes[body.receive_id_type][body.receive_id] = res; + }) + ); + } + + try { + await Promise.all(sendList); + return Response.json({ + code: 200, + msg: "ok", + data: sendRes, + }); + } catch { + return Response.json({ + code: 400, + msg: "send msg failed", + data: sendRes, + }); + } +}; diff --git a/routes/message/readme.md b/routes/message/readme.md index aa1cf60..b62a325 100644 --- a/routes/message/readme.md +++ b/routes/message/readme.md @@ -1 +1 @@ -# 批量发送消息，给已经订阅的用户和群组发送消息 +# 批量发送消息，给已经订阅的用户和群组发送消息 diff --git a/schedule/accessToken.ts b/schedule/accessToken.ts index 39a2a63..52263ba 100644 --- a/schedule/accessToken.ts +++ b/schedule/accessToken.ts @@ -1,20 +1,20 @@ -import db from "../db" - -export const resetAccessToken = async () => { - const URL = 'https://open.f.mioffice.cn/open-apis/auth/v3/tenant_access_token/internal' - const app_id = 'cli_a1eff35b43b89063' - const app_secret = 'IFSl8ig5DMwMnFjwPiljCfoEWlgRwDxW' - const res = await fetch(URL, { - method: 'POST', - headers: { - 'Content-Type': 'application/json' - }, - body: JSON.stringify({ - app_id, - app_secret - }) - }) - const { tenant_access_token } = await res.json() as any - await db.tenantAccessToken.update(tenant_access_token) - return tenant_access_token +import db from "../db" + +export const resetAccessToken = async () => { + const URL = 'https://open.f.mioffice.cn/open-apis/auth/v3/tenant_access_token/internal' + const app_id = 'cli_a1eff35b43b89063' + const app_secret = 'IFSl8ig5DMwMnFjwPiljCfoEWlgRwDxW' + const res = await fetch(URL, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + app_id, + app_secret + }) + }) + const { tenant_access_token } = await res.json() as any + await db.tenantAccessToken.update(tenant_access_token) + return tenant_access_token } \ No newline at end of file diff --git a/schedule/index.ts b/schedule/index.ts index d1c5945..0f919f1 100644 --- a/schedule/index.ts +++ b/schedule/index.ts @@ -1,9 +1,9 @@ -import { resetAccessToken } from "./accessToken"; -import schedule from 'node-schedule' - -export const initSchedule = async () => { - // 定时任务，每15分钟刷新一次token - schedule.scheduleJob('*/15 * * * *', resetAccessToken); - // 立即执行一次 - resetAccessToken() -} +import { resetAccessToken } from "./accessToken"; +import schedule from 'node-schedule' + +export const initSchedule = async () => { + // 定时任务，每15分钟刷新一次token + schedule.scheduleJob('*/15 * * * *', resetAccessToken); + // 立即执行一次 + resetAccessToken() +} diff --git a/service/index.ts b/service/index.ts index 8e81b3b..3f5d2d8 100644 --- a/service/index.ts +++ b/service/index.ts @@ -1,8 +1,8 @@ -export const fetchCIMonitor = async () => { - try { - const res = await fetch("https://ci-monitor.xiaomiwh.cn/ci"); - return ((await res.json()) as string) || ""; - } catch { - return ""; - } -}; +export const fetchCIMonitor = async () => { + try { + const res = await fetch("https://ci-monitor.xiaomiwh.cn/ci"); + return ((await res.json()) as string) || ""; + } catch { + return ""; + } +}; diff --git a/test.ts b/test.ts index 5c3fa86..c3a401b 100644 --- a/test.ts +++ b/test.ts @@ -1,5 +1,5 @@ -console.log( - JSON.stringify({ - text: "hello", - }) -); +console.log( + JSON.stringify({ + text: "hello", + }) +); diff --git a/thunder-tests/thunderActivity.json b/thunder-tests/thunderActivity.json index 529d187..f647a3a 100644 --- a/thunder-tests/thunderActivity.json +++ b/thunder-tests/thunderActivity.json @@ -1,21 +1,21 @@ -[ - { - "_id": "a5cb7b58-0c22-41fb-bc00-af460ef90c1b", - "colId": "history", - "containerId": "", - "name": "https://self.imoaix.cn/bot", - "url": "https://self.imoaix.cn/bot", - "method": "POST", - "sortNum": 0, - "created": "2023-08-15T07:47:05.439Z", - "modified": "2023-08-15T07:47:34.510Z", - "headers": [], - "params": [], - "body": { - "type": "json", - "raw": "{\r\n \"challenge\": \"c14206ad-5b5f-4a77-82b6-b39b7365392b\",\r\n \"token\": \"tV9djUKSjzVnekV7xTg2Od06NFTcsBnj\",\r\n \"type\": \"url_verification\"\r\n}", - "form": [] - }, - "tests": [] - } +[ + { + "_id": "a5cb7b58-0c22-41fb-bc00-af460ef90c1b", + "colId": "history", + "containerId": "", + "name": "https://self.imoaix.cn/bot", + "url": "https://self.imoaix.cn/bot", + "method": "POST", + "sortNum": 0, + "created": "2023-08-15T07:47:05.439Z", + "modified": "2023-08-15T07:47:34.510Z", + "headers": [], + "params": [], + "body": { + "type": "json", + "raw": "{\r\n \"challenge\": \"c14206ad-5b5f-4a77-82b6-b39b7365392b\",\r\n \"token\": \"tV9djUKSjzVnekV7xTg2Od06NFTcsBnj\",\r\n \"type\": \"url_verification\"\r\n}", + "form": [] + }, + "tests": [] + } ] \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 7556e1d..888802f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,22 +1,22 @@ -{ - "compilerOptions": { - "lib": ["ESNext"], - "module": "esnext", - "target": "esnext", - "moduleResolution": "bundler", - "moduleDetection": "force", - "allowImportingTsExtensions": true, - "noEmit": true, - "composite": true, - "strict": true, - "downlevelIteration": true, - "skipLibCheck": true, - "jsx": "react-jsx", - "allowSyntheticDefaultImports": true, - "forceConsistentCasingInFileNames": true, - "allowJs": true, - "types": [ - "bun-types" // add Bun global - ] - } -} +{ + "compilerOptions": { + "lib": ["ESNext"], + "module": "esnext", + "target": "esnext", + "moduleResolution": "bundler", + "moduleDetection": "force", + "allowImportingTsExtensions": true, + "noEmit": true, + "composite": true, + "strict": true, + "downlevelIteration": true, + "skipLibCheck": true, + "jsx": "react-jsx", + "allowSyntheticDefaultImports": true, + "forceConsistentCasingInFileNames": true, + "allowJs": true, + "types": [ + "bun-types" // add Bun global + ] + } +} diff --git a/typings.d.ts b/typings.d.ts index e592fcd..d37f58f 100644 --- a/typings.d.ts +++ b/typings.d.ts @@ -1,451 +1,451 @@ -/** - * 用户信息 - */ -interface User { - /** - * id - */ - id: string; - /** - * 用户名 - * @example zhaoyingbo - */ - userId: string; - /** - * open_id - */ - openId: string; - /** - * 提醒列表 - */ - remindList: string[]; -} - -/** - * 提醒列表 - */ -interface Remind { - /** - * id - */ - id: string; - /** - * 所有者信息，绑定用户表的id - */ - owner: string; - /** - * 消息Id - */ - messageId: string; - /** - * 接收者类型 - */ - subscriberType: "open_id" | "user_id" | "union_id" | "email" | "chat_id"; - /** - * 接收者Id - */ - subscriberId: string; - /** - * 是否需要回复，不需要回复的也不会重复提醒 - */ - needReply: boolean; - /** - * 延迟时间 - */ - delayTime: number; - /** - * 卡片信息，用于绘制初始卡片、确认卡片、取消卡片、延迟卡片 - */ - cardInfo: { - /** - * 提醒标题，必须要有 - */ - title: string; - /** - * 插图key - */ - imageKey?: string; - /** - * 提醒内容，为空不显示 - */ - content?: string; - /** - * 确认文本，为空不显示，为需要回复卡片时，如果为空则默认为“完成” - */ - confirmText?: string; - /** - * 取消文本，为空不显示 - */ - cancelText?: string; - /** - * 延迟文本，为空不显示 - */ - delayText?: string; - } | null; - /** - * 卡片模板信息 - */ - templateInfo: { - /** - * 卡片模板ID，会注入变量 - * ${owner} 所有者 - * ${remindTime} 提醒时间 - */ - pendingTemplateId: string; - /** - * 交互之后的卡片模板ID，如果有这个就不会用下边三个但是都会注入变量 - * ${owner} 所有者 - * ${remindTime} 提醒时间 - * ${result} 交互结果，会读卡片按钮绑定的变量text，如果没有则是绑定的result对应的 已确认、已取消、已延迟 - * ${interactTime} 交互时间 - */ - interactedTemplateId: string; - /** - * 确认之后的卡片模板ID - */ - confirmedTemplateId: string; - /** - * 取消之后的卡片模板ID - */ - cancelededTemplateId: string; - /** - * 延迟之后的卡片模板ID - */ - delayedTemplateId: string; - } | null; - - /** - * 提醒时间 - */ - remindTimes: RemindTime[]; - - /** - * 是否启用 - */ - enabled: boolean; - /** - * 下次提醒的时间，格式为yyyy-MM-dd HH:mm - */ - nextRemindTime: string; - /** - * 下次提醒时间的中文 - */ - nextRemindTimeCHS: string; -} - -/** - * 提醒时间 - * 为了支持多个时间点提醒，将时间存成数组 - */ -interface RemindTime { - /** - * 重复类型 - * single: 一次性 - * daily: 每天 - * weekly: 每周 - * monthly: 每月 - * yearly: 每年 - * workday: 工作日 - * holiday: 节假日 - */ - frequency: - | "single" - | "daily" - | "weekly" - | "monthly" - | "yearly" - | "workday" - | "holiday"; - /** - * 提醒时间，格式为HH:mm， single类型时仅作展示用，类型为yyyy-MM-dd HH:mm - */ - time: string; - /** - * 星期几[1-7]，当frequency为weekly时有效 - */ - daysOfWeek: number[]; - /** - * 每月的几号[1-31]，当frequency为monthly时有效 - */ - daysOfMonth: number[]; - /** - * 每年的哪天提醒，当frequency为 yearly 时有效，格式为MM-dd - */ - dayOfYear: string; -} - -/** - * 提醒记录 - * 记录提醒时间，回答结果等 - */ -interface RemindRecord { - /** - * 记录Id - */ - id: string; - /** - * 关联的提醒Id - */ - remindId: string; - /** - * 发送的卡片Id - */ - messageId: string; - /** - * 提醒状态 - * pending: 待确认 - * delay: 已延迟 - * confirmed: 已确认 - * canceled: 已取消 - */ - status: "pending" | "delayed" | "confirmed" | "canceled"; - /** - * 本次提醒时间，格式为yyyy-MM-dd HH:mm - */ - remindTime: string; - /** - * 用户交互的时间，格式为yyyy-MM-dd HH:mm - */ - interactTime: string; - /** - * 用户回答的结果，类似每天 07:00 - */ - result: object; -} - -/** - * 消息事件头 - */ -interface Header { - /** - * 事件ID - * @example 0f8ab23b60993cf8dd15c8cde4d7b0f5 - */ - event_id: string; - /** - * token - * @example tV9djUKSjzVnekV7xTg2Od06NFTcsBnj - */ - token: string; - /** - * 创建时间戳 - * @example 1693565712117 - */ - create_time: string; - /** - * 事件类型 - * @example im.message.receive_v1 - */ - event_type: string; - /** - * tenant_key - * @example 2ee61fe50f4f1657 - */ - tenant_key: string; - /** - * app_id - * @example cli_a1eff35b43b89063 - */ - app_id: string; -} - -/** - * 用户ID信息 - */ -interface UserIdInfo { - /** - * 用户标记 - * @example ou_032f507d08f9a7f28b042fcd086daef5 - */ - open_id: string; - /** - * 用户标记 - * @example on_7111660fddd8302ce47bf1999147c011 - */ - union_id: string; - /** - * 用户名 - * @example zhaoyingbo - */ - user_id: string; -} - -/** - * 被AT的人的信息 - */ -interface Mention { - /** - * 被艾特的人的ID信息 - */ - id: UserIdInfo; - /** - * 对应到文本内的内容 - * @example "@_user_1" - */ - key: string; - /** - * 用户名 - * @example 小煎蛋 - */ - name: string; - /** - * 应用ID - * @example 2ee61fe50f4f1657 - */ - tenant_key: string; -} - -/** - * 消息内容信息 - */ -interface Message { - /** - * 对话流ID - * @example oc_433b1cb7a9dbb7ebe70a4e1a59cb8bb1 - */ - chat_id: string; - /** - * 消息类型 - * @example group | p2p - */ - chat_type: string; - /** - * JSON字符串文本内容 - * @example "{\"text\":\"@_user_1 测试\"}" - */ - content: string; - /** - * 消息发送时间戳 - * @example 1693565711996 - */ - create_time: string; - /** - * 被艾特的人信息 - */ - mentions?: Mention[]; - /** - * 当前消息的ID - * @example om_038fc0eceed6224a1abc1cdaa4266405 - */ - message_id: string; - /** - * 消息类型 - * @example text、post、image、file、audio、media、sticker、interactive、share_chat、share_user - */ - message_type: string; -} - -/** - * 消息发送者信息 - */ -interface Sender { - /** - * id 相关信息 - */ - sender_id: UserIdInfo; - /** - * 发送者类型 - * @example user - */ - sender_type: string; - /** - * 应用ID - * @example 2ee61fe50f4f1657 - */ - tenant_key: string; -} - -/** - * 事件详情 - */ -interface Event { - message: Message; - sender: Sender; -} - -/** - * 事件订阅信息 - */ -interface LarkMessageEvent { - /** - * 协议版本 - * @example 2.0 - */ - schema: string; - /** - * 事件头 - */ - header: Header; - /** - * 事件详情 - */ - event: Event; -} - -/** - * 用户Action信息 - */ -interface LarkUserAction { - /** - * open_id - */ - open_id: string; - /** - * 用户名 - * @example zhaoyingbo - */ - user_id: string; - /** - * 当前消息的ID - * @example om_038fc0eceed6224a1abc1cdaa4266405 - */ - open_message_id: string; - /** - * 对话流ID - * @example oc_433b1cb7a9dbb7ebe70a4e1a59cb8bb1 - */ - open_chat_id: string; - /** - * 应用ID - * @example 2ee61fe50f4f1657 - */ - tenant_key: string; - /** - * token - * @example tV9djUKSjzVnekV7xTg2Od06NFTcsBnj - */ - token: string; - /** - * 事件结果 - */ - action: { - /** - * 传的参数 - */ - value: any; - /** - * 标签名 - * @example picker_datetime - */ - tag: string; - /** - * 选择的事件 - * @example 2023-09-03 10:35 +0800 - */ - option: string; - /** - * 时区 - */ - timezone: string; - }; -} - -type ReceiveIDType = "open_id" | "user_id" | "union_id" | "email" | "chat_id"; - -type MsgType = "text" | "post" | "image" | "file" | "audio" | "media" | "sticker" | "interactive" | "share_chat" | "share_user"; - -interface ServerResponse { - code: number; - data: any; - msg: string; -} +/** + * 用户信息 + */ +interface User { + /** + * id + */ + id: string; + /** + * 用户名 + * @example zhaoyingbo + */ + userId: string; + /** + * open_id + */ + openId: string; + /** + * 提醒列表 + */ + remindList: string[]; +} + +/** + * 提醒列表 + */ +interface Remind { + /** + * id + */ + id: string; + /** + * 所有者信息，绑定用户表的id + */ + owner: string; + /** + * 消息Id + */ + messageId: string; + /** + * 接收者类型 + */ + subscriberType: "open_id" | "user_id" | "union_id" | "email" | "chat_id"; + /** + * 接收者Id + */ + subscriberId: string; + /** + * 是否需要回复，不需要回复的也不会重复提醒 + */ + needReply: boolean; + /** + * 延迟时间 + */ + delayTime: number; + /** + * 卡片信息，用于绘制初始卡片、确认卡片、取消卡片、延迟卡片 + */ + cardInfo: { + /** + * 提醒标题，必须要有 + */ + title: string; + /** + * 插图key + */ + imageKey?: string; + /** + * 提醒内容，为空不显示 + */ + content?: string; + /** + * 确认文本，为空不显示，为需要回复卡片时，如果为空则默认为“完成” + */ + confirmText?: string; + /** + * 取消文本，为空不显示 + */ + cancelText?: string; + /** + * 延迟文本，为空不显示 + */ + delayText?: string; + } | null; + /** + * 卡片模板信息 + */ + templateInfo: { + /** + * 卡片模板ID，会注入变量 + * ${owner} 所有者 + * ${remindTime} 提醒时间 + */ + pendingTemplateId: string; + /** + * 交互之后的卡片模板ID，如果有这个就不会用下边三个但是都会注入变量 + * ${owner} 所有者 + * ${remindTime} 提醒时间 + * ${result} 交互结果，会读卡片按钮绑定的变量text，如果没有则是绑定的result对应的 已确认、已取消、已延迟 + * ${interactTime} 交互时间 + */ + interactedTemplateId: string; + /** + * 确认之后的卡片模板ID + */ + confirmedTemplateId: string; + /** + * 取消之后的卡片模板ID + */ + cancelededTemplateId: string; + /** + * 延迟之后的卡片模板ID + */ + delayedTemplateId: string; + } | null; + + /** + * 提醒时间 + */ + remindTimes: RemindTime[]; + + /** + * 是否启用 + */ + enabled: boolean; + /** + * 下次提醒的时间，格式为yyyy-MM-dd HH:mm + */ + nextRemindTime: string; + /** + * 下次提醒时间的中文 + */ + nextRemindTimeCHS: string; +} + +/** + * 提醒时间 + * 为了支持多个时间点提醒，将时间存成数组 + */ +interface RemindTime { + /** + * 重复类型 + * single: 一次性 + * daily: 每天 + * weekly: 每周 + * monthly: 每月 + * yearly: 每年 + * workday: 工作日 + * holiday: 节假日 + */ + frequency: + | "single" + | "daily" + | "weekly" + | "monthly" + | "yearly" + | "workday" + | "holiday"; + /** + * 提醒时间，格式为HH:mm， single类型时仅作展示用，类型为yyyy-MM-dd HH:mm + */ + time: string; + /** + * 星期几[1-7]，当frequency为weekly时有效 + */ + daysOfWeek: number[]; + /** + * 每月的几号[1-31]，当frequency为monthly时有效 + */ + daysOfMonth: number[]; + /** + * 每年的哪天提醒，当frequency为 yearly 时有效，格式为MM-dd + */ + dayOfYear: string; +} + +/** + * 提醒记录 + * 记录提醒时间，回答结果等 + */ +interface RemindRecord { + /** + * 记录Id + */ + id: string; + /** + * 关联的提醒Id + */ + remindId: string; + /** + * 发送的卡片Id + */ + messageId: string; + /** + * 提醒状态 + * pending: 待确认 + * delay: 已延迟 + * confirmed: 已确认 + * canceled: 已取消 + */ + status: "pending" | "delayed" | "confirmed" | "canceled"; + /** + * 本次提醒时间，格式为yyyy-MM-dd HH:mm + */ + remindTime: string; + /** + * 用户交互的时间，格式为yyyy-MM-dd HH:mm + */ + interactTime: string; + /** + * 用户回答的结果，类似每天 07:00 + */ + result: object; +} + +/** + * 消息事件头 + */ +interface Header { + /** + * 事件ID + * @example 0f8ab23b60993cf8dd15c8cde4d7b0f5 + */ + event_id: string; + /** + * token + * @example tV9djUKSjzVnekV7xTg2Od06NFTcsBnj + */ + token: string; + /** + * 创建时间戳 + * @example 1693565712117 + */ + create_time: string; + /** + * 事件类型 + * @example im.message.receive_v1 + */ + event_type: string; + /** + * tenant_key + * @example 2ee61fe50f4f1657 + */ + tenant_key: string; + /** + * app_id + * @example cli_a1eff35b43b89063 + */ + app_id: string; +} + +/** + * 用户ID信息 + */ +interface UserIdInfo { + /** + * 用户标记 + * @example ou_032f507d08f9a7f28b042fcd086daef5 + */ + open_id: string; + /** + * 用户标记 + * @example on_7111660fddd8302ce47bf1999147c011 + */ + union_id: string; + /** + * 用户名 + * @example zhaoyingbo + */ + user_id: string; +} + +/** + * 被AT的人的信息 + */ +interface Mention { + /** + * 被艾特的人的ID信息 + */ + id: UserIdInfo; + /** + * 对应到文本内的内容 + * @example "@_user_1" + */ + key: string; + /** + * 用户名 + * @example 小煎蛋 + */ + name: string; + /** + * 应用ID + * @example 2ee61fe50f4f1657 + */ + tenant_key: string; +} + +/** + * 消息内容信息 + */ +interface Message { + /** + * 对话流ID + * @example oc_433b1cb7a9dbb7ebe70a4e1a59cb8bb1 + */ + chat_id: string; + /** + * 消息类型 + * @example group | p2p + */ + chat_type: string; + /** + * JSON字符串文本内容 + * @example "{\"text\":\"@_user_1 测试\"}" + */ + content: string; + /** + * 消息发送时间戳 + * @example 1693565711996 + */ + create_time: string; + /** + * 被艾特的人信息 + */ + mentions?: Mention[]; + /** + * 当前消息的ID + * @example om_038fc0eceed6224a1abc1cdaa4266405 + */ + message_id: string; + /** + * 消息类型 + * @example text、post、image、file、audio、media、sticker、interactive、share_chat、share_user + */ + message_type: string; +} + +/** + * 消息发送者信息 + */ +interface Sender { + /** + * id 相关信息 + */ + sender_id: UserIdInfo; + /** + * 发送者类型 + * @example user + */ + sender_type: string; + /** + * 应用ID + * @example 2ee61fe50f4f1657 + */ + tenant_key: string; +} + +/** + * 事件详情 + */ +interface Event { + message: Message; + sender: Sender; +} + +/** + * 事件订阅信息 + */ +interface LarkMessageEvent { + /** + * 协议版本 + * @example 2.0 + */ + schema: string; + /** + * 事件头 + */ + header: Header; + /** + * 事件详情 + */ + event: Event; +} + +/** + * 用户Action信息 + */ +interface LarkUserAction { + /** + * open_id + */ + open_id: string; + /** + * 用户名 + * @example zhaoyingbo + */ + user_id: string; + /** + * 当前消息的ID + * @example om_038fc0eceed6224a1abc1cdaa4266405 + */ + open_message_id: string; + /** + * 对话流ID + * @example oc_433b1cb7a9dbb7ebe70a4e1a59cb8bb1 + */ + open_chat_id: string; + /** + * 应用ID + * @example 2ee61fe50f4f1657 + */ + tenant_key: string; + /** + * token + * @example tV9djUKSjzVnekV7xTg2Od06NFTcsBnj + */ + token: string; + /** + * 事件结果 + */ + action: { + /** + * 传的参数 + */ + value: any; + /** + * 标签名 + * @example picker_datetime + */ + tag: string; + /** + * 选择的事件 + * @example 2023-09-03 10:35 +0800 + */ + option: string; + /** + * 时区 + */ + timezone: string; + }; +} + +type ReceiveIDType = "open_id" | "user_id" | "union_id" | "email" | "chat_id"; + +type MsgType = "text" | "post" | "image" | "file" | "audio" | "media" | "sticker" | "interactive" | "share_chat" | "share_user"; + +interface ServerResponse { + code: number; + data: any; + msg: string; +} diff --git a/utils/msgTools.ts b/utils/msgTools.ts index 2b55781..593dd42 100644 --- a/utils/msgTools.ts +++ b/utils/msgTools.ts @@ -1,42 +1,42 @@ -/** - * 是否为事件消息 - * @param {LarkMessageEvent} body - */ -export const getIsEventMsg = (body: LarkMessageEvent) => { - return body?.header?.event_type === "im.message.receive_v1"; -}; - -/** - * 获取事件文本类型 - * @param {LarkMessageEvent} body - * @returns - */ -export const getMsgType = (body: LarkMessageEvent) => { - return body?.event?.message?.message_type; -}; - -/** - * 获取对话流Id - * @param {LarkMessageEvent} body - * @returns - */ -export const getChatId = (body: LarkMessageEvent) => { - return body?.event?.message?.chat_id; -}; - -/** - * 是否为Action消息 - * @param {LarkUserAction} body - */ -export const getIsActionMsg = (body: LarkUserAction) => { - return body?.action; -}; - -/** - * 获取Action类型 - * @param {LarkUserAction} body - * @returns {string} Action类型 - */ -export const getActionType = (body: LarkUserAction) => { - return body?.action?.tag; -}; +/** + * 是否为事件消息 + * @param {LarkMessageEvent} body + */ +export const getIsEventMsg = (body: LarkMessageEvent) => { + return body?.header?.event_type === "im.message.receive_v1"; +}; + +/** + * 获取事件文本类型 + * @param {LarkMessageEvent} body + * @returns + */ +export const getMsgType = (body: LarkMessageEvent) => { + return body?.event?.message?.message_type; +}; + +/** + * 获取对话流Id + * @param {LarkMessageEvent} body + * @returns + */ +export const getChatId = (body: LarkMessageEvent) => { + return body?.event?.message?.chat_id; +}; + +/** + * 是否为Action消息 + * @param {LarkUserAction} body + */ +export const getIsActionMsg = (body: LarkUserAction) => { + return body?.action; +}; + +/** + * 获取Action类型 + * @param {LarkUserAction} body + * @returns {string} Action类型 + */ +export const getActionType = (body: LarkUserAction) => { + return body?.action?.tag; +}; diff --git a/utils/pbTools.ts b/utils/pbTools.ts index 77ed703..ff4d048 100644 --- a/utils/pbTools.ts +++ b/utils/pbTools.ts @@ -1,11 +1,11 @@ -export const managePb404 = async (dbFunc: Function) => { - try { - return await dbFunc() - } catch (err: any) { - console.log("🚀 ~ manage404 ~ err:", err) - // 没有这个提醒就返回空 - if (err?.message === "The requested resource wasn't found.") { - return null - } else throw err; - } -} +export const managePb404 = async (dbFunc: Function) => { + try { + return await dbFunc() + } catch (err: any) { + console.log("🚀 ~ manage404 ~ err:", err) + // 没有这个提醒就返回空 + if (err?.message === "The requested resource wasn't found.") { + return null + } else throw err; + } +} diff --git a/utils/sendMsg.ts b/utils/sendMsg.ts index e1eed8b..6103d0e 100644 --- a/utils/sendMsg.ts +++ b/utils/sendMsg.ts @@ -1,115 +1,115 @@ -import db from "../db"; - -/** - * 发送消息 - * @param func fetch - * @returns - */ -const manageFetch = async (func: Function) => { - try { - const res = await func(); - const data = (await res.json()) as ServerResponse; - console.log("🚀 ~ manageFetch ~ data:", data); - return data; - } catch (error) { - console.log("🚀 ~ manageFetch ~ error:", error); - return { - code: 1, - data: null, - msg: "sendMsg fetch error", - }; - } -}; - -/** - * 获取header - * @returns header - */ -const getHeaders = async () => { - const tenant_access_token = await db.tenantAccessToken.get(); - return { - "Content-Type": "application/json", - Authorization: `Bearer ${tenant_access_token}`, - }; -}; - -/** - * 发送卡片 - * @param {ReceiveIDType} receive_id_type 消息接收者id类型 open_id/user_id/union_id/email/chat_id - * @param {string} receive_id 消息接收者的ID，ID类型应与查询参数receive_id_type 对应 - * @param {MsgType} msg_type 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user - * @param {string} content 消息内容，JSON结构序列化后的字符串。不同msg_type对应不同内容 - */ -export const sendMsg = async ( - receive_id_type: ReceiveIDType, - receive_id: string, - msg_type: MsgType, - content: string -) => { - const URL = `https://open.f.mioffice.cn/open-apis/im/v1/messages?receive_id_type=${receive_id_type}`; - const headers = await getHeaders(); - return await manageFetch(() => - fetch(URL, { - method: "POST", - headers, - body: JSON.stringify({ receive_id, msg_type, content }), - }) - ); -}; - -/** - * 更新卡片 - * @param {string} message_id 消息id - * @param {string} content 消息内容，JSON结构序列化后的字符串。不同msg_type对应不同内容 - */ -export const updateCard = async (message_id: string, content: string) => { - const URL = `https://open.f.mioffice.cn/open-apis/im/v1/messages/${message_id}`; - const headers = await getHeaders(); - return await manageFetch(() => - fetch(URL, { - method: "PATCH", - headers, - body: JSON.stringify({ content }), - }) - ); -}; - -/** - * 发送某人可见的卡片 - * @param {string} chat_id 对话流ID - * @param {string} open_id 消息接收者的ID - * @param {MsgType} msg_type 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user - * @param {*} card 消息卡片的描述内容，注意不是String - */ -export const sendEphemeralMsg = async ( - chat_id: string, - open_id: string, - msg_type: MsgType, - card: any -) => { - const URL = `https://open.f.mioffice.cn/open-apis/ephemeral/v1/send`; - const headers = await getHeaders(); - return await manageFetch(() => - fetch(URL, { - method: "POST", - headers, - body: JSON.stringify({ chat_id, open_id, msg_type, card }), - }) - ); -}; - -/** - * 删除某人可见的卡片 - * @param message_id 消息id - */ -export const delEphemeralMsg = async (message_id: string) => { - const URL = `https://open.f.mioffice.cn/open-apis/ephemeral/v1/delete`; - const headers = await getHeaders(); - return await manageFetch(() => - fetch(URL, { - method: "POST", - headers, - body: JSON.stringify({ message_id }), - }) - ); -}; +import db from "../db"; + +/** + * 发送消息 + * @param func fetch + * @returns + */ +const manageFetch = async (func: Function) => { + try { + const res = await func(); + const data = (await res.json()) as ServerResponse; + console.log("🚀 ~ manageFetch ~ data:", data); + return data; + } catch (error) { + console.log("🚀 ~ manageFetch ~ error:", error); + return { + code: 1, + data: null, + msg: "sendMsg fetch error", + }; + } +}; + +/** + * 获取header + * @returns header + */ +const getHeaders = async () => { + const tenant_access_token = await db.tenantAccessToken.get(); + return { + "Content-Type": "application/json", + Authorization: `Bearer ${tenant_access_token}`, + }; +}; + +/** + * 发送卡片 + * @param {ReceiveIDType} receive_id_type 消息接收者id类型 open_id/user_id/union_id/email/chat_id + * @param {string} receive_id 消息接收者的ID，ID类型应与查询参数receive_id_type 对应 + * @param {MsgType} msg_type 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user + * @param {string} content 消息内容，JSON结构序列化后的字符串。不同msg_type对应不同内容 + */ +export const sendMsg = async ( + receive_id_type: ReceiveIDType, + receive_id: string, + msg_type: MsgType, + content: string +) => { + const URL = `https://open.f.mioffice.cn/open-apis/im/v1/messages?receive_id_type=${receive_id_type}`; + const headers = await getHeaders(); + return await manageFetch(() => + fetch(URL, { + method: "POST", + headers, + body: JSON.stringify({ receive_id, msg_type, content }), + }) + ); +}; + +/** + * 更新卡片 + * @param {string} message_id 消息id + * @param {string} content 消息内容，JSON结构序列化后的字符串。不同msg_type对应不同内容 + */ +export const updateCard = async (message_id: string, content: string) => { + const URL = `https://open.f.mioffice.cn/open-apis/im/v1/messages/${message_id}`; + const headers = await getHeaders(); + return await manageFetch(() => + fetch(URL, { + method: "PATCH", + headers, + body: JSON.stringify({ content }), + }) + ); +}; + +/** + * 发送某人可见的卡片 + * @param {string} chat_id 对话流ID + * @param {string} open_id 消息接收者的ID + * @param {MsgType} msg_type 消息类型 包括：text、post、image、file、audio、media、sticker、interactive、share_chat、share_user + * @param {*} card 消息卡片的描述内容，注意不是String + */ +export const sendEphemeralMsg = async ( + chat_id: string, + open_id: string, + msg_type: MsgType, + card: any +) => { + const URL = `https://open.f.mioffice.cn/open-apis/ephemeral/v1/send`; + const headers = await getHeaders(); + return await manageFetch(() => + fetch(URL, { + method: "POST", + headers, + body: JSON.stringify({ chat_id, open_id, msg_type, card }), + }) + ); +}; + +/** + * 删除某人可见的卡片 + * @param message_id 消息id + */ +export const delEphemeralMsg = async (message_id: string) => { + const URL = `https://open.f.mioffice.cn/open-apis/ephemeral/v1/delete`; + const headers = await getHeaders(); + return await manageFetch(() => + fetch(URL, { + method: "POST", + headers, + body: JSON.stringify({ message_id }), + }) + ); +};