node-karin 0.12.0 → 0.12.2-5.pr.206.027f2f2

package/lib/utils/common/common.d.ts

@@ -1,236 +0,0 @@
-import fs from 'fs';
-import { AxiosRequestConfig } from 'axios';
-import { Readable } from 'stream';
-import { ButtonElement, ButtonType, dirName, KarinElement, NodeElement, KeyBoardElement } from '../../types/index.js';
-export interface NpmInfo {
-    plugin: string;
-    path: string;
-    file: string;
-    isMain: boolean;
-}
-/**
- * 常用方法
- */
-export declare class Common {
-    streamPipeline: (stream1: Readable, stream2: fs.WriteStream) => Promise<void>;
-    constructor();
-    /**
-     * 休眠函数
-     * @param ms 毫秒
-     */
-    sleep(ms: number): Promise<unknown>;
-    /**
-     * 下载保存文件
-     * @param  fileUrl 下载地址
-     * @param  savePath 保存路径
-     * @param param axios参数
-     */
-    downFile(fileUrl: string, savePath: string, param?: AxiosRequestConfig): Promise<boolean>;
-    /**
-     * 对axios进行简单封装，超时、错误后返回null，不会抛出异常
-     * @param url 请求地址
-     * @param type 请求类型
-     * @param param axios参数
-     */
-    axios(url: string, type?: 'get' | 'post', param?: AxiosRequestConfig): Promise<any | null>;
-    /**
-     * 递归创建目录
-     * @param dirname - 要创建的文件夹路径
-     */
-    mkdir(dirname: string): boolean;
-    /**
-     * 标准化文件路径
-     * @param file - 相对路径
-     * @param isDir - 返回绝对路径
-     * @param isFile - 添加file://前缀
-     * @returns 标准化后的路径
-     */
-    absPath(file: string, isDir?: boolean, isFile?: boolean): string;
-    /**
-     * 判断是否为文件夹
-     * @param path - 路径
-     * @returns 返回true为文件夹
-     */
-    isDir(path: string): boolean;
-    /**
-     * 判断是否为插件包
-     * @param path - 路径
-     * @returns 返回true为插件包
-     */
-    isPlugin(path: string): boolean;
-    /**
-     * 去掉相对路径的前缀和后缀
-     * @param root - 相对路径路径
-     */
-    getRelPath(root: string): string;
-    /**
-     * 判断路径是否存在
-     * @param path - 路径
-     * @returns 返回true为存在
-     */
-    exists(path: string): boolean;
-    /**
-     * - 解析json文件
-     * @param file - 文件路径
-     * @param isThrow - 解析失败是否抛出错误
-     */
-    readJson(file: string, isThrow?: boolean): any;
-    /**
-     * - 写入json文件
-     * @param file - 文件路径
-     * @param data - 要写入的数据
-     */
-    writeJson(file: string, data: any): boolean;
-    /**
-     * - 解析yaml文件
-     * @param file - 文件路径
-     */
-    readYaml(file: string): any;
-    /**
-     * - 写入yaml文件
-     * @param file - 文件路径
-     * @param data - 要写入的数据
-     */
-    writeYaml(file: string, data: any): boolean;
-    /**
-     * 传入插件名称 返回解析后的package.json的内容
-     * @param name - 插件名称
-     */
-    pkgJson(name: string): {
-        name: string;
-        version: string;
-        [key: string]: any;
-    } | null;
-    /**
-     * 输入包名 返回包根目录的绝对路径 仅简单查找
-     * @param name - 包名
-     * @param _path - 导入包的路径 此项适用于在插件中读取插件的依赖包
-     * @returns - 包根目录的绝对路径
-     * @example
-     * common.pkgroot('axios')
-     * common.pkgroot('axios', import.meta.url)
-     */
-    pkgroot(name: string, _path?: string): string;
-    /**
-     * 根据文件后缀名从指定路径下读取符合要求的文件
-     * @param path - 路径
-     * @param ext - 后缀名、或后缀名列表
-     * @example common.readDir('./plugins', '.js')
-     * @example common.readDir('./plugins', ['.js', '.ts'])
-     */
-    readDir(_path: string, ext: string | string[]): string[] | null;
-    /**
-     * 根据传入的 import.meta.url 计算相对于项目根目录的路径，返回需要的 '../' 层级。
-     * @param url - import.meta.url
-     * @returns 相对路径的层级数量，用 '../' 表示
-     * @example
-     * // 在 plugins/karin-plugin-example/index.ts 中使用
-     * common.urlToPath(import.meta.url) // 返回 '../../'
-     */
-    urlToPath(url: string): string;
-    /**
-     * 传入相对路径 分割为两部分 1为文件夹路径 2为文件名 文件夹路径无前缀开头
-     * @param _path - 路径
-     */
-    splitPath(_path: string): {
-        dir: string;
-        pop: string;
-    };
-    /**
-     * 将文件转换为不带前缀的base64字符串
-     * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
-     * @param options - 选项 http为true时返回http地址
-     * @returns 返回base64字符串
-     */
-    base64(file: string | Buffer | Readable, options?: {
-        http: boolean;
-    }): Promise<string>;
-    /**
-     * 将文件转换为Buffer对象 仅支持标准格式
-     * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
-     * @param options - 选项 http为true时返回http地址
-     * @returns - 返回Buffer对象
-     */
-    buffer<T extends {
-        http: boolean;
-    }>(file: string | Buffer | Readable, options?: T): Promise<T extends {
-        http: true;
-    } ? string : Buffer>;
-    /**
-     * 将数据流对象转换为Buffer对象
-     * @param {stream.Readable} stream - 要转换的数据流对象
-     * @returns {Promise<Buffer>} - 返回Buffer
-     */
-    stream(stream: Readable): Promise<Buffer>;
-    /**
-     * 标准化发送的消息内容
-     * @param elements - 消息内容
-     */
-    makeMessage(elements: string | KarinElement | (string | KarinElement)[]): Array<KarinElement>;
-    /**
-     * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
-     * @param elements
-     * @param fakeUin 转发用户的QQ号 必填
-     * @param fakeNick 转发用户显示的昵称 必填
-     */
-    makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<NodeElement>;
-    /**
-     * 获取git插件列表
-     * @param isPack - 是否屏蔽不带package.json的插件，默认为false
-     */
-    getPlugins(isPack?: boolean): Array<dirName>;
-    /**
-     * 获取git插件列表
-     * @param isPack - 是否屏蔽不带package.json的插件，默认为false
-     */
-    getGitPlugins(isPack?: boolean): Array<dirName>;
-    /**
-     * 获取npm插件列表
-     * @param showDetails - 是否返回详细信息
-     * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
-     */
-    getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? NpmInfo[] : string[]>;
-    /**
-     * 获取运行时间
-     */
-    uptime(): string;
-    /**
-     * 传入一个时间戳
-     * 返回距今已过去的时间
-     * @param time - 时间戳
-     *
-     * @example
-     * common.formatTime(1620000000)
-     * // -> '18天'
-     */
-    formatTime(time: number): string;
-    /**
-     * 构建消息体日志
-     * @param - 消息体
-     */
-    makeMessageLog(message: Array<KarinElement>): string;
-    /**
-     * 更新yaml文件
-     * @param filePath - 文件路径
-     * @param settings - 设置项
-     */
-    updateYaml(filePath: string, settings: {
-        /** 键路径 */
-        key: string;
-        /** 要写入的 */
-        val: any;
-        /** 需要写入的注释 */
-        comment: string;
-    }[]): void;
-    /**
-     * karin按钮转换为QQBot官方按钮 返回官方按钮结构
-     * @param button - 按钮
-     */
-    buttonToQQBot(button: ButtonElement | KeyBoardElement): Array<{
-        buttons: Array<ButtonType>;
-    }>;
-}
-/**
- * 常用方法
- */
-export declare const common: Common;