@zhin.js/adapter-github 1.0.1 → 1.1.2

package/agents/github/skills/github-repository/tools/push_branch/index.ts

@@ -0,0 +1,18 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubPushBranch } from '../../handlers.js';
+
+export default defineAgentTool<{ repo?: string; branch?: string; message: string }>({
+  description: '在托管工作区 git commit 并 push 到远程分支（需 HITL 确认；Bot 身份）',
+  adapter: 'github',
+  inputSchema: z.object({
+    repo: z.string().optional().describe('owner/repo'),
+    branch: z.string().optional().describe('分支名，缺省从上下文推断'),
+    message: z.string().describe('commit message'),
+  }),
+  tags: ['github'],
+  requiresApproval: 'always',
+  async execute(input, context) {
+    return executeGithubPushBranch(input, context.$client);
+  },
+});

package/agents/github/skills/github-subscriptions/SKILL.md

@@ -0,0 +1,20 @@
+---
+name: github-subscriptions
+platforms:
+  - github
+description: GitHub Star 与仓库订阅管理能力。
+keywords:
+  - "github"
+  - "star"
+  - "订阅"
+  - "通知"
+tools:
+  - "star"
+  - "subscribe"
+  - "subscriptions"
+  - "unsubscribe"
+---
+
+# github-subscriptions
+
+先用 `subscriptions` 查询当前聊天通道的已有订阅，再执行订阅或取消。Webhook 订阅绑定当前聊天通道，只会向该通道投递事件。`star` 优先使用用户绑定的 OAuth 身份，未绑定时才使用 Endpoint 默认身份；外部写操作遵守审批策略。

package/agents/github/skills/github-subscriptions/handlers.js

@@ -0,0 +1,101 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { getCurrentCommMessage } from '@zhin.js/agent/security';
+function subscriptionsModel(client) {
+    const db = client.database;
+    return db?.models?.get('github_subscriptions');
+}
+export async function executeGithubStar(args, client, commMessage) {
+    const msg = commMessage ?? getCurrentCommMessage();
+    const gh = await client.getUserOrDefaultApi(msg?.$adapter, msg?.$sender.id);
+    switch (args.action) {
+        case 'star': {
+            const r = await gh.starRepo(args.repo);
+            return r.ok ? `⭐ 已 Star ${args.repo}` : `❌ ${r.data?.message || JSON.stringify(r.data)}`;
+        }
+        case 'unstar': {
+            const r = await gh.unstarRepo(args.repo);
+            return r.ok ? `💔 已取消 Star ${args.repo}` : `❌ ${r.data?.message || JSON.stringify(r.data)}`;
+        }
+        case 'check': {
+            const starred = await gh.isStarred(args.repo);
+            return starred ? `⭐ 已 Star ${args.repo}` : `☆ 尚未 Star ${args.repo}`;
+        }
+        default:
+            return `❌ 未知操作: ${args.action}`;
+    }
+}
+export async function executeGithubSubscribe(args, client, commMessage) {
+    const msg = commMessage ?? getCurrentCommMessage();
+    if (!msg?.$adapter || !msg?.$sender.id || !msg?.$channel?.id || !msg?.$endpoint) {
+        return '❌ 无法获取当前聊天通道信息';
+    }
+    const model = subscriptionsModel(client);
+    if (!model)
+        return '❌ 数据库未就绪';
+    const validEvents = ['push', 'issue', 'star', 'fork', 'unstar', 'pull_request'];
+    const events = args.events
+        ? args.events.split(',').map((s) => s.trim()).filter((e) => validEvents.includes(e))
+        : validEvents;
+    if (!events.length)
+        return `❌ 无效的事件类型，可选: ${validEvents.join(', ')}`;
+    const [existing] = await model.select().where({
+        repo: args.repo,
+        target_id: msg.$channel?.id,
+        adapter: msg.$adapter,
+        endpoint: msg.$endpoint,
+    });
+    if (existing) {
+        await model.update({ events, target_type: msg.$channel?.type || 'private' }).where({ id: existing.id });
+        return `✅ 已更新订阅 ${args.repo}\n📡 事件: ${events.join(', ')}`;
+    }
+    await model.insert({
+        id: Date.now(),
+        repo: args.repo,
+        events,
+        target_id: msg.$channel?.id,
+        target_type: msg.$channel?.type || 'private',
+        adapter: msg.$adapter,
+        endpoint: msg.$endpoint,
+    });
+    return `✅ 已订阅 ${args.repo}\n📡 事件: ${events.join(', ')}\n📌 通知将推送到当前通道`;
+}
+export async function executeGithubUnsubscribe(args, client, commMessage) {
+    const msg = commMessage ?? getCurrentCommMessage();
+    if (!msg?.$adapter || !msg?.$channel?.id || !msg?.$endpoint) {
+        return '❌ 无法获取当前聊天通道信息';
+    }
+    const model = subscriptionsModel(client);
+    if (!model)
+        return '❌ 数据库未就绪';
+    const [existing] = await model.select().where({
+        repo: args.repo,
+        target_id: msg.$channel?.id,
+        adapter: msg.$adapter,
+        endpoint: msg.$endpoint,
+    });
+    if (!existing)
+        return `📭 当前通道未订阅 ${args.repo}`;
+    await model.delete().where({ id: existing.id });
+    return `✅ 已取消订阅 ${args.repo}`;
+}
+export async function executeGithubSubscriptions(_args, client, commMessage) {
+    const msg = commMessage ?? getCurrentCommMessage();
+    if (!msg?.$adapter || !msg?.$channel?.id || !msg?.$endpoint) {
+        return '❌ 无法获取当前聊天通道信息';
+    }
+    const model = subscriptionsModel(client);
+    if (!model)
+        return '❌ 数据库未就绪';
+    const subs = await model.select().where({
+        target_id: msg.$channel?.id,
+        adapter: msg.$adapter,
+        endpoint: msg.$endpoint,
+    });
+    if (!subs?.length)
+        return '📭 当前通道没有任何 GitHub 订阅';
+    return `📋 当前通道订阅 (${subs.length}):\n\n` +
+        subs.map((s) => {
+            const events = Array.isArray(s.events) ? s.events : [];
+            return `  📦 ${s.repo}\n     📡 ${events.join(', ') || '(无事件)'}`;
+        }).join('\n\n');
+}

