@zhin.js/adapter-satori 1.1.19 → 1.1.21

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @zhin.js/adapter-satori
 
+## 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
+
+- Updated dependencies [5e878ba]
+  - @zhin.js/page@1.1.12
+
 ## 1.1.19
 
 ### Patch Changes

package/lib/endpoint.js

@@ -1,3 +1,4 @@
+import { createSatoriSelfProfile } from './self-profile.js';
 import { acceptHttpIngress } from 'imhelper';
 /**
  * SatoriEndpoint — WebSocket and webhook lifecycle, outbound, admit.
@@ -34,6 +35,8 @@ export class SatoriWsEndpoint extends SatoriClient {
             close: () => { this.#open = false; }, stop: () => this.#stop(),
             send: request => this.#send(request),
             management: this.#management, control: this.#control,
+            profile: createSatoriSelfProfile({ call, platform: options.config.platform, accountId: options.config.userId,
+                reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
         forwardSatoriClientEvents(this, (name, payload) => {
             void this[endpointSpec].events.run(() => {
@@ -304,6 +307,8 @@ export class SatoriWebhookEndpoint extends SatoriClient {
             close: () => { this.#open = false; }, stop: () => this.#stop(),
             send: request => this.#send(request),
             management: this.#management, control: this.#control,
+            profile: createSatoriSelfProfile({ call, platform: options.config.platform, accountId: options.config.userId,
+                reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
         });
         forwardSatoriClientEvents(this, (name, payload) => {
             void this[endpointSpec].events.run(() => {

package/lib/protocol.d.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 /** Satori protocol helpers. Spec: https://satori.chat/zh-CN/protocol/overview.html */
 import { type ConversationRef } from '@zhin.js/im-contract';
 /** Opcode：EVENT=0, PING=1, PONG=2, IDENTIFY=3, READY=4, META=5 */
