koishi-plugin-github-webhook-pusher 0.0.7 → 0.0.8

package/lib/commands/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * 命令模块入口
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerUtilCommands = exports.registerSubscriptionCommands = exports.registerTrustCommands = void 0;
+var trust_1 = require("./trust");
+Object.defineProperty(exports, "registerTrustCommands", { enumerable: true, get: function () { return trust_1.registerTrustCommands; } });
+var subscription_1 = require("./subscription");
+Object.defineProperty(exports, "registerSubscriptionCommands", { enumerable: true, get: function () { return subscription_1.registerSubscriptionCommands; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "registerUtilCommands", { enumerable: true, get: function () { return utils_1.registerUtilCommands; } });

package/lib/commands/subscription.js

@@ -0,0 +1,214 @@
+"use strict";
+/**
+ * 订阅管理命令
+ * 需求: 3.1-3.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSubscriptionCommands = registerSubscriptionCommands;
+const types_1 = require("../types");
+const trust_1 = require("../repository/trust");
+const subscription_1 = require("../repository/subscription");
+/** 所有支持的事件类型 */
+const ALL_EVENT_TYPES = [
+    'issues',
+    'issue_comment',
+    'pull_request',
+    'pull_request_review',
+    'pull_request_review_comment',
+    'release',
+    'push',
+    'star',
+    'fork',
+    'create',
+    'delete',
+    'workflow_run',
+];
+/**
+ * 从会话中提取会话标识
+ */
+function getSessionIdentifier(session) {
+    return {
+        platform: session.platform,
+        channelId: session.channelId,
+        guildId: session.guildId,
+        userId: session.userId,
+    };
+}
+/**
+ * 解析事件变更参数
+ * 格式: +issues -star +release
+ * @param changes 变更参数数组
+ * @param currentEvents 当前事件列表
+ * @returns 新的事件列表
+ */
+function parseEventChanges(changes, currentEvents) {
+    const events = new Set(currentEvents);
+    for (const change of changes) {
+        if (!change)
+            continue;
+        const prefix = change[0];
+        const eventName = change.slice(1);
+        // 验证事件类型
+        if (!ALL_EVENT_TYPES.includes(eventName)) {
+            continue;
+        }
+        if (prefix === '+') {
+            events.add(eventName);
+        }
+        else if (prefix === '-') {
+            events.delete(eventName);
+        }
+    }
+    return Array.from(events);
+}
+/**
+ * 注册订阅管理命令
+ * @param ctx Koishi 上下文
+ * @param config 插件配置
+ */
+function registerSubscriptionCommands(ctx, config) {
+    ctx.command('gh', 'GitHub Webhook 指令');
+    // gh.sub <repo> - 订阅仓库
+    ctx.command('gh.sub <repo:string>', '订阅 GitHub 仓库事件')
+        .usage('gh.sub owner/repo')
+        .example('gh.sub koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        if (!repo) {
+            return '❌ 请指定仓库名，格式: owner/repo';
+        }
+        // 检查仓库是否在信任列表中
+        const trusted = await (0, trust_1.isInTrustList)(ctx, repo);
+        if (!trusted) {
+            return '❌ 该仓库不在信任列表中';
+        }
+        const sessionId = getSessionIdentifier(session);
+        const subscription = await (0, subscription_1.createSubscription)(ctx, sessionId, repo, config.defaultEvents);
+        if (subscription) {
+            const eventList = subscription.events.join(', ');
+            return `✅ 已订阅仓库: ${repo}\n📋 订阅事件: ${eventList}`;
+        }
+        return '❌ 订阅失败';
+    });
+    // gh.unsub <repo> - 取消订阅
+    ctx.command('gh.unsub <repo:string>', '取消订阅 GitHub 仓库')
+        .usage('gh.unsub owner/repo')
+        .example('gh.unsub koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        const sessionId = getSessionIdentifier(session);
+        const success = await (0, subscription_1.removeSubscription)(ctx, sessionId, repo);
+        if (success) {
+            return `✅ 已取消订阅: ${repo}`;
+        }
+        return `❌ 未找到仓库 ${repo} 的订阅`;
+    });
+    // gh.list - 列出当前会话的所有订阅
+    ctx.command('gh.list', '列出当前会话的所有订阅')
+        .usage('gh.list')
+        .action(async ({ session }) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        const sessionId = getSessionIdentifier(session);
+        const subscriptions = await (0, subscription_1.listSubscriptions)(ctx, sessionId);
+        if (subscriptions.length === 0) {
+            return '📋 当前会话没有订阅任何仓库';
+        }
+        const lines = ['📋 订阅列表:'];
+        for (const sub of subscriptions) {
+            const status = sub.enabled ? '✅' : '⏸️';
+            const events = sub.events.join(', ');
+            lines.push(`${status} ${sub.repo}`);
+            lines.push(`   事件: ${events}`);
+        }
+        return lines.join('\n');
+    });
+    // gh.events <repo> - 查看订阅事件
+    ctx.command('gh.events [repo:string]', '查看订阅的事件类型')
+        .usage('gh.events [owner/repo]')
+        .example('gh.events koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        if (!repo) {
+            // 显示所有可用事件类型
+            const lines = ['📋 可用事件类型:'];
+            for (const [type, info] of Object.entries(types_1.EVENT_DISPLAY_MAP)) {
+                lines.push(`${info.emoji} ${type} - ${info.name}`);
+            }
+            return lines.join('\n');
+        }
+        const sessionId = getSessionIdentifier(session);
+        const subscription = await (0, subscription_1.getSubscription)(ctx, sessionId, repo);
+        if (!subscription) {
+            return `❌ 未找到仓库 ${repo} 的订阅`;
+        }
+        const events = subscription.events.join(', ');
+        return `📋 ${repo} 订阅的事件:\n${events}`;
+    });
+    ctx.command('gh.on <repo:string> [...events:string]', '快捷启用订阅事件')
+        .usage('gh.on owner/repo issues pull_request')
+        .example('gh.on koishijs/koishi issues pull_request')
+        .action(async ({ session }, repo, ...events) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        if (!events || events.length === 0) {
+            const eventList = ALL_EVENT_TYPES.map(e => {
+                const info = types_1.EVENT_DISPLAY_MAP[e];
+                return `${info.emoji} ${e}`;
+            }).join(', ');
+            return `❌ 请指定事件类型\n可用类型: ${eventList}`;
+        }
+        const sessionId = getSessionIdentifier(session);
+        const subscription = await (0, subscription_1.getSubscription)(ctx, sessionId, repo);
+        if (!subscription) {
+            return `❌ 未找到仓库 ${repo} 的订阅`;
+        }
+        const changes = events.map(event => `+${event}`);
+        const newEvents = parseEventChanges(changes, subscription.events);
+        const success = await (0, subscription_1.updateEvents)(ctx, sessionId, repo, newEvents);
+        if (success) {
+            const eventList = newEvents.join(', ');
+            return `✅ 已启用 ${repo} 的订阅事件:\n${eventList}`;
+        }
+        return '❌ 更新失败';
+    });
+    ctx.command('gh.off <repo:string> [...events:string]', '快捷禁用订阅事件')
+        .usage('gh.off owner/repo issues pull_request')
+        .example('gh.off koishijs/koishi issues pull_request')
+        .action(async ({ session }, repo, ...events) => {
+        if (!session)
+            return '❌ 无法获取会话信息';
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        if (!events || events.length === 0) {
+            const eventList = ALL_EVENT_TYPES.map(e => {
+                const info = types_1.EVENT_DISPLAY_MAP[e];
+                return `${info.emoji} ${e}`;
+            }).join(', ');
+            return `❌ 请指定事件类型\n可用类型: ${eventList}`;
+        }
+        const sessionId = getSessionIdentifier(session);
+        const subscription = await (0, subscription_1.getSubscription)(ctx, sessionId, repo);
+        if (!subscription) {
+            return `❌ 未找到仓库 ${repo} 的订阅`;
+        }
+        const changes = events.map(event => `-${event}`);
+        const newEvents = parseEventChanges(changes, subscription.events);
+        const success = await (0, subscription_1.updateEvents)(ctx, sessionId, repo, newEvents);
+        if (success) {
+            const eventList = newEvents.join(', ');
+            return `✅ 已禁用 ${repo} 的订阅事件:\n${eventList}`;
+        }
+        return '❌ 更新失败';
+    });
+}

