@zhin.js/adapter-satori 1.1.17 → 1.1.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-satori",
-  "version": "1.1.17",
+  "version": "1.1.19",
   "description": "Zhin.js Satori adapter for Plugin Runtime (WebSocket client)",
   "type": "module",
   "main": "./lib/index.js",
@@ -14,6 +14,7 @@
   "files": [
     "adapters",
     "commands",
+    "pages",
     "plugin.js",
     "schema.json",
     "src",
@@ -40,27 +41,30 @@
     "@imhelper/satori-v1": "1.0.7",
     "imhelper": "1.0.7",
     "ws": "^8.21.1",
-    "@zhin.js/adapter": "1.1.24",
-    "@zhin.js/core": "1.1.52",
-    "@zhin.js/feature-kit": "1.1.9",
-    "@zhin.js/host-http": "1.1.11",
-    "@zhin.js/im-contract": "1.1.8",
+    "@zhin.js/adapter": "1.1.26",
+    "@zhin.js/client": "1.1.22",
+    "@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/logger": "1.1.2",
-    "@zhin.js/skill": "1.1.10"
+    "@zhin.js/page": "1.1.11",
+    "@zhin.js/skill": "1.1.11"
   },
   "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.11",
-    "zhin.js": "1.1.17"
+    "@zhin.js/host-http": "1.1.12",
+    "zhin.js": "1.1.19"
   },
   "peerDependencies": {
-    "@zhin.js/adapter": "^1.1.24",
-    "@zhin.js/command": "^1.1.11",
-    "@zhin.js/core": "^1.1.52",
-    "zhin.js": "^1.1.17"
+    "@zhin.js/adapter": "^1.1.26",
+    "@zhin.js/command": "^1.1.12",
+    "@zhin.js/core": "^1.1.54",
+    "zhin.js": "^1.1.19"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {
@@ -91,7 +95,7 @@
     "features": [
       {
         "package": "@zhin.js/adapter",
-        "api": "^1.0.0"
+        "api": "^2.0.0"
       },
       {
         "package": "@zhin.js/command",
@@ -100,6 +104,10 @@
       {
         "package": "@zhin.js/skill",
         "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: 'Satori',
+    titleI18n: { en: 'Satori' },
+    icon: 'Sparkles',
+    order: 72,
+    requiredPermissions: ['satori:read'],
+});
+/**
+ * Convention page: `pages/index/index.ts` → `/satori`（插件路径）。
+ * 连接状态、连接测试、endpoint 增删；登录待办来自 LoginAssist（ICQQ 等）。
+ */
+export default createAdapterConsolePage('satori');

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: 'Satori',
+  titleI18n: { en: 'Satori' },
+  icon: 'Sparkles',
+  order: 72,
+  requiredPermissions: ['satori:read'],
+});
+
+/**
+ * Convention page: `pages/index/index.ts` → `/satori`（插件路径）。
+ * 连接状态、连接测试、endpoint 增删；登录待办来自 LoginAssist（ICQQ 等）。
+ */
+export default createAdapterConsolePage('satori');

package/plugin.js

@@ -1,14 +1,12 @@
 // Generated by build-plugin-runtime-entries.mjs. Do not edit.
-import { createEndpointRuntimeState } from 'zhin.js/adapter';
-import { definePlugin } from 'zhin.js';
-import { satoriRuntimeStateToken } from "./lib/satori-runtime-state.js";
+import { definePlugin, pluginConsoleRpcToken } from 'zhin.js';
+import { createSatoriConsoleRpc } from "./lib/console.js";
 export default definePlugin({
     name: 'satori',
     metadata: {
         displayName: 'Satori Adapter',
     },
     setup(context) {
-        // 运行中 endpoint 注册表（satori endpoint list 的"运行中"数据源）
-        context.resources.provide(satoriRuntimeStateToken, createEndpointRuntimeState());
+        context.resources.provide(pluginConsoleRpcToken, createSatoriConsoleRpc(context.resources, () => context.config.get()));
     },
 });

package/schema.json

@@ -48,7 +48,7 @@
     "endpoints": {
       "type": "array",
       "minItems": 1,
-      "description": "多账号：每项定义一个 endpoint，id/baseUrl 必填，其余字段覆盖实例默认值",
+      "description": "多账号：每项明确选择 platform/userId，id/baseUrl 必填，其余字段覆盖实例默认值",
       "items": {
         "type": "object",
         "additionalProperties": false,
@@ -109,16 +109,28 @@
           "id": {
             "type": "string",
             "description": "Satori bot name"
+          },
+          "platform": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Selected Satori login platform"
+          },
+          "userId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Selected Satori login user ID"
           }
         },
         "required": [
           "id",
-          "baseUrl"
+          "baseUrl",
+          "platform",
+          "userId"
         ]
       },
       "x-i18n": {
         "en": {
-          "description": "Multiple accounts: each entry defines an endpoint. id and baseUrl are required; other fields override instance defaults."
+          "description": "Multiple accounts: each entry selects an explicit platform and userId. id and baseUrl are required; remaining fields override instance defaults."
         }
       }
     },

