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

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.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Koishi GitHub Webhook 推送插件入口
+ * 需求: 1.1, 7.1-7.7
+ */
+import { Context } from 'koishi';
+import { Config } from './config';
+/** 插件名称 */
+export declare const name = "github-webhook-pusher";
+/** 声明服务依赖 - 需要 server 服务提供 router 和 database 服务 */
+export declare const inject: string[];
+/** 导出配置 Schema */
+export { Config };
+/**
+ * 插件入口函数
+ * @param ctx Koishi 上下文
+ * @param config 插件配置
+ */
+export declare function apply(ctx: Context, config: Config): void;

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('调试模式已启用');
+    }
+}

package/lib/message.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 消息构建器
+ * 需求: 5.3, 5.4, 5.5
+ */
+import { Element } from 'koishi';
+import { ParsedEvent } from './types';
+/**
+ * 构建推送消息
+ * @param event 解析后的事件
+ * @returns Koishi Element 消息数组
+ */
+export declare function buildMessage(event: ParsedEvent): Element[];

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.d.ts

@@ -0,0 +1,65 @@
+/**
+ * GitHub Webhook 事件解析器
+ * 需求: 4.1-4.7
+ */
+import { ParsedEvent } from './types';
+/**
+ * 解析 Issues 事件
+ * 需求 4.1: 提取 issue 标题、编号、操作者和链接
+ */
+export declare function parseIssuesEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Issue Comment 事件
+ */
+export declare function parseIssueCommentEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Release 事件
+ * 需求 4.2: 提取版本号、发布者和下载链接
+ */
+export declare function parseReleaseEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Push 事件
+ * 需求 4.3, 4.6: 提取分支名、提交列表（最多5条）和推送者信息
+ */
+export declare function parsePushEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Pull Request 事件
+ * 需求 4.4: 提取 PR 标题、编号、操作者和链接
+ */
+export declare function parsePullRequestEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Pull Request Review 事件
+ */
+export declare function parsePullRequestReviewEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Pull Request Review Comment 事件
+ */
+export declare function parsePullRequestReviewCommentEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Star 事件
+ * 需求 4.5: 提取操作者和当前 star 数量
+ */
+export declare function parseStarEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Fork 事件
+ */
+export declare function parseForkEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Create 事件
+ */
+export declare function parseCreateEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Delete 事件
+ */
+export declare function parseDeleteEvent(payload: any): ParsedEvent | null;
+/**
+ * 解析 Workflow Run 事件
+ */
+export declare function parseWorkflowRunEvent(payload: any): ParsedEvent | null;
+/**
+ * 统一的事件解析入口函数
+ * @param eventName X-GitHub-Event 头的值
+ * @param payload 解析后的 JSON 负载
+ * @returns 解析后的事件数据，不支持的事件返回 null
+ */
+export declare function parseEvent(eventName: string, payload: any): ParsedEvent | null;