@rdjksp/node-napcat-ts 0.4.20

package/dist/NCWebsocketBase.d.ts

@@ -0,0 +1,58 @@
+import type { EventHandleMap, EventKey, HandlerResMap, NCWebsocketOptions, WSSendParam, WSSendReturn } from './Interfaces.js';
+export declare class NCWebsocketBase {
+    #private;
+    constructor(NCWebsocketOptions: NCWebsocketOptions, debug?: boolean);
+    /**
+     * await connect() 等待 ws 连接
+     */
+    connect(): Promise<void>;
+    disconnect(): void;
+    reconnect(): Promise<void>;
+    /**
+     * 发送API请求
+     * @param method API 端点
+     * @param params 请求参数
+     */
+    send<T extends keyof WSSendParam>(method: T, params: WSSendParam[T]): Promise<WSSendReturn[T]>;
+    /**
+     * 注册监听方法
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    on<T extends EventKey>(event: T, handle: EventHandleMap[T]): this;
+    /**
+     * 只执行一次
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    once<T extends EventKey>(event: T, handle: EventHandleMap[T]): this;
+    /**
+     * 解除监听方法
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    off<T extends EventKey>(event: T, handle: EventHandleMap[T]): this;
+    /**
+     * effect风格的订阅 效果同on
+     * @param event
+     * @param handle
+     * @returns 返回执行后取消订阅的函数
+     */
+    subscribe<T extends EventKey>(event: T, handle: EventHandleMap[T]): () => void;
+    /**
+     * effect风格的订阅 效果同once
+     * @param event
+     * @param handle
+     * @returns 返回执行后取消订阅的函数
+     */
+    subscribeOnce<T extends EventKey>(event: T, handle: EventHandleMap[T]): () => void;
+    /**
+     * 手动模拟触发某个事件
+     * @param type
+     * @param context
+     */
+    emit<T extends EventKey>(type: T, context: HandlerResMap[T]): this;
+}

package/dist/NCWebsocketBase.js

