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

package/lib/types/plugin/plugin.d.ts

@@ -1,473 +0,0 @@
-import schedule from 'node-schedule';
-import { Plugin } from '../../core/index.js';
-import { Reply, replyCallback, replyForward } from '../event/reply.js';
-import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, PermissionType, AllMessageSubType, Contact, AllNoticeSubType, AllRequestSubType } from '../event/index.js';
-import { KarinElement } from '../element/element.js';
-/**
- * - 插件根目录名称
- * - 例如: karin-plugin-example
- * - 例如: karin-plugin-example/apps
- * - ### npm包类型: `string`
- * - ### git插件类型: `karin-plugin-${string}`
- */
-export type dirName = `karin-plugin-${string}` | string;
-/**
- * - 插件名称
- * - 例如: index.js index.ts
- */
-export type fileName = `${string}.js` | `${string}.ts`;
-/**
- * 插件类型枚举
- */
-export declare const enum AppsType {
-    /** git插件 */
-    Git = "git",
-    /** npm插件 */
-    Npm = "npm",
-    /** 单个app插件 */
-    Js = "js"
-}
-/**
- * 插件实现方法类型
- */
-export declare const enum MethodType {
-    /** 函数 */
-    Function = "function",
-    /** 类 */
-    Class = "class"
-}
-/**
- * plugin基本信息
- */
-export interface PluginInfoType {
-    /** 插件包类型 */
-    type: `${AppsType}`;
-    /** 插件包名称 例: `karin-plugin-example` `@karinjs/adapter-qqbot` */
-    plugin: string;
-    /** 插件路径 在type为js下，path为空 */
-    path: string;
-    /** 插件文件名称 index.js index.ts */
-    file: string;
-}
-/**
- * Command规则集信息
- */
-export interface PluginCommandInfoType {
-    /** 插件基本信息的映射key */
-    key: number;
-    /** 插件包名称 */
-    name: string;
-    /** 插件正则 */
-    reg: RegExp;
-    /** 插件执行方法 */
-    fn: (e: KarinMessageType) => Promise<boolean>;
-    /** 插件执行方法名称 */
-    fnname: string;
-    /** 插件类型 */
-    type: `${MethodType}`;
-    /** 在type为class的时候 data为class 否则为空字符串 */
-    data: (() => PluginType) | undefined;
-    /** 插件执行权限 */
-    perm: `${PermissionType}`;
-    /** 执行打印日志方法 */
-    log: Function;
-    /** 监听的子事件 高于父事件 */
-    event: AllMessageSubType;
-    /** 优先级 */
-    rank: number;
-}
-/**
- * accept规则集信息
- */
-export interface PluginAcceptInfoType {
-    /** 插件基本信息的映射key */
-    key: number;
-    /** 插件包名称 */
-    name: string;
-    /** 插件执行方法 */
-    fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>;
-    /** 优先级 */
-    rank: number;
-    /** 监听事件 */
-    event: AllNoticeSubType | AllRequestSubType;
-    /** 执行打印日志方法 */
-    log: Function;
-}
-/**
- * task规则集信息
- */
-export interface PluginTaskInfoType {
-    /** 插件基本信息的映射key */
-    key: number;
-    /** 插件包名称 */
-    name: string;
-    /** 任务名称 */
-    taskname: string;
-    /** cron表达式 */
-    cron: string;
-    /** 任务执行方法 */
-    fn: Function;
-    /** 在type为class的时候 data为class 否则为空字符串 */
-    data: (() => PluginType) | undefined;
-    /** 执行打印日志方法 */
-    log: Function;
-    /** 停止函数 */
-    schedule: schedule.Job;
-}
-/**
- * button规则集信息
- */
-export interface PluginButtonInfoType {
-    /** 插件基本信息的映射key */
-    key: number;
-    /** 插件包名称 */
-    name: string;
-    /** 插件正则 */
-    reg: RegExp;
-    /** 插件执行方法 */
-    fn: (reject: Function, e?: KarinMessageType) => Promise<any>;
-    /** 优先级 */
-    rank: number;
-}
-/**
- * handler规则集信息
- */
-export interface PluginHandlerInfoType {
-    /** 插件基本信息的映射key */
-    key: number;
-    /** 插件包名称 */
-    name: string;
-    /** handler的处理方法 */
-    fn: (args: any, reject: (msg?: string) => void) => Promise<any>;
-    /** 优先级 */
-    rank: number;
-}
-/**
- * 中间件规则集信息
- */
-export interface PluginMiddlewareInfoType {
-    /** 初始化消息前 */
-    recvMsg: Array<{
-        /** 插件基本信息的映射key */
-        key: number;
-        /** 插件包名称 */
-        name: string;
-        /** 插件执行方法 */
-        fn: (
-        /** 消息事件方法 */
-        e: KarinMessageType, 
-        /** 是否继续执行下一个中间件 */
-        next: Function, 
-        /** 是否退出此条消息 不再执行匹配插件 */
-        exit: Function) => Promise<boolean>;
-        /** 优先级 */
-        rank: number;
-    }>;
-    /** 回复消息前 */
-    replyMsg: Array<{
-        /** 插件基本信息的映射key */
-        key: number;
-        /** 插件包名称 */
-        name: string;
-        /** 插件执行方法 */
-        fn: (
-        /** 消息事件方法 */
-        e: KarinMessageType, 
-        /** 回复的消息体 */
-        element: KarinElement[], 
-        /** 是否继续执行下一个中间件 */
-        next: Function, 
-        /** 是否不发送此条消息 */
-        exit: Function) => Promise<boolean>;
-        /** 优先级 */
-        rank: number;
-    }>;
-    /** 发送主动消息前 */
-    sendMsg: Array<{
-        /** 插件基本信息的映射key */
-        key: number;
-        /** 插件包名称 */
-        name: string;
-        /** 插件执行方法 */
-        fn: (
-        /** 发送的bot */
-        uid: string, 
-        /** 发送目标 */
-        contact: Contact, 
-        /** 发送的消息体 */
-        element: KarinElement[], 
-        /** 是否继续执行下一个中间件 */
-        next: Function, 
-        /** 是否不发送此条消息 */
-        exit: Function) => Promise<boolean>;
-        /** 优先级 */
-        rank: number;
-    }>;
-}
-/**
- * 上下文状态
- */
-export interface stateArrType {
-    [key: string]: {
-        type: 'fnc';
-        fnc: Function;
-    } | {
-        type: 'class';
-        fnc: Plugin;
-        name: string;
-    } | {
-        type: 'ctx';
-    };
-}
-/**
- * - 插件规则
- */
-export interface PluginRule {
-    /**
-     * - 命令正则
-     */
-    reg: string | RegExp;
-    /**
-     * - 命令执行方法名称
-     */
-    fnc: string | Function;
-    /**
-     * - 监听子事件
-     */
-    event?: AllMessageSubType;
-    /**
-     * - 优先级 默认为10000
-     */
-    priority?: number;
-    /**
-     * 权限
-     */
-    permission?: PermissionType;
-    /**
-     * - 打印日志 默认为true
-     */
-    log?: boolean | Function;
-}
-/**
- * - 定时任务规则
- */
-export interface PluginTask {
-    /**
-     * - 任务名称
-     */
-    name: string;
-    /**
-     * - cron表达式
-     */
-    cron: string;
-    /**
-     * - 执行方法名称或对应函数
-     */
-    fnc: string | Function;
-    /**
-     * - 是否显示执行日志 默认为true
-     */
-    log: boolean | Function;
-    /**
-     * - 停止函数
-     */
-    schedule?: schedule.Job;
-}
-/**
- * - 按钮规则
- */
-export interface PluginButton {
-    /**
-     * - 按钮命令正则
-     */
-    reg: string | RegExp;
-    /**
-     * - 执行方法名称
-     */
-    fnc: string | Function;
-}
-/**
- * - handler规则
- */
-export interface PluginHandler {
-    /**
-     * - handler支持的事件key
-     */
-    key: string;
-    /**
-     * - handler的处理方法名称
-     */
-    fnc: string | Function;
-    /**
-     * - handler优先级 不填默认为主优先度
-     */
-    priority: number;
-}
-/**
- * - 插件信息
- */
-export interface AppInfo {
-    /**
-     * - 插件根目录名称
-     * - karin-plugin-example
-     * - karin-plugin-example/apps
-     * - karin-plugin-example/src/apps
-     * - karin-plugin-example/dist/apps
-     */
-    dir: dirName;
-    /**
-     * - 插件名称 例如: index.js index.ts
-     */
-    name: fileName;
-}
-/**
- * - 定义一个条件类型，根据是否存在accept方法来决定类型
- */
-export type EType<T> = T extends {
-    accept: (e: KarinNoticeType | KarinRequestType) => Promise<void>;
-} ? KarinNoticeType | KarinRequestType : KarinMessageType;
-/**
- * - 插件基类
- */
-export interface PluginType {
-    /**
-     * - 插件名称
-     */
-    name: string;
-    /**
-     * - 插件描述
-     */
-    desc: string;
-    /**
-     * - 监听事件 默认为message
-     */
-    event: AllMessageSubType;
-    /**
-     * - 优先级 默认为10000
-     */
-    priority: number;
-    /**
-     * - 定时任务
-     */
-    task: Array<PluginTask>;
-    /**
-     * - 命令规则
-     */
-    rule: Array<PluginRule>;
-    /**
-     * - handler
-     */
-    handler: Array<PluginHandler>;
-    /**
-     * - 用户ID 一般上下文使用
-     */
-    userId?: number;
-    /**
-     * - 上下文超时
-     */
-    timeout: NodeJS.Timeout | undefined;
-    /**
-     * - 上报事件
-     */
-    e: EType<this>;
-    init?: () => Promise<any>;
-    /**
-     * - 快速回复
-     */
-    reply: Reply;
-    /**
-     * - 快速回复内部方法 由适配器实现
-     */
-    replyCallback: replyCallback;
-    /**
-     * - 快速回复合并转发
-     */
-    replyForward: replyForward;
-    /**
-     * - 构建上下文键
-     */
-    conKey: () => string;
-    /**
-     * - 设置上下文状态
-     */
-    setContext: (
-    /**
-     * - 执行方法名称
-     */
-    fnc: string, 
-    /**
-     * - 超时后是否回复
-     */
-    reply?: boolean, 
-    /**
-     * - 下文超时时间 默认120秒
-     */
-    time?: number) => void;
-    /**
-     * - 获取上下文状态
-     */
-    getContext: () => stateArrType[string];
-    /**
-     * - accept标准方法 给通知、请求事件使用
-     */
-    accept?(e: KarinNoticeType | KarinRequestType): Promise<void>;
-}
-/**
- * - Apps
- */
-export interface PluginApps {
-    /**
-     * - 插件文件信息
-     */
-    file: AppInfo & {
-        /**
-         * - 插件类型
-         */
-        type: 'function' | 'class';
-        /**
-         * - 插件方法
-         */
-        Fnc: '' | (new () => PluginType);
-    };
-    /**
-     * - 插件名称
-     */
-    name: string;
-    /**
-     * - 插件事件
-     */
-    event: AllListenEvent;
-    /**
-     * - 插件优先级
-     * @default 10000
-     */
-    priority: number;
-    /**
-     * - accept函数
-     */
-    accept: boolean | Function;
-    /**
-     * - accept函数触发是否打印日志
-     */
-    log: boolean;
-    /**
-     * - 命令规则
-     */
-    rule: Array<PluginRule>;
-    /**
-     * - 定时任务
-     */
-    task: Array<PluginTask>;
-    /**
-     * - 按钮
-     */
-    button: Array<PluginButton>;
-    /**
-     * - handler
-     */
-    handler: Array<PluginHandler>;
-}
-/**
- * 未实例化的插件
- */
-export type NewMessagePlugin = new (e?: KarinMessageType) => Plugin;

