suitest-js-api 3.0.2 → 3.1.2

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 {RelativePosition} from './typeDefinition/RelativePositionChain';
 
 // --------------- Suitest Interface ---------------------- //
 
@@ -53,6 +54,7 @@ declare namespace suitest {
 		pairDevice(deviceId: string): Promise<DeviceData|SuitestError>;
 		releaseDevice(): Promise<void|SuitestError>;
 		startREPL(options?: ReplOptions): Promise<void>;
+		getAppConfig(): Promise<AppConfiguration|SuitestError>;
 
 		// config
 		getConfig(): ConfigureOptions;
@@ -82,6 +84,7 @@ declare namespace suitest {
 		openUrl(absoluteUrl: string): OpenUrlChain;
 		pollUrl(url: string, response: string): PollUrlChain;
 		position(x: number, y: number): PositionChain;
+		relativePosition(x: number, y: number): RelativePosition;
 		press(key: string): PressButtonChain;
 		press(keys: string[]): PressButtonChain;
 		sleep(milliseconds: number): SleepChain;
@@ -186,6 +189,7 @@ declare namespace suitest {
 		openUrl(absoluteUrl: string): OpenUrlChain;
 		pollUrl(url: string, response: string): PollUrlChain;
 		position(x: number, y: number): PositionChain;
+		relativePosition(x: number, y: number): RelativePosition;
 		press(key: string): PressButtonChain;
 		press(keys: string[]): PressButtonChain;
 		runTest(testId: string): RunTestChain;
@@ -268,6 +272,14 @@ declare namespace suitest {
 		accessToken: string;
 	}
 
+	interface AppConfiguration {
+		name: string;
+		url: string;
+		suitestify: boolean;
+		domainList: string[];
+		variables: Record<string, string>;
+	}
+
 	interface ConfigureOptions {
 		logLevel: 'silent'|'normal'|'verbose'|'debug'|'silly';
 		disallowCrashReports: boolean;

package/lib/api/wsContentTypes.js

@@ -11,6 +11,7 @@ const contentTypes = {
 	eval: 'eval',
 	testLine: 'testLine',
 	takeScreenshot: 'takeScreenshot',
+	getConfiguration: 'getConfiguration',
 };
 
 Object.freeze(contentTypes);

package/lib/chains/relativePositionChain.js

@@ -0,0 +1,131 @@
+const {compose} = require('ramda');
+// Import utils
+const makeChain = require('../utils/makeChain');
+const {applyCountAndDelayAndActions, applyUntilCondition} = require('../utils/chainUtils');
+const {validate, validators} = require('../validation');
+const {getRequestType} = require('../utils/socketChainHelper');
+// Import chain composers
+const {
+	clickComposer,
+	moveToComposer,
+	repeatComposer,
+	intervalComposer,
+	makeToStringComposer,
+	makeThenComposer,
+	abandonComposer,
+	cloneComposer,
+	gettersComposer,
+	assertComposer,
+	makeToJSONComposer,
+	untilComposer,
+} = require('../composers');
+const {invalidInputMessage, relativePositionIsMalformed} = require('../texts');
+const SuitestError = require('../utils/SuitestError');
+
+/**
+ * @param {SUITEST_API} classInstance
+ */
+const relativePositionFactory = (classInstance) => {
+	const toJSON = (data) => {
+		if (!data.isClick && !data.isMoveTo) {
+			throw new SuitestError(relativePositionIsMalformed(), SuitestError.INVALID_INPUT);
+		}
+
+		const lineType = data.isClick ? 'click' : 'moveTo';
+		const socketMessage = {
+			type: getRequestType(data, false),
+			request: {
+				type: lineType,
+				target: {
+					type: 'window',
+					coordinates: data.coordinates,
+					relative: true,
+				},
+			},
+		};
+
+		if (lineType === 'click') {
+			socketMessage.request = compose(
+				msg => applyUntilCondition(msg, data),
+				msg => applyCountAndDelayAndActions(msg, data),
+			)({...socketMessage.request});
+		}
+
+		return socketMessage;
+	};
+
+	// 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);
+		}
+
+		if (!data.isClick && !data.isMoveTo) {
+			output.push(clickComposer, moveToComposer);
+		}
+
+		if (data.isClick) {
+			if (!data.interval) {
+				output.push(intervalComposer);
+			}
+
+			if (!data.repeat) {
+				output.push(repeatComposer);
+			}
+
+			if (!data.until) {
+				output.push(untilComposer);
+			}
+		}
+
+		return output;
+	};
+
+	/**
+	 * Define relative position
+	 * @param {number | string} x - horizontal position
+	 * @param {number | string} y - vertical position
+	 */
+	const relativePositionChain = (x, y) => {
+		return makeChain(classInstance, getComposers, {
+			type: 'position',
+			coordinates: {
+				x: validate(validators.ST_VAR_OR_NUMBER, x, invalidInputMessage('relativePosition', 'Position x')),
+				y: validate(validators.ST_VAR_OR_NUMBER, y, invalidInputMessage('relativePosition', 'Position y')),
+			},
+		});
+	};
+
+	return {
+		// relativePosition functions
+		relativePosition: relativePositionChain,
+		relativePositionAssert: (x, y) => relativePositionChain(x, y).toAssert(),
+
+		// For testing
+		toJSON,
+	};
+};
+
+module.exports = relativePositionFactory;

package/lib/commands/getAppConfig.js

@@ -0,0 +1,23 @@
+const wsContentTypes = require('../api/wsContentTypes');
+const chainPromise = require('../utils/chainPromise');
+const {getAppConfigError} = require('../texts');
+const SuitestError = require('../utils/SuitestError');
+
+async function getAppConfig({appContext, authContext, webSockets}) {
+	const authedContent = await authContext.authorizeWs({
+		type: wsContentTypes.getConfiguration,
+		configId: appContext._context.configId,
+	}, getAppConfig.name);
+
+	const response = await webSockets.send(authedContent);
+
+	if (response.result === 'error') {
+		throw new SuitestError(getAppConfigError());
+	}
+
+	return response.configuration;
+}
+
+module.exports = {
+	getAppConfig: chainPromise(getAppConfig),
+};

package/lib/composers/scrollComposer.js

@@ -5,12 +5,18 @@ const {invalidInputMessage} = require('../texts');
 
 /**
  * Defines click method
+ * @param {'up' | 'down' | 'left' | 'right'} direction
+ * @param {number | string} [distance]
  */
-const scrollComposer = makeModifierComposer(composers.TAP, ['scroll'], (_, meta, direction, distance) => ({
-	...meta,
-	isScroll: true,
-	direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('scroll', 'direction')),
-	distance: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, distance, invalidInputMessage('scroll', 'distance')),
-}));
+const scrollComposer = makeModifierComposer(composers.TAP, ['scroll'], (_, meta, direction, distance) => {
+	return {
+		...meta,
+		isScroll: true,
+		direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('scroll', 'direction')),
+		distance: distance !== undefined
+			? validate(validators.ST_VAR_OR_POSITIVE_NUMBER, distance, invalidInputMessage('scroll', 'distance'))
+			: undefined,
+	};
+});
 
 module.exports = scrollComposer;

