suitest-js-api 3.7.2 → 3.8.1

package/README.md

@@ -45,6 +45,7 @@ etc.
 - Locally installed Chrome, Firefox, Safari and Edge
 - Apple tvOS, iOS and iPadOS devices, including simulators 
 - Roku
+- Vizio
 
 Suitest supports automating end-to-end testing of:
 
@@ -52,11 +53,12 @@ Suitest supports automating end-to-end testing of:
 - Samsung Orsay and Tizen apps
 - LG NetCast and webOS apps 
 - HTML apps for other TV's or set-top boxes
-- Android TV apps (including FireTV)
-- tvOS apps
+- Android TV and mobile apps (including FireTV)
+- Apple TV (tvOS), iOS and iPadOS apps
 - Xbox One and Xbox Series S and X apps
 - PlayStation 4 / 5 apps
 - Roku apps
+- Vizio SmartCast
 - Traditional websites and web apps for desktop browsers.
 
 ## Contributing

package/config/index.js

@@ -11,7 +11,7 @@ const timestamp = require('../lib/constants/timestamp');
 const {validate, validators} = require('../lib/validation');
 const {invalidConfigObj} = require('../lib/texts');
 const {pickNonNil} = require('../lib/utils/common');
-const envVars = require('../lib/constants/enviroment');
+const envVars = require('../lib/constants/environment');
 
 const sentryDsn = 'https://1f74b885d0c44549b57f307733d60351:dd736ff3ac994104ab6635da53d9be2e@sentry.io/288812';
 const DEFAULT_TIMEOUT = 2000;
@@ -19,7 +19,7 @@ const DEFAULT_TIMEOUT = 2000;
 const overridableFields = [
 	'tokenId', 'tokenPassword', 'concurrency', 'preset', 'presets', 'deviceId', 'appConfigId', 'inspect', 'inspectBrk',
 	'logLevel', 'logDir', 'timestamp', 'configFile', 'disallowCrashReports', 'defaultTimeout', 'screenshotDir',
-	'includeChangelist',
+	'includeChangelist', 'recordingOption', 'webhookUrl',
 ];
 
 const serverAddress = process.env[envVars.SUITEST_BE_SERVER] || 'the.suite.st';

package/index.d.ts

@@ -53,10 +53,12 @@ declare namespace suitest {
 		openSession(options: OpenSessionOptions): Promise<OpenSessionResult|SuitestError>;
 		closeSession(): Promise<object|SuitestError>;
 		setAppConfig(configId: string, options?: ConfigOverride): Promise<void|SuitestError>;
-		pairDevice(deviceId: string): Promise<DeviceData|SuitestError>;
+		pairDevice(deviceId: string, {recording, webhookUrl}: {recording?: 'autostart' | 'manualstart' | 'none', webhookUrl?: string} | undefined): Promise<DeviceData|SuitestError>;
 		releaseDevice(): Promise<void|SuitestError>;
 		startREPL(options?: ReplOptions): Promise<void>;
 		getAppConfig(): Promise<AppConfiguration|SuitestError>;
+		startRecording({webhookUrl}?: {webhookUrl: string}): Promise<void|SuitestError>;
+		stopRecording({discard}?: {discard: boolean}): Promise<void|SuitestError>;
 
 		// config
 		getConfig(): ConfigureOptions;
@@ -64,6 +66,8 @@ declare namespace suitest {
 		setContinueOnFatalError(continueOnFatalError: ConfigureOptions['continueOnFatalError']): void;
 		setDisallowCrashReports(disallowCrashReports: ConfigureOptions['disallowCrashReports']): void;
 		setLogLevel(logLevel: ConfigureOptions['logLevel']): void;
+		setRecordingOption(recordingOption: ConfigureOptions['recordingOption']): void;
+		setWebhookUrl(webhookUrl: ConfigureOptions['webhookUrl']): void;
 
 		// subjects
 		location(): LocationChain;
@@ -277,6 +281,8 @@ declare namespace suitest {
 
 	interface ConfigureOptions {
 		logLevel: 'silent'|'normal'|'verbose'|'debug'|'silly';
+		recordingOption: 'autostart'|'manualstart'|'none';
+		webhookUrl: string;
 		disallowCrashReports: boolean;
 		continueOnFatalError: boolean;
 		defaultTimeout: number;

package/lib/api/webSockets.js

@@ -157,6 +157,21 @@ const webSocketsFactory = (self) => {
 							});
 						});
 				}