package/lib/commands/trust.js

@@ -0,0 +1,119 @@
+"use strict";
+/**
+ * 信任仓库管理命令
+ * 需求: 2.1-2.5, 8.3
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerTrustCommands = registerTrustCommands;
+const trust_1 = require("../repository/trust");
+/** 管理员权限等级 */
+const ADMIN_AUTHORITY = 3;
+/**
+ * 注册信任仓库管理命令
+ * @param ctx Koishi 上下文
+ */
+function registerTrustCommands(ctx) {
+    // 创建 gh.trust 命令组
+    const trust = ctx.command('gh.trust', '管理信任的 GitHub 仓库')
+        .usage('gh.trust <add|remove|list|enable|disable> [repo]');
+    // gh.trust.add <repo> - 添加信任仓库
+    trust.subcommand('.add <repo:string>', '添加信任仓库')
+        .usage('gh.trust.add owner/repo')
+        .example('gh.trust.add koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        if (!repo) {
+            return '❌ 请指定仓库名，格式: owner/repo';
+        }
+        // 格式验证
+        if (!(0, trust_1.isValidRepoFormat)(repo)) {
+            return '❌ 仓库格式错误，请使用 owner/repo 格式';
+        }
+        const result = await (0, trust_1.addTrustedRepo)(ctx, repo);
+        if (result) {
+            return `✅ 已添加信任仓库: ${repo}`;
+        }
+        return '❌ 添加失败';
+    });
+    // gh.trust.remove <repo> - 移除信任仓库
+    trust.subcommand('.remove <repo:string>', '移除信任仓库')
+        .usage('gh.trust.remove owner/repo')
+        .example('gh.trust.remove koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        const success = await (0, trust_1.removeTrustedRepo)(ctx, repo);
+        if (success) {
+            return `✅ 已移除信任仓库: ${repo}`;
+        }
+        return `❌ 仓库 ${repo} 不在信任列表中`;
+    });
+    // gh.trust.list - 列出所有信任仓库
+    trust.subcommand('.list', '列出所有信任仓库')
+        .usage('gh.trust.list')
+        .action(async ({ session }) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        const repos = await (0, trust_1.listTrustedRepos)(ctx);
+        if (repos.length === 0) {
+            return '📋 信任仓库列表为空';
+        }
+        const lines = ['📋 信任仓库列表:'];
+        for (const repo of repos) {
+            const status = repo.enabled ? '✅' : '⏸️';
+            lines.push(`${status} ${repo.repo}`);
+        }
+        return lines.join('\n');
+    });
+    // gh.trust.enable <repo> - 启用信任仓库
+    trust.subcommand('.enable <repo:string>', '启用信任仓库')
+        .usage('gh.trust.enable owner/repo')
+        .example('gh.trust.enable koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        const success = await (0, trust_1.enableRepo)(ctx, repo);
+        if (success) {
+            return `✅ 已启用仓库: ${repo}`;
+        }
+        return `❌ 仓库 ${repo} 不在信任列表中`;
+    });
+    // gh.trust.disable <repo> - 禁用信任仓库
+    trust.subcommand('.disable <repo:string>', '禁用信任仓库')
+        .usage('gh.trust.disable owner/repo')
+        .example('gh.trust.disable koishijs/koishi')
+        .action(async ({ session }, repo) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        if (!repo) {
+            return '❌ 请指定仓库名';
+        }
+        const success = await (0, trust_1.disableRepo)(ctx, repo);
+        if (success) {
+            return `⏸️ 已禁用仓库: ${repo}`;
+        }
+        return `❌ 仓库 ${repo} 不在信任列表中`;
+    });
+}