package/src/adapter.ts

@@ -0,0 +1,32 @@
+import { Adapter, type AdapterContext, type EndpointCreationContext } from 'zhin.js/adapter';
+import { httpHostToken } from '@zhin.js/host-http';
+import { callSatoriApi, resolveSatoriConfig, type SatoriEndpointConfig, type SatoriLogin } from './protocol.js';
+import { SatoriWsEndpoint, SatoriWebhookEndpoint } from './endpoint.js';
+import type { SatoriClientEventMap } from './client.js';
+
+export class SatoriAdapter extends Adapter<SatoriWsEndpoint | SatoriWebhookEndpoint, SatoriEndpointConfig, SatoriClientEventMap> {
+  readonly #context: AdapterContext<SatoriEndpointConfig>;
+  constructor(context: AdapterContext<SatoriEndpointConfig>) { super(); this.#context = context; }
+  override get configurationIdentityFields(): readonly string[] { return ['id', 'platform', 'userId']; }
+  override get configurationIdentityProbeFields(): readonly string[] { return ['token', 'baseUrl']; }
+  override get configurationUpdateFields(): readonly string[] { return ['connection', 'baseUrl', 'token', 'path', 'heartbeat_interval']; }
+  protected override validateConfiguration(config: SatoriEndpointConfig): void { resolveSatoriConfig(config); }
+  protected override async identifyConfiguration(input: SatoriEndpointConfig, signal: AbortSignal): Promise<string> {
+    const config = resolveSatoriConfig(input);
+    signal.throwIfAborted();
+    const login = await callSatoriApi<SatoriLogin>({ ...config, signal, resource: 'login', method: 'get' });
+    signal.throwIfAborted();
+    if (!login?.platform || !login.user?.id) throw new Error('Satori login identity is unavailable');
+    if (login.platform !== config.platform || login.user.id !== config.userId) throw new Error('Satori returned another login identity');
+    return `satori:${JSON.stringify([login.platform, login.user.id])}`;
+  }
+  protected createEndpoint(input: SatoriEndpointConfig, execution: EndpointCreationContext): SatoriWsEndpoint | SatoriWebhookEndpoint {
+    const config = resolveSatoriConfig(input), id = execution.canonicalId, signal = execution.signal;
+    return config.connection === 'webhook'
+      ? new SatoriWebhookEndpoint({ id, config, signal, http: this.#context.use(httpHostToken) })
+      : new SatoriWsEndpoint({ id, config, signal });
+  }
+}
+declare module '@zhin.js/feature-kit' {
+  interface AdapterRegistry { readonly satori: SatoriAdapter; }
+}

package/src/client.ts

@@ -1,16 +1,15 @@
+import { EndpointDeliveryError } from '@zhin.js/im-contract';
 import {
   SatoriV1Client,
   type SatoriV1Event,
 } from '@imhelper/satori-v1';
 import { EventFactory, type EventMap, type ImHelperEventMap } from 'imhelper';
 import {
-  defineEndpointClient,
   forwardEndpointClientEvents,
   type ClientEventPayloads,
 } from 'zhin.js/adapter';
 import type {
   ResolvedSatoriConfig,
-  SatoriApiOptions,
   callSatoriApi,
 } from './protocol.js';
 
@@ -19,18 +18,35 @@ export { SatoriV1Client as SatoriClient } from '@imhelper/satori-v1';
 type SatoriClientEvents = ImHelperEventMap<string, SatoriV1Event, EventMap<string>>;
 export type SatoriClientEventMap = ClientEventPayloads<SatoriClientEvents>;
 
-export function createSatoriEndpointClient(
-  config: ResolvedSatoriConfig,
-  request: typeof callSatoriApi,
-  apiOptions: () => SatoriApiOptions,
-): SatoriV1Client {
-  return new SatoriV1Client({
-    baseUrl: config.baseUrl,
-    selfId: config.id,
-    accessToken: config.token,
-    receiveMode: 'manual',
-    call: (resource, method, params) => request(apiOptions(), resource, method, params ?? {}),
-  });
+/** One account-bound caller is shared by native SDK and semantic ports. */
+export interface SatoriActionRequest {
+  readonly resource: string;
+  readonly method: string;
+  readonly params?: Record<string, unknown>;
+  readonly signal?: AbortSignal;
+}
+export interface SatoriClientBinding {
+  readonly config: ResolvedSatoriConfig;
+  readonly request: typeof callSatoriApi;
+  readonly signal?: AbortSignal;
+}
+export type SatoriActionCaller = (request: SatoriActionRequest) => Promise<unknown>;
+export function createSatoriActionCaller({ config, request, signal }: SatoriClientBinding): SatoriActionCaller {
+  return action => {
+    const operationSignal = signal && action.signal ? AbortSignal.any([signal, action.signal]) : signal ?? action.signal;
+    if (operationSignal?.aborted) throw new EndpointDeliveryError('endpoint_inactive', 'Endpoint request ended before submission', 'not_sent', { cause: operationSignal.reason });
+    return request({ baseUrl: config.baseUrl, platform: config.platform, userId: config.userId,
+      token: config.token, ...action, signal: operationSignal });
+  };
+}
+export function satoriClientOptions({ config, call }: {
+  readonly config: ResolvedSatoriConfig;
+  readonly call: SatoriActionCaller;
+}): ConstructorParameters<typeof SatoriV1Client>[0] {
+  return { baseUrl: config.baseUrl, selfId: config.userId, platform: config.platform,
+    accessToken: config.token, receiveMode: 'manual',
+    call: (resource, method, params) => call({ resource, method, params: params ?? {} }),
+  };
 }
 
 const satoriClientEventNames = Object.freeze([
@@ -44,14 +60,3 @@ export function forwardSatoriClientEvents(
 ): () => void {
   return forwardEndpointClientEvents(client, satoriClientEventNames, receive);
 }
-
-declare module '@zhin.js/feature-kit' {
-  interface AdapterClientRegistry {
-    readonly satori: {
-      readonly client: SatoriV1Client;
-      readonly events: SatoriClientEventMap;
-    };
-  }
-}
-
-export const satoriClient = defineEndpointClient<SatoriV1Client, SatoriClientEventMap>('satori');

package/src/console-spec.ts

@@ -0,0 +1,19 @@
+/**
+ * Satori Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+
+export const satoriConsoleSpec = {
+  adapterKey: 'satori',
+  adapterDisplayName: 'Satori',
+  fields: [
+    { key: 'platform', required: true, description: 'Selected Satori login platform' },
+    { key: 'userId', required: true, description: 'Selected Satori login user ID' },
+    { key: 'baseUrl', required: true, description: 'Satori 服务 base URL', descriptionI18n: { en: 'Satori service base URL' } },
+    { key: 'path', description: 'webhook 路径（connection: webhook）', descriptionI18n: { en: 'Webhook path (connection: webhook)' } },
+    { key: 'token', env: true, description: 'Satori access token' },
+  ] as readonly AdapterConsoleField[],
+  docsUrl: 'https://zhin.js.org/adapters/satori',
+  readPermission: 'satori:read',
+  writePermission: 'satori:write',
+} as const;

package/src/console.ts

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