testplane 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 YANDEX LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+<p align="center">
+  <picture>
+    <img alt="Testplane" src="docs/images/testplane.svg" width="220" style="max-width: 100%;">
+  </picture>
+</p>
+
+<p align="center">
+Fast, scalable and robust testing solution for the ever-evolving web landscape.
+</p>
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/testplane"><img src="https://img.shields.io/npm/dt/hermione.svg" alt="Total Downloads"></a>
+    <a href="https://github.com/gemini-testing/testplane/releases"><img src="https://img.shields.io/npm/v/testplane.svg" alt="Latest Release"></a>
+    <a href="https://github.com/gemini-testing/testplane/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/hermione.svg" alt="License"></a>
+</p>
+
+---
+
+Testplane (ex-Hermione) is a battle-hardened framework for testing web apps at any scale, any browser and any platform.
+
+🧑‍💻 **Developer Friendly:** Enjoy a hassle-free start with our installation wizard, TypeScript support, instant feedback via live test editing, advanced HTML-reporter, and smart features like auto-wait and retries.
+
+📸 **Visual Testing Redefined:** Capture anything from specific details to whole pages, manage diffs with a streamlined UI, explore a variety of diff modes and let Testplane tackle flakiness.
+
+🌐 **Test Across Environments:** Forget being tied to a couple of latest Chrome builds. Testplane goes beyond that, offering testing on real devices and broad automation protocol support, mirroring your users' actual environments.
+
+📈 **Scale Effortlessly:** Run thousands of tests on a remote browser grid or benefit from ultra-fast local execution. Testplane offers sharding, parallel test execution, and isolated browser contexts.
+
+⚡ **Infinite Extensibility:** Testplane offers a versatile plugin system with dozens of open-source plugins on GitHub, along with custom reporters, commands, and execution logic.
+
+## Getting started
+
+> Note: if you prefer manual installation, you can run `npm i -D testplane`. Check out [the Docs](docs/quick-start.md) for details.  
+
+1. Use the CLI wizard to set up testplane and generate basic configuration:
+
+    ```shell
+    npm init testplane@latest new-testplane-project
+    ```
+
+   You may add `-- -y` option to quickly set up a project using defaults.
+
+2. Open the newly generated file `testplane-tests/example.testplane.ts`. We’ll modify the test to ensure the description includes expected text:
+
+    ```typescript 
+    describe("test", () => {
+        it("example", async ({browser}) => {
+            await browser.url("https://example.com/");
+    
+            const description = await browser.$("p");
+
+            expect(description).toHaveTextContaining("for use in illustrative examples in documents");
+        });
+    });
+    ```
+
+3. Launch GUI:
+
+    ```shell
+    npx testplane gui
+   ```
+
+4. Try running the test and watch it pass. Now, let's replace description text check with a visual assertion. Use the `assertView` command to carry out visual checks:
+
+    ```diff
+    - expect(description).toHaveTextContaining("for use in illustrative examples in documents");
+    + await description.assertView("description"); // "description" is just a name of the assertion
+      ```
+
+5. Run the test again. It will fail, because a reference image for the heading is missing. You can accept the diff and re-run the test, it will then pass.
+
+Congratulations on writing your first Testplane test, which navigates to a page and executes a visual assertion. Dive into the Docs to discover more awesome features Testplane has to offer!
+
+## Docs
+
+The documentation is divided into several sections:
+
+- [Testplane Features Overview](docs/features.md)
+- [Quick Start](docs/quick-start.md)
+- [Dealing with Browsers](docs/dealing-with-browsers.md)
+- [Writing Tests](docs/writing-tests.md)
+- [Browser Commands Reference](docs/commands.md)
+- [Testplane Config Reference](docs/config.md)
+- [Testplane × Typescript](docs/typescript.md)
+- [Testplane CLI](docs/cli.md)
+- [Testplane Events](docs/events.md)
+- [Testplane Programmatic API](docs/programmatic-api.md)
+
+## Rename from "hermione"
+
+This project was formerly known as "hermione", but eventually some copyright and trademark issues surfaced, leading to the decision to rebrand. After some discussion, we settled on "Testplane" as the official new title. We've tailored Testplane `v1` to be a drop-in replacement for Hermione `v8`.
+
+## Contributing
+
+Our mission with this repository is to make the Testplane development process open, while continuing to improve upon its features, performance and ease of use. We hope other organizations find value in our project and benefit from our work.
+
+We welcome and appreciate community contributions. To ensure our efforts are in sync, we recommend to raise an issue or leave a comment beforehand. 
+
+Visit our [contributing guide](CONTRIBUTING.md) to understand more about our development process and how to get involved.
+
+## License
+Testplane is [MIT licensed](LICENSE).

