@zhin.js/adapter-icqq 1.1.17 → 1.1.19

package/commands/icqq/login/qr/index.js

@@ -0,0 +1,53 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineCommand } from 'zhin.js/command';
+import { icqqLoginControls, icqqLoginForbidden, isIcqqLoginOperator, pickIcqqLoginControl, } from '../definition.js';
+const QR_IMAGE = /^data:image\/[a-z0-9.+-]+;base64,(.+)$/iu;
+export default defineCommand({
+    description: '获取 ICQQ 登录二维码（发给当前会话）',
+    descriptionI18n: { en: 'Fetch the ICQQ login QR code into this conversation' },
+    async execute({ args, config, input, project, owner }) {
+        if (!isIcqqLoginOperator(config, input))
+            return icqqLoginForbidden();
+        const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+        if (!picked.control)
+            return picked.text ?? 'ICQQ 适配器还没有启动';
+        const control = picked.control;
+        const findQr = () => control.pending().find((task) => task.type === 'qrcode' || task.type === 'auth');
+        let task = findQr();
+        if (!task) {
+            const other = control.pending().find((item) => item.type !== 'qrcode' && item.type !== 'auth');
+            if (other) {
+                const url = typeof other.payload.url === 'string' ? other.payload.url : '';
+                return `ICQQ ${other.endpointKey} 当前是${other.type === 'slider' ? '滑块验证' : '登录验证'}，请打开 ${url || '验证页面'}，`
+                    + '完成后回复 `icqq login code <内容>`。';
+            }
+            try {
+                await control.relogin();
+            }
+            catch {
+                // The SDK may still deliver a QR challenge asynchronously.
+            }
+            task = findQr();
+            if (!task)
+                return '已触发重新登录，请 5 秒后再发送 `icqq login qr` 获取二维码。';
+        }
+        const raw = typeof task.payload.image === 'string' ? task.payload.image : '';
+        const base64 = QR_IMAGE.exec(raw)?.[1];
+        if (!base64) {
+            return `ICQQ ${task.endpointKey} 当前是 ${task.type === 'qrcode' ? '二维码' : '登录确认'}待办，但没有可发送的图片；请打开 Console 的 ICQQ 页面完成。`;
+        }
+        return [
+            {
+                type: 'text',
+                data: {
+                    text: `ICQQ ${task.endpointKey} 登录二维码（约 3 分钟有效）。\n`
+                        + '用手机 QQ 扫码，完成后回复 `icqq login confirm`。',
+                },
+            },
+            {
+                type: 'image',
+                data: { media: { kind: 'base64', value: base64, mime_type: 'image/png' } },
+            },
+        ];
+    },
+});

package/commands/icqq/login/qr/index.ts

