@zhin.js/adapter-kook 1.1.18 → 1.1.19

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @zhin.js/adapter-kook
 
+## 1.1.19
+
+### Patch Changes
+
+- 2c3610a: Move account lifecycle ownership into the generic Adapter base and let native Endpoints retain their SDK Client inheritance. Infer platform-specific operation Sessions from a single adapter registry while preserving command parameter, option, configuration and factory inference.
+
+  Bind message replies, management ports, login challenges and Agent cancellation to the captured account incarnation. Persist runtime account intent with encrypted, revision-checked Host storage; keep account management independent of Root process restarts. Require explicit operator confirmation before importing existing accounts, and give replacement accounts a new identity without inheriting previous Sessions.
+
+  Expose account save, start, stop, update and replacement through the existing adapter Console, with exact account ownership, truthful pending/unknown outcomes and no startup configuration or environment-file rewrites.
+
+  Complete the target migration across every adapter, the public authoring API, generators, examples and Console. This intentionally removes the old create factory, inheritable Endpoint/ClientEndpoint classes, Client descriptors and file-rewrite account management; plugin authors must use createAdapter, native Client inheritance and the single AdapterRegistry. Satori and OneBot12 require explicit platform/userId selection, and WeCom requires a separate agentId.
+
+  Verify opaque credential changes before the same configuration snapshot is committed. Drain admitted native callbacks across close/rollback, cancel target work on stop, and keep raw transport parsing, platform ACK timing and SDK native methods under their existing owners. Account metadata conceals credentials carried in URLs.
+
+- a9f4e48: PATCH COMPATIBILITY CUTOVER: this batch intentionally changes plugin APIs. The maintainer explicitly chose patch releases with declared version boundaries. Upgrade the complete tested dependency set; patch numbering does not promise compatibility with the removed interfaces.
+
+  The first planned floors are zhin.js 1.1.19, Core 1.1.54, Adapter 1.1.26, FeatureKit 1.1.10, Plugin Runtime 1.1.18, Runtime/Isolate 1.1.16 and Agent 1.1.45. Keep old-interface plugins with the earlier locked stack until they are migrated. Adapter's independent Feature API changes from 1.0.0 to 2.0.0; official consumers declare ^2.0.0. Existing Feature API admission rejects explicitly incompatible ranges; omitted API metadata keeps its existing behavior and does not certify compatibility. Runtime engine and patch-only release gates remain unchanged.
+
+  Use the native-Client Adapter target contract, canonical FeatureKit AdapterRegistry augmentation and named Endpoint control/management requests. Route message controls from canonical message/conversation refs; retain exact source authority and propagate caller/account/explicit-Root-stop cancellation. Replace removed Agent activity feedback exports with source-bound feedback. HMR pause/resume belongs to concrete plugin instances; plugins choose accepted-work policy without changing Controller commit/rollback authority. Cooperative worker/process control cancellation does not kill an isolate or reopen retired business admission.
+
+  Provide authenticated historical-data preview, exact selected binding, transactional application, authoritative inspection and explicit resumption, including active games. Preserve before-images and journals; never replay an unconfirmed effect, infer an account from an alias, or reuse historical permission grants. Owner V2 approvals remain inactive legacy data, while new writes use V3. Rollback requires matching software, lockfile and verified data; installing old code alone cannot read a new V3 approval file. Conflicting after-images are never overwritten.
+
+  See docs/plans/adapter-operation-version-boundaries.md and the Chinese/English upgrade guide for the complete version inventory, custom-plugin changes, acceptance and recovery sequence. These code and metadata changes do not authorize merging, publication, deployment, login, production migration or removal of installed workspace patches.
+
+- Updated dependencies [2c3610a]
+- Updated dependencies [a9f4e48]
+- Updated dependencies [f8505b0]
+- Updated dependencies [2c3610a]
+  - @zhin.js/adapter@1.1.26
+  - @zhin.js/feature-kit@1.1.10
+  - @zhin.js/core@1.1.54
+  - @zhin.js/host-http@1.1.12
+  - @zhin.js/client@1.1.22
+  - @zhin.js/page@1.1.11
+  - @zhin.js/agent-feature@1.1.11
+  - @zhin.js/skill@1.1.11
+  - @zhin.js/tool@1.1.13
+  - @zhin.js/permission@1.1.10
+
 ## 1.1.18
 
 ### Patch Changes

