epii-types-rpa 1.5.6 → 1.5.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epii-types-rpa",
-  "version": "1.5.6",
+  "version": "1.5.7",
   "description": "rpa-types",
   "author": "MrRen",
   "license": "ISC",

package/rpa.d.ts

@@ -34,18 +34,18 @@ type PageHander = {
     evaluateFunction: (func: Function, data?: Object) => Promise<any>;
     waitForSelector: (selector: string) => Promise;
     waitForTrue: (func: Function, data?: Object) => Promise;
-    waitForOnceLoad: (invokeFun:Function,params?: Object) => Promise;
-    waitForClosed: (invokeFun:Function) => Promise;
+    waitForOnceLoad: (invokeFun: Function, params?: Object) => Promise;
+    waitForClosed: (invokeFun: Function) => Promise;
     execScript: (script: String, params?: Object) => Promise,
     getPageId: () => string;
     goto(url: string): Promise;
-    setContent(html:string):Promise;
-    close():Promise;
-    mouse:{
-        down:(options?:Object)=> Promise<void>;
-        move:(x:number,y:number,options?:Object)=> Promise<void>;
-        up:(options?:Object)=> Promise<void>;
-        click:(x:number,y:number,options?:Object)=> Promise<void>;
+    setContent(html: string): Promise;
+    close(): Promise;
+    mouse: {
+        down: (options?: Object) => Promise<void>;
+        move: (x: number, y: number, options?: Object) => Promise<void>;
+        up: (options?: Object) => Promise<void>;
+        click: (x: number, y: number, options?: Object) => Promise<void>;
     }
 };
 
@@ -139,7 +139,7 @@ declare namespace rpa {
         function getAppDataDir(subDir: string): Promise<string>;
         function unlink(filepath: string): Promise<string>;
         function getChromeExePath(): Promise<string>;
-        function getBase64ImageFromImgNode(imgNode:Element):Promise<string>;
+        function getBase64ImageFromImgNode(imgNode: Element): Promise<string>;
     }
     namespace page {
         function setViewport(viewport: Object): Promise
@@ -168,8 +168,8 @@ declare namespace rpa {
 
     }
     namespace browser {
-        function newPageAndGetHandler(url?:string): Promise<PageHander>;
-         function newIncognitoPageAndGetHandler(url?:string): Promise<PageHander>;
+        function newPageAndGetHandler(url?: string): Promise<PageHander>;
+        function newIncognitoPageAndGetHandler(url?: string): Promise<PageHander>;
         function getPageHandler(pageId: string): PageHander;
 
         function evaluateInPage(ageId: String, func: Function, data?: Object): Promise;
@@ -179,7 +179,7 @@ declare namespace rpa {
         function newPageAndEvaluate(url: String, func: Function, data: Object = {}): Promise;
         function waitOpenedPageAndEvaluate(invokeFun: Function, func: Function, data: Object = {}): Promise;
         function waitOpenedPageAndExec(invokeFun: Function, script: String, params: Object = {}): Promise;
-        function waitOpenedPageAndGetHandler(invokeFun: Function, waitFor?:String):Promise<PageHander>;
+        function waitOpenedPageAndGetHandler(invokeFun: Function, waitFor?: String): Promise<PageHander>;
 
         function getNextWindowOpenUrl(beforFunc: Function, cancel: boolean): Promise;
         function getNextWindowOpenUrl(beforFunc: Function): Promise;
@@ -247,3 +247,311 @@ declare function require(path: String, readCache: Boolean = true): Promise;
 declare namespace args {
     function get(key: String, dvalue: any = null): any;
 }
+
+
+type AgentManager = {
+    manager: {
+        isStart(): boolean;
+        stopServer(): Promise<void>;
+        startServer(): Promise<void>;
+    },
+    tools: {
+        /** 本地存储初始化状态标记 */
+        localStorageInitOk: boolean;
+
+        /** 系统行分隔符（如 Windows 的 \r\n、Linux 的 \n） */
+        EOL: string;
+
+        /**
+         * 重置命令根目录
+         * @description 将 cmdRootDir 置空，并重新初始化路径别名
+         */
+        resetCmdRootDir(): void;
+
+        /**
+         * 获取根目录路径
+         * @returns 根目录路径（优先使用 args 中的 "script-path-prefix"，无则使用当前工作目录）
+         */
+        getRootDir(): string;
+
+        /**
+         * 解析路径（处理路径别名替换）
+         * @param path 原始路径（可能包含别名）
+         * @returns 替换别名后的路径（统一分隔符为 /）
+         * @example 若别名配置为 { "src": "./src" }，则 "src/utils.js" 会解析为 "./src/utils.js"
+         */
+        parsePath(path: string): string;
+
+        /**
+         * 获取完整路径（处理别名、根目录拼接、文件存在性校验）
+         * @param path 原始路径（本地路径或 Web 路径）
+         * @param rootDir 自定义根目录（默认使用 getRootDir() 结果）
+         * @returns 完整路径（Web 路径直接返回，本地路径优先返回存在的文件路径，统一分隔符为 /）
+         */
+        getPath(path: string, rootDir?: string | null): string;
+
+        /**
+         * 获取本地路径（区分 Web 根目录和本地根目录）
+         * @param path 原始路径
+         * @returns 本地路径（若根目录是 Web 路径，则拼接当前工作目录；否则使用 getPath 结果）
+         */
+        getLocalPath(path: string): string;
+
+        /**
+         * 获取应用数据目录（不存在则自动创建）
+         * @param subDir 子目录（可选，如 "chrome-cache"）
+         * @returns 应用数据目录路径（含子目录，确保目录已创建，创建失败会终止进程）
+         */
+        getAppDataDir(subDir?: string | null): string;
+
+        /**
+         * 获取 Chrome 可执行文件路径
+         * @returns Chrome 路径（需先通过 initChromeExePath 初始化）
+         */
+        getChromeExePath(): string;
+
+        /**
+         * 初始化 Chrome 可执行文件路径
+         * @description 优先级：args 配置的 "chrome-path" → 缓存文件（chrome.path.txt）→ 自动安装 Chrome
+         * @returns 初始化后的 Chrome 路径
+         */
+        initChromeExePath(): Promise<string>;
+
+        /**
+         * 判断是否为 Web 文件路径（基于 HTTP/HTTPS 协议）
+         * @param file 路径字符串
+         * @returns true 为 Web 文件（如 "https://xxx.js"），false 为本地文件
+         */
+        isWebFile(file: string): boolean;
+
+        /**
+         * 获取脚本文件内容（支持 Web 文件、加密文件、require 语法替换）
+         * @param file 脚本路径（本地路径或 Web URL）
+         * @param requireReplace 是否将同步 require 替换为 await require（默认 false）
+         * @returns 处理后的脚本内容（统一换行符为 \n，加密文件会自动解密）
+         * @throws 本地文件读取失败时，内容会返回错误信息字符串
+         */
+        getScriptContent(file: string, requireReplace?: boolean): Promise<string>;
+
+        /**
+         * 异步遍历数组/对象（按顺序执行回调，确保异步操作串行）
+         * @param list 待遍历的数组或对象
+         * @param callback 异步回调函数（参数：当前元素、索引/键）
+         * @returns 遍历结果集合（与原 list 结构一致，数组返回数组，对象返回对象）
+         */
+        forEachAsync<T = any, R = any>(
+            list: T[] | Record<string, T>,
+            callback: (item: T, key: number | string) => Promise<R>
+        ): Promise<(R | undefined)[] | Record<string, R>>;
+
+        /**
+         * 异步替换字符串（基于正则表达式，支持异步回调）
+         * @param str 原始字符串
+         * @param regex 正则表达式（需带全局匹配标记 g）
+         * @param asyncFn 异步替换函数（参数：匹配结果、分组1、分组2...）
+         * @returns 替换后的字符串
+         */
+        replaceAsync(
+            str: string,
+            regex: RegExp,
+            asyncFn: (...args: any[]) => Promise<string>
+        ): Promise<string>;
+
+        /**
+         * 获取脚本源码（处理 //rpa-include 指令，递归引入依赖脚本）
+         * @param file 脚本路径
+         * @returns 完整脚本源码（含所有通过 //rpa-include 引入的依赖脚本）
+         * @example //rpa-include=./a.js,./b.js 会自动拼接 a.js 和 b.js 的内容
+         */
+        getScriptSource(file: string): Promise<string>;
+
+        /**
+         * 获取脚本源码的行数组（按行分割）
+         * @param file 脚本路径
+         * @returns 脚本行数组（每行为一个元素，基于 EOL 分割）
+         */
+        getScriptSourceLines(file: string): Promise<string[]>;
+
+        /**
+         * 解析模板字符串（替换 {{变量名}} 为 map 中的对应值）
+         * @param str 模板字符串（如 "Hello {{name}}"）
+         * @param map 变量映射对象（如 { name: "World" }）
+         * @returns 解析后的字符串（如 "Hello World"）
+         * @warning 内部使用 eval 执行变量读取，需确保 map 安全无恶意代码
+         */
+        parseTemplate(str: string, map: Record<string, any>): string;
+
+        /**
+         * 将查询字符串转为对象（如 "a=1&b=2" → { a: "1", b: "2" }）
+         * @param str 查询字符串（不含 ? 前缀）
+         * @returns 解析后的键值对对象（值均为字符串类型）
+         */
+        strToObject(str: string): Record<string, string>;
+
+        /**
+         * 获取文件所在目录（区分 Web 文件和本地文件）
+         * @param file 文件路径
+         * @returns 目录路径（Web 文件返回 URL 路径部分，本地文件返回系统目录路径）
+         */
+        dirname(file: string): string;
+
+        /**
+         * 检查文件目录是否存在，不存在则创建
+         * @param file 文件路径（需包含文件名，如 "src/logs/2024.txt"）
+         */
+        checkFileDirAndCreate(file: string): void;
+
+        /**
+         * 创建目录（递归创建，权限设为 0777）
+         * @param filedir 目录路径（如 "src/logs"）
+         */
+        mkdirSync(filedir: string): void;
+
+        /**
+         * 创建文件所在目录（仅需传入文件路径，自动处理父目录）
+         * @param filePath 文件路径（如 "src/logs/2024.txt"）
+         */
+        mkFilePathDirSync(filePath: string): void;
+
+        /**
+         * 执行系统命令（异步）
+         * @param cmd 命令字符串（如 "node -v"、"npm install"）
+         * @returns 命令执行结果（stdout 输出）
+         * @throws 命令执行失败时抛出错误（含 stderr 信息）
+         */
+        runCmd(cmd: string): Promise<string>;
+
+        /**
+         * 获取当前时间（格式化字符串）
+         * @returns 格式化时间（如 "2024-05-20 14:30:00"）
+         */
+        getNowTime(): string;
+
+        /**
+         * 判断是否允许指定类型的控制台输出（基于 rpa-console-types 配置）
+         * @param type 控制台类型（如 "log"、"error"、"warn"）
+         * @returns true 允许输出，false 不允许
+         * @example 若配置为 "log,error"，则 isincludeConsoleType("warn") 返回 false
+         */
+        isincludeConsoleType(type: string): boolean;
+
+        /**
+         * 休眠指定时间（异步延迟）
+         * @param time 休眠时间（毫秒）
+         * @returns 休眠结束后的 Promise
+         */
+        sleep(time: number): Promise<void>;
+
+        /**
+         * 生成随机字符串（排除易混淆字符）
+         * @param e 字符串长度（默认 32）
+         * @returns 随机字符串（包含大写字母、小写字母、数字，不含 I、O、l、0 等易混淆字符）
+         */
+        randomString(e?: number): string;
+
+        /**
+         * 等待页面初始化完成（监听页面 ___rpa__init__ready 标记）
+         * @param page 页面对象（需包含 ___rpa__init__ready 属性，标记页面是否初始化完成）
+         * @returns 页面初始化完成后的 Promise（每 200ms 检查一次状态）
+         */
+        waitForPageReady(page: { ___rpa__init__ready?: boolean }): Promise<void>;
+    },
+    changeAgent(agent?: {
+        agentId: String,
+        config: Object,
+        name: String
+
+    }): void,
+    viewConsole(msg: String, color?: String): void,
+    args: {
+
+
+        /**
+         * 获取当前核心执行动作
+         * @returns 动作字符串（如 "server"、"run-script"）
+         */
+        getAction(): ArgsData["action"];
+
+        /**
+         * 获取命令行普通参数列表
+         * @returns 普通参数数组（非 --key=value 形式的参数）
+         */
+        getParams(): ArgsParams;
+
+        /**
+         * 判断当前执行动作是否与目标动作匹配
+         * @param action 目标动作（如 "run-script"）
+         * @returns 匹配结果（true 为匹配，false 为不匹配）
+         */
+        isAction(action: string): boolean;
+
+        /**
+         * 判断参数是否为「布尔真值」
+         * @description 真值判定规则：参数存在 + (值为 true / 值为 1 / 值为 "true")
+         * @param key 参数键名
+         * @returns 真值判定结果
+         */
+        getTrueValue(key: keyof ArgsData | string): boolean;
+
+        /**
+         * 检查是否包含指定参数键
+         * @param key 参数键名（支持自定义字段）
+         * @returns 存在性结果（true 为包含，false 为不包含）
+         */
+        containsKey(key: keyof ArgsData | string): boolean;
+
+        /**
+         * 获取指定参数的值（支持默认值兜底）
+         * @param key 参数键名
+         * @param dvalue 默认值（参数不存在时返回）
+         * @returns 参数值或默认值
+         */
+        get(
+            key: String,
+            dvalue?: any
+        ): any;
+
+        /**
+         * 获取项目根目录（即 data.__root__）
+         * @returns 项目根目录路径
+         */
+        getRootDir(): String;
+
+        /**
+         * 合并配置到 data 中（覆盖已有键）
+         * @param map 待合并的配置对象
+         */
+        merge(map: Record<string, any>): void;
+
+        /**
+         * 手动设置参数值（覆盖原有值）
+         * @param key 参数键名
+         * @param value 待设置的值
+         */
+        set(key: string, value: any): void;
+
+        /**
+         * 完整配置数据对象（存储所有参数，支持直接读写）
+         */
+        data: Record<string, any>;
+    },
+    http: {
+        get: (url: string) => Promise<String>;
+
+        /**
+         * 发送 POST 请求
+         * @param url 请求地址
+         * @param data 请求数据（格式根据实际实现，如 FormData、string 等）
+         * @returns 请求结果（返回类型根据实际实现补充，如 Promise<any>）
+         */
+        post: (url: string, data: any) => Promise<String>;
+
+        /**
+         * 发送 JSON 格式的 POST 请求
+         * @param url 请求地址
+         * @param data JSON 请求数据（默认空对象）
+         * @returns 请求结果（返回类型根据实际实现补充，如 Promise<any>）
+         */
+        postJson: (url: string, data?: Record<string, any>) => Promise<String>;
+    }
+}