+			} else if (
+				path([message.messageId, 'contentType'])(requestPromises) === 'startRecording' &&
+				message.content.result === 'error'
+			) {
+				// Allowing result: 'error' for startRecording command and not interrupting test flow
+
+				const messageId = message.messageId;
+				const res = message.content.response || message.content;
+				const req = requestPromises[messageId];
+				const contentMessage = res.error ? res.error : texts.unknownError();
+
+				logger.error(getInfoErrorMessage(contentMessage, '', res, ''));
+				req.resolve(res);
+
+				delete requestPromises[messageId];
 			} else {
 				handleResponse(message);
 			}

package/lib/api/wsContentTypes.js

@@ -12,6 +12,8 @@ const contentTypes = {
 	testLine: 'testLine',
 	takeScreenshot: 'takeScreenshot',
 	getConfiguration: 'getConfiguration',
+	startRecording: 'startRecording',
+	stopRecording: 'stopRecording',
 };
 
 Object.freeze(contentTypes);

package/lib/commands/pairDevice.js

@@ -15,12 +15,20 @@ const SuitestError = require('../utils/SuitestError');
  * Pair with device
  * @param {Object} instance - main class instance
  * @param {string} deviceId - device to connect to
+ * @param {Object | undefined} recordingSettings - {recording, webhookUrl} object. Optional.
  * @returns {ChainablePromise.<DeviceData>}
  */