package/agents/github/skills/github-subscriptions/handlers.ts

@@ -0,0 +1,119 @@
+import type { Message } from 'zhin.js';
+import { getCurrentCommMessage } from '@zhin.js/agent/security';
+import type { GithubClient } from '../../../../src/client.js';
+import type { EventType } from '../../../../src/types.js';
+
+function subscriptionsModel(client: GithubClient) {
+  const db = client.database as {
+    models?: Map<string, unknown>;
+  } | null | undefined;
+  return db?.models?.get('github_subscriptions') as {
+    select: () => { where: (q: object) => Promise<any[]> };
+    insert: (row: object) => Promise<void>;
+    update: (row: object) => { where: (q: object) => Promise<void> };
+    delete: () => { where: (q: object) => Promise<void> };
+  } | undefined;
+}
+
+export async function executeGithubStar(args: { action: 'star' | 'unstar' | 'check'; repo: string }, client: GithubClient, commMessage?: Message) {
+  const msg = commMessage ?? getCurrentCommMessage();
+  const gh = await client.getUserOrDefaultApi(msg?.$adapter, msg?.$sender.id);
+  switch (args.action) {
+    case 'star': {
+      const r = await gh.starRepo(args.repo);
+      return r.ok ? `⭐ 已 Star ${args.repo}` : `❌ ${r.data?.message || JSON.stringify(r.data)}`;
+    }
+    case 'unstar': {
+      const r = await gh.unstarRepo(args.repo);
+      return r.ok ? `💔 已取消 Star ${args.repo}` : `❌ ${r.data?.message || JSON.stringify(r.data)}`;
+    }
+    case 'check': {
+      const starred = await gh.isStarred(args.repo);
+      return starred ? `⭐ 已 Star ${args.repo}` : `☆ 尚未 Star ${args.repo}`;
+    }
+    default:
+      return `❌ 未知操作: ${args.action}`;
+  }
+}
+
+export async function executeGithubSubscribe(args: { repo: string; events?: string }, client: GithubClient, commMessage?: Message) {
+  const msg = commMessage ?? getCurrentCommMessage();
+  if (!msg?.$adapter || !msg?.$sender.id || !msg?.$channel?.id || !msg?.$endpoint) {
+    return '❌ 无法获取当前聊天通道信息';
+  }
+
+  const model = subscriptionsModel(client);
+  if (!model) return '❌ 数据库未就绪';
+
+  const validEvents: EventType[] = ['push', 'issue', 'star', 'fork', 'unstar', 'pull_request'];
+  const events: EventType[] = args.events
+    ? args.events.split(',').map((s) => s.trim()).filter((e): e is EventType => validEvents.includes(e as EventType))
+    : validEvents;
+  if (!events.length) return `❌ 无效的事件类型，可选: ${validEvents.join(', ')}`;
+
+  const [existing] = await model.select().where({
+    repo: args.repo,
+    target_id: msg.$channel?.id,
+    adapter: msg.$adapter,
+    endpoint: msg.$endpoint,
+  });
+  if (existing) {
+    await model.update({ events, target_type: msg.$channel?.type || 'private' }).where({ id: existing.id });
+    return `✅ 已更新订阅 ${args.repo}\n📡 事件: ${events.join(', ')}`;
+  }
+
+  await model.insert({
+    id: Date.now(),
+    repo: args.repo,
+    events,
+    target_id: msg.$channel?.id,
+    target_type: msg.$channel?.type || 'private',
+    adapter: msg.$adapter,
+    endpoint: msg.$endpoint,
+  });
+  return `✅ 已订阅 ${args.repo}\n📡 事件: ${events.join(', ')}\n📌 通知将推送到当前通道`;
+}
+
+export async function executeGithubUnsubscribe(args: { repo: string }, client: GithubClient, commMessage?: Message) {
+  const msg = commMessage ?? getCurrentCommMessage();
+  if (!msg?.$adapter || !msg?.$channel?.id || !msg?.$endpoint) {
+    return '❌ 无法获取当前聊天通道信息';
+  }
+
+  const model = subscriptionsModel(client);
+  if (!model) return '❌ 数据库未就绪';
+
+  const [existing] = await model.select().where({
+    repo: args.repo,
+    target_id: msg.$channel?.id,
+    adapter: msg.$adapter,
+    endpoint: msg.$endpoint,
+  });
+  if (!existing) return `📭 当前通道未订阅 ${args.repo}`;
+
+  await model.delete().where({ id: existing.id });
+  return `✅ 已取消订阅 ${args.repo}`;
+}
+
+export async function executeGithubSubscriptions(_args: Record<string, never>, client: GithubClient, commMessage?: Message) {
+  const msg = commMessage ?? getCurrentCommMessage();
+  if (!msg?.$adapter || !msg?.$channel?.id || !msg?.$endpoint) {
+    return '❌ 无法获取当前聊天通道信息';
+  }
+
+  const model = subscriptionsModel(client);
+  if (!model) return '❌ 数据库未就绪';
+
+  const subs = await model.select().where({
+    target_id: msg.$channel?.id,
+    adapter: msg.$adapter,
+    endpoint: msg.$endpoint,
+  });
+  if (!subs?.length) return '📭 当前通道没有任何 GitHub 订阅';
+
+  return `📋 当前通道订阅 (${subs.length}):\n\n` +
+    subs.map((s: any) => {
+      const events = Array.isArray(s.events) ? s.events : [];
+      return `  📦 ${s.repo}\n     📡 ${events.join(', ') || '(无事件)'}`;
+    }).join('\n\n');
+}

