pp-robot-module 0.2.14

package/dist/MR/WebBrowser.d.ts

@@ -0,0 +1,210 @@
+/// <reference types="node" />
+import { Browser, Page, Response, Frame, Locator, Cookie, Dialog, ConsoleMessage, BrowserContext } from 'playwright';
+import Robot from './Robot';
+import WebMouse from './WebMouse';
+import WebKeyboard from './WebKeyboard';
+import WebElement from './WebElement';
+export declare namespace MR {
+    class WebBrowser {
+        private static webBrowser;
+        context: BrowserContext;
+        browser: Browser;
+        page: Page;
+        myframe: Frame;
+        Mouse: WebMouse;
+        Keyboard: WebKeyboard;
+        Element: WebElement;
+        private robotDetail;
+        /**
+            *
+            * @param {function(WebBot)} action 要执行的函数
+            * @param {*} robotDetail 要执行的数智人的对象
+            * @param {*} httpReqParams
+            * @param {} options
+            */
+        launch(params?: {
+            robotDetail?: any;
+            _options: {
+                _browserName?: string;
+                _browserPath?: string;
+                _browserType?: string;
+                _remotePath?: string;
+                _headless?: boolean;
+                _slowMo?: number;
+                _devtools?: boolean;
+            };
+        }): Promise<void>;
+        prepareMouse(): Promise<void>;
+        prepareKeyBoard(): Promise<void>;
+        attachRobot(detail: Robot): Promise<void>;
+        private openCloud;
+        private openLocal;
+        private constructor();
+        static get instance(): WebBrowser;
+        /**
+         * 内部打印日志 并记录跟踪指令
+         * @param {} args
+         */
+        private printer;
+        /**
+         * Navigate to the given URL.
+         * @param url
+         */
+        goto(params: {
+            _url: string;
+        } | string): Promise<null | Response>;
+        maximize(): Promise<void>;
+        setViewportSize(params: {
+            _width: number;
+            _height: number;
+        }): Promise<void>;
+        cookies(): Promise<Array<Cookie>>;
+        addCookies(cookies: Array<{
+            name: string;
+            value: string;
+            domain: string;
+            path: string;
+            url?: string;
+            expires?: number;
+            httpOnly?: boolean;
+            secure?: boolean;
+            sameSite?: "Strict" | "Lax" | "None";
+        }>): Promise<void>;
+        /**
+         * Quit the current session.
+         * After calling quit, this instance will be invalidated and
+         * may no longer be used to issue commands against the WebBrowser.
+         */
+        close(): Promise<void>;
+        viewportSize(): Promise<{
+            width: number;
+            height: number;
+        }>;
+        url(): Promise<string>;
+        title(): Promise<string>;
+        goForward(): Promise<null | Response>;
+        goBack(): Promise<null | Response>;
+        reload(): Promise<null | Response>;
+        /**
+         * Take a screenshot.
+         */
+        screenshot(params?: {
+            _filepath?: string;
+            _filename?: string;
+            _fullpage?: boolean;
+        }): Promise<Buffer>;
+        /**
+       * save pdf
+       */
+        pdf(params?: {
+            _filepath?: string;
+            _filename?: string;
+        }): Promise<Buffer>;
+        /**
+         *  打印输出所有Frame
+         */
+        dumpFrame(): void;
+        private dumpFrameTree;
+        /**
+         * 获取全部Frame
+         */
+        frames(): Frame[];
+        /**
+         * 获取主Frame
+         */
+        mainFrame(): Frame;
+        /**
+         * 获取指定名称的Frame
+         * @param {*} name
+         * @returns Frame
+         * Frame常用方法 name(),title(),url(),content()
+         */
+        frame(params: {
+            _name?: string;
+            _url?: string | RegExp | ((url: URL) => boolean);
+        }): Frame;
+        /**
+        * 普通方式元素定位
+        * @param url
+        */
+        locator(params: {
+            _selector: string;
+            _isframe?: boolean;
+        }, options?: {
+            has?: Locator;
+            hasText?: string | RegExp;
+        }): Locator;
+        /**
+        * 角色方式元素定位
+        * @param url
+        */
+        getByRole(role: "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem", options?: {
+            checked?: boolean;
+            disabled?: boolean;
+            exact?: boolean;
+            expanded?: boolean;
+            includeHidden?: boolean;
+            level?: number;
+            name?: string | RegExp;
+            pressed?: boolean;
+            selected?: boolean;
+        }, _isframe?: boolean): Locator;
+        executeJs<R>(params: {
+            _code: string;
+            _isframe?: boolean;
+        }): Promise<R>;
+        download(params: {
+            _selector: string;
+            _isframe?: boolean;
+            _filename?: string;
+        }): Promise<void>;
+        /**
+         * 监听控制台消息
+         * const  msgPromise = console()
+         * page.xxxx //操作元素
+         * await msgPromise
+         * @returns
+         */
+        console(): Promise<ConsoleMessage>;
+        onDialog(listener: (dialog: Dialog) => void): void;
+        onConsole(listener: (consoleMessage: ConsoleMessage) => void): void;
+        dragAndDrop(source: string, target: string, options?: {
+            force?: boolean;
+            noWaitAfter?: boolean;
+            sourcePosition?: {
+                x: number;
+                y: number;
+            };
+            strict?: boolean;
+            targetPosition?: {
+                x: number;
+                y: number;
+            };
+            timeout?: number;
+            trial?: boolean;
+        }): Promise<void>;
+        addInitScript(params: {
+            _path: string;
+        }): Promise<void>;
+        content(): Promise<string>;
+        /**
+         * Enable file downloads in Chrome running in headless mode
+         */
+        private enableDownloadInHeadlessChrome;
+        /**
+         * Wait for the download to complete.
+         * @returns The name of the downloaded file.
+         */
+        waitForDownload(params: {
+            /** Function to start the download. */
+            downloader: () => Promise<void>;
+            /** Extension name of the file to download. */
+            extname?: string;
+            /** How long to wait, in milliseconds, for the download to complete. */
+            timeout?: number;
+        }): Promise<string>;
+        private toStr;
+    }
+}
+declare const _default: MR.WebBrowser;
+export default _default;

