testplane 0.0.1 → 0.1.0

package/build/src/browser/client-scripts/util.js

@@ -0,0 +1,142 @@
+"use strict";
+
+var SCROLL_DIR_NAME = {
+    top: "scrollTop",
+    left: "scrollLeft"
+};
+
+var PAGE_OFFSET_NAME = {
+    x: "pageXOffset",
+    y: "pageYOffset"
+};
+
+exports.each = arrayUtil(Array.prototype.forEach, myForEach);
+exports.some = arrayUtil(Array.prototype.some, mySome);
+exports.every = arrayUtil(Array.prototype.every, myEvery);
+
+function arrayUtil(nativeFunc, shimFunc) {
+    return nativeFunc ? contextify(nativeFunc) : shimFunc;
+}
+
+/**
+ * Makes function f to accept context as a
+ * first argument
+ */
+function contextify(f) {
+    return function (ctx) {
+        var rest = Array.prototype.slice.call(arguments, 1);
+        return f.apply(ctx, rest);
+    };
+}
+
+function myForEach(array, cb, context) {
+    for (var i = 0; i < array.length; i++) {
+        cb.call(context, array[i], i, array);
+    }
+}
+
+function mySome(array, cb, context) {
+    for (var i = 0; i < array.length; i++) {
+        if (cb.call(context, array[i], i, array)) {
+            return true;
+        }
+    }
+    return false;
+}
+
+function myEvery(array, cb, context) {
+    for (var i = 0; i < array.length; i++) {
+        if (!cb.call(context, array[i], i, array)) {
+            return false;
+        }
+    }
+    return true;
+}
+
+function getScroll(scrollElem, direction, coord) {
+    var scrollDir = SCROLL_DIR_NAME[direction];
+    var pageOffset = PAGE_OFFSET_NAME[coord];
+
+    if (scrollElem && scrollElem !== window) {
+        return scrollElem[scrollDir];
+    }
+
+    if (typeof window[pageOffset] !== "undefined") {
+        return window[pageOffset];
+    }
+
+    return document.documentElement[scrollDir];
+}
+
+exports.getScrollTop = function (scrollElem) {
+    return getScroll(scrollElem, "top", "y");
+};
+
+exports.getScrollLeft = function (scrollElem) {
+    return getScroll(scrollElem, "left", "x");
+};
+
+exports.isSafariMobile = function () {
+    return (
+        navigator &&
+        typeof navigator.vendor === "string" &&
+        navigator.vendor.match(/apple/i) &&
+        /(iPhone|iPad).*AppleWebKit.*Safari/i.test(navigator.userAgent)
+    );
+};
+
+exports.isInteger = function (num) {
+    return num % 1 === 0;
+};
+
+exports.forEachRoot = function (cb) {
+    function traverseRoots(root) {
+        cb(root);
+
+        // In IE 11, we need to pass the third and fourth arguments
+        var treeWalker = document.createTreeWalker(root, NodeFilter.SHOW_ELEMENT, null, false);
+
+        for (var node = treeWalker.currentNode; node !== null; node = treeWalker.nextNode()) {
+            if (node instanceof Element && node.shadowRoot) {
+                traverseRoots(node.shadowRoot);
+            }
+        }
+    }
+
+    traverseRoots(document.documentElement);
+};
+
+exports.getOwnerWindow = function (node) {
+    if (!node.ownerDocument) {
+        return null;
+    }
+
+    return node.ownerDocument.defaultView;
+};
+
+exports.getOwnerIframe = function (node) {
+    var nodeWindow = exports.getOwnerWindow(node);
+    if (nodeWindow) {
+        return nodeWindow.frameElement;
+    }
+
+    return null;
+};
+
+exports.getMainDocumentElem = function (currDocumentElem) {
+    if (!currDocumentElem) {
+        currDocumentElem = document.documentElement;
+    }
+
+    var currIframe = exports.getOwnerIframe(currDocumentElem);
+    if (!currIframe) {
+        return currDocumentElem;
+    }
+
+    var currWindow = exports.getOwnerWindow(currIframe);
+    if (!currWindow) {
+        return currDocumentElem;
+    }
+
+    return exports.getMainDocumentElem(currWindow.document.documentElement);
+};

