testplane 9.0.0-rc.3 → 9.0.0-rc.4

package/README.md

@@ -1,7 +1,7 @@
 <p align="center">
   <a href="https://testplane.io/">
     <picture>
-      <img alt="Testplane" src="docs/images/testplane.svg" width="220" style="max-width: 100%;">
+      <img alt="Testplane" src="https://raw.githubusercontent.com/gemini-testing/testplane/refs/heads/master/docs/images/testplane.svg" width="220" style="max-width: 100%;">
     </picture>
   </a>
 </p>

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "testplane",
-    "version": "9.0.0-rc.3",
+    "version": "9.0.0-rc.4",
     "description": "Tests framework based on mocha and wdio",
     "main": "build/src/index.js",
     "files": [
@@ -19,26 +19,32 @@
     },
     "scripts": {
         "browsers:launch": "docker run -it --rm --network=host $(which colima >/dev/null || echo --add-host=host.docker.internal:0.0.0.0) yinfra/html-reporter-browsers",
-        "build": "tsc --build && npm run build-bundles && npm run copy-static && node scripts/create-client-scripts-symlinks.js",
-        "copy-static": "copyfiles 'src/browser/client-scripts/*' 'src/**/[!cache]*/autogenerated/**/*.json' build",
+        "build": "tsc --build && npm run build-bundles && npm run copy-static",
+        "copy-static": "copyfiles 'src/browser/client-scripts/**/*.js' 'src/**/[!cache]*/autogenerated/**/*.json' build",
         "build-node-bundle": "esbuild ./src/bundle/cjs/index.ts --outdir=./build/src/bundle/cjs --bundle --format=cjs --platform=node --target=ES2021",
-        "build-browser-bundle": "node ./src/browser/client-scripts/build.js",
+        "build-browser-bundle": "node ./src/browser/client-scripts/build.js ./src/browser/client-scripts/screen-shooter && node ./src/browser/client-scripts/build.js ./src/browser/client-scripts/browser-utils",
         "build-bundles": "concurrently -c 'auto' 'npm:build-browser-bundle' 'npm:build-node-bundle --minify'",
-        "create-client-scripts-symlinks": "node scripts/create-client-scripts-symlinks.js",
         "resolve-ubuntu-dependencies": "ts-node ./src/browser-installer/ubuntu-packages/collect-dependencies",
         "check-types": "tsc --project test/tsconfig.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/!(integration)/**/*.js\"",
+        "test-unit": "_mocha \"test/!(integration|e2e|browser-env)/**/*.[jt]s\"",
+        "test-unit:coverage": "c8 --all --src=src --reporter=html --reporter=text-summary --exclude=\"build/**\" --exclude=\"test/**\" --exclude=\"**/*.d.ts\" _mocha \"test/!(integration|browser-env|e2e)/**/*.[jt]s\"",
+        "test-unit:generate-fixtures": "TS_NODE_PROJECT=test/tsconfig.json node -r ts-node/register -r tsconfig-paths/register test/src/browser/screen-shooter/composite-image/fixtures/generate.ts generate",
         "test": "npm run test-unit && npm run check-types && npm run lint",
-        "test-integration": "mocha -r ts-node/register -r test/integration/standalone/preload-browser.fixture.ts test/integration/standalone/standalone.test.ts",
-        "test-e2e": "node bin/testplane --config test/e2e/testplane.config.ts",
+        "test-integration": "TS_NODE_TRANSPILE_ONLY=1 mocha -r ts-node/register test/integration/*/**",
+        "test-e2e": "npm run test-e2e:generate-fixtures && npm run test-e2e:run-tests",
+        "test-e2e:run-tests": "node bin/testplane --config test/e2e/testplane.config.ts",
+        "test-e2e:generate-fixtures": "node bin/testplane --config test/e2e/fixtures/basic-report/testplane.config.ts || true",
         "test-e2e:gui": "node bin/testplane --config test/e2e/testplane.config.ts gui",
+        "test-browser-env": "TS_NODE_PROJECT=./test/browser-env/tsconfig.json node bin/testplane -r tsconfig-paths/register --config test/browser-env/testplane.config.ts",
+        "test-browser-env:gui": "TS_NODE_PROJECT=./test/browser-env/tsconfig.json node bin/testplane gui -r tsconfig-paths/register --config test/browser-env/testplane.config.ts",
         "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 && npm run build-browser-bundle && concurrently -c 'auto' 'npm:watch:src' 'npm:watch:bundle'",
@@ -69,13 +75,14 @@
         "@babel/code-frame": "7.24.2",
         "@gemini-testing/commander": "2.15.4",
         "@jspm/core": "2.0.1",
+        "@jsquash/png": "3.1.1",
         "@puppeteer/browsers": "2.7.1",
-        "@rrweb/record": "2.0.0-alpha.18",
-        "@testplane/devtools": "8.32.3",
-        "@testplane/wdio-protocols": "9.4.6",
-        "@testplane/wdio-utils": "9.5.3",
-        "@testplane/webdriverio": "9.5.21",
+        "@testplane/devtools": "8.32.5",
+        "@testplane/wdio-protocols": "9.4.7",
+        "@testplane/wdio-utils": "9.5.4",
+        "@testplane/webdriverio": "9.5.23",
         "@vitest/spy": "2.1.4",
+        "buffer-crc32": "1.0.0",
         "chalk": "2.4.2",
         "clear-require": "1.0.1",
         "cli-progress": "3.12.0",
@@ -86,27 +93,26 @@
         "expect-webdriverio": "3.6.0",
         "extract-zip": "2.0.1",
         "fastq": "1.13.0",
-        "fs-extra": "5.0.0",
+        "fs-extra": "7.0.1",
         "geckodriver": "4.5.0",
-        "gemini-configparser": "1.4.1",
+        "gemini-configparser": "1.4.2",
         "get-port": "5.1.1",
         "import-meta-resolve": "4.0.0",
-        "load-esm": "1.0.2",
         "local-pkg": "0.4.3",
         "lodash": "4.17.21",
-        "looks-same": "9.0.1",
+        "looks-same": "10.0.1",
         "micromatch": "4.0.5",
         "mocha": "10.2.0",
         "pirates": "4.0.7",
         "plugins-loader": "1.3.4",
         "png-validator": "1.1.0",
+        "proper-lockfile": "4.1.2",
         "recast": "0.23.6",
         "resolve.exports": "2.0.2",
-        "sharp": "0.32.6",
         "sizzle": "2.3.6",
         "socket.io": "4.7.5",
         "socket.io-client": "4.7.5",
-        "source-map": "0.7.4",
+        "source-map-js": "1.2.1",
         "strftime": "0.10.2",
         "strip-ansi": "6.0.1",
         "temp": "0.8.3",
@@ -116,15 +122,18 @@
         "vite": "5.1.6",
         "wait-port": "1.1.0",
         "worker-farm": "1.7.0",
+        "ws": "8.18.3",
         "yallist": "3.1.1"
     },
     "devDependencies": {
+        "@babel/parser": "7.28.5",
         "@commitlint/cli": "^19.0.3",
         "@commitlint/config-conventional": "^19.0.3",
         "@cspotcode/source-map-support": "0.8.0",
+        "@rrweb/record": "2.0.0-alpha.18",
         "@sinonjs/fake-timers": "10.3.0",
         "@swc/core": "1.13.3",
-        "@testplane/wdio-types": "9.5.3",
+        "@testplane/wdio-types": "9.5.4",
         "@types/babel__code-frame": "7.0.6",
         "@types/browserify": "12.0.40",
         "@types/chai": "4.3.4",
@@ -139,8 +148,9 @@
         "@types/micromatch": "4.0.9",
         "@types/mocha": "10.0.1",
         "@types/node": "18.19.3",
+        "@types/proper-lockfile": "4.1.4",
         "@types/proxyquire": "1.3.28",
-        "@types/sharp": "0.31.1",
+        "@types/set-cookie-parser": "2.4.10",
         "@types/sinon": "17.0.1",
         "@types/sinonjs__fake-timers": "8.1.2",
         "@types/strftime": "0.9.8",
@@ -152,6 +162,7 @@
         "aliasify": "1.9.0",
         "app-module-path": "2.2.0",
         "browserify": "13.3.0",
+        "c8": "10.1.3",
         "chai": "4.2.0",
         "chai-as-promised": "7.1.1",
         "concurrently": "8.2.2",
@@ -162,7 +173,7 @@
         "eslint-config-prettier": "8.7.0",
         "execa": "5.1.1",
         "glob-extra": "5.0.2",
-        "html-reporter": "10.18.7",
+        "html-reporter": "11.9.3",
         "husky": "0.11.4",
         "js-levenshtein": "1.1.6",
         "jsdom": "^24.0.0",
@@ -175,16 +186,21 @@
         "sinon-chai": "3.7.0",
         "standard-version": "9.5.0",
         "ts-node": "10.9.1",
+        "tsconfig-paths": "4.2.0",
         "type-fest": "3.11.1",
         "typescript": "5.3.2",
         "uglifyify": "3.0.4"
     },
     "peerDependencies": {
+        "@babel/parser": ">=7.0.0",
         "@cspotcode/source-map-support": ">=0.7.0",
         "@swc/core": ">=1.3.96",
         "ts-node": ">=10.5.0"
     },
     "peerDependenciesMeta": {
+        "@babel/parser": {
+            "optional": true
+        },
         "ts-node": {
             "optional": true
         },

package/build/src/base-testplane.js

@@ -20,6 +20,7 @@ class BaseTestplane extends events_1.AsyncEmitter {
         this._interceptors = [];
         (0, typescript_1.registerTransformHook)(this.isWorker());
         this._config = config_1.Config.create(config);
+        (0, typescript_1.updateTransformHook)(this._config);
         this._setLogLevel();
         this._loadPlugins();
     }

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

@@ -1 +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,mDAA2D;AAG3D,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,kCAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvC,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"}
+{"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,mDAAgF;AAGhF,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,kCAAqB,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,eAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,IAAA,gCAAmB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAElC,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;AA1DD,sCA0DC"}

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

@@ -1,3 +1,4 @@
+import * as history from "./history";
 import { Config } from "../config";
 import { AsyncEmitter } from "../events";
 import { BrowserConfig } from "../config/browser-config";
@@ -14,6 +15,7 @@ export type BrowserState = {
     testXReqId?: string;
     traceparent?: string;
     isBroken?: boolean;
+    isLastTestFailed?: boolean;
 };
 export type CustomCommand = {
     name: string;
@@ -29,6 +31,9 @@ export declare class Browser {
     protected _customCommands: Set<CustomCommand>;
     protected _wdPool?: WebdriverPool;
     protected _wdProcess: WdProcess | null;
+    /** This Promise is awaited after test is finished. Can be used for cleanup.
+       Right now is used to wait for time travel snapshots to finish collecting */
+    protected _snapshotsPromiseRef: history.PromiseRef;
     id: string;
     version?: string;
     static create<T extends Browser>(this: new (config: Config, opts: BrowserOpts) => T, config: Config, opts: BrowserOpts): T;
@@ -50,6 +55,7 @@ export declare class Browser {
     get state(): BrowserState;
     get capabilities(): WebdriverIO.Capabilities;
     get callstackHistory(): Callstack;
+    get snapshotsPromiseRef(): history.PromiseRef;
     get customCommands(): CustomCommand[];
     get emitter(): AsyncEmitter;
 }

package/build/src/browser/browser.js

@@ -58,10 +58,12 @@ class Browser {
         this._debug = config.system.debug;
         this._session = null;
         this._callstackHistory = null;
+        this._snapshotsPromiseRef = { current: Promise.resolve() };
         this._wdProcess = null;
         this._state = {
             ...opts.state,
             isBroken: false,
+            isLastTestFailed: false,
         };
         this._customCommands = new Set();
         this._wdPool = opts.wdPool;
@@ -90,7 +92,9 @@ class Browser {
     }
     _addHistory() {
         if (this._config.saveHistoryMode !== config_1.SAVE_HISTORY_MODE.NONE) {
-            this._callstackHistory = history.initCommandHistory(this._session, this._config);
+            const initHistoryResult = history.initCommandHistory(this._session, this._config);
+            this._callstackHistory = initHistoryResult.callstack;
+            this._snapshotsPromiseRef = initHistoryResult.snapshotsPromiseRef;
         }
     }
     _addExtendOptionsMethod(session) {
@@ -152,6 +156,9 @@ class Browser {
     get callstackHistory() {
         return this._callstackHistory;
     }
+    get snapshotsPromiseRef() {
+        return this._snapshotsPromiseRef;
+    }
     get customCommands() {
         const allCustomCommands = Array.from(this._customCommands);
         return lodash_1.default.uniqWith(allCustomCommands, lodash_1.default.isEqual);

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

@@ -1 +1 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/browser/browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAA4B;AAE5B,oDAAuB;AAEvB,gDAAwD;AACxD,kDAA8D;AAC9D,mDAAqC;AACrC,6CAAkD;AAClD,iDAA4E;AAC5E,iEAAmD;AAOnD,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;AAkBF,MAAa,OAAO;IAahB,MAAM,CAAC,MAAM,CAET,MAAc,EACd,IAAiB;QAEjB,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,MAAc,EAAE,IAAiB;QACzC,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,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG;YACV,GAAG,IAAI,CAAC,KAAK;YACb,QAAQ,EAAE,KAAK;SAClB,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,cAAc,CAAC,OAAsB;QACjC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,QAAS,CAAC,aAAa,CAAC,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,UAAU,CAAC,KAA8B;QACrC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAES,YAAY;QAClB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;IACjD,CAAC;IAES,SAAS;QACf,IAAA,iBAAiB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,iBAAiB;QACvB,IAAA,+BAAkB,EAAC,IAAI,CAAC,QAAS,CAAC,CAAC;IACvC,CAAC;IAES,WAAW;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,0BAAiB,CAAC,IAAI,EAAE,CAAC;YAC1D,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAA+B,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5G,CAAC;IACL,CAAC;IAES,uBAAuB,CAAC,OAA4B;QAC1D,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE;YACvC,gBAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAES,yBAAyB,CAAC,QAAQ,GAAG,mBAAmB;QAC9D,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAgC,EAAE,OAAO,EAAE,EAAE;YACjE,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBACjC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAmB,EAAkB,EAAE;oBACvD,IAAI,CAAC,gBAAC,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,OAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;wBAChC,GAAG,CAAC,OAAQ,CAAC,cAAc,CAAC,GAAG,GAC3B,IAAI,CAAC,KAAK,CAAC,UACf,GAAG,gCAAsB,GAAG,gBAAM,CAAC,UAAU,EAAE,EAAE,CAAC;oBACtD,CAAC;oBACD,IAAI,CAAC,GAAG,CAAC,OAAQ,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;wBACzD,GAAG,CAAC,OAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;oBACzD,CAAC;oBAED,OAAO,GAAG,CAAC;gBACf,CAAC,CAAC;YACN,CAAC;iBAAM,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAC,CAAC,EAAE,CAAC;gBACjE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAC,CAAC;YACpE,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAES,8BAA8B;QACpC,MAAM,eAAe,GAAG,IAAA,6BAAkB,GAAE,CAAC;QAC7C,MAAM,eAAe,GAAG,IAAA,6BAAkB,GAAE,CAAC;QAE7C,IAAI,CAAC,QAAS,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,EAAE;YAChG,MAAM,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEtG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAClB,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC5E,CAAC;YAED,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACP,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,QAAS,CAAC,CAAC,+BAA+B;IAC1D,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,iBAAkB,CAAC;IACnC,CAAC;IAED,IAAI,cAAc;QACd,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,OAAO,gBAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAC,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ;AA7JD,0BA6JC"}
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/browser/browser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAA4B;AAE5B,oDAAuB;AAEvB,gDAAwD;AACxD,kDAA8D;AAC9D,mDAAqC;AACrC,6CAAkD;AAClD,iDAA4E;AAC5E,iEAAmD;AAOnD,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;AAmBF,MAAa,OAAO;IAgBhB,MAAM,CAAC,MAAM,CAET,MAAc,EACd,IAAiB;QAEjB,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,MAAc,EAAE,IAAiB;QACzC,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,oBAAoB,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG;YACV,GAAG,IAAI,CAAC,KAAK;YACb,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;SAC1B,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,cAAc,CAAC,OAAsB;QACjC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,QAAS,CAAC,aAAa,CAAC,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,UAAU,CAAC,KAA8B;QACrC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAES,YAAY;QAClB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAS,CAAC,CAAC;IACjD,CAAC;IAES,SAAS;QACf,IAAA,iBAAiB,EAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAES,iBAAiB;QACvB,IAAA,+BAAkB,EAAC,IAAI,CAAC,QAAS,CAAC,CAAC;IACvC,CAAC;IAES,WAAW;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,0BAAiB,CAAC,IAAI,EAAE,CAAC;YAC1D,MAAM,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAA+B,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACzG,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,SAAS,CAAC;YACrD,IAAI,CAAC,oBAAoB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;QACtE,CAAC;IACL,CAAC;IAES,uBAAuB,CAAC,OAA4B;QAC1D,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE;YACvC,gBAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAES,yBAAyB,CAAC,QAAQ,GAAG,mBAAmB;QAC9D,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAgC,EAAE,OAAO,EAAE,EAAE;YACjE,IAAI,OAAO,KAAK,kBAAkB,EAAE,CAAC;gBACjC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAmB,EAAkB,EAAE;oBACvD,IAAI,CAAC,gBAAC,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,OAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;wBAChC,GAAG,CAAC,OAAQ,CAAC,cAAc,CAAC,GAAG,GAC3B,IAAI,CAAC,KAAK,CAAC,UACf,GAAG,gCAAsB,GAAG,gBAAM,CAAC,UAAU,EAAE,EAAE,CAAC;oBACtD,CAAC;oBACD,IAAI,CAAC,GAAG,CAAC,OAAQ,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;wBACzD,GAAG,CAAC,OAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;oBACzD,CAAC;oBAED,OAAO,GAAG,CAAC;gBACf,CAAC,CAAC;YACN,CAAC;iBAAM,IAAI,CAAC,gBAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAC,CAAC,EAAE,CAAC;gBACjE,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAA8B,CAAC,CAAC;YACpE,CAAC;YAED,OAAO,OAAO,CAAC;QACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAES,8BAA8B;QACpC,MAAM,eAAe,GAAG,IAAA,6BAAkB,GAAE,CAAC;QAC7C,MAAM,eAAe,GAAG,IAAA,6BAAkB,GAAE,CAAC;QAE7C,IAAI,CAAC,QAAS,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,EAAE;YAChG,MAAM,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEtG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAClB,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC5E,CAAC;YAED,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACP,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,QAAS,CAAC,CAAC,+BAA+B;IAC1D,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,iBAAkB,CAAC;IACnC,CAAC;IAED,IAAI,mBAAmB;QACnB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAED,IAAI,cAAc;QACd,MAAM,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,OAAO,gBAAC,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAC,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ;AAxKD,0BAwKC"}

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

@@ -1,12 +1,13 @@
 import { ExistingBrowser } from "./existing-browser";
+import { Length, Rect, Size } from "./isomorphic";
 interface BrowserFeatures {
     needsCompatLib: boolean;
     pixelRatio: number;
-    innerWidth: number;
+    innerWidth: Length<"css", "x">;
 }
 export interface CalibrationResult extends BrowserFeatures {
-    top: number;
-    left: number;
+    viewportArea: Rect<"image", "device">;
+    screenshotSize: Size<"device">;
     usePixelRatio: boolean;
 }
 export declare class Calibrator {
@@ -14,6 +15,6 @@ export declare class Calibrator {
     private _script;
     constructor();
     calibrate(browser: ExistingBrowser): Promise<CalibrationResult>;
-    private _analyzeImage;
+    private _findMarkerAreaInImage;
 }
 export {};

package/build/src/browser/calibrator.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +31,11 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const looks_same_1 = __importDefault(require("looks-same"));
 const core_error_1 = require("./core-error");
-const DIRECTION = { FORWARD: "forward", REVERSE: "reverse" };
+const isomorphic_1 = require("./isomorphic");
+const logger = __importStar(require("../utils/logger"));
+const node_os_1 = __importDefault(require("node:os"));
+const debug_1 = __importDefault(require("debug"));
+const debug = (0, debug_1.default)("testplane:screenshots:calibrator");
 class Calibrator {
     constructor() {
         this._cache = {};
@@ -18,81 +45,101 @@ class Calibrator {
         if (this._cache[browser.id]) {
             return this._cache[browser.id];
         }
+        debug("calibrating browser %s", browser.id);
         await browser.open("about:blank");
         const features = await browser.evalScript(this._script);
+        debug("features: %O", features);
         const image = await browser.captureViewportImage();
         const { innerWidth, pixelRatio } = features;
         const hasPixelRatio = Boolean(pixelRatio && pixelRatio > 1.0);
-        const imageFeatures = await this._analyzeImage(image, { calculateColorLength: hasPixelRatio });
+        const screenshotSize = (await image.getSize());
+        const imageFeatures = await this._findMarkerAreaInImage(image);
         if (!imageFeatures) {
+            const screenshotPath = path_1.default.join(node_os_1.default.tmpdir(), "testplane-calibration-page.png");
+            await image.save(screenshotPath);
+            logger.error("Could not calibrate, because marker area was not found. See calibration page screenshot for details: " +
+                screenshotPath);
+            await image.save(screenshotPath);
             throw new core_error_1.CoreError("Could not calibrate. This could be due to calibration page has failed to open properly");
         }
         const calibratedFeatures = {
             ...features,
-            top: imageFeatures.viewportStart.y,
-            left: imageFeatures.viewportStart.x,
-            usePixelRatio: hasPixelRatio && imageFeatures.colorLength > innerWidth,
+            viewportArea: imageFeatures,
+            screenshotSize,
+            usePixelRatio: hasPixelRatio && imageFeatures.width > innerWidth,
         };
         this._cache[browser.id] = calibratedFeatures;
         return calibratedFeatures;
     }
-    async _analyzeImage(image, params) {
+    async _findMarkerAreaInImage(image) {
         const imageHeight = (await image.getSize()).height;
+        let topPart = null;
         for (let y = 0; y < imageHeight; y++) {
-            const result = await analyzeRow(y, image, params);
+            const result = await findMarkerXBandInRow(y, image);
             if (result) {
-                return result;
+                topPart = {
+                    top: y,
+                    left: result.left,
+                    width: result.width,
+                    height: (0, isomorphic_1.getHeight)(y, imageHeight),
+                };
+                break;
+            }
+        }
+        if (topPart === null) {
+            return null;
+        }
+        for (let y = (imageHeight - 1); y >= 0; y--) {
+            const result = await findMarkerXBandInRow(y, image);
+            if (result) {
+                const bottomPart = {
+                    top: 0,
+                    left: result.left,
+                    width: result.width,
+                    height: (0, isomorphic_1.getHeight)(0, (y + 1)),
+                };
+                return (0, isomorphic_1.getIntersection)(topPart, bottomPart);
             }
         }
         return null;
     }
 }
 exports.Calibrator = Calibrator;
-async function analyzeRow(row, image, params = {}) {
-    const markerStart = await findMarkerInRow(row, image, DIRECTION.FORWARD);
-    if (markerStart === -1) {
+async function findMarkerXBandInRow(row, image) {
+    const markerStart = await findMarkerStartInRow(row, image);
+    if (markerStart === null) {
         return null;
     }
-    const result = { viewportStart: { x: markerStart, y: row } };
-    if (!params.calculateColorLength) {
-        return result;
+    const markerEnd = await findMarkerEndInRow(row, image);
+    if (markerEnd === null) {
+        return null;
     }
-    const markerEnd = await findMarkerInRow(row, image, DIRECTION.REVERSE);
-    const colorLength = markerEnd - markerStart + 1;
-    return { ...result, colorLength };
+    return {
+        left: markerStart,
+        width: (0, isomorphic_1.getWidth)(markerStart, (markerEnd + 1)),
+    };
 }
-async function findMarkerInRow(row, image, searchDirection) {
-    const imageWidth = (await image.getSize()).width;
+async function isMarkerColorAtPoint(image, x, y) {
     const searchColor = { R: 148, G: 250, B: 0 };
-    if (searchDirection === DIRECTION.REVERSE) {
-        return searchReverse_();
-    }
-    else {
-        return searchForward_();
-    }
-    async function searchForward_() {
-        for (let x = 0; x < imageWidth; x++) {
-            if (await compare_(x)) {
-                return x;
-            }
+    const color = await image.getRGB(x, y);
+    return looks_same_1.default.colors(color, searchColor);
+}
+async function findMarkerStartInRow(row, image) {
+    const imageWidth = (await image.getSize()).width;
+    for (let x = 0; x < imageWidth; x++) {
+        if (await isMarkerColorAtPoint(image, x, row)) {
+            return x;
         }
-        return -1;
     }
-    async function searchReverse_() {
-        for (let x = imageWidth - 1; x >= 0; x--) {
-            if (await compare_(x)) {
-                return x;
-            }
+    return null;
+}
+async function findMarkerEndInRow(row, image) {
+    const imageWidth = (await image.getSize()).width;
+    for (let x = (imageWidth - 1); x >= 0; x--) {
+        if (await isMarkerColorAtPoint(image, x, row)) {
+            return x;
         }
-        return -1;
     }
-    async function compare_(x) {
-        const pixel = await image.getRGBA(x, row);
-        const color = pickRGB(pixel);
-        return looks_same_1.default.colors(color, searchColor);
-    }
-}
-function pickRGB(rgba) {
-    return { R: rgba.r, G: rgba.g, B: rgba.b };
+    return null;
 }
 //# sourceMappingURL=calibrator.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"calibrator.js","sourceRoot":"","sources":["../../../src/browser/calibrator.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,4DAAmC;AACnC,6CAAyC;AAIzC,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAW,CAAC;AA6BtE,MAAa,UAAU;IAInB;QACI,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,OAAwB;QACpC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,UAAU,CAAkB,IAAI,CAAC,OAAO,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAEnD,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;QAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,oBAAoB,EAAE,aAAa,EAAE,CAAC,CAAC;QAE/F,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,MAAM,IAAI,sBAAS,CACf,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,MAAM,kBAAkB,GAAsB;YAC1C,GAAG,QAAQ;YACX,GAAG,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;YAClC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;YACnC,aAAa,EAAE,aAAa,IAAI,aAAa,CAAC,WAAY,GAAG,UAAU;SAC1E,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;QAC7C,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,KAAY,EACZ,MAA0C;QAE1C,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,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YAClD,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,MAAM,CAAC;YAClB,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAtDD,gCAsDC;AAED,KAAK,UAAU,UAAU,CACrB,GAAW,EACX,KAAY,EACZ,SAA6C,EAAE;IAE/C,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,GAAwB,EAAE,aAAa,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC;IAElF,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,EAAE,GAAG,MAAM,EAAE,WAAW,EAAE,CAAC;AACtC,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,KAAY,EAAE,eAAsC;IAC5F,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,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpB,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,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpB,OAAO,CAAC,CAAC;YACb,CAAC;QACL,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;IACd,CAAC;IAED,KAAK,UAAU,QAAQ,CAAC,CAAS;QAC7B,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,oBAAS,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,IAAU;IACvB,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;AAC/C,CAAC"}
+{"version":3,"file":"calibrator.js","sourceRoot":"","sources":["../../../src/browser/calibrator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,4DAAmC;AACnC,6CAAyC;AAGzC,6CAAsG;AACtG,wDAA0C;AAC1C,sDAAyB;AACzB,kDAA8B;AAE9B,MAAM,KAAK,GAAG,IAAA,eAAS,EAAC,kCAAkC,CAAC,CAAC;AAc5D,MAAa,UAAU;IAInB;QACI,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,OAAwB;QACpC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,wBAAwB,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAE5C,MAAM,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,UAAU,CAAkB,IAAI,CAAC,OAAO,CAAC,CAAC;QACzE,KAAK,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAEnD,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;QAC5C,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,IAAI,UAAU,GAAG,GAAG,CAAC,CAAC;QAC9D,MAAM,cAAc,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAmB,CAAC;QACjE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAE/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,MAAM,cAAc,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAE,CAAC,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;YAChF,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACjC,MAAM,CAAC,KAAK,CACR,uGAAuG;gBACnG,cAAc,CACrB,CAAC;YACF,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACjC,MAAM,IAAI,sBAAS,CACf,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,MAAM,kBAAkB,GAAsB;YAC1C,GAAG,QAAQ;YACX,YAAY,EAAE,aAAa;YAC3B,cAAc;YACd,aAAa,EAAE,aAAa,IAAI,aAAa,CAAC,KAAK,GAAG,UAAU;SACnE,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;QAC7C,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,KAAY;QAC7C,MAAM,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAEnD,IAAI,OAAO,GAAmC,IAAI,CAAC;QAEnD,KAAK,IAAI,CAAC,GAAG,CAAkC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC;YACpE,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACpD,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,GAAG;oBACN,GAAG,EAAE,CAAC;oBACN,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,IAAA,sBAAS,EAAC,CAAC,EAAE,WAA4C,CAAC;iBACrE,CAAC;gBACF,MAAM;YACV,CAAC;QACL,CAAC;QAED,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,CAAC,CAAkC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3E,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACpD,IAAI,MAAM,EAAE,CAAC;gBACT,MAAM,UAAU,GAAG;oBACf,GAAG,EAAE,CAAC;oBACN,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,IAAA,sBAAS,EAAC,CAAkC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAkC,CAAC;iBAClG,CAAC;gBAEF,OAAO,IAAA,4BAAe,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAChD,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAxFD,gCAwFC;AAED,KAAK,UAAU,oBAAoB,CAC/B,GAAkC,EAClC,KAAY;IAEZ,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAE3D,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAA,qBAAQ,EAAC,WAAW,EAAE,CAAC,SAAS,GAAG,CAAC,CAAkC,CAAC;KACjF,CAAC;AACN,CAAC;AAED,KAAK,UAAU,oBAAoB,CAC/B,KAAY,EACZ,CAAgC,EAChC,CAAgC;IAEhC,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAC7C,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEvC,OAAO,oBAAS,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,oBAAoB,CAC/B,GAAkC,EAClC,KAAY;IAEZ,MAAM,UAAU,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC;IAEjD,KAAK,IAAI,CAAC,GAAG,CAAkC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;QACnE,IAAI,MAAM,oBAAoB,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;YAC5C,OAAO,CAAC,CAAC;QACb,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAC7B,GAAkC,EAClC,KAAY;IAEZ,MAAM,UAAU,GAAG,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC;IAEjD,KAAK,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAkC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1E,IAAI,MAAM,oBAAoB,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;YAC5C,OAAO,CAAC,CAAC;QACb,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC"}

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

@@ -1,29 +1,22 @@
 import { Image } from "../../image";
-export interface ImageArea {
-    left: number;
-    top: number;
-    width: number;
-    height: number;
-}
+import { type Point, type Rect, type Size } from "../isomorphic/geometry";
 export type ScreenshotMode = "fullpage" | "viewport" | "auto";
-export interface PageMeta {
-    viewport: ImageArea;
-    documentHeight: number;
-    documentWidth: number;
-}
-interface Calibration {
-    left: number;
-    top: number;
+export interface CaptureViewportImageOpts {
+    viewportOffset: Point<"page", "device">;
+    viewportSize: Size<"device">;
+    /** Delay before taking the screenshot, in milliseconds. */
+    screenshotDelay?: number;
 }
 export declare class Camera {
     private _screenshotMode;
     private _takeScreenshot;
-    private _calibration;
+    private _calibratedArea;
+    private _calibrationScreenshotSize;
+    private _debugTmpDir;
     static create(screenshotMode: ScreenshotMode, takeScreenshot: () => Promise<string>): Camera;
     constructor(screenshotMode: ScreenshotMode, takeScreenshot: () => Promise<string>);
-    calibrate(calibration: Calibration): void;
-    captureViewportImage(page?: PageMeta): Promise<Image>;
-    private _calibrateArea;
+    calibrate(calibratedArea: Rect<"image", "device">, screenshotSize?: Size<"device">): void;
+    captureViewportImage(opts?: CaptureViewportImageOpts): Promise<Image>;
+    private _cropAreaToCalibratedArea;
     private _cropAreaToViewport;
 }
-export {};