@zhin.js/adapter-napcat 3.0.1 → 4.0.1

package/lib/ws-endpoint.d.ts

@@ -0,0 +1,61 @@
+import type { EndpointInstance } from '@zhin.js/adapter';
+import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { CapabilityId } from '@zhin.js/plugin-runtime';
+import { type NapCatEvent, type NapCatWsConfig } from './protocol.js';
+import { type NapCatWsCreateOptions, type NapCatWsSocket } from './ws-types.js';
+export interface NapCatWsEndpointOptions {
+    readonly id: CapabilityId;
+    readonly gateway: MessageGateway;
+    readonly config: NapCatWsConfig;
+    readonly createWebSocket?: (url: string, options: NapCatWsCreateOptions) => NapCatWsSocket;
+}
+export declare class NapCatWsEndpoint implements EndpointInstance {
+    #private;
+    constructor(options: NapCatWsEndpointOptions);
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ target, payload }: {
+        readonly target: string;
+        readonly payload: unknown;
+    }): Promise<string>;
+    callApi(action: string, params?: Record<string, unknown>): Promise<unknown>;
+    setTitle(groupId: number, userId: number, title: string, duration?: number): Promise<boolean>;
+    sendLike(userId: number, times?: number): Promise<unknown>;
+    deleteFriend(userId: number): Promise<unknown>;
+    markMsgAsRead(messageId: number): Promise<unknown>;
+    ocrImage(image: string): Promise<unknown>;
+    setQQProfile(nickname: string, company?: string, email?: string, college?: string, personalNote?: string): Promise<unknown>;
+    setGroupPortrait(groupId: number, file: string): Promise<unknown>;
+    setEssenceMsg(messageId: number): Promise<unknown>;
+    deleteEssenceMsg(messageId: number): Promise<unknown>;
+    getEssenceMsgList(groupId: number): Promise<unknown>;
+    sendGroupSign(groupId: number): Promise<unknown>;
+    sendGroupNotice(groupId: number, content: string, image?: string): Promise<unknown>;
+    getGroupNotice(groupId: number): Promise<unknown>;
+    deleteGroupNotice(groupId: number, noticeId: string): Promise<unknown>;
+    uploadGroupFile(groupId: number, file: string, name: string, folder?: string): Promise<unknown>;
+    getGroupRootFiles(groupId: number): Promise<unknown>;
+    getGroupFileUrl(groupId: number, fileId: string, busid: number): Promise<unknown>;
+    downloadFile(url: string, threadCount?: number, headers?: string[]): Promise<unknown>;
+    setOnlineStatus(status: number, extStatus: number): Promise<unknown>;
+    setQQAvatar(file: string): Promise<unknown>;
+    forwardFriendSingleMsg(userId: number, messageId: number): Promise<unknown>;
+    forwardGroupSingleMsg(groupId: number, messageId: number): Promise<unknown>;
+    translateEn2Zh(sourceText: string): Promise<unknown>;
+    setMsgEmojiLike(messageId: number, emojiId: string): Promise<unknown>;
+    sendForwardMsg(messageType: 'private' | 'group', id: number, messages: unknown[]): Promise<unknown>;
+    getFriendMsgHistory(userId: number, messageSeq?: number, count?: number): Promise<unknown>;
+    getGroupMsgHistory(groupId: number, messageSeq?: number, count?: number): Promise<unknown>;
+    setSelfLongnick(longnick: string): Promise<unknown>;
+    getGroupInfoEx(groupId: number): Promise<unknown>;
+    sendPoke(userId: number, groupId?: number): Promise<unknown>;
+    ncGetUserStatus(userId: number): Promise<unknown>;
+    getGroupShutList(groupId: number): Promise<unknown>;
+    getMiniAppArk(type: string, title: string, desc: string, picUrl: string, jumpUrl: string): Promise<unknown>;
+    getAiCharacters(groupId: number): Promise<unknown>;
+    sendGroupAiRecord(groupId: number, characterId: string, text: string): Promise<unknown>;
+    /** Test / internal: admit a parsed event when the endpoint is open. */
+    admit(ev: NapCatEvent): void;
+}