@@ -74,7 +75,7 @@ export interface SatoriWireSegment {
     readonly data?: Record<string, unknown>;
 }
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface SatoriEndpointConfig {
+export interface SatoriEndpointConfig extends EndpointProfileConfiguration {
     readonly id: string;
     /** Exact remote login selected by this configured Endpoint. */
     readonly platform: string;

package/lib/self-profile.d.ts

@@ -0,0 +1,11 @@
+import type { EndpointProfile } from 'zhin.js/adapter';
+import type { SatoriActionCaller } from './client.js';
+interface SatoriSelfProfileOptions {
+    readonly call: SatoriActionCaller;
+    readonly platform: string;
+    readonly accountId: string;
+    readonly reportAccount: (id: string) => void;
+}
+/** login.get is scoped by Satori-Platform/Satori-User-ID, never the gateway's first login. */
+export declare function createSatoriSelfProfile({ call, platform, accountId, reportAccount }: SatoriSelfProfileOptions): EndpointProfile;
+export {};

package/lib/self-profile.js

@@ -0,0 +1,15 @@
+/** login.get is scoped by Satori-Platform/Satori-User-ID, never the gateway's first login. */
+export function createSatoriSelfProfile({ call, platform, accountId, reportAccount }) {
+    return Object.freeze({
+        writableFields: Object.freeze([]),
+        async read({ signal }) {
+            const self = await call({ resource: 'login', method: 'get', signal });
+            if (self?.user?.id !== accountId || (self.platform !== undefined && self.platform !== platform)) {
+                throw new Error('Satori returned another account profile');
+            }
+            reportAccount(self.user.id);
+            return { ...(typeof self.user.name === 'string' ? { nickname: self.user.name } : {}),
+                ...(typeof self.user.avatar === 'string' ? { avatar: self.user.avatar } : {}) };
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-satori",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Zhin.js Satori adapter for Plugin Runtime (WebSocket client)",
   "type": "module",
   "main": "./lib/index.js",
@@ -41,30 +41,30 @@
     "@imhelper/satori-v1": "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.11",
-    "@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": {
@@ -95,7 +95,7 @@
     "features": [
       {
         "package": "@zhin.js/adapter",
-        "api": "^2.0.0"
+        "api": "^2.1.0"
       },
       {
         "package": "@zhin.js/command",

package/schema.json

@@ -119,6 +119,27 @@
             "type": "string",
             "minLength": 1,
             "description": "Selected Satori login 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": [
@@ -143,9 +164,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

@@ -1,3 +1,4 @@
+import { createSatoriSelfProfile } from './self-profile.js';
 import { acceptHttpIngress } from 'imhelper';
 /**
  * SatoriEndpoint — WebSocket and webhook lifecycle, outbound, admit.
@@ -88,6 +89,8 @@ export class SatoriWsEndpoint extends SatoriClient implements Endpoint {
       close: () => { this.#open = false; }, stop: () => this.#stop(),
       send: request => this.#send(request),
       management: this.#management, control: this.#control,
+      profile: createSatoriSelfProfile({ call, platform: options.config.platform, accountId: options.config.userId,
+        reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     forwardSatoriClientEvents(this, (name, payload) => {
       void this[endpointSpec].events.run(() => {
@@ -370,6 +373,8 @@ export class SatoriWebhookEndpoint extends SatoriClient implements Endpoint {
       close: () => { this.#open = false; }, stop: () => this.#stop(),
       send: request => this.#send(request),
       management: this.#management, control: this.#control,
+      profile: createSatoriSelfProfile({ call, platform: options.config.platform, accountId: options.config.userId,
+        reportAccount: id => this[endpointSpec].reportSelfUserId(id) }),
     });
     forwardSatoriClientEvents(this, (name, payload) => {
       void this[endpointSpec].events.run(() => {

package/src/protocol.ts

@@ -1,3 +1,4 @@
+import type { EndpointProfileConfiguration } from 'zhin.js/adapter';
 /** Satori protocol helpers. Spec: https://satori.chat/zh-CN/protocol/overview.html */
 
 import { EndpointDeliveryError, isMediaRef, type ConversationKind, type ConversationRef } from '@zhin.js/im-contract';
@@ -78,7 +79,7 @@ export interface SatoriWireSegment {
 }
 
 /** One endpoint config after AdapterIndex expands `plugins.<instanceKey>.endpoints`. */
-export interface SatoriEndpointConfig {
+export interface SatoriEndpointConfig extends EndpointProfileConfiguration {
   readonly id: string;
   /** Exact remote login selected by this configured Endpoint. */
   readonly platform: string;

package/src/self-profile.ts

@@ -0,0 +1,26 @@
+import type { EndpointProfile } from 'zhin.js/adapter';
+import type { SatoriActionCaller } from './client.js';
+import type { SatoriLogin } from './protocol.js';
+
+interface SatoriSelfProfileOptions {
+  readonly call: SatoriActionCaller;
+  readonly platform: string;
+  readonly accountId: string;
+  readonly reportAccount: (id: string) => void;
+}
+
+/** login.get is scoped by Satori-Platform/Satori-User-ID, never the gateway's first login. */
+export function createSatoriSelfProfile({ call, platform, accountId, reportAccount }: SatoriSelfProfileOptions): EndpointProfile {
+  return Object.freeze<EndpointProfile>({
+    writableFields: Object.freeze([]),
+    async read({ signal }) {
+      const self = await call({ resource: 'login', method: 'get', signal }) as SatoriLogin;
+      if (self?.user?.id !== accountId || (self.platform !== undefined && self.platform !== platform)) {
+        throw new Error('Satori returned another account profile');
+      }
+      reportAccount(self.user.id);
+      return { ...(typeof self.user.name === 'string' ? { nickname: self.user.name } : {}),
+        ...(typeof self.user.avatar === 'string' ? { avatar: self.user.avatar } : {}) };
+    },
+  });
+}