package/lib/types/plugin/plugin.js

@@ -1 +0,0 @@
-export {};

package/lib/types/render/render.d.ts

@@ -1,118 +0,0 @@
-import chokidar from 'chokidar';
-/**
- * 渲染标准方法传参
- */
-export interface KarinRenderType {
-    /**
-     * - 渲染文件路径或HTTP地址 与vue二选一
-     */
-    file: string;
-    /**
-     * - vue文件路径 与file二选一
-     */
-    vue?: boolean;
-    props?: any;
-    /**
-     * - 模板名称
-     */
-    name?: string;
-    /**
-     * - art-template后的文件名
-     */
-    fileID?: string;
-    /**
-     * - 传递给模板的数据 template.render(data)
-     */
-    data?: object;
-    /**
-     * - 截图类型 默认'webp'
-     */
-    type?: 'png' | 'jpeg' | 'webp';
-    /**
-     * - 截图质量 默认90 1-100
-     */
-    quality?: number;
-    /**
-     * - 是否隐藏背景 默认false
-     */
-    omitBackground?: boolean;
-    /**
-     * - 设置视窗大小和设备像素比 默认1920*1080、1
-     */
-    setViewport?: {
-        /**
-         * - 视窗宽度
-         */
-        width?: number;
-        /**
-         * - 视窗高度
-         */
-        height?: number;
-        /**
-         * - 设备像素比
-         */
-        deviceScaleFactor?: number;
-    };
-    /**
-     * - 分页截图 传递数字则视为视窗高度 返回数组
-     */
-    multiPage?: number | boolean;
-    /**
-     * - 页面goto时的参数
-     */
-    pageGotoParams?: {
-        /**
-         * - 页面加载超时时间
-         */
-        timeout?: number;
-        /**
-         * - 页面加载状态
-         */
-        waitUntil?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2';
-        [key: string]: any;
-    };
-}
-/**
- * 渲染结果
- */
-export type RenderResult<T> = T extends {
-    multiPage: true | number;
-} ? Array<string> : string;
-/**
- * 渲染基类
- */
-export interface KarinRender {
-    dir: './temp/html';
-    html: {
-        [key: string]: string;
-    };
-    watcher: {
-        [key: string]: chokidar.FSWatcher;
-    };
-    /**
-     * 模板渲染
-     * @param options - 渲染参数
-     * @param isAbs - 是否返回绝对路径 默认true
-     */
-    dealTpl(options: KarinRenderType, isAbs: boolean): string;
-    /**
-     * 监听模板文件
-     * @param tplFile 模板文件路径
-     */
-    watch(tplFile: string): void;
-    /**
-     * 渲染
-     * @param options - 标准渲染方法
-     */
-    render: <T extends KarinRenderType>(options: T, id?: string) => Promise<RenderResult<T>>;
-}
-/**
- * 渲染器管理
- */
-export interface KarinRenderApp {
-    index: number;
-    id: string;
-    type: string;
-    time: number;
-    render: KarinRender['render'];
-}

package/lib/types/render/render.js

@@ -1 +0,0 @@
-export {};

package/lib/types/type/global.d.ts

@@ -1,25 +0,0 @@
-import { Logger as LoggerType } from 'log4js';
-import { Logger } from '../../types/index.js';
-import { Lang, Mode, Runner } from '../../cli/index.js';
-declare global {
-    namespace NodeJS {
-        interface ProcessEnv {
-            /** 重启次数 */
-            karin_app_start_count: string;
-            /** 是否为监听模式 yes=true no=false */
-            karin_app_watch: string;
-            /** 运行模式 "dev" | "prod" */
-            karin_app_mode: `${Mode}`;
-            /** 语言环境 "js" | "ts" */
-            karin_app_lang: `${Lang}`;
-            /** 运行器 "node" | "tsx" | "pm2" */
-            karin_app_runner: `${Runner}`;
-            /** 版本 */
-            karin_app_version: string;
-        }
-    }
-}
-declare global {
-    var logger: LoggerType & Logger;
-}
-export {};

package/lib/types/type/global.js

@@ -1 +0,0 @@
-export {};