package/lib/ws-endpoint.js

@@ -0,0 +1,357 @@
+/**
+ * NapCat WS client endpoint — outbound connect to NapCat.
+ */
+import WebSocket from 'ws';
+import { clearInterval, clearTimeout, setTimeout } from 'node:timers';
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { registerNapcatAgentEndpoint } from './napcat-agent-deps.js';
+import { InboundMessageDeduper, isNapCatBotMentioned, isSelfMessage, normalizeMessage, } from './napcat-inbound.js';
+import { buildSendAction, buildWsConnectOptions, formatInboundContent, formatInboundTarget, formatOutboundSegments, isMessageEvent, senderNickname, senderUserId, } from './protocol.js';
+import { callNapCatWsAction, handleNapCatWsMessage, rejectAllPending, startNapCatHeartbeat, } from './ws-transport.js';
+const logger = getLogger('napcat');
+export class NapCatWsEndpoint {
+    #options;
+    #inboundDeduper = new InboundMessageDeduper();
+    #ws;
+    #reconnectTimer;
+    #heartbeatTimer;
+    #requestId = { value: 0 };
+    #pending = new Map();
+    #open = false;
+    #started = false;
+    #stopping = false;
+    #unregisterAgent;
+    constructor(options) {
+        this.#options = options;
+    }
+    async start() {
+        if (this.#started)
+            return;
+        this.#started = true;
+        this.#stopping = false;
+        this.#unregisterAgent = registerNapcatAgentEndpoint(this.#options.config.name, this);
+        try {
+            await this.#connect();
+        }
+        catch (err) {
+            this.#started = false;
+            throw err;
+        }
+    }
+    open() {
+        this.#open = true;
+    }
+    close() {
+        this.#open = false;
+    }
+    async stop() {
+        this.#open = false;
+        this.#stopping = true;
+        this.#started = false;
+        this.#unregisterAgent?.();
+        this.#unregisterAgent = undefined;
+        if (this.#reconnectTimer) {
+            clearTimeout(this.#reconnectTimer);
+            this.#reconnectTimer = undefined;
+        }
+        if (this.#heartbeatTimer) {
+            clearInterval(this.#heartbeatTimer);
+            this.#heartbeatTimer = undefined;
+        }
+        rejectAllPending(this.#pending);
+        this.#inboundDeduper.clear();
+        if (this.#ws) {
+            try {
+                this.#ws.close();
+            }
+            catch {
+                /* ignore */
+            }
+            this.#ws = undefined;
+        }
+        logger.debug(formatCompact({ op: 'disconnect', endpoint: this.#options.config.name }));
+    }
+    async send({ target, payload }) {
+        const message = formatOutboundSegments(payload);
+        const { action, params } = buildSendAction(target, message);
+        const data = await this.callApi(action, params);
+        const messageId = data?.message_id != null ? String(data.message_id) : '';
+        logger.debug(formatCompact({
+            op: 'napcat_send',
+            endpoint: this.#options.config.name,
+            target,
+            messageId,
+        }));
+        return messageId;
+    }
+    callApi(action, params = {}) {
+        return callNapCatWsAction(this.#ws, this.#pending, this.#requestId, action, params);
+    }
+    // ── Agent-facing API wrappers ─────────────────────────────────────
+    async setTitle(groupId, userId, title, duration = -1) {
+        await this.callApi('set_group_special_title', {
+            group_id: groupId,
+            user_id: userId,
+            special_title: title,
+            duration,
+        });
+        return true;
+    }
+    sendLike(userId, times = 1) {
+        return this.callApi('send_like', { user_id: userId, times });
+    }
+    deleteFriend(userId) {
+        return this.callApi('delete_friend', { user_id: userId });
+    }
+    markMsgAsRead(messageId) {
+        return this.callApi('mark_msg_as_read', { message_id: messageId });
+    }
+    ocrImage(image) {
+        return this.callApi('ocr_image', { image });
+    }
+    setQQProfile(nickname, company, email, college, personalNote) {
+        return this.callApi('set_qq_profile', {
+            nickname,
+            company,
+            email,
+            college,
+            personal_note: personalNote,
+        });
+    }
+    setGroupPortrait(groupId, file) {
+        return this.callApi('set_group_portrait', { group_id: groupId, file });
+    }
+    setEssenceMsg(messageId) {
+        return this.callApi('set_essence_msg', { message_id: messageId });
+    }
+    deleteEssenceMsg(messageId) {
+        return this.callApi('delete_essence_msg', { message_id: messageId });
+    }
+    getEssenceMsgList(groupId) {
+        return this.callApi('get_essence_msg_list', { group_id: groupId });
+    }
+    sendGroupSign(groupId) {
+        return this.callApi('send_group_sign', { group_id: groupId });
+    }
+    sendGroupNotice(groupId, content, image) {
+        return this.callApi('_send_group_notice', { group_id: groupId, content, image });
+    }
+    getGroupNotice(groupId) {
+        return this.callApi('_get_group_notice', { group_id: groupId });
+    }
+    deleteGroupNotice(groupId, noticeId) {
+        return this.callApi('_del_group_notice', { group_id: groupId, notice_id: noticeId });
+    }
+    uploadGroupFile(groupId, file, name, folder) {
+        return this.callApi('upload_group_file', { group_id: groupId, file, name, folder });
+    }
+    getGroupRootFiles(groupId) {
+        return this.callApi('get_group_root_files', { group_id: groupId });
+    }
+    getGroupFileUrl(groupId, fileId, busid) {
+        return this.callApi('get_group_file_url', { group_id: groupId, file_id: fileId, busid });
+    }
+    downloadFile(url, threadCount = 1, headers) {
+        return this.callApi('download_file', { url, thread_count: threadCount, headers });
+    }
+    setOnlineStatus(status, extStatus) {
+        return this.callApi('set_online_status', { status, ext_status: extStatus });
+    }
+    setQQAvatar(file) {
+        return this.callApi('set_qq_avatar', { file });
+    }
+    forwardFriendSingleMsg(userId, messageId) {
+        return this.callApi('forward_friend_single_msg', { user_id: userId, message_id: messageId });
+    }
+    forwardGroupSingleMsg(groupId, messageId) {
+        return this.callApi('forward_group_single_msg', { group_id: groupId, message_id: messageId });
+    }
+    translateEn2Zh(sourceText) {
+        return this.callApi('translate_en2zh', { source_text: sourceText });
+    }
+    setMsgEmojiLike(messageId, emojiId) {
+        return this.callApi('set_msg_emoji_like', { message_id: messageId, emoji_id: emojiId });
+    }
+    sendForwardMsg(messageType, id, messages) {
+        return this.callApi('send_forward_msg', {
+            message_type: messageType,
+            [messageType === 'group' ? 'group_id' : 'user_id']: id,
+            messages,
+        });
+    }
+    getFriendMsgHistory(userId, messageSeq, count) {
+        return this.callApi('get_friend_msg_history', {
+            user_id: userId,
+            message_seq: messageSeq,
+            count,
+        });
+    }
+    getGroupMsgHistory(groupId, messageSeq, count) {
+        return this.callApi('get_group_msg_history', {
+            group_id: groupId,
+            message_seq: messageSeq,
+            count,
+        });
+    }
+    setSelfLongnick(longnick) {
+        return this.callApi('set_self_longnick', { longNick: longnick });
+    }
+    getGroupInfoEx(groupId) {
+        return this.callApi('get_group_info_ex', { group_id: groupId });
+    }
+    sendPoke(userId, groupId) {
+        return this.callApi('send_poke', { user_id: userId, group_id: groupId });
+    }
+    ncGetUserStatus(userId) {
+        return this.callApi('nc_get_user_status', { user_id: userId });
+    }
+    getGroupShutList(groupId) {
+        return this.callApi('get_group_shut_list', { group_id: groupId });
+    }
+    getMiniAppArk(type, title, desc, picUrl, jumpUrl) {
+        return this.callApi('get_mini_app_ark', { type, title, desc, picUrl, jumpUrl });
+    }
+    getAiCharacters(groupId) {
+        return this.callApi('get_ai_characters', { group_id: groupId });
+    }
+    sendGroupAiRecord(groupId, characterId, text) {
+        return this.callApi('send_group_ai_record', {
+            group_id: groupId,
+            character: characterId,
+            text,
+        });
+    }
+    /** Test / internal: admit a parsed event when the endpoint is open. */
+    admit(ev) {
+        if (!this.#open || !isMessageEvent(ev))
+            return;
+        if (isSelfMessage(ev))
+            return;
+        const msgId = String(ev.message_id);
+        if (!this.#inboundDeduper.shouldProcess(msgId))
+            return;
+        if (Array.isArray(ev.message) || typeof ev.message === 'string') {
+            ev = { ...ev, message: normalizeMessage(ev.message) };
+        }
+        const target = formatInboundTarget(ev);
+        const content = formatInboundContent(ev);
+        const nickname = senderNickname(ev);
+        const mentioned = isNapCatBotMentioned(ev);
+        void this.#options.gateway.receive({
+            adapter: this.#options.id,
+            target,
+            content,
+            sender: senderUserId(ev),
+            id: msgId,
+            metadata: Object.freeze({
+                message_type: ev.message_type,
+                user_id: ev.user_id != null ? String(ev.user_id) : undefined,
+                group_id: ev.group_id != null ? String(ev.group_id) : undefined,
+                endpoint: this.#options.config.name,
+                time: ev.time,
+                self_id: ev.self_id != null ? String(ev.self_id) : undefined,
+                role: ev.sender?.role,
+                ...(nickname ? { nickname } : {}),
+                ...(mentioned ? { mentioned: true } : {}),
+            }),
+        }).catch((err) => {
+            logger.warn(formatCompact({
+                op: 'napcat_gateway_receive_failed',
+                target,
+                error: err instanceof Error ? err.message : String(err),
+            }));
+        });
+    }
+    async #connect() {
+        const { url, headers, safeUrl } = buildWsConnectOptions(this.#options.config);
+        const create = this.#options.createWebSocket
+            ?? ((connectUrl, options) => new WebSocket(connectUrl, { headers: options.headers }));
+        await new Promise((resolve, reject) => {
+            let settled = false;
+            const ws = create(url, { headers });
+            this.#ws = ws;
+            ws.on('open', () => {
+                if (settled)
+                    return;
+                settled = true;
+                if (!this.#options.config.access_token) {
+                    logger.warn(formatCompact({
+                        endpoint: this.#options.config.name,
+                        ok: false,
+                        error: 'missing access_token',
+                    }));
+                }
+                logger.debug(formatCompact({
+                    endpoint: this.#options.config.name,
+                    mode: 'ws',
+                    url: safeUrl,
+                }));
+                this.#heartbeatTimer = this.#stopping
+                    ? this.#heartbeatTimer
+                    : startNapCatHeartbeat(this.#ws, this.#options.config.heartbeat_interval, this.#heartbeatTimer);
+                resolve();
+            });
+            ws.on('message', (data) => {
+                handleNapCatWsMessage(data, {
+                    endpointName: this.#options.config.name,
+                    pending: this.#pending,
+                    admit: (event) => this.admit(event),
+                });
+            });
+            ws.on('close', (code, reason) => {
+                const reasonStr = typeof reason === 'string'
+                    ? reason
+                    : Buffer.isBuffer(reason)
+                        ? reason.toString()
+                        : String(reason ?? '');
+                const codeNum = typeof code === 'number' ? code : Number(code ?? 0);
+                const codeHint = codeNum === 1005
+                    ? ' [no status]'
+                    : codeNum === 1006
+                        ? ' [abnormal]'
+                        : '';
+                logger.warn(formatCompact({
+                    op: 'disconnect',
+                    endpoint: this.#options.config.name,
+                    code: codeNum,
+                    error: `${reasonStr || 'closed'}${codeHint}`,
+                    reconnect_ms: this.#options.config.reconnect_interval,
+                }));
+                if (!settled) {
+                    settled = true;
+                    reject(new Error(`NapCat WS closed: ${codeNum} ${reasonStr}`));
+                }
+                this.#scheduleReconnect();
+            });
+            ws.on('error', (err) => {
+                const error = err instanceof Error ? err : new Error(String(err));
+                logger.warn(formatCompact({
+                    op: 'ws_error',
+                    endpoint: this.#options.config.name,
+                    ok: false,
+                    error: error.message,
+                }));
+                if (!settled) {
+                    settled = true;
+                    reject(error);
+                }
+            });
+        });
+    }
+    #scheduleReconnect() {
+        if (this.#stopping || !this.#started || this.#reconnectTimer)
+            return;
+        const delay = this.#options.config.reconnect_interval;
+        this.#reconnectTimer = setTimeout(() => {
+            this.#reconnectTimer = undefined;
+            void this.#connect().catch((err) => {
+                logger.warn(formatCompact({
+                    op: 'reconnect',
+                    endpoint: this.#options.config.name,
+                    ok: false,
+                    error: err instanceof Error ? err.message : String(err),
+                }));
+            });
+        }, delay);
+    }
+}

package/lib/ws-transport.d.ts

@@ -0,0 +1,13 @@
+import { type NapCatEvent } from './protocol.js';
+import { type NapCatPendingAction, type NapCatWsSocket } from './ws-types.js';
+export declare function decodeWsPayload(data: unknown): string;
+export declare function handleNapCatWsMessage(data: unknown, options: {
+    readonly endpointName: string;
+    readonly pending: Map<string, NapCatPendingAction>;
+    readonly admit: (ev: NapCatEvent) => void;
+}): void;
+export declare function callNapCatWsAction(ws: NapCatWsSocket | undefined, pending: Map<string, NapCatPendingAction>, requestId: {
+    value: number;
+}, action: string, params: Record<string, unknown>): Promise<unknown>;
+export declare function startNapCatHeartbeat(ws: NapCatWsSocket | undefined, intervalMs: number, existingTimer?: NodeJS.Timeout): NodeJS.Timeout;
+export declare function rejectAllPending(pending: Map<string, NapCatPendingAction>, message?: string): void;

package/lib/ws-transport.js

@@ -0,0 +1,75 @@
+import { clearInterval, clearTimeout, setInterval, setTimeout } from 'node:timers';
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { WS_OPEN, } from './ws-types.js';
+const logger = getLogger('napcat');
+export function decodeWsPayload(data) {
+    if (typeof data === 'string')
+        return data;
+    if (Buffer.isBuffer(data))
+        return data.toString();
+    if (data instanceof ArrayBuffer)
+        return new TextDecoder().decode(data);
+    return String(data ?? '');
+}
+export function handleNapCatWsMessage(data, options) {
+    try {
+        const raw = decodeWsPayload(data);
+        const msg = JSON.parse(raw);
+        if ('echo' in msg && typeof msg.echo === 'string') {
+            const resp = msg;
+            const pending = options.pending.get(resp.echo);
+            if (pending) {
+                options.pending.delete(resp.echo);
+                clearTimeout(pending.timeout);
+                if (resp.status === 'ok')
+                    pending.resolve(resp.data);
+                else {
+                    pending.reject(new Error(`API error [${resp.retcode}]: ${resp.message || resp.wording || 'unknown'}`));
+                }
+            }
+            return;
+        }
+        options.admit(msg);
+    }
+    catch (error) {
+        logger.warn(formatCompact({
+            op: 'napcat_parse_failed',
+            endpoint: options.endpointName,
+            error: error instanceof Error ? error.message : String(error),
+        }));
+    }
+}
+export function callNapCatWsAction(ws, pending, requestId, action, params) {
+    if (!ws || ws.readyState !== WS_OPEN) {
+        return Promise.reject(new Error('WebSocket is not connected'));
+    }
+    const echo = `req_${++requestId.value}`;
+    const req = { action, params, echo };
+    return new Promise((resolve, reject) => {
+        const timeout = setTimeout(() => {
+            pending.delete(echo);
+            reject(new Error(`API call timeout: ${action}`));
+        }, 30_000);
+        pending.set(echo, { resolve, reject, timeout });
+        ws.send(JSON.stringify(req));
+    });
+}
+export function startNapCatHeartbeat(ws, intervalMs, existingTimer) {
+    if (existingTimer)
+        clearInterval(existingTimer);
+    return setInterval(() => {
+        try {
+            ws?.ping?.();
+        }
+        catch {
+            /* ignore */
+        }
+    }, intervalMs);
+}
+export function rejectAllPending(pending, message = 'Connection closed') {
+    for (const [, entry] of pending) {
+        clearTimeout(entry.timeout);
+        entry.reject(new Error(message));
+    }
+    pending.clear();
+}

package/lib/ws-types.d.ts

@@ -0,0 +1,17 @@
+/** Minimal WS surface used by the endpoint (real `ws` or test mock). */
+export interface NapCatWsSocket {
+    readonly readyState: number;
+    send(data: string): void;
+    close(code?: number, reason?: string): void;
+    ping?(): void;
+    on(event: 'open' | 'message' | 'close' | 'error', listener: (...args: unknown[]) => void): void;
+}
+export interface NapCatWsCreateOptions {
+    readonly headers?: Record<string, string>;
+}
+export declare const WS_OPEN = 1;
+export interface NapCatPendingAction {
+    resolve: (value: unknown) => void;
+    reject: (err: Error) => void;
+    timeout: NodeJS.Timeout;
+}

package/lib/ws-types.js

@@ -0,0 +1 @@
+export const WS_OPEN = 1;

package/lib/wss-auth.d.ts

@@ -0,0 +1,2 @@
+import type { IncomingMessage } from 'node:http';
+export declare function verifyNapCatAccessToken(accessToken: string | undefined, request: IncomingMessage): boolean;

package/lib/wss-auth.js

@@ -0,0 +1,16 @@
+export function verifyNapCatAccessToken(accessToken, request) {
+    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;
+}

package/lib/wss-endpoint.d.ts

@@ -0,0 +1,25 @@
+import type { EndpointInstance } from '@zhin.js/adapter';
+import type { MessageGateway } from '@zhin.js/core/runtime';
+import type { HttpHost } from '@zhin.js/host-http';
+import type { CapabilityId } from '@zhin.js/plugin-runtime';
+import { type NapCatEvent, type NapCatWssConfig } from './protocol.js';
+export interface NapCatWssEndpointOptions {
+    readonly id: CapabilityId;
+    readonly gateway: MessageGateway;
+    readonly http: HttpHost;
+    readonly config: NapCatWssConfig;
+}
+export declare class NapCatWssEndpoint implements EndpointInstance {
+    #private;
+    constructor(options: NapCatWssEndpointOptions);
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ target, payload }: {
+        readonly target: string;
+        readonly payload: unknown;
+    }): Promise<string>;
+    callApi(action: string, params?: Record<string, unknown>): Promise<unknown>;
+    admit(ev: NapCatEvent): void;
+}