package/agents/github/skills/github-subscriptions/tools/star/index.js

@@ -0,0 +1,16 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubStar } from '../../handlers.js';
+export default defineAgentTool({
+    description: 'Star 或取消 Star 一个 GitHub 仓库（使用你绑定的 GitHub 账号，未绑定则用 Endpoint 默认账号）',
+    adapter: 'github',
+    inputSchema: z.object({
+        action: z.enum(['star', 'unstar', 'check']),
+        repo: z.string().min(1),
+    }),
+    tags: ['github'],
+    async execute(input, context) {
+        return executeGithubStar(input, context.$client);
+    },
+});

package/agents/github/skills/github-subscriptions/tools/star/index.ts

@@ -0,0 +1,16 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubStar } from '../../handlers.js';
+
+export default defineAgentTool<{ action: 'star' | 'unstar' | 'check'; repo: string }>({
+  description: 'Star 或取消 Star 一个 GitHub 仓库（使用你绑定的 GitHub 账号，未绑定则用 Endpoint 默认账号）',
+  adapter: 'github',
+  inputSchema: z.object({
+    action: z.enum(['star', 'unstar', 'check']),
+    repo: z.string().min(1),
+  }),
+  tags: ['github'],
+  async execute(input, context) {
+    return executeGithubStar(input, context.$client);
+  },
+});