package/bin/hermione

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict';
+
+var cli = require('../build/src/cli').run({ cliName: 'hermione' });

package/bin/testplane

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict';
+
+var cli = require('../build/src/cli').run();

package/build/package.json

@@ -0,0 +1,130 @@
+{
+    "name": "testplane",
+    "version": "0.1.0",
+    "description": "Tests framework based on mocha and wdio",
+    "main": "build/src/index.js",
+    "files": [
+        "build",
+        "typings"
+    ],
+    "scripts": {
+        "build": "tsc && npm run copy-static",
+        "copy-static": "copyfiles 'src/browser/client-scripts/*' build",
+        "check-types": "tsc --project tsconfig.spec.json",
+        "clean": "rimraf build/ *.tsbuildinfo",
+        "lint": "eslint --cache . && prettier --check .",
+        "reformat": "eslint --fix . && prettier --write .",
+        "prettier-watch": "onchange '**' --exclude-path .prettierignore -- prettier --write {{changed}}",
+        "test-unit": "_mocha test/",
+        "test": "npm run test-unit && npm run check-types && npm run lint",
+        "toc": "doctoc docs --title '### Contents'",
+        "precommit": "npm run lint",
+        "prepack": "npm run clean && npm run build",
+        "preversion": "npm run lint && npm test",
+        "commitmsg": "commitlint -e",
+        "release": "standard-version",
+        "watch": "npm run copy-static && tsc --watch"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/gemini-testing/testplane.git"
+    },
+    "engines": {
+        "node": ">= 18.0.0"
+    },
+    "keywords": [
+        "testplane",
+        "hermione",
+        "webdriverio",
+        "mocha",
+        "test"
+    ],
+    "bin": {
+        "testplane": "./bin/testplane",
+        "hermione": "./bin/hermione"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@gemini-testing/commander": "2.15.3",
+        "@types/mocha": "10.0.1",
+        "@wdio/globals": "8.21.0",
+        "@wdio/types": "8.21.0",
+        "@wdio/utils": "7.26.0",
+        "aliasify": "1.9.0",
+        "bluebird": "3.5.1",
+        "browserify": "13.3.0",
+        "chalk": "2.4.2",
+        "clear-require": "1.0.1",
+        "debug": "2.6.9",
+        "devtools": "8.21.0",
+        "expect-webdriverio": "3.5.3",
+        "fastq": "1.13.0",
+        "fs-extra": "5.0.0",
+        "gemini-configparser": "1.4.1",
+        "glob-extra": "5.0.2",
+        "lodash": "4.17.21",
+        "looks-same": "9.0.0",
+        "micromatch": "4.0.5",
+        "mocha": "10.2.0",
+        "plugins-loader": "1.3.0",
+        "png-validator": "1.1.0",
+        "sharp": "0.32.6",
+        "sizzle": "2.3.6",
+        "strftime": "0.10.2",
+        "strip-ansi": "6.0.1",
+        "temp": "0.8.3",
+        "uglifyify": "3.0.4",
+        "urijs": "1.19.11",
+        "url-join": "4.0.1",
+        "webdriverio": "8.21.0",
+        "worker-farm": "1.7.0",
+        "yallist": "3.1.1"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^19.0.3",
+        "@commitlint/config-conventional": "^19.0.3",
+        "@sinonjs/fake-timers": "10.3.0",
+        "@swc/core": "1.3.40",
+        "@types/bluebird": "3.5.38",
+        "@types/chai": "4.3.4",
+        "@types/chai-as-promised": "7.1.5",
+        "@types/lodash": "4.14.191",
+        "@types/node": "18.19.3",
+        "@types/proxyquire": "1.3.28",
+        "@types/sharp": "0.31.1",
+        "@types/sinon": "4.3.3",
+        "@types/sinonjs__fake-timers": "8.1.2",
+        "@typescript-eslint/eslint-plugin": "6.12.0",
+        "@typescript-eslint/parser": "6.12.0",
+        "app-module-path": "2.2.0",
+        "chai": "4.2.0",
+        "chai-as-promised": "7.1.1",
+        "copyfiles": "2.4.1",
+        "doctoc": "2.2.0",
+        "escape-string-regexp": "1.0.5",
+        "eslint": "8.25.0",
+        "eslint-config-gemini-testing": "2.8.0",
+        "eslint-config-prettier": "8.7.0",
+        "husky": "0.11.4",
+        "jsdom": "^24.0.0",
+        "jsdom-global": "3.0.2",
+        "onchange": "7.1.0",
+        "prettier": "2.8.4",
+        "proxyquire": "1.8.0",
+        "rimraf": "4.1.2",
+        "sinon": "17.0.1",
+        "sinon-chai": "3.7.0",
+        "standard-version": "9.5.0",
+        "ts-node": "10.9.1",
+        "type-fest": "3.11.1",
+        "typescript": "5.3.2"
+    },
+    "peerDependencies": {
+        "ts-node": ">=10.5.0"
+    },
+    "peerDependenciesMeta": {
+        "ts-node": {
+            "optional": true
+        }
+    }
+}