package/dist/MR/WebBrowser.js

@@ -0,0 +1,484 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MR = void 0;
+const playwright_1 = require("playwright");
+const util_1 = require("../util");
+const Log_1 = require("./Log");
+const File_1 = require("./File");
+const Robot_1 = require("./Robot");
+const WebMouse_1 = require("./WebMouse");
+const WebKeyboard_1 = require("./WebKeyboard");
+const WebElement_1 = require("./WebElement");
+var MR;
+(function (MR) {
+    class WebBrowser {
+        /**
+            *
+            * @param {function(WebBot)} action 要执行的函数
+            * @param {*} robotDetail 要执行的数智人的对象
+            * @param {*} httpReqParams
+            * @param {} options
+            */
+        launch(params = {
+            _options: {
+                _browserName: 'chrome', _browserPath: '', _browserType: 'local',
+                _headless: false, _slowMo: 50, _devtools: false
+            }
+        }) {
+            return __awaiter(this, void 0, void 0, function* () {
+                this.attachRobot(params.robotDetail);
+                if (params._options._browserType === 'cloud') {
+                    yield this.openCloud(params._options);
+                }
+                else {
+                    yield this.openLocal(params._options);
+                }
+            });
+        }
+        prepareMouse() {
+            return __awaiter(this, void 0, void 0, function* () {
+                this.Mouse = new WebMouse_1.default(this.page.mouse, this.robotDetail);
+            });
+        }
+        prepareKeyBoard() {
+            return __awaiter(this, void 0, void 0, function* () {
+                this.Keyboard = new WebKeyboard_1.default(this.page.keyboard, this.robotDetail);
+            });
+        }
+        attachRobot(detail) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (!detail) {
+                    this.robotDetail = Robot_1.default.create();
+                }
+                else {
+                    this.robotDetail = detail;
+                }
+            });
+        }
+        openCloud(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.openCloud", note: "打开远程浏览器", param: this.toStr(params) };
+                this.printer(argObj);
+                this.browser = yield playwright_1.chromium.connectOverCDP('ws://' + params._remotePath);
+                this.page = yield this.browser.newPage();
+            });
+        }
+        //另一种写法 直接解耦
+        openLocal(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.openLocal", note: "打开本地浏览器", param: this.toStr(params) };
+                this.printer(argObj);
+                const opt = {
+                    headless: params._headless,
+                    defaultViewport: { width: 1920, height: 1080 },
+                    executablePath: params._browserPath,
+                    slowMo: params._slowMo,
+                    devtools: params._devtools,
+                    args: [
+                        `--disable-notifications=true`,
+                        `--no-sandbox`,
+                        `--disable-setuid-sandbox`,
+                        `--disable-infobars`,
+                        `--window-position=0,0`,
+                        `--ignore-certifcate-errors`,
+                        `--ignore-certifcate-errors-spki-list`,
+                        `--disable-web-security`,
+                        `--disable-features=IsolateOrigins,site-per-process`,
+                        `--lang=zh-CN,zn`,
+                        `--start-maximized`
+                    ],
+                    ignoreDefaultArgs: ['--enable-automation'],
+                    //env: { LANGUAGE: "zh-CN" } 
+                };
+                if (params._browserName.toLocaleLowerCase() === 'firefox') {
+                    this.browser = yield playwright_1.firefox.launch(opt);
+                }
+                else if (params._browserName.toLocaleLowerCase() === 'webkit') {
+                    this.browser = yield playwright_1.webkit.launch(opt);
+                }
+                else {
+                    this.browser = yield playwright_1.chromium.launch(opt);
+                }
+                this.page = yield this.browser.newPage();
+            });
+        }
+        constructor() {
+        }
+        static get instance() {
+            if (!this.webBrowser) {
+                this.webBrowser = new WebBrowser();
+            }
+            return this.webBrowser;
+        }
+        /**
+         * 内部打印日志 并记录跟踪指令
+         * @param {} args
+         */
+        printer(args) {
+            Log_1.default.debug(args);
+            this.robotDetail.addTrail(args);
+        }
+        /**
+         * Navigate to the given URL.
+         * @param url
+         */
+        goto(params) {
+            const argObj = { action: "WebBrowser.goto", note: "跳转至URL", param: this.toStr(params) };
+            this.printer(argObj);
+            if (typeof params == "string") {
+                return this.page.goto(params);
+            }
+            else {
+                return this.page.goto(params._url);
+            }
+        }
+        maximize() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.maximize", note: "设置视窗最大化大小" };
+                this.printer(argObj);
+                const { width, height } = yield this.page.evaluate(() => ({
+                    width: window.screen.width,
+                    height: window.screen.height,
+                }));
+                console.log(width, height);
+                yield this.page.setViewportSize({
+                    width: Math.floor(width),
+                    height: Math.floor(height),
+                });
+            });
+        }
+        setViewportSize(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.setViewportSize", note: "设置视窗大小", param: this.toStr(params) };
+                this.printer(argObj);
+                yield this.page.setViewportSize({ width: params._width, height: params._height });
+            });
+        }
+        cookies() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.cookies", note: "获取cookies" };
+                this.printer(argObj);
+                return yield this.page.context().cookies();
+            });
+        }
+        addCookies(cookies) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.addCookies", note: "添加cookies", param: this.toStr(cookies) };
+                this.printer(argObj);
+                yield this.page.context().addCookies(cookies);
+            });
+        }
+        /**
+         * Quit the current session.
+         * After calling quit, this instance will be invalidated and
+         * may no longer be used to issue commands against the WebBrowser.
+         */
+        close() {
+            const argObj = { action: "WebBrowser.close", note: "关闭浏览器" };
+            this.printer(argObj);
+            return this.browser.close();
+        }
+        viewportSize() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.viewportSize", note: "获取浏览器视窗长宽" };
+                this.printer(argObj);
+                return yield this.page.viewportSize();
+            });
+        }
+        url() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.url", note: "获取网址" };
+                this.printer(argObj);
+                return yield this.page.url();
+            });
+        }
+        title() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.title", note: "获取标题" };
+                this.printer(argObj);
+                return yield this.page.title();
+            });
+        }
+        goForward() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.goForward", note: "网页前进" };
+                this.printer(argObj);
+                return yield this.page.goForward();
+            });
+        }
+        goBack() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.goBack", note: "网页回退" };
+                this.printer(argObj);
+                return yield this.page.goBack();
+            });
+        }
+        reload() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.reload", note: "网页刷新" };
+                this.printer(argObj);
+                return yield this.page.reload();
+            });
+        }
+        /**
+         * Take a screenshot.
+         */
+        screenshot(params = { _filepath: '.', _fullpage: true }) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.screenshot", note: "网页截图", param: this.toStr(params) };
+                this.printer(argObj);
+                let filepath = '.';
+                if (params._filepath)
+                    filepath = params._filepath;
+                let filename = `${Math.round(new Date().getTime() / 1000)}.png`;
+                if (params._filename)
+                    filename = params._filename;
+                return this.page.screenshot({ path: `${filepath}/${filename}`, fullPage: params._fullpage });
+            });
+        }
+        /**
+       * save pdf
+       */
+        pdf(params = { _filepath: '.' }) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.pdf", note: "保存为PDF", param: this.toStr(params) };
+                this.printer(argObj);
+                let filepath = '.';
+                if (params._filepath)
+                    filepath = params._filepath;
+                let filename = `${Math.round(new Date().getTime() / 1000)}.pdf`;
+                if (params._filename)
+                    filename = params._filename;
+                yield this.page.emulateMedia({ media: 'screen' });
+                return yield this.page.pdf({ path: `${filepath}/${filename}` });
+            });
+        }
+        /**
+         *  打印输出所有Frame
+         */
+        dumpFrame() {
+            const argObj = { action: "WebBrowser.dumpFrame", note: "打印输出所有Frame" };
+            this.printer(argObj);
+            this.dumpFrameTree(this.page.mainFrame(), '');
+        }
+        dumpFrameTree(frame, indent) {
+            console.log(indent + frame.url());
+            for (const child of frame.childFrames()) {
+                this.dumpFrameTree(child, indent + '  ');
+            }
+        }
+        /**
+         * 获取全部Frame
+         */
+        frames() {
+            const argObj = { action: "WebBrowser.frames", note: "获取全部Frame" };
+            this.printer(argObj);
+            const frames = this.page.frames();
+            return frames;
+        }
+        /**
+         * 获取主Frame
+         */
+        mainFrame() {
+            const argObj = { action: "WebBrowser.mainFrame", note: "获取主Frame" };
+            this.printer(argObj);
+            const frame = this.page.mainFrame();
+            this.myframe = frame;
+            return frame;
+        }
+        /**
+         * 获取指定名称的Frame
+         * @param {*} name
+         * @returns Frame
+         * Frame常用方法 name(),title(),url(),content()
+         */
+        frame(params) {
+            const argObj = { action: "WebBrowser.frame", note: "获取指定名称的Frame", param: this.toStr(params) };
+            this.printer(argObj);
+            const frame = this.page.frame({ name: params._name, url: params._url });
+            this.myframe = frame;
+            return frame;
+        }
+        /**
+        * 普通方式元素定位
+        * @param url
+        */
+        locator(params, options) {
+            const argObj = { action: "WebBrowser.locator", note: "普通方式元素定位", element: this.toStr(params._selector), param: this.toStr(options) };
+            this.printer(argObj);
+            let _element = this.page.locator(params._selector, options);
+            if (params._isframe && this.myframe) {
+                _element = this.myframe.locator(params._selector, options);
+            }
+            this.Element = new WebElement_1.default(_element, this.robotDetail);
+            return _element;
+        }
+        /**
+        * 角色方式元素定位
+        * @param url
+        */
+        getByRole(role, options, _isframe) {
+            const argObj = { action: "WebBrowser.getByRole", note: "角色方式元素定位", element: this.toStr(role), param: this.toStr(options) };
+            this.printer(argObj);
+            let _element = this.page.getByRole(role, options);
+            if (_isframe && this.myframe) {
+                _element = this.myframe.getByRole(role, options);
+            }
+            this.Element = new WebElement_1.default(_element, this.robotDetail);
+            return _element;
+        }
+        executeJs(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.executeJs", note: "执行JS代码", param: this.toStr(params) };
+                this.printer(argObj);
+                if (params._isframe && this.myframe) {
+                    return this.myframe.evaluate(params._code);
+                }
+                else {
+                    return this.page.evaluate(params._code);
+                }
+            });
+        }
+        download(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.download", note: "触发下载文件", param: this.toStr(params) };
+                this.printer(argObj);
+                const downloadPromise = this.page.waitForEvent('download');
+                if (params._isframe && this.myframe) {
+                    yield this.myframe.locator(params._selector).click();
+                }
+                else {
+                    yield this.page.locator(params._selector).click();
+                }
+                const saveName = params._filename ? params._filename : '/path/to/save/new_file_name';
+                const savePath = saveName.substring(0, saveName.lastIndexOf('/') + 1);
+                const fileName = saveName.substring(saveName.lastIndexOf('/') + 1);
+                yield (yield downloadPromise).saveAs(savePath + fileName);
+            });
+        }
+        /**
+         * 监听控制台消息
+         * const  msgPromise = console()
+         * page.xxxx //操作元素
+         * await msgPromise
+         * @returns
+         */
+        console() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.console", note: "监听控制台消息" };
+                this.printer(argObj);
+                const msgPromise = this.page.waitForEvent('console');
+                return msgPromise;
+            });
+        }
+        //对话框设置  放在goto之后
+        onDialog(listener) {
+            this.page.on('dialog', listener);
+        }
+        //控制台消息设置  放在goto之后
+        onConsole(listener) {
+            this.page.on('console', listener);
+        }
+        dragAndDrop(source, target, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.dragAndDrop", note: "从一个元素拖至另一个元素", element: this.toStr(source), param: this.toStr(target) };
+                this.printer(argObj);
+                return this.page.dragAndDrop(source, target, options);
+            });
+        }
+        addInitScript(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.addInitScript", note: "加载外部JS文件", param: this.toStr(params) };
+                this.printer(argObj);
+                return this.page.addInitScript({ path: params._path });
+            });
+        }
+        content() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const argObj = { action: "WebBrowser.content", note: "获取网页源码" };
+                this.printer(argObj);
+                return this.page.content();
+            });
+        }
+        /**
+         * Enable file downloads in Chrome running in headless mode
+         */
+        enableDownloadInHeadlessChrome() {
+            /*
+             const executor = (this.driver as any).getExecutor
+                 ? (this.driver as any).getExecutor()
+                 : (this.driver as any).executor_;
+             executor.defineCommand(
+                 "send_command",
+                 "POST",
+                 "/session/:sessionId/chromium/send_command"
+             );
+             const params = {
+                 cmd: "Page.setDownloadBehavior",
+                 params: {
+                     behavior: "allow",
+                     downloadPath: WebWebBrowser.outDir
+                 }
+             };
+             this.driver.execute(new Command("send_command").setParameters(params)); */
+        }
+        /**
+         * Wait for the download to complete.
+         * @returns The name of the downloaded file.
+         */
+        // eslint-disable-next-line class-methods-use-this
+        waitForDownload(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const timeout = params.timeout || 30000;
+                let extname = params.extname || "";
+                if (extname && !extname.startsWith(".")) {
+                    extname = `.${extname}`;
+                }
+                Log_1.default.debug("WebWebBrowser.download", { timeout, extname });
+                const startedAt = Date.now();
+                yield params.downloader();
+                // Omit the debug logs temporarily
+                const logLevel = Log_1.default.level;
+                Log_1.default.level = Log_1.default.isInfoEnabled() ? "INFO" : Log_1.default.level;
+                try {
+                    while (Date.now() < startedAt + timeout) {
+                        const files = File_1.default.listFiles({
+                            sortType: File_1.default.SortType.Mtime,
+                            orderBy: File_1.default.OrderBy.DESC
+                        })
+                            .filter((filename) => !filename.endsWith(".crdownload"))
+                            .filter((filename) => filename.endsWith(extname));
+                        if (files.length > 0) {
+                            const latestFile = files[0];
+                            if (File_1.default.getStats({ _filename: latestFile }).mtimeMs > startedAt) {
+                                return latestFile;
+                            }
+                        }
+                        yield util_1.default.sleep(100); // eslint-disable-line no-await-in-loop
+                    }
+                }
+                finally {
+                    Log_1.default.level = logLevel;
+                }
+                throw new Error("Download timed out");
+            });
+        }
+        toStr(obj) {
+            if (obj === undefined || obj === '' || obj === null) {
+                return '';
+            }
+            return JSON.stringify(obj);
+        }
+    }
+    MR.WebBrowser = WebBrowser;
+})(MR = exports.MR || (exports.MR = {}));
+exports.default = MR.WebBrowser.instance;