node-karin 0.0.3

package/README.md

@@ -0,0 +1,57 @@
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
+
+[文档](https://karinjs.github.io/Karin/)
+
+基于 [Kritor](https://github.com/KarinJS/kritor-kotlin) 标准进行开发的 [nodejs](https://nodejs.org/en) 机器人框架  
+
+> 本项目正在开发中，不建议用于生产环境
+
+---
+
+### 目前计划
+
+- [x] [kritor标准](https://github.com/KarinJS/kritor)
+- [x] [onebot11](https://github.com/botuniverse/onebot-11)
+- [ ] [onebot12](https://onebot.dev/)
+- [ ] 支持主动[grpc](https://grpc.io/)
+- [x] 支持被动[grpc](https://grpc.io/)
+- [x] 支持主动ws 12暂未支持
+- [x] 支持被动ws
+- [ ] 支持onebot HTTP
+- [x] 支持[onebots](https://github.com/lc-cn/onebots)
+- [x] ~~puppeteer渲染图片~~
+- [x] 外置[puppeteer](https://github.com/KarinJS/karin-plugin-puppeteer)
+- [ ] 降低对`redis`的依赖
+- [ ] 支持 package.karin
+- [ ] 支持db通用接口
+- [ ] 支持动态加载插件
+- [x] 支持`redis`集群
+
+> 关于`puppeteer`，由于内置的chrome过于臃肿，将会移除内置的pupppeteer，分开搭建或使用远程、作为插件等方式使用puppeteer。  
+> [karin-puppeteer](https://github.com/KarinJS/karin-puppeteer)
+
+### 感谢
+
+Karin的开发离不开以下项目的帮助：
+
+- [Kritor](https://github.com/KarinJS/kritor) Kritor标准
+- [OpenShamrock](https://github.com/whitechi73/OpenShamrock) Kritor标准Kotlin的实现
+- [onebots](https://github.com/lc-cn/onebots) onebots适配器
+- [onebot-11](https://github.com/botuniverse/onebot-11) onebot11标准
+- [Miao-Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) 最开始的代码结构
+- [Yunzai-Bot](https://gitee.com/le-niao/Yunzai-Bot) 最开始的代码结构
+
+### 来加入我们吧~
+
+QQGroup: 967068507 
+
+Discord: [☘Karin的喵趴～](https://discord.com/channels/1251552521957408878/1251552521957408881)
+
+
+### 贡献者
+
+> 🌟星光闪烁，你们的智慧如同璀璨的夜空。感谢所有为**Karin**做出贡献的人！
+
+[![贡献者](https://contributors-img.web.app/image?repo=KarinJS/Karin)](https://github.com/KarinJS/Karin/graphs/contributors)
+
+![Alt](https://repobeats.axiom.co/api/embed/aaaa2759c8885691443a4d80e5753f975d4f250e.svg "Repobeats analytics image")

package/config/defSet/App.yaml

@@ -0,0 +1,37 @@
+# 黑名单相关
+BlackList:
+  # 黑名单用户
+  users: false
+  # 黑名单群聊
+  groups: false
+  # 消息日志黑名单群聊 设置后不会打印该群的消息日志
+  GroupMsgLog: false
+
+# 白名单相关
+WhiteList:
+  # 白名单用户
+  users: false
+  # 白名单群聊
+  groups: false
+  # 消息日志白名单群聊 设置后只会打印该群的消息日志
+  GroupMsgLog: false
+
+# 群聊
+GroupConfig:
+  # 群聊中所有消息冷却时间
+  GroupCD: false
+
+  # 群聊中 每个人的消息冷却时间
+  GroupUserCD: true
+
+  # 机器人响应模式
+  mode: false
+
+  # 机器人前缀 设置后前缀+指令触发机器人
+  alias: false
+
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应
+  enable: false
+
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应
+  disable: false

package/config/defSet/config.yaml

@@ -0,0 +1,43 @@
+# log4js 日志配置
+log4jsCfg:
+  # 日志等级: trace, debug, info, warn, fatal, mark, error, off
+  level: info
+  # 日志保留天数
+  daysToKeep: 7
+  # 整体化: 将日志输出到一个文件(一天为一个文件) 日志较多的情况下不建议与碎片化同时开启
+  overall: true
+  # 碎片化: 将日志分片，达到指定大小后自动切割 日志较多的情况下不建议与整体化同时开启
+  fragments: false
+  # 日志文件最大大小 MB
+  maxLogSize: 30
+
+# 控制台触发插件日志颜色 十六进制 默认#FFFF00 不支持热更新
+log_color: "#E1D919"
+
+# ffmpeg配置 用于音视频处理
+ffmpeg_path:
+ffprobe_path:
+
+# 主人列表 主权限
+master: []
+
+# 管理员列表 子权限
+admin: []
+
+# 黑名单相关
+BlackList:
+  # 黑名单用户
+  users: []
+  # 黑名单群聊
+  groups: []
+  # 消息日志黑名单群聊 设置后不会打印该群的消息日志
+  GroupMsgLog: []
+
+# 白名单相关
+WhiteList:
+  # 白名单用户
+  users: []
+  # 白名单群聊
+  groups: []
+  # 消息日志白名单群聊 设置后只会打印该群的消息日志
+  GroupMsgLog: []

package/config/defSet/group.yaml

@@ -0,0 +1,18 @@
+# 默认配置
+default:
+  # 群聊中所有消息冷却时间，单位秒,0则无限制
+  GroupCD: 0
+  # 群聊中 每个人的消息冷却时间，单位秒，0则无限制。注意，开启后所有消息都会进CD，无论是否触发插件。
+  GroupUserCD: 1
+  # 机器人响应模式，0-所有 1-仅@机器人 2-仅回应主人 3-仅回应前缀 4-前缀或@机器人 5-主人无前缀，群员前缀或@机器人
+  mode: 0
+
+  # 机器人前缀 设置后前缀+指令触发机器人
+  alias:
+    - karin
+
+  # 白名单插件、功能，只有在白名单中的插件、功能才会响应
+  enable: []
+
+  # 黑名单插件、功能，黑名单中的插件、功能不会响应
+  disable: []

package/config/defSet/pm2.yaml

@@ -0,0 +1,21 @@
+# 最多显示多少行日志
+lines: 1000
+
+apps:
+  - name: "Karin"
+    # 入口
+    script: "./lib/index.js"
+    # 进程守护
+    autorestart: true
+    # 每分钟最大重启数量
+    max_restarts: 60
+    # 内存溢出重启，可以是“10M”、“100K”、“2G”等
+    max_memory_restart: "1G"
+    # 重启延迟 2s
+    restart_delay: 2000
+    # 避免使用进程 id 后缀日志文件
+    merge_logs: true
+    # 错误日志路径
+    error_file: "./logs/pm2_error.log"
+    # 输出日志路径
+    out_file: "./logs/pm2_out.log"

package/config/defSet/redis.yaml

@@ -0,0 +1,18 @@
+# redis地址
+host: 127.0.0.1
+# redis端口
+port: 6379
+# redis用户名，可以为空
+username:
+# redis密码，没有密码可以为空
+password:
+# redis数据库
+db: 0
+
+# 集群配置
+cluster:
+  # 是否启用集群
+  enable: false
+  # 集群地址
+  rootNodes:
+    - url: Redis://127.0.0.1:6379/0

package/config/defSet/server.yaml

@@ -0,0 +1,42 @@
+# 当前文件热更新是否重启http、grpc服务
+HotUpdate: false
+
+# http 服务器配置
+http:
+  # 监听地址
+  host: 0.0.0.0
+  # 端口
+  port: 7000
+
+# grpc 服务器配置
+grpc:
+  # 监听地址
+  host: 0.0.0.0:7001
+  # Api请求超时时间 秒
+  timeout: 60
+
+# websocket 服务器配置
+websocket:
+  # API请求超时时间 秒
+  timeout: 60
+  # websocket 渲染器地址 ws://127.0.0.1:7005/ws/render
+  render: []
+  # onebot11 正向WebSocket地址
+  OneBot11Host: []
+  # onebot12 正向WebSocket地址
+  OneBot12Host: []
+
+# HTTP渲染器配置
+HttpRender:
+  # 是否开启http渲染
+  enable: false
+  # karin端Api地址 公网 > 局域网 > 127
+  host: http://127.0.0.1:7000
+  # karin-puppeteer渲染器 post请求地址
+  post: http://127.0.0.1:7005/api/render
+  # karin-puppeteer渲染器 post请求token
+  token: Karin-Puppeteer
+  # 请求的非html或非有效路径的返回内容 可以填http地址 例如：https://ys.mihoyo.com
+  not_found: "404 Not Found"
+  # Wormhole代理地址 无公网环境的情况下使用
+  WormholeClient: ""

package/config/view/App.yaml

@@ -0,0 +1,74 @@
+name: 应用配置
+view:
+  -
+    key: 黑名单
+    comment: 黑名单相关
+    path: 'BlackList'
+    type: 'group'
+    part:
+        -
+          key: 黑名单用户
+          path: 'BlackList.users'
+          type: 'boolean'
+        -
+          key: 黑名单群聊
+          path: 'BlackList.groups'
+          type: 'boolean'
+        -
+          key: 消息日志黑名单群聊
+          comment: 设置后不会打印该群的消息日志
+          path: 'BlackList.GroupMsgLog'
+          type: 'boolean'
+  -
+    key: 白名单
+    comment: 白名单相关
+    path: 'WhiteList'
+    type: 'group'
+    part:
+        -
+          key: 白名单用户
+          path: 'WhiteList.users'
+          type: 'boolean'
+        -
+          key: 白名单群聊
+          path: 'WhiteList.groups'
+          type: 'boolean'
+        -
+          key: 消息日志白名单群聊
+          comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
+          path: 'WhiteList.GroupMsgLog'
+          type: 'boolean'
+  -
+    key: 群聊
+    path: 'GroupConfig'
+    type: 'group'
+    part:
+        -
+          key: 消息冷却时间
+          comment: 群聊中所有消息冷却时间
+          path: 'GroupConfig.GroupCD'
+          type: 'boolean'
+        -
+          key: 个人消息冷却时间
+          comment: 群聊中 每个人的消息冷却时间
+          path: 'GroupConfig.GroupUserCD'
+          type: 'boolean'
+        -
+          key: 机器人响应模式
+          path: 'GroupConfig.mode'
+          type: 'boolean'
+        -
+          key: 机器人前缀
+          comment: 机器人前缀 设置后前缀+指令触发机器人
+          path: 'GroupConfig.alias'
+          type: 'boolean'
+        -
+          key: 白名单插件、功能
+          comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
+          path: 'GroupConfig.enable'
+          type: 'boolean'
+        -
+          key: 黑名单插件、功能
+          comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
+          path: 'GroupConfig.disable'
+          type: 'boolean'

package/config/view/config.yaml

@@ -0,0 +1,100 @@
+name: 通用配置
+view:
+  -
+    key: 日志等级
+    comment: 日志等级:trace,debug,info,warn,fatal,mark,error,off
+    path: 'log_level'
+    type: 'select'
+    multiple: false
+    item:
+      -
+        name: Trace
+        value: trace
+      -
+        name: Debug
+        value: ebug
+      -
+        name: Info
+        value: info
+      -
+        name: Warn
+        value: warn
+      -
+        name: Fatal
+        value: fatal
+      -
+        name: Mark
+        value: mark
+      -
+        name: Error
+        value: error
+      -
+        name: Off
+        value: off
+  -
+    key: 日志保留天数
+    path: 'log_days_Keep'
+    type: 'number'
+  -
+    key: ffmpeg路径
+    comment: ffmpeg配置 用于音视频处理
+    path: 'ffmpeg_path'
+    type: 'text'
+  -
+    key: ffprobe路径
+    comment: ffmpeg配置 用于音视频处理
+    path: 'ffprobe_path'
+    type: 'text'
+  -
+    key: 主人列表
+    comment: 主人列表 主权限
+    path: 'master'
+    type: 'array'
+    arrayType: 'number'
+  -
+    key: 管理员列表
+    comment: 管理员列表 子权限
+    path: 'admin'
+    type: 'array'
+    arrayType: 'number'
+  -
+    key: 黑名单
+    comment: 黑名单相关
+    path: 'BlackList'
+    type: 'group'
+    part:
+        -
+          key: 黑名单用户
+          path: 'BlackList.users'
+          type: 'array'
+          arrayType: 'number'
+        -
+          key: 黑名单群聊
+          path: 'BlackList.groups'
+          type: 'array'
+          arrayType: 'number'
+        -
+          key: 消息日志黑名单群聊
+          comment: 设置后不会打印该群的消息日志
+          path: 'BlackList.GroupMsgLog'
+          type: 'array'
+          arrayType: 'number'
+  -
+    key: 白名单
+    comment: 白名单相关
+    path: 'WhiteList'
+    type: 'group'
+    part:
+        -
+          key: 白名单用户
+          path: 'WhiteList.users'
+          type: 'boolean'
+        -
+          key: 白名单群聊
+          path: 'WhiteList.groups'
+          type: 'boolean'
+        -
+          key: 消息日志白名单群聊
+          comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
+          path: 'WhiteList.GroupMsgLog'
+          type: 'boolean'

package/config/view/group.yaml

@@ -0,0 +1,62 @@
+name: 群聊配置
+view:
+  -
+    key: 默认配置
+    path: 'default'
+    type: 'group'
+    part:
+        -
+          key: 消息冷却时间
+          comment: 群聊中所有消息冷却时间，0则无限制
+          path: 'default.global_cd'
+          type: 'number'
+          suffix: 秒
+        -
+          key: 个人消息冷却时间
+          comment: 群聊中 每个人的消息冷却时间，0则无限制。注意，开启后所有消息，无论是否触发插件。
+          path: 'default.personal_cd'
+          type: 'number'
+          suffix: 秒
+        -
+          key: 机器人响应模式
+          comment: 机器人响应模式，0-所有 1-仅@机器人 2-仅回应主人 3-仅回应前缀 4-前缀或@机器人 5-主人无前缀，群员前缀或@机器人
+          path: 'default.mode'
+          type: 'select'
+          multiple: false
+          item:
+            -
+              name: 所有
+              value: 0
+            -
+              name: 仅@机器人
+              value: 1
+            -
+              name: 仅回应主人
+              value: 2
+            -
+              name: 仅回应前缀
+              value: 3
+            -
+              name: 前缀或@机器人
+              value: 4
+            -
+              name: 主人无前缀，群员前缀或@机器人
+              value: 5
+        -
+          key: 机器人前缀
+          comment: 机器人前缀 设置后前缀+指令触发机器人
+          path: 'default.ailas'
+          type: 'array'
+          arrayType: 'text'
+        -
+          key: 白名单插件
+          comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
+          path: 'default.enable'
+          type: 'array'
+          arrayType: 'text'
+        -
+          key: 黑名单插件
+          comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
+          path: 'default.disable'
+          type: 'array'
+          arrayType: 'text'

package/config/view/pm2.yaml

@@ -0,0 +1,41 @@
+name: pm2配置
+view:
+  -
+    key: 应用
+    path: 'apps'
+    type: 'group'
+    part:
+        -
+          key: 启动名称
+          path: 'apps.name'
+          type: 'text'
+        -
+          key: 进程守护
+          path: 'apps.autorestart'
+          type: 'boolean'
+        -
+          key: 每分钟最大重启数量
+          path: 'apps.max_restarts'
+          type: 'number'
+        -
+          key: 内存溢出重启
+          comment: 内存溢出重启，可以是“10M”、“100K”、“2G”等
+          path: 'apps.max_memory_restart'
+          type: 'text'
+        -
+          key: 重启延迟
+          path: 'apps.restart_delay'
+          type: 'number'
+          suffix: 毫秒
+        -
+          key: 避免使用进程 id 后缀日志文件
+          path: 'apps.merge_logs'
+          type: 'boolean'
+        -
+          key: 错误日志路径
+          path: 'apps.error_file'
+          type: 'text'
+        -
+          key: 输出日志路径
+          path: 'apps.out_file'
+          type: 'text'

package/config/view/redis.yaml

@@ -0,0 +1,25 @@
+name: 数据库配置
+view:
+  -
+    key: redis地址
+    path: 'host'
+    type: 'text'
+  -
+    key: redis端口
+    path: 'port'
+    type: 'number'
+  -
+    key: redis用户名
+    comment: redis用户名，可以为空
+    path: 'username'
+    type: 'text'
+  -
+    key: redis密码
+    comment: redis密码，没有密码可以为空
+    path: 'password'
+    type: 'password'
+  -
+    key: 数据库
+    comment: 运行中第几个redis数据库
+    path: 'db'
+    type: 'number'

package/config/view/server.yaml

@@ -0,0 +1,93 @@
+name: 服务配置
+view:
+  -
+    key: 热更新是否重启服务
+    comment: 当前文件热更新是否重启http、grpc服务
+    path: 'HotUpdate'
+    type: 'boolean'
+  -
+    key: http 服务器配置
+    path: 'http'
+    type: 'group'
+    part:
+        -
+          key: 监听地址
+          path: 'http.host'
+          type: 'text'
+        -
+          key: 端口
+          path: 'http.port'
+          type: 'number'
+  -
+    key: grpc 服务器配置
+    path: 'grpc'
+    type: 'group'
+    part:
+        -
+          key: 监听地址
+          path: 'grpc.host'
+          type: 'text'
+        -
+          key: Api请求超时时间
+          path: 'grpc.timeout'
+          type: 'number'
+          suffix: 秒
+  -
+    key: websocket 服务器配置
+    path: 'websocket'
+    type: 'group'
+    part:
+        -
+          key: API请求超时时间
+          path: 'websocket.timeout'
+          type: 'number'
+          suffix: 秒
+        -
+          key: websocket 渲染器地址
+          comment: ws://127.0.0.1:7005/ws/render
+          path: 'websocket.render'
+          type: 'array'
+          arrayType: 'text'
+        -
+          key: onebot11 正向WebSocket地址
+          path: 'websocket.OneBot11Host'
+          type: 'array'
+          arrayType: 'text'
+        -
+          key: onebot12 正向WebSocket地址
+          path: 'websocket.OneBot12Host'
+          type: 'array'
+          arrayType: 'text'
+  -
+    key: HTTP渲染器配置
+    path: 'HttpRender'
+    type: 'group'
+    part:
+        -
+          key: 是否开启http渲染
+          path: 'HttpRender.enable'
+          type: 'boolean'
+        -
+          key: karin端Api地址
+          comment: 公网 > 局域网 > 127
+          path: 'HttpRender.host'
+          type: 'url'
+        -
+          key: karin-puppeteer渲染器 post请求地址
+          path: 'HttpRender.post'
+          type: 'url'
+        -
+          key: karin-puppeteer渲染器 post请求token
+          path: 'HttpRender.token'
+          type: 'text'
+        -
+          key: 请求的非html或非有效路径的返回内容
+          comment: 可以填http地址 例如：https://ys.mihoyo.com
+          path: 'HttpRender.not_found'
+          type: 'text'
+        -
+          key: Wormhole代理地址
+          comment: 无公网IP环境的情况下使用
+          path: 'HttpRender.WormholeClient'
+          type: 'text'
+