@zhin.js/adapter-milky 3.0.1 → 4.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/adapter-milky",
-  "version": "3.0.1",
-  "description": "Zhin.js adapter for Milky protocol",
+  "version": "4.0.1",
+  "description": "Zhin.js Milky adapter for Plugin Runtime (WebSocket client)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -13,13 +13,14 @@
     }
   },
   "files": [
+    "adapters",
+    "plugin.ts",
+    "schema.json",
     "src",
     "lib",
-    "client",
-    "dist",
-    "skills",
-    "plugin.yml",
-    "README.md"
+    "agent",
+    "README.md",
+    "CHANGELOG.md"
   ],
   "keywords": [
     "zhin",
@@ -37,25 +38,38 @@
     "directory": "plugins/adapters/milky"
   },
   "dependencies": {
-    "eventsource": "^2.0.2",
-    "ws": "^8.21.0"
+    "ws": "^8.21.0",
+    "@zhin.js/adapter": "1.0.1",
+    "@zhin.js/core": "1.3.5",
+    "@zhin.js/host-http": "1.0.1",
+    "@zhin.js/logger": "1.0.75",
+    "@zhin.js/plugin-runtime": "1.0.1"
   },
   "devDependencies": {
-    "@types/eventsource": "^1.1.15",
     "@types/node": "^26.1.0",
     "@types/ws": "^8.18.1",
     "typescript": "^6.0.3",
-    "@zhin.js/cli": "1.0.92",
-    "@zhin.js/client": "2.0.4",
-    "@zhin.js/host-router": "2.0.2",
-    "zhin.js": "4.1.1"
+    "vitest": "^4.1.10",
+    "zod": "^4.4.3",
+    "@zhin.js/agent": "1.0.4",
+    "@zhin.js/host-http": "1.0.1"
   },
   "peerDependencies": {
-    "@zhin.js/host-router": "2.0.2",
-    "zhin.js": "4.1.1"
+    "zod": "^4.0.0",
+    "@zhin.js/adapter": "1.0.1",
+    "@zhin.js/core": "1.3.5",
+    "@zhin.js/plugin-runtime": "1.0.1",
+    "zhin.js": "4.1.3",
+    "@zhin.js/agent": "1.0.4"
   },
   "peerDependenciesMeta": {
-    "@zhin.js/host-router": {
+    "zhin.js": {
+      "optional": true
+    },
+    "@zhin.js/agent": {
+      "optional": true
+    },
+    "zod": {
       "optional": true
     }
   },
@@ -64,11 +78,30 @@
     "email": "admin@liucl.cn",
     "url": "https://github.com/lc-cn"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
+  "zhin": {
+    "protocol": 1,
+    "type": "plugin",
+    "entry": "./plugin.ts",
+    "engine": "^1.0.0",
+    "runtime": "trusted",
+    "features": [
+      {
+        "package": "@zhin.js/adapter",
+        "api": "^1.0.0"
+      }
+    ],
+    "plugins": []
+  },
   "scripts": {
-    "build": "zhin build",
-    "clean": "rimraf lib"
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/adapters/milky/tests"
   }
 }

package/plugin.ts

@@ -0,0 +1,8 @@
+import { definePlugin } from '@zhin.js/plugin-runtime';
+
+export default definePlugin({
+  name: 'milky',
+  metadata: {
+    displayName: 'Milky Adapter',
+  },
+});

package/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "connection": {
+      "type": "string",
+      "enum": ["ws", "sse", "webhook", "wss"],
+      "default": "ws",
+      "description": "ws (default), sse (EventSource client), webhook or wss (webhook/wss via httpHostToken)"
+    },
+    "name": {
+      "type": "string",
+      "default": "milky-bot"
+    },
+    "baseUrl": {
+      "type": "string",
+      "description": "Milky HTTP API base URL (required); WS event path is derived as ws(s)://host/event"
+    },
+    "path": {
+      "type": "string",
+      "description": "Path for webhook / reverse-wss"
+    },
+    "access_token": {
+      "type": "string"
+    },
+    "reconnect_interval": {
+      "type": "number",
+      "default": 5000
+    },
+    "heartbeat_interval": {
+      "type": "number",
+      "default": 30000
+    }
+  }
+}

package/src/endpoint.ts

