@zhin.js/adapter-github 1.1.17 → 1.1.18

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @zhin.js/adapter-github
 
+## 1.1.18
+
+### Patch Changes
+
+- 6345a38: feat(adapters): add per-adapter Console pages
+
+  Every platform adapter now ships a `pages/index` Console page backed by a shared
+  `createAdapterConsolePage` component and `createAdapterConsoleRpc` server helper:
+
+  - See running endpoints, test connectivity, and manage
+    `plugins.<adapter>.endpoints` (add/remove writes `.env` references) from the
+    Console instead of chat commands.
+  - Surface LoginAssist pending tasks (QR / slider / SMS / device) so ICQQ login no
+    longer requires the terminal.
+  - QQ moves its QR binding flow (`qq endpoint add`) into Console actions with
+    public/private selection.
+  - Pages are permission-gated by `<adapter>:read`; writes need `<adapter>:write`.
+
+- Updated dependencies [6345a38]
+- Updated dependencies [ff3efe7]
+- Updated dependencies [c58c589]
+  - @zhin.js/adapter@1.1.25
+  - @zhin.js/client@1.1.21
+  - @zhin.js/core@1.1.53
+  - @zhin.js/im-contract@1.1.9
+  - @zhin.js/tool@1.1.12
+
 ## 1.1.17
 
 ### Patch Changes

package/README.md

@@ -97,6 +97,16 @@ github:
 - 入站：`httpHostToken` POST → `Endpoint.emit(...)`
 - 出站：`send({ conversation, payload })`
 
+## Console 页面
+
+启动后打开 Console 的「GitHub」页（地址 `/github`），可以：
+
+- 查看运行中的连接、点「测试连接」做连通性诊断；
+- 增删 `plugins.github.endpoints`（凭据写入 `.env`，配置里只保留 `${ENV}` 引用）；
+- 如果适配器要求登录，页面会显示 LoginAssist 的扫码 / 滑块 / 设备确认待办；
+
+读取需要 `github:read`，写操作需要 `github:write`；管理员 full token 不受限。页面里的「添加 endpoint」等价于原来的 `github endpoint add`。
+
 ## 故障排查
 
 | 现象 | 排查 |

package/lib/console-spec.d.ts

@@ -0,0 +1,12 @@
+/**
+ * GitHub Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+export declare const githubConsoleSpec: {
+    readonly adapterKey: "github";
+    readonly adapterDisplayName: "GitHub";
+    readonly fields: readonly AdapterConsoleField[];
+    readonly docsUrl: "https://zhin.js.org/adapters/github";
+    readonly readPermission: "github:read";
+    readonly writePermission: "github:write";
+};

package/lib/console-spec.js

@@ -0,0 +1,12 @@
+export const githubConsoleSpec = {
+    adapterKey: 'github',
+    adapterDisplayName: 'GitHub',
+    fields: [
+        { key: 'app_id', required: true, env: true, description: 'GitHub App ID' },
+        { key: 'private_key', required: true, secret: true, description: 'PEM 文件路径（推荐，如 ./data/xxx.pem）或 PEM 内容', descriptionI18n: { en: 'PEM file path (recommended) or PEM content' } },
+        { key: 'webhook_secret', env: true, description: 'webhook 签名密钥（不配则 API-only）', descriptionI18n: { en: 'Webhook signing secret (API-only when omitted)' } },
+    ],
+    docsUrl: 'https://zhin.js.org/adapters/github',
+    readPermission: 'github:read',
+    writePermission: 'github:write',
+};

package/lib/console.d.ts

@@ -0,0 +1,8 @@
+/**
+ * GitHub Console RPC：运行状态 + endpoint 增删（原 `github endpoint` 聊天命令）。
+ *
+ * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
+ */
+import { type AdapterConsoleResources } from 'zhin.js/adapter';
+import type { PluginConsoleRpc } from 'zhin.js';
+export declare function createGithubConsoleRpc(resources: AdapterConsoleResources, getConfig: () => unknown): PluginConsoleRpc;