package/lib/commands/utils.js

@@ -0,0 +1,182 @@
+"use strict";
+/**
+ * 工具命令
+ * 需求: 8.1, 8.2
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerUtilCommands = registerUtilCommands;
+const types_1 = require("../types");
+const trust_1 = require("../repository/trust");
+const message_1 = require("../message");
+/** 插件名称（避免循环依赖） */
+const PLUGIN_NAME = 'github-webhook-pusher';
+/** 管理员权限等级 */
+const ADMIN_AUTHORITY = 3;
+/** 所有支持的事件类型 */
+const ALL_EVENT_TYPES = [
+    'issues',
+    'issue_comment',
+    'pull_request',
+    'pull_request_review',
+    'pull_request_review_comment',
+    'release',
+    'push',
+    'star',
+    'fork',
+    'create',
+    'delete',
+    'workflow_run',
+];
+/**
+ * 生成测试事件数据
+ */
+function generateTestEvent(repo, eventType) {
+    const baseEvent = {
+        type: eventType,
+        displayType: (0, types_1.getDisplayType)(eventType),
+        repo,
+        actor: 'test-user',
+        url: `https://github.com/${repo}`,
+    };
+    switch (eventType) {
+        case 'issues':
+            return {
+                ...baseEvent,
+                action: 'opened',
+                title: '测试 Issue 标题',
+                number: 123,
+            };
+        case 'issue_comment':
+            return {
+                ...baseEvent,
+                action: 'created',
+                title: '测试 Issue 标题',
+                number: 123,
+            };
+        case 'release':
+            return {
+                ...baseEvent,
+                action: 'published',
+                title: 'v1.0.0',
+                tagName: 'v1.0.0',
+            };
+        case 'push':
+            return {
+                ...baseEvent,
+                ref: 'main',
+                commits: [
+                    { sha: 'abc1234', message: '测试提交 1', author: 'test-user', url: '' },
+                    { sha: 'def5678', message: '测试提交 2', author: 'test-user', url: '' },
+                ],
+                totalCommits: 2,
+            };
+        case 'pull_request':
+            return {
+                ...baseEvent,
+                action: 'opened',
+                title: '测试 PR 标题',
+                number: 456,
+            };
+        case 'pull_request_review':
+            return {
+                ...baseEvent,
+                action: 'approved',
+                title: '测试 PR 标题',
+                number: 456,
+            };
+        case 'pull_request_review_comment':
+            return {
+                ...baseEvent,
+                action: 'created',
+                title: '测试 PR 标题',
+                number: 456,
+            };
+        case 'star':
+            return {
+                ...baseEvent,
+                action: 'created',
+                starCount: 1234,
+            };
+        case 'fork':
+            return {
+                ...baseEvent,
+                action: 'forked',
+                title: `${repo}-fork`,
+            };
+        case 'create':
+            return {
+                ...baseEvent,
+                action: 'created',
+                ref: 'branch:feature/test',
+            };
+        case 'delete':
+            return {
+                ...baseEvent,
+                action: 'deleted',
+                ref: 'branch:feature/old',
+            };
+        case 'workflow_run':
+            return {
+                ...baseEvent,
+                action: 'completed/success',
+                title: 'CI',
+            };
+        default:
+            return baseEvent;
+    }
+}
+/**
+ * 注册工具命令
+ * @param ctx Koishi 上下文
+ * @param config 插件配置
+ */
+function registerUtilCommands(ctx, config) {
+    // gh.ping - 返回插件状态信息
+    ctx.command('gh.ping', '查看插件状态')
+        .usage('gh.ping')
+        .action(async () => {
+        const repos = await (0, trust_1.listTrustedRepos)(ctx);
+        const enabledCount = repos.filter(r => r.enabled).length;
+        const lines = [
+            '🏓 GitHub Webhook 推送插件',
+            `📦 插件名称: ${PLUGIN_NAME}`,
+            `🔗 Webhook 路径: ${config.path}`,
+            `📋 信任仓库: ${repos.length} 个 (${enabledCount} 个已启用)`,
+            `🔧 调试模式: ${config.debug ? '开启' : '关闭'}`,
+        ];
+        return lines.join('\n');
+    });
+    // gh.test <repo> <event> - 生成并推送测试消息（管理员）
+    ctx.command('gh.test <repo:string> <event:string>', '生成测试消息')
+        .usage('gh.test owner/repo event')
+        .example('gh.test koishijs/koishi issues')
+        .example('gh.test koishijs/koishi push')
+        .action(async ({ session }, repo, event) => {
+        // 权限检查
+        const user = session?.user;
+        if ((user?.authority ?? 0) < ADMIN_AUTHORITY) {
+            return '❌ 权限不足，需要管理员权限';
+        }
+        if (!repo) {
+            return '❌ 请指定仓库名，格式: owner/repo';
+        }
+        if (!event) {
+            const eventList = ALL_EVENT_TYPES.map(e => {
+                const info = types_1.EVENT_DISPLAY_MAP[e];
+                return `${info.emoji} ${e}`;
+            }).join(', ');
+            return `❌ 请指定事件类型\n可用类型: ${eventList}`;
+        }
+        // 验证事件类型
+        if (!ALL_EVENT_TYPES.includes(event)) {
+            const eventList = ALL_EVENT_TYPES.join(', ');
+            return `❌ 不支持的事件类型: ${event}\n可用类型: ${eventList}`;
+        }
+        // 生成测试事件
+        const testEvent = generateTestEvent(repo, event);
+        const message = (0, message_1.buildMessage)(testEvent);
+        // 发送测试消息到当前会话
+        await session?.send(message);
+        return; // 消息已发送，不需要额外返回
+    });
+}

