@applitools/visual-grid-cli-utils 1.21.27 → 1.21.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/visual-grid-cli-utils",
-  "version": "1.21.27",
+  "version": "1.21.30",
   "description": "",
   "main": "src/visual-grid-cli-utils.js",
   "engines": {
@@ -21,7 +21,9 @@
     "start": "scripts/run-visual-grid-cli-utils.js",
     "test:mocha": "mocha --no-timeouts --exit 'test/unit/*.test.js' 'test/it/*.test.js' 'test/e2e/*.test.js'",
     "test": "npm run eslint && npm run test:mocha",
-    "eslint": "eslint '**/*.js'"
+    "eslint": "eslint '**/*.js'",
+    "postinstall": "install-yargs-completion",
+    "uninstall": "uninstall-yargs-completion"
   },
   "keywords": [
     "applitools",
@@ -43,6 +45,7 @@
     "@applitools/screenshot-stitching-client": "^8.0.15",
     "@applitools/url-commons": "^1.0.1",
     "@applitools/visual-grid-client": "^15.8.21",
+    "completarr": "^0.2.2",
     "debug": "^4.3.1",
     "gunzip-file": "^0.1.1",
     "jszip": "^3.7.1",

package/src/job-info.js

@@ -15,6 +15,10 @@ async function main({
   deviceOrientation,
   iosDeviceName,
   iosDeviceOrientation,
+  androidDeviceName,
+  androidVersion,
+  androidDeviceOrientation,
+  androidVhsType,
   serverUrl,
   accountOverride,
   canary,
@@ -44,6 +48,14 @@ async function main({
               version: canary ? 'canary' : iosVersion,
             }
           : undefined,
+        androidDeviceInfo: androidDeviceName
+          ? {
+              name: androidDeviceName,
+              version: canary ? 'canary' : androidVersion,
+              screenOrientation: androidDeviceOrientation,
+            }
+          : undefined,
+        vhsType: androidDeviceName ? androidVhsType : undefined,
         width: deviceEmulation || iosDeviceName ? undefined : width,
         height: deviceEmulation || iosDeviceName ? undefined : height,
         target: 'full-page',
@@ -54,7 +66,10 @@ async function main({
         : {
             name: iosDeviceName ? 'safari' : canary ? convertBrowserNameToCanary(browser) : browser,
           },
-      platform: {name: iosDeviceName ? 'ios' : undefined, type: native ? 'native' : 'web'},
+      platform: {
+        name: iosDeviceName ? 'ios' : androidDeviceName ? 'android' : undefined,
+        type: native ? 'native' : 'web',
+      },
       options,
     },
     {

package/src/view-rendering.js

@@ -27,12 +27,18 @@ async function main({
   const viewRenderingUrl = calculateViewRenderingUrl(renderId, finalAuthToken, accountOverride)
 
   if (downloadVhsFolder) {
-    const response = await fetch(viewRenderingUrl)
+    let response = await fetch(viewRenderingUrl)
     if (!response.ok) await throwErrorFromBadStatus(viewRenderingUrl, response)
     const contentType = response.headers.get('content-type')
-    if (!contentType.includes('x-applitools-vhs')) {
+    if (contentType.includes('json')) {
+      const body = await response.json()
+
+      response = await fetch(body.vhs)
+      if (!response.ok) await throwErrorFromBadStatus(viewRenderingUrl, response)
+    } else if (!contentType.includes('x-applitools-vhs')) {
       throw new Error('Content type is not VHS, it is: ' + contentType)
     }
+
     const resource = await response.buffer()
     const fname = `${downloadVhsFolder}/${renderId}.vhs`
     fs.writeFileSync(fname, resource)

package/src/visual-grid-cli-utils.js

@@ -3,6 +3,9 @@ const yargs = require('yargs')
 const {parseBrowser} = require('./commons/parse-browser')
 const parseRegion = require('./commons/parse-region')
 const splitApiKey = require('./commons/split-api-key')
+require('completarr')({
+  name: 'vg-cli',
+})
 
 async function main(argv, {shouldExitOnError = false} = {}) {
   const commandLineOptions = yargs(argv)
@@ -490,6 +493,28 @@ async function main(argv, {shouldExitOnError = false} = {}) {
           choices: ['portrait', 'landscapeLeft', 'landscapeRight'],
           default: 'portrait',
         })
+        .option('android-device-name', {
+          describe: 'the name of the Android device to use',
+          type: 'string',
+        })
+        .option('android-version', {
+          describe:
+            'The Android version to use (latest, latest-1 or latest-2 - relative to the device)',
+          type: 'string',
+          default: 'latest',
+        })
+        .option('android-device-orientation', {
+          describe: 'screen orientation',
+          type: 'string',
+          choices: ['portrait', 'landscape'],
+          default: 'portrait',
+        })
+        .option('android-vhs-type', {
+          describe: 'vhs type',
+          type: 'string',
+          choices: ['android-x', 'android-support'],
+          default: 'android-x',
+        })
         .option('browser', {
           alias: 'b',
           describe: 'the browser to render to',