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

package/lib/repository/subscription.d.ts

@@ -0,0 +1,99 @@
+/**
+ * 订阅数据访问层
+ * 需求: 3.1-3.7, 5.1, 5.2
+ */
+import { Context } from 'koishi';
+import { Subscription } from '../database';
+import { EventType } from '../types';
+/** 推送目标信息 */
+export interface PushTarget {
+    platform: string;
+    channelId: string;
+    guildId?: string;
+    userId?: string;
+}
+/** 会话标识 */
+export interface SessionIdentifier {
+    platform: string;
+    channelId: string;
+    guildId?: string;
+    userId?: string;
+}
+/**
+ * 创建订阅
+ * 需求 3.1: 为当前会话创建订阅记录
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @param defaultEvents 默认事件列表
+ * @returns 创建的订阅记录
+ */
+export declare function createSubscription(ctx: Context, session: SessionIdentifier, repo: string, defaultEvents: EventType[]): Promise<Subscription>;
+/**
+ * 移除订阅
+ * 需求 3.3: 移除当前会话对该仓库的订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功移除
+ */
+export declare function removeSubscription(ctx: Context, session: SessionIdentifier, repo: string): Promise<boolean>;
+/**
+ * 列出会话的所有订阅
+ * 需求 3.4: 显示当前会话的所有订阅及其事件设置
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @returns 订阅列表
+ */
+export declare function listSubscriptions(ctx: Context, session: SessionIdentifier): Promise<Subscription[]>;
+/**
+ * 获取单个订阅
+ * 需求 3.5: 显示该仓库订阅的事件类型列表
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 订阅记录，不存在返回 null
+ */
+export declare function getSubscription(ctx: Context, session: SessionIdentifier, repo: string): Promise<Subscription | null>;
+/**
+ * 更新订阅的事件类型
+ * 需求 3.6: 根据 +/- 前缀启用或禁用对应事件类型
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @param events 新的事件列表
+ * @returns 是否成功更新
+ */
+export declare function updateEvents(ctx: Context, session: SessionIdentifier, repo: string, events: EventType[]): Promise<boolean>;
+/**
+ * 查询订阅目标
+ * 需求 5.1, 5.2: 查询所有订阅该仓库的目标会话，并根据事件类型过滤
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @param eventType 事件类型
+ * @returns 推送目标列表
+ */
+export declare function queryTargets(ctx: Context, repo: string, eventType: EventType): Promise<PushTarget[]>;
+/**
+ * 获取仓库的所有订阅
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 订阅列表
+ */
+export declare function getRepoSubscriptions(ctx: Context, repo: string): Promise<Subscription[]>;
+/**
+ * 启用订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功启用
+ */
+export declare function enableSubscription(ctx: Context, session: SessionIdentifier, repo: string): Promise<boolean>;
+/**
+ * 禁用订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功禁用
+ */
+export declare function disableSubscription(ctx: Context, session: SessionIdentifier, repo: string): Promise<boolean>;

package/lib/repository/subscription.js

