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

package/lib/index.js

@@ -0,0 +1,80 @@
+"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");
+const repository_1 = require("./repository");
+/** 插件名称 */
+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('工具命令已注册');
+    scheduleDeliveryCleanup(ctx, config);
+    // 插件启动日志
+    logger.info(`GitHub Webhook 插件已加载`);
+    logger.info(`Webhook 路径: ${config.path}`);
+    logger.info(`默认订阅事件: ${config.defaultEvents.join(', ')}`);
+    if (config.debug) {
+        logger.info('调试模式已启用');
+    }
+}
+function scheduleDeliveryCleanup(ctx, config) {
+    if (config.deliveryRetentionDays <= 0) {
+        logger.debug('投递记录清理已禁用');
+        return;
+    }
+    const intervalHours = Math.max(1, config.deliveryCleanupIntervalHours || 24);
+    const intervalMs = intervalHours * 60 * 60 * 1000;
+    const runCleanup = async () => {
+        const beforeDate = new Date(Date.now() - config.deliveryRetentionDays * 24 * 60 * 60 * 1000);
+        const removed = await (0, repository_1.cleanupDeliveries)(ctx, beforeDate);
+        if (config.debug) {
+            logger.debug(`清理投递记录: ${removed} 条 (保留 ${config.deliveryRetentionDays} 天)`);
+        }
+    };
+    runCleanup().catch(error => {
+        const message = error instanceof Error ? error.message : String(error);
+        logger.warn(`投递记录清理失败: ${message}`);
+    });
+    ctx.setInterval(() => {
+        runCleanup().catch(error => {
+            const message = error instanceof Error ? error.message : String(error);
+            logger.warn(`投递记录清理失败: ${message}`);
+        });
+    }, intervalMs);
+}

package/lib/message.js