package/README.md

@@ -20,13 +20,14 @@ pnpm add @zhin.js/adapter-kook
 ## Plugin Runtime
 
 - `@zhin.js/adapter` — 约定式 `adapters/kook/index.ts`（`defineAdapter`）
-- `@zhin.js/core` — `Endpoint.emit(...)` 入站、`outboundMessageToken` 出站
+- `@zhin.js/core` — `endpoint[endpointSpec].events` 入站、`outboundMessageToken` 出站
 - `@zhin.js/host-http` — Webhook 模式 POST 路由（WebSocket 不需要）
 - `zhin.js` — `plugin.ts`（`definePlugin`）
 - 配置经插件 `schema.json` 落到顶层 `<instanceKey>`
 - **WebSocket 路径无需** `@zhin.js/host-http` / `@zhin.js/host-router`
 
-入站：`gateway.receive({ conversation, message, content, sender, metadata })`（ConversationRef：`channel` 频道消息带 guild `parent`，`private` 私聊）  
+入站：`endpoint[endpointSpec].events.emit('message.receive', { conversation, message, content, sender, metadata })`（ConversationRef：`channel` 频道消息带 guild `parent`，`private` 私聊）
+
 出站：`send({ conversation, payload })` → `sendChannelMsg` / `sendPrivateMsg`
 
 ## 前置条件