@@ -0,0 +1,187 @@
+"use strict";
+/**
+ * 订阅数据访问层
+ * 需求: 3.1-3.7, 5.1, 5.2
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSubscription = createSubscription;
+exports.removeSubscription = removeSubscription;
+exports.listSubscriptions = listSubscriptions;
+exports.getSubscription = getSubscription;
+exports.updateEvents = updateEvents;
+exports.queryTargets = queryTargets;
+exports.getRepoSubscriptions = getRepoSubscriptions;
+exports.enableSubscription = enableSubscription;
+exports.disableSubscription = disableSubscription;
+/**
+ * 创建订阅
+ * 需求 3.1: 为当前会话创建订阅记录
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @param defaultEvents 默认事件列表
+ * @returns 创建的订阅记录
+ */
+async function createSubscription(ctx, session, repo, defaultEvents) {
+    const now = new Date();
+    // 检查是否已存在
+    const existing = await ctx.database.get('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    });
+    if (existing.length > 0) {
+        return existing[0];
+    }
+    await ctx.database.create('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        guildId: session.guildId || '',
+        userId: session.userId || '',
+        repo,
+        events: defaultEvents,
+        enabled: true,
+        createdAt: now,
+        updatedAt: now,
+    });
+    const [created] = await ctx.database.get('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    });
+    return created;
+}
+/**
+ * 移除订阅
+ * 需求 3.3: 移除当前会话对该仓库的订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功移除
+ */
+async function removeSubscription(ctx, session, repo) {
+    const result = await ctx.database.remove('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    });
+    return (result.removed ?? 0) > 0;
+}
+/**
+ * 列出会话的所有订阅
+ * 需求 3.4: 显示当前会话的所有订阅及其事件设置
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @returns 订阅列表
+ */
+async function listSubscriptions(ctx, session) {
+    return ctx.database.get('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+    });
+}
+/**
+ * 获取单个订阅
+ * 需求 3.5: 显示该仓库订阅的事件类型列表
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 订阅记录，不存在返回 null
+ */
+async function getSubscription(ctx, session, repo) {
+    const subs = await ctx.database.get('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    });
+    return subs.length > 0 ? subs[0] : null;
+}
+/**
+ * 更新订阅的事件类型
+ * 需求 3.6: 根据 +/- 前缀启用或禁用对应事件类型
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @param events 新的事件列表
+ * @returns 是否成功更新
+ */
+async function updateEvents(ctx, session, repo, events) {
+    const result = await ctx.database.set('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    }, {
+        events,
+        updatedAt: new Date(),
+    });
+    return (result.modified ?? 0) > 0;
+}
+/**
+ * 查询订阅目标
+ * 需求 5.1, 5.2: 查询所有订阅该仓库的目标会话，并根据事件类型过滤
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @param eventType 事件类型
+ * @returns 推送目标列表
+ */
+async function queryTargets(ctx, repo, eventType) {
+    // 获取所有订阅该仓库且已启用的订阅
+    const subscriptions = await ctx.database.get('github_subscriptions', {
+        repo,
+        enabled: true,
+    });
+    // 过滤出订阅了该事件类型的目标
+    return subscriptions
+        .filter(sub => sub.events.includes(eventType))
+        .map(sub => ({
+        platform: sub.platform,
+        channelId: sub.channelId,
+        guildId: sub.guildId || undefined,
+        userId: sub.userId || undefined,
+    }));
+}
+/**
+ * 获取仓库的所有订阅
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 订阅列表
+ */
+async function getRepoSubscriptions(ctx, repo) {
+    return ctx.database.get('github_subscriptions', { repo });
+}
+/**
+ * 启用订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功启用
+ */
+async function enableSubscription(ctx, session, repo) {
+    const result = await ctx.database.set('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    }, {
+        enabled: true,
+        updatedAt: new Date(),
+    });
+    return (result.modified ?? 0) > 0;
+}
+/**
+ * 禁用订阅
+ * @param ctx Koishi 上下文
+ * @param session 会话标识
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功禁用
+ */
+async function disableSubscription(ctx, session, repo) {
+    const result = await ctx.database.set('github_subscriptions', {
+        platform: session.platform,
+        channelId: session.channelId,
+        repo,
+    }, {
+        enabled: false,
+        updatedAt: new Date(),
+    });
+    return (result.modified ?? 0) > 0;
+}

package/lib/repository/trust.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 信任仓库数据访问层
+ * 需求: 2.1-2.7
+ */
+import { Context } from 'koishi';
+import { TrustedRepo } from '../database';
+/**
+ * 验证仓库名格式是否符合 owner/repo 格式
+ * @param repo 仓库名
+ * @returns 是否有效
+ */
+export declare function isValidRepoFormat(repo: string): boolean;
+/**
+ * 添加信任仓库
+ * 需求 2.1: 将仓库添加到信任列表并持久化到数据库
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 添加的仓库记录，如果格式错误返回 null
+ */
+export declare function addTrustedRepo(ctx: Context, repo: string): Promise<TrustedRepo | null>;
+/**
+ * 移除信任仓库
+ * 需求 2.2: 从信任列表中移除该仓库
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功移除
+ */
+export declare function removeTrustedRepo(ctx: Context, repo: string): Promise<boolean>;
+/**
+ * 列出所有信任仓库
+ * 需求 2.3: 显示所有信任仓库及其启用状态
+ * @param ctx Koishi 上下文
+ * @returns 信任仓库列表
+ */
+export declare function listTrustedRepos(ctx: Context): Promise<TrustedRepo[]>;
+/**
+ * 检查仓库是否在信任列表中且已启用
+ * 需求 2.6: 验证仓库是否可以处理事件
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否信任且启用
+ */
+export declare function isTrusted(ctx: Context, repo: string): Promise<boolean>;
+/**
+ * 检查仓库是否在信任列表中（不考虑启用状态）
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否在信任列表中
+ */
+export declare function isInTrustList(ctx: Context, repo: string): Promise<boolean>;
+/**
+ * 启用信任仓库
+ * 需求 2.4: 启用该仓库的事件处理
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功启用
+ */
+export declare function enableRepo(ctx: Context, repo: string): Promise<boolean>;
+/**
+ * 禁用信任仓库
+ * 需求 2.5: 禁用该仓库的事件处理
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功禁用
+ */
+export declare function disableRepo(ctx: Context, repo: string): Promise<boolean>;
+/**
+ * 获取单个信任仓库信息
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 仓库信息，不存在返回 null
+ */
+export declare function getTrustedRepo(ctx: Context, repo: string): Promise<TrustedRepo | null>;

package/lib/repository/trust.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * 信任仓库数据访问层
+ * 需求: 2.1-2.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidRepoFormat = isValidRepoFormat;
+exports.addTrustedRepo = addTrustedRepo;
+exports.removeTrustedRepo = removeTrustedRepo;
+exports.listTrustedRepos = listTrustedRepos;
+exports.isTrusted = isTrusted;
+exports.isInTrustList = isInTrustList;
+exports.enableRepo = enableRepo;
+exports.disableRepo = disableRepo;
+exports.getTrustedRepo = getTrustedRepo;
+/** 仓库名格式验证正则表达式 */
+const REPO_NAME_REGEX = /^[a-zA-Z0-9_.-]+\/[a-zA-Z0-9_.-]+$/;
+/**
+ * 验证仓库名格式是否符合 owner/repo 格式
+ * @param repo 仓库名
+ * @returns 是否有效
+ */
+function isValidRepoFormat(repo) {
+    if (!repo || typeof repo !== 'string') {
+        return false;
+    }
+    return REPO_NAME_REGEX.test(repo);
+}
+/**
+ * 添加信任仓库
+ * 需求 2.1: 将仓库添加到信任列表并持久化到数据库
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 添加的仓库记录，如果格式错误返回 null
+ */
+async function addTrustedRepo(ctx, repo) {
+    if (!isValidRepoFormat(repo)) {
+        return null;
+    }
+    const now = new Date();
+    // 检查是否已存在
+    const existing = await ctx.database.get('github_trusted_repos', { repo });
+    if (existing.length > 0) {
+        return existing[0];
+    }
+    await ctx.database.create('github_trusted_repos', {
+        repo,
+        enabled: true,
+        createdAt: now,
+        updatedAt: now,
+    });
+    const [created] = await ctx.database.get('github_trusted_repos', { repo });
+    return created;
+}
+/**
+ * 移除信任仓库
+ * 需求 2.2: 从信任列表中移除该仓库
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功移除
+ */
+async function removeTrustedRepo(ctx, repo) {
+    const result = await ctx.database.remove('github_trusted_repos', { repo });
+    return (result.removed ?? 0) > 0;
+}
+/**
+ * 列出所有信任仓库
+ * 需求 2.3: 显示所有信任仓库及其启用状态
+ * @param ctx Koishi 上下文
+ * @returns 信任仓库列表
+ */
+async function listTrustedRepos(ctx) {
+    return ctx.database.get('github_trusted_repos', {});
+}
+/**
+ * 检查仓库是否在信任列表中且已启用
+ * 需求 2.6: 验证仓库是否可以处理事件
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否信任且启用
+ */
+async function isTrusted(ctx, repo) {
+    const repos = await ctx.database.get('github_trusted_repos', { repo, enabled: true });
+    return repos.length > 0;
+}
+/**
+ * 检查仓库是否在信任列表中（不考虑启用状态）
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否在信任列表中
+ */
+async function isInTrustList(ctx, repo) {
+    const repos = await ctx.database.get('github_trusted_repos', { repo });
+    return repos.length > 0;
+}
+/**
+ * 启用信任仓库
+ * 需求 2.4: 启用该仓库的事件处理
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功启用
+ */
+async function enableRepo(ctx, repo) {
+    const result = await ctx.database.set('github_trusted_repos', { repo }, {
+        enabled: true,
+        updatedAt: new Date(),
+    });
+    return (result.modified ?? 0) > 0;
+}
+/**
+ * 禁用信任仓库
+ * 需求 2.5: 禁用该仓库的事件处理
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 是否成功禁用
+ */
+async function disableRepo(ctx, repo) {
+    const result = await ctx.database.set('github_trusted_repos', { repo }, {
+        enabled: false,
+        updatedAt: new Date(),
+    });
+    return (result.modified ?? 0) > 0;
+}
+/**
+ * 获取单个信任仓库信息
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @returns 仓库信息，不存在返回 null
+ */
+async function getTrustedRepo(ctx, repo) {
+    const repos = await ctx.database.get('github_trusted_repos', { repo });
+    return repos.length > 0 ? repos[0] : null;
+}

package/lib/signature.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 创建 GitHub Webhook 签名
+ * @param payload 原始请求体
+ * @param secret Webhook Secret
+ * @returns 签名字符串，格式为 sha256=<hex_digest>
+ */
+export declare function createSignature(payload: string, secret: string): string;
+/**
+ * 验证 GitHub Webhook 签名
+ * @param payload 原始请求体
+ * @param signature X-Hub-Signature-256 头的值
+ * @param secret 配置的 Webhook Secret
+ * @returns 签名是否有效
+ */
+export declare function verifySignature(payload: string, signature: string, secret: string): boolean;

package/lib/signature.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSignature = createSignature;
+exports.verifySignature = verifySignature;
+const crypto_1 = require("crypto");
+/**
+ * 创建 GitHub Webhook 签名
+ * @param payload 原始请求体
+ * @param secret Webhook Secret
+ * @returns 签名字符串，格式为 sha256=<hex_digest>
+ */
+function createSignature(payload, secret) {
+    const hmac = (0, crypto_1.createHmac)('sha256', secret);
+    hmac.update(payload, 'utf8');
+    return `sha256=${hmac.digest('hex')}`;
+}
+/**
+ * 验证 GitHub Webhook 签名
+ * @param payload 原始请求体
+ * @param signature X-Hub-Signature-256 头的值
+ * @param secret 配置的 Webhook Secret
+ * @returns 签名是否有效
+ */
+function verifySignature(payload, signature, secret) {
+    // 检查签名格式
+    if (!signature || !signature.startsWith('sha256=')) {
+        return false;
+    }
+    const expected = createSignature(payload, secret);
+    // 使用常量时间比较防止时序攻击
+    const sigBuffer = Buffer.from(signature);
+    const expectedBuffer = Buffer.from(expected);
+    // 长度不同时也需要进行比较以保持常量时间
+    if (sigBuffer.length !== expectedBuffer.length) {
+        return false;
+    }
+    return (0, crypto_1.timingSafeEqual)(sigBuffer, expectedBuffer);
+}

package/lib/types.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 事件类型和接口定义
+ * 需求: 4.1-4.7
+ */
+/** 支持的事件类型 */
+export type EventType = 'issues' | 'issue_comment' | 'pull_request' | 'pull_request_review' | 'pull_request_review_comment' | 'release' | 'push' | 'star' | 'fork' | 'create' | 'delete' | 'workflow_run';
+/** 提交信息 */
+export interface CommitInfo {
+    sha: string;
+    message: string;
+    author: string;
+    url: string;
+}
+/** 解析后的事件数据 */
+export interface ParsedEvent {
+    type: EventType;
+    displayType: string;
+    repo: string;
+    actor: string;
+    action?: string;
+    title?: string;
+    number?: number;
+    url: string;
+    body?: string;
+    commits?: CommitInfo[];
+    totalCommits?: number;
+    ref?: string;
+    tagName?: string;
+    starCount?: number;
+}
+/** 事件类型显示信息 */
+export interface EventDisplayInfo {
+    name: string;
+    emoji: string;
+}
+/** 事件类型到显示名称和 emoji 的映射 */
+export declare const EVENT_DISPLAY_MAP: Record<EventType, EventDisplayInfo>;
+/**
+ * 获取事件类型的显示名称
+ * @param type 事件类型
+ * @returns 显示名称
+ */
+export declare function getDisplayType(type: EventType): string;
+/**
+ * 获取事件类型的 emoji
+ * @param type 事件类型
+ * @returns emoji 字符
+ */
+export declare function getEventEmoji(type: EventType): string;

package/lib/types.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * 事件类型和接口定义
+ * 需求: 4.1-4.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_DISPLAY_MAP = void 0;
+exports.getDisplayType = getDisplayType;
+exports.getEventEmoji = getEventEmoji;
+/** 事件类型到显示名称和 emoji 的映射 */
+exports.EVENT_DISPLAY_MAP = {
+    issues: { name: 'Issue', emoji: '📌' },
+    issue_comment: { name: 'Issue Comment', emoji: '💬' },
+    release: { name: 'Release', emoji: '🚀' },
+    push: { name: 'Commit', emoji: '⬆️' },
+    pull_request: { name: 'PR', emoji: '🔀' },
+    pull_request_review: { name: 'PR Review', emoji: '🧪' },
+    pull_request_review_comment: { name: 'PR Review Comment', emoji: '💬' },
+    star: { name: 'Star', emoji: '⭐' },
+    fork: { name: 'Fork', emoji: '🍴' },
+    create: { name: 'Create', emoji: '✨' },
+    delete: { name: 'Delete', emoji: '🗑️' },
+    workflow_run: { name: 'Workflow', emoji: '🧩' },
+};
+/**
+ * 获取事件类型的显示名称
+ * @param type 事件类型
+ * @returns 显示名称
+ */
+function getDisplayType(type) {
+    return exports.EVENT_DISPLAY_MAP[type].name;
+}
+/**
+ * 获取事件类型的 emoji
+ * @param type 事件类型
+ * @returns emoji 字符
+ */
+function getEventEmoji(type) {
+    return exports.EVENT_DISPLAY_MAP[type].emoji;
+}

package/lib/webhook.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Webhook 处理器
+ * 需求: 1.1-1.6, 2.6, 9.1-9.6
+ */
+import { Context } from 'koishi';
+import type { Context as KoaContext } from 'koa';
+import { Config } from './config';
+declare module 'koishi' {
+    interface Context {
+        server: {
+            post(path: string, handler: (ctx: KoaContext) => Promise<void>): void;
+        };
+    }
+}
+/**
+ * 注册 Webhook 处理器
+ * 需求 1.1: 在配置的路径上监听 HTTP POST 请求
+ * @param ctx Koishi 上下文
+ * @param config 插件配置
+ */
+export declare function registerWebhook(ctx: Context, config: Config): void;