@@ -0,0 +1,250 @@
+"use strict";
+/**
+ * 消息构建器
+ * 需求: 5.3, 5.4, 5.5
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildMessage = buildMessage;
+const koishi_1 = require("koishi");
+const types_1 = require("./types");
+/**
+ * 构建推送消息
+ * @param event 解析后的事件
+ * @returns Koishi Element 消息数组
+ */
+function buildMessage(event) {
+    switch (event.type) {
+        case 'issues':
+            return buildIssuesMessage(event);
+        case 'issue_comment':
+            return buildIssueCommentMessage(event);
+        case 'release':
+            return buildReleaseMessage(event);
+        case 'push':
+            return buildPushMessage(event);
+        case 'pull_request':
+            return buildPullRequestMessage(event);
+        case 'pull_request_review':
+            return buildPullRequestReviewMessage(event);
+        case 'pull_request_review_comment':
+            return buildPullRequestReviewCommentMessage(event);
+        case 'star':
+            return buildStarMessage(event);
+        case 'fork':
+            return buildForkMessage(event);
+        case 'create':
+            return buildCreateMessage(event);
+        case 'delete':
+            return buildDeleteMessage(event);
+        case 'workflow_run':
+            return buildWorkflowRunMessage(event);
+        default:
+            return buildGenericMessage(event);
+    }
+}
+/**
+ * 构建 Issues 事件消息
+ * 格式: 📌 [owner/repo] Issue
+ *       user opened #123: Issue Title
+ *       https://github.com/...
+ */
+function buildIssuesMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} #${event.number}: ${event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildIssueCommentMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} #${event.number}: ${event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 构建 Release 事件消息
+ * 格式: 🚀 [owner/repo] Release
+ *       user published v1.0.0
+ *       https://github.com/...
+ */
+function buildReleaseMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} ${event.tagName || event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 构建 Push 事件消息
+ * 格式: ⬆️ [owner/repo] Commit
+ *       user 推送了 3 个提交到 main
+ *
+ *       • abc1234 - 提交消息1
+ *       • def5678 - 提交消息2
+ *       • ghi9012 - 提交消息3
+ *
+ *       还有 2 条提交...
+ *       https://github.com/...
+ */
+function buildPushMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const commits = event.commits || [];
+    const totalCommits = event.totalCommits || commits.length;
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} 推送了 ${totalCommits} 个提交到 ${event.ref}`,
+        '',
+    ];
+    // 添加提交列表
+    for (const commit of commits) {
+        lines.push(`• ${commit.sha} - ${commit.message}`);
+    }
+    // 如果有更多提交，显示提示
+    if (totalCommits > commits.length) {
+        lines.push('');
+        lines.push(`还有 ${totalCommits - commits.length} 条提交...`);
+    }
+    lines.push(event.url);
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 构建 Pull Request 事件消息
+ * 格式: 🔀 [owner/repo] PR
+ *       user opened #123: PR Title
+ *       https://github.com/...
+ */
+function buildPullRequestMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} #${event.number}: ${event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildPullRequestReviewMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} #${event.number}: ${event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildPullRequestReviewCommentMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} #${event.number}: ${event.title}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 构建 Star 事件消息
+ * 格式: ⭐ [owner/repo] Star
+ *       user starred (⭐ 1234)
+ *       https://github.com/...
+ */
+function buildStarMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = event.action === 'created' ? 'starred' : 'unstarred';
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText} (⭐ ${event.starCount})`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildForkMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const target = event.title ? ` -> ${event.title}` : '';
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} forked${target}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildCreateMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const refText = event.ref ? ` ${event.ref}` : '';
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText}${refText}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildDeleteMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const refText = event.ref ? ` ${event.ref}` : '';
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText}${refText}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+function buildWorkflowRunMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const actionText = getActionText(event.action);
+    const nameText = event.title ? ` ${event.title}` : '';
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${actionText}${nameText}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 构建通用事件消息（兜底）
+ */
+function buildGenericMessage(event) {
+    const emoji = (0, types_1.getEventEmoji)(event.type);
+    const lines = [
+        `${emoji} [${event.repo}] ${event.displayType}`,
+        `${event.actor} ${event.action || 'triggered'}`,
+        event.url,
+    ];
+    return [(0, koishi_1.h)('text', { content: lines.join('\n') })];
+}
+/**
+ * 获取动作的中文描述
+ */
+function getActionText(action) {
+    const actionMap = {
+        opened: 'opened',
+        closed: 'closed',
+        reopened: 'reopened',
+        edited: 'edited',
+        merged: 'merged',
+        published: 'published',
+        created: 'created',
+        deleted: 'deleted',
+        submitted: 'submitted',
+        dismissed: 'dismissed',
+        approved: 'approved',
+        changes_requested: 'changes requested',
+        commented: 'commented',
+        requested: 'requested',
+        completed: 'completed',
+        forked: 'forked',
+    };
+    return actionMap[action || ''] || action || '';
+}

package/lib/parser.js

