testplane 8.20.4 → 8.20.5

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "testplane",
-    "version": "8.20.4",
+    "version": "8.20.5",
     "description": "Tests framework based on mocha and wdio",
     "main": "build/src/index.js",
     "files": [

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

@@ -1,85 +1,5 @@
-import { AssertViewOptsConfig } from "../../config/types";
+import { AssertViewOpts } from "../../config/types";
 import { ChainablePromiseElement } from "webdriverio";
-export interface AssertViewOpts extends Partial<AssertViewOptsConfig> {
-    /**
-     * Maximum allowed difference between colors.
-     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#tolerance tolerance} value.
-     *
-     * @remarks
-     * Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode.
-     * Increasing global default is not recommended, prefer changing tolerance for particular suites or states instead.
-     * By default it's 2.3 which should be enough for the most cases.
-     *
-     * @defaultValue `2.3`
-     */
-    tolerance?: number;
-    /**
-     * Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels.
-     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#antialiasingTolerance antialiasingTolerance} value.
-     *
-     * @remarks
-     * Read more about this option in {@link https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing looks-same}
-     *
-     * @defaultValue `4`
-     */
-    antialiasingTolerance?: number;
-    /**
-     * Allows testing of regions which bottom bounds are outside of a viewport height.
-     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#compositeImage compositeImage} value.
-     *
-     * @remarks
-     * In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height.
-     *
-     * @defaultValue `true`
-     */
-    compositeImage?: boolean;
-    /**
-     * Allows to specify a delay (in milliseconds) before making any screenshot.
-     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#screenshotDelay screenshotDelay} value.
-     *
-     * @remarks
-     * This is useful when the page has elements which are animated or if you do not want to screen a scrollbar.
-     *
-     * @defaultValue `0`
-     */
-    screenshotDelay?: number;
-    /**
-     * Ability to set DOM-node selector which should be scroll when the captured element does not completely fit on the screen.
-     *
-     * @remarks
-     * Useful when you capture the modal (popup). In this case a duplicate of the modal appears on the screenshot.
-     * That happens because we scroll the page using `window` selector, which scroll only the background of the modal, and the modal itself remains in place.
-     * Default value is `undefined` (it means scroll relative to `window`). Works only when `compositeImage` is `true` (default).
-     *
-     * @defaultValue `undefined`
-     */
-    selectorToScroll?: string;
-    /**
-     * Ability to disable animations and transitions while making a screenshot
-     *
-     * @remarks
-     * Usefull when you capture screenshot of a page, having animations and transitions.
-     * Iframe animations are only disabled when using webdriver protocol.
-     *
-     * @defaultValue `true`
-     */
-    disableAnimation?: boolean;
-    /**
-     * Ability to ignore a small amount of different pixels to classify screenshots as being "identical"
-     *
-     * @example 5
-     * @example '1.5%'
-     *
-     * @remarks
-     * Useful when you encounter a few pixels difference that cannot be eliminated using the tolerance and antialiasingTolerance settings.
-     *
-     * @note
-     * This should be considered a last resort and only used in small number of cases where necessary.
-     *
-     * @defaultValue `0`
-     */
-    ignoreDiffPixelCount?: `${number}%` | number;
-}
 export type AssertViewCommandWithSelector = (this: WebdriverIO.Browser, state: string, selectors: string | string[], opts?: AssertViewOpts) => Promise<void>;
 export type AssertViewCommandWithoutSelector = (this: WebdriverIO.Browser, state: string, opts?: AssertViewOpts) => Promise<void>;
 export type AssertViewCommand = AssertViewCommandWithSelector & AssertViewCommandWithoutSelector;

package/build/src/config/types.d.ts

@@ -14,13 +14,13 @@ export interface BuildDiffOptsConfig {
     ignoreAntialiasing: boolean;
     ignoreCaret: boolean;
 }
-export interface AssertViewOptsConfig {
+export interface AssertViewOpts {
     /**
      * DOM-node selectors which will be ignored (painted with a black rectangle) when comparing images.
      *
      * @defaultValue `[]`
      */
-    ignoreElements: string | Array<string>;
+    ignoreElements?: string | Array<string>;
     /**
      * Ability to set capture element from the top area or from current position.
      *
@@ -29,7 +29,7 @@ export interface AssertViewOptsConfig {
      *
      * @defaultValue `true`
      */
-    captureElementFromTop: boolean;
+    captureElementFromTop?: boolean;
     /**
      * Disables check that element is outside of the viewport left, top, right or bottom bounds.
      *
@@ -41,7 +41,85 @@ export interface AssertViewOptsConfig {
      *
      * @defaultValue `false`
      */
-    allowViewportOverflow: boolean;
+    allowViewportOverflow?: boolean;
+    /**
+     * Maximum allowed difference between colors.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#tolerance tolerance} value.
+     *
+     * @remarks
+     * Indicates maximum allowed CIEDE2000 difference between colors. Used only in non-strict mode.
+     * Increasing global default is not recommended, prefer changing tolerance for particular suites or states instead.
+     * By default it's 2.3 which should be enough for the most cases.
+     *
+     * @defaultValue `2.3`
+     */
+    tolerance?: number;
+    /**
+     * Minimum difference in brightness (zero by default) between the darkest/lightest pixel (which is adjacent to the antialiasing pixel) and theirs adjacent pixels.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#antialiasingTolerance antialiasingTolerance} value.
+     *
+     * @remarks
+     * Read more about this option in {@link https://github.com/gemini-testing/looks-same#comparing-images-with-ignoring-antialiasing looks-same}
+     *
+     * @defaultValue `4`
+     */
+    antialiasingTolerance?: number;
+    /**
+     * Allows testing of regions which bottom bounds are outside of a viewport height.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#compositeImage compositeImage} value.
+     *
+     * @remarks
+     * In the resulting screenshot the area which fits the viewport bounds will be joined with the area which is outside of the viewport height.
+     *
+     * @defaultValue `true`
+     */
+    compositeImage?: boolean;
+    /**
+     * Allows to specify a delay (in milliseconds) before making any screenshot.
+     * Overrides config {@link https://github.com/gemini-testing/testplane#browsers browsers}.{@link https://github.com/gemini-testing/testplane#screenshotDelay screenshotDelay} value.
+     *
+     * @remarks
+     * This is useful when the page has elements which are animated or if you do not want to screen a scrollbar.
+     *
+     * @defaultValue `0`
+     */
+    screenshotDelay?: number;
+    /**
+     * Ability to set DOM-node selector which should be scroll when the captured element does not completely fit on the screen.
+     *
+     * @remarks
+     * Useful when you capture the modal (popup). In this case a duplicate of the modal appears on the screenshot.
+     * That happens because we scroll the page using `window` selector, which scroll only the background of the modal, and the modal itself remains in place.
+     * Default value is `undefined` (it means scroll relative to `window`). Works only when `compositeImage` is `true` (default).
+     *
+     * @defaultValue `undefined`
+     */
+    selectorToScroll?: string;
+    /**
+     * Ability to disable animations and transitions while making a screenshot
+     *
+     * @remarks
+     * Usefull when you capture screenshot of a page, having animations and transitions.
+     * Iframe animations are only disabled when using webdriver protocol.
+     *
+     * @defaultValue `true`
+     */
+    disableAnimation?: boolean;
+    /**
+     * Ability to ignore a small amount of different pixels to classify screenshots as being "identical"
+     *
+     * @example 5
+     * @example '1.5%'
+     *
+     * @remarks
+     * Useful when you encounter a few pixels difference that cannot be eliminated using the tolerance and antialiasingTolerance settings.
+     *
+     * @note
+     * This should be considered a last resort and only used in small number of cases where necessary.
+     *
+     * @defaultValue `0`
+     */
+    ignoreDiffPixelCount?: `${number}%` | number;
 }
 export interface ExpectOptsConfig {
     wait: number;
@@ -124,7 +202,7 @@ export interface CommonConfig {
     antialiasingTolerance: number;
     compareOpts: CompareOptsConfig;
     buildDiffOpts: BuildDiffOptsConfig;
-    assertViewOpts: AssertViewOptsConfig;
+    assertViewOpts: AssertViewOpts;
     expectOpts: ExpectOptsConfig;
     meta: {
         [name: string]: unknown;

package/build/src/index.d.ts

@@ -5,9 +5,9 @@ import "expect-webdriverio";
 import { GlobalHelper } from "./types";
 export { Testplane as default } from "./testplane";
 export { Key } from "webdriverio";
-export type { WdioBrowser, TestResult, Test, Suite, TestError, AssertViewOpts, HermioneCtx, GlobalHelper, TestplaneCtx, TestFunctionCtx, } from "./types";
+export type { WdioBrowser, TestResult, Test, Suite, TestError, HermioneCtx, GlobalHelper, TestplaneCtx, TestFunctionCtx, } from "./types";
 export type { Config } from "./config";
-export type { ConfigInput } from "./config/types";
+export type { ConfigInput, AssertViewOpts } from "./config/types";
 export type { TestCollection, FormatterTreeSuite, FormatterTreeTest, FormatterTreeMainRunnable, FormatterListTest, } from "./test-collection";
 export type { StatsResult } from "./stats";
 import type { TestDefinition, SuiteDefinition, TestHookDefinition } from "./test-reader/test-object/types";

package/build/src/types/index.d.ts

@@ -19,7 +19,6 @@ export type { Browser as WdioBrowser } from "webdriverio";
 export type { Test } from "../test-reader/test-object/test";
 export type { Suite } from "../test-reader/test-object/suite";
 export type { TestFunctionCtx } from "../test-reader/test-object/types";
-export type { AssertViewOpts } from "../browser/commands/types";
 export interface RootSuite extends Suite {
     root: true;
 }

package/build/src/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;AA0GA,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,yBAAU,CAAA;IACV,yBAAU,CAAA;IACV,0BAAW,CAAA;IACX,6BAAc,CAAA;IACd,+BAAgB,CAAA;IAChB,6BAAc,CAAA;IACd,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,6BAAc,CAAA;IACd,6BAAc,CAAA;IACd,wBAAS,CAAA;AACb,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;AAwGA,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,yBAAU,CAAA;IACV,yBAAU,CAAA;IACV,0BAAW,CAAA;IACX,6BAAc,CAAA;IACd,+BAAgB,CAAA;IAChB,6BAAc,CAAA;IACd,kCAAmB,CAAA;IACnB,4BAAa,CAAA;IACb,6BAAc,CAAA;IACd,6BAAc,CAAA;IACd,wBAAS,CAAA;AACb,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testplane",
-  "version": "8.20.4",
+  "version": "8.20.5",
   "description": "Tests framework based on mocha and wdio",
   "main": "build/src/index.js",
   "files": [