package/build/src/base-testplane.d.ts

@@ -0,0 +1,18 @@
+import { Config } from "./config";
+import { AsyncEmitter, InterceptedEvent, Events, InterceptHandler, Interceptor } from "./events";
+import Errors from "./errors";
+import { ConfigInput } from "./config/types";
+export declare abstract class BaseTestplane extends AsyncEmitter {
+    protected _interceptors: Interceptor[];
+    protected _config: Config;
+    static create<T extends BaseTestplane>(this: new (config?: string | ConfigInput) => T, config?: string | ConfigInput): T;
+    protected constructor(config?: string | ConfigInput);
+    protected _init(): Promise<void>;
+    get config(): Config;
+    get events(): Events;
+    get errors(): typeof Errors;
+    intercept(event: InterceptedEvent, handler: InterceptHandler): this;
+    abstract isWorker(): boolean;
+    protected _setLogLevel(): void;
+    protected _loadPlugins(): void;
+}

package/build/src/base-testplane.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseTestplane = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const plugins_loader_1 = __importDefault(require("plugins-loader"));
+const config_1 = require("./config");
+const events_1 = require("./events");
+const errors_1 = __importDefault(require("./errors"));
+const typescript_1 = require("./utils/typescript");
+class BaseTestplane extends events_1.AsyncEmitter {
+    static create(config) {
+        return new this(config);
+    }
+    constructor(config) {
+        super();
+        this._interceptors = [];
+        this._interceptors = [];
+        (0, typescript_1.tryToRegisterTsNode)();
+        this._config = config_1.Config.create(config);
+        this._setLogLevel();
+        this._loadPlugins();
+    }
+    async _init() {
+        this._init = () => Promise.resolve(); // init only once
+        await this.emitAndWait(events_1.MasterEvents.INIT);
+    }
+    get config() {
+        return this._config;
+    }
+    get events() {
+        return lodash_1.default.extend({}, events_1.MasterEvents, events_1.WorkerEvents);
+    }
+    get errors() {
+        return errors_1.default;
+    }
+    intercept(event, handler) {
+        this._interceptors.push({ event, handler });
+        return this;
+    }
+    _setLogLevel() {
+        if (!process.env.WDIO_LOG_LEVEL) {
+            process.env.WDIO_LOG_LEVEL = lodash_1.default.get(this.config, "system.debug", false) ? "trace" : "error";
+        }
+    }
+    _loadPlugins() {
+        plugins_loader_1.default.load(this, this.config.plugins, "hermione-");
+    }
+}
+exports.BaseTestplane = BaseTestplane;
+//# sourceMappingURL=base-testplane.js.map

