suitest-js-api 3.4.3 → 3.6.0

package/index.d.ts

@@ -40,6 +40,7 @@ import {CloseAppChain} from './typeDefinition/CloseAppChain';
 import {SuspendAppChain} from './typeDefinition/SuspendAppChain';
 import {RelativePosition} from './typeDefinition/RelativePositionChain';
 import {LaunchMode} from './typeDefinition/constants/LaunchMode';
+import {OpenDeepLinkChain} from './typeDefinition/OpenDeepLink';
 
 // --------------- Suitest Interface ---------------------- //
 
@@ -90,18 +91,15 @@ declare namespace suitest {
 		press(keys: string[], options?: { longPressMs?: string | number }): PressButtonChain;
 		sleep(milliseconds: number): SleepChain;
 		window(): WindowChain;
-
 		/**
 		 * @description return PromiseLike object with Buffer as value
 		 */
 		takeScreenshot(dataFormat?: 'raw'): TakeScreenshotChain<Buffer>;
 		setScreenOrientation(orientation: ScreenOrientationValues): SetScreenOrientationChain;
-
 		/**
 		 * @description return PromiseLike object with base64 string as value
 		 */
 		takeScreenshot(dataFormat: 'base64'): TakeScreenshotChain<string>;
-
 		/**
 		 * @description the complete path to the file name where the screenshot should be saved.
 		 *  Can be defined as string with placeholders, for example default path
@@ -116,6 +114,7 @@ declare namespace suitest {
 		 * suitest.saveScreenshot('{screenshotDir}/{dateTime}-{currentFile}-l{currentLine}.png');
 		 */
 		saveScreenshot(fileName?: string): TakeScreenshotChain<void>;
+		openDeepLink(deepLink?: string): OpenDeepLinkChain;
 
 		getPairedDevice(): null | {
 			deviceId: string,
@@ -198,6 +197,7 @@ declare namespace suitest {
 		sleep(milliseconds: number): SleepChain;
 		window(): WindowChain;
 		setScreenOrientation(orientation: ScreenOrientationValues): SetScreenOrientationChain;
+		openDeepLink(deepLink?: string): OpenDeepLinkChain;
 	}
 
 	type NetworkLogEvent = {

package/lib/chains/openDeepLinkChain.js

@@ -0,0 +1,86 @@
+const makeChain = require('../utils/makeChain');
+const {
+	abandonComposer,
+	makeToStringComposer,
+	makeThenComposer,
+	assertComposer,
+	cloneComposer,
+	gettersComposer,
+	makeToJSONComposer,
+} = require('../composers');
+const {invalidInputMessage} = require('../texts');
+const {getRequestType} = require('../utils/socketChainHelper');
+const {validate, validators} = require('../validation');
+
+/**
+ * @param {SUITEST_API} classInstance
+ */
+const openDeepLinkFactory = (classInstance) => {
+	const toJSON = (data) => ({
+		type: getRequestType(data, false),
+		request: {
+			type: 'openDeepLink',
+			deepLink: data.deepLink,
+		},
+	});
+
+	// Build composers
+	const toStringComposer = makeToStringComposer(toJSON);
+	const thenComposer = makeThenComposer(toJSON);
+	const toJSONComposer = makeToJSONComposer(toJSON);
+
+	/**
+	 * Function accepts data object of future chain as input
+	 * and returns a list of composers that should build the chain
+	 * @param data
+	 * @returns {*[]}
+	 */
+	const getComposers = (data) => {
+		const output = [
+			toStringComposer,
+			thenComposer,
+			cloneComposer,
+			gettersComposer,
+			toJSONComposer,
+		];
+
+		if (!data.isAssert) {
+			output.push(assertComposer);
+		}
+
+		if (!data.isAbandoned) {
+			output.push(abandonComposer);
+		}
+
+		return output;
+	};
+
+	// Chain builder functions
+	const openDeepLinkChain = (deepLink) => {
+		deepLink = deepLink === undefined ? '' : validate(
+			validators.STRING,
+			deepLink,
+			invalidInputMessage('openDeepLink', 'Deep Link'),
+		);
+
+		return makeChain(
+			classInstance,
+			getComposers,
+			{
+				type: 'openDeepLink',
+				deepLink,
+			},
+		);
+	};
+
+	return {
+		openDeepLink: openDeepLinkChain,
+		openDeepLinkAssert: (deepLink) => openDeepLinkChain(deepLink).toAssert(),
+
+		// For Unit tests
+		getComposers,
+		toJSON,
+	};
+};
+
+module.exports = openDeepLinkFactory;

package/lib/constants/keys.js

@@ -56,6 +56,8 @@ const KEY = {
 	SUBTRACT: '[[Subtract]]',
 	TAB: '[[Tab]]',
 	UP_ARROW: '[[Up arrow]]',
+	SEARCH: '[[Search]]',
+	DONE: '[[Done]]',
 };
 
 Object.freeze(KEY);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.4.3",
+  "version": "3.6.0",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",
@@ -85,7 +85,7 @@
   },
   "dependencies": {
     "@suitest/smst-to-text": "^4.4.3",
-    "@suitest/translate": "^4.5.1",
+    "@suitest/translate": "^4.6.0",
     "@types/node": "^14.0.10",
     "ajv": "^6.12.2",
     "ansi-regex": "^5.0.0",

package/suitest.js

@@ -36,6 +36,7 @@ const networkRequestFactory = require('./lib/chains/networkRequestChain');
 const videoFactory = require('./lib/chains/videoChain');
 const playstationVideoFactory = require('./lib/chains/playstationVideoChain');
 const setScreenOrientationFactory = require('./lib/chains/setScreenOrientationChain');
+const openDeepLinkFactory = require('./lib/chains/openDeepLinkChain');
 
 // Constants
 const {ELEMENT_PROP, VALUE} = require('./lib/constants/element');
@@ -126,6 +127,7 @@ class SUITEST_API extends EventEmitter {
 		const {takeScreenshot} = takeScreenshotFactory(this);
 		const {saveScreenshot} = saveScreenshotFactory(this);
 		const {setScreenOrientation, setScreenOrientationAssert} = setScreenOrientationFactory(this);
+		const {openDeepLink, openDeepLinkAssert} = openDeepLinkFactory(this);
 
 		this.openApp = openApp;
 		this.closeApp = closeApp;
@@ -152,6 +154,7 @@ class SUITEST_API extends EventEmitter {
 		this.takeScreenshot = takeScreenshot;
 		this.saveScreenshot = saveScreenshot;
 		this.setScreenOrientation = setScreenOrientation;
+		this.openDeepLink = openDeepLink;
 
 		this.PROP = ELEMENT_PROP;
 		this.COMP = PROP_COMPARATOR;
@@ -198,6 +201,7 @@ class SUITEST_API extends EventEmitter {
 			video: videoAssert,
 			psVideo: playstationVideoAssert,
 			setScreenOrientation: setScreenOrientationAssert,
+			openDeepLink: openDeepLinkAssert,
 		};
 
 		// Listen to process events to trigger websocket termination and dump warnings, if any

package/typeDefinition/OpenDeepLink.d.ts

@@ -0,0 +1,12 @@
+import {
+	AbstractChain,
+	BaseChain
+} from './modifiers';
+
+export interface OpenDeepLinkChain extends
+	BaseChain<OpenDeepLinkChain, OpenDeepLinkEvalResult, OpenDeepLinkAbandonedChain>
+{}
+
+interface OpenDeepLinkAbandonedChain extends AbstractChain {}
+
+type OpenDeepLinkEvalResult = void | boolean;

package/typeDefinition/constants/Keys.d.ts

@@ -55,4 +55,6 @@ export type Keys = {
 	SUBTRACT:    '[[Subtract]]',
 	TAB:         '[[Tab]]',
 	UP_ARROW:    '[[Up arrow]]',
+	SEARCH:      '[[Search]]',
+	DONE:        '[[Done]]',
 }