@applitools/eyes-puppeteer 1.13.0 → 1.14.1

package/CHANGELOG.md

@@ -11,6 +11,20 @@
 
 
 
+## 1.14.1 - 2023/3/22
+
+### Features
+### Bug fixes
+- Fixed slowness during ufg tests
+- Optimized number of requests during polling
+
+## 1.14.0 - 2023/2/21
+
+### Features
+- Additional internal event logs
+- Crop screenshot image base on account info
+### Bug fixes
+
 ## 1.13.0 - 2022/12/20
 
 ### Features

package/README.md

@@ -29,6 +29,7 @@
       - [Scroll root element](#scroll-root-element)
       - [Tag (`withName`)](#tag-withname)
       - [Lazy loading (`lazyLoad`)](#lazy-loading-lazyload)
+      - [Density metrics](#density-metrics-densitymetrics)
         - [Other checkSettings configuration](#other-checksettings-configuration)
   - [close](#close)
 - [Runners](#runners)
@@ -386,6 +387,23 @@ Other details:
 - The SDK will repeatedly scroll the page using the `scrollLength` until either the page cannot be scrolled further or the `maxAmountToScroll` has been reached (whichever happens first)
 - If more time is needed for additional content to load, then increase the waitingTime to a value higher than 500 milliseconds. If better performance is desired and additional content lazily loads faster than the default waitingTime, then reduce it to a value below 500 milliseconds
 
+##### Density metrics (`densityMetrics`)
+
+In order to set the density metrics for the screenshot, use the `densityMetrics` method. This method accepts a object value with the following properties:
+
+- `xdpi` - The exact physical pixels per inch of the screen in the X dimension.
+- `ydpi` - The exact physical pixels per inch of the screen in the Y dimension.
+- `scaleRatio` - The scale ratio.
+
+```js
+// set density metrics
+eyes.check(Target.window().densityMetrics({
+  xdpi: 100,
+  ydpi: 100,
+  scaleRatio: 1
+}))
+```
+
 ###### Other checkSettings configuration
 
 <!-- TODO add explanation -->

package/dist/api.js

@@ -26,33 +26,30 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.closeBatch = exports.BatchClose = exports.Target = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Configuration = exports.Eyes = void 0;
-const core_1 = require("@applitools/core");
-const api = __importStar(require("@applitools/eyes-api"));
+exports.closeBatch = exports.BatchClose = exports.Configuration = exports.Target = exports.TargetAutomation = exports.CheckSettings = exports.CheckSettingsAutomation = exports.Eyes = void 0;
+const eyes = __importStar(require("@applitools/eyes"));
 const spec = __importStar(require("@applitools/spec-driver-puppeteer"));
-const sdk = (0, core_1.makeCore)({
-    agentId: `eyes.puppeteer/${require('../package.json').version}`,
-    spec,
-});
-__exportStar(require("@applitools/eyes-api"), exports);
-class Eyes extends api.Eyes {
+__exportStar(require("@applitools/eyes"), exports);
+const sdk = { agentId: `eyes.puppeteer/${require('../package.json').version}`, spec };
+class Eyes extends eyes.Eyes {
 }
 exports.Eyes = Eyes;
-Eyes._spec = sdk;
-class Configuration extends api.Configuration {
-}
-exports.Configuration = Configuration;
-Configuration._spec = sdk;
-class CheckSettingsAutomation extends api.CheckSettingsAutomation {
+Eyes._sdk = sdk;
+class CheckSettingsAutomation extends eyes.CheckSettingsAutomation {
 }
 exports.CheckSettingsAutomation = CheckSettingsAutomation;
-CheckSettingsAutomation._spec = sdk;
+CheckSettingsAutomation._spec = spec;
 class CheckSettings extends CheckSettingsAutomation {
 }
 exports.CheckSettings = CheckSettings;
-exports.Target = { ...api.Target, spec: sdk };
-class BatchClose extends api.BatchClose {
+exports.TargetAutomation = { ...eyes.TargetAutomation, spec };
+exports.Target = { ...eyes.Target, spec };
+class Configuration extends eyes.Configuration {
+}
+exports.Configuration = Configuration;
+Configuration._spec = spec;
+class BatchClose extends eyes.BatchClose {
 }
 exports.BatchClose = BatchClose;
-BatchClose._spec = sdk;
-exports.closeBatch = api.closeBatch(sdk);
+BatchClose._sdk = sdk;
+exports.closeBatch = eyes.closeBatch(sdk);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-puppeteer",
-  "version": "1.13.0",
+  "version": "1.14.1",
   "description": "Applitools Eyes SDK for Puppeteer",
   "keywords": [
     "eyes-puppeteer",
@@ -38,58 +38,33 @@
     "types"
   ],
   "scripts": {
-    "lint": "eslint '**/*.ts'",
-    "build": "ttsc",
+    "lint": "node ../../node_modules/.bin/eslint '**/*.ts'",
+    "build": "node ../../node_modules/.bin/ttsc --project ./tsconfig.build.json",
     "generate:tests": "coverage-tests generate https://raw.githubusercontent.com/applitools/sdk.coverage.tests/universal-sdk/js/config.js --name 'eyes-puppeteer'",
     "test": "yarn test:coverage",
+    "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) MOCHA_GROUP=coverage node ../../node_modules/.bin/mocha './test/generic/*.spec.js' --parallel --jobs ${MOCHA_JOBS:-15} --exit",
     "test:sanity": "echo 'create sanity suite'",
-    "test:coverage": "yarn generate:tests && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' APPLITOOLS_BATCH_ID=$(uuidgen) XUNIT_FILE=coverage-test-report.xml mocha --exit --config .mocharc.cvg.js",
-    "report": "coverage-tests report https://raw.githubusercontent.com/applitools/sdk.coverage.tests/master/js/config.js --name 'eyes-puppeteer'",
-    "docker:build": "docker build -t applitools/puppeteer-chrome .",
-    "docker:rebuild": "docker build --no-cache -t applitools/puppeteer-chrome .",
-    "docker:run": "yarn docker:build && docker run -e NODE_AUTH_TOKEN --env APPLITOOLS_API_KEY=$APPLITOOLS_API_KEY_SDK --env APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-puppeteer' --env APPLITOOLS_BATCH_ID=$(uuidgen) --env XUNIT_FILE=coverage-test-report.xml -it --init --rm -v $(pwd):/sandbox applitools/puppeteer-chrome",
+    "report": "bongo report --name 'puppeteer'",
     "upgrade:framework": "if [ ! -z $APPLITOOLS_PUPPETEER_VERSION ]; then packagejson=`cat package.json`; yarn upgrade --no-lockfile puppeteer@$APPLITOOLS_PUPPETEER_VERSION; echo \"$packagejson\" > package.json; fi",
     "deps": "bongo deps",
-    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='puppeteer' -f links='types test-utils sdk-shared eyes-sdk-core visual-grid-client eyes-api spec-driver-puppeteer utils driver snippets screenshoter'",
+    "gh:test": "gh workflow run test.yml --ref $(git rev-parse --abbrev-ref HEAD) -f packages='puppeteer' -f links='types test-utils eyes-sdk-core visual-grid-client eyes spec-driver-puppeteer utils driver snippets screenshoter'",
     "gh:publish": "gh workflow run publish-puppeteer.yml --ref $(git rev-parse --abbrev-ref HEAD)",
-    "preversion": "bongo preversion --verifyPendingChanges && yarn build",
+    "preversion": "bongo preversion --verifyPendingChanges",
     "version": "bongo version --withPendingChanges",
-    "postversion": "bongo postversion"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
+    "postversion": "bongo postversion",
+    "postpublish": "bongo send-release-notification --name 'puppeteer'"
   },
   "dependencies": {
-    "@applitools/core": "1.3.3",
-    "@applitools/eyes-api": "1.11.2",
-    "@applitools/spec-driver-puppeteer": "1.1.28"
+    "@applitools/eyes": "1.0.2",
+    "@applitools/spec-driver-puppeteer": "1.1.49"
   },
   "devDependencies": {
-    "@applitools/api-extractor": "1.2.11",
-    "@applitools/bongo": "^2.2.0",
-    "@applitools/scripts": "1.2.0",
-    "@applitools/sdk-coverage-tests": "2.7.10",
-    "@applitools/sdk-shared": "0.9.15",
-    "@applitools/test-utils": "1.5.4",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "12",
-    "@typescript-eslint/eslint-plugin": "^5.27.0",
-    "@typescript-eslint/parser": "^5.27.0",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-mocha-no-only": "^1.1.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^4.3.8",
-    "mocha": "^9.2.2",
-    "prettier": "^2.6.2",
-    "puppeteer": "^18.0.5",
-    "spec-xunit-file": "0.0.1-3",
-    "ts-node": "^10.8.0",
-    "ttypescript": "^1.5.13",
-    "typescript": "^4.7.2"
+    "@applitools/api-extractor": "1.2.12",
+    "@applitools/bongo": "^3.0.2",
+    "@applitools/sdk-coverage-tests": "3.0.0",
+    "@applitools/test-utils": "1.5.14",
+    "@types/node": "^12.20.55",
+    "puppeteer": "^18.0.5"
   },
   "peerDependencies": {
     "puppeteer": ">=5.3.0"