@zhin.js/adapter-onebot12 1.1.20 → 1.1.21

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @zhin.js/adapter-onebot12
 
+## 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/page@1.1.13
+  - @zhin.js/host-http@1.1.13
+  - @zhin.js/feature-kit@1.1.11
+  - @zhin.js/skill@1.1.12
+
 ## 1.1.20
 
 ### Patch Changes

package/lib/protocol.d.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 /**
  * OneBot 12 protocol helpers (no legacy Adapter/Endpoint / segment-mapper).
  * Canonicalization is owned by gateway/core before endpoint.send.
@@ -5,7 +6,7 @@
  */
 import { type MediaRef, type ConversationRef } from '@zhin.js/im-contract';
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface OneBot12EndpointConfig {
+export interface OneBot12EndpointConfig extends EndpointProfileConfiguration {
     readonly platform: string;
     readonly userId: string;
     readonly connection?: 'ws' | 'webhook' | 'wss';

package/lib/self-profile.d.ts

@@ -0,0 +1,9 @@
+import type { EndpointProfile, PendingRpcRequest } from 'zhin.js/adapter';
+interface Onebot12SelfProfileOptions {
+    readonly call: (request: PendingRpcRequest) => Promise<unknown>;
+    readonly accountId: string;
+    readonly reportAccount: (id: string) => void;
+}
+/** The protocol caller already binds self={platform,user_id}; validate the returned account too. */
+export declare function createOnebot12SelfProfile({ call, accountId, reportAccount }: Onebot12SelfProfileOptions): EndpointProfile;
+export {};

package/lib/self-profile.js

@@ -0,0 +1,16 @@
+/** The protocol caller already binds self={platform,user_id}; validate the returned account too. */
+export function createOnebot12SelfProfile({ call, accountId, reportAccount }) {
+    return Object.freeze({
+        writableFields: Object.freeze([]),
+        async read({ signal }) {
+            const self = await call({ action: 'get_self_info', signal });
+            if (self?.user_id !== accountId)
+                throw new Error('OneBot12 returned another account profile');
+            const nickname = self.user_displayname || self.user_name;
+            if (typeof nickname !== 'string')
+                throw new Error('OneBot12 returned an incomplete self profile');
+            reportAccount(self.user_id);
+            return { nickname };
+        },
+    });
+}

package/lib/webhook.js

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 import { acceptHttpIngress } from 'imhelper';
 import { createEndpointSpecification, endpointSpec, createRecallEndpointControl, } from 'zhin.js/adapter';
 import { formatCompact, getLogger } from '@zhin.js/logger';
@@ -32,6 +33,7 @@ export class OneBot12WebhookEndpoint extends Onebot12Client {
             close: () => { this.#open = false; }, stop: () => this.#stop(),
             send: request => this.#send(request),
             management: this.#management, control: this.#control, content: this.#content,
+            profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
         this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
             void this[endpointSpec].events.run(() => {

package/lib/ws-endpoint.js

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 /**
  * OneBot12 WS client endpoint — outbound connect to OneBot implementation.
  */
@@ -42,6 +43,7 @@ export class OneBot12WsEndpoint extends Onebot12Client {
             send: request => this.#send(request),
             get transportState() { return readTransportState(); },
             management: this.#management, control: this.#control, content: this.#content,
+            profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
         this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
             void this[endpointSpec].events.run(() => {

package/lib/wss-endpoint.js

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 /**
  * OneBot12 reverse WSS endpoint — accepts inbound WebSocket from OneBot implementation.
  */
@@ -49,6 +50,7 @@ export class OneBot12WssEndpoint extends Onebot12Client {
             send: request => this.#send(request),
             get transportState() { return readTransportState(); },
             management: this.#management, control: this.#control, content: this.#content,
+            profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
         this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
             void this[endpointSpec].events.run(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-onebot12",
-  "version": "1.1.20",
+  "version": "1.1.21",
   "description": "Zhin.js OneBot 12 adapter for Plugin Runtime (WebSocket client)",
   "type": "module",
   "main": "./lib/index.js",
@@ -42,30 +42,30 @@
     "@imhelper/onebot-v12": "1.0.7",
     "imhelper": "1.0.7",
     "ws": "^8.21.1",
-    "@zhin.js/adapter": "1.1.26",
-    "@zhin.js/client": "1.1.22",
+    "@zhin.js/adapter": "1.1.27",
+    "@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.12",
-    "@zhin.js/skill": "1.1.11"
+    "@zhin.js/page": "1.1.13",
+    "@zhin.js/skill": "1.1.12"
   },
   "devDependencies": {
     "@types/node": "^26.1.2",
     "@types/ws": "^8.18.1",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
-    "@zhin.js/host-http": "1.1.12",
-    "zhin.js": "1.1.19"
+    "@zhin.js/host-http": "1.1.13",
+    "zhin.js": "1.1.20"
   },
   "peerDependencies": {
-    "@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": {
@@ -96,7 +96,7 @@
     "features": [
       {
         "package": "@zhin.js/adapter",
-        "api": "^2.0.0"
+        "api": "^2.1.0"
       },
       {
         "package": "@zhin.js/command",

package/schema.json

@@ -131,6 +131,27 @@
             "type": "string",
             "minLength": 1,
             "description": "Selected OneBot12 bot user ID"
+          },
+          "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": [
@@ -154,9 +175,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/protocol.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 import { readOnebot12Response } from './response.js';
 /**
  * OneBot 12 protocol helpers (no legacy Adapter/Endpoint / segment-mapper).
@@ -10,7 +11,7 @@ import { formatCompact, getLogger } from '@zhin.js/logger';
 const logger = getLogger('onebot12');
 
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface OneBot12EndpointConfig {
+export interface OneBot12EndpointConfig extends EndpointProfileConfiguration {
   readonly platform: string;
   readonly userId: string;
   readonly connection?: 'ws' | 'webhook' | 'wss';

package/src/self-profile.ts

@@ -0,0 +1,22 @@
+import type { EndpointProfile, PendingRpcRequest } from 'zhin.js/adapter';
+
+interface Onebot12SelfProfileOptions {
+  readonly call: (request: PendingRpcRequest) => Promise<unknown>;
+  readonly accountId: string;
+  readonly reportAccount: (id: string) => void;
+}
+
+/** The protocol caller already binds self={platform,user_id}; validate the returned account too. */
+export function createOnebot12SelfProfile({ call, accountId, reportAccount }: Onebot12SelfProfileOptions): EndpointProfile {
+  return Object.freeze<EndpointProfile>({
+    writableFields: Object.freeze([]),
+    async read({ signal }) {
+      const self = await call({ action: 'get_self_info', signal }) as { user_id?: string; user_name?: string; user_displayname?: string } | undefined;
+      if (self?.user_id !== accountId) throw new Error('OneBot12 returned another account profile');
+      const nickname = self.user_displayname || self.user_name;
+      if (typeof nickname !== 'string') throw new Error('OneBot12 returned an incomplete self profile');
+      reportAccount(self.user_id);
+      return { nickname };
+    },
+  });
+}

package/src/webhook.ts

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 import { acceptHttpIngress } from 'imhelper';
 /**
  * OneBot12 HTTP webhook endpoint — POST inbound + api_url outbound.
@@ -71,6 +72,7 @@ export class OneBot12WebhookEndpoint extends Onebot12Client implements Endpoint
       close: () => { this.#open = false; }, stop: () => this.#stop(),
       send: request => this.#send(request),
       management: this.#management, control: this.#control, content: this.#content,
+      profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
       void this[endpointSpec].events.run(() => {

package/src/ws-endpoint.ts

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 /**
  * OneBot12 WS client endpoint — outbound connect to OneBot implementation.
  */
@@ -85,6 +86,7 @@ export class OneBot12WsEndpoint extends Onebot12Client implements Endpoint {
       send: request => this.#send(request),
       get transportState() { return readTransportState(); },
       management: this.#management, control: this.#control, content: this.#content,
+      profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
       void this[endpointSpec].events.run(() => {

package/src/wss-endpoint.ts

@@ -1,3 +1,4 @@
+import { createOnebot12SelfProfile } from './self-profile.js';
 /**
  * OneBot12 reverse WSS endpoint — accepts inbound WebSocket from OneBot implementation.
  */
@@ -85,6 +86,7 @@ export class OneBot12WssEndpoint extends Onebot12Client implements Endpoint {
       send: request => this.#send(request),
       get transportState() { return readTransportState(); },
       management: this.#management, control: this.#control, content: this.#content,
+      profile: createOnebot12SelfProfile({ call: callApi, accountId: options.config.userId, reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     this.#releaseClientEvents = forwardOnebot12ClientEvents(this, (name, payload) => {
       void this[endpointSpec].events.run(() => {