@zhin.js/adapter-github 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @zhin.js/adapter-github
 
+## 4.0.2
+
+### Patch Changes
+
+- d5cd4aa: Publish Plugin Runtime entry points and convention modules as JavaScript so
+  installed npm plugins load on Node without TypeScript stripping. Workspace
+  development continues to prefer TypeScript sources for local HMR.
+
+  Remove the unconsumed legacy game hub APIs from game-kit; game navigation and
+  records now use ordinary convention commands owned by the game hub plugin.
+
+- Updated dependencies [d5cd4aa]
+  - @zhin.js/command@1.0.4
+  - zhin.js@5.0.2
+  - @zhin.js/adapter@1.1.2
+  - @zhin.js/core@1.4.2
+  - @zhin.js/agent@1.0.7
+
+## 4.0.1
+
+### Patch Changes
+
+- 74b035c: endpoint 管理命令扩展至 18/20 适配器：kook / discord / github（private_key 支持内联文件路径）/ icqq（bindFlow 登记式 add + `icqq login` 引导）/ dingtalk / lark / line / satori / wechat-mp / wecom / weixin-ilink 接入 `endpoint list/add/remove`（字段对齐各自 schema，凭据写 `.env`）。email（smtp/imap 嵌套对象）与 sandbox（无凭据）暂不接。
+- Updated dependencies [cdf64e7]
+- Updated dependencies [2d0a159]
+- Updated dependencies [5691aba]
+- Updated dependencies [078e3f7]
+- Updated dependencies [50497a5]
+- Updated dependencies [9c997b2]
+- Updated dependencies [09d4f25]
+- Updated dependencies [43485a9]
+- Updated dependencies [f0ec5ab]
+- Updated dependencies [3e925d0]
+- Updated dependencies [fa66c4c]
+- Updated dependencies [fa66c4c]
+- Updated dependencies [6cb6152]
+  - @zhin.js/command@1.0.3
+  - @zhin.js/agent@1.0.6
+  - @zhin.js/plugin-runtime@1.1.1
+  - @zhin.js/host-http@1.0.3
+  - zhin.js@5.0.1
+  - @zhin.js/adapter@1.1.1
+  - @zhin.js/core@1.4.1
+
 ## 4.0.0
 
 ### Patch Changes

package/adapters/github.js

@@ -0,0 +1,54 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+/**
+ * Convention entry: discover `adapters/github.ts` → defineAdapter.
+ * Implementation lives under `src/` (endpoint / webhook / oauth / protocol).
+ */
+import { defineAdapter } from '@zhin.js/adapter';
+import { messageGatewayToken } from '@zhin.js/core/runtime';
+import { httpHostToken } from '@zhin.js/host-http';
+import { databaseHostToken, } from '@zhin.js/plugin-runtime';
+import { GithubEndpoint } from "../lib/endpoint.js";
+import { githubRuntimeStateToken } from "../lib/github-runtime-state.js";
+import { resolveGithubConfig, } from "../lib/protocol.js";
+export { GithubEndpoint } from "../lib/endpoint.js";
+function optionalDatabase(context) {
+    try {
+        return context.use(databaseHostToken);
+    }
+    catch {
+        return undefined;
+    }
+}
+export default defineAdapter({
+    capabilities: ['inbound', 'outbound'],
+    // Issue/PR 评论以 markdown 图片链接消费远程 URL；无交互面，交互段降级纯文本。
+    segments: {
+        outboundMedia: ['url'],
+        interactive: 'text',
+    },
+    create(context) {
+        const config = resolveGithubConfig(context.config);
+        const database = optionalDatabase(context);
+        // 注册到插件运行时状态（github endpoint list 的"运行中"数据源）
+        context.use(githubRuntimeStateToken).endpoints.set(config.name, {
+            name: config.name,
+            mode: config.webhookSecret ? 'webhook' : 'api',
+        });
+        if (config.webhookSecret) {
+            return new GithubEndpoint({
+                id: context.id,
+                gateway: context.use(messageGatewayToken),
+                http: context.use(httpHostToken),
+                database,
+                config,
+            });
+        }
+        // API-only: Issue/PR send + agent tools without webhook.
+        return new GithubEndpoint({
+            id: context.id,
+            gateway: context.use(messageGatewayToken),
+            database,
+            config,
+        });
+    },
+});