-async function pairDevice({webSockets, authContext, logger, pairedDeviceContext}, deviceId) {
+async function pairDevice(
+	{webSockets, authContext, logger, pairedDeviceContext, config},
+	deviceId,
+	recordingSettings
+) {
 	// validate deviceId string to be in uuid format
 	validate(validators.UUID, deviceId, invalidInputMessage(pairDevice.name, 'Device id'));
 
+	const recordingDefault = recordingSettings ? recordingSettings.recording : 'none';
+	const webhookUrlDefault = recordingSettings ? recordingSettings.webhookUrl : undefined;
+
 	const [deviceDetails] = await getDevicesDetails({authContext}, [{device: deviceId}]);
 
 	if (!deviceDetails)
@@ -31,12 +39,18 @@ async function pairDevice({webSockets, authContext, logger, pairedDeviceContext}
 
 	const deviceName = deviceDetails.displayName;
 
+	const recordingOption = config.recordingOption || recordingDefault;
+
+	const webhookUrlOption = config.webhookUrl || webhookUrlDefault;
+
 	logger.delayed(connectingToDevice(deviceName, deviceId), 4e3);
 
 	// authorize
 	const authedContent = await authContext.authorizeWs({
 		type: wsContentTypes.pairDevice,
 		deviceId,
+		recording: recordingOption,
+		webhookUrl: webhookUrlOption,
 	}, pairDevice.name);
 	// make ws request
 	const res = await webSockets.send(authedContent);

package/lib/commands/startRecording.js

@@ -0,0 +1,33 @@
+/**
+ * Start recording command.
+ */
+
+const wsContentTypes = require('../api/wsContentTypes');
+const chainPromise = require('../utils/chainPromise');
+const {startRecordingMessage} = require('../texts');
+
+/**
+ * Start recording
+ * @param {SUITEST_API} instance of main class
+ * @returns {ChainablePromise.<void>}
+ */
+async function startRecording({webSockets, authContext, logger}, recordingSettings) {
+	const webhookUrl = recordingSettings ? recordingSettings.webhookUrl : undefined;
+
+	// authorize
+	const authedContent = await authContext.authorizeWs(
+		{
+			type: wsContentTypes.startRecording,
+			webhookUrl,
+		},
+	);
+
+	// make ws request
+	const response = await webSockets.send(authedContent);
+
+	if (response.result === 'success') {
+		logger.log(startRecordingMessage());
+	}
+}
+
+module.exports = chainPromise(startRecording);

package/lib/commands/stopRecording.js

@@ -0,0 +1,31 @@
+/**
+ * Stop recording command.
+ */
+
+const wsContentTypes = require('../api/wsContentTypes');
+const chainPromise = require('../utils/chainPromise');
+const {stopRecordingMessage} = require('../texts');
+
+/**
+ * Stop recording
+ * @param {SUITEST_API} instance of main class
+ * @returns {ChainablePromise.<void>}
+ */
+async function stopRecording({webSockets, authContext, logger}, recordingSettings) {
+	const discard = recordingSettings ? recordingSettings.discard : false;
+
+	// authorize
+	const authedContent = await authContext.authorizeWs(
+		{
+			type: wsContentTypes.stopRecording,
+			discard,
+		},
+	);
+
+	// make ws request
+	await webSockets.send(authedContent);
+
+	logger.log(stopRecordingMessage());
+}
+
+module.exports = chainPromise(stopRecording);

package/lib/composers/acceptModalComposer.js

@@ -8,14 +8,17 @@ const {invalidInputMessage} = require('../texts');
  * Accept modal dialog, optionally sending message
  * @param {String} [message] - text to be send to modal dialog
  */
-const acceptModalComposer = makeModifierComposer(composers.ACCEPT_MODAL, ['acceptModal'], (_, meta, message = null) => ({
-	...meta,
-	isAcceptModal: true,
-	acceptModalMessage: validate(
-		validators.NON_EMPTY_STRING_OR_NUll,
-		message,
-		invalidInputMessage('acceptModal', 'Message value'),
-	),
-}));
+const acceptModalComposer = makeModifierComposer(
+	composers.ACCEPT_MODAL,
+	['acceptModal'],
+	(_, meta, message = null) => ({
+		...meta,
+		isAcceptModal: true,
+		acceptModalMessage: validate(
+			validators.NON_EMPTY_STRING_OR_NUll,
+			message,
+			invalidInputMessage('acceptModal', 'Message value'),
+		),
+	}));
 
 module.exports = acceptModalComposer;

package/lib/composers/cloneComposer.js

@@ -8,7 +8,7 @@ const cloneComposer = makeModifierComposer(
 	composers.CLONE,
 	['clone'],
 	(_, meta) => ({...meta}),
-	{unregisterParent: false}
+	{unregisterParent: false},
 );
 
 module.exports = cloneComposer;

package/lib/composers/matchBrightScriptComposer.js

@@ -22,7 +22,7 @@ const matchBrightScriptComposer = makeModifierComposer(
 				val: res,
 			},
 		};
-	}
+	},
 );
 
 module.exports = matchBrightScriptComposer;

package/lib/composers/matchRepoComposer.js

@@ -38,16 +38,19 @@ const processMatchRepoArgs = makeArgumentsProcessor(
 	}),
 );
 
-const matchRepoComposer = makeModifierComposer(composers.MATCH_REPO, ['matchRepo', 'matchesRepo'], (_, data, ...args) => ({
-	...data,
-	comparator: {
-		type: SUBJ_COMPARATOR.MATCH,
-		props: validation.validate(
-			validation.validators.ELEMENT_REPO_PROPS,
-			processMatchRepoArgs(args),
-			invalidInputMessage('matchRepo', 'Property')
-		),
-	},
-}));
+const matchRepoComposer = makeModifierComposer(
+	composers.MATCH_REPO,
+	['matchRepo', 'matchesRepo'],
+	(_, data, ...args) => ({
+		...data,
+		comparator: {
+			type: SUBJ_COMPARATOR.MATCH,
+			props: validation.validate(
+				validation.validators.ELEMENT_REPO_PROPS,
+				processMatchRepoArgs(args),
+				invalidInputMessage('matchRepo', 'Property'),
+			),
+		},
+	}));
 
 module.exports = matchRepoComposer;

