@haystacks/async/test/testHarness/src/commands/clientCommandsLibrary.js

A framework to build any number or any kind of native application or automation solution.

/**
 * @file clientCommandsLibrary.js
 * @module clientCommandsLibrary
 * @description Contains all of the client defined commands as a map between function names and function calls.
 * @requires module:applicationSystem
 * @requires module:applicationTest
 * @requires module:clientCommands
 * @requires module:application.command.constants
 * @requires module:application.function.constants
 * @author Seth Hollingsead
 * @date 2022/02/07
 * @copyright Copyright © 2022-… by Seth Hollingsead. All rights reserved
 */

// Internal imports
import applicationSystem from './clientCommands/applicationSystem.js';
import applicationTest from './clientCommands/applicationTests.js';
import clientCommands from './clientCommands/clientCommands.js';
import * as app_cmd from '../constants/application.command.constants.js';

/**
 * @function initClientCommandsLibrary
 * @description Initializes an object map of client commands and client function calls and returns them.
 * @return {object} A JSON object that contains a list of business rule names and their associated function calls.
 * @author Seth Hollingsead
 * @date 2022/02/08
 * @NOTE Please be aware that the Commands and BusinessRules data fields in the
 * D-data structure are going to display as empty when printing out the D-data structure even when using JSON.stringify().
 * This is because the functions cannot really be serialized in any way. It actually kind of makes sense,
 * but could be really confusing if you are struggling, trying to debug commands or business rules that do not appear to exist.
 */
const initClientCommandsLibrary = function() {
  return {
    // Client commands
    // ***********************************************
    // application system commands in order
    // ***********************************************
    [app_cmd.capplicationHelp]: (inputData, inputMetaData) => applicationSystem.applicationHelp(inputData, inputMetaData),
    [app_cmd.capplicationWorkflowHelp]: (inputData, inputMetaData) => applicationSystem.applicationWorkflowHelp(inputData, inputMetaData),

    // ***********************************************
    // application test commands in order
    // ***********************************************
    [app_cmd.cvalidateApplicationConstants]: (inputData, inputMetaData) => applicationTest.validateApplicationConstants(inputData, inputMetaData),
    [app_cmd.cvalidateApplicationCommandAliases]: (inputData, inputMetaData) => applicationTest.validateApplicationCommandAliases(inputData, inputMetaData),
    [app_cmd.cvalidateApplicationWorkflows]: (inputData, inputMetaData) => applicationTest.validateApplicationWorkflows(inputData, inputMetaData),
    [app_cmd.callApplicationValidations]: (inputData, inputMetaData) => applicationTest.allApplicationValidations(inputData, inputMetaData),

    // ***********************************************
    // client commands in order
    // ***********************************************
    [app_cmd.ccustomEchoCommand]: (inputData, inputMetaData) => clientCommands.customEchoCommand(inputData, inputMetaData),
    [app_cmd.cbossPanic]: (inputData, inputMetaData) => clientCommands.bossPanic(inputData, inputMetaData),
    [app_cmd.ccommand01]: (inputData, inputMetaData) => clientCommands.clientCommand01(inputData, inputMetaData),
    [app_cmd.ccommand02]: (inputData, inputMetaData) => clientCommands.clientCommand02(inputData, inputMetaData),
    [app_cmd.ccommand03]: (inputData, inputMetaData) => clientCommands.clientCommand03(inputData, inputMetaData),
    [app_cmd.ccommand04]: (inputData, inputMetaData) => clientCommands.clientCommand04(inputData, inputMetaData),
    [app_cmd.ccommand05]: (inputData, inputMetaData) => clientCommands.clientCommand05(inputData, inputMetaData),
    [app_cmd.ccommand06]: (inputData, inputMetaData) => clientCommands.clientCommand06(inputData, inputMetaData),
    [app_cmd.ccommand07]: (inputData, inputMetaData) => clientCommands.clientCommand07(inputData, inputMetaData),
    [app_cmd.ccommand08]: (inputData, inputMetaData) => clientCommands.clientCommand08(inputData, inputMetaData),
    [app_cmd.ccommand09]: (inputData, inputMetaData) => clientCommands.clientCommand09(inputData, inputMetaData),
    [app_cmd.ccommand10]: (inputData, inputMetaData) => clientCommands.clientCommand10(inputData, inputMetaData)
  };
};

export default {
  initClientCommandsLibrary
};