package/adapters/github.ts

@@ -10,6 +10,7 @@ import {
   type DatabaseHost,
 } from '@zhin.js/plugin-runtime';
 import { GithubEndpoint } from '../src/endpoint.js';
+import { githubRuntimeStateToken } from '../src/github-runtime-state.js';
 import {
   resolveGithubConfig,
   type GithubAdapterConfig,
@@ -28,9 +29,19 @@ function optionalDatabase(context: AdapterContext): DatabaseHost | undefined {
 
 export default defineAdapter<GithubAdapterConfig>({
   capabilities: ['inbound', 'outbound'],
+  // Issue/PR 评论以 markdown 图片链接消费远程 URL；无交互面，交互段降级纯文本。
+  segments: {
+    outboundMedia: ['url'],
+    interactive: 'text',
+  },
   create(context) {
     const config = resolveGithubConfig(context.config);
     const database = optionalDatabase(context);
+    // 注册到插件运行时状态（github endpoint list 的"运行中"数据源）
+    context.use(githubRuntimeStateToken).endpoints.set(config.name, {
+      name: config.name,
+      mode: config.webhookSecret ? 'webhook' : 'api',
+    });
     if (config.webhookSecret) {
       return new GithubEndpoint({
         id: context.id,

package/commands/endpoint/add/[name:string].js

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

package/commands/endpoint/add/[name:string].ts

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

package/commands/endpoint/list.js

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

package/commands/endpoint/list.ts

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

package/commands/endpoint/remove/[name:string].js

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

package/commands/endpoint/remove/[name:string].ts

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

package/lib/endpoint.d.ts

@@ -13,6 +13,10 @@ export interface GithubEndpointOptions {
     readonly config: ResolvedGithubConfig;
     readonly createClient?: (config: ResolvedGithubConfig) => GhClient;
 }
+/**
+ * GitHub 是代码协作面（issue/PR），无好友/群/频道等 IM 社交概念，
+ * 不适用 EndpointManagement 语义端口；本 endpoint 不暴露该端口。
+ */
 export declare class GithubEndpoint implements EndpointInstance {
     #private;
     readonly gh: GhClient;

package/lib/endpoint.js

@@ -10,6 +10,10 @@ import { enrichInboundContent, formatInboundContent, formatOutboundBody, parseCh
 import { registerGithubWebhookRoutes } from './webhook.js';
 import { WorkspaceManager } from './workspace-manager.js';
 const logger = getLogger('github');
+/**
+ * GitHub 是代码协作面（issue/PR），无好友/群/频道等 IM 社交概念，
+ * 不适用 EndpointManagement 语义端口；本 endpoint 不暴露该端口。
+ */
 export class GithubEndpoint {
     #options;
     gh;

package/lib/github-endpoint-commands.d.ts

@@ -0,0 +1 @@
+export declare const githubEndpointCommands: import("@zhin.js/adapter").EndpointCommands<Readonly<import("@zhin.js/command").CommandDefinition<unknown, unknown, import("@zhin.js/command").CommandMessage>>>;

package/lib/github-endpoint-commands.js

@@ -0,0 +1,22 @@
+/**
+ * `github endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/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 './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 ?? entry.appId)}`,
+}, defineCommand);

package/lib/github-runtime-state.d.ts

@@ -0,0 +1 @@
+export declare const githubRuntimeStateToken: import("zhin.js").Token<import("@zhin.js/adapter").EndpointRuntimeState>;

package/lib/github-runtime-state.js

@@ -0,0 +1,6 @@
+/**
+ * GitHub 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
+ * 由 plugin.ts setup() provide，adapter create 与 `github endpoint` 命令共享（同一 owner generation）。
+ */
+import { defineEndpointRuntimeStateToken } from '@zhin.js/adapter';
+export const githubRuntimeStateToken = defineEndpointRuntimeStateToken('github');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-github",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Zhin.js GitHub adapter for Plugin Runtime (App auth + webhook)",
   "type": "module",
   "main": "./lib/index.js",
@@ -41,20 +41,21 @@
     "directory": "plugins/adapters/github"
   },
   "dependencies": {
-    "@zhin.js/adapter": "1.1.0",
-    "@zhin.js/core": "1.4.0",
-    "@zhin.js/host-http": "1.0.2",
+    "@zhin.js/adapter": "1.1.2",
+    "@zhin.js/command": "1.0.4",
+    "@zhin.js/core": "1.4.2",
+    "@zhin.js/host-http": "1.0.3",
     "@zhin.js/logger": "1.0.75",
-    "@zhin.js/plugin-runtime": "1.1.0"
+    "@zhin.js/plugin-runtime": "1.1.1"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/adapter": "1.1.0",
-    "@zhin.js/agent": "1.0.5",
-    "@zhin.js/core": "1.4.0",
-    "@zhin.js/host-http": "1.0.2",
-    "@zhin.js/plugin-runtime": "1.1.0",
-    "zhin.js": "5.0.0"
+    "@zhin.js/adapter": "1.1.2",
+    "@zhin.js/agent": "1.0.7",
+    "@zhin.js/core": "1.4.2",
+    "@zhin.js/host-http": "1.0.3",
+    "@zhin.js/plugin-runtime": "1.1.1",
+    "zhin.js": "5.0.2"
   },
   "peerDependenciesMeta": {
     "zhin.js": {
@@ -72,12 +73,13 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "@zhin.js/agent": "1.0.5",
-    "zhin.js": "5.0.0"
+    "@zhin.js/agent": "1.0.7",
+    "zhin.js": "5.0.2"
   },
   "files": [
     "adapters",
-    "plugin.ts",
+    "commands",
+    "plugin.js",
     "schema.json",
     "src",
     "lib",
@@ -95,13 +97,17 @@
   "zhin": {
     "protocol": 1,
     "type": "plugin",
-    "entry": "./plugin.ts",
+    "entry": "./plugin.js",
     "engine": "^1.0.0",
     "runtime": "trusted",
     "features": [
       {
         "package": "@zhin.js/adapter",
         "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/command",
+        "api": "^1.0.0"
       }
     ],
     "plugins": []

package/plugin.js

@@ -0,0 +1,55 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { createEndpointRuntimeState } from '@zhin.js/adapter';
+import { definePlugin, databaseHostToken } from '@zhin.js/plugin-runtime';
+import { githubRuntimeStateToken } from "./lib/github-runtime-state.js";
+import { defineGithubOauthUsersTable } from "./lib/oauth-users.js";
+/**
+ * github_subscriptions — repo event subscriptions per chat channel
+ * (used by github_subscriptions agent tool; schema matches legacy defineModel).
+ */
+const GITHUB_SUBSCRIPTIONS_SCHEMA = {
+    id: { type: 'integer', primary: true },
+    repo: { type: 'text', nullable: false },
+    events: { type: 'json', default: [] },
+    target_id: { type: 'text', nullable: false },
+    target_type: { type: 'text', nullable: false },
+    adapter: { type: 'text', nullable: false },
+    endpoint: { type: 'text', nullable: false },
+};
+/**
+ * Plugin Runtime GitHub adapter.
+ * - Endpoint: `adapters/github.ts`
+ * - OAuth user tokens: define `github_oauth_users` when DatabaseHost is present
+ */
+export default definePlugin({
+    name: 'github',
+    metadata: {
+        displayName: 'GitHub Adapter',
+    },
+    setup(context) {
+        // 运行中 endpoint 注册表（github endpoint list 的"运行中"数据源）
+        context.resources.provide(githubRuntimeStateToken, createEndpointRuntimeState());
+        if (context.resources.has(databaseHostToken)) {
+            const host = context.resources.use(databaseHostToken);
+            defineGithubOauthUsersTable(host);
+            host.define('github_subscriptions', { ...GITHUB_SUBSCRIPTIONS_SCHEMA });
+        }
+        // Agent prompt contributor (orchestrator/deferred-worker GitHub guidance).
+        // `zhin.js/agent` is an optional peer — skip silently on IM-only installs.
+        let cancelled = false;
+        let unregister;
+        void Promise.all([
+            import('zhin.js/agent'),
+            import("./lib/agent-prompt.js"),
+        ]).then(([agent, prompt]) => {
+            if (cancelled)
+                return;
+            agent.registerAgentPromptContributor(prompt.createGithubAgentPromptContributor());
+            unregister = () => agent.unregisterAgentPromptContributor('github');
+        }).catch(() => { });
+        return () => {
+            cancelled = true;
+            unregister?.();
+        };
+    },
+});

package/src/endpoint.ts

@@ -32,6 +32,10 @@ export interface GithubEndpointOptions {
   readonly createClient?: (config: ResolvedGithubConfig) => GhClient;
 }
 
+/**
+ * GitHub 是代码协作面（issue/PR），无好友/群/频道等 IM 社交概念，
+ * 不适用 EndpointManagement 语义端口；本 endpoint 不暴露该端口。
+ */
 export class GithubEndpoint implements EndpointInstance {
   readonly #options: GithubEndpointOptions;
   readonly gh: GhClient;

package/src/github-endpoint-commands.ts

@@ -0,0 +1,23 @@
+/**
+ * `github endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/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 './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 ?? entry.appId)}`,
+}, defineCommand);

package/src/github-runtime-state.ts

@@ -0,0 +1,7 @@
+/**
+ * GitHub 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
+ * 由 plugin.ts setup() provide，adapter create 与 `github endpoint` 命令共享（同一 owner generation）。
+ */
+import { defineEndpointRuntimeStateToken } from '@zhin.js/adapter';
+
+export const githubRuntimeStateToken = defineEndpointRuntimeStateToken('github');

package/plugin.ts

@@ -1,52 +0,0 @@
-import { definePlugin, databaseHostToken } from '@zhin.js/plugin-runtime';
-import { defineGithubOauthUsersTable } from './src/oauth-users.js';
-
-/**
- * github_subscriptions — repo event subscriptions per chat channel
- * (used by github_subscriptions agent tool; schema matches legacy defineModel).
- */
-const GITHUB_SUBSCRIPTIONS_SCHEMA = {
-  id: { type: 'integer', primary: true },
-  repo: { type: 'text', nullable: false },
-  events: { type: 'json', default: [] },
-  target_id: { type: 'text', nullable: false },
-  target_type: { type: 'text', nullable: false },
-  adapter: { type: 'text', nullable: false },
-  endpoint: { type: 'text', nullable: false },
-} as const;
-
-/**
- * Plugin Runtime GitHub adapter.
- * - Endpoint: `adapters/github.ts`
- * - OAuth user tokens: define `github_oauth_users` when DatabaseHost is present
- */
-export default definePlugin({
-  name: 'github',
-  metadata: {
-    displayName: 'GitHub Adapter',
-  },
-  setup(context) {
-    if (context.resources.has(databaseHostToken)) {
-      const host = context.resources.use(databaseHostToken);
-      defineGithubOauthUsersTable(host);
-      host.define('github_subscriptions', { ...GITHUB_SUBSCRIPTIONS_SCHEMA });
-    }
-
-    // Agent prompt contributor (orchestrator/deferred-worker GitHub guidance).
-    // `zhin.js/agent` is an optional peer — skip silently on IM-only installs.
-    let cancelled = false;
-    let unregister: (() => void) | undefined;
-    void Promise.all([
-      import('zhin.js/agent'),
-      import('./src/agent-prompt.js'),
-    ]).then(([agent, prompt]) => {
-      if (cancelled) return;
-      agent.registerAgentPromptContributor(prompt.createGithubAgentPromptContributor());
-      unregister = () => agent.unregisterAgentPromptContributor('github');
-    }).catch(() => { /* optional peer not installed */ });
-    return () => {
-      cancelled = true;
-      unregister?.();
-    };
-  },
-});