package/build/src/base-testplane.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-testplane.js","sourceRoot":"","sources":["../../src/base-testplane.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,oEAA2C;AAC3C,qCAAkC;AAClC,qCAQkB;AAClB,sDAA8B;AAC9B,mDAAyD;AAGzD,MAAsB,aAAc,SAAQ,qBAAY;IAIpD,MAAM,CAAC,MAAM,CAET,MAA6B;QAE7B,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,YAAsB,MAA6B;QAC/C,KAAK,EAAE,CAAC;QAXF,kBAAa,GAAkB,EAAE,CAAC;QAaxC,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,IAAA,gCAAmB,GAAE,CAAC;QAEtB,IAAI,CAAC,OAAO,GAAG,eAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACxB,CAAC;IAES,KAAK,CAAC,KAAK;QACjB,IAAI,CAAC,KAAK,GAAG,GAAkB,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,iBAAiB;QACtE,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAY,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAI,MAAM;QACN,OAAO,gBAAC,CAAC,MAAM,CAAC,EAAE,EAAE,qBAAY,EAAE,qBAAY,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,MAAM;QACN,OAAO,gBAAM,CAAC;IAClB,CAAC;IAED,SAAS,CAAC,KAAuB,EAAE,OAAyB;QACxD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAIS,YAAY;QAClB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QAC/F,CAAC;IACL,CAAC;IAES,YAAY;QAClB,wBAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/D,CAAC;CACJ;AAzDD,sCAyDC"}

package/build/src/browser/browser.d.ts

@@ -0,0 +1,28 @@
+export = Browser;
+declare class Browser {
+    static create(config: any, opts: any): import("./browser");
+    constructor(config: any, opts: any);
+    id: any;
+    version: any;
+    _config: any;
+    _debug: any;
+    _session: any;
+    _callstackHistory: import("./history/callstack") | null;
+    _state: any;
+    attach(sessionId: any, sessionCaps: any, sessionOpts: any): Promise<void>;
+    setHttpTimeout(timeout: any): void;
+    restoreHttpTimeout(): void;
+    applyState(state: any): void;
+    _addCommands(): void;
+    _addSteps(): void;
+    _addHistory(): void;
+    _addExtendOptionsMethod(session: any): void;
+    _getSessionOptsFromConfig(optNames?: string[]): {};
+    get fullId(): any;
+    get publicAPI(): any;
+    get sessionId(): any;
+    get config(): any;
+    get state(): any;
+    get capabilities(): any;
+    get callstackHistory(): import("./history/callstack") | null;
+}

package/build/src/browser/browser.js

