npm - @mimik/local - Versions diffs - 7.1.0 → 7.1.1 - Mend

@mimik/local 7.1.0 → 7.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/README.md +332 -223
package/dotFiles/eslint.config.js +10 -12
package/eslint.config.js +10 -6
package/index.js +358 -273
package/lib/common.js +149 -142
package/lib/helpers.js +12 -11
package/lib/rp-axios-wrapper.js +4 -4
package/lib/tasks.js +35 -55
package/manual-test/getAPI.js +2 -2
package/manual-test/testMerge.js +3 -3
package/package.json +6 -5
package/configuration/config.js +0 -57

package/index.js CHANGED Viewed

@@ -1,13 +1,10 @@
 /* eslint-disable prefer-template, no-console */
 import {
-  DEFAULT_DIRECTORY,
-  DUMMY_CUSTOMER_CODE,
-  IGNORE,
+  DEFAULT,
+  DUMMY,
   LITERAL,
   SYSTEM_NAME,
   TEST,
-  shellFile,
-  testJsonFile,
 } from './lib/common.js';
 import {
   baseUrl,
@@ -20,7 +17,7 @@ import {
   start2shell,
   write,
 } from './lib/helpers.js';
-import { dirname, join } from 'path';
+import { dirname, join } from 'node:path';
 import {
   getAPI,
   getAdminToken,
@@ -34,9 +31,9 @@ import {
   startSetup,
 } from './lib/tasks.js';
 import { commitCheckMsg } from '@mimik/git-hooks';
-import { fileURLToPath } from 'url';
+import { fileURLToPath } from 'node:url';
 import find from 'lodash.find';
-import fs from 'fs';
+import { writeFileSync } from 'node:fs';
 colors.setTheme({
   success: 'green',
@@ -59,111 +56,122 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  * or
  * import { mSTTestSetup, mSTSetup, mITTestSetup, mITSetup, testSetup, setup, dotFiles, scripts, unScripts, commitCheckMsg, start2process, testJsonFile} from '@mimik/local';
  *
- * @description Set of functions for local deployment.
+ * @description Utilities for local deployment.
  *
  * The following files are expected to exist:
- * In the directory above the server root directory: `mSTConfig.json`, `mIDConfig.json`, `mITConfig.json`,`sumoLog.json`, `kinesisLog.json`, `s3Log.json`, `customerConfig.json`, `key.json`, `locationConfig.json` are being set. If they don't exist at the launch of the script, default will be setup.
- * - for `mSTConfig.json`:
- * ``` javascript
+ *
+ * In the directory **above** the server’s root directory: `mSTConfig.json`, `mIDConfig.json`, `mITConfig.json`, `sumoLog.json`, `kinesisLog.json`, `s3Log.json`, `customerConfig.json`, `key.json`, and `locationConfig.json`. If they don’t exist when the script launches, defaults will be set up.
+ *
+ * - For `mSTConfig.json`:
+ * ```javascript
  *  {
- *    "basePath": "base path of the mST server, for example: `/mST/v1`",
- *    "protocol": "protocol for the mST server, for example: `http:`, by default `http:`",
- *    "domainName": "domain name of the mST server",
- *    "port": "port for the mST server, for example: `8025`",
- *    "passphrase": "passphrase to be used to generate public private key pair, if not present mST will user regular key",
- *    "update": "switch to indicate if mST needs to be updated, default is `false`. If the address is localhost, mST will be updated"
+ *    "basePath": "Base path of the mST server, e.g., `/mST/v1`",
+ *    "protocol": "Protocol for the mST server, e.g., `http:` (default: `http:`)",
+ *    "domainName": "Domain name of the mST server",
+ *    "port": "Port for the mST server, e.g., `8025`",
+ *    "passphrase": "Passphrase used to generate the public/private key pair; if not present, mST will use a regular key",
+ *    "update": "Whether mST should be updated (default: `false`). If the address is localhost, mST will be updated.",
  *    "admin": {
- *      "clientId": "id or the client in order to get an admin token for mST, for example: `12345`",
- *      "clientSecret": "secret of the client in order to get an admin token for mST, for example: `timeForSecret`"
+ *      "clientId": "Client ID used to obtain an mST admin token, e.g., `12345`",
+ *      "clientSecret": "Client secret used to obtain an mST admin token, e.g., `timeForSecret`"
  *    }
  *  }
  * ```
- * `domainName` must exit, and when `domainName` is equal to `localhost`, `port` must exist. When `domainName` is equal to `localhost` the `local ip` will replace `localhost`. When `domainName` is different of `localhost` the `port` will be ignored.
- * - for `mIDConfig.json`:
- * ``` javascript
+ * `domainName` must exist. When `domainName` is `localhost`, `port` must also exist. When `domainName` is `localhost`, the local IP will replace `localhost`. When `domainName` is different from `localhost`, `port` is ignored.
+ *
+ * - For `mIDConfig.json`:
+ * ```javascript
  *  {
- *    "basePath": "base path of the mID server, for example: `/mID/v1`",
- *    "protocol": "protocol for the mID server, for example: `http:`, by default `http:`",
- *    "domainName": "domain name of the mID server",
- *    "port": "port for the mST server, for example: `8015`",
+ *    "basePath": "Base path of the mID server, e.g., `/mID/v1`",
+ *    "protocol": "Protocol for the mID server, e.g., `http:` (default: `http:`)",
+ *    "domainName": "Domain name of the mID server",
+ *    "port": "Port for the mID server, e.g., `8015`",
  *    "implicit": {
- *      "key": "a key to sign and verify the signature of a use token: `timeForSecret`",
- *      "audience": "url defining the audinece used in user token: `https://mimik`"
+ *      "key": "Key to sign and verify the signature of a user token, e.g., `timeForSecret`",
+ *      "audience": "URL defining the audience used in the user token, e.g., `https://mimik`"
  *    }
  *  }
  * ```
- * Similar properties than for mSTConfig on `domainName` and `port` apply.
- * - for `mITConfig.json`:
- * ``` javascript
+ * The same `domainName`/`port` rules as in `mSTConfig.json` apply.
+ *
+ * - For `mITConfig.json`:
+ * ```javascript
  *  {
- *    "basePath": "base path of the mIT server, for example: `/mIT/v1`",
- *    "protocol": "protocol for the mIT server, for example: `http:`, by default `http:`",
- *    "domainName": "domain name of the mIT server",
- *    "port": "port for the mIT server, for example: `8050`"
+ *    "basePath": "Base path of the mIT server, e.g., `/mIT/v1`",
+ *    "protocol": "Protocol for the mIT server, e.g., `http:` (default: `http:`)",
+ *    "domainName": "Domain name of the mIT server",
+ *    "port": "Port for the mIT server, e.g., `8050`"
  *  }
  * ```
- * Similar properties than for mSTConfig on `domainName` and `port` apply.
- * - for `sumoLog.json`:
- * ``` javascript
+ * The same `domainName`/`port` rules as in `mSTConfig.json` apply.
+ *
+ * - For `sumoLog.json`:
+ * ```javascript
  *  {
  *    "<serverType>": {
- *      "url": "base URL for sumologic, for example: `https://endpoint2.collection.us2.sumologic.com/receiver/v1/http/`",
- *      "code": "code for sumologic, everything after the last / in the sumologic URL"
+ *      "url": "Base URL for Sumo Logic, e.g., `https://endpoint2.collection.us2.sumologic.com/receiver/v1/http/`",
+ *      "code": "The code for Sumo Logic (the part after the last `/` in the URL)"
  *    },
  *    "default": {
- *      "url": "base URL for sumologic, for example: `https://endpoint2.collection.us2.sumologic.com/receiver/v1/http/`",
- *      "code": "code for sumologic, everything after the last / in the sumologic URL"
+ *      "url": "Base URL for Sumo Logic, e.g., `https://endpoint2.collection.us2.sumologic.com/receiver/v1/http/`",
+ *      "code": "The code for Sumo Logic (the part after the last `/` in the URL)"
+ *    }
  *  }
  * ```
- * - for `kinesisLog.json`:
- * ``` javascript
+ *
+ * - For `kinesisLog.json`:
+ * ```javascript
  *  {
- *    "region": "region of the Kinesis implementation",
- *    "accessKeyId": "access key id of Kinesis",
- *    "secretAccessKey": "secret access key for Kinesis",
- *    "streamNameInfo": "name of the Kinesis stream for info",
- *    "streamNameError": "name of the Kinesis stream for error",
- *    "streamNameOther": "name of the Kinesis stream for all the other levels"
+ *    "region": "Region of the Kinesis implementation",
+ *    "accessKeyId": "Access key ID for Kinesis",
+ *    "secretAccessKey": "Secret access key for Kinesis",
+ *    "streamNameInfo": "Name of the Kinesis stream for info",
+ *    "streamNameError": "Name of the Kinesis stream for errors",
+ *    "streamNameOther": "Name of the Kinesis stream for all other levels"
  *  }
  * ```
- * - for `s3Log.json`:
- * ``` javascript
- * {
- *    "region": "region of the S3 implementation",
- *    "accessKeyId": "Access key id for S3",
- *    "secretAccessKey": "secret access key for S3",
- *    "bucketname": "name of the S3 bucket used to store the information",
- *    "maxEvents": "number of events buffered before sending to S3 (integer)",
- *    "timeout": "number of seconds before timeout to send to S3 (integer)",
- *    "maxSize": "max size in Bytes before sending to S3 (integer)"
- * }
+ *
+ * - For `s3Log.json`:
+ * ```javascript
+ *  {
+ *    "region": "Region of the S3 implementation",
+ *    "accessKeyId": "Access key ID for S3",
+ *    "secretAccessKey": "Secret access key for S3",
+ *    "bucketname": "Name of the S3 bucket used to store information",
+ *    "maxEvents": "Number of events buffered before sending to S3 (integer)",
+ *    "timeout": "Number of seconds before a timeout triggers sending to S3 (integer)",
+ *    "maxSize": "Maximum size in bytes before sending to S3 (integer)"
+ *  }
  * ```
+ *
  * - for `key.json`:
- * ``` javascript
- * {
- *   "bitbucket": {
- *      "username": "username to access the bitbucket account",
- *      "password": "password to access the bitbucket account"
- *   },
- *   "swaggerhub": "key to access private API on swaggerhub"
- * }
+ * ```javascript
+ *  {
+ *    "bitbucket": {
+ *      "username": "Username to access the Bitbucket account",
+ *      "password": "Password to access the Bitbucket account"
+ *    },
+ *    "swaggerhub": "Key to access private APIs on SwaggerHub"
+ *  }
  * ```
- * - for `locationConfig.json`:
- * ``` javascript
- * {
- *     "url": "url of the location provider"
- *     "key": "key to make request to the location provider"
- * }
+ *
+ * - For `locationConfig.json`:
+ * ```javascript
+ *  {
+ *    "url": "URL of the location provider",
+ *    "key": "API key used to make requests to the location provider"
+ *  }
  * ```
- * A property may be defined for each `serverType` involved. If the serverType does not exist the default will be picked.
- * - for `customerConfig.json`:
- * See `mST` `README.md` file for an example of a customer configuration. This may have to be updated to reflect the new servers.
- * - in the `local` directory of the server root directory: two files `start.json` and `testStart.json` may exit. `start.json` is used when `npm start` is executed, `testStart.json` is used when `npm test` is executed.
- * If the files don't exist `exampe-start.json` is used to create `start.json` and `testStart.json`.
- * Additionally `example-testStart.json` is used when to create `testStart.json`. The values in `example-testStart.json` take precedence over the values in `example-start.json`.
- * The configuration of these files depends on the configuration parameters of the server.
- * The following is an example of start.json file for `mIT`:
- * ``` javascript
+ *
+ * A property may be defined for each `serverType` involved. If the `serverType` does not exist, the `default` entry is used.
+ *
+ * - for `customerConfig.json`: see `mST` `README.md` file for an example of a customer configuration. This may have to be updated to reflect the new server.
+ * - In the `local` directory under the server’s root directory: two files, `start.json` and `testStart.json`, may exist. `start.json` is used when `npm start` is executed; `testStart.json` is used when `npm test` is executed.
+ * If these files don’t exist, `example-start.json` is used to create `start.json` and `testStart.json`. Additionally, `example-testStart.json` is used to create `testStart.json`; values in `example-testStart.json` take precedence over values in `example-start.json`.
+ * The configuration of these files depends on the server’s configuration parameters.
+ *
+ * Example `start.json` for `mIT`:
+ * ```javascript
  *  {
  *    "NODE_ENV": "local",
  *    "LOG_LEVEL": "debug",
@@ -176,29 +184,32 @@ const getBasePath = apiDef => apiDef.basePath || apiDef.servers[FIRST].url;
  *    "SERVER_SECURITY_SET": "off"
  *  }
  * ```
- * While all the files use the `.json` extension it is still possible to add comments `//` in the file to make the file more explicit or to remove some parameters.
- * There are reserved environment variables used by the library for configuration:
- * - `oauthImplicitNeeded`: if the service handles user token the implicit configuration is needed
- * - `mIDNeeded`: if the service has mID as a target
+ *
+ * Although all files use the `.json` extension, you may still add `//` comments to make them more explicit or to remove parameters.
+ *
+ * Reserved environment variables used by the library for configuration:
+ * - `oauthImplicitNeeded`: if the service handles user tokens, the implicit configuration is required
+ * - `mIDNeeded`: if the service targets mID
  * - `locationNeeded`: if location translation is needed
- * - `standAlone`: if the service needs to be operated without other service. If the service has targets most likely 500 errors will be generated
+ * - `standAlone`: if the service must operate without other services (if the service has targets, 500 errors are likely)
  *
- * If SERVER_ID is not set in the start.json or testStart.json file, SERVER_ID will be assigned with a uuid.v4.
+ * If `SERVER_ID` is not set in `start.json` or `testStart.json`, it will be assigned using `uuidv4`.
  *
- * For test in json file (`server-test.json`) is created in `.`.
- * This file contains informations needed to start the test:
- * ``` javascript
+ * For tests, a JSON file (`server-test.json`) is created in the project root (`.`).
+ * This file contains information needed to start the tests:
+ * ```javascript
  *  {
- *    "start": "information needed to setup the environment variables for the test",
- *    "CUSTOMER_NAME": "name of the customer to setup customer config",
- *    "CUSTOMER_CODE": "code of the customer to setup coustomer config, `not available for MST`",
- *    "BASE_PATH": "base path of the API",
- *    "MST_TOKEN": "mST admin token for creating clients, `no available in standAlone`",
- *    "ADMIN_TOKEN": "admin token of the service, `no available in standAlone`",
- *    "MID_TOKEN": "mID admin token for creating users when `authImplicitNeeded is set, `not available in standAlone`")
+ *    "start": "Information needed to set environment variables for the test",
+ *    "CUSTOMER_NAME": "Customer name used to set up customer config",
+ *    "CUSTOMER_CODE": "Customer code used to set up customer config (`not available for mST`)",
+ *    "BASE_PATH": "Base path of the API",
+ *    "MST_TOKEN": "mST admin token for creating clients (`not available in standAlone`)",
+ *    "ADMIN_TOKEN": "Admin token of the service (`not available in standAlone`)",
+ *    "MID_TOKEN": "mID admin token for creating users when `authImplicitNeeded` is set (`not available in standAlone`)"
  *  }
- *```
- * In standAlone mode the test can easily get the token using `oauth-helper-temp`.
+ * ```
+ *
+ * In `standAlone` mode, the test can obtain tokens using `oauth-helper-temp`.
  *
  */
@@ -207,7 +218,7 @@ const mSTInit = (confType) => {
   const config = init(regType, false, true);
   const start = startSetup(config, startConfig);
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT.API_DIRECTORY, config.pack.swaggerFile, config.key)
     .then((apiDefinition) => {
       console.log('- mST base url: ' + config.mSTBaseUrl.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
@@ -215,12 +226,12 @@ const mSTInit = (confType) => {
       if (confType === TEST) {
         start.CUSTOMER_NAME = SYSTEM_NAME;
         start.BASE_PATH = getBasePath(apiDefinition);
-        return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
+        return { file: DEFAULT.FILE.testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
       }
-      return { file: shellFile, content: start2shell(start), type: 'shell script' };
+      return { file: DEFAULT.FILE.shellFile, content: start2shell(start), type: 'shell script' };
     })
     .then((response) => {
-      fs.writeFileSync(response.file, response.content);
+      writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
     .catch(err => exitError(regType, err));
@@ -234,7 +245,7 @@ const mITInit = (confType) => {
   let start = startSetup(config, startConfig);
   let authorization;
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT.API_DIRECTORY, config.pack.swaggerFile, config.key)
     .then((apiDefinition) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
@@ -243,11 +254,11 @@ const mITInit = (confType) => {
         start = settingUpDummyServer(type, start.SERVER_ID, null, start);
         if (confType === TEST) {
           start.CUSTOMER_NAME = SYSTEM_NAME;
-          start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
+          start.CUSTOMER_CODE = DUMMY.CUSTOMER_CODE;
           start.BASE_PATH = getBasePath(apiDefinition);
-          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
+          return { file: DEFAULT.FILE.testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
         }
-        return { file: shellFile, content: start2shell(start), type: 'shell script' };
+        return { file: DEFAULT.FILE.shellFile, content: start2shell(start), type: 'shell script' };
       }
       return getAdminToken(
         { type: 'mST', audience: `${baseUrl('mST', regType, config.mST, LITERAL)}/clients/Generic-mST` },
@@ -274,16 +285,16 @@ const mITInit = (confType) => {
                   start.BASE_PATH = getBasePath(apiDefinition);
                   start.MST_TOKEN = authorization;
                   start.ADMIN_TOKEN = adminToken;
-                  return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
+                  return { file: DEFAULT.FILE.testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
                 }
                 if (adminToken) console.log('- admin token for the service: ' + adminToken.info);
                 console.log('- mST token: ' + authorization.info);
-                return { file: shellFile, content: start2shell(start), type: 'shell script' };
+                return { file: DEFAULT.FILE.shellFile, content: start2shell(start), type: 'shell script' };
               });
           }));
     })
     .then((response) => {
-      fs.writeFileSync(response.file, response.content);
+      writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
     .catch(err => exitError(regType, err));
@@ -301,7 +312,7 @@ const serverInit = (confType) => {
   let start = startSetup(config, startConfig);
   let authorization;
-  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT_DIRECTORY, config.pack.swaggerFile, config.key)
+  getAPI(start.SWAGGER_FILE_DIRECTORY || DEFAULT.API_DIRECTORY, config.pack.swaggerFile, config.key)
     .then((apiDefinition) => {
       console.log('- mST base url: ' + `${mSTBaseUrl}`.info);
       console.log('- mIT base url: ' + config.MITBaseUrl.info);
@@ -310,11 +321,11 @@ const serverInit = (confType) => {
         start = settingUpDummyServer(type, start.SERVER_ID, customer, start);
         if (confType === TEST) {
           start.CUSTOMER_NAME = customer.name;
-          start.CUSTOMER_CODE = DUMMY_CUSTOMER_CODE;
+          start.CUSTOMER_CODE = DUMMY.CUSTOMER_CODE;
           start.BASE_PATH = getBasePath(apiDefinition);
-          return { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
+          return { file: DEFAULT.FILE.testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
         }
-        return { file: shellFile, content: start2shell(start), type: 'shell script' };
+        return { file: DEFAULT.FILE.shellFile, content: start2shell(start), type: 'shell script' };
       }
       return getAdminToken(
         { type: 'mST', audience: `${baseUrl('mST', regType, config.mST, LITERAL)}/clients/Generic-mST` },
@@ -345,7 +356,7 @@ const serverInit = (confType) => {
                 start.BASE_PATH = getBasePath(apiDefinition);
                 start.MST_TOKEN = authorization;
                 start.ADMIN_TOKEN = adminToken;
-                const testResponse = { file: testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
+                const testResponse = { file: DEFAULT.FILE.testJsonFile, content: JSON.stringify(start2env(start), null, TAB), type: 'JSON file' };
                 if (startConfig.oauthImplicitNeeded === 'yes') {
                   return settingUpAdminClient('mID', `admin_${customer.name}_${start.NODE_ENV}_mID`, customer, start.MST_TOKEN, mSTBaseUrl)
@@ -360,12 +371,12 @@ const serverInit = (confType) => {
               }
               if (adminToken) console.log('- admin token for the service: ' + adminToken.info);
               console.log('- mST token: ' + authorization.info);
-              return { file: shellFile, content: start2shell(start), type: 'shell script' };
+              return { file: DEFAULT.FILE.shellFile, content: start2shell(start), type: 'shell script' };
             });
         });
     })
     .then((response) => {
-      fs.writeFileSync(response.file, response.content);
+      writeFileSync(response.file, response.content);
       console.log(`${regType}status: ` + 'completed'.success + ', ' + response.type.info + ' created at (' + response.file.info + ')');
     })
     .catch(err => exitError(regType, err));
@@ -373,292 +384,366 @@ const serverInit = (confType) => {
 /**
  *
- * Setup mST for test.
+ * Set up `mST` for tests.
  *
  * @function mSTTestSetup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
- * The following actions are being performed:
+ * Actions performed:
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. generate a json object stored in a file in . to enable the test
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Generate a JSON object and store it in a file in the project root (`.`) to enable tests.
  *
- * The following files are needed to perform these actions:
+ * Files required:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumoLog.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
+ * | `../sumoLog.json` | Sumologic endpoints and code
+ * | `../kinesisLog.json` | AWS Kinesis configuration
+ * | `../s3Log.json` | AWS S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/testStart.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `testStart.json`)
  */
 export const mSTTestSetup = () => mSTInit(TEST);
 /**
  *
- * Setup mST.
+ * Set up `mST`.
  *
  * @function mSTSetup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
- * The following actions are being performed:
+ * Actions performed:
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. generate a shell script in a file in . to start the server
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Generate a shell script in the project root (`.`) to start the server.
  *
- * The following files are needed to perform these actions:
+ * Files required:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumoLog.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
+ * | `../sumoLog.json` | Sumologic endpoints and code
+ * | `../kinesisLog.json` | AWS Kinesis configuration
+ * | `../s3Log.json` | AWS S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/start.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `start.json`)
  */
 export const mSTSetup = () => mSTInit();
 /**
  *
- * Setup mIT for test.
+ * Set up `mIT` for tests.
  *
  * @function mITTestSetup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
  * Two modes are available:
- * 1. stand alone
- * 2. with mST
  *
- * The environment variable STAND_ALONE will select the mode.
- * When in stand alone, the following actions are being performed:
+ * 1. Standalone
+ * 2. With mST
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for that service
- * 3. generate a JSON object store in a file under .
+ * The environment variable `STAND_ALONE` selects the mode.
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
+ * When **standalone**, the following actions are performed:
  *
- * When mST and other servers are present, the following actions are being performed:
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for the service.
+ * 3. Generate a JSON object and store it in a file under the project root (`.`).
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for mST
- * 3. register the service in mST
- * 4. register an admin client for that service in mST
- * 5. get an admin token for that service
- * 6. get an admin token for mID if needed
- * 7. generate a JSON object store in a file under .
+ * In `standAlone` mode, dependencies are not reachable and operations that contact dependencies will most likely return a 500 error.
  *
- * The following files are needed to perform these actions:
+ * When **mST and other servers are present**, the following actions are performed:
+ *
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for mST.
+ * 3. Register the service in mST.
+ * 4. Register an admin client for the service in mST.
+ * 5. Obtain an admin token for the service.
+ * 6. Obtain an admin token for mID if needed.
+ * 7. Generate a JSON object and store it in a file under the project root (`.`).
+ *
+ * Files required:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumoLog.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
+ * | `../sumoLog.json` | Sumologic endpoints and code
+ * | `../kinesisLog.json` | AWS Kinesis configuration
+ * | `../s3Log.json` | AWS S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/testStart.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `testStart.json`)
  */
 export const mITTestSetup = () => mITInit(TEST);
 /**
  *
- * Setup mIT.
+ * Set up `mIT`.
  *
  * @function mITSetup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
  * Two modes are available:
- * 1. stand alone
- * 2. with mST
  *
- * The environment variable STAND_ALONE will select the mode.
- * When in stand alone, the following actions are being performed:
+ * 1. Standalone
+ * 2. With mST
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for that service
- * 3. generate a shell script to start the server
+ * The environment variable `STAND_ALONE` selects the mode.
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
+ * When **standalone**, the following actions are performed:
  *
- * When mST is present, the following actions are being performed:
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for the service.
+ * 3. Generate a shell script in the project root (`.`) to start the server.
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for mST
- * 3. register the service in mST
- * 4. generate a shell script to start the server
+ * In `standAlone` mode, dependencies are not reachable and operations that contact dependencies will most likely return a 500 error.
  *
- * The following files are needed to perform these actions:
+ * When **mST is present**, the following actions are performed:
+ *
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for mST.
+ * 3. Register the service in mST.
+ * 4. Generate a shell script in the project root (`.`) to start the server.
+ *
+ * Files required:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumoLog.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
+ * | `../sumoLog.json` | Sumologic endpoints and code
+ * | `../kinesisLog.json` | AWS Kinesis configuration
+ * | `../s3Log.json` | AWS S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/start.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `start.json`)
  */
 export const mITSetup = () => mITInit();
 /**
  *
- * Setup a service (not mST, mIT) for test.
+ * Set up a service (not mST or mIT) for tests.
  *
  * @function testSetup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
  * Two modes are available:
- * 1. stand alone
- * 2. with mST, mID are other dependent servers
  *
- * The environment variable STAND_ALONE will select the mode.
- * When in stand alone, the following actions are being performed:
+ * 1. Standalone
+ * 2. With mST/mID and other dependent servers
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for that service
- * 3. generate a JSON object store in a file under .
+ * The environment variable `STAND_ALONE` selects the mode.
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
+ * When **standalone**, the following actions are performed:
  *
- * When mST and other servers are present, the following actions are being performed:
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for the service.
+ * 3. Generate a JSON object and store it in a file under the project root (`.`).
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for mST
- * 3. setup the customer in mST
- * 4. register the service in mST
- * 5. register an admin client for that service in mST
- * 6. get an admin token for that service
- * 7. get an admin token for mID if needed
- * 8. generate a json object store in a file under .
+ * In `standAlone` mode, dependencies are not reachable and operations that contact dependencies will most likely return a 500 error.
  *
- * The following files are needed to perform these actions:
+ * When **mST and other servers are present**, the following actions are performed:
+ *
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for mST.
+ * 3. Set up the customer in mST.
+ * 4. Register the service in mST.
+ * 5. Register an admin client for the service in mST.
+ * 6. Obtain an admin token for the service.
+ * 7. Obtain an admin token for mID if needed.
+ * 8. Generate a JSON object and store it in a file under the project root (`.`).
+ *
+ * Files required:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumoLog.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `../mIDConfig.json` | The config for mID
- * | `../customerConfig.json` | The mST customer config
- * | `./local/testStart.json` | The local configuration. If it does not exist start.json will be used and if start.json does not exist start-example.json will be used to create start.json
+ * | `../sumoLog.json` | Sumologic endpoints and code
+ * | `../kinesisLog.json` | AWS Kinesis configuration
+ * | `../s3Log.json` | AWS S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../mIDConfig.json` | mID configuration (when needed)
+ * | `../customerConfig.json` | mST customer configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/testStart.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `testStart.json`)
  */
 export const testSetup = () => serverInit(TEST);
 /**
  *
- * Setup a service (not mST, mIT).
+ * Set up a service (not mST or mIT).
  *
  * @function setup
  * @category sync
  *
  * @return `null`.
  *
- * Will exit 1 if there is an error.
+ * Exits with code `1` on error.
  *
  * Two modes are available:
- * 1. stand alone
- * 2. with mST, mID are other dependent servers
+ * 1. Standalone
+ * 2. With mST/mID and other dependent servers
  *
- * The environment variable STAND_ALONE will select the mode.
- * When in stand alone, the following actions are being performed:
+ * The environment variable `STAND_ALONE` selects the mode.
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for that service
- * 3. generate a shell script to start the server
+ * When **standalone**, the following actions are performed:
  *
- * In standAlone the dependencies will not be reachable and the operation that implies reaching dependencies will most likely generate a 500 error.
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for the service.
+ * 3. Generate a shell script to start the server.
  *
- * When mST and other servers are present, the following actions are being performed:
+ * In `standAlone` mode, dependencies are not reachable and operations that contact dependencies will most likely return a 500 error.
  *
- * 1. retrieve the API from [swaggerhub](https://app.swaggerhub.com/search?type=API&owner=mimik)
- * 2. get an admin token for mST
- * 3. setup the customer in mST
- * 4. register the service in mST
- * 5. generate a shell script to start the server
+ * When **mST and other servers are present**, the following actions are performed:
+ *
+ * 1. Retrieve the API definition from [SwaggerHub](https://app.swaggerhub.com/search?type=API&owner=mimik).
+ * 2. Obtain an admin token for mST.
+ * 3. Set up the customer in mST.
+ * 4. Register the service in mST.
+ * 5. Generate a shell script in the project root (`.`) to start the server.
  *
  * The following files are needed to perform these actions:
  *
  * | Filename | Description |
  * | -------- | ----------- |
- * | `../sumo.json` | The sumologic endpoints and code
- * | `../kinesisLog.json` | The Kinesis information
- * | `../s3Log.json` | The S3 information
- * | `../mSTConfig.json` | The config for mST
- * | `../mITConfig.json` | The config for mIT
- * | `../mIDConfig.json` | The config for mID
- * | `../customerConfig.json` | The mST customer config
- * | `./local/start.json` | The local configuration. If it does not exist start-example.json will be used to create start.json
+ * | `../sumo.json` | Sumo Logic endpoints and code
+ * | `../kinesisLog.json` | Kinesis configuration
+ * | `../s3Log.json` | S3 configuration
+ * | `../mSTConfig.json` | mST configuration
+ * | `../mITConfig.json` | mIT configuration
+ * | `../mIDConfig.json` | mID configuration (when needed)
+ * | `../customerConfig.json` | mST customer configuration
+ * | `../locationConfig.json` | Location provider URL and key (when needed)
+ * | `../key.json` | Github username and password or Swaggerhub key
+ * | `./local/start.json` | Local configuration (if it does not exist, `example-start.json` will be used to create `start.json`)
  */
 export const setup = () => serverInit();
-const rootPath = (pathName, ignore) => {
-  const rootDir = join(localDirname, '..', '..', '..');
-  if (pathName) {
-    if (ignore) return `${IGNORE}${join(rootDir, pathName)}`;
-    return join(rootDir, pathName);
-  }
-  if (ignore) return `${IGNORE}${rootDir}`;
-  return rootDir;
-};
+/**
+ *
+ * Utility to create `rule files`.
+ *
+ * @function dotFiles
+ * @category sync
+ *
+ * @return `null`.
+ *
+ * Creates the `rule files` for:
+ *
+ * - `eslint` -> `eslint.config.js`.
+ * - `c8` -> `.nycrc`
+ * - `github` -> `.gitignore`
+ *
+ * If a file already exists, it will be overwritten.
+ */
 export const dotFiles = () => {
-  write(rootPath('eslint.config.js'), read(join(localDirname, 'dotFiles', 'eslint.config.js'), INSTALL), INSTALL);
-  write(rootPath('.nycrc'), parse(read(join(localDirname, 'dotFiles', 'nycrc.json'), 'nycrc.json', INSTALL)), INSTALL, true);
-  write(rootPath('.gitignore'), read(join(localDirname, 'dotFiles', 'gitIgnore.txt'), INSTALL), INSTALL);
+  write('./eslint.config.js', read(join(localDirname, 'dotFiles', 'eslint.config.js'), INSTALL), INSTALL);
+  write('./.nycrc', parse(read(join(localDirname, 'dotFiles', 'nycrc.json'), 'nycrc.json', INSTALL)), INSTALL, true);
+  write('./.gitignore', read(join(localDirname, 'dotFiles', 'gitIgnore.txt'), INSTALL), INSTALL);
 };
+/**
+ *
+ * Utility to add `scripts` and `husky`.
+ *
+ * @function scripts
+ * @category sync
+ *
+ * @return `null`.
+ *
+ * Adds `scripts` and `husky` to `package.json`. If a script already exists, it will be overwritten.
+ */
 export const scripts = () => {
-  const packageFilename = rootPath('package.json');
-  const scriptsFile = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
-  const packageFile = parse(read(packageFilename, INSTALL), 'package.json', INSTALL);
+  const scriptsContent = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
+  const packageContent = parse(read(DEFAULT.FILE.packageFile, INSTALL), DEFAULT.FILE.packageFile, INSTALL);
-  Object.keys(scriptsFile.scripts).forEach((script) => {
-    packageFile.scripts[script] = scriptsFile.scripts[script];
+  Object.keys(scriptsContent.scripts).forEach((script) => {
+    packageContent.scripts[script] = scriptsContent.scripts[script];
   });
-  packageFile.husky = scriptsFile.husky;
-  write(packageFilename, packageFile, 'package.json', INSTALL, true);
+  packageContent.husky = scriptsContent.husky;
+  write(DEFAULT.FILE.packageFile, packageContent, DEFAULT.FILE.packageFile, INSTALL, true);
 };
+/**
+ *
+ * Utility to remove `scripts` and `husky`.
+ *
+ * @function unscripts
+ * @category sync
+ *
+ * @return `null`.
+ *
+ * Removes `scripts` and `husky` from `package.json`. Only removes the scripts that are in the script file.
+ */
 export const unScripts = () => {
-  const packageFilename = rootPath('package.json');
-  const scriptsFile = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
-  const packageFile = parse(read(packageFilename, INSTALL), 'package.json', INSTALL);
+  const scriptsContent = parse(read(join(localDirname, 'scripts.json'), INSTALL), 'scripts.json', INSTALL);
+  const packageContent = parse(read(DEFAULT.FILE.packageFile, INSTALL), DEFAULT.FILE.packageFile, INSTALL);
-  Object.keys(scriptsFile.scripts).forEach((script) => {
-    delete packageFile.scripts[script];
+  Object.keys(scriptsContent.scripts).forEach((script) => {
+    delete packageContent.scripts[script];
   });
-  delete packageFile.husky;
-  write(packageFilename, packageFile, 'package.json', INSTALL, true);
+  delete packageContent.husky;
+  write(DEFAULT.FILE.packageFile, packageContent, DEFAULT.FILE.packageFile, INSTALL, true);
 };
-export { commitCheckMsg, start2process, testJsonFile };
+/**
+ * Path to the JSON test file.
+ *
+ * @type {string}
+ */
+export const testJsonFile = DEFAULT.FILE.testJsonFile; // eslint-disable-line prefer-destructuring
+/**
+ *
+ * Check the validity of the commit message.
+ *
+ * @function commitCheckMsg
+ * @category async
+ * @return {Promise}.
+ * @fulfil `null`.
+ *
+ * Exits with code `1` if the commit message is not correct or if the branch is not a Jira generated branch.
+ */
+export { commitCheckMsg };
+/**
+ *
+ * Set up the environment variables based on given JSON object.
+ *
+ * @function start2process
+ * @category sync
+ * @param {object} start - JSON object that is used to configure the environment variables. The comments (starting by //) are ignored.
+ * @return `null`.
+ */
+export { start2process };
 export default {
   commitCheckMsg,