@zhin.js/adapter-github 0.1.64 → 1.0.1

package/src/adapter.ts

@@ -3,9 +3,9 @@
  */
 import { formatCompact, Adapter, Message, Plugin } from 'zhin.js';
 import crypto from 'node:crypto';
-import { GitHubBot } from './bot.js';
+import { GitHubEndpoint } from './endpoint.js';
 import type { Router } from '@zhin.js/host-router';
-import type { GitHubBotConfig, EventType, GenericWebhookPayload, Subscription } from './types.js';
+import type { GitHubEndpointConfig, EventType, GenericWebhookPayload, Subscription } from './types.js';
 import type { GhClient } from './gh-client.js';
 import type { IssueCommentPayload, PRReviewCommentPayload, PRReviewPayload } from './types.js';
 
@@ -69,7 +69,9 @@ function formatNotification(event: string, p: GenericWebhookPayload): string {
   }
 }
 
-export class GitHubAdapter extends Adapter<GitHubBot> {
+export class GitHubAdapter extends Adapter<GitHubEndpoint> {
+  static override readonly capabilities = ['inbound', 'outbound'] as const;
+
   /** 轮询定时器 */
   private _pollTimer: ReturnType<typeof setInterval> | null = null;
   /** 每个 repo 的 ETag 缓存 */
@@ -83,8 +85,8 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     super(plugin, 'github', []);
   }
 
-  createBot(config: GitHubBotConfig): GitHubBot {
-    return new GitHubBot(this, config);
+  createEndpoint(config: GitHubEndpointConfig): GitHubEndpoint {
+    return new GitHubEndpoint(this, config);
   }
 
   async start(): Promise<void> {
@@ -96,15 +98,15 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     await super.stop();
   }
 
-  /** 获取第一个可用 bot 的 GhClient (工具用) */
+  /** 获取第一个可用 Endpoint 的 GhClient (工具用) */
   getAPI(): GhClient | null {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return bot?.gh || null;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return endpoint?.gh || null;
   }
 
   /** 获取指定用户绑定的 GhClient；未绑定则返回 null */
   async getUserAPI(platform: string, platformUid: string): Promise<GhClient | null> {
-    const db = this.plugin.root?.inject('database') as any;
+    const db = this.plugin.root?.inject('database');
     const model = db?.models?.get('github_oauth_users');
     if (!model) return null;
     const [record] = await model.select().where({ platform, platform_uid: platformUid });
@@ -114,7 +116,7 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     return base.withToken(record.access_token);
   }
 
-  /** 获取用户 API，若未绑定则降级为 bot 默认的 API */
+  /** 获取用户 API，若未绑定则降级为 Endpoint 默认的 API */
   async getUserOrDefaultAPI(platform?: string, platformUid?: string): Promise<GhClient | null> {
     if (platform && platformUid) {
       const userApi = await this.getUserAPI(platform, platformUid);
@@ -123,34 +125,34 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     return this.getAPI();
   }
 
-  /** 获取第一个 bot 的 client_id（App 认证时从 /app 自动获取） */
+  /** 获取第一个 Endpoint 的 client_id（App 认证时从 /app 自动获取） */
   getClientId(): string | null {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return bot?.gh.clientId || null;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return endpoint?.gh.clientId || null;
   }
 
-  /** 获取第一个 bot 的 host 配置 */
+  /** 获取第一个 Endpoint 的 host 配置 */
   getHost(): string | undefined {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return bot?.$config.host;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return endpoint?.$config.host;
   }
 
   /** 获取 App slug（用于生成安装链接） */
   getAppSlug(): string | null {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return bot?.gh.appSlug || null;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return endpoint?.gh.appSlug || null;
   }
 
   /** 获取所有已发现的安装信息 */
   getInstallations() {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return bot?.gh.installations || [];
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return endpoint?.gh.installations || [];
   }
 
-  /** 第一个 bot 是否配置了 Webhook */
+  /** 第一个 Endpoint 是否配置了 Webhook */
   get hasWebhookConfig(): boolean {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    return !!bot?.$config.webhook_secret;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    return !!endpoint?.$config.webhook_secret;
   }
 
   /** Webhook 是否已激活 */
@@ -162,13 +164,13 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
 
   /** 在 router 上挂载 Webhook 路由（生产环境推荐） */
   setupWebhook(router: Router): void {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    if (!bot?.$config.webhook_secret) {
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    if (!endpoint?.$config.webhook_secret) {
       this.plugin.logger.warn(formatCompact( { op: 'webhook', ok: false, error: 'missing webhook_secret' }));
       return;
     }
-    const secret = bot.$config.webhook_secret;
-    const path = bot.$config.webhook_path || '/github/webhook';
+    const secret = endpoint.$config.webhook_secret;
+    const path = endpoint.$config.webhook_path || '/github/webhook';
 
     router.post(path, async (ctx) => {
       const signature = ctx.get('x-hub-signature-256') as string;
@@ -207,14 +209,14 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
 
   /** 处理 Webhook 推送的事件 */
   async handleWebhookPayload(event: string, payload: any): Promise<void> {
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
     const repo = payload.repository?.full_name;
 
     this.plugin.logger.debug(`Webhook: ${event}${payload.action ? `.${payload.action}` : ''} ${repo || ''}`);
 
     // 记录事件到数据库
     if (repo) {
-      const db = this.plugin.root?.inject('database') as any;
+      const db = this.plugin.root?.inject('database');
       const eventsModel = db?.models?.get('github_events');
       if (eventsModel) {
         await eventsModel.insert({ id: Date.now(), repo, event_type: event, payload }).catch(() => {});
@@ -222,26 +224,26 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     }
 
     // 处理消息类事件（Issue/PR 评论）
-    if (bot && event === 'issue_comment' && payload.action === 'created' && payload.comment) {
-      const message = bot.$formatMessage(payload as IssueCommentPayload);
-      const botUser = bot.gh.authenticatedUser;
+    if (endpoint && event === 'issue_comment' && payload.action === 'created' && payload.comment) {
+      const message = endpoint.$formatMessage(payload as IssueCommentPayload);
+      const botUser = endpoint.gh.authenticatedUser;
       if (!(botUser && message.$sender.id === botUser)) {
         this.emit('message.receive', message);
       }
     }
 
-    if (bot && event === 'pull_request_review_comment' && payload.action === 'created' && payload.comment) {
-      const message = bot.formatPRReviewComment(payload as PRReviewCommentPayload);
-      const botUser = bot.gh.authenticatedUser;
+    if (endpoint && event === 'pull_request_review_comment' && payload.action === 'created' && payload.comment) {
+      const message = endpoint.formatPRReviewComment(payload as PRReviewCommentPayload);
+      const botUser = endpoint.gh.authenticatedUser;
       if (!(botUser && message.$sender.id === botUser)) {
         this.emit('message.receive', message);
       }
     }
 
-    if (bot && event === 'pull_request_review' && payload.action === 'submitted') {
-      const message = bot.formatPRReview(payload as PRReviewPayload);
+    if (endpoint && event === 'pull_request_review' && payload.action === 'submitted') {
+      const message = endpoint.formatPRReview(payload as PRReviewPayload);
       if (message) {
-        const botUser = bot.gh.authenticatedUser;
+        const botUser = endpoint.gh.authenticatedUser;
         if (!(botUser && message.$sender.id === botUser)) {
           this.emit('message.receive', message);
         }
@@ -269,8 +271,8 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
   /** 启动事件轮询 */
   startPolling(): void {
     if (this._pollTimer) return;
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
-    const interval = (bot?.$config.poll_interval || 60) * 1000;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
+    const interval = (endpoint?.$config.poll_interval || 60) * 1000;
     this.plugin.logger.debug(formatCompact( { op: 'poll', interval_s: interval / 1000 }));
 
     // 立即执行一次
@@ -292,7 +294,7 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
 
   /** 轮询所有已订阅仓库的事件 */
   private async pollAllRepos(): Promise<void> {
-    const db = this.plugin.root?.inject('database') as any;
+    const db = this.plugin.root?.inject('database');
     const model = db?.models?.get('github_subscriptions');
     if (!model) return;
 
@@ -339,7 +341,7 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
 
     this.plugin.logger.debug(`${repo}: ${newEvents.length} 条新事件`);
 
-    const bot = this.bots.values().next().value as GitHubBot | undefined;
+    const endpoint = this.endpoints.values().next().value as GitHubEndpoint | undefined;
 
     // 按时间正序处理（API 返回倒序）
     for (const ev of newEvents.reverse()) {
@@ -359,16 +361,16 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
       };
 
       // 记录事件到数据库
-      const db = this.plugin.root?.inject('database') as any;
+      const db = this.plugin.root?.inject('database');
       const eventsModel = db?.models?.get('github_events');
       if (eventsModel) {
         await eventsModel.insert({ id: Date.now(), repo, event_type: eventName, payload: ev.payload }).catch(() => {});
       }
 
       // 处理消息类事件（Issue/PR 评论）
-      if (bot && eventName === 'issue_comment' && ev.payload?.action === 'created' && ev.payload?.comment) {
-        const message = bot.$formatMessage(ev.payload as IssueCommentPayload);
-        const botUser = bot.gh.authenticatedUser;
+      if (endpoint && eventName === 'issue_comment' && ev.payload?.action === 'created' && ev.payload?.comment) {
+        const message = endpoint.$formatMessage(ev.payload as IssueCommentPayload);
+        const botUser = endpoint.gh.authenticatedUser;
         if (!(botUser && message.$sender.id === botUser)) {
           this.emit('message.receive', message);
         }
@@ -411,7 +413,7 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
     }
 
     const repo = payload.repository.full_name;
-    const db = this.plugin.root?.inject('database') as any;
+    const db = this.plugin.root?.inject('database');
     const model = db?.models?.get('github_subscriptions');
     if (!model) {
       this.plugin.logger.warn(formatCompact( { op: 'notify', ok: false, error: 'subscriptions model not ready' }));
@@ -431,13 +433,13 @@ export class GitHubAdapter extends Adapter<GitHubBot> {
         continue;
       }
       try {
-        const adapter = this.plugin.root?.inject(s.adapter as any) as any;
-        if (!adapter?.sendMessage) {
+        const targetAdapter = this.plugin.root?.inject(s.adapter as keyof Plugin.Contexts);
+        if (!(targetAdapter instanceof Adapter)) {
           this.plugin.logger.warn(formatCompact( { op: 'notify', ok: false, adapter: s.adapter, error: 'no sendMessage' }));
           continue;
         }
-        this.plugin.logger.debug(formatCompact( { op: 'notify', event: eventType, adapter: s.adapter, bot: s.bot, target: s.target_id }));
-        await adapter.sendMessage({ context: s.adapter, bot: s.bot, id: s.target_id, type: s.target_type, content: text });
+        this.plugin.logger.debug(formatCompact( { op: 'notify', event: eventType, adapter: s.adapter, endpoint: s.endpoint, target: s.target_id }));
+        await targetAdapter.sendMessage({ context: s.adapter, endpoint: s.endpoint, id: s.target_id, type: s.target_type, content: text });
       } catch (e) {
         this.plugin.logger.error(`通知推送失败 → ${s.adapter}:${s.target_id}`, e);
       }

package/src/{bot.ts → endpoint.ts}

@@ -1,9 +1,9 @@
 /**
- * GitHub Bot 实现（基于 gh CLI）
+ * GitHub Endpoint 实现（基于 gh CLI）
  */
-import { formatCompact, Bot, Message, segment, SendContent, SendOptions, type MessageSegment } from 'zhin.js';
+import { formatCompact, Endpoint, Message, segment, SendContent, SendOptions, type MessageSegment } from 'zhin.js';
 import type {
-  GitHubBotConfig,
+  GitHubEndpointConfig,
   IssueCommentPayload,
   PRReviewCommentPayload,
   PRReviewPayload,
@@ -40,7 +40,7 @@ export function toMarkdown(content: SendContent): string {
   }).join('');
 }
 
-export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
+export class GitHubEndpoint implements Endpoint<GitHubEndpointConfig, IssueCommentPayload> {
   $connected = false;
   gh: GhClient;
 
@@ -50,7 +50,7 @@ export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
     return this.adapter.plugin.logger;
   }
 
-  constructor(public adapter: GitHubAdapter, public $config: GitHubBotConfig) {
+  constructor(public adapter: GitHubAdapter, public $config: GitHubEndpointConfig) {
     const { host, app_id, private_key } = $config;
     const appAuth = app_id && private_key
       ? { appId: app_id, privateKey: private_key }
@@ -62,12 +62,12 @@ export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
     const result = await this.gh.verifyAuth();
     if (!result.ok) throw new Error(`GitHub 认证失败: ${result.message}`);
     this.$connected = true;
-    this.logger.info(formatCompact({ bot: this.$id }));
+    this.logger.info(formatCompact({ endpoint: this.$id }));
   }
 
   async $disconnect(): Promise<void> {
     this.$connected = false;
-    this.logger.debug(formatCompact({ bot: this.$id, disconnect: true }));
+    this.logger.debug(formatCompact({ endpoint: this.$id, disconnect: true }));
   }
 
   $formatMessage(payload: IssueCommentPayload): Message<IssueCommentPayload> {
@@ -80,7 +80,7 @@ export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
     const result = Message.from(payload, {
       $id: payload.comment.id.toString(),
       $adapter: 'github',
-      $bot: this.$config.name,
+      $endpoint: this.$config.name,
       $sender: { id: payload.sender.login, name: payload.sender.login },
       $channel: { id: channelId, type: 'group' },
       $content: parseMarkdown(payload.comment.body),
@@ -110,7 +110,7 @@ export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
     return Message.from(payload, {
       $id: payload.comment.id.toString(),
       $adapter: 'github',
-      $bot: this.$config.name,
+      $endpoint: this.$config.name,
       $sender: { id: payload.sender.login, name: payload.sender.login },
       $channel: { id: channelId, type: 'group' },
       $content: parseMarkdown(body),
@@ -140,7 +140,7 @@ export class GitHubBot implements Bot<GitHubBotConfig, IssueCommentPayload> {
     return Message.from(payload, {
       $id: payload.review.id.toString(),
       $adapter: 'github',
-      $bot: this.$config.name,
+      $endpoint: this.$config.name,
       $sender: { id: payload.sender.login, name: payload.sender.login },
       $channel: { id: channelId, type: 'group' },
       $content: parseMarkdown(body),

package/src/gh-client.ts

@@ -162,12 +162,13 @@ export class GhClient {
       let data: any;
       try { data = raw ? JSON.parse(raw) : null; } catch { data = raw; }
       return { ok: true, status: 200, data };
-    } catch (err: any) {
+    } catch (err: unknown) {
       let data: any;
-      try { data = err.stdout ? JSON.parse(err.stdout) : { message: err.message }; } catch {
-        data = { message: err.stderr?.trim() || err.message };
+      const errObj = err instanceof Error ? err : new Error(String(err));
+      try { data = (err as any).stdout ? JSON.parse((err as any).stdout) : { message: errObj.message }; } catch {
+        data = { message: (err as any).stderr?.trim() || errObj.message };
       }
-      return { ok: false, status: err.exitCode || 0, data };
+      return { ok: false, status: (err as any).exitCode || 0, data };
     }
   }
 
@@ -205,8 +206,8 @@ export class GhClient {
         }
         const errBody = await appRes.text();
         return { ok: false, user: '', message: `App Token 验证失败 (${appRes.status}): ${errBody}` };
-      } catch (e: any) {
-        return { ok: false, user: '', message: e.message || 'App 认证失败' };
+      } catch (e: unknown) {
+        return { ok: false, user: '', message: (e instanceof Error ? e.message : String(e)) || 'App 认证失败' };
       }
     }
     // Token 模式（用户绑定）或 gh CLI 默认模式
@@ -225,8 +226,8 @@ export class GhClient {
       const login = raw.trim();
       this._user = login;
       return { ok: true, user: login, message: `gh CLI: ${login}` };
-    } catch (e: any) {
-      return { ok: false, user: '', message: e.message || 'gh 认证检查失败' };
+    } catch (e: unknown) {
+      return { ok: false, user: '', message: (e instanceof Error ? e.message : String(e)) || 'gh 认证检查失败' };
     }
   }
 
@@ -469,9 +470,10 @@ export class GhClient {
       let events: any[];
       try { events = JSON.parse(bodyPart); } catch { events = []; }
       return { events: Array.isArray(events) ? events : [], etag: newEtag };
-    } catch (err: any) {
+    } catch (err: unknown) {
       // 304 Not Modified — gh 会以非 0 退出码返回
-      if (err.stderr?.includes('304') || err.exitCode === 1) {
+      const ghErr = err instanceof Error ? (err as Error & { stderr?: string; exitCode?: number }) : null;
+      if (ghErr?.stderr?.includes('304') || (ghErr as { exitCode?: number } | null)?.exitCode === 1) {
         return { events: [], etag: etag || null };
       }
       throw err;
@@ -506,9 +508,11 @@ export class GhClient {
         body: JSON.stringify({ client_id: clientId }),
         signal: AbortSignal.timeout(15_000),
       });
-    } catch (e: any) {
+    } catch (e: unknown) {
+      const errMsg = e instanceof Error ? e.message : String(e);
+      const errCause = e instanceof Error ? (e as any).cause?.code : undefined;
       throw new Error(
-        `Device Flow 请求失败: 无法连接 ${baseUrl} (${e.cause?.code || e.message})。` +
+        `Device Flow 请求失败: 无法连接 ${baseUrl} (${errCause || errMsg})。` +
         `Device Flow 需要访问 github.com（非 api.github.com），请检查网络/代理设置。`,
       );
     }