@o3r/testing 10.0.0-next.9 → 11.0.0-next.0

package/tools/protractor/post-message-interceptor/post-message-interceptor.d.ts

@@ -6,14 +6,12 @@ export declare class PostMessageInterceptor {
     private readonly GET_INSTANCE;
     /**
      * Executes a script in the app
-     *
      * @param methodName
      * @param {...any} args
      */
     private execInstanceMethod;
     /**
      * Executes an async script in the app
-     *
      * @param methodName
      * @param {...any} args
      */
@@ -29,7 +27,6 @@ export declare class PostMessageInterceptor {
     stop(): Promise<void>;
     /**
      * Listens for post messages
-     *
      * @param conditionFn an optional boolean function that will evaluate if the message should be saved or not in the stack
      */
     listen(conditionFn?: ConditionFn): Promise<void>;
@@ -39,7 +36,6 @@ export declare class PostMessageInterceptor {
     stopListening(): Promise<void>;
     /**
      * Get all the post messages
-     *
      * @param timeoutInterval Interval in milliseconds between two checks
      * @param retries How many retries to be executed (-1 for infinite retries)
      */

package/tools/protractor/post-message-interceptor/post-message-interceptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"post-message-interceptor.d.ts","sourceRoot":"","sources":["../../../../src/tools/protractor/post-message-interceptor/post-message-interceptor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEtD;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiD;IAE9E;;;;;OAKG;YACW,kBAAkB;IAIhC;;;;;OAKG;YACW,uBAAuB;IAIrC;;;OAGG;IACU,UAAU;IAWvB;;OAEG;IACU,IAAI;IAIjB;;;;OAIG;IACU,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW;IAI7C;;OAEG;IACU,aAAa;IAI1B;;;;;OAKG;IACU,WAAW,CAAC,eAAe,SAAM,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAG1F"}
+{"version":3,"file":"post-message-interceptor.d.ts","sourceRoot":"","sources":["../../../../src/tools/protractor/post-message-interceptor/post-message-interceptor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEtD;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiD;IAE9E;;;;OAIG;YACW,kBAAkB;IAIhC;;;;OAIG;YACW,uBAAuB;IAIrC;;;OAGG;IACU,UAAU;IAWvB;;OAEG;IACU,IAAI;IAIjB;;;OAGG;IACU,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW;IAI7C;;OAEG;IACU,aAAa;IAI1B;;;;OAIG;IACU,WAAW,CAAC,eAAe,SAAM,EAAE,OAAO,SAAK,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAG1F"}

package/tools/protractor/post-message-interceptor/post-message-interceptor.js

@@ -14,7 +14,6 @@ var PostMessageInterceptor = /** @class */ (function () {
     }
     /**
      * Executes a script in the app
-     *
      * @param methodName
      * @param {...any} args
      */
@@ -34,7 +33,6 @@ var PostMessageInterceptor = /** @class */ (function () {
     };
     /**
      * Executes an async script in the app
-     *
      * @param methodName
      * @param {...any} args
      */
@@ -93,7 +91,6 @@ var PostMessageInterceptor = /** @class */ (function () {
     };
     /**
      * Listens for post messages
-     *
      * @param conditionFn an optional boolean function that will evaluate if the message should be saved or not in the stack
      */
     PostMessageInterceptor.prototype.listen = function (conditionFn) {
@@ -125,7 +122,6 @@ var PostMessageInterceptor = /** @class */ (function () {
     };
     /**
      * Get all the post messages
-     *
      * @param timeoutInterval Interval in milliseconds between two checks
      * @param retries How many retries to be executed (-1 for infinite retries)
      */

package/tools/protractor/post-message-interceptor/post-message-interceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"post-message-interceptor.js","sourceRoot":"","sources":["../../../../src/tools/protractor/post-message-interceptor/post-message-interceptor.ts"],"names":[],"mappings":";;;;AAAA,4BAA8B;AAC9B,gCAAkC;AAClC,yCAAqC;AAIrC;;GAEG;AACH;IAAA;QACmB,iBAAY,GAAG,6CAA6C,CAAC;IAqEhF,CAAC;IAnEC;;;;;OAKG;IACW,mDAAkB,GAAhC,UAAiC,UAAkB;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;;;;4BAC1D,qBAAM,oBAAO,CAAC,aAAa,OAArB,oBAAO,yBAAe,UAAG,IAAI,CAAC,YAAY,cAAI,UAAU,oBAAiB,GAAK,IAAI,WAAC;4BAAhG,sBAAO,SAAyF,EAAC;;;;KAClG;IAED;;;;;OAKG;IACW,wDAAuB,GAArC,UAAsC,UAAkB;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;;;;4BAC/D,qBAAM,oBAAO,CAAC,kBAAkB,OAA1B,oBAAO,yBAAoB,UAAG,IAAI,CAAC,YAAY,cAAI,UAAU,oBAAiB,GAAK,IAAI,WAAC;4BAArG,sBAAO,SAA8F,EAAC;;;;KACvG;IAED;;;OAGG;IACU,2CAAU,GAAvB;;;;;;wBACQ,YAAY,GAAG,EAAE,CAAC,YAAY,CAClC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,0BAA0B,EAAE,8BAA8B,CAAC,EACjJ;4BACE,QAAQ,EAAE,OAAO;yBAClB,CACF,CAAC;wBACF,qBAAM,oBAAO,CAAC,aAAa,CAAC,YAAY,CAAC,EAAA;;wBAAzC,SAAyC,CAAC;wBAC1C,qBAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAA;;wBAArC,SAAqC,CAAC;;;;;KACvC;IAED;;OAEG;IACU,qCAAI,GAAjB;;;;4BACE,qBAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAA;;wBAArC,SAAqC,CAAC;;;;;KACvC;IAED;;;;OAIG;IACU,uCAAM,GAAnB,UAAoB,WAAyB;;;;4BAC3C,qBAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAA;;wBAApD,SAAoD,CAAC;;;;;KACtD;IAED;;OAEG;IACU,8CAAa,GAA1B;;;;4BACE,qBAAM,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAA;;wBAA9C,SAA8C,CAAC;;;;;KAChD;IAED;;;;;OAKG;IACU,4CAAW,GAAxB,UAAyB,eAAqB,EAAE,OAAY;QAAnC,gCAAA,EAAA,qBAAqB;QAAE,wBAAA,EAAA,WAAW,CAAC;;;;4BAClD,qBAAM,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,eAAe,EAAE,OAAO,CAAC,EAAA;4BAAnF,sBAAO,CAAC,SAA2E,CAAsB,EAAC;;;;KAC3G;IACH,6BAAC;AAAD,CAAC,AAtED,IAsEC;AAtEY,wDAAsB","sourcesContent":["import * as fs from 'node:fs';\nimport * as path from 'node:path';\nimport { browser } from 'protractor';\n\nimport { ConditionFn, PostMessageCall } from './core';\n\n/**\n * Controls the postMessage interceptor\n */\nexport class PostMessageInterceptor {\n  private readonly GET_INSTANCE = 'window.postMessageInterceptor.getInstance()';\n\n  /**\n   * Executes a script in the app\n   *\n   * @param methodName\n   * @param {...any} args\n   */\n  private async execInstanceMethod(methodName: string, ...args: any[]) {\n    return await browser.executeScript(`${this.GET_INSTANCE}.${methodName}(...arguments);`, ...args);\n  }\n\n  /**\n   * Executes an async script in the app\n   *\n   * @param methodName\n   * @param {...any} args\n   */\n  private async execInstanceAsyncMethod(methodName: string, ...args: any[]) {\n    return await browser.executeAsyncScript(`${this.GET_INSTANCE}.${methodName}(...arguments);`, ...args);\n  }\n\n  /**\n   * Initializes the PostMessageInterceptor in the app\n   * NOTE: It does not start listening right away. You need to call listen()\n   */\n  public async initialize() {\n    const fetchManager = fs.readFileSync(\n      path.resolve(process.cwd(), 'node_modules', '@o3r', 'testing', 'tools', 'protractor', 'post-message-interceptor', '_post-message-interceptor.js'),\n      {\n        encoding: 'utf-8'\n      }\n    );\n    await browser.executeScript(fetchManager);\n    await this.execInstanceMethod('init');\n  }\n\n  /**\n   * Stops the PostMessageInterceptor.\n   */\n  public async stop() {\n    await this.execInstanceMethod('stop');\n  }\n\n  /**\n   * Listens for post messages\n   *\n   * @param conditionFn an optional boolean function that will evaluate if the message should be saved or not in the stack\n   */\n  public async listen(conditionFn?: ConditionFn) {\n    await this.execInstanceMethod('listen', conditionFn);\n  }\n\n  /**\n   * Stops listening for post messages, resets the stack and clears the condition\n   */\n  public async stopListening() {\n    await this.execInstanceMethod('stopListening');\n  }\n\n  /**\n   * Get all the post messages\n   *\n   * @param timeoutInterval Interval in milliseconds between two checks\n   * @param retries How many retries to be executed (-1 for infinite retries)\n   */\n  public async getMessages(timeoutInterval = 100, retries = -1): Promise<PostMessageCall[]> {\n    return (await this.execInstanceAsyncMethod('getMessages', timeoutInterval, retries)) as PostMessageCall[];\n  }\n}\n"]}
+{"version":3,"file":"post-message-interceptor.js","sourceRoot":"","sources":["../../../../src/tools/protractor/post-message-interceptor/post-message-interceptor.ts"],"names":[],"mappings":";;;;AAAA,4BAA8B;AAC9B,gCAAkC;AAClC,yCAAqC;AAIrC;;GAEG;AACH;IAAA;QACmB,iBAAY,GAAG,6CAA6C,CAAC;IAiEhF,CAAC;IA/DC;;;;OAIG;IACW,mDAAkB,GAAhC,UAAiC,UAAkB;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;;;;4BAC1D,qBAAM,oBAAO,CAAC,aAAa,OAArB,oBAAO,yBAAe,UAAG,IAAI,CAAC,YAAY,cAAI,UAAU,oBAAiB,GAAK,IAAI,WAAC;4BAAhG,sBAAO,SAAyF,EAAC;;;;KAClG;IAED;;;;OAIG;IACW,wDAAuB,GAArC,UAAsC,UAAkB;QAAE,cAAc;aAAd,UAAc,EAAd,qBAAc,EAAd,IAAc;YAAd,6BAAc;;;;;4BAC/D,qBAAM,oBAAO,CAAC,kBAAkB,OAA1B,oBAAO,yBAAoB,UAAG,IAAI,CAAC,YAAY,cAAI,UAAU,oBAAiB,GAAK,IAAI,WAAC;4BAArG,sBAAO,SAA8F,EAAC;;;;KACvG;IAED;;;OAGG;IACU,2CAAU,GAAvB;;;;;;wBACQ,YAAY,GAAG,EAAE,CAAC,YAAY,CAClC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,0BAA0B,EAAE,8BAA8B,CAAC,EACjJ;4BACE,QAAQ,EAAE,OAAO;yBAClB,CACF,CAAC;wBACF,qBAAM,oBAAO,CAAC,aAAa,CAAC,YAAY,CAAC,EAAA;;wBAAzC,SAAyC,CAAC;wBAC1C,qBAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAA;;wBAArC,SAAqC,CAAC;;;;;KACvC;IAED;;OAEG;IACU,qCAAI,GAAjB;;;;4BACE,qBAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAA;;wBAArC,SAAqC,CAAC;;;;;KACvC;IAED;;;OAGG;IACU,uCAAM,GAAnB,UAAoB,WAAyB;;;;4BAC3C,qBAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAA;;wBAApD,SAAoD,CAAC;;;;;KACtD;IAED;;OAEG;IACU,8CAAa,GAA1B;;;;4BACE,qBAAM,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAA;;wBAA9C,SAA8C,CAAC;;;;;KAChD;IAED;;;;OAIG;IACU,4CAAW,GAAxB,UAAyB,eAAqB,EAAE,OAAY;QAAnC,gCAAA,EAAA,qBAAqB;QAAE,wBAAA,EAAA,WAAW,CAAC;;;;4BAClD,qBAAM,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,eAAe,EAAE,OAAO,CAAC,EAAA;4BAAnF,sBAAO,CAAC,SAA2E,CAAsB,EAAC;;;;KAC3G;IACH,6BAAC;AAAD,CAAC,AAlED,IAkEC;AAlEY,wDAAsB","sourcesContent":["import * as fs from 'node:fs';\nimport * as path from 'node:path';\nimport { browser } from 'protractor';\n\nimport { ConditionFn, PostMessageCall } from './core';\n\n/**\n * Controls the postMessage interceptor\n */\nexport class PostMessageInterceptor {\n  private readonly GET_INSTANCE = 'window.postMessageInterceptor.getInstance()';\n\n  /**\n   * Executes a script in the app\n   * @param methodName\n   * @param {...any} args\n   */\n  private async execInstanceMethod(methodName: string, ...args: any[]) {\n    return await browser.executeScript(`${this.GET_INSTANCE}.${methodName}(...arguments);`, ...args);\n  }\n\n  /**\n   * Executes an async script in the app\n   * @param methodName\n   * @param {...any} args\n   */\n  private async execInstanceAsyncMethod(methodName: string, ...args: any[]) {\n    return await browser.executeAsyncScript(`${this.GET_INSTANCE}.${methodName}(...arguments);`, ...args);\n  }\n\n  /**\n   * Initializes the PostMessageInterceptor in the app\n   * NOTE: It does not start listening right away. You need to call listen()\n   */\n  public async initialize() {\n    const fetchManager = fs.readFileSync(\n      path.resolve(process.cwd(), 'node_modules', '@o3r', 'testing', 'tools', 'protractor', 'post-message-interceptor', '_post-message-interceptor.js'),\n      {\n        encoding: 'utf-8'\n      }\n    );\n    await browser.executeScript(fetchManager);\n    await this.execInstanceMethod('init');\n  }\n\n  /**\n   * Stops the PostMessageInterceptor.\n   */\n  public async stop() {\n    await this.execInstanceMethod('stop');\n  }\n\n  /**\n   * Listens for post messages\n   * @param conditionFn an optional boolean function that will evaluate if the message should be saved or not in the stack\n   */\n  public async listen(conditionFn?: ConditionFn) {\n    await this.execInstanceMethod('listen', conditionFn);\n  }\n\n  /**\n   * Stops listening for post messages, resets the stack and clears the condition\n   */\n  public async stopListening() {\n    await this.execInstanceMethod('stopListening');\n  }\n\n  /**\n   * Get all the post messages\n   * @param timeoutInterval Interval in milliseconds between two checks\n   * @param retries How many retries to be executed (-1 for infinite retries)\n   */\n  public async getMessages(timeoutInterval = 100, retries = -1): Promise<PostMessageCall[]> {\n    return (await this.execInstanceAsyncMethod('getMessages', timeoutInterval, retries)) as PostMessageCall[];\n  }\n}\n"]}

package/visual-test/utils.d.ts

@@ -2,7 +2,6 @@
  * Prepare css rule to hide specific blocks
  *
  * Should be called only once during the visual test.
- *
  * @note: this function is evaluated in the context of the page and should not use external variables
  * @param ignoreClass
  */
@@ -13,7 +12,6 @@ export declare function prepareVisualTesting(ignoreClass?: string): void;
 export declare function isVisualTestingEnabled(): boolean;
 /**
  * Toggle the visual testing view : if it is active, will hide tagged components as grey blocks.
- *
  * @note: this function is evaluated in the context of the page and cannot use external code
  * @param enabled
  */

package/visual-test/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/visual-test/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,SAAe,QAkB9D;AAED;;GAEG;AACH,wBAAgB,sBAAsB,YAGrC;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,QAOzD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/visual-test/utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,SAAe,QAkB9D;AAED;;GAEG;AACH,wBAAgB,sBAAsB,YAGrC;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,QAOzD"}

package/visual-test/utils.js

@@ -5,7 +5,6 @@ exports.toggleVisualTestingRender = exports.isVisualTestingEnabled = exports.pre
  * Prepare css rule to hide specific blocks
  *
  * Should be called only once during the visual test.
- *
  * @note: this function is evaluated in the context of the page and should not use external variables
  * @param ignoreClass
  */
@@ -27,7 +26,6 @@ function isVisualTestingEnabled() {
 exports.isVisualTestingEnabled = isVisualTestingEnabled;
 /**
  * Toggle the visual testing view : if it is active, will hide tagged components as grey blocks.
- *
  * @note: this function is evaluated in the context of the page and cannot use external code
  * @param enabled
  */

package/visual-test/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/visual-test/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,WAA0B;IAA1B,4BAAA,EAAA,0BAA0B;IAC7D,IAAM,gBAAgB,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACzD,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,gBAAgB,CAAC,WAAW,GAAG,iBAC1B,kBAAkB,eAAK,WAAW,4CAElC,kBAAkB,eAAK,WAAW,wLASrC,CAAC;IAEH,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;AAC9C,CAAC;AAlBD,oDAkBC;AAED;;GAEG;AACH,SAAgB,sBAAsB;IACpC,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAC9D,CAAC;AAHD,wDAGC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,OAAgB;IACxD,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;KACjD;SAAM;QACL,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;KACpD;AACH,CAAC;AAPD,8DAOC","sourcesContent":["/**\n * Prepare css rule to hide specific blocks\n *\n * Should be called only once during the visual test.\n *\n * @note: this function is evaluated in the context of the page and should not use external variables\n * @param ignoreClass\n */\nexport function prepareVisualTesting(ignoreClass = 'e2e-ignore') {\n  const visualTestingCss = document.createElement('style');\n  const visualTestingClass = 'visual-testing-render';\n  visualTestingCss.textContent = `\n    .${visualTestingClass} .${ignoreClass} {position: relative;}\n\n    .${visualTestingClass} .${ignoreClass}:before {\n      z-index: 999;\n      content: '';\n      width: 100%;\n      height: 100%;\n      background: grey;\n      position: absolute;\n      left: 0;\n      top: 0;\n  }`;\n\n  document.head.appendChild(visualTestingCss);\n}\n\n/**\n * Determine if the visual testing is enabled\n */\nexport function isVisualTestingEnabled() {\n  const visualTestingClass = 'visual-testing-render';\n  return document.body.classList.contains(visualTestingClass);\n}\n\n/**\n * Toggle the visual testing view : if it is active, will hide tagged components as grey blocks.\n *\n * @note: this function is evaluated in the context of the page and cannot use external code\n * @param enabled\n */\nexport function toggleVisualTestingRender(enabled: boolean) {\n  const visualTestingClass = 'visual-testing-render';\n  if (enabled) {\n    document.body.classList.add(visualTestingClass);\n  } else {\n    document.body.classList.remove(visualTestingClass);\n  }\n}\n"]}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/visual-test/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,WAA0B;IAA1B,4BAAA,EAAA,0BAA0B;IAC7D,IAAM,gBAAgB,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACzD,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,gBAAgB,CAAC,WAAW,GAAG,iBAC1B,kBAAkB,eAAK,WAAW,4CAElC,kBAAkB,eAAK,WAAW,wLASrC,CAAC;IAEH,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;AAC9C,CAAC;AAlBD,oDAkBC;AAED;;GAEG;AACH,SAAgB,sBAAsB;IACpC,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAC9D,CAAC;AAHD,wDAGC;AAED;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,OAAgB;IACxD,IAAM,kBAAkB,GAAG,uBAAuB,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;KACjD;SAAM;QACL,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;KACpD;AACH,CAAC;AAPD,8DAOC","sourcesContent":["/**\n * Prepare css rule to hide specific blocks\n *\n * Should be called only once during the visual test.\n * @note: this function is evaluated in the context of the page and should not use external variables\n * @param ignoreClass\n */\nexport function prepareVisualTesting(ignoreClass = 'e2e-ignore') {\n  const visualTestingCss = document.createElement('style');\n  const visualTestingClass = 'visual-testing-render';\n  visualTestingCss.textContent = `\n    .${visualTestingClass} .${ignoreClass} {position: relative;}\n\n    .${visualTestingClass} .${ignoreClass}:before {\n      z-index: 999;\n      content: '';\n      width: 100%;\n      height: 100%;\n      background: grey;\n      position: absolute;\n      left: 0;\n      top: 0;\n  }`;\n\n  document.head.appendChild(visualTestingCss);\n}\n\n/**\n * Determine if the visual testing is enabled\n */\nexport function isVisualTestingEnabled() {\n  const visualTestingClass = 'visual-testing-render';\n  return document.body.classList.contains(visualTestingClass);\n}\n\n/**\n * Toggle the visual testing view : if it is active, will hide tagged components as grey blocks.\n * @note: this function is evaluated in the context of the page and cannot use external code\n * @param enabled\n */\nexport function toggleVisualTestingRender(enabled: boolean) {\n  const visualTestingClass = 'visual-testing-render';\n  if (enabled) {\n    document.body.classList.add(visualTestingClass);\n  } else {\n    document.body.classList.remove(visualTestingClass);\n  }\n}\n"]}

package/visual-test/visual-test.d.ts

@@ -50,8 +50,7 @@ export declare function toBeVisuallySimilar(): {
  * It will create a file for the passed screenshot object.
  * The path of the new file will be calculated using the parameters
  * Ex: ./dist-screenshots\OWBooking\windows_chrome_91\fare-page-after-click-on-continue-0.png
- *     distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png
- *
+ * distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png
  * @param screenshot The screenshot object captured. Ex: for protractor - browser.takeScreenshot()
  * @param scenarioName E2e Scenario class name
  * @param device Details of the platform on which the test is run. If there are spaces the helper will do the concatenation. Ex: `Windows 10 chrome 89`
@@ -62,7 +61,6 @@ export declare function saveScreenshot(screenshot: string, scenarioName: string,
 /**
  * Write the 3 images (base/new/diff) on the reports folder
  * The path inside the reports forlder will be calculated using the parameters
- *
  * @param pathToScenarioReport Path where the scenario report is saved inside reports folder
  * @param screenshotsDirName Name of the directory which will contain the 3 images
  * @param diff diff image
@@ -72,7 +70,6 @@ export declare function saveScreenshot(screenshot: string, scenarioName: string,
 export declare function writeScreenshotsDiff(pathToScenarioReport: string, screenshotsDirName: string, diff: PNG, baseImage: PNG, currentImg: PNG): void;
 /**
  * Compare images helper function. If the comparison fails the 3 images (base/new/diff) will be written inside the reports folder of the actual scenario
- *
  * @param screenshot Actual captured screenshot object
  * @param baseImagePath The path to the base screenshot
  * @param threshold The diff between base screenshot and the current one should not be bigger than this value.
@@ -82,7 +79,6 @@ export declare function writeScreenshotsDiff(pathToScenarioReport: string, scree
 export declare function compareScreenshot(screenshot: string, baseImagePath: string, threshold: number, pathToScenarioReport: string): VisualTestResult;
 /**
  * Helper function to perform a visual test operation
- *
  * @param screenshotObj Ex: for protractor browser.takeScreenshot()
  * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end
  * @param device os followed by browser version - ex: `Windows 10 chrome 89`

package/visual-test/visual-test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"visual-test.d.ts","sourceRoot":"","sources":["../../src/visual-test/visual-test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAG1B,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAEjB,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,0EAA0E;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,uDAAuD;AACvD,eAAO,MAAM,kBAAkB,EAAE,iBAMhC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6GAA6G;IAC7G,UAAU,CAAC,EAAE;QAAC,cAAc,EAAE,MAAM,CAAA;KAAC,CAAC;IACtC,0FAA0F;IAC1F,sBAAsB,CAAC,EAAE;QAAC,kBAAkB,EAAE,MAAM,CAAA;KAAC,CAAC;IACtD,6GAA6G;IAC7G,IAAI,CAAC,EAAE;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAC,CAAC;IACvE,yCAAyC;IACzC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB;sBAEb,gBAAgB,aAAa,gBAAgB;;;;EA8BlE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,kBAAkB,SAAqB,QASjK;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,oBAAoB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,QAYxI;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,GAAG,gBAAgB,CA6B9I;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAC3B,aAAa,EAAE,MAAM,EACrB,wBAAwB,EAAE,MAAM,EAChC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,oBAAoB,SAAY,EAChC,SAAS,SAAI,EACb,YAAY,UAAQ,EACpB,sBAAsB,SAA0B,oBAUjD"}
+{"version":3,"file":"visual-test.d.ts","sourceRoot":"","sources":["../../src/visual-test/visual-test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAG1B,OAAO,EACL,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,SAAS,CAAC;AAEjB,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,0EAA0E;IAC1E,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,uDAAuD;AACvD,eAAO,MAAM,kBAAkB,EAAE,iBAMhC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,6GAA6G;IAC7G,UAAU,CAAC,EAAE;QAAC,cAAc,EAAE,MAAM,CAAA;KAAC,CAAC;IACtC,0FAA0F;IAC1F,sBAAsB,CAAC,EAAE;QAAC,kBAAkB,EAAE,MAAM,CAAA;KAAC,CAAC;IACtD,6GAA6G;IAC7G,IAAI,CAAC,EAAE;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAC,CAAC;IACvE,yCAAyC;IACzC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB;sBAEb,gBAAgB,aAAa,gBAAgB;;;;EA8BlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,kBAAkB,SAAqB,QASjK;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,oBAAoB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,QAYxI;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,GAAG,gBAAgB,CA6B9I;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC3B,aAAa,EAAE,MAAM,EACrB,wBAAwB,EAAE,MAAM,EAChC,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,oBAAoB,SAAY,EAChC,SAAS,SAAI,EACb,YAAY,UAAQ,EACpB,sBAAsB,SAA0B,oBAUjD"}

package/visual-test/visual-test.js

@@ -59,8 +59,7 @@ exports.toBeVisuallySimilar = toBeVisuallySimilar;
  * It will create a file for the passed screenshot object.
  * The path of the new file will be calculated using the parameters
  * Ex: ./dist-screenshots\OWBooking\windows_chrome_91\fare-page-after-click-on-continue-0.png
- *     distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png
- *
+ * distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png
  * @param screenshot The screenshot object captured. Ex: for protractor - browser.takeScreenshot()
  * @param scenarioName E2e Scenario class name
  * @param device Details of the platform on which the test is run. If there are spaces the helper will do the concatenation. Ex: `Windows 10 chrome 89`
@@ -82,7 +81,6 @@ exports.saveScreenshot = saveScreenshot;
 /**
  * Write the 3 images (base/new/diff) on the reports folder
  * The path inside the reports forlder will be calculated using the parameters
- *
  * @param pathToScenarioReport Path where the scenario report is saved inside reports folder
  * @param screenshotsDirName Name of the directory which will contain the 3 images
  * @param diff diff image
@@ -104,7 +102,6 @@ function writeScreenshotsDiff(pathToScenarioReport, screenshotsDirName, diff, ba
 exports.writeScreenshotsDiff = writeScreenshotsDiff;
 /**
  * Compare images helper function. If the comparison fails the 3 images (base/new/diff) will be written inside the reports folder of the actual scenario
- *
  * @param screenshot Actual captured screenshot object
  * @param baseImagePath The path to the base screenshot
  * @param threshold The diff between base screenshot and the current one should not be bigger than this value.
@@ -144,7 +141,6 @@ function compareScreenshot(screenshot, baseImagePath, threshold, pathToScenarioR
 exports.compareScreenshot = compareScreenshot;
 /**
  * Helper function to perform a visual test operation
- *
  * @param screenshotObj Ex: for protractor browser.takeScreenshot()
  * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end
  * @param device os followed by browser version - ex: `Windows 10 chrome 89`

package/visual-test/visual-test.js.map

@@ -1 +1 @@
-{"version":3,"file":"visual-test.js","sourceRoot":"","sources":["../../src/visual-test/visual-test.ts"],"names":[],"mappings":";;;AAAA,4BAA8B;AAC9B,gCAAkC;AAClC,+BAA0B;AAC1B,uCAAyC;AAEzC,iCAGiB;AAFf,6GAAA,oBAAoB,OAAA;AACpB,kHAAA,yBAAyB,OAAA;AAiB3B,uDAAuD;AAC1C,QAAA,kBAAkB,GAAsB;IACnD,UAAU,EAAE,+BAA+B;IAC3C,WAAW,EAAE,oDAAoD;IACjE,eAAe,EAAE,iCAAiC;IAClD,OAAO,EAAE,wBAAwB;IACjC,YAAY,EAAE,iCAAiC;CAChD,CAAC;AAgBF;;;GAGG;AACH,SAAgB,mBAAmB;IACjC,OAAO;QACL,OAAO,EAAE,UAAC,MAAwB,EAAE,SAA2B;YAC7D,IAAI,MAAM,CAAC,YAAY,EAAE;gBACvB,OAAO;oBACL,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,0BAAkB,CAAC,YAAY;iBACzC,CAAC;aACH;YACD,IAAI,MAAM,CAAC,sBAAsB,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,0BAAkB,CAAC,eAAe,cAAI,MAAM,CAAC,sBAAsB,CAAC,kBAAkB,CAAE;iBAAC,CAAC;aACzG;YACD,IAAI,MAAM,CAAC,UAAU,EAAE;gBACrB,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,0BAAkB,CAAC,UAAU,cAAI,MAAM,CAAC,UAAU,CAAC,cAAc,CAAE;iBAChF,CAAC;aACH;YACD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjE,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,MAAM,CAAC,IAAI,CAAC,UAAU,gBAAM,MAAM,CAAC,IAAI,CAAC,SAAS,gBAAM,0BAAkB,CAAC,WAAW,cAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAE;iBAClI,CAAC;aACH;YACD,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,0BAAkB,CAAC,OAAO;aACpC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAhCD,kDAgCC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,cAAc,CAAC,UAAkB,EAAE,YAAoB,EAAE,MAAc,EAAE,wBAAgC,EAAE,kBAAuC;IAAvC,mCAAA,EAAA,uCAAuC;IAChK,IAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,YAAY,EAAE,UAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAE,CAAC,CAAC;IACvG,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QAClC,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;KACjD;IACD,IAAM,YAAY,GAAG,UAAG,wBAAwB,SAAM,CAAC;IACvD,IAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;IAChF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,GAAG,EAAE,CAAC;AACf,CAAC;AATD,wCASC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAAC,oBAA4B,EAAE,kBAA0B,EAAE,IAAS,EAAE,SAAc,EAAE,UAAe;IACvI,IAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;IACvG,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE;QAC1C,EAAE,CAAC,SAAS,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;KAC3D;IAED,IAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,UAAU,CAAC,CAAC;IAClE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACxD,CAAC;AAZD,oDAYC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAC,UAAkB,EAAE,aAAqB,EAAE,SAAiB,EAAE,oBAA4B;IAC1H,IAAM,eAAe,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACrD,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,EAAC,sBAAsB,EAAE,EAAC,kBAAkB,EAAE,aAAa,EAAC,EAAC,CAAC;KACtE;SACI;QACH,IAAM,SAAS,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACzD,IAAA,KAAK,GAAY,SAAS,MAArB,EAAE,MAAM,GAAI,SAAS,OAAb,CAAc;QAClC,IAAM,IAAI,GAAG,IAAI,WAAG,CAAC,EAAC,KAAK,OAAA,EAAE,MAAM,QAAA,EAAC,CAAC,CAAC;QAEtC,IAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC3D,IAAM,UAAU,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACnD,IAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,MAAM,SAAA,CAAC;QACX,IAAI;YACF,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAC,SAAS,EAAE,GAAG,EAAC,CAAC,CAAC;SAClG;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC,EAAE;gBAC9D,MAAM,GAAG,CAAC;aACX;YACD,oBAAoB,CAAC,oBAAoB,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YACrF,OAAO,EAAC,UAAU,EAAE,EAAC,cAAc,EAAE,WAAW,EAAC,EAAC,CAAC;SACpD;QACD,IAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,GAAG,MAAM,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC;QACnE,IAAI,EAAE,GAAG,SAAS,EAAE;YAClB,oBAAoB,CAAC,oBAAoB,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;SACtF;QACD,OAAO,EAAC,IAAI,EAAE,EAAC,UAAU,EAAE,EAAE,EAAE,SAAS,WAAA,EAAE,cAAc,EAAE,WAAW,EAAC,EAAC,CAAC;KACzE;AACH,CAAC;AA7BD,8CA6BC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAC3B,aAAqB,EACrB,wBAAgC,EAChC,MAAc,EACd,YAAoB,EACpB,oBAAgC,EAChC,SAAa,EACb,YAAoB,EACpB,sBAAgD;IAHhD,qCAAA,EAAA,gCAAgC;IAChC,0BAAA,EAAA,aAAa;IACb,6BAAA,EAAA,oBAAoB;IACpB,uCAAA,EAAA,gDAAgD;IAEhD,IAAI,YAAY,EAAE;QAChB,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAC9E,OAAO,EAAC,YAAY,EAAE,IAAI,EAAC,CAAC;KAC7B;SAAM;QACL,IAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,YAAY,EAAE,MAAM,EAAE,UAAG,wBAAwB,SAAM,CAAC,CAAC;QACpH,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC1G,OAAO,gBAAgB,CAAC;KACzB;AACH,CAAC;AAlBD,sCAkBC","sourcesContent":["import * as fs from 'node:fs';\nimport * as path from 'node:path';\nimport {PNG} from 'pngjs';\nimport * as pixelmatch from 'pixelmatch';\n\nexport {\n  prepareVisualTesting,\n  toggleVisualTestingRender\n} from './utils';\n\n/** Error types returned by visual testing comparison */\nexport interface VisualTestMessage {\n  /** Error message when base image and actual image have different sizes */\n  imagesSize: string;\n  /** Error message when base screensot not found */\n  baseImgNotFound: string;\n  /** Error message when the threshold is passed */\n  diffMessage: string;\n  /** The message in case of success */\n  success: string;\n  /** The message in case of generate mode run */\n  generateMode: string;\n}\n\n/** Error messages in case of visual testing failure */\nexport const visualTestMessages: VisualTestMessage = {\n  imagesSize: 'Image sizes do not match for:',\n  diffMessage: 'Diff between images is greater than threshold for:',\n  baseImgNotFound: 'Base screenshot file not found:',\n  success: 'Visual test successful',\n  generateMode: 'Run in generate screenshot mode'\n};\n\n/**\n * Object returned by a visual test operation\n */\nexport interface VisualTestResult {\n  /** Error object when base image and actual image have different sizes; Contains the screenshot ffile name */\n  imagesSize?: {screenshotName: string};\n  /** Error object when base screensot not found. Contains the not found path as a string */\n  baseScreenshotNotFound?: {baseScreenshotPath: string};\n  /** Object containing the actual diff between images as percentage, the threshold and screenshot file name */\n  diff?: {actualDiff: number; threshold: number; screenshotName: string};\n  /** Run only generation of screenshots */\n  generateMode?: boolean;\n}\n\n/**\n * Visual test matcher\n * Based on the VisualTestResult object return by compareScreenshots function, this matcher will compute the error messages\n */\nexport function toBeVisuallySimilar() {\n  return {\n    compare: (actual: VisualTestResult, _expected: VisualTestResult) => {\n      if (actual.generateMode) {\n        return {\n          pass: true,\n          message: visualTestMessages.generateMode\n        };\n      }\n      if (actual.baseScreenshotNotFound) {\n        return {\n          pass: false,\n          message: `${visualTestMessages.baseImgNotFound} ${actual.baseScreenshotNotFound.baseScreenshotPath}`};\n      }\n      if (actual.imagesSize) {\n        return {\n          pass: false,\n          message: `${visualTestMessages.imagesSize} ${actual.imagesSize.screenshotName}`\n        };\n      }\n      if (actual.diff && actual.diff.actualDiff > actual.diff.threshold) {\n        return {\n          pass: false,\n          message: `${actual.diff.actualDiff} > ${actual.diff.threshold} : ${visualTestMessages.diffMessage} ${actual.diff.screenshotName}`\n        };\n      }\n      return {\n        pass: true,\n        message: visualTestMessages.success\n      };\n    }\n  };\n}\n\n/**\n * It will create a file for the passed screenshot object.\n * The path of the new file will be calculated using the parameters\n * Ex: ./dist-screenshots\\OWBooking\\windows_chrome_91\\fare-page-after-click-on-continue-0.png\n *     distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png\n *\n * @param screenshot The screenshot object captured. Ex: for protractor - browser.takeScreenshot()\n * @param scenarioName E2e Scenario class name\n * @param device Details of the platform on which the test is run. If there are spaces the helper will do the concatenation. Ex: `Windows 10 chrome 89`\n * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end\n * @param distScreenshotsDir Name of the directory to save the screenshots\n */\nexport function saveScreenshot(screenshot: string, scenarioName: string, device: string, filenameWithoutExtension: string, distScreenshotsDir = 'dist-screenshots') {\n  const screenshotsDir = path.resolve(distScreenshotsDir, scenarioName, `${device.replace(/ +/g, '_')}`);\n  if (!fs.existsSync(screenshotsDir)) {\n    fs.mkdirSync(screenshotsDir, {recursive: true});\n  }\n  const fullFileName = `${filenameWithoutExtension}.png`;\n  const stream = fs.createWriteStream(path.resolve(screenshotsDir, fullFileName));\n  stream.write(Buffer.from(screenshot, 'base64'));\n  stream.end();\n}\n\n/**\n * Write the 3 images (base/new/diff) on the reports folder\n * The path inside the reports forlder will be calculated using the parameters\n *\n * @param pathToScenarioReport Path where the scenario report is saved inside reports folder\n * @param screenshotsDirName Name of the directory which will contain the 3 images\n * @param diff diff image\n * @param baseImage the base image\n * @param currentImg the actual taken screenshot image\n */\nexport function writeScreenshotsDiff(pathToScenarioReport: string, screenshotsDirName: string, diff: PNG, baseImage: PNG, currentImg: PNG) {\n  const destScreenshotsDiffDir = path.join(pathToScenarioReport, 'screenshots-diff', screenshotsDirName);\n  if (!fs.existsSync(destScreenshotsDiffDir)) {\n    fs.mkdirSync(destScreenshotsDiffDir, { recursive: true });\n  }\n\n  const diffPath = path.resolve(destScreenshotsDiffDir, 'diff.png');\n  const oldPath = path.resolve(destScreenshotsDiffDir, 'old.png');\n  const newPath = path.resolve(destScreenshotsDiffDir, 'new.png');\n  fs.writeFileSync(diffPath, PNG.sync.write(diff));\n  fs.writeFileSync(oldPath, PNG.sync.write(baseImage));\n  fs.writeFileSync(newPath, PNG.sync.write(currentImg));\n}\n\n/**\n * Compare images helper function. If the comparison fails the 3 images (base/new/diff) will be written inside the reports folder of the actual scenario\n *\n * @param screenshot Actual captured screenshot object\n * @param baseImagePath The path to the base screenshot\n * @param threshold The diff between base screenshot and the current one should not be bigger than this value.\n * @param pathToScenarioReport Path where the scenario report is saved inside reports folder. Used to compute the path to write diff images in case there is a diff at comparison\n * @returns An object of visual test result type\n */\nexport function compareScreenshot(screenshot: string, baseImagePath: string, threshold: number, pathToScenarioReport: string): VisualTestResult {\n  const baseImageExists = fs.existsSync(baseImagePath);\n  if (!baseImageExists) {\n    return {baseScreenshotNotFound: {baseScreenshotPath: baseImagePath}};\n  }\n  else {\n    const baseImage = PNG.sync.read(fs.readFileSync(baseImagePath));\n    const {width, height} = baseImage;\n    const diff = new PNG({width, height});\n\n    const screenshotBuffer = Buffer.from(screenshot, 'base64');\n    const currentImg = PNG.sync.read(screenshotBuffer);\n    const diffDirName = path.basename(baseImagePath, '.png');\n    let result;\n    try {\n      result = pixelmatch(baseImage.data, currentImg.data, diff.data, width, height, {threshold: 0.1});\n    } catch (err: any) {\n      if (err.toString().indexOf('Image sizes do not match.') === -1) {\n        throw err;\n      }\n      writeScreenshotsDiff(pathToScenarioReport, diffDirName, diff, baseImage, currentImg);\n      return {imagesSize: {screenshotName: diffDirName}};\n    }\n    const pr = Math.round(100 * 100 * result / (width * height)) / 100;\n    if (pr > threshold) {\n      writeScreenshotsDiff(pathToScenarioReport, diffDirName, diff, baseImage, currentImg);\n    }\n    return {diff: {actualDiff: pr, threshold, screenshotName: diffDirName}};\n  }\n}\n\n/**\n * Helper function to perform a visual test operation\n *\n * @param screenshotObj Ex: for protractor browser.takeScreenshot()\n * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end\n * @param device os followed by browser version - ex: `Windows 10 chrome 89`\n * @param scenarioName E2e Scenario class name\n * @param pathToScenarioReport Path used in compare mode for saving the base,new,diff images in reports in case there is a diff\n * @param threshold The diff between base screenshot and the current one should not be bigger than this value.\n * If the diff is bigger, 3 png files will be created: base screenshot, new screenshot and diff image\n * @param generateMode If true it will generate the screenshot file without screenshots comparison\n * @param baseScreenshotsDirPath The folder path to search base screenshots; used only in compare mode\n */\nexport function o3rVisualTest(\n  screenshotObj: string,\n  filenameWithoutExtension: string,\n  device: string,\n  scenarioName: string,\n  pathToScenarioReport = 'reports',\n  threshold = 0,\n  generateMode = false,\n  baseScreenshotsDirPath = 'dist-screenshots-base'\n) {\n  if (generateMode) {\n    saveScreenshot(screenshotObj, scenarioName, device, filenameWithoutExtension);\n    return {generateMode: true};\n  } else {\n    const baseImagePath = path.resolve(baseScreenshotsDirPath, scenarioName, device, `${filenameWithoutExtension}.png`);\n    const visualTestResult = compareScreenshot(screenshotObj, baseImagePath, threshold, pathToScenarioReport);\n    return visualTestResult;\n  }\n}\n"]}
+{"version":3,"file":"visual-test.js","sourceRoot":"","sources":["../../src/visual-test/visual-test.ts"],"names":[],"mappings":";;;AAAA,4BAA8B;AAC9B,gCAAkC;AAClC,+BAA0B;AAC1B,uCAAyC;AAEzC,iCAGiB;AAFf,6GAAA,oBAAoB,OAAA;AACpB,kHAAA,yBAAyB,OAAA;AAiB3B,uDAAuD;AAC1C,QAAA,kBAAkB,GAAsB;IACnD,UAAU,EAAE,+BAA+B;IAC3C,WAAW,EAAE,oDAAoD;IACjE,eAAe,EAAE,iCAAiC;IAClD,OAAO,EAAE,wBAAwB;IACjC,YAAY,EAAE,iCAAiC;CAChD,CAAC;AAgBF;;;GAGG;AACH,SAAgB,mBAAmB;IACjC,OAAO;QACL,OAAO,EAAE,UAAC,MAAwB,EAAE,SAA2B;YAC7D,IAAI,MAAM,CAAC,YAAY,EAAE;gBACvB,OAAO;oBACL,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,0BAAkB,CAAC,YAAY;iBACzC,CAAC;aACH;YACD,IAAI,MAAM,CAAC,sBAAsB,EAAE;gBACjC,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,0BAAkB,CAAC,eAAe,cAAI,MAAM,CAAC,sBAAsB,CAAC,kBAAkB,CAAE;iBAAC,CAAC;aACzG;YACD,IAAI,MAAM,CAAC,UAAU,EAAE;gBACrB,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,0BAAkB,CAAC,UAAU,cAAI,MAAM,CAAC,UAAU,CAAC,cAAc,CAAE;iBAChF,CAAC;aACH;YACD,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjE,OAAO;oBACL,IAAI,EAAE,KAAK;oBACX,OAAO,EAAE,UAAG,MAAM,CAAC,IAAI,CAAC,UAAU,gBAAM,MAAM,CAAC,IAAI,CAAC,SAAS,gBAAM,0BAAkB,CAAC,WAAW,cAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAE;iBAClI,CAAC;aACH;YACD,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,0BAAkB,CAAC,OAAO;aACpC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAhCD,kDAgCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,cAAc,CAAC,UAAkB,EAAE,YAAoB,EAAE,MAAc,EAAE,wBAAgC,EAAE,kBAAuC;IAAvC,mCAAA,EAAA,uCAAuC;IAChK,IAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,YAAY,EAAE,UAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAE,CAAC,CAAC;IACvG,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;QAClC,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;KACjD;IACD,IAAM,YAAY,GAAG,UAAG,wBAAwB,SAAM,CAAC;IACvD,IAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;IAChF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChD,MAAM,CAAC,GAAG,EAAE,CAAC;AACf,CAAC;AATD,wCASC;AAED;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,oBAA4B,EAAE,kBAA0B,EAAE,IAAS,EAAE,SAAc,EAAE,UAAe;IACvI,IAAM,sBAAsB,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;IACvG,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE;QAC1C,EAAE,CAAC,SAAS,CAAC,sBAAsB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;KAC3D;IAED,IAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,UAAU,CAAC,CAAC;IAClE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,WAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACxD,CAAC;AAZD,oDAYC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,UAAkB,EAAE,aAAqB,EAAE,SAAiB,EAAE,oBAA4B;IAC1H,IAAM,eAAe,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACrD,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,EAAC,sBAAsB,EAAE,EAAC,kBAAkB,EAAE,aAAa,EAAC,EAAC,CAAC;KACtE;SACI;QACH,IAAM,SAAS,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACzD,IAAA,KAAK,GAAY,SAAS,MAArB,EAAE,MAAM,GAAI,SAAS,OAAb,CAAc;QAClC,IAAM,IAAI,GAAG,IAAI,WAAG,CAAC,EAAC,KAAK,OAAA,EAAE,MAAM,QAAA,EAAC,CAAC,CAAC;QAEtC,IAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC3D,IAAM,UAAU,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACnD,IAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,MAAM,SAAA,CAAC;QACX,IAAI;YACF,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAC,SAAS,EAAE,GAAG,EAAC,CAAC,CAAC;SAClG;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC,EAAE;gBAC9D,MAAM,GAAG,CAAC;aACX;YACD,oBAAoB,CAAC,oBAAoB,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YACrF,OAAO,EAAC,UAAU,EAAE,EAAC,cAAc,EAAE,WAAW,EAAC,EAAC,CAAC;SACpD;QACD,IAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,GAAG,MAAM,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC;QACnE,IAAI,EAAE,GAAG,SAAS,EAAE;YAClB,oBAAoB,CAAC,oBAAoB,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;SACtF;QACD,OAAO,EAAC,IAAI,EAAE,EAAC,UAAU,EAAE,EAAE,EAAE,SAAS,WAAA,EAAE,cAAc,EAAE,WAAW,EAAC,EAAC,CAAC;KACzE;AACH,CAAC;AA7BD,8CA6BC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,aAAa,CAC3B,aAAqB,EACrB,wBAAgC,EAChC,MAAc,EACd,YAAoB,EACpB,oBAAgC,EAChC,SAAa,EACb,YAAoB,EACpB,sBAAgD;IAHhD,qCAAA,EAAA,gCAAgC;IAChC,0BAAA,EAAA,aAAa;IACb,6BAAA,EAAA,oBAAoB;IACpB,uCAAA,EAAA,gDAAgD;IAEhD,IAAI,YAAY,EAAE;QAChB,cAAc,CAAC,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAC9E,OAAO,EAAC,YAAY,EAAE,IAAI,EAAC,CAAC;KAC7B;SAAM;QACL,IAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,YAAY,EAAE,MAAM,EAAE,UAAG,wBAAwB,SAAM,CAAC,CAAC;QACpH,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC1G,OAAO,gBAAgB,CAAC;KACzB;AACH,CAAC;AAlBD,sCAkBC","sourcesContent":["import * as fs from 'node:fs';\nimport * as path from 'node:path';\nimport {PNG} from 'pngjs';\nimport * as pixelmatch from 'pixelmatch';\n\nexport {\n  prepareVisualTesting,\n  toggleVisualTestingRender\n} from './utils';\n\n/** Error types returned by visual testing comparison */\nexport interface VisualTestMessage {\n  /** Error message when base image and actual image have different sizes */\n  imagesSize: string;\n  /** Error message when base screensot not found */\n  baseImgNotFound: string;\n  /** Error message when the threshold is passed */\n  diffMessage: string;\n  /** The message in case of success */\n  success: string;\n  /** The message in case of generate mode run */\n  generateMode: string;\n}\n\n/** Error messages in case of visual testing failure */\nexport const visualTestMessages: VisualTestMessage = {\n  imagesSize: 'Image sizes do not match for:',\n  diffMessage: 'Diff between images is greater than threshold for:',\n  baseImgNotFound: 'Base screenshot file not found:',\n  success: 'Visual test successful',\n  generateMode: 'Run in generate screenshot mode'\n};\n\n/**\n * Object returned by a visual test operation\n */\nexport interface VisualTestResult {\n  /** Error object when base image and actual image have different sizes; Contains the screenshot ffile name */\n  imagesSize?: {screenshotName: string};\n  /** Error object when base screensot not found. Contains the not found path as a string */\n  baseScreenshotNotFound?: {baseScreenshotPath: string};\n  /** Object containing the actual diff between images as percentage, the threshold and screenshot file name */\n  diff?: {actualDiff: number; threshold: number; screenshotName: string};\n  /** Run only generation of screenshots */\n  generateMode?: boolean;\n}\n\n/**\n * Visual test matcher\n * Based on the VisualTestResult object return by compareScreenshots function, this matcher will compute the error messages\n */\nexport function toBeVisuallySimilar() {\n  return {\n    compare: (actual: VisualTestResult, _expected: VisualTestResult) => {\n      if (actual.generateMode) {\n        return {\n          pass: true,\n          message: visualTestMessages.generateMode\n        };\n      }\n      if (actual.baseScreenshotNotFound) {\n        return {\n          pass: false,\n          message: `${visualTestMessages.baseImgNotFound} ${actual.baseScreenshotNotFound.baseScreenshotPath}`};\n      }\n      if (actual.imagesSize) {\n        return {\n          pass: false,\n          message: `${visualTestMessages.imagesSize} ${actual.imagesSize.screenshotName}`\n        };\n      }\n      if (actual.diff && actual.diff.actualDiff > actual.diff.threshold) {\n        return {\n          pass: false,\n          message: `${actual.diff.actualDiff} > ${actual.diff.threshold} : ${visualTestMessages.diffMessage} ${actual.diff.screenshotName}`\n        };\n      }\n      return {\n        pass: true,\n        message: visualTestMessages.success\n      };\n    }\n  };\n}\n\n/**\n * It will create a file for the passed screenshot object.\n * The path of the new file will be calculated using the parameters\n * Ex: ./dist-screenshots\\OWBooking\\windows_chrome_91\\fare-page-after-click-on-continue-0.png\n * distScreenshotsDir/scenarionName/device/filenameWithoutExtension.png\n * @param screenshot The screenshot object captured. Ex: for protractor - browser.takeScreenshot()\n * @param scenarioName E2e Scenario class name\n * @param device Details of the platform on which the test is run. If there are spaces the helper will do the concatenation. Ex: `Windows 10 chrome 89`\n * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end\n * @param distScreenshotsDir Name of the directory to save the screenshots\n */\nexport function saveScreenshot(screenshot: string, scenarioName: string, device: string, filenameWithoutExtension: string, distScreenshotsDir = 'dist-screenshots') {\n  const screenshotsDir = path.resolve(distScreenshotsDir, scenarioName, `${device.replace(/ +/g, '_')}`);\n  if (!fs.existsSync(screenshotsDir)) {\n    fs.mkdirSync(screenshotsDir, {recursive: true});\n  }\n  const fullFileName = `${filenameWithoutExtension}.png`;\n  const stream = fs.createWriteStream(path.resolve(screenshotsDir, fullFileName));\n  stream.write(Buffer.from(screenshot, 'base64'));\n  stream.end();\n}\n\n/**\n * Write the 3 images (base/new/diff) on the reports folder\n * The path inside the reports forlder will be calculated using the parameters\n * @param pathToScenarioReport Path where the scenario report is saved inside reports folder\n * @param screenshotsDirName Name of the directory which will contain the 3 images\n * @param diff diff image\n * @param baseImage the base image\n * @param currentImg the actual taken screenshot image\n */\nexport function writeScreenshotsDiff(pathToScenarioReport: string, screenshotsDirName: string, diff: PNG, baseImage: PNG, currentImg: PNG) {\n  const destScreenshotsDiffDir = path.join(pathToScenarioReport, 'screenshots-diff', screenshotsDirName);\n  if (!fs.existsSync(destScreenshotsDiffDir)) {\n    fs.mkdirSync(destScreenshotsDiffDir, { recursive: true });\n  }\n\n  const diffPath = path.resolve(destScreenshotsDiffDir, 'diff.png');\n  const oldPath = path.resolve(destScreenshotsDiffDir, 'old.png');\n  const newPath = path.resolve(destScreenshotsDiffDir, 'new.png');\n  fs.writeFileSync(diffPath, PNG.sync.write(diff));\n  fs.writeFileSync(oldPath, PNG.sync.write(baseImage));\n  fs.writeFileSync(newPath, PNG.sync.write(currentImg));\n}\n\n/**\n * Compare images helper function. If the comparison fails the 3 images (base/new/diff) will be written inside the reports folder of the actual scenario\n * @param screenshot Actual captured screenshot object\n * @param baseImagePath The path to the base screenshot\n * @param threshold The diff between base screenshot and the current one should not be bigger than this value.\n * @param pathToScenarioReport Path where the scenario report is saved inside reports folder. Used to compute the path to write diff images in case there is a diff at comparison\n * @returns An object of visual test result type\n */\nexport function compareScreenshot(screenshot: string, baseImagePath: string, threshold: number, pathToScenarioReport: string): VisualTestResult {\n  const baseImageExists = fs.existsSync(baseImagePath);\n  if (!baseImageExists) {\n    return {baseScreenshotNotFound: {baseScreenshotPath: baseImagePath}};\n  }\n  else {\n    const baseImage = PNG.sync.read(fs.readFileSync(baseImagePath));\n    const {width, height} = baseImage;\n    const diff = new PNG({width, height});\n\n    const screenshotBuffer = Buffer.from(screenshot, 'base64');\n    const currentImg = PNG.sync.read(screenshotBuffer);\n    const diffDirName = path.basename(baseImagePath, '.png');\n    let result;\n    try {\n      result = pixelmatch(baseImage.data, currentImg.data, diff.data, width, height, {threshold: 0.1});\n    } catch (err: any) {\n      if (err.toString().indexOf('Image sizes do not match.') === -1) {\n        throw err;\n      }\n      writeScreenshotsDiff(pathToScenarioReport, diffDirName, diff, baseImage, currentImg);\n      return {imagesSize: {screenshotName: diffDirName}};\n    }\n    const pr = Math.round(100 * 100 * result / (width * height)) / 100;\n    if (pr > threshold) {\n      writeScreenshotsDiff(pathToScenarioReport, diffDirName, diff, baseImage, currentImg);\n    }\n    return {diff: {actualDiff: pr, threshold, screenshotName: diffDirName}};\n  }\n}\n\n/**\n * Helper function to perform a visual test operation\n * @param screenshotObj Ex: for protractor browser.takeScreenshot()\n * @param filenameWithoutExtension file name to save the screenshot - .png will be added at the end\n * @param device os followed by browser version - ex: `Windows 10 chrome 89`\n * @param scenarioName E2e Scenario class name\n * @param pathToScenarioReport Path used in compare mode for saving the base,new,diff images in reports in case there is a diff\n * @param threshold The diff between base screenshot and the current one should not be bigger than this value.\n * If the diff is bigger, 3 png files will be created: base screenshot, new screenshot and diff image\n * @param generateMode If true it will generate the screenshot file without screenshots comparison\n * @param baseScreenshotsDirPath The folder path to search base screenshots; used only in compare mode\n */\nexport function o3rVisualTest(\n  screenshotObj: string,\n  filenameWithoutExtension: string,\n  device: string,\n  scenarioName: string,\n  pathToScenarioReport = 'reports',\n  threshold = 0,\n  generateMode = false,\n  baseScreenshotsDirPath = 'dist-screenshots-base'\n) {\n  if (generateMode) {\n    saveScreenshot(screenshotObj, scenarioName, device, filenameWithoutExtension);\n    return {generateMode: true};\n  } else {\n    const baseImagePath = path.resolve(baseScreenshotsDirPath, scenarioName, device, `${filenameWithoutExtension}.png`);\n    const visualTestResult = compareScreenshot(screenshotObj, baseImagePath, threshold, pathToScenarioReport);\n    return visualTestResult;\n  }\n}\n"]}