@@ -0,0 +1,55 @@
+import { defineCommand } from 'zhin.js/command';
+import {
+  icqqLoginControls,
+  icqqLoginForbidden,
+  isIcqqLoginOperator,
+  pickIcqqLoginControl,
+} from '../definition.js';
+
+const QR_IMAGE = /^data:image\/[a-z0-9.+-]+;base64,(.+)$/iu;
+
+export default defineCommand({
+  description: '获取 ICQQ 登录二维码（发给当前会话）',
+  descriptionI18n: { en: 'Fetch the ICQQ login QR code into this conversation' },
+  async execute({ args, config, input, project, owner }) {
+    if (!isIcqqLoginOperator(config, input)) return icqqLoginForbidden();
+    const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+    if (!picked.control) return picked.text ?? 'ICQQ 适配器还没有启动';
+    const control = picked.control;
+    const findQr = () => control.pending().find((task) => task.type === 'qrcode' || task.type === 'auth');
+    let task = findQr();
+    if (!task) {
+      const other = control.pending().find((item) => item.type !== 'qrcode' && item.type !== 'auth');
+      if (other) {
+        const url = typeof other.payload.url === 'string' ? other.payload.url : '';
+        return `ICQQ ${other.endpointKey} 当前是${other.type === 'slider' ? '滑块验证' : '登录验证'}，请打开 ${url || '验证页面'}，`
+          + '完成后回复 `icqq login code <内容>`。';
+      }
+      try {
+        await control.relogin();
+      } catch {
+        // The SDK may still deliver a QR challenge asynchronously.
+      }
+      task = findQr();
+      if (!task) return '已触发重新登录，请 5 秒后再发送 `icqq login qr` 获取二维码。';
+    }
+    const raw = typeof task.payload.image === 'string' ? task.payload.image : '';
+    const base64 = QR_IMAGE.exec(raw)?.[1];
+    if (!base64) {
+      return `ICQQ ${task.endpointKey} 当前是 ${task.type === 'qrcode' ? '二维码' : '登录确认'}待办，但没有可发送的图片；请打开 Console 的 ICQQ 页面完成。`;
+    }
+    return [
+      {
+        type: 'text',
+        data: {
+          text: `ICQQ ${task.endpointKey} 登录二维码（约 3 分钟有效）。\n`
+            + '用手机 QQ 扫码，完成后回复 `icqq login confirm`。',
+        },
+      },
+      {
+        type: 'image',
+        data: { media: { kind: 'base64', value: base64, mime_type: 'image/png' } },
+      },
+    ];
+  },
+});

package/commands/icqq/login/retry/index.js

@@ -0,0 +1,21 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineCommand } from 'zhin.js/command';
+import { icqqLoginControls, icqqLoginForbidden, isIcqqLoginOperator, pickIcqqLoginControl, } from '../definition.js';
+export default defineCommand({
+    description: '重新触发 ICQQ 登录',
+    descriptionI18n: { en: 'Trigger an ICQQ login attempt again' },
+    async execute({ args, config, input, project, owner }) {
+        if (!isIcqqLoginOperator(config, input))
+            return icqqLoginForbidden();
+        const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+        if (!picked.control)
+            return picked.text ?? 'ICQQ 适配器还没有启动';
+        try {
+            await picked.control.relogin();
+            return `已触发 ICQQ ${picked.control.endpointId} 重新登录；需要扫码时发送 \`icqq login qr\`。`;
+        }
+        catch {
+            return `ICQQ ${picked.control.endpointId} 重新登录失败，请稍后重试或查看日志。`;
+        }
+    },
+});

package/commands/icqq/login/retry/index.ts

@@ -0,0 +1,23 @@
+import { defineCommand } from 'zhin.js/command';
+import {
+  icqqLoginControls,
+  icqqLoginForbidden,
+  isIcqqLoginOperator,
+  pickIcqqLoginControl,
+} from '../definition.js';
+
+export default defineCommand({
+  description: '重新触发 ICQQ 登录',
+  descriptionI18n: { en: 'Trigger an ICQQ login attempt again' },
+  async execute({ args, config, input, project, owner }) {
+    if (!isIcqqLoginOperator(config, input)) return icqqLoginForbidden();
+    const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+    if (!picked.control) return picked.text ?? 'ICQQ 适配器还没有启动';
+    try {
+      await picked.control.relogin();
+      return `已触发 ICQQ ${picked.control.endpointId} 重新登录；需要扫码时发送 \`icqq login qr\`。`;
+    } catch {
+      return `ICQQ ${picked.control.endpointId} 重新登录失败，请稍后重试或查看日志。`;
+    }
+  },
+});

package/commands/icqq/login/status/index.js

