hayd-caf/src/commandsBlob/commands/dCafCommands.js

Haystacks D-CAF: Distinguished Cloud Automation Framework is a web/cloud/SaaS/mobile GUI automation plugin that leverages a suite of business rules and a factory pattern to auto-generate functions and strings for logging that are used to execute test acti

/**
 * @file dCafCommands.js
 * @module dCafCommands
 * @description Contains all of the commands for the hayD-Caf plugin.
 * @requires module:plugin.constants
 * @requires {@link https://www.npmjs.com/package/@haystacks/async|@haystacks/async}
 * @requires {@link https://www.npmjs.com/package/@haystacks/constants|@haystacks/constants}
 * @requires {@link https://www.npmjs.com/package/path|path}
 * @author Seth Hollingsead
 * @date 2023/04/03
 * @copyright Copyright © 2023-… by Seth Hollingsead. All rights reserved
 */

// Internal imports
import * as plg from '../../constants/plugin.constants.js';
// External imports
import haystacks from '@haystacks/async';
import hayConst from '@haystacks/constants';
import path from 'path';

const {bas, msg, num, sys, wrd} = hayConst;
const baseFileName = path.basename(import.meta.url, path.extname(import.meta.url));
// plugins.hayD-CAF.commandsBlob.commands.dCafCommands.
const namespacePrefix = wrd.cplugins + bas.cDot + plg.cpluginName + bas.cDot + sys.ccommandsBlob + bas.cDot +
  wrd.ccommands + bas.cDot + baseFileName + bas.cDot;

/**
 * @function buildBrowserActionFunction
 * @description Creates a function that can be used to execute an action against a browser or HTML interface of some kind.
 * @param {array<string>} inputData An array that could actually contain anything,
 * depending on what the user entered. But the function filters all of that internally and
 * extracts the case the user has entered a list of meta-data that should be used for construction the browser action.
 * inputData[0] === 'buildBrowserActionFunction'
 * inputData[1] === CSS-locator
 * inputData[2] === parent
 * inputData[n] === action (default/override)
 * @param {string} inputMetaData Not used for this command.
 * @return {array<boolean,object>} An array that contains a boolean to indicate that the application should not exit,
 * and a JSON object that contains data about the object after the change was made.
 * @author Seth Hollingsead
 * @date 2023/04/06
 */
async function buildBrowserActionFunction(inputData, inputMetaData) {
  let functionName = buildBrowserActionFunction.name;
  await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
  await loggers.consoleLog(namespacePrefix + functionName, msg.cinputDataIs + JSON.stringify(inputData));
  await loggers.consoleLog(namespacePrefix + functionName, msg.cinputMetaDataIs + inputMetaData);
  let returnData = [true, {}];

  await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
  await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
  return returnData;
}

export default {
  buildBrowserActionFunction
}