@zhin.js/adapter-kook 1.1.19 → 1.1.21

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @zhin.js/adapter-kook
 
+## 1.1.21
+
+### Patch Changes
+
+- af8f803: Use the current Endpoint's platform profile for Agent account identity, with per-field configured fallbacks and scoped, identity-approved profile tools. Keep SOUL first-person and independent of account names. Profile ports preserve the source Client, cancellation, truthful update outcomes and private image authority.
+
+  Adapter Feature API 2.1 and Tool Feature API 1.1 describe the additive profile requirements; new Core, official adapters and generated plugins declare the corresponding floors. Existing compatible API-2.0/API-1.0 plugins remain accepted by the newer providers. npm releases remain patch.
+
+  Private IM assets now bind to the full canonical conversation and principal. Existing IM asset records that contain only the earlier lossy hash remain on disk until their original expiry, but cannot be safely rebound; recapture them. No automatic file deletion, platform profile mutation or workspace SOUL rewrite occurs during upgrade.
+
+- Updated dependencies [b88e988]
+- Updated dependencies [f78eb84]
+- Updated dependencies [c15cef9]
+- Updated dependencies [b0c02a2]
+- Updated dependencies [af8f803]
+- Updated dependencies [26fda97]
+- Updated dependencies [976886c]
+- Updated dependencies [032dc96]
+  - @zhin.js/adapter@1.1.27
+  - @zhin.js/client@1.1.23
+  - @zhin.js/im-contract@1.1.10
+  - @zhin.js/core@1.1.55
+  - @zhin.js/tool@1.1.14
+  - @zhin.js/page@1.1.13
+  - @zhin.js/host-http@1.1.13
+  - @zhin.js/agent-feature@1.1.12
+  - @zhin.js/feature-kit@1.1.11
+  - @zhin.js/permission@1.1.11
+  - @zhin.js/skill@1.1.12
+
+## 1.1.20
+
+### Patch Changes
+
+- Updated dependencies [5e878ba]
+  - @zhin.js/page@1.1.12
+
 ## 1.1.19
 
 ### Patch Changes

package/lib/endpoint.js

