karin-plugin-adapter-all 0.0.0-stage → 1.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 karinjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,107 @@
-# Temporary Holding Version
+# karin-plugin-adapter-SnowLuma
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+基于 [node-karin](https://www.npmjs.com/package/node-karin) 的多协议统一适配器插件，一套配置同时接入多种机器人协议，统一转换为 Karin 的消息与事件结构。
+
+## 支持的协议
+
+| 协议 | 说明 |
+| --- | --- |
+| OneBot 11 | 支持 SnowLuma / NapCat / Lagrange / 标准实现，通信方式支持 HTTP、正向 WebSocket、反向 WebSocket、SSE |
+| OneBot 12 | 标准 OneBot 12 实现 |
+| ICQQ | QQ 协议直连（快速登录 / 密码 / 扫码），支持滑动验证码多通道处理 |
+| Milky | WebSocket / SSE / WebHook 三种事件接收方式 |
+| Kook | 官方 API 直连，支持官方 Gateway（WS）与 WebHook 两种事件接收方式 |
+| QQBot | 官方开放平台 API 直连（api-v2 鉴权），支持官方 WebSocket Gateway 与 WebHook，支持扫码绑定 AppID/AppSecret |
+
+## 功能特性
+
+- **可视化配置面板**：插件自带的 Web 界面支持添加 / 编辑 / 删除机器人，实时保存热更新，无需重启 Karin
+- **QQBot 扫码绑定**：在配置面板扫码快速获取 AppID / AppSecret，绑定成功后自动保存配置并开始连接机器人
+- **富媒体消息**：图片、语音、视频、文件消息完整支持（QQBot 走官方富媒体上传通道）
+- **断线重连**：所有网络型连接均内置自动重连与心跳
+- **icqq 滑动验证**：GT 网页验证、txhelper、手动 ticket、自建 Cloudflare Pages 多通道并行处理
+
+## 安装
+
+```bash
+pnpm add karin-plugin-adapter-all -w
+```
+
+然后在 Karin 根目录启动，插件会自动注册。
+
+### ICQQ 协议
+
+icqq 依赖包名 `icqq`（npm 别名指向 `@icqqjs/icqq`），安装本插件时已自动装好；若被手动移除，一条命令重装：
+
+```bash
+pnpm add icqq@npm:@icqqjs/icqq -w
+```
+
+装好后无需重启，在配置面板添加 ICQQ 机器人并保存即可热更新生效。
+
+## 配置
+
+访问 Karin 提供的插件 Web 控制台（默认地址与 Karin 主控制台相同），在「适配器」页面添加机器人：
+
+1. 选择协议（OneBot 11 / OneBot 12 / ICQQ / Milky / Kook / QQBot）
+2. 按需填写连接地址、Token、AppID / AppSecret 等参数
+3. 保存即热更新生效
+
+### QQBot 扫码绑定
+
+QQBot 协议可在配置面板直接扫码：
+
+1. 在 QQBot 配置处点击「扫码绑定」
+2. 用 QQ 扫描二维码完成授权
+3. 授权成功后 AppID / AppSecret 自动回填并保存，立即开始连接
+
+### 消息正则替换
+
+Kook / QQBot 入站消息默认开启正则替换，可将协议端命令风格转换为 Karin 默认前缀，例如：
+
+```json
+{ "match": "^\\s*\\\\/", "to": "#" }
+```
+
+将 `/命令` 转为 `#命令`。可在配置中通过 `msgReplaceEnable: false` 关闭。
+
+## 开发
+
+```bash
+pnpm install
+pnpm dev          # 开发模式（核心 + 构建 Web 面板）
+pnpm build        # 编译 TS + 构建 Web 面板资源
+pnpm app          # 运行编译产物
+```
+
+目录结构：
+
+```
+src/
+├── adapters/        # 各协议实现（onebot11 / onebot12 / icqq / milky / kook / qqbot）
+├── utils/           # 配置、扫码绑定、事件工具
+├── server.ts        # 控制台服务（配置保存 API、扫码、WebHook 入口）
+└── index.ts         # 插件入口
+web/                 # 配置面板（Next.js + Tailwind）
+```
+
+## 自动化发布
+
+推送到 `main` 分支后，GitHub Actions 自动完成：
+
+1. **release-please** 依据 Conventional Commits 自动生成版本号（feat → minor，fix → patch）、打 tag 并创建 GitHub Release
+2. 自动构建并发布到 npm（需配置 `NPM_TOKEN` secret）
+3. **sync-build** 构建编译产物并强制同步到 `build` 分支，`build` 分支始终与最新 `main` 保持一致且包含 `dist/` 产物
+
+日常开发流程：
+
+```bash
+git commit -m "feat: 新增 xxx"
+git push
+```
+
+发布成功后在 [npm](https://www.npmjs.com/) 与 GitHub Releases 页面即可看到新版本。
+
+## License
+
+[MIT](./LICENSE)

package/dist/config-DKcb6lmw.js

@@ -0,0 +1,54 @@
+import { dir } from "./dir.js";
+import { copyConfigSync, filesByExt, requireFileSync, watch } from "node-karin";
+import fs from "node:fs";
+
+//#region src/utils/config.ts
+/** 网页面板访问前缀 须与 web/next.config.mjs 的 basePath 保持一致 */
+const WEB_PREFIX = "/adapter-all";
+/**
+* @description 初始化配置文件
+*/
+copyConfigSync(dir.defConfigDir, dir.ConfigDir, [".json"]);
+/**
+* @description 配置文件
+* force 强制重读: requireFileSync 默认缓存 300 秒且命中会续期,
+* 否则热更新/网页面板保存后读到的仍是旧配置
+*/
+const config$1 = () => {
+	const cfg = requireFileSync(`${dir.ConfigDir}/config.json`, { force: true });
+	const def = requireFileSync(`${dir.defConfigDir}/config.json`);
+	return {
+		...def,
+		...cfg
+	};
+};
+/**
+* @description 写入配置文件 (网页面板保存用)
+*/
+const saveConfig = (data) => {
+	fs.writeFileSync(`${dir.ConfigDir}/config.json`, JSON.stringify(data, null, 2));
+};
+const changeListeners = new Set();
+/**
+* @description 订阅配置文件变更 文件被保存/修改后触发 (热更新等场景使用)
+*/
+const onConfigChange = (cb) => {
+	changeListeners.add(cb);
+	return () => changeListeners.delete(cb);
+};
+/**
+* @description 监听配置文件
+*/
+setTimeout(() => {
+	const list = filesByExt(dir.ConfigDir, ".json", "abs");
+	list.forEach((file) => watch(file, () => {
+		changeListeners.forEach((cb) => {
+			try {
+				cb();
+			} catch {}
+		});
+	}));
+}, 2e3);
+
+//#endregion
+export { saveConfig as i, config$1 as n, onConfigChange as r, WEB_PREFIX as t };

package/dist/dir.js

@@ -0,0 +1,49 @@
+import path from "node:path";
+import { URL, fileURLToPath } from "node:url";
+import { karinPathBase, requireFileSync } from "node-karin";
+
+//#region src/dir.ts
+/** 插件包绝对路径 */
+const pluginDir = fileURLToPath(new URL("../", import.meta.url));
+/** 插件包目录名称 */
+const pluginName = path.basename(pluginDir);
+/** package.json */
+const pkg = requireFileSync(path.join(pluginDir, "package.json"));
+/**
+* 插件目录信息
+*/
+const dir = {
+	/** 根目录绝对路径 */
+	pluginDir,
+	/** 插件目录名称 */
+	pluginName,
+	/** package.json */
+	pkg,
+	/** 插件版本 package.json 的 version */
+	get version() {
+		return pkg.version;
+	},
+	/** 插件名称 package.json 的 name */
+	get name() {
+		return pkg.name;
+	},
+	/** 插件默认配置目录 */
+	get defConfigDir() {
+		return path.join(pluginDir, "config");
+	},
+	/** 在`@karinjs`中的绝对路径 */
+	get karinPath() {
+		return path.join(karinPathBase, pluginName);
+	},
+	/** 插件配置目录 `@karinjs/karin-plugin-xxx/config` */
+	get ConfigDir() {
+		return path.join(this.karinPath, "config");
+	},
+	/** 插件资源目录 `@karinjs/karin-plugin-xxx/resources` */
+	get defResourcesDir() {
+		return path.join(this.karinPath, "resources");
+	}
+};
+
+//#endregion
+export { dir };