package/agents/github/skills/github-subscriptions/tools/subscribe/index.js

@@ -0,0 +1,16 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubSubscribe } from '../../handlers.js';
+export default defineAgentTool({
+    description: '订阅 GitHub 仓库的 Webhook 事件，事件将推送到当前聊天通道',
+    inputSchema: z.object({
+        repo: z.string().min(1),
+        events: z.string().optional(),
+    }),
+    adapter: 'github',
+    tags: ['github'],
+    async execute(input, context) {
+        return executeGithubSubscribe(input, context.$client);
+    },
+});

package/agents/github/skills/github-subscriptions/tools/subscribe/index.ts

@@ -0,0 +1,16 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubSubscribe } from '../../handlers.js';
+
+export default defineAgentTool<{ repo: string; events?: string }>({
+  description: '订阅 GitHub 仓库的 Webhook 事件，事件将推送到当前聊天通道',
+  inputSchema: z.object({
+    repo: z.string().min(1),
+    events: z.string().optional(),
+  }),
+  adapter: 'github',
+  tags: ['github'],
+  async execute(input, context) {
+    return executeGithubSubscribe(input, context.$client);
+  },
+});

package/agents/github/skills/github-subscriptions/tools/subscriptions/index.js

@@ -0,0 +1,13 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubSubscriptions } from '../../handlers.js';
+export default defineAgentTool({
+    description: '查看当前聊天通道的 GitHub 仓库订阅列表',
+    inputSchema: z.object({}),
+    adapter: 'github',
+    tags: ['github'],
+    async execute(input, context) {
+        return executeGithubSubscriptions({}, context.$client);
+    },
+});

package/agents/github/skills/github-subscriptions/tools/subscriptions/index.ts

@@ -0,0 +1,13 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubSubscriptions } from '../../handlers.js';
+
+export default defineAgentTool<{}>({
+  description: '查看当前聊天通道的 GitHub 仓库订阅列表',
+  inputSchema: z.object({}),
+  adapter: 'github',
+  tags: ['github'],
+  async execute(input, context) {
+    return executeGithubSubscriptions({}, context.$client);
+  },
+});

package/agents/github/skills/github-subscriptions/tools/unsubscribe/index.js

@@ -0,0 +1,15 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubUnsubscribe } from '../../handlers.js';
+export default defineAgentTool({
+    description: '取消订阅 GitHub 仓库的 Webhook 事件',
+    inputSchema: z.object({
+        repo: z.string().min(1),
+    }),
+    adapter: 'github',
+    tags: ['github'],
+    async execute(input, context) {
+        return executeGithubUnsubscribe(input, context.$client);
+    },
+});

package/agents/github/skills/github-subscriptions/tools/unsubscribe/index.ts

@@ -0,0 +1,15 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { executeGithubUnsubscribe } from '../../handlers.js';
+
+export default defineAgentTool<{ repo: string }>({
+  description: '取消订阅 GitHub 仓库的 Webhook 事件',
+  inputSchema: z.object({
+    repo: z.string().min(1),
+  }),
+  adapter: 'github',
+  tags: ['github'],
+  async execute(input, context) {
+    return executeGithubUnsubscribe(input, context.$client);
+  },
+});

package/agents/github/system.md

@@ -0,0 +1,3 @@
+# GITHUB Platform Agent
+
+You are the github platform specialist. Interpret requests in the current github conversation and load only the narrowest private Skill needed for the task.

package/commands/github/endpoint/add/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { githubEndpointCommands } from '../../definition.js';
+export default githubEndpointCommands.add;

package/commands/github/endpoint/add/[id]/index.ts

@@ -0,0 +1,3 @@
+import { githubEndpointCommands } from '../../definition.js';
+
+export default githubEndpointCommands.add;

package/commands/github/endpoint/definition.js