package/build/src/browser/client-scripts/xpath.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var XPATH_SELECTORS_START = ["/", "(", "../", "./", "*/"];
+
+function isXpathSelector(selector) {
+    return XPATH_SELECTORS_START.some(function (startString) {
+        return selector.indexOf(startString) === 0;
+    });
+}
+
+function queryFirst(selector) {
+    return document.evaluate(selector, document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+}
+
+function queryAll(selector) {
+    var elements = document.evaluate(selector, document, null, XPathResult.ANY_TYPE, null);
+    var node,
+        nodes = [];
+    node = elements.iterateNext();
+    while (node) {
+        nodes.push(node);
+        node = elements.iterateNext();
+    }
+    return nodes;
+}
+
+module.exports = {
+    isXpathSelector: isXpathSelector,
+    queryFirst: queryFirst,
+    queryAll: queryAll
+};

package/build/src/browser/commands/assert-view/assert-view-results.d.ts

@@ -0,0 +1,12 @@
+export = AssertViewResults;
+declare class AssertViewResults {
+    static fromRawObject(results: any): import("./assert-view-results");
+    static create(results: any): import("./assert-view-results");
+    constructor(results: any);
+    _results: any;
+    add(data: any): void;
+    hasFails(): any;
+    hasState(stateName: any): any;
+    toRawObject(): any;
+    get(): any;
+}

package/build/src/browser/commands/assert-view/assert-view-results.js

@@ -0,0 +1,34 @@
+"use strict";
+const { ImageDiffError } = require("./errors/image-diff-error");
+const { NoRefImageError } = require("./errors/no-ref-image-error");
+module.exports = class AssertViewResults {
+    static fromRawObject(results) {
+        return AssertViewResults.create(results.map(res => {
+            return ((res.name === ImageDiffError.name && ImageDiffError.fromObject(res)) ||
+                (res.name === NoRefImageError.name && NoRefImageError.fromObject(res)) ||
+                res);
+        }));
+    }
+    static create(results) {
+        return new AssertViewResults(results);
+    }
+    constructor(results) {
+        this._results = results || [];
+    }
+    add(data) {
+        this._results.push(data);
+    }
+    hasFails() {
+        return this._results.some(res => res instanceof Error);
+    }
+    hasState(stateName) {
+        return this._results.some(res => res.stateName === stateName);
+    }
+    toRawObject() {
+        return this._results.map(res => ({ ...res }));
+    }
+    get() {
+        return this._results;
+    }
+};
+//# sourceMappingURL=assert-view-results.js.map

package/build/src/browser/commands/assert-view/assert-view-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-view-results.js","sourceRoot":"","sources":["../../../../../src/browser/commands/assert-view/assert-view-results.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;AAChE,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;AAEnE,MAAM,CAAC,OAAO,GAAG,MAAM,iBAAiB;IACpC,MAAM,CAAC,aAAa,CAAC,OAAO;QACxB,OAAO,iBAAiB,CAAC,MAAM,CAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACd,OAAO,CACH,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,IAAI,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBACpE,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,IAAI,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBACtE,GAAG,CACN,CAAC;QACN,CAAC,CAAC,CACL,CAAC;IACN,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,OAAO;QACjB,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,YAAY,OAAO;QACf,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE,CAAC;IAClC,CAAC;IAED,GAAG,CAAC,IAAI;QACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,QAAQ,CAAC,SAAS;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ,CAAC"}

package/build/src/browser/commands/assert-view/capture-processors/assert-refs.d.ts

@@ -0,0 +1,3 @@
+export function handleNoRefImage(currImg: any, refImg: any, stateName: any): Promise<never>;
+export function handleImageDiff(currImg: any, refImg: any, stateName: any, opts: any): Promise<never>;
+import Promise = require("bluebird");

package/build/src/browser/commands/assert-view/capture-processors/assert-refs.js

@@ -0,0 +1,31 @@
+"use strict";
+const Promise = require("bluebird");
+const { ImageDiffError } = require("../errors/image-diff-error");
+const { NoRefImageError } = require("../errors/no-ref-image-error");
+exports.handleNoRefImage = (currImg, refImg, stateName) => {
+    return Promise.reject(NoRefImageError.create(stateName, currImg, refImg));
+};
+exports.handleImageDiff = (currImg, refImg, stateName, opts) => {
+    const { tolerance, antialiasingTolerance, canHaveCaret, diffAreas, config, diffBuffer, differentPixels, diffRatio, } = opts;
+    const { buildDiffOpts, system: { diffColor }, } = config;
+    buildDiffOpts.ignoreCaret = buildDiffOpts.ignoreCaret && canHaveCaret;
+    const diffOpts = {
+        current: currImg.path,
+        reference: refImg.path,
+        diffColor,
+        tolerance,
+        antialiasingTolerance,
+        ...buildDiffOpts,
+    };
+    return Promise.reject(ImageDiffError.create({
+        stateName,
+        currImg,
+        refImg,
+        diffOpts,
+        diffAreas,
+        diffBuffer,
+        differentPixels,
+        diffRatio,
+    }));
+};
+//# sourceMappingURL=assert-refs.js.map

package/build/src/browser/commands/assert-view/capture-processors/assert-refs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-refs.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/capture-processors/assert-refs.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AACpC,MAAM,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AACjE,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAEpE,OAAO,CAAC,gBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;IACtD,OAAO,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,OAAO,CAAC,eAAe,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;IAC3D,MAAM,EACF,SAAS,EACT,qBAAqB,EACrB,YAAY,EACZ,SAAS,EACT,MAAM,EACN,UAAU,EACV,eAAe,EACf,SAAS,GACZ,GAAG,IAAI,CAAC;IACT,MAAM,EACF,aAAa,EACb,MAAM,EAAE,EAAE,SAAS,EAAE,GACxB,GAAG,MAAM,CAAC;IACX,aAAa,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW,IAAI,YAAY,CAAC;IAEtE,MAAM,QAAQ,GAAG;QACb,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,SAAS,EAAE,MAAM,CAAC,IAAI;QACtB,SAAS;QACT,SAAS;QACT,qBAAqB;QACrB,GAAG,aAAa;KACnB,CAAC;IAEF,OAAO,OAAO,CAAC,MAAM,CACjB,cAAc,CAAC,MAAM,CAAC;QAClB,SAAS;QACT,OAAO;QACP,MAAM;QACN,QAAQ;QACR,SAAS;QACT,UAAU;QACV,eAAe;QACf,SAAS;KACZ,CAAC,CACL,CAAC;AACN,CAAC,CAAC"}

package/build/src/browser/commands/assert-view/capture-processors/index.d.ts

@@ -0,0 +1,2 @@
+export function getCaptureProcessors(): typeof updateRefs;
+import updateRefs = require("./update-refs");

package/build/src/browser/commands/assert-view/capture-processors/index.js

@@ -0,0 +1,6 @@
+"use strict";
+const RuntimeConfig = require("../../../../config/runtime-config");
+const assertRefs = require("./assert-refs");
+const updateRefs = require("./update-refs");
+exports.getCaptureProcessors = () => (RuntimeConfig.getInstance().updateRefs ? updateRefs : assertRefs);
+//# sourceMappingURL=index.js.map

package/build/src/browser/commands/assert-view/capture-processors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/capture-processors/index.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,aAAa,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;AAEnE,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC5C,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAE5C,OAAO,CAAC,oBAAoB,GAAG,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC"}

package/build/src/browser/commands/assert-view/capture-processors/update-refs.d.ts

@@ -0,0 +1,6 @@
+export function handleNoRefImage(currImg: any, refImg: any, state: any, { emitter }: {
+    emitter: any;
+}): Promise<void>;
+export function handleImageDiff(currImg: any, refImg: any, state: any, { emitter }: {
+    emitter: any;
+}): Promise<void>;

package/build/src/browser/commands/assert-view/capture-processors/update-refs.js

@@ -0,0 +1,8 @@
+"use strict";
+const fs = require("fs-extra");
+const { WorkerEvents } = require("../../../../events");
+exports.handleNoRefImage = exports.handleImageDiff = async (currImg, refImg, state, { emitter }) => {
+    await fs.copy(currImg.path, refImg.path);
+    emitter.emit(WorkerEvents.UPDATE_REFERENCE, { state, refImg });
+};
+//# sourceMappingURL=update-refs.js.map

package/build/src/browser/commands/assert-view/capture-processors/update-refs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-refs.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/capture-processors/update-refs.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/B,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEvD,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,GAAG,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;IAC/F,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC"}

package/build/src/browser/commands/assert-view/errors/assert-view-error.d.ts

@@ -0,0 +1,4 @@
+export declare class AssertViewError extends Error {
+    message: string;
+    constructor(message?: string);
+}

package/build/src/browser/commands/assert-view/errors/assert-view-error.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssertViewError = void 0;
+class AssertViewError extends Error {
+    constructor(message = "image comparison failed") {
+        super();
+        this.message = message;
+        this.name = this.constructor.name;
+    }
+}
+exports.AssertViewError = AssertViewError;
+//# sourceMappingURL=assert-view-error.js.map

package/build/src/browser/commands/assert-view/errors/assert-view-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-view-error.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/errors/assert-view-error.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAgB,SAAQ,KAAK;IACtC,YAAmB,UAAkB,yBAAyB;QAC1D,KAAK,EAAE,CAAC;QADO,YAAO,GAAP,OAAO,CAAoC;QAG1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;CACJ;AAND,0CAMC"}

package/build/src/browser/commands/assert-view/errors/base-state-error.d.ts

@@ -0,0 +1,7 @@
+import { ImageInfo } from "../../../../types";
+export declare class BaseStateError extends Error {
+    stateName: string;
+    currImg: ImageInfo;
+    refImg: ImageInfo;
+    constructor(stateName: string, currImg: ImageInfo, refImg: ImageInfo);
+}

package/build/src/browser/commands/assert-view/errors/base-state-error.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseStateError = void 0;
+class BaseStateError extends Error {
+    constructor(stateName, currImg, refImg) {
+        super();
+        this.stateName = stateName;
+        this.currImg = currImg;
+        this.refImg = refImg;
+        this.name = this.constructor.name;
+    }
+}
+exports.BaseStateError = BaseStateError;
+//# sourceMappingURL=base-state-error.js.map

package/build/src/browser/commands/assert-view/errors/base-state-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-state-error.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/errors/base-state-error.ts"],"names":[],"mappings":";;;AAEA,MAAa,cAAe,SAAQ,KAAK;IACrC,YAAmB,SAAiB,EAAS,OAAkB,EAAS,MAAiB;QACrF,KAAK,EAAE,CAAC;QADO,cAAS,GAAT,SAAS,CAAQ;QAAS,YAAO,GAAP,OAAO,CAAW;QAAS,WAAM,GAAN,MAAM,CAAW;QAGrF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;CACJ;AAND,wCAMC"}

package/build/src/browser/commands/assert-view/errors/image-diff-error.d.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" />
+import { ImageInfo } from "../../../../types";
+import { BaseStateError } from "./base-state-error";
+import type { LooksSameOptions, LooksSameResult } from "looks-same";
+interface DiffOptions extends LooksSameOptions {
+    /** Path to the current screenshot */
+    current: string;
+    reference: string;
+    diffColor: string;
+}
+type DiffAreas = Pick<LooksSameResult, "diffClusters" | "diffBounds">;
+type ImageDiffErrorConstructor<T> = new (params: {
+    stateName: string;
+    currImg: ImageInfo;
+    refImg: ImageInfo;
+    diffOpts: DiffOptions;
+    diffAreas: DiffAreas;
+    diffBuffer: Buffer;
+    differentPixels: number;
+    diffRatio: number;
+}) => T;
+interface ImageDiffErrorData {
+    stateName: string;
+    currImg: ImageInfo;
+    refImg: ImageInfo;
+    diffOpts: DiffOptions;
+    diffBounds: LooksSameResult["diffBounds"];
+    diffClusters: LooksSameResult["diffClusters"];
+    diffBuffer: Buffer;
+    differentPixels: number;
+    diffRatio: number;
+}
+export declare class ImageDiffError extends BaseStateError {
+    message: string;
+    diffOpts: DiffOptions;
+    diffBounds?: DiffAreas["diffBounds"];
+    diffClusters?: DiffAreas["diffClusters"];
+    diffBuffer: Buffer;
+    differentPixels: number;
+    diffRatio: number;
+    static create<T extends ImageDiffError>(this: ImageDiffErrorConstructor<T>, { stateName, currImg, refImg, diffOpts, diffAreas, diffBuffer, differentPixels, diffRatio, }: {
+        stateName: string;
+        currImg: ImageInfo;
+        refImg: ImageInfo;
+        diffOpts: DiffOptions;
+        diffAreas?: DiffAreas;
+        diffBuffer: Buffer;
+        differentPixels: number;
+        diffRatio: number;
+    }): T;
+    static fromObject<T>(this: ImageDiffErrorConstructor<T>, data: ImageDiffErrorData): T;
+    constructor({ stateName, currImg, refImg, diffOpts, diffAreas: { diffBounds, diffClusters }, diffBuffer, differentPixels, diffRatio, }: {
+        stateName: string;
+        currImg: ImageInfo;
+        refImg: ImageInfo;
+        diffOpts: DiffOptions;
+        diffAreas?: DiffAreas;
+        diffBuffer: Buffer;
+        differentPixels: number;
+        diffRatio: number;
+    });
+    saveDiffTo(diffPath: string): Promise<null>;
+}
+export {};

package/build/src/browser/commands/assert-view/errors/image-diff-error.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageDiffError = void 0;
+const image_1 = __importDefault(require("../../../../image"));
+const base_state_error_1 = require("./base-state-error");
+class ImageDiffError extends base_state_error_1.BaseStateError {
+    static create({ stateName, currImg, refImg, diffOpts, diffAreas = {}, diffBuffer, differentPixels, diffRatio, }) {
+        return new this({ stateName, currImg, refImg, diffOpts, diffAreas, diffBuffer, differentPixels, diffRatio });
+    }
+    static fromObject(data) {
+        const { diffBounds, diffClusters, ...rest } = data;
+        return new this({ ...rest, diffAreas: { diffBounds, diffClusters } });
+    }
+    constructor({ stateName, currImg, refImg, diffOpts, diffAreas: { diffBounds, diffClusters } = {}, diffBuffer, differentPixels, diffRatio, }) {
+        super(stateName, currImg, refImg);
+        this.message = `images are different for "${stateName}" state`;
+        this.diffOpts = diffOpts;
+        this.diffBounds = diffBounds;
+        this.diffClusters = diffClusters;
+        this.diffBuffer = diffBuffer;
+        this.differentPixels = differentPixels;
+        this.diffRatio = diffRatio;
+    }
+    saveDiffTo(diffPath) {
+        return image_1.default.buildDiff({ diff: diffPath, ...this.diffOpts });
+    }
+}
+exports.ImageDiffError = ImageDiffError;
+//# sourceMappingURL=image-diff-error.js.map

package/build/src/browser/commands/assert-view/errors/image-diff-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-diff-error.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/errors/image-diff-error.ts"],"names":[],"mappings":";;;;;;AAEA,8DAAsC;AACtC,yDAAoD;AAoCpD,MAAa,cAAe,SAAQ,iCAAc;IAS9C,MAAM,CAAC,MAAM,CAET,EACI,SAAS,EACT,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,GAAG,EAAe,EAC3B,UAAU,EACV,eAAe,EACf,SAAS,GAUZ;QAED,OAAO,IAAI,IAAI,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IACjH,CAAC;IAED,MAAM,CAAC,UAAU,CAAwC,IAAwB;QAC7E,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO,IAAI,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,YAAY,EACR,SAAS,EACT,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,EAAe,EACzD,UAAU,EACV,eAAe,EACf,SAAS,GAUZ;QACG,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAElC,IAAI,CAAC,OAAO,GAAG,6BAA6B,SAAS,SAAS,CAAC;QAC/D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,UAAU,CAAC,QAAgB;QACvB,OAAO,eAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,CAAC;CACJ;AAxED,wCAwEC"}

package/build/src/browser/commands/assert-view/errors/invalid-png-error.d.ts

@@ -0,0 +1,5 @@
+export = InvalidPngError;
+declare class InvalidPngError extends Error {
+    constructor(message: any);
+    message: any;
+}

package/build/src/browser/commands/assert-view/errors/invalid-png-error.js

@@ -0,0 +1,9 @@
+"use strict";
+module.exports = class InvalidPngError extends Error {
+    constructor(message) {
+        super();
+        this.name = this.constructor.name;
+        this.message = message;
+    }
+};
+//# sourceMappingURL=invalid-png-error.js.map

package/build/src/browser/commands/assert-view/errors/invalid-png-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalid-png-error.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/errors/invalid-png-error.js"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,MAAM,CAAC,OAAO,GAAG,MAAM,eAAgB,SAAQ,KAAK;IAChD,YAAY,OAAO;QACf,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ,CAAC"}

