@rockcarver/frodo-lib 0.11.0

package/docs/CONTRIBUTE.md

@@ -0,0 +1,96 @@
+# Contribute to frodo
+Any direct commits to the repository are not allowed. Pull requests (PR) are most welcome. Please fork this repo and develop and test in that fork. Once you feel ready, please create a PR. For any major changes, please open an [issue](https://github.com/rockcarver/frodo/issues) first to discuss what and why you'd like to change.
+
+## Developing
+### Forking this repo
+Please refer to these couple of excellent resources for getting started with forking the repo and contributing to github open source projects in general. These are great reads not only for someone new to this, even regular github contributors may find some great tidbits of information.
+
+- [https://github.com/firstcontributions/first-contributions](https://github.com/firstcontributions/first-contributions)
+Also take a look at [Additional material](https://github.com/firstcontributions/first-contributions/blob/master/additional-material/git_workflow_scenarios/additional-material.md) towards the end, as there are some good tips on that page.
+
+OR
+
+- [https://www.dataschool.io/how-to-contribute-on-github/](https://www.dataschool.io/how-to-contribute-on-github/)
+
+### Prerequisites
+- Node.js 18 (used by developers) or newer
+- npm (included with Node.js)
+- A GUI editor is highly recommended. The current developers use [VSCode](https://code.visualstudio.com/), but you are welcome to others, like [Atom](https://atom.io/) or [Sublime](https://www.sublimetext.com/) too. The repository contains configuration files for VSCode's [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [prettier](https://prettier.io/) add-ons, which will automatically lint the code and apply coding styles when using VSCode. The same files may work for other editors with similar add-ons, but this has not been tested.
+
+### Build
+To build locally we need to do a couple of extra steps due to a limitation with the `pkg` module we're using to distribute binaries. `pkg` [doesn't support ES6](https://github.com/vercel/pkg/issues/1291) modules as of yet, so we have to transpile to commonJS then build.
+
+There should be a `dist` folder when you cloned the repo from Github, the binaries will get pushed there. We're using a `gulp` script to transpile ES6 module to commonJS and then `pkg` can create the binary for the respective OS. For Mac OS you'll have to sign the binary
+
+#### For windows and Linux
+
+```console
+cd $HOME/frodo
+npm install
+npm install -g pkg gulp
+gulp
+cd ./dist
+npm i
+#For Windows
+pkg -C Gzip -t node16-win-x64 --out-path bin/win .
+#For Linux
+pkg -C Gzip -t node16-linux-x64 --out-path bin/linux .
+```
+
+#### For MacOS
+
+For MacOS we need to sign the binaries with an Apple Developer Cert.
+
+```console
+# create variables
+CERTIFICATE_PATH=<YOUR_CERTIFICATE_PATH>
+INTERMEDIATE_CERTIFICATE_PATH=<YOUR_INTERMEDIATE_CERTIFICATE_PATH>
+KEYCHAIN_PATH=<YOUR_TEMP_KEYCHAIN_PATH>
+KEYCHAIN_PASSWORD=<KEY_CHAIN_PASSWORD>
+DEVELOPMENT_CERTIFICATE_PASSPHRASE=<YOUR_CERT_PASSPHRASE>
+
+#create temp keychain
+security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
+security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
+
+#import certs to keychain
+security import $CERTIFICATE_PATH -P "$DEVELOPMENT_CERTIFICATE_PASSPHRASE" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+security import $INTERMEDIATE_CERTIFICATE_PATH -P "$DEVELOPMENT_CERTIFICATE_PASSPHRASE" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+security list-keychain -d user -s $KEYCHAIN_PATH
+
+# import certificate to keychain
+security import $CERTIFICATE_PATH -P "$DEVELOPMENT_CERTIFICATE_PASSPHRASE" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+security import $INTERMEDIATE_CERTIFICATE_PATH -P "$DEVELOPMENT_CERTIFICATE_PASSPHRASE" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
+security list-keychain -d user -s $KEYCHAIN_PATH
+
+cd $HOME/frodo
+npm install
+npm install -g pkg gulp
+gulp
+
+cd ./dist
+npm i
+pkg -C Gzip -t node16-macos-x64 --out-path bin/macos .
+
+cd ./dist/bin/macos
+codesign -f -s 'DEV_ID' --timestamp --deep frodo
+```
+
+This will build `frodo` in each local directory respective to the OS target you chose
+
+```console
+./dist/bin/linux/frodo
+./dist/bin/macos/frodo
+./dist/bin/win/frodo
+```
+
+#### Run
+
+`frodo` is self contained, statically linked, so no dependencies should be needed. It can be run as:
+
+```console
+$HOME/frodo/frodo # or the platform equivalent binary
+```
+
+We recommend sourcing, or adding it to the path if you're on windows, to make it easier to call from your terminal without switching directories

package/docs/PIPELINE.md

@@ -0,0 +1,169 @@
+# Frodo Release Pipeline
+
+The Frodo project uses a fully automated release [pipeline](../.github/workflows/pipeline.yml) based on GitHub workflows:
+
+![Frodo Release Pipeline Workflow](images/release_pipeline.png)
+
+## Releasing Frodo
+
+This information is only actionable if you are an active contributor or maintainer with appropriate access to the repository and need to understand how frodo releases work.
+
+### Every Push Triggers A Release
+
+Frodo adopted the principle of continuous integration. Therefore every push to the main branch in the [rockcarver/frodo] repository trigger the automated release pipeline.
+
+The pipeline determines the type of release - `prerelease`, `patch`, `minor`, `major` - for the push:
+
+- Scans the commit and PR comments for trigger phrases:
+  - `PATCH RELEASE` triggers a `patch` release
+  - `MINOR RELEASE` triggers a `minor` release
+  - `MAJOR RELEASE` triggers a `major` release
+  - Everything else triggers a `prerelease`
+- Bumps the version accordingly:<br>
+  `<major>`.`<minor>`.`<patch>`-`<prerelease>`
+- Updates the [changelog](../CHANGELOG.md) file in [keep a changelog](https://keepachangelog.com/en/1.0.0/) format:
+  - Creates a new release heading using the bumped version and a date stamp
+  - Moves the content of the `Unreleased` section into the new section
+  - Adds release details links
+
+❗❗❗ IMPORTANT ❗❗❗<br>
+Contributors are instructed to submit pull requests. Maintainers must make sure none of the commit comments nor the PR comment contain trigger phrases that would cause the pipeline to perform an undesired version bump and release.
+
+### Automatic Pre-Releases During Iterative Development
+
+The default release type (if no specific and exact trigger phrases are used) results in a pre-release. Pre-releases are flagged with the label `Pre-release` on the [release page](../releases) indicating to users that these releases are not considered final or complete.
+
+Pre-releases are a great way to get the latest and greatest functionality but they are not fully polished, readme and changelog might not be updated and test coverage might not be complete.
+
+### Triggering Patch, Minor, and Major Releases
+
+Maintainers must validate PRs contain an updated `Unreleased` section in the[changelog](../CHANGELOG.md) before merging any PR. Changelog entries must adhere to the [keep a changelog](https://keepachangelog.com/en/1.0.0/) format.
+
+Maintainers must use an appropriate trigger phrase (see: [Every Push Triggers A Release](#Every-Push-Triggers-A-Release)) in the PR title to trigger the appropriate automated version bump and release.
+
+❗❗❗ IMPORTANT ❗❗❗<br>
+Maintainers must adhere to the [guidelines set forth by the npm project](https://docs.npmjs.com/about-semantic-versioning#incrementing-semantic-versions-in-published-packages) to determine the appropriate release type:
+
+![NPM Versioning Guidelines](images/npm_versioning_guidelines.png)
+
+Frodo is currently in a pre-1.0.0 phase. We are striving to release 1.0.0 very soon.
+
+## Current Pipeline Explained
+
+### Trigger Event
+
+The trigger event is any `push` to the `main` branch in the repository.
+
+### Smoke Tests
+
+This step performs a quick smoke test of the vital functions like login with and without network proxy. All smoke tests must pass or pipeline execution terminates.
+
+### Update Changelog
+
+This step calculates the new version but doesn't modify `package.json` and `package-lock.json`. Based on that new version, it creates a new heading in the [CHANGELOG.md](../CHANGELOG.md) file and moves everything from the `Unreleased` section into the new version section. It also creates links to the release tags at the bottom of the [CHANGELOG.md](../CHANGELOG.md) file. Last but not least, it commits the updated [CHANGELOG.md](../CHANGELOG.md) file to the repository.
+
+#### 3rd-Party Actions
+
+-   [gh-action-bump-version](https://github.com/phips28/gh-action-bump-version): phips28/gh-action-bump-version@master
+-   [keep-a-changelog-new-release](https://github.com/thomaseizinger/keep-a-changelog-new-release): thomaseizinger/keep-a-changelog-new-release@1.3.0
+
+### Bump Version
+
+This step calculates the new version and corresponding tag, updates both [package.json](../package.json) and [package-lock.json](../package-lock.json) and commits the changes to the `main` branch.
+
+#### 3rd-Party Actions
+
+-   [gh-action-bump-version](https://github.com/phips28/gh-action-bump-version): phips28/gh-action-bump-version@master
+
+### Release Notes
+
+This step extracts the changes under the heading that matches the release version and uses it as the release notes. For pre-releases it also generates a section of changes based on commits that were part of the release.
+
+Good release notes require the contributor and/or maintainer take the time and update the [CHANGELOG.md](../CHANGELOG.md) file. Auto-generated release notes based on commit comments are less than optimal but acceptable for pre-releases.
+
+Patch, minor, and major releases require a carefully curated [CHANGELOG.md](../CHANGELOG.md) file.
+
+#### 3rd-Party Actions
+
+-   [submark](https://github.com/dahlia/submark): dahlia/submark@main
+
+
+### Release
+
+This step creates a GitHub release based on the tag created in a previous step and posts a number of artifacts:
+
+-   [CHANGELOG.md](../CHANGELOG.md)
+-   [LICENSE](../LICENSE)
+-   `Release.txt` - Generated for each release containing the git sha of the release
+-   `<tag>.zip` -  Generated for each release containing the full repository as a `.zip` archive
+-   `<tag>.tar.gz` - Generated for each release containing the full repository as a `.tar.gz` archive
+
+_Note:_ this step does not include the frodo binaries!
+
+#### 3rd-Party Actions
+
+-   [action-gh-release](https://github.com/softprops/action-gh-release): softprops/action-gh-release@v1
+
+### Binary Releases
+
+The binaries are built by GitHub runners of the same OS as the binary they are building. That allows the binaries to be executed (tested) as one of the steps in the build process.
+
+The binary builds run in parallel while all the previous steps run in sequence and must complete before the binay builds even kick off.
+
+#### Linux Binary Release
+
+This step builds the Linux binary and adds it to the release created in an earlier step.
+
+#### 3rd-Party Actions
+
+-   [action-gh-release](https://github.com/softprops/action-gh-release): softprops/action-gh-release@v1
+
+#### Mac OS Binary Release
+
+This step builds the Mac OS binary and adds it to the release created in an earlier step.
+
+#### 3rd-Party Actions
+
+-   [action-gh-release](https://github.com/softprops/action-gh-release): softprops/action-gh-release@v1
+
+#### Windows Binary Release
+
+This step builds the Windows binary and adds it to the release created in an earlier step.
+
+#### 3rd-Party Actions
+
+-   [action-gh-release](https://github.com/softprops/action-gh-release): softprops/action-gh-release@v1
+
+## Pipeline Maintenance
+
+Pipeline maintenance is a tricky business. Pipeline testing in forks is difficult because GitHub by default imposes a different behaviour for pipeline events than in the main repository. Some pipeline steps require branch names, which means the pipeline needs to be adopted to run in the fork and branch it is being tested in.
+
+All of the above has lead the team to make and test pipeline changes in the main repository on the real pipeline.
+
+### Recover From A Wrong Version Bump And Release
+
+When testing the pipeline and especially when experimenting with the automated version bump logic, it is unavoidable that once in a while a version is released that really has to be removed. E.g. during the pipeline development and testing of the first full automation, a bump to version 1.0.0 was triggered unintentionally. While minor and patch version bumps can be dealt with, major version bumps should really not be taken lightly.
+
+So to recover from that, the following needs to happen:
+
+1.  Manually delete the `faulty release` from the [release page](../releases)
+1.  Manually modify the following files in your fork:
+    -   [CHANGELOG.md](../CHANGELOG.md)
+        1.  Find the faulty release heading towards the top of the file
+            1.  Move your changelog entries in the faulty release section back into the Unreleased section
+            1.  Now remove the faulty release header
+        1.  Find the link to the faulty release tag at the bottom of the file and remove it
+    -   [package.json](../package.json)
+        -   Fine the 1 occurance of the frodo version in package.json and reset it to the `previous version` from before the faulty version bump
+    -   [package-lock.json](../package-lock.json)
+        -   Find the 2 occurances of the faulty version in package-lock.json and reset them to the `previous version` from before the faulty version bump
+1.  Commit your changes and create a new pull request
+1.  In the frodo repository, merge the PR and provide the appropriate comment to trigger the intended version bump
+1.  Remove the faulty tag from the repository:<br>
+    This is important because you cannot update an existing tag and in order to eventually release the version in the future, you must delete it first. Beware the difference between version (e.g. `1.0.0`) and tag (e.g. `v1.0.0`). This step requires you to use the tag:
+    -   From the command line, navigate to the directory where you cloned the frodo repository (_not your fork, the real one!_)
+    -   Issue the following command:<br>
+        ```
+        git push --delete origin v1.0.0
+        ```
+1. Validate the pipeline created the desired new version and release

package/jsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "target": "ES6"
+  },
+  "exclude": ["node_modules", "**/node_modules/*", "dist"]
+}

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@rockcarver/frodo-lib",
+  "version": "0.11.0",
+  "type": "module",
+  "description": "ForgeROck DO Library, frodo-lib, a library to manage ForgeRock platform deployments supporting Identity Cloud tenants, ForgeOps deployments, and classic deployments.",
+  "keywords": [
+    "forgerock",
+    "library",
+    "am",
+    "idm",
+    "forgeops",
+    "identity cloud",
+    "export",
+    "import",
+    "ci/cd",
+    "devops"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rockcarver/frodo-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rockcarver/frodo-lib/issues"
+  },
+  "main": "src/index.js",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
+    "lint": "eslint --ext .js --ignore-path .gitignore ."
+  },
+  "jest": {
+    "globalSetup": "<rootDir>/test/global/setup.js"
+  },
+  "contributors": [
+    {
+      "name": "Sandeep Chaturvedi",
+      "email": "sandeep.chaturvedi@forgerock.com"
+    },
+    {
+      "name": "Adam Crockett",
+      "email": "adam.crockett@forgerock.com"
+    },
+    {
+      "name": "Ali Falahi",
+      "email": "ali@falahi.com"
+    },
+    {
+      "name": "Joshua Sayers",
+      "email": "joshua.sayers@forgerock.com"
+    },
+    {
+      "name": "Volker Scheuber",
+      "email": "volker.scheuber@forgerock.com"
+    }
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@colors/colors": "^1.5.0",
+    "axios": "^0.27.2",
+    "axios-retry": "^3.3.1",
+    "cli-progress": "^3.11.2",
+    "cli-table3": "^0.6.2",
+    "commander": "^9.4.0",
+    "fs-extra": "^10.0.0",
+    "https-proxy-agent": "^5.0.1",
+    "lodash": "^4.17.21",
+    "nanospinner": "^1.1.0",
+    "properties-reader": "^2.2.0",
+    "qs": "^6.10.3",
+    "readline-sync": "^1.4.10",
+    "replaceall": "^0.1.6",
+    "slugify": "^1.6.5",
+    "url": "^0.11.0",
+    "uuid": "^8.3.2",
+    "yesno": "^0.4.0"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.18.9",
+    "del": "^6.0.0",
+    "eslint": "^8.21.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.4.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.8.2",
+    "eslint-plugin-jsx-a11y": "^6.6.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.29.2",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "jest": "^28.1.3",
+    "map-stream": "^0.0.7"
+  }
+}

package/resources/sampleEntitiesFile.json

@@ -0,0 +1,8 @@
+{
+  "idm": [
+    "managed",
+    "sync",
+    "provisioner.openicf.connectorinfoprovider",
+    "authentication"
+  ]
+}

package/resources/sampleEnvFile.env

@@ -0,0 +1,2 @@
+RCS_NAME=rcs1
+INTROSPECT_URL=http://am.fr-platform/am/oauth2/introspect

package/src/api/AuthenticateApi.js

@@ -0,0 +1,33 @@
+import util from 'util';
+import { generateAmApi } from './BaseApi.js';
+import storage from '../storage/SessionStorage.js';
+
+const authenticateUrlTemplate = '%s/json%s/authenticate';
+
+const apiVersion = 'resource=2.0, protocol=1.0';
+const getApiConfig = () => ({
+  apiVersion,
+});
+
+const realmPathTemplate = '/realms/%s';
+
+export function getRealmUrl(realm) {
+  let localRealm = realm;
+  if (localRealm.startsWith('/') && localRealm.length > 1) {
+    localRealm = localRealm.substring(1);
+  }
+  let realmPath = util.format(realmPathTemplate, 'root');
+  if (localRealm !== '/') {
+    realmPath += util.format(realmPathTemplate, localRealm);
+  }
+  return realmPath;
+}
+
+export async function step(data = {}, config = {}) {
+  const urlString = util.format(
+    authenticateUrlTemplate,
+    storage.session.getTenant(),
+    getRealmUrl('/')
+  );
+  return generateAmApi(getApiConfig()).post(urlString, data, config);
+}

package/src/api/BaseApi.js

@@ -0,0 +1,242 @@
+import axios from 'axios';
+import axiosRetry from 'axios-retry';
+import * as https from 'https';
+import HttpsProxyAgent from 'https-proxy-agent';
+import url from 'url';
+import fs from 'fs';
+import storage from '../storage/SessionStorage.js';
+import { getTenantURL } from './utils/ApiUtils.js';
+// import pkg from '../../package.json' assert { type: 'json' };
+
+const pkg = JSON.parse(
+  fs.readFileSync(new URL('../../package.json', import.meta.url))
+);
+
+axiosRetry(axios, {
+  retries: 3,
+  shouldResetTimeout: true,
+  // eslint-disable-next-line no-unused-vars
+  retryCondition: (_error) => true, // retry no matter what
+});
+
+const timeout = 30000;
+const userAgent = `${pkg.name}/${pkg.version}`;
+let httpsAgent;
+
+/**
+ * Helper method to create properly configured httpsAgent
+ * @returns {any} appropriate httpsAgent
+ */
+function getHttpsAgent() {
+  if (httpsAgent) return httpsAgent;
+  const options = {
+    rejectUnauthorized: !storage.session.getAllowInsecureConnection(),
+  };
+  const httpsProxy = process.env.HTTPS_PROXY || process.env.https_proxy;
+  if (httpsProxy) {
+    // https://github.com/axios/axios/issues/3459
+    console.error(`Using proxy ${httpsProxy}`.yellow);
+    const parsed = url.parse(httpsProxy);
+    options.host = parsed.hostname;
+    options.port = parsed.port;
+    options.protocol = parsed.protocol;
+    options.rejectUnauthorized = !storage.session.getAllowInsecureConnection();
+    httpsAgent = new HttpsProxyAgent(options);
+    return httpsAgent;
+  }
+  httpsAgent = new https.Agent(options);
+  return httpsAgent;
+}
+
+function getProxy() {
+  if (process.env.HTTPS_PROXY || process.env.https_proxy) return false;
+  return null;
+}
+
+/**
+ * Generates an AM Axios API instance
+ * @param {object} resource Takes an object takes a resource object. example:
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either
+ * add on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateAmApi(resource, requestOverride = {}) {
+  let headers = {
+    'User-Agent': userAgent,
+    'Content-Type': 'application/json',
+    'Accept-API-Version': resource.apiVersion,
+    Cookie: `${storage.session.raw.cookieName}=${storage.session.raw.cookieValue}`,
+  };
+  if (requestOverride.headers) {
+    headers = {
+      ...headers,
+      ...requestOverride.headers,
+    };
+  }
+
+  const requestDetails = {
+    baseURL: `${storage.session.getTenant()}/json${resource.path}`,
+    timeout,
+    ...requestOverride,
+    headers,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}
+
+/**
+ * Generates an OAuth2 Axios API instance
+ * @param {object} resource Takes an object takes a resource object. example:
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either
+ * add on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateOauth2Api(resource, requestOverride = {}) {
+  let headers = {
+    'User-Agent': userAgent,
+    'Accept-API-Version': resource.apiVersion,
+    Cookie: `${storage.session.raw.cookieName}=${storage.session.raw.cookieValue}`,
+  };
+  if (requestOverride.headers) {
+    headers = {
+      ...headers,
+      ...requestOverride.headers,
+    };
+  }
+
+  const requestDetails = {
+    baseURL: `${storage.session.getTenant()}/json${resource.path}`,
+    timeout,
+    ...requestOverride,
+    headers,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}
+
+/**
+ * Generates an IDM Axios API instance
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either add
+ * on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateIdmApi(requestOverride = {}) {
+  const requestDetails = {
+    baseURL: getTenantURL(storage.session.getTenant()),
+    timeout,
+    headers: {
+      'User-Agent': userAgent,
+      'Content-Type': 'application/json',
+    },
+    ...requestOverride,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  if (storage.session.getBearerToken()) {
+    requestDetails.headers.Authorization = `Bearer ${storage.session.getBearerToken()}`;
+  }
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}
+
+/**
+ * Generates a LogKeys API Axios instance
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either add
+ * on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateLogKeysApi(requestOverride = {}) {
+  const headers = {
+    'User-Agent': userAgent,
+    'Content-Type': 'application/json',
+  };
+  const requestDetails = {
+    baseURL: getTenantURL(storage.session.getTenant()),
+    timeout,
+    headers,
+    ...requestOverride,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  if (storage.session.getBearerToken()) {
+    requestDetails.headers.Authorization = `Bearer ${storage.session.getBearerToken()}`;
+  }
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}
+
+/**
+ * Generates a Log API Axios instance
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either add
+ * on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateLogApi(requestOverride = {}) {
+  const headers = {
+    'User-Agent': userAgent,
+    'X-API-Key': storage.session.getLogApiKey(),
+    'X-API-Secret': storage.session.getLogApiSecret(),
+  };
+  const requestDetails = {
+    baseURL: getTenantURL(storage.session.getTenant()),
+    timeout,
+    headers,
+    ...requestOverride,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}
+
+/**
+ * Generates an ESV Axios API instance for Environment Secrets and Variables
+ * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either add
+ * on extra information or override default properties https://github.com/axios/axios#request-config
+ *
+ * @returns {AxiosInstance}
+ */
+export function generateESVApi(resource, requestOverride = {}) {
+  const headers = {
+    'User-Agent': userAgent,
+    'Content-Type': 'application/json',
+    'Accept-API-Version': resource.apiVersion,
+  };
+  const requestDetails = {
+    baseURL: getTenantURL(storage.session.getTenant()),
+    timeout,
+    headers,
+    ...requestOverride,
+    httpsAgent: getHttpsAgent(),
+    proxy: getProxy(),
+  };
+
+  if (storage.session.getBearerToken()) {
+    requestDetails.headers.Authorization = `Bearer ${storage.session.getBearerToken()}`;
+  }
+
+  const request = axios.create(requestDetails);
+
+  return request;
+}