hayd-caf
Version:
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
204 lines (177 loc) • 10.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: brokers/dataBroker.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: brokers/dataBroker.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* @file dataBroker.js
* @module dataBroker
* @description Contains middle or low-level data management functions.
* @requires module:plugin.constants
* @requires module:loggers
* @requires module:pluginData
* @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';
import loggers from '../executrix/loggers.js';
import D from '../structures/pluginData.js';
// External imports
import haystacks from '@haystacks/async';
import hayConst from '@haystacks/constants';
import path from 'path';
const {bas, cfg, msg, sys, wrd} = hayConst;
const baseFileName = path.basename(import.meta.url, path.extname(import.meta.url));
// plugins.hayD-CAF.brokers.dataBroker.
const namespacePrefix = wrd.cplugins + bas.cDot + plg.cpluginName + bas.cDot + wrd.cbrokers + bas.cDot + baseFileName + bas.cDot;
/**
* @function initData
* @description Initialize the data that will be used by
* the plugin to load all of the plugin content and export it to the Haystacks platform.
* @return {void}
* @author Seth Hollingsead
* @date 2023/04/03
*/
async function initData() {
// let functionName = initData.name;
// await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
D.data = {}; // Make sure it's initialized, should have been done when we called import above.
// await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
}
/**
* @function loadConfigData
* @description Calls the Haystacks platform to load the configuration data, parse it and return it as a JSON object.
* @param {string} configPath The path to the plugin configuration data that must be loaded.
* @return {object} A JSON object that contains all of the configuration data loaded and parsed from the specified path.
* @author Seth Hollingsead
* @date 2023/04/03
*/
async function loadConfigData(configPath) {
// let functionName = loadConfigData.name;
// await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
// configPath is:
// await loggers.consoleLog(namespacePrefix + functionName, msg.cconfigPathIs + configPath);
let returnData = {};
// NOTE: This is the first call back to Haystacks to load data,
// we will need to pass the Haystacks data back into this instance of Haystacks before we try to call it to get it to do any kind of work.
if (D[wrd.cdata]) {
if (D[wrd.cdata][cfg.chaystacksContextObject]) {
if (await haystacks.accouterFramework(D[wrd.cdata][cfg.chaystacksContextObject]) === true) {
// Done loading the Haystacks dependency data, now try and use Haystacks to load the config data, from the configPath.
// await loggers.consoleLog(namespacePrefix + functionName, msg.cpluginLoadConfigDataMessage);
returnData = await haystacks.loadPluginResourceData(wrd.cconfiguration, configPath);
} else {
// FATAL ERROR: Unable to load the specified plugin config path, Haystacks framework data dependency failure:
console.log(msg.cloadConfigDataErrorMessage01 + configPath);
}
} else {
// FATAL ERROR: Unable to load the specified plugin, no config data for the plugin:
console.log(msg.cloadConfigDataErrorMessage02);
}
} else {
// FATAL ERROR: Unable to load the specified plugin, no config data for the plugin:
console.log(msg.cloadConfigDataErrorMessage03 + configPath);
}
// await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
// await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
return returnData;
}
/**
* @function loadCommandAliasesData
* @description Loads the plugin command aliases data by calling the Haystacks platform to
* load and parse the command aliases data from the specified path.
* @param {string} aliasesPath The fully qualified path to the command aliases folder with all of the command aliases data for the plugin.
* @return {object} A JSON object that contains all of the command aliases data loaded and parsed from the specified path.
* @author Seth Hollingsead
* @date 2023/04/03
*/
async function loadCommandAliasesData(aliasesPath) {
// let functionName = loadCommandAliasesData.name;
// await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
// aliasesPath is:
// await loggers.consoleLog(namespacePrefix + functionName, msg.caliasesPathIs + aliasesPath);
let returnData = {};
returnData = await haystacks.loadPluginResourceData(wrd.ccommand + wrd.cAliases, aliasesPath);
// await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
// await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
return returnData;
}
/**
* @function loadWorkflowsData
* @description Loads the plugin workflows data by calling the Haystacks platform to
* load and parse the workflows data from the specified path.
* @param {string} workflowsPath The fully qualified path to the workflows folder with all of the workflows data for the plugin.
* @return {object} A JSON object that contains all of the workflows data loaded and parsed from the specified path.
* @author Seth Hollingsead
* @date 2023/04/03
*/
async function loadWorkflowsData(workflowsPath) {
// let functionName = loadWorkflowsData.name;
// await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
// workflowsPath is:
// await loggers.consoleLog(namespacePrefix + functionName, msg.cworkflowsPathIs + workflowsPath);
let returnData = {};
returnData = await haystacks.loadPluginResourceData(wrd.cworkflows, workflowsPath);
// await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
// await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
return returnData;
}
/**
* @function loadThemesData
* @description Loads the plugin themes data by calling the Haystacks platform to
* load and parse the themes data from the specified path.
* @param {string} themesPath The fully qualified path to the themes folder with all of the themes data for the plugin.
* @return {object} A JSON object that contains all of the themes paths data loaded and parsed from the specified path.
* @author Seth Hollingsead
* @date 2023/04/03
*/
async function loadThemesData(themesPath) {
// let functionName = loadThemesData.name;
// await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
// themesPath is:
// await loggers.consoleLog(namespacePrefix + functionName, msg.cthemesPathIs + themesPath);
let returnData = {};
returnData = await haystacks.loadPluginResourceData(wrd.cthemes, themesPath);
// await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
// await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
return returnData;
}
export default {
initData,
loadConfigData,
loadCommandAliasesData,
loadWorkflowsData,
loadThemesData
};</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-allPluginConstantsValidationMetadata.html">allPluginConstantsValidationMetadata</a></li><li><a href="module-chiefCommander.html">chiefCommander</a></li><li><a href="module-chiefConfiguration.html">chiefConfiguration</a></li><li><a href="module-chiefData.html">chiefData</a></li><li><a href="module-chiefRules.html">chiefRules</a></li><li><a href="module-chiefTheme.html">chiefTheme</a></li><li><a href="module-chiefWorkflow.html">chiefWorkflow</a></li><li><a href="module-commandBroker.html">commandBroker</a></li><li><a href="module-commandsLibrary.html">commandsLibrary</a></li><li><a href="module-dCafCommands.html">dCafCommands</a></li><li><a href="module-dataBroker.html">dataBroker</a></li><li><a href="module-loggers.html">loggers</a></li><li><a href="module-main.html">main</a></li><li><a href="module-pluginData.html">pluginData</a></li><li><a href="module-ruleBroker.html">ruleBroker</a></li><li><a href="module-rulesLibrary.html">rulesLibrary</a></li><li><a href="module-selectorConstruction.html">selectorConstruction</a></li><li><a href="module-warden.html">warden</a></li><li><a href="plugin.business.constants.module_validation.html">plugin.business.constants.validation</a></li><li><a href="plugin.business.module_constants.html">plugin.business.constants</a></li><li><a href="plugin.command.constants.module_validation.html">plugin.command.constants.validation</a></li><li><a href="plugin.command.module_constants.html">plugin.command.constants</a></li><li><a href="plugin.constants.module_validation.html">plugin.constants.validation</a></li><li><a href="plugin.message.constants.module_validation.html">plugin.message.constants.validation</a></li><li><a href="plugin.message.module_constants.html">plugin.message.constants</a></li><li><a href="plugin.module_constants.html">plugin.constants</a></li><li><a href="plugin.system.constants.module_validation.html">plugin.system.constants.validation</a></li><li><a href="plugin.system.module_constants.html">plugin.system.constants</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Apr 28 2023 18:01:37 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>