package/lib/composers/requestMatchesComposer.js

@@ -31,7 +31,7 @@ const processRequestArgs = makeArgumentsProcessor(
 	 */
 	({name, val, type = PROP_COMPARATOR.EQUAL}) => getRequestMatchItem(name, val, type),
 	objArg => 'name' in objArg && 'val' in objArg,
-	getRequestMatchItem
+	getRequestMatchItem,
 );
 
 const requestMatchesComposer = makeModifierComposer(
@@ -47,7 +47,7 @@ const requestMatchesComposer = makeModifierComposer(
 				invalidInputMessage('requestMatch', 'Header'),
 			),
 		},
-	})
+	}),
 );
 
 module.exports = requestMatchesComposer;

package/lib/composers/responseMatchesComposer.js

@@ -32,7 +32,7 @@ const processResponseArgs = makeArgumentsProcessor(
 	 */
 	({name, val, type = PROP_COMPARATOR.EQUAL}) => getResponseMatchComposers(name, val, type),
 	objArg => 'name' in objArg && 'val' in objArg,
-	getResponseMatchComposers
+	getResponseMatchComposers,
 );
 
 const responseMatchesComposer = makeModifierComposer(
@@ -45,10 +45,10 @@ const responseMatchesComposer = makeModifierComposer(
 			props: validation.validate(
 				validation.validators.RESPONSE_MATCHES,
 				processResponseArgs(args),
-				invalidInputMessage('responseMatch', 'Header')
+				invalidInputMessage('responseMatch', 'Header'),
 			),
 		},
-	})
+	}),
 );
 
 module.exports = responseMatchesComposer;

package/lib/composers/swipeComposer.js

@@ -6,12 +6,21 @@ const {invalidInputMessage} = require('../texts');
 /**
  * Defines click method
  */
-const swipeComposer = makeModifierComposer(composers.TAP, ['swipe', 'flick'], (_, meta, direction, distance, duration) => ({
-	...meta,
-	isSwipe: true,
-	direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('swipe/flick', 'direction')),
-	distance: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, distance, invalidInputMessage('swipe/flick', 'distance')),
-	duration: validate(validators.ST_VAR_OR_POSITIVE_NUMBER, duration, invalidInputMessage('swipe/flick', 'duration')),
-}));
+const swipeComposer = makeModifierComposer(
+	composers.TAP,
+	['swipe', 'flick'],
+	(_, meta, direction, distance, duration) => ({
+		...meta,
+		isSwipe: true,
+		direction: validate(validators.DIRECTIONS, direction, invalidInputMessage('swipe/flick', 'direction')),
+		distance: validate(
+			validators.ST_VAR_OR_POSITIVE_NUMBER, distance,
+			invalidInputMessage('swipe/flick', 'distance'),
+		),
+		duration: validate(
+			validators.ST_VAR_OR_POSITIVE_NUMBER, duration,
+			invalidInputMessage('swipe/flick', 'duration'),
+		),
+	}));
 
 module.exports = swipeComposer;

package/lib/constants/{enviroment.js → environment.js}