@@ -0,0 +1,276 @@
+import WebSocket from 'isomorphic-ws';
+import { nanoid } from 'nanoid';
+import { NCEventBus } from './NCEventBus.js';
+import { convertCQCodeToJSON, CQCodeDecode, logger } from './Utils.js';
+export class NCWebsocketBase {
+    #debug;
+    #baseUrl;
+    #accessToken;
+    #throwPromise;
+    #reconnection;
+    #socket;
+    #eventBus;
+    #echoMap;
+    constructor(NCWebsocketOptions, debug = false) {
+        this.#accessToken = NCWebsocketOptions.accessToken ?? '';
+        this.#throwPromise = NCWebsocketOptions.throwPromise ?? false;
+        if ('baseUrl' in NCWebsocketOptions) {
+            this.#baseUrl = NCWebsocketOptions.baseUrl;
+        }
+        else if ('protocol' in NCWebsocketOptions &&
+            'host' in NCWebsocketOptions &&
+            'port' in NCWebsocketOptions) {
+            const { protocol, host, port } = NCWebsocketOptions;
+            this.#baseUrl = protocol + '://' + host + ':' + port;
+        }
+        else {
+            throw new Error('NCWebsocketOptions must contain either "protocol && host && port" or "baseUrl"');
+        }
+        // 整理重连参数
+        const { enable = true, attempts = 10, delay = 5000 } = NCWebsocketOptions.reconnection ?? {};
+        this.#reconnection = { enable, attempts, delay, nowAttempts: 1 };
+        this.#debug = debug;
+        this.#eventBus = new NCEventBus(this);
+        this.#echoMap = new Map();
+    }
+    // ==================WebSocket操作=============================
+    /**
+     * await connect() 等待 ws 连接
+     */
+    async connect() {
+        return new Promise((resolve, reject) => {
+            this.#eventBus.emit('socket.connecting', { reconnection: this.#reconnection });
+            const socket = new WebSocket(`${this.#baseUrl}?access_token=${this.#accessToken}`);
+            socket.onopen = () => {
+                this.#eventBus.emit('socket.open', { reconnection: this.#reconnection });
+                this.#reconnection.nowAttempts = 1;
+                resolve();
+            };
+            socket.onclose = async (event) => {
+                this.#eventBus.emit('socket.close', {
+                    code: event.code,
+                    reason: event.reason,
+                    reconnection: this.#reconnection,
+                });
+                if (this.#reconnection.enable &&
+                    this.#reconnection.nowAttempts < this.#reconnection.attempts) {
+                    this.#reconnection.nowAttempts++;
+                    setTimeout(async () => {
+                        try {
+                            await this.reconnect();
+                        }
+                        catch (error) {
+                            reject(error);
+                        }
+                    }, this.#reconnection.delay);
+                }
+            };
+            socket.onmessage = (event) => this.#message(event.data);
+            socket.onerror = (event) => {
+                this.#eventBus.emit('socket.error', {
+                    reconnection: this.#reconnection,
+                    error_type: 'connect_error',
+                    errors: event?.error?.errors ?? [event?.error ?? null],
+                });
+                if (this.#throwPromise) {
+                    if (this.#reconnection.enable &&
+                        this.#reconnection.nowAttempts < this.#reconnection.attempts) {
+                        // 重连未到最后一次，等待继续重连，不抛出错误
+                        return;
+                    }
+                    reject({
+                        reconnection: this.#reconnection,
+                        error_type: 'connect_error',
+                        errors: event?.error?.errors ?? [event?.error ?? null],
+                    });
+                }
+            };
+            this.#socket = socket;
+        });
+    }
+    disconnect() {
+        if (this.#socket) {
+            this.#socket.close(1000);
+            this.#socket = undefined;
+        }
+    }
+    async reconnect() {
+        this.disconnect();
+        await this.connect();
+    }
+    #message(data) {
+        let strData;
+        try {
+            strData = data.toString();
+            // 检查数据是否看起来像有效的JSON (以 { 或 [ 开头)
+            if (!(strData.trim().startsWith('{') || strData.trim().startsWith('['))) {
+                logger.warn('[node-napcat-ts]', '[socket]', 'received non-JSON data:', strData);
+                return;
+            }
+            let json = JSON.parse(strData);
+            if (json.post_type === 'message' || json.post_type === 'message_sent') {
+                if (json.message_format === 'string') {
+                    // 直接处理message字段，而不是整个json对象
+                    json.message = convertCQCodeToJSON(CQCodeDecode(json.message));
+                    json.message_format = 'array';
+                }
+                if (typeof json.raw_message === 'string') {
+                    json.raw_message = CQCodeDecode(json.raw_message);
+                }
+            }
+            if (this.#debug) {
+                logger.debug('[node-napcat-ts]', '[socket]', 'receive data');
+                logger.dir(json);
+            }
+            if (json.echo) {
+                const handler = this.#echoMap.get(json.echo);
+                if (handler) {
+                    if (json.retcode === 0) {
+                        this.#eventBus.emit('api.response.success', json);
+                        handler.onSuccess(json);
+                    }
+                    else {
+                        this.#eventBus.emit('api.response.failure', json);
+                        handler.onFailure(json);
+                    }
+                }
+            }
+            else {
+                if (json?.status === 'failed' && json?.echo === null) {
+                    this.#reconnection.enable = false;
+                    this.#eventBus.emit('socket.error', {
+                        reconnection: this.#reconnection,
+                        error_type: 'response_error',
+                        info: {
+                            url: this.#baseUrl,
+                            errno: json.retcode,
+                            message: json.message,
+                        },
+                    });
+                    if (this.#throwPromise)
+                        throw new Error(json.message);
+                    this.disconnect();
+                    return;
+                }
+                this.#eventBus.parseMessage(json);
+            }
+        }
+        catch (error) {
+            logger.warn('[node-napcat-ts]', '[socket]', 'failed to parse JSON');
+            logger.dir(error);
+            return;
+        }
+    }
+    // ==================事件绑定=============================
+    /**
+     * 发送API请求
+     * @param method API 端点
+     * @param params 请求参数
+     */
+    send(method, params) {
+        const echo = nanoid();
+        const message = {
+            action: method,
+            params: params,
+            echo,
+        };
+        if (this.#debug) {
+            logger.debug('[node-open-napcat] send request');
+            logger.dir(message);
+        }
+        return new Promise((resolve, reject) => {
+            const onSuccess = (response) => {
+                this.#echoMap.delete(echo);
+                return resolve(response.data);
+            };
+            const onFailure = (reason) => {
+                this.#echoMap.delete(echo);
+                return reject(reason);
+            };
+            this.#echoMap.set(echo, {
+                message,
+                onSuccess,
+                onFailure,
+            });
+            this.#eventBus.emit('api.preSend', message);
+            if (this.#socket === undefined) {
+                reject({
+                    status: 'failed',
+                    retcode: -1,
+                    data: null,
+                    message: 'api socket is not connected',
+                    echo: '',
+                });
+            }
+            else if (this.#socket.readyState === WebSocket.CLOSING) {
+                reject({
+                    status: 'failed',
+                    retcode: -1,
+                    data: null,
+                    message: 'api socket is closed',
+                    echo: '',
+                });
+            }
+            else {
+                this.#socket.send(JSON.stringify(message));
+            }
+        });
+    }
+    /**
+     * 注册监听方法
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    on(event, handle) {
+        this.#eventBus.on(event, handle);
+        return this;
+    }
+    /**
+     * 只执行一次
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    once(event, handle) {
+        this.#eventBus.once(event, handle);
+        return this;
+    }
+    /**
+     * 解除监听方法
+     * @param event
+     * @param handle
+     * @returns 返回自身引用
+     */
+    off(event, handle) {
+        this.#eventBus.off(event, handle);
+        return this;
+    }
+    /**
+     * effect风格的订阅 效果同on
+     * @param event
+     * @param handle
+     * @returns 返回执行后取消订阅的函数
+     */
+    subscribe(event, handle) {
+        return this.#eventBus.subscribe(event, handle);
+    }
+    /**
+     * effect风格的订阅 效果同once
+     * @param event
+     * @param handle
+     * @returns 返回执行后取消订阅的函数
+     */
+    subscribeOnce(event, handle) {
+        return this.#eventBus.subscribeOnce(event, handle);
+    }
+    /**
+     * 手动模拟触发某个事件
+     * @param type
+     * @param context
+     */
+    emit(type, context) {
+        this.#eventBus.emit(type, context);
+        return this;
+    }
+}