@@ -0,0 +1,23 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+/**
+ * `github endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/github/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ *
+ * 字段说明：private_key 内容长且含换行，不适合 kv 直传——运行时（gh-client
+ * resolvePrivateKey）本就支持 PEM 内容或文件路径，故 add 采用**内联路径**形式：
+ * `github endpoint add mybot app_id=123456 private_key=./data/mybot.pem`。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { githubRuntimeStateToken } from "../../../lib/github-runtime-state.js";
+export const githubEndpointCommands = createEndpointCommands({
+    adapterKey: 'github',
+    adapterDisplayName: 'GitHub',
+    fields: [
+        { key: 'app_id', required: true, env: true, description: 'GitHub App ID' },
+        { key: 'private_key', required: true, description: 'PEM 文件路径（推荐，如 ./data/xxx.pem）或 PEM 内容' },
+        { key: 'webhook_secret', env: true, description: 'webhook 签名密钥（不配则 API-only）' },
+    ],
+    running: (use) => use(githubRuntimeStateToken).endpoints.values(),
+    describeEntry: (entry) => `app_id: ${String(entry.app_id)}`,
+}, defineCommand);

package/commands/github/endpoint/definition.ts

@@ -0,0 +1,23 @@
+/**
+ * `github endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/github/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ *
+ * 字段说明：private_key 内容长且含换行，不适合 kv 直传——运行时（gh-client
+ * resolvePrivateKey）本就支持 PEM 内容或文件路径，故 add 采用**内联路径**形式：
+ * `github endpoint add mybot app_id=123456 private_key=./data/mybot.pem`。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { githubRuntimeStateToken } from '../../../src/github-runtime-state.js';
+
+export const githubEndpointCommands = createEndpointCommands({
+  adapterKey: 'github',
+  adapterDisplayName: 'GitHub',
+  fields: [
+    { key: 'app_id', required: true, env: true, description: 'GitHub App ID' },
+    { key: 'private_key', required: true, description: 'PEM 文件路径（推荐，如 ./data/xxx.pem）或 PEM 内容' },
+    { key: 'webhook_secret', env: true, description: 'webhook 签名密钥（不配则 API-only）' },
+  ],
+  running: (use) => use(githubRuntimeStateToken).endpoints.values(),
+  describeEntry: (entry) => `app_id: ${String(entry.app_id)}`,
+}, defineCommand);

package/commands/github/endpoint/list/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { githubEndpointCommands } from '../definition.js';
+export default githubEndpointCommands.list;

package/commands/github/endpoint/list/index.ts

@@ -0,0 +1,3 @@
+import { githubEndpointCommands } from '../definition.js';
+
+export default githubEndpointCommands.list;

package/commands/github/endpoint/remove/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { githubEndpointCommands } from '../../definition.js';
+export default githubEndpointCommands.remove;

package/commands/github/endpoint/remove/[id]/index.ts

@@ -0,0 +1,3 @@
+import { githubEndpointCommands } from '../../definition.js';
+
+export default githubEndpointCommands.remove;

package/lib/client.d.ts

@@ -0,0 +1,36 @@
+import type { PluginDatabaseHost } from 'zhin.js';
+import { GhClient } from './gh-client.js';
+import type { ResolvedGithubConfig } from './protocol.js';
+import { WorkspaceManager } from './workspace-manager.js';
+/** GitHub SDK surface exposed to plugin handlers and Agent tools. */
+export declare class GithubClient {
+    #private;
+    readonly name: string;
+    readonly api: GhClient;
+    readonly config: ResolvedGithubConfig;
+    readonly database?: PluginDatabaseHost | undefined;
+    constructor(name: string, api: GhClient, config: ResolvedGithubConfig, database?: PluginDatabaseHost | undefined);
+    getUserOrDefaultApi(platform?: string, platformUid?: string): Promise<GhClient>;
+    get clientId(): string | null;
+    get host(): string | undefined;
+    get appSlug(): string | null;
+    get installations(): {
+        id: number;
+        account: {
+            login: string;
+            type: string;
+        };
+        target_type: string;
+    }[];
+    get workspaceManager(): WorkspaceManager;
+}
+export type GithubClientEventMap = Record<string, unknown>;
+declare module '@zhin.js/feature-kit' {
+    interface AdapterClientRegistry {
+        readonly github: {
+            readonly client: GithubClient;
+            readonly events: GithubClientEventMap;
+        };
+    }
+}
+export declare const githubClient: import("@zhin.js/adapter").EndpointClientToken<GithubClient, GithubClientEventMap>;

package/lib/client.js