@@ -1,4 +1,4 @@
-const ENVIROMENT_VARS = Object.freeze({
+const ENVIRONMENT_VARS = Object.freeze({
 	/**
 	 * @description indicates that session is running as launcher child process, contains deviceId|configId|ipcPortNumber
 	 */
@@ -7,4 +7,4 @@ const ENVIROMENT_VARS = Object.freeze({
 	SUITEST_BE_SERVER: 'SUITEST_BE_SERVER',
 });
 
-module.exports = ENVIROMENT_VARS;
+module.exports = ENVIRONMENT_VARS;

package/lib/constants/recordingOptions.js

@@ -0,0 +1,13 @@
+/**
+ * Recording options
+ */
+
+const recordingOptions = {
+	autoStart: 'autostart',
+	manualStart: 'manualstart',
+	none: 'none',
+};
+
+Object.freeze(recordingOptions);
+
+module.exports = recordingOptions;

package/lib/constants/screenOrientation.js

@@ -1,3 +1,5 @@
+/* eslint-disable key-spacing */
+
 const screenOrientation = {
 	PORTRAIT:             'portrait',
 	PORTRAIT_REVERSED:    'portraitReversed',

package/lib/testLauncher/commands/run.js

@@ -2,6 +2,7 @@ const {once} = require('ramda');
 const {composeConfig} = require('../composeConfig');
 const texts = require('../../texts');
 const logLevels = require('../../constants/logLevels');
+const recordingOptions = require('../../constants/recordingOptions');
 const SuitestLauncher = require('../SuitestLauncher');
 const suitest = require('../../../index');
 
@@ -99,6 +100,16 @@ const builder = yargs => {
 			boolean: true,
 			default: false,
 			global: false,
+		})
+		.option('recording-option', {
+			describe: texts.cliRecordingOption(),
+			global: false,
+			choices: Object.values(recordingOptions),
+		})
+		.option('webhook-url', {
+			describe: 'webhook url for recording option',
+			global: false,
+			type: 'string',
 		});
 };
 

package/lib/testLauncher/repl.js

@@ -6,7 +6,7 @@ const chokidar = require('chokidar');
 
 const texts = require('../texts');
 const ipcClient = require('./ipc/client');
-const envVars = require('../constants/enviroment');
+const envVars = require('../constants/environment');
 const messageId = require('../constants/ipcMessageId');
 const errorListeners = require('../utils/errorListeners');
 const {getShortFunctionBody} = require('../utils/stringUtils');

package/lib/texts.js

@@ -212,4 +212,7 @@ ${leaves}`,
 	defaultTimeout: () => 'Globally set timeout value in milliseconds. Equals to 2000 when left out.',
 	cliTimestamp: () => `Logger timestamp format. Use "${timestamp.none}" to disable. [default: "${timestamp.default}"]. This string is processed with momentJS.`,
 	cliConfig: () => 'Config file to override default config.',
+	cliRecordingOption: () => 'Enables recording of test session',
+	startRecordingMessage: () => 'Recording started',
+	stopRecordingMessage: () => 'Recording stopped',
 };

package/lib/utils/AuthContext.js

@@ -38,6 +38,7 @@ const tokenAllowed = {
 		wsContentTypes.selectConfiguration, wsContentTypes.query,
 		wsContentTypes.eval, wsContentTypes.testLine,
 		wsContentTypes.takeScreenshot, wsContentTypes.getConfiguration,
+		wsContentTypes.startRecording, wsContentTypes.stopRecording,
 	],
 };
 
@@ -56,7 +57,7 @@ const allowedRequests = {
  * Decorate http requestObject with current context headers
  * @param {*} requestObject
  * @param {*} headers
- * @returns requestObject decoerated with auth headers
+ * @returns requestObject decorated with auth headers
  */
 function decorateRequestObject(requestObject, headers) {
 	return Object.assign({}, requestObject, {headers});

package/lib/utils/sessionStarter.js

@@ -2,7 +2,7 @@ const {TOKEN} = require('../constants/modes');
 const chainPromise = require('./chainPromise');
 const {validate, validators} = require('../validation');
 const {captureException} = require('./sentry/Raven');
-const envVars = require('../constants/enviroment');
+const envVars = require('../constants/environment');
 const messageId = require('../constants/ipcMessageId');
 const ipcClient = require('../testLauncher/ipc/client');
 const {replWarn} = require('../texts');
@@ -56,7 +56,11 @@ const bootstrapSession = async(suitest, {deviceId, configId, presetName}) => {
 				: {};
 
 			await setAppConfig(suitest, configId, configOverride);
-			await pairDevice(suitest, deviceId);
+			await pairDevice(
+				suitest,
+				deviceId,
+				{recording: suitest.config.recording, webhookUrl: suitest.config.webhookUrl},
+			);
 
 			if (suitest.config.isDebugMode) {
 				await suitest.webSockets.send({type: wsContentTypes.enableDebugMode});

package/lib/utils/testLauncherHelper.js

@@ -11,7 +11,7 @@ const texts = require('../texts');
 
 const Queue = require('./Queue');
 const {registerProcess} = require('../testLauncher/processReaper');
-const envVars = require('../constants/enviroment');
+const envVars = require('../constants/environment');
 
 const {version} = require('../../package.json');
 const {stripAnsiChars} = require('./stringUtils');
@@ -192,7 +192,7 @@ function logOutput(child, chunk, logStream) {
  * needs to be called to enable sending terminal codes.
  * When repl ends the node process for some reason does not want to take over
  * the ownership of the terminal anymore (setRawMode(false) does not help).
- * This function manually enables ctrl+c togther with the keypress module
+ * This function manually enables ctrl+c together with the keypress module
  * @param {string} ch
  * @param {Object} key
  */

package/lib/validation/jsonSchemas.js

@@ -147,7 +147,7 @@ const deviation = {
 	'then': {'type': ['number', 'string']},
 	'else': {'const': 'undefined'},
 };
-const propComarator = {
+const propComparator = {
 	'type': 'string',
 	'enum': Object.values(PROP_COMPARATOR),
 };
@@ -164,7 +164,7 @@ schemas[validationKeys.ELEMENT_PROPS] = {
 					'type': 'string',
 					'enum': Object.values(ELEMENT_PROP),
 				},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'const': VALUE.REPO},
 				deviation,
 			}},
@@ -173,7 +173,7 @@ schemas[validationKeys.ELEMENT_PROPS] = {
 					'type': 'string',
 					'enum': ELEMENT_PROP_BY_TYPE.integer,
 				},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'type': ['integer', 'string']},
 				deviation,
 			}},
@@ -182,55 +182,55 @@ schemas[validationKeys.ELEMENT_PROPS] = {
 					'type': 'string',
 					'enum': ELEMENT_PROP_BY_TYPE.string,
 				},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'type': 'string'},
 				deviation,
 			}},
 			{'properties': {
 				'name': {'enum': ELEMENT_PROP_BY_TYPE.number},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'type': ['number', 'string']},
 				deviation,
 			}},
 			{'properties': {
 				'name': {'enum': ELEMENT_PROP_BY_TYPE.boolean},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'type': 'boolean'},
 				deviation,
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.BORDER_STYLE},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(BORDER_STYLE)},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.VIDEO_STATE},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(VIDEO_STATE)},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.VISIBILITY},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': [VISIBILITY_STATE.COLLAPSED, VISIBILITY_STATE.INVISIBLE, VISIBILITY_STATE.VISIBLE]},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.CONTENT_MODE},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(CONTENT_MODE)},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.STATE},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(ELEMENT_STATE)},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.TEXT_ALIGNMENT},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(TEXT_ALIGNMENT)},
 			}},
 			{'properties': {
 				'name': {'const': ELEMENT_PROP.IMAGE_LOAD_STATE},
-				'type': propComarator,
+				'type': propComparator,
 				'val': {'enum': Object.values(IMAGE_LOAD_STATE)},
 			}},
 		],
@@ -245,7 +245,7 @@ schemas[validationKeys.ELEMENT_REPO_PROPS] = {
 		'additionalProperties': false,
 		'properties': {
 			'name': {'enum': Object.values(ELEMENT_PROP)},
-			'type': propComarator,
+			'type': propComparator,
 			'val': {'const': VALUE.REPO},
 			deviation,
 		},
@@ -261,17 +261,17 @@ schemas[validationKeys.REQUEST_MATCHES] = {
 			{'properties': {
 				'name': {'type': 'string'},
 				'val': {'type': 'string'},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 			{'properties': {
 				'name': {'const': NETWORK_PROP.METHOD},
 				'val': {'enum': Object.values(NETWORK_METHOD)},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 			{'properties': {
 				'name': {'const': NETWORK_PROP.BODY},
 				'val': {'type': 'string'},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 		],
 	},
@@ -286,17 +286,17 @@ schemas[validationKeys.RESPONSE_MATCHES] = {
 			{'properties': {
 				'name': {'type': 'string'},
 				'val': {'type': 'string'},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 			{'properties': {
 				'name': {'const': NETWORK_PROP.STATUS},
 				'val': {'type': ['number', 'string']},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 			{'properties': {
 				'name': {'const': NETWORK_PROP.BODY},
 				'val': {'type': 'string'},
-				'compare': propComarator,
+				'compare': propComparator,
 			}},
 		],
 	},
@@ -383,6 +383,8 @@ schemas[validationKeys.CONFIGURE] = {
 		'presets': {'type': 'object'},
 		'screenshotDir': {'type': 'string'},
 		'includeChangelist': {'type': 'boolean'},
+		'recordingOption': {'type': 'string'},
+		'webhookUrl': {'type': 'string'},
 	},
 };
 

package/lib/validation/validators.js

@@ -28,8 +28,6 @@ function throwError(text) {
 	);
 }
 
-const getElementPropName = (mapOfNames, name) => typeof mapOfNames[name] === 'string' ? mapOfNames[name] : name;
-
 /**
  * @description returns prettified errors messages for element properties errors
  * @param {Object} validate
@@ -130,7 +128,7 @@ function prettifyJsonSchemaErrors(validate) {
  * @param {*|Symbol} schemaKey json schema of schemas map key
  * @param {*} data
  * @param {String} errorMessage
- * @returns {*} input data or thorws error
+ * @returns {*} input data or throws error
  * @throws SuitestError
  */
 function validateJsonSchema(schemaKey, data, errorMessage) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suitest-js-api",
-  "version": "3.7.2",
+  "version": "3.8.1",
   "main": "index.js",
   "repository": "git@github.com:SuitestAutomation/suitest-js-api.git",
   "author": "Suitest <hello@suite.st>",
@@ -18,6 +18,7 @@
     "Android TV testing",
     "Apple TV testing",
     "Roku testing",
+    "Vizio SmartCast testing",
     "Smart TV test automation",
     "Fire TV test automation"
   ],

package/suitest.js

@@ -8,6 +8,8 @@ const {pairDevice} = require('./lib/commands/pairDevice');
 const releaseDevice = require('./lib/commands/releaseDevice');
 const {setAppConfig} = require('./lib/commands/setAppConfig');
 const {getAppConfig} = require('./lib/commands/getAppConfig');
+const startRecording = require('./lib/commands/startRecording');
+const stopRecording = require('./lib/commands/stopRecording');
 
 // Chains
 const openAppFactory = require('./lib/chains/openAppChain');
@@ -89,6 +91,8 @@ class SUITEST_API extends EventEmitter {
 		this.setContinueOnFatalError = (continueOnFatalError) => this.configuration.override({continueOnFatalError});
 		this.setDisallowCrashReports = (disallowCrashReports) => this.configuration.override({disallowCrashReports});
 		this.setLogLevel = (logLevel) => this.configuration.override({logLevel});
+		this.setRecordingOption = (recordingOption) => this.configuration.override({recordingOption});
+		this.setWebhookUrl = (webhookUrl) => this.configuration.override({webhookUrl});
 
 		// creating methods based on instance dependencies
 		this.logger = createLogger(this.configuration.config, this.pairedDeviceContext);
@@ -102,6 +106,8 @@ class SUITEST_API extends EventEmitter {
 		this.closeSession = (...args) => closeSession(this, ...args);
 		this.releaseDevice = (...args) => releaseDevice(this, ...args);
 		this.getAppConfig = (...args) => getAppConfig(this, ...args);
+		this.startRecording = (...args) => startRecording(this, ...args);
+		this.stopRecording = (...args) => stopRecording(this, ...args);
 
 		const {openApp, openAppAssert} = openAppFactory(this);
 		const {closeApp, closeAppAssert} = closeAppFactory(this);