@zhin.js/adapter-github 5.0.2 → 5.0.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @zhin.js/adapter-github
 
+## 5.0.3
+
+### Patch Changes
+
+- Updated dependencies [afc0e66]
+- Updated dependencies [2e41ad5]
+- Updated dependencies [9f57124]
+  - @zhin.js/core@1.5.2
+  - @zhin.js/adapter@1.1.5
+  - @zhin.js/im-contract@1.0.1
+  - @zhin.js/plugin-runtime@1.1.3
+  - @zhin.js/command@1.0.7
+  - @zhin.js/host-http@1.0.6
+  - @zhin.js/agent@1.1.3
+  - zhin.js@6.0.2
+
 ## 5.0.2
 
 ### Patch Changes

package/README.md

@@ -6,7 +6,7 @@ GitHub Plugin Runtime 适配器 — Issue/PR 评论区即聊天通道，GitHub A
 
 - **聊天通道**：Issue/PR 评论区映射为群聊，支持收发消息
 - **Webhook 入站**：HMAC-SHA256 验签 → `messageGatewayToken`
-- **出站**：`send({ target, payload })` → Issue/PR comment（target 为 channel ID）
+- **出站**：`send({ conversation, payload })` → Issue/PR comment（`conversation.id` 为 channel ID）
 - **GitHub App 认证**：JWT → Installation Token
 - **Agent 工具**：`agent/` 下 star/bind/subscribe/workspace 等保留
 
@@ -85,7 +85,7 @@ plugins:
 | `src/gh-client.ts` | GitHub API 客户端 |
 
 - 入站：`httpHostToken` POST → `messageGatewayToken.receive`
-- 出站：`send({ target, payload })`
+- 出站：`send({ conversation, payload })`
 
 ## License
 

package/lib/endpoint.d.ts

@@ -1,4 +1,4 @@
-import type { EndpointInstance } from '@zhin.js/adapter';
+import type { EndpointInstance, EndpointSendRequest } from '@zhin.js/adapter';
 import type { MessageGateway } from '@zhin.js/core/runtime';
 import type { HttpHost } from '@zhin.js/host-http';
 import type { CapabilityId, DatabaseHost } from '@zhin.js/plugin-runtime';
@@ -42,10 +42,7 @@ export declare class GithubEndpoint implements EndpointInstance {
     open(): void;
     close(): void;
     stop(): Promise<void>;
-    send({ target, payload }: {
-        readonly target: string;
-        readonly payload: unknown;
-    }): Promise<string>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
     /** Test / internal: admit a parsed comment when open. */
     admit(comment: GithubInboundComment): void;
 }

package/lib/endpoint.js

@@ -6,7 +6,7 @@ import { formatCompact, getLogger } from '@zhin.js/logger';
 import { GhClient } from './gh-client.js';
 import { registerGithubAgentEndpoint } from './github-agent-deps.js';
 import { lookupGithubOauthAccessToken } from './oauth-users.js';
-import { enrichInboundContent, formatInboundContent, formatOutboundBody, parseChannelId, } from './protocol.js';
+import { enrichInboundContent, formatInboundContent, formatOutboundBody, githubInboundConversation, parseChannelId, } from './protocol.js';
 import { registerGithubWebhookRoutes } from './webhook.js';
 import { WorkspaceManager } from './workspace-manager.js';
 const logger = getLogger('github');
@@ -114,10 +114,10 @@ export class GithubEndpoint {
         this.#started = false;
         logger.debug(formatCompact({ op: 'disconnect', endpoint: this.name }));
     }