@@ -0,0 +1,111 @@
+"use strict";
+const crypto = require("crypto");
+const _ = require("lodash");
+const { SAVE_HISTORY_MODE } = require("../constants/config");
+const { X_REQUEST_ID_DELIMITER } = require("../constants/browser");
+const history = require("./history");
+const addRunStepCommand = require("./commands/runStep").default;
+const CUSTOM_SESSION_OPTS = [
+    "outputDir",
+    "agent",
+    "headers",
+    "transformRequest",
+    "transformResponse",
+    "strictSSL",
+    // cloud service opts
+    "user",
+    "key",
+    "region",
+];
+module.exports = class Browser {
+    static create(config, opts) {
+        return new this(config, opts);
+    }
+    constructor(config, opts) {
+        this.id = opts.id;
+        this.version = opts.version;
+        this._config = config.forBrowser(this.id);
+        this._debug = config.system.debug;
+        this._session = null;
+        this._callstackHistory = null;
+        this._state = {
+            ...opts.state,
+            isBroken: false,
+        };
+    }
+    async attach(sessionId, sessionCaps, sessionOpts) {
+        this._session = await this._attachSession(sessionId, sessionCaps, sessionOpts);
+        this._addSteps();
+        this._addHistory();
+        this._addCommands();
+    }
+    setHttpTimeout(timeout) {
+        if (timeout === null) {
+            timeout = this._config.httpTimeout;
+        }
+        this._session.extendOptions({ connectionRetryTimeout: timeout });
+    }
+    restoreHttpTimeout() {
+        this.setHttpTimeout(this._config.httpTimeout);
+    }
+    applyState(state) {
+        _.extend(this._state, state);
+    }
+    _addCommands() {
+        this._addExtendOptionsMethod(this._session);
+    }
+    _addSteps() {
+        addRunStepCommand(this);
+    }
+    _addHistory() {
+        if (this._config.saveHistoryMode !== SAVE_HISTORY_MODE.NONE) {
+            this._callstackHistory = history.initCommandHistory(this._session);
+        }
+    }
+    _addExtendOptionsMethod(session) {
+        session.addCommand("extendOptions", opts => {
+            _.extend(session.options, opts);
+        });
+    }
+    _getSessionOptsFromConfig(optNames = CUSTOM_SESSION_OPTS) {
+        return optNames.reduce((options, optName) => {
+            if (optName === "transformRequest") {
+                options[optName] = req => {
+                    if (!_.isNull(this._config[optName])) {
+                        req = this._config[optName](req);
+                    }
+                    if (!req.headers["X-Request-ID"]) {
+                        req.headers["X-Request-ID"] = `${this.state.testXReqId}${X_REQUEST_ID_DELIMITER}${crypto.randomUUID()}`;
+                    }
+                    return req;
+                };
+            }
+            else if (!_.isNull(this._config[optName])) {
+                options[optName] = this._config[optName];
+            }
+            return options;
+        }, {});
+    }
+    get fullId() {
+        return this.version ? `${this.id}.${this.version}` : this.id;
+    }
+    get publicAPI() {
+        return this._session; // exposing webdriver API as is
+    }
+    get sessionId() {
+        return this.publicAPI.sessionId;
+    }
+    get config() {
+        return this._config;
+    }
+    get state() {
+        return this._state;
+    }
+    get capabilities() {
+        return this.publicAPI.capabilities;
+    }
+    get callstackHistory() {
+        return this._callstackHistory;
+    }
+};
+//# sourceMappingURL=browser.js.map

package/build/src/browser/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/browser/browser.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjC,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC5B,MAAM,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAC7D,MAAM,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnE,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AACrC,MAAM,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC;AAEhE,MAAM,mBAAmB,GAAG;IACxB,WAAW;IACX,OAAO;IACP,SAAS;IACT,kBAAkB;IAClB,mBAAmB;IACnB,WAAW;IACX,qBAAqB;IACrB,MAAM;IACN,KAAK;IACL,QAAQ;CACX,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,MAAM,OAAO;IAC1B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI;QACtB,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,MAAM,EAAE,IAAI;QACpB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG;YACV,GAAG,IAAI,CAAC,KAAK;YACb,QAAQ,EAAE,KAAK;SAClB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW;QAC5C,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAE/E,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,YAAY,EAAE,CAAC;IACxB,CAAC;IAED,cAAc,CAAC,OAAO;QAClB,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,UAAU,CAAC,KAAK;QACZ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,YAAY;QACR,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,SAAS;QACL,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,WAAW;QACP,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,iBAAiB,CAAC,IAAI,EAAE,CAAC;YAC1D,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvE,CAAC;IACL,CAAC;IAED,uBAAuB,CAAC,OAAO;QAC3B,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE;YACvC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,yBAAyB,CAAC,QAAQ,GAAG,mBAAmB;QACpD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YACxC,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBACjC,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,EAAE;oBACrB,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;wBACnC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;oBACrC,CAAC;oBAED,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;wBAC/B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,GAC1B,IAAI,CAAC,KAAK,CAAC,UACf,GAAG,sBAAsB,GAAG,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;oBACtD,CAAC;oBAED,OAAO,GAAG,CAAC;gBACf,CAAC,CAAC;YACN,CAAC;iBAAM,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC7C,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;IACjE,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,+BAA+B;IACzD,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;IACpC,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;IACvC,CAAC;IAED,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;CACJ,CAAC"}