package/lib/config.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const koishi_1 = require("koishi");
+/** 支持的事件类型列表 */
+const EVENT_TYPES = [
+    'issues',
+    'issue_comment',
+    'pull_request',
+    'pull_request_review',
+    'pull_request_review_comment',
+    'release',
+    'push',
+    'star',
+    'fork',
+    'create',
+    'delete',
+    'workflow_run',
+];
+exports.Config = koishi_1.Schema.object({
+    path: koishi_1.Schema.string().default('/github/webhook').description('Webhook 接收路径'),
+    secret: koishi_1.Schema.string().required().description('GitHub Webhook Secret'),
+    baseUrl: koishi_1.Schema.string().description('显示用基础 URL'),
+    defaultEvents: koishi_1.Schema.array(koishi_1.Schema.union(EVENT_TYPES.map(e => koishi_1.Schema.const(e))))
+        .default(['issues', 'release', 'push'])
+        .description('默认订阅事件'),
+    debug: koishi_1.Schema.boolean().default(false).description('调试模式'),
+    allowUntrusted: koishi_1.Schema.boolean().default(false).description('允许非信任仓库'),
+    concurrency: koishi_1.Schema.number().default(5).description('推送并发数'),
+});

package/lib/database.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendDatabase = extendDatabase;
+function extendDatabase(ctx) {
+    ctx.model.extend('github_trusted_repos', {
+        id: { type: 'unsigned', length: 10 },
+        repo: { type: 'string', length: 255 },
+        enabled: 'boolean',
+        createdAt: 'timestamp',
+        updatedAt: 'timestamp',
+    }, {
+        primary: 'id',
+        autoInc: true,
+        unique: ['repo'],
+    });
+    ctx.model.extend('github_subscriptions', {
+        id: { type: 'unsigned', length: 10 },
+        platform: 'string',
+        channelId: 'string',
+        guildId: 'string',
+        userId: 'string',
+        repo: 'string',
+        events: 'json',
+        enabled: 'boolean',
+        createdAt: 'timestamp',
+        updatedAt: 'timestamp',
+    }, {
+        primary: 'id',
+        autoInc: true,
+    });
+    ctx.model.extend('github_deliveries', {
+        deliveryId: 'string',
+        repo: 'string',
+        event: 'string',
+        receivedAt: 'timestamp',
+    }, {
+        primary: 'deliveryId',
+    });
+}

