suitest-js-api 2.5.0 → 2.5.3

package/index.d.ts

@@ -38,6 +38,7 @@ import {SetScreenOrientationChain} from './typeDefinition/SetScreenOrientationCh
 import {ScreenOrientation} from './typeDefinition/constants/ScreenOrientation';
 import {CloseAppChain} from './typeDefinition/CloseAppChain';
 import {SuspendAppChain} from './typeDefinition/SuspendAppChain';
+import {LaunchMode} from './typeDefinition/constants/LaunchMode';
 
 // --------------- Suitest Interface ---------------------- //
 
@@ -150,6 +151,7 @@ declare namespace suitest {
 		TAP_TYPES: TapTypes;
 		DIRECTIONS: Directions;
 		SCREEN_ORIENTATION: ScreenOrientation;
+		LAUNCH_MODE: LaunchMode;
 
 		authContext: AuthContext;
 		appContext: Context;

package/lib/texts.js

@@ -154,6 +154,11 @@ ${leaves}`,
 	'errorType.testPackNoDevices': () => 'There are no devices associated with this test pack.',
 	'errorType.testCannotBeFetched': (testId, mainTest) => `Test cannot be fetched test id: ${mainTest ? mainTest + ' > ... > ' + testId : testId}`,
 
+	'commandError.notSupportedPlatform': () => 'Screenshots are not supported on this device.',
+	'commandError.timeout': () => 'Failed to take a screenshot due to timeout.',
+	'commandError.generalError': () => 'Failed to take a screenshot.',
+	'commandError.notSupportedDriver': () => 'Screenshots are not supported on this driver.',
+
 	executorStopped: () => 'Test execution was stopped. See our documentation for possible reasons: https://suite.st/docs/error-messages/results-errors/#test-execution-was-stopped',
 
 	executionAborted: () => 'Test execution was aborted.',

package/lib/utils/socketErrorMessages.js

@@ -1,6 +1,6 @@
 /* eslint-disable max-len */
 const {EOL} = require('os');
-const {path} = require('ramda');
+const {path, has} = require('ramda');
 
 const t = require('../texts');
 const chainUtils = require('./chainUtils');
@@ -94,6 +94,22 @@ const getSnippetLogs = ({testId, definitions, results, level, verbosity}, transl
 	}, []).filter(Boolean).join('\n');
 };
 
+const commandErrors = {
+	'notSupportedPlatform': () => t['commandError.notSupportedPlatform'](),
+	'timeout': () => t['commandError.timeout'](),
+	'generalError': () => t['commandError.generalError'](),
+	'notSupportedDriver': () => t['commandError.notSupportedDriver'](),
+};
+
+/**
+ * @description check that response error is related to "command" (not "line") execution.
+ * For now it is related only for taking screenshots
+ * @param response
+ */
+function isCommandError(response) {
+	return response.result === 'error' && has(response.errorType, commandErrors);
+}
+
 /**
  * @description Create human readable error message from suitest error response
  * @param verbosity
@@ -109,6 +125,10 @@ function getErrorMessage({response, jsonMessage, verbosity, snippets}) {
 		);
 	}
 
+	if (isCommandError(response)) {
+		return commandErrors[response.errorType]();
+	}
+
 	return chainUtils.translateLineResult(jsonMessage, verbosity, response);
 }
 

package/lib/utils/testLauncherHelper.js

@@ -396,7 +396,7 @@ function runAllDevices(cmdArgv, ownArgv, devices, ipcPort) {
 
 		log.finalAutomated(failedDevices.length, result.length - failedDevices.length);
 		warnNewVersionAvailable(version, suitestVersion);
-		handleChildResult(failedDevices.length - result.length >= 0);
+		handleChildResult(failedDevices.length !== 0);
 	});
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "2.5.0",
+  "version": "2.5.3",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",

package/typeDefinition/OpenAppChain.d.ts

@@ -1,12 +1,12 @@
 import {
 	AbstractChain,
 	BaseChain,
-	LaunchMode
+	LaunchModeModifier
 } from './modifiers';
 
 export interface OpenAppChain extends
 	BaseChain<OpenAppChain, OpenAppEvalResult, OpenAppAbandonedChain>,
-	LaunchMode<OpenAppChain>
+	LaunchModeModifier<OpenAppChain>
 {}
 
 interface OpenAppAbandonedChain extends AbstractChain {}

package/typeDefinition/constants/LaunchMode.d.ts

@@ -0,0 +1,6 @@
+export type LaunchMode = {
+	RESUME:   'resume',
+	RESTART:  'restart',
+}
+
+export type LaunchModeValues = LaunchMode[keyof LaunchMode];

package/typeDefinition/modifiers.d.ts

@@ -1,3 +1,5 @@
+import {LaunchModeValues} from './constants/LaunchMode';
+
 export interface Thenable <R> {
 	then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => U | Thenable<U>): Thenable<U>;
 	then <U> (onFulfilled?: (value: R) => U | Thenable<U>, onRejected?: (error: any) => void): Thenable<U>;
@@ -38,8 +40,8 @@ export interface Clonable<T> {
 	clone(): T;
 }
 
-export interface LaunchMode<T> {
-	launchMode(mode: 'resume' | 'restart'): T;
+export interface LaunchModeModifier<T> {
+	launchMode(mode: LaunchModeValues): T;
 }
 
 export interface Abandable<T> {