package/build/src/browser/calibrator.d.ts

@@ -0,0 +1,16 @@
+export = Calibrator;
+declare class Calibrator {
+    _cache: {};
+    /**
+     * @param {Browser} browser
+     * @returns {Promise.<CalibrationResult>}
+     */
+    calibrate(browser: Browser): Promise<CalibrationResult>;
+    _analyzeImage(image: any, params: any): globalThis.Promise<{
+        viewportStart: {
+            x: number;
+            y: any;
+        };
+    } | null>;
+}
+import Promise = require("bluebird");

package/build/src/browser/calibrator.js

@@ -0,0 +1,105 @@
+"use strict";
+const fs = require("fs");
+const path = require("path");
+const Promise = require("bluebird");
+const _ = require("lodash");
+const looksSame = require("looks-same");
+const { CoreError } = require("./core-error");
+const clientScriptCalibrate = fs.readFileSync(path.join(__dirname, "client-scripts", "calibrate.js"), "utf8");
+const DIRECTION = { FORWARD: "forward", REVERSE: "reverse" };
+module.exports = class Calibrator {
+    constructor() {
+        this._cache = {};
+    }
+    /**
+     * @param {Browser} browser
+     * @returns {Promise.<CalibrationResult>}
+     */
+    calibrate(browser) {
+        if (this._cache[browser.id]) {
+            return Promise.resolve(this._cache[browser.id]);
+        }
+        return Promise.resolve(browser.open("about:blank"))
+            .then(() => browser.evalScript(clientScriptCalibrate))
+            .then(features => [features, browser.captureViewportImage()])
+            .spread(async (features, image) => {
+            const { innerWidth, pixelRatio } = features;
+            const hasPixelRatio = Boolean(pixelRatio && pixelRatio > 1.0);
+            const imageFeatures = await this._analyzeImage(image, { calculateColorLength: hasPixelRatio });
+            if (!imageFeatures) {
+                return Promise.reject(new CoreError("Could not calibrate. This could be due to calibration page has failed to open properly"));
+            }
+            features = _.extend(features, {
+                top: imageFeatures.viewportStart.y,
+                left: imageFeatures.viewportStart.x,
+                usePixelRatio: hasPixelRatio && imageFeatures.colorLength > innerWidth,
+            });
+            this._cache[browser.id] = features;
+            return features;
+        });
+    }
+    async _analyzeImage(image, params) {
+        const imageHeight = (await image.getSize()).height;
+        for (var y = 0; y < imageHeight; y++) {
+            var result = await analyzeRow(y, image, params);
+            if (result) {
+                return result;
+            }
+        }
+        return null;
+    }
+};
+async function analyzeRow(row, image, params = {}) {
+    const markerStart = await findMarkerInRow(row, image, DIRECTION.FORWARD);
+    if (markerStart === -1) {
+        return null;
+    }
+    const result = { viewportStart: { x: markerStart, y: row } };
+    if (!params.calculateColorLength) {
+        return result;
+    }
+    const markerEnd = await findMarkerInRow(row, image, DIRECTION.REVERSE);
+    const colorLength = markerEnd - markerStart + 1;
+    return _.extend(result, { colorLength });
+}
+async function findMarkerInRow(row, image, searchDirection) {
+    const imageWidth = (await image.getSize()).width;
+    const searchColor = { R: 148, G: 250, B: 0 };
+    if (searchDirection === DIRECTION.REVERSE) {
+        return searchReverse_();
+    }
+    else {
+        return searchForward_();
+    }
+    async function searchForward_() {
+        for (var x = 0; x < imageWidth; x++) {
+            var isSame = await compare_(x);
+            if (isSame) {
+                return x;
+            }
+        }
+        return -1;
+    }
+    async function searchReverse_() {
+        for (var x = imageWidth - 1; x >= 0; x--) {
+            var isSame = await compare_(x);
+            if (isSame) {
+                return x;
+            }
+        }
+        return -1;
+    }
+    async function compare_(x) {
+        var pixel = await image.getRGBA(x, row);
+        var color = pickRGB(pixel);
+        return looksSame.colors(color, searchColor);
+    }
+}
+function pickRGB(rgba) {
+    return {
+        R: rgba.r,
+        G: rgba.g,
+        B: rgba.b,
+    };
+}
+//# sourceMappingURL=calibrator.js.map