-    async send({ target, payload }) {
-        const parsed = parseChannelId(target);
+    async send({ conversation, payload }) {
+        const parsed = parseChannelId(conversation.id);
         if (!parsed)
-            throw new Error(`无效的 GitHub channel ID: ${target}`);
+            throw new Error(`无效的 GitHub conversation ID: ${conversation.id}`);
         const text = formatOutboundBody(payload);
         const r = parsed.type === 'issue'
             ? await this.gh.createIssueComment(parsed.repo, parsed.number, text)
@@ -127,7 +127,7 @@ export class GithubEndpoint {
         logger.debug(formatCompact({
             op: 'github_send',
             endpoint: this.name,
-            target,
+            target: `${conversation.kind}:${conversation.id}`,
             messageId: r.data.id,
         }));
         return String(r.data.id);
@@ -139,13 +139,13 @@ export class GithubEndpoint {
         const botUser = this.config.botLogin || this.gh.getBotLogin() || this.gh.authenticatedUser;
         if (botUser && comment.sender === botUser)
             return;
+        const conversation = githubInboundConversation(String(this.#options.id), comment);
         const content = enrichInboundContent(formatInboundContent(comment.content), this.config, botUser ?? undefined, comment.repo);
         void this.#options.gateway.receive({
-            adapter: this.#options.id,
-            target: comment.channelId,
+            conversation,
+            message: { conversation, id: comment.id },
             content,
             sender: comment.sender,
-            id: comment.id,
             metadata: Object.freeze({
                 endpoint: this.name,
                 repo: comment.repo,
@@ -155,7 +155,7 @@ export class GithubEndpoint {
         }).catch((err) => {
             logger.warn(formatCompact({
                 op: 'github_gateway_receive_failed',
-                target: comment.channelId,
+                target: `${conversation.kind}:${conversation.id}`,
                 error: err instanceof Error ? err.message : String(err),
             }));
         });

package/lib/protocol.d.ts

@@ -3,6 +3,7 @@
  * Canonicalization is owned by gateway/core before endpoint.send.
  */
 import type { IncomingMessage } from 'node:http';
+import type { ConversationRef } from '@zhin.js/im-contract';
 import { type GenericWebhookPayload, type IssueCommentPayload, type PRReviewCommentPayload, type PRReviewPayload } from './types.js';
 export type { EventType, GenericWebhookPayload, GitHubComment, GitHubEndpointConfig, GitHubIssue, GitHubOAuthUser, GitHubPR, GitHubRepo, GitHubUser, IssueCommentPayload, ParsedChannel, PRReviewCommentPayload, PRReviewPayload, Subscription, } from './types.js';
 export { buildChannelId, parseChannelId } from './types.js';
@@ -65,6 +66,12 @@ export interface GithubInboundComment {
     readonly kind: 'issue_comment' | 'pr_review_comment' | 'pr_review';
     readonly createdAt: number;
 }
+/**
+ * 入站归一化 → ConversationRef：Issue/PR 评论区即仓库容器内的 channel 会话，
+ * 仓库（owner/repo）进 `parent`。出站侧用 `parseChannelId(conversation.id)`
+ * 在平台边界还原 repo/type/number。
+ */
+export declare function githubInboundConversation(endpointId: string, comment: GithubInboundComment): ConversationRef;
 export declare function resolveGithubConfig(config?: GithubAdapterConfig): ResolvedGithubConfig;
 export declare function normalizeWebhookPath(path: string): string;
 export declare function shouldAutoReplyRepo(config: Pick<ResolvedGithubConfig, 'autoReplyRepos'>, repo: string): boolean;

package/lib/protocol.js

@@ -9,6 +9,19 @@ import { formatCompact, getLogger } from '@zhin.js/logger';
 const logger = getLogger('github');
 import { buildChannelId, } from './types.js';
 export { buildChannelId, parseChannelId } from './types.js';
+/**
+ * 入站归一化 → ConversationRef：Issue/PR 评论区即仓库容器内的 channel 会话，
+ * 仓库（owner/repo）进 `parent`。出站侧用 `parseChannelId(conversation.id)`
+ * 在平台边界还原 repo/type/number。
+ */
+export function githubInboundConversation(endpointId, comment) {
+    return {
+        endpoint: { id: endpointId, adapter: endpointId.split('\0')[0] ?? endpointId },
+        kind: 'channel',
+        id: comment.channelId,
+        parent: { kind: 'channel', id: comment.repo },
+    };
+}
 export function resolveGithubConfig(config = {}) {
     const entry = config.endpoints?.find((item) => item.context === 'github');
     const appIdRaw = pickCredential(config.appId != null ? String(config.appId) : undefined, config.app_id != null ? String(config.app_id) : undefined, entry?.appId != null ? String(entry.appId) : undefined, entry?.app_id != null ? String(entry.app_id) : undefined, process.env.GITHUB_APP_ID);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-github",
-  "version": "5.0.2",
+  "version": "5.0.3",
   "description": "Zhin.js GitHub adapter for Plugin Runtime (App auth + webhook)",
   "type": "module",
   "main": "./lib/index.js",
@@ -41,21 +41,22 @@
     "directory": "plugins/adapters/github"
   },
   "dependencies": {
-    "@zhin.js/adapter": "1.1.4",
-    "@zhin.js/command": "1.0.6",
-    "@zhin.js/core": "1.5.1",
-    "@zhin.js/host-http": "1.0.5",
+    "@zhin.js/adapter": "1.1.5",
+    "@zhin.js/command": "1.0.7",
+    "@zhin.js/core": "1.5.2",
+    "@zhin.js/host-http": "1.0.6",
+    "@zhin.js/im-contract": "1.0.1",
     "@zhin.js/logger": "1.0.75",
-    "@zhin.js/plugin-runtime": "1.1.2"
+    "@zhin.js/plugin-runtime": "1.1.3"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/adapter": "1.1.4",
-    "@zhin.js/agent": "1.1.2",
-    "@zhin.js/core": "1.5.1",
-    "@zhin.js/host-http": "1.0.5",
-    "@zhin.js/plugin-runtime": "1.1.2",
-    "zhin.js": "6.0.1"
+    "@zhin.js/adapter": "1.1.5",
+    "@zhin.js/agent": "1.1.3",
+    "@zhin.js/core": "1.5.2",
+    "@zhin.js/host-http": "1.0.6",
+    "@zhin.js/plugin-runtime": "1.1.3",
+    "zhin.js": "6.0.2"
   },
   "peerDependenciesMeta": {
     "zhin.js": {
@@ -73,8 +74,8 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "@zhin.js/agent": "1.1.2",
-    "zhin.js": "6.0.1"
+    "@zhin.js/agent": "1.1.3",
+    "zhin.js": "6.0.2"
   },
   "files": [
     "adapters",

package/src/endpoint.ts

@@ -2,7 +2,7 @@
  * GithubEndpoint — lifecycle, outbound send, inbound admit.
  */
 import path from 'node:path';
-import type { EndpointInstance } from '@zhin.js/adapter';
+import type { EndpointInstance, EndpointSendRequest } from '@zhin.js/adapter';
 import type { MessageGateway } from '@zhin.js/core/runtime';
 import type { HttpHost, HttpRouteRegistration } from '@zhin.js/host-http';
 import { formatCompact, getLogger } from '@zhin.js/logger';
@@ -14,6 +14,7 @@ import {
   enrichInboundContent,
   formatInboundContent,
   formatOutboundBody,
+  githubInboundConversation,
   parseChannelId,
   type GithubInboundComment,
   type ResolvedGithubConfig,
@@ -147,9 +148,9 @@ export class GithubEndpoint implements EndpointInstance {
     logger.debug(formatCompact({ op: 'disconnect', endpoint: this.name }));
   }
 
-  async send({ target, payload }: { readonly target: string; readonly payload: unknown }): Promise<string> {
-    const parsed = parseChannelId(target);
-    if (!parsed) throw new Error(`无效的 GitHub channel ID: ${target}`);
+  async send({ conversation, payload }: EndpointSendRequest): Promise<string> {
+    const parsed = parseChannelId(conversation.id);
+    if (!parsed) throw new Error(`无效的 GitHub conversation ID: ${conversation.id}`);
     const text = formatOutboundBody(payload);
     const r = parsed.type === 'issue'
       ? await this.gh.createIssueComment(parsed.repo, parsed.number, text)
@@ -158,7 +159,7 @@ export class GithubEndpoint implements EndpointInstance {
     logger.debug(formatCompact({
       op: 'github_send',
       endpoint: this.name,
-      target,
+      target: `${conversation.kind}:${conversation.id}`,
       messageId: r.data.id,
     }));
     return String(r.data.id);
@@ -169,6 +170,7 @@ export class GithubEndpoint implements EndpointInstance {
     if (!this.#open) return;
     const botUser = this.config.botLogin || this.gh.getBotLogin() || this.gh.authenticatedUser;
     if (botUser && comment.sender === botUser) return;
+    const conversation = githubInboundConversation(String(this.#options.id), comment);
     const content = enrichInboundContent(
       formatInboundContent(comment.content),
       this.config,
@@ -176,11 +178,10 @@ export class GithubEndpoint implements EndpointInstance {
       comment.repo,
     );
     void this.#options.gateway.receive({
-      adapter: this.#options.id,
-      target: comment.channelId,
+      conversation,
+      message: { conversation, id: comment.id },
       content,
       sender: comment.sender,
-      id: comment.id,
       metadata: Object.freeze({
         endpoint: this.name,
         repo: comment.repo,
@@ -190,7 +191,7 @@ export class GithubEndpoint implements EndpointInstance {
     }).catch((err) => {
       logger.warn(formatCompact({
         op: 'github_gateway_receive_failed',
-        target: comment.channelId,
+        target: `${conversation.kind}:${conversation.id}`,
         error: err instanceof Error ? err.message : String(err),
       }));
     });

package/src/protocol.ts

@@ -7,6 +7,7 @@ import { createHmac, timingSafeEqual } from 'node:crypto';
 import type { IncomingMessage } from 'node:http';
 import { pickCredential } from '@zhin.js/adapter';
 import { isMediaRef } from '@zhin.js/core';
+import type { ConversationRef } from '@zhin.js/im-contract';
 import { formatCompact, getLogger } from '@zhin.js/logger';
 
 const logger = getLogger('github');
@@ -100,6 +101,23 @@ export interface GithubInboundComment {
   readonly createdAt: number;
 }
 
+/**
+ * 入站归一化 → ConversationRef：Issue/PR 评论区即仓库容器内的 channel 会话，
+ * 仓库（owner/repo）进 `parent`。出站侧用 `parseChannelId(conversation.id)`
+ * 在平台边界还原 repo/type/number。
+ */
+export function githubInboundConversation(
+  endpointId: string,
+  comment: GithubInboundComment,
+): ConversationRef {
+  return {
+    endpoint: { id: endpointId, adapter: endpointId.split('\0')[0] ?? endpointId },
+    kind: 'channel',
+    id: comment.channelId,
+    parent: { kind: 'channel', id: comment.repo },
+  };
+}
+
 export function resolveGithubConfig(config: GithubAdapterConfig = {}): ResolvedGithubConfig {
   const entry = config.endpoints?.find((item) => item.context === 'github');
   const appIdRaw = pickCredential(