package/dist/Structs.d.ts

@@ -0,0 +1,379 @@
+export interface UnSafeStruct {
+    type: string;
+    data: {
+        [k: string]: any;
+    };
+}
+export interface Receive {
+    text: {
+        type: 'text';
+        data: {
+            text: string;
+        };
+    };
+    at: {
+        type: 'at';
+        data: {
+            qq: string | 'all';
+        };
+    };
+    image: {
+        type: 'image';
+        data: {
+            summary: string;
+            file: string;
+            sub_type: number;
+            url: string;
+            file_size: string;
+        } | {
+            summary: string;
+            file: string;
+            sub_type: string;
+            url: string;
+            key: string;
+            emoji_id: string;
+            emoji_package_id: number;
+        };
+    };
+    file: {
+        type: 'file';
+        data: {
+            file: string;
+            file_id: string;
+            file_size: string;
+        };
+    };
+    poke: {
+        type: 'poke';
+        data: {
+            type: string;
+            id: string;
+        };
+    };
+    dice: {
+        type: 'dice';
+        data: {
+            result: string;
+        };
+    };
+    rps: {
+        type: 'rps';
+        data: {
+            result: string;
+        };
+    };
+    face: {
+        type: 'face';
+        data: {
+            id: string;
+            raw: {
+                faceIndex?: number;
+                faceText?: string;
+                faceType?: number;
+                packId?: string;
+                stickerId?: string;
+                sourceType?: number;
+                stickerType?: number;
+                resultId?: string;
+                surpriseId?: string;
+                randomType?: number;
+                imageType?: number;
+                pokeType?: number;
+                spokeSummary?: string;
+                doubleHit?: number;
+                vaspokeId?: number;
+                vaspokeName?: string;
+                vaspokeMinver?: number;
+                pokeStrength?: number;
+                msgType?: number;
+                faceBubbleCount?: number;
+                oldVersionStr?: string;
+                pokeFlag?: number;
+                chainCount?: number;
+            };
+            resultId: string | null;
+            chainCount: number | null;
+        };
+    };
+    reply: {
+        type: 'reply';
+        data: {
+            id: string;
+        };
+    };
+    video: {
+        type: 'video';
+        data: {
+            file: string;
+            url: string;
+            file_size: string;
+        };
+    };
+    record: {
+        type: 'record';
+        data: {
+            file: string;
+            file_size: string;
+        };
+    };
+    forward: {
+        type: 'forward';
+        data: {
+            id: string;
+            content?: Receive[keyof Receive][];
+        };
+    };
+    json: {
+        type: 'json';
+        data: {
+            data: string;
+        };
+    };
+    markdown: {
+        type: 'markdown';
+        data: {
+            content: string;
+        };
+    };
+}
+interface BaseSegment<T extends string, D> {
+    type: T;
+    data: D;
+}
+export interface TextSegment extends BaseSegment<'text', {
+    text: string;
+}> {
+}
+export interface AtSegment extends BaseSegment<'at', {
+    qq: string | 'all';
+}> {
+}
+export interface ReplySegment extends BaseSegment<'reply', {
+    id: string;
+}> {
+}
+export interface FaceSegment extends BaseSegment<'face', {
+    id: string;
+}> {
+}
+export interface MFaceSegment extends BaseSegment<'mface', {
+    emoji_id: string;
+    emoji_package_id: string;
+    key: string;
+    summary?: string;
+}> {
+}
+export interface ImageSegment extends BaseSegment<'image', {
+    file: string;
+    summary?: string;
+    sub_type?: string;
+}> {
+}
+export interface FileSegment extends BaseSegment<'file', {
+    file: string;
+    name?: string;
+}> {
+}
+export interface VideoSegment extends BaseSegment<'video', {
+    file: string;
+    name?: string;
+    thumb?: string;
+}> {
+}
+export interface RecordSegment extends BaseSegment<'record', {
+    file: string;
+}> {
+}
+export interface JsonSegment extends BaseSegment<'json', {
+    data: string;
+}> {
+}
+export interface DiceSegment extends BaseSegment<'dice', any> {
+}
+export interface RPSSegment extends BaseSegment<'rps', any> {
+}
+export interface MarkdownSegment extends BaseSegment<'markdown', {
+    content: string;
+}> {
+}
+export interface CloudMusicSegment extends BaseSegment<'music', {
+    type: 'qq' | '163' | 'kugou' | 'kuwo' | 'migu';
+    id: string;
+}> {
+}
+export interface MusicSegmentCustom extends BaseSegment<'music', {
+    type: 'qq' | '163' | 'kugou' | 'kuwo' | 'migu' | 'custom';
+    url: string;
+    image: string;
+    audio?: string;
+    title?: string;
+    singer?: string;
+}> {
+}
+export type MusicSegment = CloudMusicSegment | MusicSegmentCustom;
+export interface NodeSegment extends BaseSegment<'node', ({
+    content: SendMessageSegment[];
+} | {
+    id: string;
+}) & {
+    user_id?: string;
+    nickname?: string;
+    source?: string;
+    news?: {
+        text: string;
+    }[];
+    summary?: string;
+    prompt?: string;
+    time?: string;
+}> {
+}
+export interface ForwardSegment extends BaseSegment<'forward', {
+    id: string;
+}> {
+}
+export interface ContactSegment extends BaseSegment<'contact', {
+    type: 'qq' | 'group';
+    id: string;
+}> {
+}
+export type SendMessageSegment = TextSegment | AtSegment | ReplySegment | FaceSegment | MFaceSegment | ImageSegment | FileSegment | VideoSegment | RecordSegment | JsonSegment | DiceSegment | RPSSegment | MarkdownSegment | MusicSegment | NodeSegment | ForwardSegment | ContactSegment;
+export declare const Structs: {
+    /**
+     * 发送文字消息
+     * @param text 要发送的文字
+     * @returns { type: 'text', data: { text } }
+     */
+    text: (text: string) => TextSegment;
+    /**
+     * @某人
+     * @param qq at的QQ号
+     * @returns { type: 'at', data: { qq } }
+     */
+    at: (qq: string | "all" | number) => AtSegment;
+    /**
+     * 回复消息
+     * @param id 回复的消息id
+     * @returns { type: 'reply', data: { id } }
+     */
+    reply: (id: string | number) => ReplySegment;
+    /**
+     * 发送QQ表情
+     * @param id QQ 表情 ID
+     * @returns { type: 'face', data: { id, resultId, chainCount } }
+     */
+    face: (id: string | number) => FaceSegment;
+    /**
+     * 发送QQ表情包
+     * @param emoji_id 表情id
+     * @param emoji_package_id 表情包id
+     * @param key 未知(必要)
+     * @param summary 表情简介,可选
+     * @returns { type: 'mface', data: { summary, emoji_id, emoji_package_id, key } }
+     */
+    mface: (emoji_id: string | number, emoji_package_id: string | number, key: string, summary?: string) => MFaceSegment;
+    /**
+     * 发送图片
+     * @param file 网络图片地址, 文件路径或者Buffer
+     * @param name 图片名
+     * @param summary 图片简介
+     * @param sub_type 图片类型
+     * @returns { type: 'image', data: { file, summary, sub_type } }
+     */
+    image: (file: string | Buffer, summary?: string, sub_type?: string | number) => ImageSegment;
+    /**
+     * 发文件
+     * @param file 网络文件地址, 文件路径或者Buffer
+     * @param name 文件名
+     * @returns { type: 'file', data: { file, name } }
+     */
+    file: (file: string | Buffer, name?: string) => FileSegment;
+    /**
+     * 发视频
+     * @param file 网络视频地址, 文件路径或者Buffer
+     * @param name 视频名
+     * @param thumb 预览图
+     * @returns { type: 'video', data: { file, name, thumb } }
+     */
+    video: (file: string | Buffer, name?: string, thumb?: string) => VideoSegment;
+    /**
+     * 发语音
+     * @param file 网络语音地址, 文件路径或者Buffer
+     * @param name 语音备注
+     * @returns { type: 'record', data: { file, name } }
+     */
+    record: (file: string | Buffer) => RecordSegment;
+    /**
+     * 发送json消息
+     * @param data json信息(序列化后)
+     * @returns { type: 'json', data: { data } }
+     */
+    json: (data: string) => JsonSegment;
+    /**
+     * 发送骰子魔法表情
+     * @returns { type: 'dice', data: {} }
+     */
+    dice: () => DiceSegment;
+    /**
+     * 发送猜拳魔法
+     * @returns { type: 'rps', data: {} }
+     */
+    rps: () => RPSSegment;
+    /**
+     * 发送markdown
+     * @param data markdown内容
+     * @returns { type: 'markdown', data: {} }
+     */
+    markdown: (content: string) => MarkdownSegment;
+    /**
+     * 音乐分享
+     * @param type QQ音乐或网易云音乐QQ音乐
+     * @param id 音乐id
+     * @returns { type: 'music', data: { type, id } }
+     */
+    music: (type: "qq" | "163" | "kugou" | "migu" | "kuwo", id: string | number) => CloudMusicSegment;
+    /**
+     * 分享非qq、网易云音乐 需要配置签名服务器
+     * @param url 点击后跳转目标 URL
+     * @param audio 音乐 URL
+     * @param title 标题
+     * @param image 发送时可选，内容描述
+     * @param singer 发送时可选，图片 URL
+     * @returns { type: 'music', data: { type: 'custom', url, audio, title, image, singer } }
+     */
+    customMusic: (type: "qq" | "163" | "kugou" | "migu" | "kuwo" | "custom", url: string, image: string, audio?: string, title?: string, singer?: string) => MusicSegmentCustom;
+    /**
+     * 转发消息节点
+     * @param id 消息id
+     * @param user_id 消息id
+     * @param nickname 消息id
+     * @param source 消息id
+     * @param id 消息id
+     * @param id 消息id
+     * @returns { type: 'node', data: { id } }
+     */
+    node: (id: string | number, user_id?: number | string, nickname?: string, source?: string, news?: {
+        text: string;
+    }[], summary?: string, prompt?: string, time?: string | number) => NodeSegment;
+    /**
+     * 自定义转发消息节点
+     * @param content 消息内容
+     * @returns { type: 'node', data: { content } }
+     */
+    customNode: (content: SendMessageSegment[], user_id?: number | string, nickname?: string, source?: string, news?: {
+        text: string;
+    }[], summary?: string, prompt?: string, time?: string | number) => NodeSegment;
+    /**
+     * 转发消息
+     * @param message_id 消息id
+     * @return { type: 'forward', data: { id }}
+     */
+    forward: (message_id: number) => ForwardSegment;
+    /**
+     * 发送名片
+     * @param type 名片类型
+     * @param id 联系人QQ号
+     * @returns { type: 'contact', data: { id } }
+     */
+    contact: (type: "qq" | "group", id: number | string) => ContactSegment;
+};
+export {};