@applitools/eyes-images - npm Package Compare versions

Comparing version 4.8.1 to 4.8.2

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [4.8.2](https://github.com/applitools/eyes.sdk.javascript1/compare/@applitools/eyes-images@4.8.1...@applitools/eyes-images@4.8.2) (2019-03-13)
+
+**Note:** Version bump only for package @applitools/eyes-images
+
+
+
+
+
 ## [4.8.1](https://github.com/applitools/eyes.sdk.javascript1/compare/@applitools/eyes-images@4.8.0...@applitools/eyes-images@4.8.1) (2019-02-27)
@@ -8,0 +16,0 @@

lib/Eyes.js

@@ -17,3 +17,3 @@ 'use strict';
    * @param {string} [serverUrl=EyesBase.getDefaultServerUrl()] The Eyes server URL.
-   * @param {?boolean} [isDisabled=false] Will be checked <b>before</b> any argument validation. If true, all method
+   * @param {?boolean} [isDisabled=false] - Will be checked <b>before</b> any argument validation. If true, all method
    *   will immediately return without performing any action.
@@ -44,5 +44,5 @@ */
    *
-   * @param {string} appName The application being tested.
-   * @param {string} testName The test's name.
-   * @param {RectangleSize} [imageSize] Determines the resolution used for the baseline. {@code null} will
+   * @param {string} appName - The application being tested.
+   * @param {string} testName - The test's name.
+   * @param {RectangleSize} [imageSize] - Determines the resolution used for the baseline. {@code null} will
    *   automatically grab the resolution from the image.
@@ -58,7 +58,7 @@ * @return {Promise<void>}
    *
-   * @param {string|Buffer|ImageProvider|MutableImage} image The image path, base64 string, image buffer or MutableImage.
-   * @param {string} [name] Tag to be associated with the validation checkpoint.
-   * @param {boolean} [ignoreMismatch] True if the server should ignore a negative result for the visual validation.
-   * @param {number} [retryTimeout] timeout for performing the match (ms).
-   * @return {Promise<boolean>} True if the image matched the expected output, false otherwise.
+   * @param {string|Buffer|ImageProvider|MutableImage} image - The image path, base64 string, image buffer or MutableImage.
+   * @param {string} [name] - Tag to be associated with the validation checkpoint.
+   * @param {boolean} [ignoreMismatch] - True if the server should ignore a negative result for the visual validation.
+   * @param {number} [retryTimeout] - timeout for performing the match (ms).
+   * @return {Promise<boolean>} - True if the image matched the expected output, false otherwise.
    * @throws {DiffsFoundError} Thrown if a mismatch is detected and immediate failure reports are enabled.
@@ -73,9 +73,9 @@ */
    *
-   * @param {string|Buffer|ImageProvider|MutableImage} image The image path, base64 string, image buffer or MutableImage.
-   * @param {Region|RegionObject} region The region of the image which should be verified, or {undefined}/{null} if the
+   * @param {string|Buffer|ImageProvider|MutableImage} image - The image path, base64 string, image buffer or MutableImage.
+   * @param {Region|RegionObject} region - The region of the image which should be verified, or {undefined}/{null} if the
    *   entire image should be verified.
-   * @param {string} [name] An optional tag to be associated with the validation checkpoint.
-   * @param {boolean} [ignoreMismatch] True if the server should ignore a negative result for the visual validation.
-   * @param {number} [retryTimeout] timeout for performing the match (ms).
-   * @return {Promise<boolean>} True if the image matched the expected output, false otherwise.
+   * @param {string} [name] - An optional tag to be associated with the validation checkpoint.
+   * @param {boolean} [ignoreMismatch] - True if the server should ignore a negative result for the visual validation.
+   * @param {number} [retryTimeout] - timeout for performing the match (ms).
+   * @return {Promise<boolean>} - True if the image matched the expected output, false otherwise.
    * @throws {DiffsFoundError} Thrown if a mismatch is detected and immediate failure reports are enabled.
@@ -88,5 +88,5 @@ */
   /**
-   * @param {string} name An optional tag to be associated with the validation checkpoint.
-   * @param {ImagesCheckSettings|CheckSettings} checkSettings The settings to use when checking the image.
-   * @return {Promise<boolean>} A promise which is resolved when the validation is finished. Indicates whether
+   * @param {string} name - An optional tag to be associated with the validation checkpoint.
+   * @param {ImagesCheckSettings|CheckSettings} checkSettings - The settings to use when checking the image.
+   * @return {Promise<boolean>} - A promise which is resolved when the validation is finished. Indicates whether
    *  matchResults was as expected or not.
@@ -152,3 +152,3 @@ */
    * @private
-   * @param {ImagesCheckSettings} checkSettings The settings to use when checking the image.
+   * @param {ImagesCheckSettings} checkSettings - The settings to use when checking the image.
    * @return {Promise<MutableImage>}
@@ -185,8 +185,8 @@ */
    *
-   * @param {number} stepIndex The zero based index of the step in which to replace the image.
-   * @param {string|Buffer|MutableImage} image The image base64 string, image buffer or MutableImage.
-   * @param {string} [tag] A tag to be associated with the validation checkpoint.
-   * @param {string} [title] A title to be associated with the validation checkpoint.
-   * @param {Trigger[]} [userInputs] An array of user inputs to which lead to the validation checkpoint.
-   * @return {Promise<boolean>} True if the image matched the expected output, false otherwise.
+   * @param {number} stepIndex - The zero based index of the step in which to replace the image.
+   * @param {string|Buffer|MutableImage} image - The image base64 string, image buffer or MutableImage.
+   * @param {string} [tag] - A tag to be associated with the validation checkpoint.
+   * @param {string} [title] - A title to be associated with the validation checkpoint.
+   * @param {Trigger[]} [userInputs] - An array of user inputs to which lead to the validation checkpoint.
+   * @return {Promise<boolean>} - True if the image matched the expected output, false otherwise.
    * @throws {DiffsFoundError} Thrown if a mismatch is detected and immediate failure reports are enabled.
@@ -200,3 +200,3 @@ */
       this._logger.verbose(`replaceImage('${stepIndex}', Image, '${tag}', '${title}', '${userInputs}'): Ignored`);
-      return Promise.resolve(false);
+      return false;
     }