package/lib/index.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * Koishi GitHub Webhook 推送插件入口
+ * 需求: 1.1, 7.1-7.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = exports.inject = exports.name = void 0;
+exports.apply = apply;
+const koishi_1 = require("koishi");
+const config_1 = require("./config");
+Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
+const database_1 = require("./database");
+const webhook_1 = require("./webhook");
+const commands_1 = require("./commands");
+/** 插件名称 */
+exports.name = 'github-webhook-pusher';
+/** 声明服务依赖 - 需要 server 服务提供 router 和 database 服务 */
+exports.inject = ['server', 'database'];
+/** 插件日志 */
+const logger = new koishi_1.Logger('github-webhook-pusher');
+/**
+ * 插件入口函数
+ * @param ctx Koishi 上下文
+ * @param config 插件配置
+ */
+function apply(ctx, config) {
+    // 需求 7.1-7.7: 使用配置项
+    logger.info(`正在加载 GitHub Webhook 插件...`);
+    // 初始化数据库
+    // 需求 6.1, 6.2, 6.3: 创建数据库表
+    (0, database_1.extendDatabase)(ctx);
+    logger.debug('数据库模型已注册');
+    // 需求 1.1: 注册 Webhook 处理器
+    (0, webhook_1.registerWebhook)(ctx, config);
+    logger.debug(`Webhook 处理器已注册: ${config.path}`);
+    // 注册所有命令
+    // 需求 2.1-2.5: 信任仓库管理命令
+    (0, commands_1.registerTrustCommands)(ctx);
+    logger.debug('信任仓库管理命令已注册');
+    // 需求 3.1-3.7: 订阅管理命令
+    (0, commands_1.registerSubscriptionCommands)(ctx, config);
+    logger.debug('订阅管理命令已注册');
+    // 需求 8.1, 8.2: 工具命令
+    (0, commands_1.registerUtilCommands)(ctx, config);
+    logger.debug('工具命令已注册');
+    // 插件启动日志
+    logger.info(`GitHub Webhook 插件已加载`);
+    logger.info(`Webhook 路径: ${config.path}`);
+    logger.info(`默认订阅事件: ${config.defaultEvents.join(', ')}`);
+    if (config.debug) {
+        logger.info('调试模式已启用');
+    }
+}