@@ -0,0 +1,31 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineCommand } from 'zhin.js/command';
+import { icqqLoginControls, icqqLoginForbidden, isIcqqLoginOperator, pendingTaskLabel, pickIcqqLoginControl, } from '../definition.js';
+export default defineCommand({
+    description: '查看 ICQQ 掉线状态与登录待办',
+    descriptionI18n: { en: 'Show ICQQ offline status and pending login tasks' },
+    async execute({ args, config, input, project, owner }) {
+        if (!isIcqqLoginOperator(config, input))
+            return icqqLoginForbidden();
+        const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+        if (!picked.control)
+            return picked.text ?? 'ICQQ 适配器还没有启动';
+        const state = picked.control.state();
+        const lines = [
+            `ICQQ ${state.endpointId}: ${state.online ? '在线' : '离线'}（${state.transportState}）`,
+        ];
+        if (state.pending.length === 0) {
+            lines.push('没有待处理的登录验证。');
+        }
+        else {
+            lines.push('待处理：');
+            for (const task of state.pending) {
+                const url = typeof task.payload.url === 'string' ? task.payload.url : undefined;
+                lines.push(`- ${pendingTaskLabel(task.type)}（${task.id}，endpoint ${task.endpointKey}）`
+                    + (url ? `：${url}` : ''));
+            }
+            lines.push('二维码：`icqq login qr`；完成扫码后：`icqq login confirm`；滑块/短信：`icqq login code <内容>`。');
+        }
+        return lines.join('\n');
+    },
+});

package/commands/icqq/login/status/index.ts

@@ -0,0 +1,34 @@
+import { defineCommand } from 'zhin.js/command';
+import {
+  icqqLoginControls,
+  icqqLoginForbidden,
+  isIcqqLoginOperator,
+  pendingTaskLabel,
+  pickIcqqLoginControl,
+} from '../definition.js';
+
+export default defineCommand({
+  description: '查看 ICQQ 掉线状态与登录待办',
+  descriptionI18n: { en: 'Show ICQQ offline status and pending login tasks' },
+  async execute({ args, config, input, project, owner }) {
+    if (!isIcqqLoginOperator(config, input)) return icqqLoginForbidden();
+    const picked = pickIcqqLoginControl(icqqLoginControls({ project, owner }), args[0]);
+    if (!picked.control) return picked.text ?? 'ICQQ 适配器还没有启动';
+    const state = picked.control.state();
+    const lines = [
+      `ICQQ ${state.endpointId}: ${state.online ? '在线' : '离线'}（${state.transportState}）`,
+    ];
+    if (state.pending.length === 0) {
+      lines.push('没有待处理的登录验证。');
+    } else {
+      lines.push('待处理：');
+      for (const task of state.pending) {
+        const url = typeof task.payload.url === 'string' ? task.payload.url : undefined;
+        lines.push(`- ${pendingTaskLabel(task.type)}（${task.id}，endpoint ${task.endpointKey}）`
+          + (url ? `：${url}` : ''));
+      }
+      lines.push('二维码：`icqq login qr`；完成扫码后：`icqq login confirm`；滑块/短信：`icqq login code <内容>`。');
+    }
+    return lines.join('\n');
+  },
+});

package/lib/adapter.d.ts

@@ -0,0 +1,13 @@
+import { Adapter, type AdapterContext, type EndpointCreationContext } from 'zhin.js/adapter';
+import { IcqqEndpoint } from './endpoint.js';
+import { type IcqqEndpointConfig } from './protocol.js';
+import type { IcqqClientEventMap } from './client.js';
+/** ICQQ account construction and actual SDK ownership belong to this Adapter. */
+export declare class IcqqAdapter extends Adapter<IcqqEndpoint, IcqqEndpointConfig, IcqqClientEventMap> {
+    #private;
+    get configurationIdentityFields(): readonly string[];
+    get configurationUpdateFields(): readonly string[];
+    constructor(context: AdapterContext<IcqqEndpointConfig>);
+    protected validateConfiguration(config: IcqqEndpointConfig): void;
+    protected createEndpoint(input: IcqqEndpointConfig, execution: EndpointCreationContext): IcqqEndpoint;
+}

package/lib/adapter.js