package/lib/constants/validationKeys.js

@@ -4,6 +4,7 @@ const validationKeys = {
 	NON_EMPTY_STRING: Symbol('nonEmptyString'),
 	POSITIVE_NUMBER: Symbol('positiveNumber'),
 	ST_VAR_OR_POSITIVE_NUMBER: Symbol('stVarOrPositiveNumber'),
+	ST_VAR_OR_NUMBER: Symbol('stVarOrNumber'),
 	NON_EMPTY_STRING_OR_UNDEFINED: Symbol('nonEmptyStringOrUndefined'),
 	NON_EMPTY_STRING_OR_NUll: Symbol('nonEmptyStringOrNull'),
 	ARRAY_OF_BUTTONS: Symbol('arrayOfButtons'),

package/lib/testLauncher/processArgs.js

@@ -3,7 +3,7 @@ const parser = require('yargs-parser');
 // Specify which options should be treated as boolen.
 // This will enable setting boolean option value to true if not defined explicitly,
 // eg: '--disallow-crash-reports' will be parsed as '--disallow-crash-reports=true'
-const booleanOpts = ['disallow-crash-reports'];
+const booleanOpts = ['disallow-crash-reports', 'include-changelist'];
 const inspectOpts = ['inspect', 'inspect-brk'];
 
 const parseOptions = argv => {

package/lib/texts.js

@@ -74,6 +74,7 @@ module.exports = {
 	assertElementMalformed: () => 'Assert element line is malformed',
 
 	positionIsMalformed: () => 'position command is malformed',
+	relativePositionIsMalformed: () => 'relative position is malformed',
 
 	unusedLeaves: leaves => `Some of your Suitest chains were not executed.
 Put an "await" in front of those chains or call .abandon() to suppress these warnings.
@@ -171,6 +172,7 @@ ${leaves}`,
 	usingAppConfig: (id) => `Setting app configuration id: ${id}`,
 	usedAppConfig: (id) => `Will use app configuration id: ${id}`,
 	useAppConfigOverrides: () => 'Will apply configuration overrides',
+	getAppConfigError: () => 'getAppConfig was called before configId initialization',
 
 	disconnectedFromDevice: () => 'Disconnected from device',
 	disconnectingFromDevice: () => 'Disconnecting from device',

package/lib/utils/AuthContext.js

@@ -37,7 +37,7 @@ const tokenAllowed = {
 		wsContentTypes.pairDevice, wsContentTypes.releaseDevice,
 		wsContentTypes.selectConfiguration, wsContentTypes.query,
 		wsContentTypes.eval, wsContentTypes.testLine,
-		wsContentTypes.takeScreenshot,
+		wsContentTypes.takeScreenshot, wsContentTypes.getConfiguration,
 	],
 };
 

package/lib/validation/validators.js

@@ -153,18 +153,29 @@ const validatePositiveNumber = (val, name) => {
 	return val;
 };
 
-const validateStVarOrPositiveNumber = (val, name) => {
+const validateNumber = (val, name) => {
+	if (!Number.isFinite(val)) {
+		throwError(name + ' should be number');
+	}
+
+	return val;
+};
+
+const createStVarOrNumberValidator = (onlyPositiveNumber = false) => (val, name) => {
 	if (!['number', 'string'].includes(typeof val)) {
 		throwError(name + ' should be suitest configuration variable or number');
 	} else if (typeof val === 'number') {
-		validatePositiveNumber(val, name);
-	} else if (typeof val === 'string' && !/(<%.+%>)/.test(val)) {
+		(onlyPositiveNumber ? validatePositiveNumber : validateNumber)(val, name);
+	} else if (typeof val === 'string' && !/^<%.+%>$/.test(val)) {
 		throwError(name + ' should be suitest configuration variable');
 	}
 
 	return val;
 };
 
+const validateStVarOrNumber = createStVarOrNumberValidator();
+const validateStVarOrPositiveNumber = createStVarOrNumberValidator(true);
+
 const validateNonEmptyStringOrUndefined = (val, name) => {
 	if (typeof val === 'string' && val.length || val === undefined) {
 		return val;
@@ -271,11 +282,13 @@ const validateTapTypeAndDuration = ({tapType, tapDuration}, tapTypeErrorMsg, dur
 module.exports = {
 	validateJsonSchema,
 	validatePositiveNumber,
+	validateNumber,
 	validateNonEmptyStringOrUndefined,
 	validateNonEmptyStringOrNull,
 	validateUntilConditionChain,
 	validateRepoProps,
 	validateNonEmptyArrayOfStrings,
+	validateStVarOrNumber,
 	validateStVarOrPositiveNumber,
 	validateTapTypeAndDuration,
 };

package/lib/validation/validatorsMap.js

@@ -14,6 +14,9 @@ const validatorsMap = {
 	[validationKeys.ST_VAR_OR_POSITIVE_NUMBER]: (value, text) => {
 		return validators.validateStVarOrPositiveNumber(value, text);
 	},
+	[validationKeys.ST_VAR_OR_NUMBER]: (value, text) => {
+		return validators.validateStVarOrNumber(value, text);
+	},
 	[validationKeys.NON_EMPTY_STRING_OR_UNDEFINED]: (value, text) => {
 		return validators.validateNonEmptyStringOrUndefined(value, text);
 	},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.0.2",
+  "version": "3.1.2",
   "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.2.2",
-    "@suitest/translate": "^4.4.0",
+    "@suitest/translate": "^4.4.2",
     "@types/node": "^14.0.10",
     "ajv": "^6.12.2",
     "ansi-regex": "^5.0.0",

package/suitest.js

@@ -7,6 +7,7 @@ const {closeSession} = require('./lib/commands/closeSession');
 const {pairDevice} = require('./lib/commands/pairDevice');
 const releaseDevice = require('./lib/commands/releaseDevice');
 const {setAppConfig} = require('./lib/commands/setAppConfig');
+const {getAppConfig} = require('./lib/commands/getAppConfig');
 
 // Chains
 const openAppFactory = require('./lib/chains/openAppChain');
@@ -22,6 +23,7 @@ const cookieFactory = require('./lib/chains/cookieChain');
 const sleepFactory = require('./lib/chains/sleepChain');
 const pressButtonFactory = require('./lib/chains/pressButtonChain');
 const positionFactory = require('./lib/chains/positionChain');
+const relativePositionFactory = require('./lib/chains/relativePositionChain');
 const windowFactory = require('./lib/chains/windowChain');
 const executeCommandFactory = require('./lib/chains/executeCommandChain');
 const runTestFactory = require('./lib/chains/runTestChain');
@@ -98,6 +100,7 @@ class SUITEST_API extends EventEmitter {
 		this.setAppConfig = (...args) => setAppConfig(this, ...args);
 		this.closeSession = (...args) => closeSession(this, ...args);
 		this.releaseDevice = (...args) => releaseDevice(this, ...args);
+		this.getAppConfig = (...args) => getAppConfig(this, ...args);
 
 		const {openApp, openAppAssert} = openAppFactory(this);
 		const {closeApp, closeAppAssert} = closeAppFactory(this);
@@ -110,6 +113,7 @@ class SUITEST_API extends EventEmitter {
 		const {sleep, sleepAssert} = sleepFactory(this);
 		const {pressButton, pressButtonAssert} = pressButtonFactory(this);
 		const {position, positionAssert} = positionFactory(this);
+		const {relativePosition, relativePositionAssert} = relativePositionFactory(this);
 		const {window, windowAssert} = windowFactory(this);
 		const {executeCommand, executeCommandAssert} = executeCommandFactory(this);
 		const {jsExpression, jsExpressionAssert} = jsExpressionFactory(this);
@@ -134,6 +138,7 @@ class SUITEST_API extends EventEmitter {
 		this.sleep = sleep;
 		this.press = pressButton;
 		this.position = position;
+		this.relativePosition = relativePosition;
 		this.window = window;
 		this.executeCommand = executeCommand;
 		// this.executeBrightScript = executeBrightScriptFactory(this).executeBrightScript;
@@ -180,6 +185,7 @@ class SUITEST_API extends EventEmitter {
 			sleep: sleepAssert,
 			press: pressButtonAssert,
 			position: positionAssert,
+			relativePosition: relativePositionAssert,
 			window: windowAssert,
 			executeCommand: executeCommandAssert,
 			// executeBrightScript: executeBrightScriptFactory(this).executeBrightScriptAssert,

package/typeDefinition/RelativePositionChain.d.ts

@@ -0,0 +1,48 @@
+import {
+	AbstractChain,
+	Clickable,
+	MoveToModifier,
+	Repeatable,
+	Intervalable,
+	BaseChain,
+	UntilModifier,
+} from './modifiers';
+
+export interface RelativePosition extends
+	RelativePositionBaseQueryChain<RelativePosition>,
+	Clickable<RelativePositionRepeatIntervalChain>, // click
+	MoveToModifier<RelativePositionEmptyChain> // moveTo
+{}
+
+interface RelativePositionRepeatIntervalChain extends
+	RelativePositionBaseEvalChain<RelativePositionRepeatIntervalChain>,
+	Repeatable<RelativePositionIntervalChain>,
+	Intervalable<RelativePositionRepeatChain>,
+	UntilModifier<Repeatable<RelativePositionIntervalChain> & Intervalable<RelativePositionRepeatChain>>
+{}
+
+// -repeat +interval
+interface RelativePositionIntervalChain extends
+	RelativePositionBaseEvalChain<RelativePositionIntervalChain>,
+	Intervalable<RelativePositionEmptyChain>
+{}
+
+// +repeat -interval
+interface RelativePositionRepeatChain extends
+	RelativePositionBaseEvalChain<RelativePositionRepeatChain>,
+	Repeatable<RelativePositionEmptyChain>
+{}
+
+interface RelativePositionBaseQueryChain<TSelf> extends
+	BaseChain<TSelf, RelativePositionQueryResult, RelativePositionAbandonedChain>
+{}
+
+interface RelativePositionBaseEvalChain<TSelf> extends
+	BaseChain<TSelf, RelativePositionEvalResult, RelativePositionAbandonedChain>
+{}
+
+interface RelativePositionEmptyChain extends RelativePositionBaseEvalChain<RelativePositionEmptyChain> {}
+interface RelativePositionAbandonedChain extends AbstractChain {}
+
+type RelativePositionQueryResult = string;
+type RelativePositionEvalResult = boolean | void;