@@ -0,0 +1,26 @@
+export {
+  MilkyWsEndpoint,
+  type MilkyWsEndpointOptions,
+} from './ws-endpoint.js';
+
+export {
+  MilkyWebhookEndpoint,
+  type MilkyWebhookEndpointOptions,
+} from './webhook-endpoint.js';
+
+export {
+  MilkyWssEndpoint,
+  type MilkyWssEndpointOptions,
+} from './wss-endpoint.js';
+
+export {
+  MilkySseEndpoint,
+  type MilkySseEndpointOptions,
+  type CreateMilkySseStream,
+} from './sse-endpoint.js';
+
+export type { MilkyWsSocket, MilkyWsCreateOptions } from './ws-types.js';
+
+export { verifyMilkyAccessToken, readRequestBody } from './milky-auth.js';
+
+export { openSseStream, consumeSseBuffer } from './sse-client.js';

package/src/index.ts

@@ -1,50 +1,61 @@
-/**
- * Milky 适配器入口：单一适配器，支持 WS/SSE/Webhook/反向 WS，依赖 router 注册
- */
-import { usePlugin, type Plugin, type Context, createSceneManagementTools, registerDefaultScenePlatformPermitChecker, type ToolFeature } from 'zhin.js';
-import type { Router } from '@zhin.js/host-router';
-import { MilkyAdapter } from './adapter.js';
-import type { ISceneManagement } from 'zhin.js';
+export {
+  buildSendAction,
+  buildSseConnectOptions,
+  buildWsConnectOptions,
+  callApi,
+  extractInboundAudioUrl,
+  formatInboundContent,
+  formatInboundMessageId,
+  formatInboundTarget,
+  formatOutboundMessageId,
+  formatOutboundSegments,
+  isMentioned,
+  isMessageReceiveEvent,
+  parseMessageReceiveData,
+  parseMilkyMessageId,
+  parseSendTarget,
+  resolveMilkyConfig,
+  senderNickname,
+  type MilkyAdapterConfig,
+  type MilkyApiClientOptions,
+  type MilkyApiResponse,
+  type MilkyConfigBase,
+  type MilkyEndpointConfig,
+  type MilkyEvent,
+  type MilkyIncomingMessage,
+  type MilkyIncomingSegment,
+  type MilkyOutgoingSegment,
+  type MilkySseConfig,
+  type MilkyWebhookConfig,
+  type MilkyWireSegment,
+  type MilkyWsConfig,
+  type MilkyWssConfig,
+  type ParsedSendTarget,
+  type ResolvedMilkyConfig,
+} from './protocol.js';
 
-export * from './types.js';
-export { callApi } from './api.js';
-export * from './utils.js';
-export { MilkyWsClient } from './endpoint-ws.js';
-export { MilkySseClient } from './endpoint-sse.js';
-export { MilkyWebhookEndpoint } from './endpoint-webhook.js';
-export { MilkyWssServer } from './endpoint-wss.js';
-export { MilkyAdapter, type MilkyBot } from './adapter.js';
+export {
+  MilkySseEndpoint,
+  MilkyWebhookEndpoint,
+  MilkyWssEndpoint,
+  MilkyWsEndpoint,
+  consumeSseBuffer,
+  openSseStream,
+  readRequestBody,
+  verifyMilkyAccessToken,
+  type CreateMilkySseStream,
+  type MilkySseEndpointOptions,
+  type MilkyWebhookEndpointOptions,
+  type MilkyWssEndpointOptions,
+  type MilkyWsCreateOptions,
+  type MilkyWsEndpointOptions,
+  type MilkyWsSocket,
+} from './endpoint.js';
 