@@ -0,0 +1,27 @@
+import { Adapter, createAdapterOutageNotifier } from 'zhin.js/adapter';
+import { projectLocaleToken } from 'zhin.js/i18n';
+import { loginAssistToken } from '@zhin.js/core/runtime';
+import { outboundHostToken } from 'zhin.js';
+import { IcqqEndpoint } from './endpoint.js';
+import { resolveIcqqConfig } from './protocol.js';
+/** ICQQ account construction and actual SDK ownership belong to this Adapter. */
+export class IcqqAdapter extends Adapter {
+    get configurationIdentityFields() { return ['id']; }
+    get configurationUpdateFields() {
+        return ['password', 'platform', 'ver', 'dataDir', 'signApiAddr', 'autoReconnect', 'autoServer', 'qqnt', 'ntLogin'];
+    }
+    #context;
+    constructor(context) { super(); this.#context = context; }
+    validateConfiguration(config) { resolveIcqqConfig(config); }
+    createEndpoint(input, execution) {
+        const context = this.#context;
+        const config = resolveIcqqConfig(input);
+        const outbound = context.has?.(outboundHostToken) ? context.use(outboundHostToken) : undefined;
+        const endpoint = new IcqqEndpoint({ id: execution.canonicalId, config,
+            signal: execution.signal, endpointIdentity: { canonicalId: execution.canonicalId, instanceId: execution.instanceId, epoch: execution.epoch, incarnationId: execution.incarnationId },
+            loginAssist: context.use(loginAssistToken), locale: context.use(projectLocaleToken),
+            notifier: createAdapterOutageNotifier(outbound, config.notify),
+        });
+        return endpoint;
+    }
+}

package/lib/client.d.ts

@@ -1,19 +1,16 @@
-import type { Client, EventMap } from '@icqqjs/icqq';
+import type { IcqqAdapter } from './adapter.js';
+import type { IcqqEndpoint } from './endpoint.js';
+import type { EventMap } from '@icqqjs/icqq';
 type EventPayload<TListener> = TListener extends (event: infer TEvent, ...rest: readonly unknown[]) => unknown ? TEvent : never;
 /** The actual ICQQ SDK instance exposed by every ICQQ Endpoint event. */
-export type IcqqClient = Client;
+export type IcqqClient = IcqqEndpoint;
 /** Native ICQQ event-name → first public event payload, derived from the SDK SSOT. */
 export type IcqqClientEventMap = {
     readonly [TName in keyof EventMap]: EventPayload<EventMap[TName]>;
 };
 declare module '@zhin.js/feature-kit' {
-    interface AdapterClientRegistry {
-        readonly icqq: {
-            readonly client: IcqqClient;
-            readonly events: IcqqClientEventMap;
-        };
+    interface AdapterRegistry {
+        readonly icqq: IcqqAdapter;
     }
 }
-/** Typed, generation-checked identity used by handlers, commands, tools and schedules. */
-export declare const icqqClient: import("@zhin.js/adapter").EndpointClientToken<Client, IcqqClientEventMap>;
 export {};

package/lib/client.js

@@ -1,3 +1 @@
-import { defineEndpointClient } from 'zhin.js/adapter';
-/** Typed, generation-checked identity used by handlers, commands, tools and schedules. */
-export const icqqClient = defineEndpointClient('icqq');
+export {};

package/lib/console-spec.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ICQQ Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+export declare const icqqConsoleSpec: {
+    readonly adapterKey: "icqq";
+    readonly adapterDisplayName: "ICQQ";
+    readonly fields: readonly AdapterConsoleField[];
+    readonly docsUrl: "https://zhin.js.org/adapters/icqq";
+    readonly readPermission: "icqq:read";
+    readonly writePermission: "icqq:write";
+    readonly idPattern: RegExp;
+    readonly idHint: "ICQQ endpoint id 是 QQ 号（纯数字）";
+    readonly idHintI18n: {
+        readonly en: "ICQQ endpoint ID is the QQ number (digits only)";
+    };
+};

package/lib/console-spec.js

@@ -0,0 +1,21 @@
+export const icqqConsoleSpec = {
+    adapterKey: 'icqq',
+    adapterDisplayName: 'ICQQ',
+    fields: [
+        { key: 'password', env: true, description: 'QQ password; leave blank to retain the saved credential' },
+        { key: 'platform', type: 'number', description: 'ICQQ platform number' },
+        { key: 'ver', description: 'ICQQ protocol version' },
+        { key: 'dataDir', description: 'ICQQ device and session directory' },
+        { key: 'signApiAddr', description: 'ICQQ signing service URL' },
+        { key: 'autoReconnect', type: 'boolean', description: 'ICQQ reconnect setting' },
+        { key: 'autoServer', type: 'boolean', description: 'ICQQ automatic server selection' },
+        { key: 'qqnt', type: 'boolean', description: 'QQNT protocol' },
+        { key: 'ntLogin', type: 'boolean', description: 'QQNT login' },
+    ],
+    docsUrl: 'https://zhin.js.org/adapters/icqq',
+    readPermission: 'icqq:read',
+    writePermission: 'icqq:write',
+    idPattern: /^\d+$/,
+    idHint: 'ICQQ endpoint id 是 QQ 号（纯数字）',
+    idHintI18n: { en: 'ICQQ endpoint ID is the QQ number (digits only)' },
+};

package/lib/console.d.ts

@@ -0,0 +1,2 @@
+import type { PluginConsoleRpc } from 'zhin.js';
+export declare function createIcqqConsoleRpc(getConfig: () => unknown): PluginConsoleRpc;

package/lib/console.js

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

package/lib/endpoint.d.ts

@@ -1,29 +1,26 @@
-import { Client } from '@icqqjs/icqq';
-import { Endpoint, type EndpointControl, type EndpointManagement, type EndpointSendRequest, type EndpointTransportState } from 'zhin.js/adapter';
-import type { EndpointContentPort } from '@zhin.js/adapter';
-import { type LoginAssist } from '@zhin.js/core';
+import { endpointSpec, type Endpoint, type EndpointSpecification, type AdapterOutageNotifier } from 'zhin.js/adapter';
+import { type LoginAssist, type LoginAssistEndpointIdentity } from '@zhin.js/core';
 import type { CapabilityId } from 'zhin.js';
+import type { IcqqLoginControl } from './icqq-login-control.js';
 import { type IcqqInboundMessage, type ResolvedIcqqConfig } from './protocol.js';
 import { ManagedIcqqClient } from './managed-client.js';
 export interface IcqqEndpointOptions {
     readonly id: CapabilityId;
     readonly config: ResolvedIcqqConfig;
+    readonly signal?: AbortSignal;
+    readonly endpointIdentity?: LoginAssistEndpointIdentity;
     readonly loginAssist: LoginAssist;
     readonly locale?: import('zhin.js/i18n').Locale;
+    /** Out-of-band outage notifier; absent in tests/hosts without outbound. */
+    readonly notifier?: AdapterOutageNotifier;
 }
-export declare class IcqqEndpoint extends Endpoint<Client> {
+export declare class IcqqEndpoint extends ManagedIcqqClient implements Endpoint {
     #private;
-    readonly client: ManagedIcqqClient;
+    readonly [endpointSpec]: EndpointSpecification;
     readonly endpointName: string;
-    readonly content: EndpointContentPort;
-    readonly management: EndpointManagement;
-    readonly control: EndpointControl;
+    readonly loginControl: IcqqLoginControl;
     constructor(options: IcqqEndpointOptions);
-    get transportState(): EndpointTransportState;
-    start(signal: AbortSignal): Promise<void>;
-    open(): void;
-    close(): Promise<void>;
-    stop(): Promise<void>;
-    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
+    /** Force a login attempt (manual recovery command). */
+    relogin(): Promise<void>;
     admit(msg: IcqqInboundMessage): Promise<void>;
 }