package/build/src/browser/calibrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calibrator.js","sourceRoot":"","sources":["../../../src/browser/calibrator.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACpC,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACxC,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE9C,MAAM,qBAAqB,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;AAC9G,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAE7D,MAAM,CAAC,OAAO,GAAG,MAAM,UAAU;IAC7B;QACI,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,OAAO;QACb,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC9C,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;aACrD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;aAC5D,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;YAC9B,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;YAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAC;YAC9D,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,oBAAoB,EAAE,aAAa,EAAE,CAAC,CAAC;YAE/F,IAAI,CAAC,aAAa,EAAE,CAAC;gBACjB,OAAO,OAAO,CAAC,MAAM,CACjB,IAAI,SAAS,CACT,wFAAwF,CAC3F,CACJ,CAAC;YACN,CAAC;YAED,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC1B,GAAG,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;gBAClC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;gBACnC,aAAa,EAAE,aAAa,IAAI,aAAa,CAAC,WAAW,GAAG,UAAU;aACzE,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;YAEnC,OAAO,QAAQ,CAAC;QACpB,CAAC,CAAC,CAAC;IACX,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM;QAC7B,MAAM,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAEnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,IAAI,MAAM,GAAG,MAAM,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAEhD,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC;YAClB,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ,CAAC;AAEF,KAAK,UAAU,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE;IAC7C,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAEzE,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,EAAE,aAAa,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC;IAE7D,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,SAAS,GAAG,WAAW,GAAG,CAAC,CAAC;IAEhD,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;AAC7C,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAG,EAAE,KAAK,EAAE,eAAe;IACtD,MAAM,UAAU,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC;IACjD,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAE7C,IAAI,eAAe,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;QACxC,OAAO,cAAc,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACJ,OAAO,cAAc,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,UAAU,cAAc;QACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,MAAM,GAAG,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;YAE/B,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,CAAC,CAAC;YACb,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC;IAED,KAAK,UAAU,cAAc;QACzB,KAAK,IAAI,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,IAAI,MAAM,GAAG,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAC;YAE/B,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,CAAC,CAAC;YACb,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC;IAED,KAAK,UAAU,QAAQ,CAAC,CAAC;QACrB,IAAI,KAAK,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACxC,IAAI,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3B,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,IAAI;IACjB,OAAO;QACH,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,CAAC,EAAE,IAAI,CAAC,CAAC;KACZ,CAAC;AACN,CAAC"}

package/build/src/browser/camera/index.d.ts

@@ -0,0 +1,13 @@
+export = Camera;
+declare class Camera {
+    static create(screenshotMode: any, takeScreenshot: any): import(".");
+    constructor(screenshotMode: any, takeScreenshot: any);
+    _screenshotMode: any;
+    _takeScreenshot: any;
+    _calibration: any;
+    calibrate(calibration: any): void;
+    captureViewportImage(page: any): Promise<Image>;
+    _calibrateArea(imageArea: any): any;
+    _cropAreaToViewport(imageArea: any, page: any): any;
+}
+import Image = require("../../image");