@zhin.js/scaffold-wizard 0.1.9 → 0.2.0

package/src/adapter.ts

@@ -5,10 +5,15 @@ import {
   adapterDocsUrl,
   configureDiscordEndpoint,
   configureGitHubEndpoint,
+  configureMilkyBot,
+  configureNapcatBot,
   configureOneBot11Bot,
+  configureOneBot12Bot,
   configureQQBot,
+  configureSatoriBot,
   configureSlackEndpoint,
   configureTelegramEndpoint,
+  configureWeixinIlinkBot,
 } from './adapter-configurers.js';
 import { ZHIN_STACK_VERSIONS } from './zhin-stack-deps.js';
 
@@ -32,7 +37,7 @@ export interface AdapterSetupResult {
 }
 
 // 适配器定义
-interface AdapterDefinition {
+export interface AdapterDefinition {
   name: string;
   value: string;
   package: string;
@@ -48,7 +53,7 @@ interface AdapterDefinition {
   fields: AdapterField[];
 }
 
-interface AdapterField {
+export interface AdapterField {
   key: string;
   message: string;
   type?: 'input' | 'password' | 'select';
@@ -56,6 +61,8 @@ interface AdapterField {
   required?: boolean;
   envKey?: string;       // 如果是敏感信息，对应的环境变量名
   choices?: { name: string; value: string }[];
+  /** 字段归属：endpoint 级（默认，进 endpoints[i]）或 shared（顶层共享字段） */
+  scope?: 'endpoint' | 'shared';
 }
 
 const ADAPTERS: AdapterDefinition[] = [
@@ -80,6 +87,8 @@ const ADAPTERS: AdapterDefinition[] = [
     docUrl: adapterDocsUrl('icqq'),
     fields: [
       { key: 'name', message: 'QQ 号（与 icqq login 时一致）:', required: true, envKey: 'ICQQ_ACCOUNT' },
+      // schema 顶层 required: master（所有 endpoint 共享）
+      { key: 'master', message: '主人 QQ 号（master，/approve 等管理命令）:', required: true, scope: 'shared' },
     ],
   },
   {
@@ -153,6 +162,8 @@ const ADAPTERS: AdapterDefinition[] = [
     fields: [
       { key: 'appKey', message: 'App Key:', required: true, envKey: 'DINGTALK_APP_KEY' },
       { key: 'appSecret', message: 'App Secret:', required: true, type: 'password', envKey: 'DINGTALK_APP_SECRET' },
+      // schema endpoints[i] required 含 robotCode（主动发送 /robot/send 需要）
+      { key: 'robotCode', message: 'Robot Code:', required: true, envKey: 'DINGTALK_ROBOT_CODE' },
       { key: 'webhookPath', message: 'Webhook 路径:', default: '/dingtalk/webhook' },
     ],
   },
@@ -167,7 +178,24 @@ const ADAPTERS: AdapterDefinition[] = [
     fields: [
       { key: 'appId', message: 'App ID:', required: true, envKey: 'LARK_APP_ID' },
       { key: 'appSecret', message: 'App Secret:', required: true, type: 'password', envKey: 'LARK_APP_SECRET' },
-      { key: 'webhookPath', message: 'Webhook 路径:', default: '/lark/webhook' },
+      // schema 顶层共享字段（endpoints[i] 不含 webhookPath）
+      { key: 'webhookPath', message: 'Webhook 路径:', default: '/lark/webhook', scope: 'shared' },
+    ],
+  },
+  {
+    name: 'LINE',
+    value: 'line',
+    package: '@zhin.js/adapter-line',
+    plugin: '@zhin.js/adapter-line',
+    needsHttp: true,
+    description: 'LINE Messaging API',
+    setupHint: '在 LINE Developers Console 创建 Messaging API Channel；Webhook URL 需 HTTPS 公网可达，并关闭 Auto-reply。',
+    docUrl: adapterDocsUrl('line'),
+    fields: [
+      { key: 'channelSecret', message: 'Channel Secret:', required: true, type: 'password', envKey: 'LINE_CHANNEL_SECRET' },
+      { key: 'channelAccessToken', message: 'Channel Access Token:', required: true, type: 'password', envKey: 'LINE_CHANNEL_ACCESS_TOKEN' },
+      // schema 顶层共享字段（endpoints[i] 不含 webhookPath）
+      { key: 'webhookPath', message: 'Webhook 路径:', default: '/line/webhook', scope: 'shared' },
     ],
   },
   {
@@ -182,6 +210,54 @@ const ADAPTERS: AdapterDefinition[] = [
     configure: configureOneBot11Bot,
     fields: [],
   },
+  {
+    name: 'OneBot v12',
+    value: 'onebot12',
+    package: '@zhin.js/adapter-onebot12',
+    plugin: '@zhin.js/adapter-onebot12',
+    needsHttp: false,
+    description: 'OneBot v12（ws / webhook / wss）',
+    setupHint: 'connection: ws 连 OneBot 实现；webhook / wss 由内置 HTTP Host 承接。',
+    docUrl: adapterDocsUrl('onebot12'),
+    configure: configureOneBot12Bot,
+    fields: [],
+  },
+  {
+    name: 'NapCat',
+    value: 'napcat',
+    package: '@zhin.js/adapter-napcat',
+    plugin: '@zhin.js/adapter-napcat',
+    needsHttp: false,
+    description: 'NapCat（OneBot 11 + NapCat 扩展）',
+    setupHint: 'connection: ws 连 NapCat（默认 ws://127.0.0.1:3001）；wss / http 由内置 HTTP Host 承接。',
+    docUrl: adapterDocsUrl('napcat'),
+    configure: configureNapcatBot,
+    fields: [],
+  },
+  {
+    name: 'Milky',
+    value: 'milky',
+    package: '@zhin.js/adapter-milky',
+    plugin: '@zhin.js/adapter-milky',
+    needsHttp: false,
+    description: 'Milky 协议（ws / sse / webhook / wss）',
+    setupHint: 'connection: ws 连协议端 ws(s)://baseUrl/event；webhook / wss 由内置 HTTP Host 承接。',
+    docUrl: adapterDocsUrl('milky'),
+    configure: configureMilkyBot,
+    fields: [],
+  },
+  {
+    name: 'Satori',
+    value: 'satori',
+    package: '@zhin.js/adapter-satori',
+    plugin: '@zhin.js/adapter-satori',
+    needsHttp: false,
+    description: 'Satori 聊天协议（ws / webhook）',
+    setupHint: 'connection: ws 连 Satori SDK（默认 http://127.0.0.1:5140）；webhook 由内置 HTTP Host 承接。',
+    docUrl: adapterDocsUrl('satori'),
+    configure: configureSatoriBot,
+    fields: [],
+  },
   {
     name: '微信公众号',
     value: 'wechat-mp',
@@ -194,7 +270,26 @@ const ADAPTERS: AdapterDefinition[] = [
       { key: 'appId', message: 'App ID:', required: true, envKey: 'WECHAT_APP_ID' },
       { key: 'appSecret', message: 'App Secret:', required: true, type: 'password', envKey: 'WECHAT_APP_SECRET' },
       { key: 'token', message: '验证 Token:', required: true, envKey: 'WECHAT_TOKEN' },
-      { key: 'webhookPath', message: 'Webhook 路径:', default: '/wechat/webhook' },
+      // schema 顶层共享字段名为 path（endpoints[i] 不含此项）
+      { key: 'webhookPath', message: 'Webhook 路径:', default: '/wechat/webhook', scope: 'shared' },
+    ],
+  },
+  {
+    name: '企业微信',
+    value: 'wecom',
+    package: '@zhin.js/adapter-wecom',
+    plugin: '@zhin.js/adapter-wecom',
+    needsHttp: true,
+    description: '企业微信自建应用',
+    setupHint: '管理后台创建自建应用并配置「接收消息」URL（需公网可达）；Token / EncodingAESKey 与后台一致。',
+    docUrl: adapterDocsUrl('wecom'),
+    fields: [
+      { key: 'corpId', message: 'Corp ID:', required: true, envKey: 'WECOM_CORP_ID' },
+      { key: 'agentSecret', message: '应用 Secret:', required: true, type: 'password', envKey: 'WECOM_AGENT_SECRET' },
+      { key: 'token', message: '回调 Token:', required: true, type: 'password', envKey: 'WECOM_TOKEN' },
+      { key: 'encodingAESKey', message: 'EncodingAESKey（43 字符）:', required: true, type: 'password', envKey: 'WECOM_AES_KEY' },
+      // schema 顶层共享字段（endpoints[i] 不含 webhookPath）
+      { key: 'webhookPath', message: '回调路径:', default: '/wecom/callback', scope: 'shared' },
     ],
   },
   {
@@ -227,6 +322,18 @@ const ADAPTERS: AdapterDefinition[] = [
     configure: configureGitHubEndpoint,
     fields: [],
   },
+  {
+    name: '微信 iLink（个人微信）',
+    value: 'weixin-ilink',
+    package: '@zhin.js/adapter-weixin-ilink',
+    plugin: '@zhin.js/adapter-weixin-ilink',
+    needsHttp: false,
+    description: '个人微信（iLink / ClawBot 灰度入口，长轮询，仅私聊）',
+    setupHint: '需最新版微信 + ClawBot 灰度资格；默认扫码绑定（bot_token 写入 .env），也可手动输入或放 data/weixin-ilink/<name>.json 侧车凭证文件。',
+    docUrl: adapterDocsUrl('weixin-ilink'),
+    configure: configureWeixinIlinkBot,
+    fields: [],
+  },
 ];
 
 /**
@@ -253,7 +360,7 @@ export async function configureAdapters(): Promise<AdapterSetupResult> {
         if (input.length === 0) return '至少选择一个适配器';
         return true;
       },
-      pageSize: 14,
+      pageSize: 22,
     }
   ]);
 
@@ -374,7 +481,7 @@ export async function configureAdapters(): Promise<AdapterSetupResult> {
     result.instances.push({
       package: adapterDef.package,
       instanceKey: adapterDef.value,
-      config: buildFieldBasedInstanceConfig(adapterDef.value, fieldValues),
+      config: buildFieldBasedInstanceConfig(adapterDef, fieldValues),
     });
   }
 
@@ -382,36 +489,56 @@ export async function configureAdapters(): Promise<AdapterSetupResult> {
 }
 
 /**
- * 字段式适配器（无自定义 configure）的实例配置整形，对齐各插件 schema.json：
- * - wechat-mp：webhookPath → path
- * - email：smtp/imap 平铺字段 → smtp/imap 嵌套对象
- * - 其余：字段直传
+ * 字段式适配器（无自定义 configure）的实例配置整形，对齐各插件 schema.json 新格式：
+ * - endpoint 级字段（name + 凭据等，字段默认 scope: 'endpoint'）进 `endpoints: [{ name, ... }]`
+ * - scope: 'shared' 的字段（如 lark/wechat-mp 的 webhookPath）留顶层
+ * - wechat-mp：顶层字段名为 path（向导沿用 webhookPath 提问）
+ * - email：smtp/imap 平铺字段 → endpoint 内 smtp/imap 嵌套对象
+ * - 未单独询问 name 的适配器用 `<adapter>-bot` 兜底
  */
-function buildFieldBasedInstanceConfig(adapterValue: string, values: Record<string, any>): Record<string, unknown> {
-  if (adapterValue === 'wechat-mp') {
-    const { webhookPath, ...rest } = values;
-    return { ...rest, path: webhookPath ?? '/wechat/webhook' };
-  }
-  if (adapterValue === 'email') {
+export function buildFieldBasedInstanceConfig(adapter: AdapterDefinition, values: Record<string, any>): Record<string, unknown> {
+  if (adapter.value === 'email') {
     const user = values.user ?? '';
     const password = values.password ?? '';
     return {
-      smtp: {
-        host: values.smtpHost,
-        port: Number(values.smtpPort) || 465,
-        secure: true,
-        auth: { user, pass: password },
-      },
-      imap: {
-        host: values.imapHost,
-        port: Number(values.imapPort) || 993,
-        tls: true,
-        user,
-        password,
-      },
+      endpoints: [{
+        name: 'email-bot',
+        smtp: {
+          host: values.smtpHost,
+          port: Number(values.smtpPort) || 465,
+          secure: true,
+          auth: { user, pass: password },
+        },
+        imap: {
+          host: values.imapHost,
+          port: Number(values.imapPort) || 993,
+          tls: true,
+          user,
+          password,
+        },
+      }],
     };
   }
-  return values;
+
+  const endpoint: Record<string, unknown> = {};
+  const shared: Record<string, unknown> = {};
+  for (const field of adapter.fields) {
+    const value = values[field.key];
+    if (value === undefined) continue;
+    if (field.scope === 'shared') {
+      shared[field.key] = value;
+    } else {
+      endpoint[field.key] = value;
+    }
+  }
+  if (adapter.value === 'wechat-mp' && shared.webhookPath !== undefined) {
+    shared.path = shared.webhookPath;
+    delete shared.webhookPath;
+  }
+  if (!endpoint.name) {
+    endpoint.name = `${adapter.value}-bot`;
+  }
+  return { ...shared, endpoints: [endpoint] };
 }
 
 /**
@@ -464,12 +591,14 @@ export function getAdapterSetupNotes(result: AdapterSetupResult): string[] {
       notes.push('Telegram polling: 本地开发可直接 pnpm dev，无需公网');
     }
     if (context === 'github') {
-      if (entry.webhook_secret) {
+      const endpoints = Array.isArray(entry.endpoints) ? entry.endpoints as Array<Record<string, unknown>> : [];
+      const firstEndpoint = endpoints[0] ?? {};
+      if (firstEndpoint.webhook_secret) {
         notes.push('GitHub Webhook: App 设置 URL 为 https://<域名>/github/webhook');
       } else {
         notes.push('GitHub polling: 无 Webhook 时将轮询 Events API（默认 60s）');
       }
-      if (entry.app_id) {
+      if (firstEndpoint.app_id) {
         notes.push('GitHub App: 私钥路径需存在，且 App 已安装到目标仓库');
       } else {
         notes.push('GitHub gh CLI: 运行 gh auth login 完成认证');

package/src/index.ts

@@ -4,6 +4,7 @@ export { DATABASE_PACKAGES } from './types.js';
 export type { AdapterSetupResult, AdapterPluginInstance } from './adapter.js';
 export {
   configureAdapters,
+  buildFieldBasedInstanceConfig,
   generateAdapterEnvVars,
   collectAdapterPluginConfigs,
   collectAdapterPluginManifest,

package/src/weixin-ilink-login.ts

@@ -0,0 +1,151 @@
+/**
+ * 微信 iLink（ClawBot）扫码登录流程 — 向导内联实现。
+ * 协议与 plugins/adapters/weixin-ilink/src/login.ts 一致（SSOT），
+ * 此处复制最小 HTTP 面，避免向导在适配器包安装前产生依赖。
+ */
+
+export interface IlinkQrLoginResult {
+  readonly botToken: string;
+  readonly ilinkUserId?: string;
+  readonly ilinkBotId?: string;
+  readonly baseUrl: string;
+}
+
+interface QrCodeResponse {
+  qrcode: string;
+  qrcode_img_content: string;
+}
+
+type QrStatus =
+  | 'wait'
+  | 'scaned'
+  | 'confirmed'
+  | 'expired'
+  | 'scaned_but_redirect'
+  | 'need_verifycode'
+  | 'verify_code_blocked'
+  | 'binded_redirect';
+
+interface StatusResponse {
+  status: QrStatus;
+  bot_token?: string;
+  ilink_endpoint_id?: string;
+  baseurl?: string;
+  ilink_user_id?: string;
+  redirect_host?: string;
+}
+
+const DEFAULT_BASE_URL = 'https://ilinkai.weixin.qq.com';
+const DEFAULT_BOT_TYPE = '3';
+const POLL_INTERVAL_MS = 500;
+const QR_LONG_POLL_TIMEOUT_MS = 35_000;
+
+export interface IlinkQrLoginOptions {
+  readonly baseUrl?: string;
+  readonly timeoutMs?: number;
+  /** 拿到二维码内容（URL）后回调，由调用方负责展示（终端 QR / 链接）。 */
+  readonly onQrCode: (url: string) => void | Promise<void>;
+  /** 扫码状态变化提示（scaned → 已扫码待确认）。 */
+  readonly onStatus?: (status: QrStatus) => void;
+  readonly fetchImpl?: typeof fetch;
+  readonly sleep?: (ms: number) => Promise<void>;
+}
+
+export class IlinkQrLoginError extends Error {
+  constructor(
+    message: string,
+    readonly reason: 'expired' | 'timeout' | 'network' | 'protocol',
+  ) {
+    super(message);
+    this.name = 'IlinkQrLoginError';
+  }
+}
+
+/** 与 adapter login.ts 的 buildBaseInfo 对齐的最小结构。 */
+function buildBaseInfo(): Record<string, string> {
+  return { channel_version: '0.0.0', bot_agent: 'Zhin.js' };
+}
+
+/**
+ * 微信 iLink 扫码登录：获取二维码 → 展示 → 长轮询直至 confirmed。
+ * 成功返回 bot_token 等凭证；过期/超时/网络失败抛 IlinkQrLoginError。
+ */
+export async function loginWithIlinkQr(options: IlinkQrLoginOptions): Promise<IlinkQrLoginResult> {
+  const fetchImpl = options.fetchImpl ?? fetch;
+  const sleep = options.sleep ?? ((ms: number) => new Promise<void>((r) => setTimeout(r, ms)));
+  const apiBaseUrl = options.baseUrl ?? DEFAULT_BASE_URL;
+  const timeoutMs = options.timeoutMs ?? 480_000;
+
+  let qr: QrCodeResponse;
+  try {
+    const res = await fetchImpl(
+      `${apiBaseUrl}/ilink/bot/get_bot_qrcode?bot_type=${encodeURIComponent(DEFAULT_BOT_TYPE)}`,
+      {
+        method: 'POST',
+        headers: { 'content-type': 'application/json' },
+        body: JSON.stringify({ local_token_list: [], base_info: buildBaseInfo() }),
+      },
+    );
+    if (!res.ok) throw new Error(`HTTP ${res.status}`);
+    qr = await res.json() as QrCodeResponse;
+  } catch (error) {
+    throw new IlinkQrLoginError(
+      `获取登录二维码失败：${error instanceof Error ? error.message : String(error)}`,
+      'network',
+    );
+  }
+
+  const qrcodeUrl = qr.qrcode_img_content || qr.qrcode;
+  await options.onQrCode(qrcodeUrl);
+
+  const deadline = Date.now() + timeoutMs;
+  let currentBaseUrl = apiBaseUrl;
+  let lastStatus: QrStatus | undefined;
+
+  while (Date.now() < deadline) {
+    let status: StatusResponse;
+    try {
+      const res = await fetchImpl(
+        `${currentBaseUrl}/ilink/bot/get_qrcode_status?qrcode=${encodeURIComponent(qr.qrcode)}`,
+        { signal: AbortSignal.timeout(QR_LONG_POLL_TIMEOUT_MS) },
+      );
+      if (!res.ok) throw new Error(`HTTP ${res.status}`);
+      status = await res.json() as StatusResponse;
+    } catch {
+      // 长轮询超时/瞬断视为继续等待
+      await sleep(POLL_INTERVAL_MS);
+      continue;
+    }
+
+    if (status.status !== lastStatus) {
+      lastStatus = status.status;
+      options.onStatus?.(status.status);
+    }
+
+    if (status.status === 'scaned_but_redirect' && status.redirect_host) {
+      currentBaseUrl = status.redirect_host.startsWith('http')
+        ? status.redirect_host
+        : `https://${status.redirect_host}`;
+    }
+
+    if (status.status === 'confirmed' || status.status === 'binded_redirect') {
+      if (!status.bot_token) {
+        throw new IlinkQrLoginError('扫码成功但未返回 bot_token，请重试或改用手动输入', 'protocol');
+      }
+      return {
+        botToken: status.bot_token,
+        ...(status.ilink_user_id ? { ilinkUserId: status.ilink_user_id } : {}),
+        ...(status.ilink_endpoint_id ? { ilinkBotId: status.ilink_endpoint_id } : {}),
+        baseUrl: status.baseurl ?? currentBaseUrl,
+      };
+    }
+
+    if (status.status === 'expired') {
+      throw new IlinkQrLoginError('二维码已过期', 'expired');
+    }
+
+    await sleep(POLL_INTERVAL_MS);
+  }
+
+  throw new IlinkQrLoginError('微信扫码登录超时', 'timeout');
+}