@@ -0,0 +1,304 @@
+"use strict";
+/**
+ * GitHub Webhook 事件解析器
+ * 需求: 4.1-4.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseIssuesEvent = parseIssuesEvent;
+exports.parseIssueCommentEvent = parseIssueCommentEvent;
+exports.parseReleaseEvent = parseReleaseEvent;
+exports.parsePushEvent = parsePushEvent;
+exports.parsePullRequestEvent = parsePullRequestEvent;
+exports.parsePullRequestReviewEvent = parsePullRequestReviewEvent;
+exports.parsePullRequestReviewCommentEvent = parsePullRequestReviewCommentEvent;
+exports.parseStarEvent = parseStarEvent;
+exports.parseForkEvent = parseForkEvent;
+exports.parseCreateEvent = parseCreateEvent;
+exports.parseDeleteEvent = parseDeleteEvent;
+exports.parseWorkflowRunEvent = parseWorkflowRunEvent;
+exports.parseEvent = parseEvent;
+const types_1 = require("./types");
+/** Push 事件最大显示提交数 */
+const MAX_COMMITS = 3;
+/**
+ * 解析 Issues 事件
+ * 需求 4.1: 提取 issue 标题、编号、操作者和链接
+ */
+function parseIssuesEvent(payload) {
+    const { action, issue, repository, sender } = payload;
+    // 只处理 opened/closed/reopened/edited 动作
+    if (!['opened', 'closed', 'reopened', 'edited'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'issues',
+        displayType: (0, types_1.getDisplayType)('issues'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: issue.title,
+        number: issue.number,
+        url: issue.html_url,
+        body: issue.body,
+    };
+}
+/**
+ * 解析 Issue Comment 事件
+ */
+function parseIssueCommentEvent(payload) {
+    const { action, issue, comment, repository, sender } = payload;
+    // 只处理 created/edited/deleted 动作
+    if (!['created', 'edited', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'issue_comment',
+        displayType: (0, types_1.getDisplayType)('issue_comment'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: issue.title,
+        number: issue.number,
+        url: comment?.html_url || issue.html_url,
+        body: comment?.body,
+    };
+}
+/**
+ * 解析 Release 事件
+ * 需求 4.2: 提取版本号、发布者和下载链接
+ */
+function parseReleaseEvent(payload) {
+    const { action, release, repository, sender } = payload;
+    // 只处理 published/created 动作
+    if (!['published', 'created'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'release',
+        displayType: (0, types_1.getDisplayType)('release'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: release.name || release.tag_name,
+        tagName: release.tag_name,
+        url: release.html_url,
+        body: release.body,
+    };
+}
+/**
+ * 解析 Push 事件
+ * 需求 4.3, 4.6: 提取分支名、提交列表（最多5条）和推送者信息
+ */
+function parsePushEvent(payload) {
+    const { ref, commits, repository, sender, compare } = payload;
+    // 提取分支名（去掉 refs/heads/ 前缀）
+    const branch = ref?.replace('refs/heads/', '') || '';
+    // 解析提交列表
+    const allCommits = (commits || []).map((commit) => ({
+        sha: commit.id?.substring(0, 7) || '',
+        message: commit.message?.split('\n')[0] || '', // 只取第一行
+        author: commit.author?.name || commit.author?.username || '',
+        url: commit.url || '',
+    }));
+    // 截断到最多 MAX_COMMITS 条
+    const displayCommits = allCommits.slice(0, MAX_COMMITS);
+    return {
+        type: 'push',
+        displayType: (0, types_1.getDisplayType)('push'), // 显示为 "Commit"
+        repo: repository.full_name,
+        actor: sender.login,
+        ref: branch,
+        commits: displayCommits,
+        totalCommits: allCommits.length,
+        url: compare || `https://github.com/${repository.full_name}`,
+    };
+}
+/**
+ * 解析 Pull Request 事件
+ * 需求 4.4: 提取 PR 标题、编号、操作者和链接
+ */
+function parsePullRequestEvent(payload) {
+    const { action, pull_request, repository, sender } = payload;
+    // 只处理 opened/closed/merged 动作
+    // 注意: merged 实际上是 closed + merged 标志
+    const validActions = ['opened', 'closed', 'reopened', 'edited'];
+    if (!validActions.includes(action)) {
+        return null;
+    }
+    // 判断是否为合并
+    const actualAction = action === 'closed' && pull_request.merged ? 'merged' : action;
+    return {
+        type: 'pull_request',
+        displayType: (0, types_1.getDisplayType)('pull_request'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: actualAction,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: pull_request.html_url,
+        body: pull_request.body,
+    };
+}
+/**
+ * 解析 Pull Request Review 事件
+ */
+function parsePullRequestReviewEvent(payload) {
+    const { action, review, pull_request, repository, sender } = payload;
+    // 只处理 submitted/edited/dismissed 动作
+    if (!['submitted', 'edited', 'dismissed'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'pull_request_review',
+        displayType: (0, types_1.getDisplayType)('pull_request_review'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: review?.state || action,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: review?.html_url || pull_request.html_url,
+        body: review?.body,
+    };
+}
+/**
+ * 解析 Pull Request Review Comment 事件
+ */
+function parsePullRequestReviewCommentEvent(payload) {
+    const { action, comment, pull_request, repository, sender } = payload;
+    // 只处理 created/edited/deleted 动作
+    if (!['created', 'edited', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'pull_request_review_comment',
+        displayType: (0, types_1.getDisplayType)('pull_request_review_comment'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: comment?.html_url || pull_request.html_url,
+        body: comment?.body,
+    };
+}
+/**
+ * 解析 Star 事件
+ * 需求 4.5: 提取操作者和当前 star 数量
+ */
+function parseStarEvent(payload) {
+    const { action, repository, sender } = payload;
+    // star 事件只有 created 和 deleted 动作
+    if (!['created', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'star',
+        displayType: (0, types_1.getDisplayType)('star'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        starCount: repository.stargazers_count,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Fork 事件
+ */
+function parseForkEvent(payload) {
+    const { forkee, repository, sender } = payload;
+    return {
+        type: 'fork',
+        displayType: (0, types_1.getDisplayType)('fork'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'forked',
+        title: forkee?.full_name,
+        url: forkee?.html_url || repository.html_url,
+    };
+}
+/**
+ * 解析 Create 事件
+ */
+function parseCreateEvent(payload) {
+    const { ref, ref_type, repository, sender } = payload;
+    return {
+        type: 'create',
+        displayType: (0, types_1.getDisplayType)('create'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'created',
+        ref: ref ? `${ref_type}:${ref}` : ref_type,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Delete 事件
+ */
+function parseDeleteEvent(payload) {
+    const { ref, ref_type, repository, sender } = payload;
+    return {
+        type: 'delete',
+        displayType: (0, types_1.getDisplayType)('delete'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'deleted',
+        ref: ref ? `${ref_type}:${ref}` : ref_type,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Workflow Run 事件
+ */
+function parseWorkflowRunEvent(payload) {
+    const { action, workflow_run, repository, sender } = payload;
+    // 只处理 requested/completed 动作
+    if (!['requested', 'completed'].includes(action)) {
+        return null;
+    }
+    const conclusion = workflow_run?.conclusion ? `/${workflow_run.conclusion}` : '';
+    return {
+        type: 'workflow_run',
+        displayType: (0, types_1.getDisplayType)('workflow_run'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: `${action}${conclusion}`,
+        title: workflow_run?.name,
+        url: workflow_run?.html_url || repository.html_url,
+    };
+}
+/**
+ * 统一的事件解析入口函数
+ * @param eventName X-GitHub-Event 头的值
+ * @param payload 解析后的 JSON 负载
+ * @returns 解析后的事件数据，不支持的事件返回 null
+ */
+function parseEvent(eventName, payload) {
+    switch (eventName) {
+        case 'issues':
+            return parseIssuesEvent(payload);
+        case 'issue_comment':
+            return parseIssueCommentEvent(payload);
+        case 'release':
+            return parseReleaseEvent(payload);
+        case 'push':
+            return parsePushEvent(payload);
+        case 'pull_request':
+            return parsePullRequestEvent(payload);
+        case 'pull_request_review':
+            return parsePullRequestReviewEvent(payload);
+        case 'pull_request_review_comment':
+            return parsePullRequestReviewCommentEvent(payload);
+        case 'star':
+            return parseStarEvent(payload);
+        case 'fork':
+            return parseForkEvent(payload);
+        case 'create':
+            return parseCreateEvent(payload);
+        case 'delete':
+            return parseDeleteEvent(payload);
+        case 'workflow_run':
+            return parseWorkflowRunEvent(payload);
+        default:
+            return null;
+    }
+}