@@ -0,0 +1,44 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+import { lookupGithubOauthAccessToken } from './oauth-users.js';
+import { WorkspaceManager } from './workspace-manager.js';
+/** GitHub SDK surface exposed to plugin handlers and Agent tools. */
+export class GithubClient {
+    name;
+    api;
+    config;
+    database;
+    #workspaceManager;
+    constructor(name, api, config, database) {
+        this.name = name;
+        this.api = api;
+        this.config = config;
+        this.database = database;
+    }
+    async getUserOrDefaultApi(platform, platformUid) {
+        if (platform && platformUid) {
+            const token = await lookupGithubOauthAccessToken(this.database, platform, platformUid);
+            if (token)
+                return this.api.withToken(token);
+        }
+        return this.api;
+    }
+    get clientId() {
+        return this.api.clientId || null;
+    }
+    get host() {
+        return this.config.host;
+    }
+    get appSlug() {
+        return this.api.appSlug || null;
+    }
+    get installations() {
+        return this.api.installations || [];
+    }
+    get workspaceManager() {
+        if (!this.#workspaceManager) {
+            this.#workspaceManager = new WorkspaceManager(this.api, this.config.workspaceRoot);
+        }
+        return this.#workspaceManager;
+    }
+}
+export const githubClient = defineEndpointClient('github');

package/lib/endpoint.d.ts

@@ -1,26 +1,36 @@
+import { Endpoint } from 'zhin.js/adapter';
 /**
- * GitHub Endpoint 实现（基于 gh CLI）
+ * GithubEndpoint — lifecycle, outbound send, inbound admit.
  */
-import { Endpoint, Message, SendContent, SendOptions, type MessageSegment } from 'zhin.js';
-import type { GitHubEndpointConfig, IssueCommentPayload, PRReviewCommentPayload, PRReviewPayload } from './types.js';
-import type { GitHubAdapter } from './adapter.js';
+import { type EndpointSendRequest } from 'zhin.js/adapter';
+import type { HttpHost } from '@zhin.js/host-http';
+import type { CapabilityId, PluginDatabaseHost } from 'zhin.js';
 import { GhClient } from './gh-client.js';
-export declare function parseMarkdown(md: string): MessageSegment[];
-export declare function toMarkdown(content: SendContent): string;
-export declare class GitHubEndpoint implements Endpoint<GitHubEndpointConfig, IssueCommentPayload> {
-    adapter: GitHubAdapter;
-    $config: GitHubEndpointConfig;
-    $connected: boolean;
-    gh: GhClient;
-    get $id(): string;
-    get logger(): import("zhin.js").Logger;
-    constructor(adapter: GitHubAdapter, $config: GitHubEndpointConfig);
-    $connect(): Promise<void>;
-    $disconnect(): Promise<void>;
-    $formatMessage(payload: IssueCommentPayload): Message<IssueCommentPayload>;
-    formatPRReviewComment(payload: PRReviewCommentPayload): Message<PRReviewCommentPayload>;
-    formatPRReview(payload: PRReviewPayload): Message<PRReviewPayload> | null;
-    $sendMessage(options: SendOptions): Promise<string>;
-    $recallMessage(id: string): Promise<void>;
+import { type GithubInboundComment, type ResolvedGithubConfig } from './protocol.js';
+import { GithubClient } from './client.js';
+export interface GithubEndpointOptions {
+    readonly id: CapabilityId;
+    readonly http?: HttpHost;
+    readonly database?: PluginDatabaseHost;
+    readonly config: ResolvedGithubConfig;
+    readonly createClient?: (config: ResolvedGithubConfig) => GhClient;
 }
-//# sourceMappingURL=endpoint.d.ts.map
+/**
+ * GitHub 是代码协作面（issue/PR），无好友/群/频道等 IM 社交概念，
+ * 不适用 EndpointManagement 语义端口；本 endpoint 不暴露该端口。
+ */
+export declare class GithubEndpoint extends Endpoint<GithubClient> {
+    #private;
+    readonly client: GithubClient;
+    constructor(options: GithubEndpointOptions);
+    get config(): ResolvedGithubConfig;
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
+    /** Test / internal: admit a parsed comment when open. */
+    admit(comment: GithubInboundComment): void;
+    admitPlatform(name: string, event: unknown): void;
+}
+export declare function defaultCreateClient(config: ResolvedGithubConfig): GhClient;