@zhin.js/adapter-onebot12 1.0.1 → 1.1.0

package/src/index.ts

@@ -1,40 +1,67 @@
-/**
- * OneBot 12 适配器入口：单一适配器，支持正向 WS / Webhook / 反向 WS
- * 协议文档 https://12.onebot.dev/
- */
-import { usePlugin, type Plugin, type Context } from 'zhin.js';
-import type { Router } from '@zhin.js/host-router';
-import { OneBot12Adapter } from './adapter.js';
+export {
+  buildSendMessageParams,
+  buildWsConnectOptions,
+  callOneBot12Action,
+  formatInboundContent,
+  formatOutboundSegments,
+  getChannelId,
+  isBotMentioned,
+  isMessageEvent,
+  mediaRefToOneBot12Fields,
+  mediaRefToOneBot12UploadParams,
+  onebot12InboundConversation,
+  resolveOneBot12Config,
+  senderNickname,
+  senderUserId,
+  uploadOneBot12MediaSegments,
+  type OneBot12ActionRequest,
+  type OneBot12ActionResponse,
+  type OneBot12AdapterConfig,
+  type OneBot12CallAction,
+  type OneBot12ConfigBase,
+  type OneBot12EndpointConfig,
+  type OneBot12Event,
+  type OneBot12HttpOptions,
+  type OneBot12Segment,
+  type OneBot12Self,
+  type OneBot12WebhookConfig,
+  type OneBot12WireSegment,
+  type OneBot12WsConfig,
+  type OneBot12WssConfig,
+  type ResolvedOneBot12Config,
+} from './protocol.js';
 
-export * from './types.js';
-export { callOneBot12Action } from './api.js';
-export * from './utils.js';
-export { OneBot12WsClient } from './endpoint-ws.js';
-export { OneBot12WebhookEndpoint } from './endpoint-webhook.js';
-export { OneBot12WssServer } from './endpoint-wss.js';
-export { OneBot12Adapter, type OneBot12Bot } from './adapter.js';
+export {
+  OneBot12WebhookEndpoint,
+  type OneBot12WebhookEndpointOptions,
+} from './webhook.js';
 
-declare module 'zhin.js' {
-  namespace Plugin {
-    interface Contexts {
-      router: import('@zhin.js/host-router').Router;
-    }
-  }
-  interface Adapters {
-    onebot12: OneBot12Adapter;
-  }
-}
+export {
+  OneBot12WsEndpoint,
+  type OneBot12WsEndpointOptions,
+} from './ws-endpoint.js';
 
-const { provide } = usePlugin();
-provide({
-  name: 'onebot12',
-  description: 'OneBot 12 协议适配器（正向 WS / Webhook / 反向 WS）',
-  mounted: async (p: Plugin) => {
-    const adapter = new OneBot12Adapter(p);
-    await adapter.start();
-    return adapter;
-  },
-  dispose: async (adapter: OneBot12Adapter) => {
-    await adapter.stop();
-  },
-} as unknown as Context<'onebot12'>);
+export {
+  OneBot12WssEndpoint,
+  type OneBot12WssEndpointOptions,
+} from './wss-endpoint.js';
+
+export type { OneBot12WsSocket, OneBot12WsCreateOptions } from './ws-types.js';
+
+export { verifyOneBotAccessToken } from './wss-auth.js';
+export {
+  Onebot12Client,
+  onebot12Client,
+  type Onebot12ClientEventMap,
+} from './client.js';
+
+export type {
+  OneBotV12ActionUrlResolver,
+  OneBotV12AdapterConfig as ImHelperOneBotV12AdapterConfig,
+  OneBotV12Call,
+  OneBotV12ClientConfig,
+  OneBotV12Event as ImHelperOneBotV12Event,
+  OneBotV12Response,
+} from '@imhelper/onebot-v12';
+export { ProtocolError } from '@imhelper/onebot-v12';
+export type { ProtocolErrorKind, ProtocolErrorOptions } from 'imhelper';

package/src/onebot12-endpoint-commands.ts

@@ -0,0 +1,24 @@
+/**
+ * `onebot12.endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { onebot12RuntimeStateToken } from './onebot12-runtime-state.js';
+
+export const onebot12EndpointCommands = createEndpointCommands({
+  adapterKey: 'onebot12',
+  adapterDisplayName: 'OneBot 12',
+  fields: [
+    { key: 'url', description: 'OneBot 实现 WebSocket URL（connection: ws 必填）' },
+    { key: 'path', description: 'HTTP/WS 路径（webhook / reverse-wss）' },
+    { key: 'api_url', description: 'HTTP action 端点（connection: webhook 出站必填）' },
+    { key: 'access_token', env: true, description: 'OneBot access token' },
+  ],
+  running: (use) => use(onebot12RuntimeStateToken).endpoints.values(),
+  describeEntry: (entry) => {
+    if (entry.url) return `url: ${String(entry.url)}`;
+    if (entry.path) return `path: ${String(entry.path)}`;
+    return '';
+  },
+}, defineCommand);

package/src/onebot12-runtime-state.ts

@@ -0,0 +1,7 @@
+/**
+ * OneBot12 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
+ * 由 plugin.ts setup() provide，adapter create 与 `onebot12.endpoint` 命令共享（同一 owner generation）。
+ */
+import { defineEndpointRuntimeStateToken } from 'zhin.js/adapter';
+
+export const onebot12RuntimeStateToken = defineEndpointRuntimeStateToken('onebot12');