@@ -10,6 +10,7 @@ import { RuntimeKookClient, kookWebsocketClientOptions, kookWebhookClientOptions
 import { recallKookMessage, sendKookOutbound } from './outbound.js';
 import { KookSenderRoleResolver } from './sender-roles.js';
 import { receiveKookSideEvent } from './side-event-dispatch.js';
+import { createKookSelfProfile } from './self-profile.js';
 /** 入站 message.receive 载荷：规范角色 owner/admin 进 roles，原始角色 id 进 permissions。 */
 function kookInboundPayload(endpointId, conversation, msg, projection, selfId) {
     return {
@@ -58,6 +59,7 @@ export class KookWebsocketEndpoint extends RuntimeKookClient {
             stop: () => this.#stopFramework(), send: request => this.#sendFramework(request),
             name: options.config.id, get transportState() { return endpoint.#transportState; },
             management: this.#management, control: this.#control,
+            profile: createKookSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
     }
     get #transportState() {
@@ -206,6 +208,7 @@ export class KookWebhookEndpoint extends RuntimeKookClient {
             start: signal => this.#startFramework(signal), open: () => this.#openFramework(), close: () => this.#closeFramework(),
             stop: () => this.#stopFramework(), send: request => this.#sendFramework(request), name: options.config.id,
             management: this.#management, control: this.#control,
+            profile: createKookSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
     }
     /** Used by webhook handler. */

package/lib/protocol.d.ts

@@ -1,4 +1,4 @@
-/** KOOK protocol helpers. Canonicalization is owned by Core. */
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 import type { IncomingMessage } from 'node:http';
 import { type ConversationRef } from '@zhin.js/im-contract';
 import type { Locale } from 'zhin.js/i18n';
@@ -10,7 +10,7 @@ export declare enum KookPermission {
     ChannelAdmin = 5
 }
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface KookEndpointConfig {
+export interface KookEndpointConfig extends EndpointProfileConfiguration {
     readonly apiProxy?: import('./api-proxy.js').KookApiProxy;
     readonly streamProxy?: import('./stream-proxy.js').KookStreamProxy;
     readonly id: string;

package/lib/self-profile.d.ts

@@ -0,0 +1,9 @@
+import { type EndpointProfile } from 'zhin.js/adapter';
+import type { RuntimeKookClient } from './ws.js';
+interface KookSelfProfileOptions {
+    readonly client: Pick<RuntimeKookClient, 'getSelfInfo'>;
+    readonly reportAccount: (id: string) => void;
+}
+/** Bot account profile facts from the SDK's existing /user/me method. */
+export declare function createKookSelfProfile({ client, reportAccount }: KookSelfProfileOptions): EndpointProfile;
+export {};

package/lib/self-profile.js

@@ -0,0 +1,14 @@
+import { createEndpointOperation } from 'zhin.js/adapter';
+/** Bot account profile facts from the SDK's existing /user/me method. */
+export function createKookSelfProfile({ client, reportAccount }) {
+    return Object.freeze({
+        writableFields: Object.freeze([]),
+        async read({ signal }) {
+            const self = await createEndpointOperation({ signal }).prepare(() => client.getSelfInfo());
+            if (!self?.id || typeof self.username !== 'string')
+                throw new Error('KOOK returned an incomplete self profile');
+            reportAccount(self.id);
+            return { nickname: self.username, ...(typeof self.avatar === 'string' ? { avatar: self.avatar } : {}) };
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-kook",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Zhin.js KOOK adapter for Plugin Runtime (WebSocket gateway or Webhook)",
   "type": "module",
   "main": "./lib/index.js",
@@ -33,26 +33,26 @@
   },
   "dependencies": {
     "kook-client": "^1.0.5",
-    "@zhin.js/adapter": "1.1.26",
-    "@zhin.js/agent-feature": "1.1.11",
-    "@zhin.js/client": "1.1.22",
+    "@zhin.js/adapter": "1.1.27",
+    "@zhin.js/agent-feature": "1.1.12",
+    "@zhin.js/client": "1.1.23",
     "@zhin.js/console-contract": "1.1.3",
-    "@zhin.js/core": "1.1.54",
-    "@zhin.js/feature-kit": "1.1.10",
-    "@zhin.js/host-http": "1.1.12",
-    "@zhin.js/im-contract": "1.1.9",
+    "@zhin.js/core": "1.1.55",
+    "@zhin.js/feature-kit": "1.1.11",
+    "@zhin.js/host-http": "1.1.13",
+    "@zhin.js/im-contract": "1.1.10",
     "@zhin.js/logger": "1.1.2",
-    "@zhin.js/page": "1.1.11",
-    "@zhin.js/permission": "1.1.10",
-    "@zhin.js/skill": "1.1.11",
-    "@zhin.js/tool": "1.1.13"
+    "@zhin.js/page": "1.1.13",
+    "@zhin.js/permission": "1.1.11",
+    "@zhin.js/skill": "1.1.12",
+    "@zhin.js/tool": "1.1.14"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/adapter": "^1.1.26",
-    "@zhin.js/command": "^1.1.12",
-    "@zhin.js/core": "^1.1.54",
-    "zhin.js": "^1.1.19"
+    "@zhin.js/adapter": "^1.1.27",
+    "@zhin.js/command": "^1.1.13",
+    "@zhin.js/core": "^1.1.55",
+    "zhin.js": "^1.1.20"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {
@@ -70,8 +70,8 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
     "zod": "^4.4.3",
-    "@zhin.js/host-http": "1.1.12",
-    "zhin.js": "1.1.19"
+    "@zhin.js/host-http": "1.1.13",
+    "zhin.js": "1.1.20"
   },
   "files": [
     "adapters",
@@ -103,7 +103,7 @@
     "features": [
       {
         "package": "@zhin.js/adapter",
-        "api": "^2.0.0"
+        "api": "^2.1.0"
       },
       {
         "package": "@zhin.js/command",
@@ -111,7 +111,7 @@
       },
       {
         "package": "@zhin.js/tool",
-        "api": "^1.0.0"
+        "api": "^1.1.0"
       },
       {
         "package": "@zhin.js/skill",

package/schema.json

@@ -212,6 +212,27 @@
               }
             },
             "description": "Optional fixed loopback TCP route for www.kookapp.cn JSON API only; verified TLS remains enabled."
+          },
+          "nickname": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "账号昵称兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account nickname"
+              }
+            }
+          },
+          "profile": {
+            "$ref": "#/$defs/selfProfileFallback",
+            "description": "账号资料兜底",
+            "x-i18n": {
+              "en": {
+                "description": "Fallback account profile"
+              }
+            }
           }
         },
         "required": [
@@ -234,9 +255,93 @@
           "description": "Command prefix. The default empty string allows unprefixed commands; '/' requires a leading slash. Each endpoints[i] can override it."
         }
       }
+    },
+    "nickname": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "账号昵称兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account nickname"
+        }
+      }
+    },
+    "profile": {
+      "$ref": "#/$defs/selfProfileFallback",
+      "description": "账号资料兜底",
+      "x-i18n": {
+        "en": {
+          "description": "Fallback account profile"
+        }
+      }
     }
   },
   "required": [
     "endpoints"
-  ]
+  ],
+  "$defs": {
+    "selfProfileFallback": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "gender": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "enum": [
+            "male",
+            "female",
+            "other",
+            "unknown",
+            null
+          ]
+        },
+        "age": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 0
+        },
+        "birthday": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"
+        },
+        "signature": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "avatar": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(https?://[^\\s/?#]+(?:[/?#].*)?|)$"
+        },
+        "interests": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "bio": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    }
+  }
 }