package/build/src/browser/commands/assert-view/errors/no-ref-image-error.d.ts

@@ -0,0 +1,14 @@
+import { BaseStateError } from "./base-state-error";
+import { ImageInfo } from "../../../../types";
+type NoRefImageErrorConstructor<T> = new (stateName: string, currImg: ImageInfo, refImg: ImageInfo) => T;
+interface NoRefImageErrorData {
+    stateName: string;
+    currImg: ImageInfo;
+    refImg: ImageInfo;
+}
+export declare class NoRefImageError extends BaseStateError {
+    static create<T extends NoRefImageError>(this: NoRefImageErrorConstructor<T>, stateName: string, currImg: ImageInfo, refImg: ImageInfo): T;
+    static fromObject<T extends NoRefImageError>(this: NoRefImageErrorConstructor<T>, data: NoRefImageErrorData): T;
+    constructor(stateName: string, currImg: ImageInfo, refImg: ImageInfo);
+}
+export {};

package/build/src/browser/commands/assert-view/errors/no-ref-image-error.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoRefImageError = void 0;
+const base_state_error_1 = require("./base-state-error");
+class NoRefImageError extends base_state_error_1.BaseStateError {
+    static create(stateName, currImg, refImg) {
+        return new this(stateName, currImg, refImg);
+    }
+    static fromObject(data) {
+        return new this(data.stateName, data.currImg, data.refImg);
+    }
+    constructor(stateName, currImg, refImg) {
+        super(stateName, currImg, refImg);
+        this.message = `can not find reference image at ${this.refImg.path} for "${stateName}" state`;
+    }
+}
+exports.NoRefImageError = NoRefImageError;
+//# sourceMappingURL=no-ref-image-error.js.map