package/lib/console.js

@@ -0,0 +1,16 @@
+/**
+ * GitHub Console RPC：运行状态 + endpoint 增删（原 `github endpoint` 聊天命令）。
+ *
+ * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
+ */
+import { createAdapterConsoleRpc } from 'zhin.js/adapter';
+import { githubRuntimeStateToken } from './github-runtime-state.js';
+import { githubConsoleSpec } from './console-spec.js';
+export function createGithubConsoleRpc(resources, getConfig) {
+    const state = resources.use(githubRuntimeStateToken);
+    return createAdapterConsoleRpc({
+        ...githubConsoleSpec,
+        running: () => state.endpoints.values(),
+        getConfig,
+    }, resources);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-github",
-  "version": "1.1.17",
+  "version": "1.1.18",
   "description": "Zhin.js GitHub adapter for Plugin Runtime (App auth + webhook)",
   "type": "module",
   "main": "./lib/index.js",
@@ -39,25 +39,28 @@
     "directory": "plugins/adapters/github"
   },
   "dependencies": {
-    "@zhin.js/adapter": "1.1.24",
+    "@zhin.js/adapter": "1.1.25",
     "@zhin.js/agent-feature": "1.1.10",
-    "@zhin.js/core": "1.1.52",
+    "@zhin.js/client": "1.1.21",
+    "@zhin.js/console-contract": "1.1.3",
+    "@zhin.js/core": "1.1.53",
     "@zhin.js/feature-kit": "1.1.9",
     "@zhin.js/host-http": "1.1.11",
-    "@zhin.js/im-contract": "1.1.8",
+    "@zhin.js/im-contract": "1.1.9",
     "@zhin.js/logger": "1.1.2",
+    "@zhin.js/page": "1.1.10",
     "@zhin.js/skill": "1.1.10",
-    "@zhin.js/tool": "1.1.11"
+    "@zhin.js/tool": "1.1.12"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/adapter": "^1.1.24",
-    "@zhin.js/agent": "^1.1.43",
+    "@zhin.js/adapter": "^1.1.25",
+    "@zhin.js/agent": "^1.1.44",
     "@zhin.js/command": "^1.1.11",
-    "@zhin.js/core": "^1.1.52",
+    "@zhin.js/core": "^1.1.53",
     "@zhin.js/host-http": "^1.1.11",
     "@zhin.js/prompt-section": "^1.1.9",
-    "zhin.js": "^1.1.17"
+    "zhin.js": "^1.1.18"
   },
   "peerDependenciesMeta": {
     "@zhin.js/agent": {
@@ -81,13 +84,14 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "@zhin.js/agent": "1.1.43",
+    "@zhin.js/agent": "1.1.44",
     "@zhin.js/prompt-section": "1.1.9",
-    "zhin.js": "1.1.17"
+    "zhin.js": "1.1.18"
   },
   "files": [
     "adapters",
     "commands",
+    "pages",
     "plugin.js",
     "schema.json",
     "src",
@@ -130,6 +134,10 @@
       {
         "package": "@zhin.js/agent-feature",
         "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/page",
+        "api": "^1.0.0"
       }
     ],
     "plugins": []

package/pages/index/index.js

@@ -0,0 +1,15 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { definePage } from '@zhin.js/console-contract';
+import { createAdapterConsolePage } from '@zhin.js/client';
+export const meta = definePage({
+    title: 'GitHub',
+    titleI18n: { en: 'GitHub' },
+    icon: 'Github',
+    order: 63,
+    requiredPermissions: ['github:read'],
+});
+/**
+ * Convention page: `pages/index/index.ts` → `/github`（插件路径）。
+ * 连接状态、连接测试、endpoint 增删；登录待办来自 LoginAssist（ICQQ 等）。
+ */
+export default createAdapterConsolePage('github');

package/pages/index/index.ts

@@ -0,0 +1,16 @@
+import { definePage } from '@zhin.js/console-contract';
+import { createAdapterConsolePage } from '@zhin.js/client';
+
+export const meta = definePage({
+  title: 'GitHub',
+  titleI18n: { en: 'GitHub' },
+  icon: 'Github',
+  order: 63,
+  requiredPermissions: ['github:read'],
+});
+
+/**
+ * Convention page: `pages/index/index.ts` → `/github`（插件路径）。
+ * 连接状态、连接测试、endpoint 增删；登录待办来自 LoginAssist（ICQQ 等）。
+ */
+export default createAdapterConsolePage('github');

package/plugin.js

@@ -1,8 +1,9 @@
 // Generated by build-plugin-runtime-entries.mjs. Do not edit.
 import { createEndpointRuntimeState } from 'zhin.js/adapter';
-import { definePlugin, databaseHostToken } from 'zhin.js';
+import { definePlugin, databaseHostToken, pluginConsoleRpcToken } from 'zhin.js';
 import { githubRuntimeStateToken } from "./lib/github-runtime-state.js";
 import { defineGithubOauthUsersTable } from "./lib/oauth-users.js";
+import { createGithubConsoleRpc } from "./lib/console.js";
 /**
  * github_subscriptions — repo event subscriptions per chat channel
  * (used by github_subscriptions agent tool; schema is registered through DatabaseHost).
@@ -29,6 +30,7 @@ export default definePlugin({
     setup(context) {
         // 运行中 endpoint 注册表（github endpoint list 的"运行中"数据源）
         context.resources.provide(githubRuntimeStateToken, createEndpointRuntimeState());
+        context.resources.provide(pluginConsoleRpcToken, createGithubConsoleRpc(context.resources, () => context.config.get()));
         if (context.resources.has(databaseHostToken)) {
             const host = context.resources.use(databaseHostToken);
             defineGithubOauthUsersTable(host);

package/src/console-spec.ts

@@ -0,0 +1,17 @@
+/**
+ * GitHub Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+
+export const githubConsoleSpec = {
+  adapterKey: 'github',
+  adapterDisplayName: 'GitHub',
+  fields: [
+    { key: 'app_id', required: true, env: true, description: 'GitHub App ID' },
+    { key: 'private_key', required: true, secret: true, description: 'PEM 文件路径（推荐，如 ./data/xxx.pem）或 PEM 内容', descriptionI18n: { en: 'PEM file path (recommended) or PEM content' } },
+    { key: 'webhook_secret', env: true, description: 'webhook 签名密钥（不配则 API-only）', descriptionI18n: { en: 'Webhook signing secret (API-only when omitted)' } },
+  ] as readonly AdapterConsoleField[],
+  docsUrl: 'https://zhin.js.org/adapters/github',
+  readPermission: 'github:read',
+  writePermission: 'github:write',
+} as const;

package/src/console.ts

@@ -0,0 +1,21 @@
+/**
+ * GitHub Console RPC：运行状态 + endpoint 增删（原 `github endpoint` 聊天命令）。
+ *
+ * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
+ */
+import { createAdapterConsoleRpc, type AdapterConsoleResources } from 'zhin.js/adapter';
+import type { PluginConsoleRpc } from 'zhin.js';
+import { githubRuntimeStateToken } from './github-runtime-state.js';
+import { githubConsoleSpec } from './console-spec.js';
+
+export function createGithubConsoleRpc(
+  resources: AdapterConsoleResources,
+  getConfig: () => unknown,
+): PluginConsoleRpc {
+  const state = resources.use(githubRuntimeStateToken);
+  return createAdapterConsoleRpc({
+    ...githubConsoleSpec,
+    running: () => state.endpoints.values(),
+    getConfig,
+  }, resources);
+}