package/src/endpoint.ts

@@ -42,6 +42,7 @@ import {
 import { recallKookMessage, sendKookOutbound } from './outbound.js';
 import { KookSenderRoleResolver, type KookSenderRoleProjection } from './sender-roles.js';
 import { receiveKookSideEvent } from './side-event-dispatch.js';
+import { createKookSelfProfile } from './self-profile.js';
 
 export interface KookEndpointOptions {
   readonly id: CapabilityId;
@@ -105,6 +106,7 @@ export class KookWebsocketEndpoint extends RuntimeKookClient implements Endpoint
       stop: () => this.#stopFramework(), send: request => this.#sendFramework(request),
       name: options.config.id, get transportState() { return endpoint.#transportState; },
       management: this.#management, control: this.#control,
+      profile: createKookSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
   }
 
@@ -266,6 +268,7 @@ export class KookWebhookEndpoint extends RuntimeKookClient implements Endpoint {
       start: signal => this.#startFramework(signal), open: () => this.#openFramework(), close: () => this.#closeFramework(),
       stop: () => this.#stopFramework(), send: request => this.#sendFramework(request), name: options.config.id,
       management: this.#management, control: this.#control,
+      profile: createKookSelfProfile({ client: this, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
   }
 

package/src/protocol.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 /** KOOK protocol helpers. Canonicalization is owned by Core. */
 
 import { createDecipheriv, timingSafeEqual } from 'node:crypto';
@@ -28,7 +29,7 @@ export enum KookPermission {
 }
 
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface KookEndpointConfig {
+export interface KookEndpointConfig extends EndpointProfileConfiguration {
   readonly apiProxy?: import('./api-proxy.js').KookApiProxy;
   readonly streamProxy?: import('./stream-proxy.js').KookStreamProxy;
   readonly id: string;

package/src/self-profile.ts

@@ -0,0 +1,20 @@
+import { createEndpointOperation, type EndpointProfile } from 'zhin.js/adapter';
+import type { RuntimeKookClient } from './ws.js';
+
+interface KookSelfProfileOptions {
+  readonly client: Pick<RuntimeKookClient, 'getSelfInfo'>;
+  readonly reportAccount: (id: string) => void;
+}
+
+/** Bot account profile facts from the SDK's existing /user/me method. */
+export function createKookSelfProfile({ client, reportAccount }: KookSelfProfileOptions): EndpointProfile {
+  return Object.freeze<EndpointProfile>({
+    writableFields: Object.freeze([]),
+    async read({ signal }) {
+      const self = await createEndpointOperation({ signal }).prepare(() => client.getSelfInfo());
+      if (!self?.id || typeof self.username !== 'string') throw new Error('KOOK returned an incomplete self profile');
+      reportAccount(self.id);
+      return { nickname: self.username, ...(typeof self.avatar === 'string' ? { avatar: self.avatar } : {}) };
+    },
+  });
+}