package/build/src/browser/commands/assert-view/errors/no-ref-image-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-ref-image-error.js","sourceRoot":"","sources":["../../../../../../src/browser/commands/assert-view/errors/no-ref-image-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAWpD,MAAa,eAAgB,SAAQ,iCAAc;IAC/C,MAAM,CAAC,MAAM,CAET,SAAiB,EACjB,OAAkB,EAClB,MAAiB;QAEjB,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,UAAU,CAAiE,IAAyB;QACvG,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,YAAY,SAAiB,EAAE,OAAkB,EAAE,MAAiB;QAChE,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAElC,IAAI,CAAC,OAAO,GAAG,mCAAmC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,SAAS,SAAS,CAAC;IAClG,CAAC;CACJ;AAnBD,0CAmBC"}

package/build/src/browser/commands/assert-view/index.d.ts

@@ -0,0 +1,2 @@
+declare function _default(browser: any): void;
+export default _default;

package/build/src/browser/commands/assert-view/index.js

@@ -0,0 +1,130 @@
+"use strict";
+const fs = require("fs-extra");
+const _ = require("lodash");
+const Promise = require("bluebird");
+const { pngValidator: validatePng } = require("png-validator");
+const Image = require("../../../image");
+const ScreenShooter = require("../../screen-shooter");
+const temp = require("../../../temp");
+const { getCaptureProcessors } = require("./capture-processors");
+const RuntimeConfig = require("../../../config/runtime-config");
+const AssertViewResults = require("./assert-view-results");
+const { BaseStateError } = require("./errors/base-state-error");
+const { AssertViewError } = require("./errors/assert-view-error");
+const InvalidPngError = require("./errors/invalid-png-error");
+const getIgnoreDiffPixelCountRatio = value => {
+    const percent = _.isString(value) && value.endsWith("%") ? parseFloat(value.slice(0, -1)) : false;
+    if (percent === false || _.isNaN(percent)) {
+        throw new Error(`Invalid ignoreDiffPixelCount value: got ${value}, but expected number or '\${number}%'`);
+    }
+    if (percent > 100 || percent < 0) {
+        throw new Error(`Invalid ignoreDiffPixelCount value: percent should be in range between 0 and 100`);
+    }
+    return percent / 100;
+};
+module.exports.default = browser => {
+    const screenShooter = ScreenShooter.create(browser);
+    const { publicAPI: session, config } = browser;
+    const { assertViewOpts, compareOpts, compositeImage, screenshotDelay, tolerance, antialiasingTolerance, disableAnimation, } = config;
+    const { handleNoRefImage, handleImageDiff } = getCaptureProcessors();
+    const assertView = async (state, selectors, opts) => {
+        opts = _.defaults(opts, assertViewOpts, {
+            compositeImage,
+            screenshotDelay,
+            tolerance,
+            antialiasingTolerance,
+            disableAnimation,
+        });
+        const { testplaneCtx } = session.executionContext;
+        testplaneCtx.assertViewResults = testplaneCtx.assertViewResults || AssertViewResults.create();
+        if (testplaneCtx.assertViewResults.hasState(state)) {
+            return Promise.reject(new AssertViewError(`duplicate name for "${state}" state`));
+        }
+        const handleCaptureProcessorError = e => e instanceof BaseStateError ? testplaneCtx.assertViewResults.add(e) : Promise.reject(e);
+        const page = await browser.prepareScreenshot([].concat(selectors), {
+            ignoreSelectors: [].concat(opts.ignoreElements),
+            allowViewportOverflow: opts.allowViewportOverflow,
+            captureElementFromTop: opts.captureElementFromTop,
+            selectorToScroll: opts.selectorToScroll,
+            disableAnimation: opts.disableAnimation,
+        });
+        const { tempOpts } = RuntimeConfig.getInstance();
+        temp.attach(tempOpts);
+        const screenshoterOpts = _.pick(opts, [
+            "allowViewportOverflow",
+            "compositeImage",
+            "screenshotDelay",
+            "selectorToScroll",
+        ]);
+        const currImgInst = await screenShooter
+            .capture(page, screenshoterOpts)
+            .finally(() => browser.cleanupScreenshot(opts));
+        const currSize = await currImgInst.getSize();
+        const currImg = { path: temp.path(Object.assign(tempOpts, { suffix: ".png" })), size: currSize };
+        const test = session.executionContext.ctx.currentTest;
+        const refImg = { path: config.getScreenshotPath(test, state), size: null };
+        const { emitter } = browser;
+        if (!fs.existsSync(refImg.path)) {
+            await currImgInst.save(currImg.path);
+            return handleNoRefImage(currImg, refImg, state, { emitter }).catch(e => handleCaptureProcessorError(e));
+        }
+        const { canHaveCaret, pixelRatio } = page;
+        const imageCompareOpts = {
+            tolerance: opts.tolerance,
+            antialiasingTolerance: opts.antialiasingTolerance,
+            canHaveCaret,
+            pixelRatio,
+            compareOpts,
+        };
+        const currBuffer = await currImgInst.toPngBuffer({ resolveWithObject: false });
+        const refBuffer = await fs.readFile(refImg.path);
+        try {
+            validatePng(refBuffer);
+        }
+        catch (err) {
+            throw new InvalidPngError(`Reference image in ${refImg.path} is not a valid png`);
+        }
+        const { equal, diffBounds, diffClusters, diffImage, metaInfo = {}, differentPixels, totalPixels, } = await Image.compare(refBuffer, currBuffer, imageCompareOpts);
+        Object.assign(refImg, metaInfo.refImg);
+        const diffRatio = differentPixels / totalPixels;
+        const isMinorDiff = _.isString(opts.ignoreDiffPixelCount)
+            ? diffRatio <= getIgnoreDiffPixelCountRatio(opts.ignoreDiffPixelCount)
+            : differentPixels <= opts.ignoreDiffPixelCount;
+        if (!equal && !isMinorDiff) {
+            const diffBuffer = await diffImage.createBuffer("png");
+            const diffAreas = { diffBounds, diffClusters };
+            const { tolerance, antialiasingTolerance } = opts;
+            const imageDiffOpts = {
+                tolerance,
+                antialiasingTolerance,
+                canHaveCaret,
+                diffAreas,
+                config,
+                emitter,
+                diffBuffer,
+                differentPixels,
+                diffRatio,
+            };
+            await fs.outputFile(currImg.path, currBuffer);
+            return handleImageDiff(currImg, refImg, state, imageDiffOpts).catch(e => handleCaptureProcessorError(e));
+        }
+        testplaneCtx.assertViewResults.add({ stateName: state, refImg: refImg });
+    };
+    session.addCommand("assertView", async function (state, selectors, opts = {}) {
+        await Promise.map([].concat(selectors), async (selector) => {
+            await this.$(selector)
+                .then(el => el.waitForExist())
+                .catch(() => {
+                throw new Error(`element ("${selector}") still not existing after ${this.options.waitforTimeout} ms`);
+            });
+        });
+        return assertView(state, selectors, opts);
+    });
+    session.addCommand("assertView", async function (state, opts = {}) {
+        await this.waitForExist({ timeoutMsg: "custom timeout msg" }).catch(() => {
+            throw new Error(`element ("${this.selector}") still not existing after ${this.options.waitforTimeout} ms`);
+        });
+        return assertView(state, this.selector, opts);
+    }, true);
+};
+//# sourceMappingURL=index.js.map