@@ -218,3 +218,3 @@
    * @param {MouseTrigger.MouseAction} action  Mouse action.
-   * @param {Region} control The control on which the trigger is activated (context relative coordinates).
+   * @param {Region} control - The control on which the trigger is activated (context relative coordinates).
    * @param {Location} cursor  The cursor's position relative to the control.
@@ -230,4 +230,4 @@ */
    *
-   * @param {Region} control The control's context-relative region.
-   * @param {string} text The trigger's text.
+   * @param {Region} control - The control's context-relative region.
+   * @param {string} text - The trigger's text.
    */
@@ -241,4 +241,4 @@ addTextTrigger(control, text) {
    */
-  getViewportSize() {
-    return Promise.resolve(this._viewportSizeHandler.get());
+  async getViewportSize() {
+    return this._viewportSizeHandler.get();
   }
@@ -250,10 +250,9 @@
    *
-   * @param {RectangleSize|RectangleSizeObject} viewportSize The required viewport size.
+   * @param {RectangleSize|RectangleSizeObject} viewportSize - The required viewport size.
    * @return {Promise<void>}
    */
-  setViewportSize(viewportSize) {
+  async setViewportSize(viewportSize) {
     ArgumentGuard.notNull(viewportSize, 'size');
 
     this._viewportSizeHandler.set(new RectangleSize(viewportSize));
-    return Promise.resolve();
   }
@@ -264,4 +263,4 @@
    */
-  getInferredEnvironment() {
-    return Promise.resolve(this._inferred);
+  async getInferredEnvironment() {
+    return this._inferred;
   }
@@ -273,3 +272,3 @@
    *
-   * @param {string} inferred The inferred environment string.
+   * @param {string} inferred - The inferred environment string.
    */
@@ -297,4 +296,4 @@ setInferredEnvironment(inferred) {
    */
-  getScreenshotUrl() {
-    return Promise.resolve(this._screenshotUrl);
+  async getScreenshotUrl() {
+    return this._screenshotUrl;
   }
@@ -306,3 +305,3 @@
   async tryCaptureDom() {
-    return Promise.resolve(this._domString);
+    return this._domString;
   }
@@ -314,3 +313,3 @@
   async getImageLocation() {
-    return Promise.resolve(this._imageLocation);
+    return this._imageLocation;
   }
@@ -321,4 +320,4 @@
    */
-  getTitle() {
-    return Promise.resolve(this._title);
+  async getTitle() {
+    return this._title;
   }
@@ -325,0 +324,0 @@ }

lib/fluent/ImagesCheckSettings.js

@@ -124,3 +124,3 @@ 'use strict';
    * @param {RectangleSize} imageSize
-   * @return {this} This instance of the settings object.
+   * @return {this} - This instance of the settings object.
    */
@@ -142,3 +142,3 @@ imageSize(imageSize) {
    * @param {string} domString
-   * @return {this} This instance of the settings object.
+   * @return {this} - This instance of the settings object.
    */
@@ -160,4 +160,4 @@ withDom(domString) {
   /**
-   * @param {Location|{x: number, y: number}} location
-   * @return {this} This instance of the settings object.
+   * @param {Location|LocationObject} location
+   * @return {this} - This instance of the settings object.
    */
@@ -179,3 +179,3 @@ withLocation(location) {
   /**
-   * @param {boolean} [ignoreMismatch=true] True if the server should ignore a negative result for the visual validation.
+   * @param {boolean} [ignoreMismatch=true] - True if the server should ignore a negative result for the visual validation.
    *  Default value is `false`, but if you call to .ignoreMismatch() without arguments it will set value to `true`.
@@ -198,3 +198,3 @@ * @return {this}
   /**
-   * @param {Region|RegionObject} region The region to validate.
+   * @param {Region|RegionObject} region - The region to validate.
    * @return {this}
@@ -201,0 +201,0 @@ */

package.json

 {
   "name": "@applitools/eyes-images",
-  "version": "4.8.1",
+  "version": "4.8.2",
   "description": "The simplest implementation of Applitools Eyes SDK, uploads images for validation",
@@ -34,4 +34,4 @@ "keywords": [
   "dependencies": {
-    "@applitools/eyes-common": "^1.3.1",
-    "@applitools/eyes-sdk-core": "^4.9.0"
+    "@applitools/eyes-common": "^2.0.0",
+    "@applitools/eyes-sdk-core": "^5.0.0"
   },
@@ -50,3 +50,3 @@ "devDependencies": {
   },
-  "gitHead": "904e77937820d97ca5e61bd5f0a9e11f867e61e5"
+  "gitHead": "554d1e6b4d8c7124320a0869a8c1f27de3b4636c"
 }

No alert changes

Improved metrics

Total package byte prevSize

41280

increased by0.39%

Worsened metrics

Lines of code

566

decreased by-0.18%

Dependency changes

• + Added@applitools/eyes-common@2.2.13.24.0(transitive)

• + Added@applitools/eyes-sdk-core@5.25.0(transitive)

• + Added@applitools/isomorphic-fetch@3.0.0(transitive)

• + Added@applitools/sdk-fake-eyes-server@1.1.3(transitive)

• + Added@babel/code-frame@7.26.2(transitive)

• + Added@babel/helper-validator-identifier@7.25.9(transitive)

• + Added@types/parse-json@4.0.2(transitive)

• + Addedaccepts@1.3.8(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedarray-flatten@1.1.1(transitive)

• + Addedaxios@0.19.2(transitive)

• + Addedbody-parser@1.20.3(transitive)

• + Addedbytes@3.1.2(transitive)

• + Addedcall-bind-apply-helpers@1.0.2(transitive)

• + Addedcall-bound@1.0.4(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addedchalk@3.0.0(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedcontent-disposition@0.5.4(transitive)

• + Addedcontent-type@1.0.5(transitive)

• + Addedcookie@0.7.1(transitive)

• + Addedcookie-signature@1.0.6(transitive)

• + Addedcosmiconfig@6.0.0(transitive)

• + Addeddebug@2.6.94.4.0(transitive)

• + Addeddeepmerge@4.3.1(transitive)

• + Addeddepd@2.0.0(transitive)

• + Addeddestroy@1.2.0(transitive)

• + Addeddunder-proto@1.0.1(transitive)

• + Addedee-first@1.1.1(transitive)

• + Addedencodeurl@1.0.22.0.0(transitive)

• + Addedes-define-property@1.0.1(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-object-atoms@1.1.1(transitive)

• + Addedescape-html@1.0.3(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedetag@1.8.1(transitive)

• + Addedexpress@4.21.2(transitive)

• + Addedfilename-reserved-regex@2.0.0(transitive)

• + Addedfilenamify@4.3.0(transitive)

• + Addedfinalhandler@1.3.1(transitive)

• + Addedforwarded@0.2.0(transitive)

• + Addedfresh@0.5.2(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-intrinsic@1.3.0(transitive)

• + Addedget-proto@1.0.1(transitive)

• + Addedgopd@1.2.0(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedhas-symbols@1.1.0(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhttp-errors@2.0.0(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedimport-fresh@3.3.1(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedipaddr.js@1.9.1(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjson-parse-even-better-errors@2.3.1(transitive)

• + Addedlines-and-columns@1.2.4(transitive)

• + Addedmath-intrinsics@1.1.0(transitive)

• + Addedmedia-typer@0.3.0(transitive)

• + Addedmerge-descriptors@1.0.3(transitive)

• + Addedmethods@1.1.2(transitive)

• + Addedmime@1.6.0(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedms@2.0.02.1.3(transitive)

• + Addednegotiator@0.6.3(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedobject-inspect@1.13.4(transitive)

• + Addedon-finished@2.4.1(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedparse-json@5.2.0(transitive)

• + Addedparseurl@1.3.3(transitive)

• + Addedpath-to-regexp@0.1.12(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicocolors@1.1.1(transitive)

• + Addedproxy-addr@2.0.7(transitive)

• + Addedqs@6.13.0(transitive)

• + Addedrange-parser@1.2.1(transitive)

• + Addedraw-body@2.5.2(transitive)

• + Addedresolve-from@4.0.0(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsend@0.19.0(transitive)

• + Addedserve-static@1.16.2(transitive)

• + Addedsetprototypeof@1.2.0(transitive)

• + Addedside-channel@1.1.0(transitive)

• + Addedside-channel-list@1.0.0(transitive)

• + Addedside-channel-map@1.0.1(transitive)

• + Addedside-channel-weakmap@1.0.2(transitive)

• + Addedstatuses@2.0.1(transitive)

• + Addedstrip-outer@1.0.1(transitive)

• + Addedsupports-color@7.2.0(transitive)

• + Addedtoidentifier@1.0.1(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedtrim-repeated@1.0.0(transitive)

• + Addedtunnel@0.0.6(transitive)

• + Addedtype-is@1.6.18(transitive)

• + Addedua-parser-js@0.7.40(transitive)

• + Addedunpipe@1.0.0(transitive)

• + Addedutils-merge@1.0.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedvary@1.1.2(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-fetch@3.6.20(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• + Addedyaml@1.10.2(transitive)

• - Removed@applitools/eyes-common@1.3.1(transitive)

• - Removed@applitools/eyes-sdk-core@4.9.1(transitive)

• - Removedaxios@0.18.1(transitive)

• - Removedis-buffer@2.0.5(transitive)

• Updated@applitools/eyes-common@^2.0.0

• Updated@applitools/eyes-sdk-core@^5.0.0