@@ -83,7 +84,7 @@ kook:
       # encrypt_key: ${KOOK_ENCRYPT_KEY}   # 启用消息加密时必填
 ```
 
-Host 需注入 `httpHostToken`。Challenge（`type: 255`）会校验 `verify_token` 并回显 `challenge`；普通事件经 `gateway.receive` 入站，出站仍走 KOOK HTTP API。
+Host 需注入 `httpHostToken`。Challenge（`type: 255`）会校验 `verify_token` 并回显 `challenge`；普通事件经 `endpoint[endpointSpec].events.emit` 入站，出站仍走 KOOK HTTP API。
 
 ## AI 工具（Skill）
 
@@ -110,11 +111,17 @@ canonical `share` 映射为含标题、描述/正文与“打开链接”按钮
 启动后打开 Console 的「KOOK」页（地址 `/kook`），可以：
 
 - 查看运行中的连接、点「测试连接」做连通性诊断；
-- 增删 `plugins.kook.endpoints`（凭据写入 `.env`，配置里只保留 `${ENV}` 引用）；
+- 在账号库保存、修改、启动、停止、替换或删除该 Adapter 的账号；新增仅保存，不创建 SDK Client，需手动启动；
 - 如果适配器要求登录，页面会显示 LoginAssist 的扫码 / 滑块 / 设备确认待办；
 
 读取需要 `kook:read`，写操作需要 `kook:write`；管理员 full token 不受限。页面里的「添加 endpoint」等价于原来的 `kook endpoint add`。
 
+首次修改启动配置里的既有账号前，管理员必须核对清单并确认一次迁移。原 canonical 身份与历史保留，完整账号配置加密进入 Host 数据库；此后账号管理只写数据库，不修改启动文件或 `.env`，不重启进程。没有持久化账号端口的环境可使用静态配置连接，动态写操作明确不可用。
+
+启停意图在进程重启后恢复。停止或删除会取消并关闭目标账号的在途操作，其他账号继续运行；删除保留历史。已启动账号的连接配置更新先关闭旧 incarnation，再仅重连该账号；平台身份变化按替换处理，分配新内部身份、保留旧历史，新账号不继承旧 Session、个人设置或启动意图。提交结果未知时先刷新核实，不自动重复 CAS 或平台操作。
+
+KOOK 的 token 更新通过 SDK 只读 GET `/v3/user/me` 核验真实用户 ID；核验只创建不连网关的 API Client，不做网关连接或缓存预载。verify_token / encrypt_key 无法据此证明身份，变更须使用显式账号替换。
+
 ## 故障排查
 
 | 现象 | 排查 |

package/adapters/kook/index.js

@@ -4,10 +4,8 @@
  * Implementation lives under `src/` (endpoint / webhook / ws / protocol).
  */
 import { defineAdapter } from 'zhin.js/adapter';
-import { httpHostToken } from '@zhin.js/host-http';
-import { KookWebhookEndpoint, KookWebsocketEndpoint, } from "../../lib/endpoint.js";
-import { resolveKookConfig, } from "../../lib/protocol.js";
-import { kookRuntimeStateToken } from "../../lib/kook-runtime-state.js";
+import { KookAdapter } from "../../lib/adapter.js";
+import {} from "../../lib/protocol.js";
 export { KookWebhookEndpoint, KookWebsocketEndpoint, } from "../../lib/endpoint.js";
 export default defineAdapter({
     capabilities: ['inbound', 'outbound'],
@@ -19,23 +17,5 @@ export default defineAdapter({
         interactive: 'native',
         markdown: 'native',
     },
-    create(context) {
-        const config = resolveKookConfig(context.config);
-        // 注册到插件运行时状态（kook endpoint list 的"运行中"数据源）
-        context.use(kookRuntimeStateToken).endpoints.set(config.id, {
-            id: config.id,
-            mode: config.connection,
-        });
-        if (config.connection === 'webhook') {
-            return new KookWebhookEndpoint({
-                id: context.id,
-                http: context.use(httpHostToken),
-                config,
-            });
-        }
-        return new KookWebsocketEndpoint({
-            id: context.id,
-            config,
-        });
-    },
+    createAdapter: context => new KookAdapter(context),
 });

package/adapters/kook/index.ts

@@ -3,16 +3,10 @@
  * Implementation lives under `src/` (endpoint / webhook / ws / protocol).
  */
 import { defineAdapter } from 'zhin.js/adapter';
-import { httpHostToken } from '@zhin.js/host-http';
+import { KookAdapter } from '../../src/adapter.js';
 import {
-  KookWebhookEndpoint,
-  KookWebsocketEndpoint,
-} from '../../src/endpoint.js';
-import {
-  resolveKookConfig,
   type KookEndpointConfig,
 } from '../../src/protocol.js';
-import { kookRuntimeStateToken } from '../../src/kook-runtime-state.js';
 
 export {
   KookWebhookEndpoint,
@@ -22,7 +16,7 @@ export type {
   KookEndpointOptions,
   KookWebhookEndpointOptions,
 } from '../../src/endpoint.js';
-export type { CreateKookClient, KookClientTransport } from '../../src/ws.js';
+export type { KookClientTransport } from '../../src/ws.js';
 
 export default defineAdapter<KookEndpointConfig>({
   capabilities: ['inbound', 'outbound'],
@@ -34,23 +28,5 @@ export default defineAdapter<KookEndpointConfig>({
     interactive: 'native',
     markdown: 'native',
   },
-  create(context) {
-    const config = resolveKookConfig(context.config);
-    // 注册到插件运行时状态（kook endpoint list 的"运行中"数据源）
-    context.use(kookRuntimeStateToken).endpoints.set(config.id, {
-      id: config.id,
-      mode: config.connection,
-    });
-    if (config.connection === 'webhook') {
-      return new KookWebhookEndpoint({
-        id: context.id,
-        http: context.use(httpHostToken),
-        config,
-      });
-    }
-    return new KookWebsocketEndpoint({
-      id: context.id,
-      config,
-    });
-  },
+  createAdapter: context => new KookAdapter(context),
 });

package/commands/kook/endpoint/definition.js

@@ -5,7 +5,6 @@
  */
 import { createEndpointCommands } from 'zhin.js/adapter';
 import { defineCommand } from 'zhin.js/command';
-import { kookRuntimeStateToken } from "../../../lib/kook-runtime-state.js";
 export const kookEndpointCommands = createEndpointCommands({
     adapterKey: 'kook',
     adapterDisplayName: 'KOOK',
@@ -14,6 +13,5 @@ export const kookEndpointCommands = createEndpointCommands({
         { key: 'encrypt_key', env: true, description: 'webhook 加密密钥（connection: webhook）', descriptionI18n: { en: "Webhook encryption secret (connection: webhook)" } },
         { key: 'verify_token', env: true, description: 'webhook 验证 token（connection: webhook）', descriptionI18n: { en: "Webhook verification token (connection: webhook)" } },
     ],
-    running: (use) => use(kookRuntimeStateToken).endpoints.values(),
     describeEntry: (entry) => `token: ${String(entry.token)}`,
 }, defineCommand);

package/commands/kook/endpoint/definition.ts

@@ -4,7 +4,6 @@
  */
 import { createEndpointCommands } from 'zhin.js/adapter';
 import { defineCommand } from 'zhin.js/command';
-import { kookRuntimeStateToken } from '../../../src/kook-runtime-state.js';
 
 export const kookEndpointCommands = createEndpointCommands({
   adapterKey: 'kook',
@@ -14,6 +13,5 @@ export const kookEndpointCommands = createEndpointCommands({
     { key: 'encrypt_key', env: true, description: 'webhook 加密密钥（connection: webhook）', descriptionI18n: { en: "Webhook encryption secret (connection: webhook)" } },
     { key: 'verify_token', env: true, description: 'webhook 验证 token（connection: webhook）', descriptionI18n: { en: "Webhook verification token (connection: webhook)" } },
   ],
-  running: (use) => use(kookRuntimeStateToken).endpoints.values(),
   describeEntry: (entry) => `token: ${String(entry.token)}`,
 }, defineCommand);

package/lib/adapter.d.ts

@@ -0,0 +1,14 @@
+import { Adapter, type AdapterContext, type EndpointCreationContext } from 'zhin.js/adapter';
+import { KookWebhookEndpoint, KookWebsocketEndpoint } from './endpoint.js';
+import { type KookEndpointConfig } from './protocol.js';
+import type { KookClientEventMap } from './client.js';
+export declare class KookAdapter extends Adapter<KookWebhookEndpoint | KookWebsocketEndpoint, KookEndpointConfig, KookClientEventMap> {
+    private readonly context;
+    constructor(context: AdapterContext<KookEndpointConfig>);
+    get configurationIdentityFields(): readonly string[];
+    get configurationIdentityProbeFields(): readonly string[];
+    get configurationUpdateFields(): readonly string[];
+    protected validateConfiguration(input: KookEndpointConfig): void;
+    protected identifyConfiguration(input: KookEndpointConfig, signal: AbortSignal, changedFields: readonly string[]): Promise<string | undefined>;
+    protected createEndpoint(input: KookEndpointConfig, execution: EndpointCreationContext): KookWebhookEndpoint | KookWebsocketEndpoint;
+}

package/lib/adapter.js

@@ -0,0 +1,44 @@
+import { Adapter } from 'zhin.js/adapter';
+import { httpHostToken } from '@zhin.js/host-http';
+import { KookWebhookEndpoint, KookWebsocketEndpoint } from './endpoint.js';
+import { RuntimeKookClient, kookWebhookClientOptions, kookWebsocketClientOptions } from './ws.js';
+import { resolveKookConfig } from './protocol.js';
+export class KookAdapter extends Adapter {
+    context;
+    constructor(context) {
+        super();
+        this.context = context;
+    }
+    get configurationIdentityFields() { return ['id']; }
+    get configurationIdentityProbeFields() { return ['token', 'verify_token', 'encrypt_key']; }
+    get configurationUpdateFields() {
+        return ['token', 'verify_token', 'encrypt_key', 'connection',
+            'webhookPath', 'data_dir', 'timeout', 'max_retry', 'ignore', 'logLevel', 'apiProxy', 'apiProxy.port',
+            'streamProxy', 'streamProxy.port', 'streamProxy.serverName'];
+    }
+    validateConfiguration(input) { resolveKookConfig(input); }
+    async identifyConfiguration(input, signal, changedFields) {
+        if (changedFields.some(field => field !== 'token'))
+            return undefined;
+        const config = resolveKookConfig(input);
+        const options = config.connection === 'websocket' ? kookWebsocketClientOptions(config) : kookWebhookClientOptions(config);
+        // Webhook receiver construction has no gateway socket or login; only GET /v3/user/me is issued.
+        const client = new RuntimeKookClient({ ...options, mode: 'webhook' }, undefined, config.apiProxy);
+        client.request.interceptors.request.use(request => { request.signal = signal; return request; });
+        try {
+            const me = await client.getSelfInfo();
+            if (typeof me?.id !== 'string' || !me.id.trim())
+                throw new Error('KOOK identity response is incomplete');
+            return JSON.stringify(['kook', me.id]);
+        }
+        finally {
+            await client.disconnect();
+        }
+    }
+    createEndpoint(input, execution) {
+        const config = resolveKookConfig(input);
+        return config.connection === 'webhook'
+            ? new KookWebhookEndpoint({ id: execution.canonicalId, config, http: this.context.use(httpHostToken) })
+            : new KookWebsocketEndpoint({ id: execution.canonicalId, config });
+    }
+}

package/lib/client.d.ts

@@ -1,11 +1,10 @@
-import type { KookClientTransport } from './ws.js';
-export type KookClientEventMap = Record<string, unknown>;
+import type { EventMap } from 'kook-client';
+import type { KookAdapter } from './adapter.js';
+export type KookClientEventMap = {
+    readonly [K in keyof EventMap]: EventMap[K] extends (event: infer E, ...args: never[]) => unknown ? E : never;
+};
 declare module '@zhin.js/feature-kit' {
-    interface AdapterClientRegistry {
-        readonly kook: {
-            readonly client: KookClientTransport;
-            readonly events: KookClientEventMap;
-        };
+    interface AdapterRegistry {
+        readonly kook: KookAdapter;
     }
 }
-export declare const kookClient: import("@zhin.js/adapter").EndpointClientToken<KookClientTransport, KookClientEventMap>;

package/lib/client.js

@@ -1,2 +1 @@
-import { defineEndpointClient } from 'zhin.js/adapter';
-export const kookClient = defineEndpointClient('kook');
+export {};

package/lib/console-spec.js

@@ -5,6 +5,16 @@ export const kookConsoleSpec = {
         { key: 'token', required: true, env: true, description: 'KOOK bot token' },
         { key: 'encrypt_key', env: true, description: 'webhook 加密密钥（connection: webhook）', descriptionI18n: { en: 'Webhook encryption secret' } },
         { key: 'verify_token', env: true, description: 'webhook 验证 token（connection: webhook）', descriptionI18n: { en: 'Webhook verification token' } },
+        { key: 'connection', description: 'websocket or webhook' },
+        { key: 'webhookPath', description: 'Local webhook route' },
+        { key: 'data_dir', description: 'SDK data directory' },
+        { key: 'timeout', type: 'number', description: 'SDK request timeout' },
+        { key: 'max_retry', type: 'number', description: 'SDK configured retry count' },
+        { key: 'ignore', description: 'SDK inbound ignore setting: bot or self' },
+        { key: 'logLevel', description: 'SDK log level' },
+        { key: 'apiProxy.port', type: 'number', description: 'Configured API loopback proxy port' },
+        { key: 'streamProxy.port', type: 'number', description: 'Configured Gateway loopback proxy port' },
+        { key: 'streamProxy.serverName', description: 'Expected Gateway TLS hostname' },
     ],
     docsUrl: 'https://zhin.js.org/adapters/kook',
     readPermission: 'kook:read',

package/lib/console.d.ts

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

package/lib/console.js

@@ -4,13 +4,10 @@
  * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
  */
 import { createAdapterConsoleRpc } from 'zhin.js/adapter';
-import { kookRuntimeStateToken } from './kook-runtime-state.js';
 import { kookConsoleSpec } from './console-spec.js';
-export function createKookConsoleRpc(resources, getConfig) {
-    const state = resources.use(kookRuntimeStateToken);
+export function createKookConsoleRpc(getConfig) {
     return createAdapterConsoleRpc({
         ...kookConsoleSpec,
-        running: () => state.endpoints.values(),
         getConfig,
-    }, resources);
+    });
 }

package/lib/endpoint.d.ts

@@ -1,26 +1,20 @@
 import { type ConversationRef } from '@zhin.js/im-contract';
-import { Endpoint, type EndpointControl, type EndpointManagement, type EndpointSendRequest, type EndpointTransportState } from 'zhin.js/adapter';
+/**
+ * KookEndpoint — lifecycle, outbound, admit, OpenAPI helpers for agent tools.
+ */
+import { endpointSpec, type Endpoint, type EndpointSpecification, type EndpointManagement } from 'zhin.js/adapter';
 import type { HttpHost } from '@zhin.js/host-http';
 import type { CapabilityId } from 'zhin.js';
 import { type KookInboundMessage, type KookWebhookEventData, type ResolvedKookWebhookConfig, type ResolvedKookWebsocketConfig } from './protocol.js';
-import { type CreateKookClient, type KookClientTransport } from './ws.js';
+import { RuntimeKookClient, type KookClientTransport } from './ws.js';
 export interface KookEndpointOptions {
     readonly id: CapabilityId;
     readonly config: ResolvedKookWebsocketConfig;
-    readonly createClient?: CreateKookClient;
 }
-export declare class KookWebsocketEndpoint extends Endpoint<KookClientTransport> {
+export declare class KookWebsocketEndpoint extends RuntimeKookClient implements Endpoint {
     #private;
-    readonly management: EndpointManagement;
-    readonly control: EndpointControl;
+    readonly [endpointSpec]: EndpointSpecification;
     constructor(options: KookEndpointOptions);
-    get client(): KookClientTransport;
-    get transportState(): EndpointTransportState | undefined;
-    start(): Promise<void>;
-    open(): void;
-    close(): void;
-    stop(): Promise<void>;
-    send(request: EndpointSendRequest): Promise<string>;
     /** Test / internal: admit a normalized message when open. */
     admit(msg: KookInboundMessage): void;
     recallMessage(messageId: string, conversation?: ConversationRef): Promise<void>;
@@ -30,23 +24,15 @@ export interface KookWebhookEndpointOptions {
     readonly id: CapabilityId;
     readonly http: HttpHost;
     readonly config: ResolvedKookWebhookConfig;
-    readonly createClient?: CreateKookClient;
 }
-export declare class KookWebhookEndpoint extends Endpoint<KookClientTransport> {
+export declare class KookWebhookEndpoint extends RuntimeKookClient implements Endpoint {
     #private;
-    readonly management: EndpointManagement;
-    readonly control: EndpointControl;
+    readonly [endpointSpec]: EndpointSpecification;
     constructor(options: KookWebhookEndpointOptions);
-    get client(): KookClientTransport;
     /** Used by webhook handler. */
     get isOpen(): boolean;
-    get config(): ResolvedKookWebhookConfig;
+    get endpointConfig(): ResolvedKookWebhookConfig;
     get selfId(): string | undefined;
-    start(): Promise<void>;
-    open(): void;
-    close(): void;
-    stop(): Promise<void>;
-    send(request: EndpointSendRequest): Promise<string>;
     admitEvent(event: KookWebhookEventData): Promise<void>;
     /** Test / internal: admit a message when open. */
     admit(msg: KookInboundMessage): void;