-declare module 'zhin.js' {
-  namespace Plugin {
-    interface Contexts {
-      router: import('@zhin.js/host-router').Router;
-    }
-  }
-  interface Adapters {
-    milky: MilkyAdapter;
-  }
-}
-
-const plugin = usePlugin();
-const { provide, useContext } = plugin;
-provide({
-  name: 'milky',
-  description: 'Milky Adapter（WS 正向 / SSE / Webhook / 反向 WS）',
-  mounted: async (p: Plugin) => {
-    const adapter = new MilkyAdapter(p);
-    await adapter.start();
-    return adapter;
-  },
-  dispose: async (adapter: MilkyAdapter) => {
-    await adapter.stop();
-  },
-} as unknown as Context<'milky'>);
-
-useContext('tool', 'milky', (toolService: ToolFeature, milky: MilkyAdapter) => {
-  const disposers: (() => void)[] = [];
-  disposers.push(registerDefaultScenePlatformPermitChecker('milky'));
-  const sceneTools = createSceneManagementTools(milky as unknown as ISceneManagement, 'milky');
-  disposers.push(...sceneTools.map(t => toolService.addTool(t, plugin.name)));
-  return () => disposers.forEach(d => d());
-});
+export {
+  getMilkyAgentDeps,
+  registerMilkyAgentEndpoint,
+  setMilkyAgentDeps,
+  type MilkyAgentDeps,
+  type MilkyAgentEndpoint,
+} from './milky-agent-deps.js';

package/src/milky-agent-deps.ts

@@ -0,0 +1,53 @@
+/**
+ * Agent tool deps for milky (scene management / callApi).
+ * Endpoints register themselves on start; tools look up by config name / endpoint id.
+ */
+
+export interface MilkyAgentEndpoint {
+  callApi(action: string, params?: Record<string, unknown>): Promise<unknown>;
+  kickMember(groupId: number, userId: number, rejectAddRequest?: boolean): Promise<boolean>;
+  muteMember(groupId: number, userId: number, duration?: number): Promise<boolean>;
+  muteAll(groupId: number, enable?: boolean): Promise<boolean>;
+  setAdmin(groupId: number, userId: number, enable?: boolean): Promise<boolean>;
+  setCard(groupId: number, userId: number, card: string): Promise<boolean>;
+  setTitle(groupId: number, userId: number, title: string): Promise<boolean>;
+  setGroupName(groupId: number, name: string): Promise<boolean>;
+  getMemberList(groupId: number): Promise<unknown[]>;
+  getGroupInfo(groupId: number): Promise<unknown>;
+  recallMessage?(id: string): Promise<void>;
+}
+
+export interface MilkyAgentDeps {
+  getEndpoint: (endpointId: string) => MilkyAgentEndpoint;
+}
+
+const endpoints = new Map<string, MilkyAgentEndpoint>();
+let override: MilkyAgentDeps | null = null;
+
+export function registerMilkyAgentEndpoint(
+  endpointId: string,
+  endpoint: MilkyAgentEndpoint,
+): () => void {
+  endpoints.set(endpointId, endpoint);
+  return () => {
+    if (endpoints.get(endpointId) === endpoint) {
+      endpoints.delete(endpointId);
+    }
+  };
+}
+
+/** Optional override used by tests / transitional callers. Pass `null` to clear. */
+export function setMilkyAgentDeps(deps: MilkyAgentDeps | null): void {
+  override = deps;
+}
+
+export function getMilkyAgentDeps(): MilkyAgentDeps {
+  if (override) return override;
+  return {
+    getEndpoint(endpointId: string): MilkyAgentEndpoint {
+      const registered = endpoints.get(endpointId);
+      if (!registered) throw new Error(`Endpoint ${endpointId} 不存在`);
+      return registered;
+    },
+  };
+}

package/src/milky-auth.ts

@@ -0,0 +1,29 @@
+import type { IncomingMessage } from 'node:http';
+
+export function verifyMilkyAccessToken(accessToken: string | undefined, request: IncomingMessage): boolean {
+  if (!accessToken) return true;
+  const auth = request.headers.authorization ?? '';
+  if (auth === `Bearer ${accessToken}`) return true;
+  try {
+    const url = new URL(request.url ?? '/', 'http://localhost');
+    if (url.searchParams.get('access_token') === accessToken) return true;
+  } catch {
+    /* ignore */
+  }
+  return false;
+}
+
+export async function readRequestBody(request: IncomingMessage): Promise<string> {
+  const chunks: Buffer[] = [];
+  let size = 0;
+  for await (const chunk of request) {
+    const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+    size += buffer.length;
+    if (size > 1_048_576) {
+      request.destroy();
+      throw new Error('Request body exceeds 1MB');
+    }
+    chunks.push(buffer);
+  }
+  return Buffer.concat(chunks).toString('utf8');
+}