@rockcarver/frodo-cli 0.11.1-2 → 0.12.2-1

package/CHANGELOG.md

@@ -7,11 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.2-1] - 2022-08-27
+
+## [0.12.2-0] - 2022-08-27
+
+## [0.12.1] - 2022-08-27
+
+### Changed
+
+-   \#3: `frodo-cli` now uses the new callback based progress indicator and message display framework in `frodo-lib 0.12.0`
+
+## [0.12.0] - 2022-08-27 [YANKED]
+
 ## [0.11.1-2] - 2022-08-21
 
+### Fixed
+
+-   rockcarver/frodo#389: Exporting of empty scripts now works properly
+
 ## [0.11.1-1] - 2022-08-21
 
-## [0.11.1-0] - 2022-08-19
+### Added
+
+-   Frodo CLI is now effectively using Frodo Library for all functionality except CLI.
+    -   This changes has no effect on users using frodo binaries except for the download location of those binaries, which has now shifted to the [frodo-cli](https://github.com/rockcarver/frodo-cli) repo [release section](https://github.com/rockcarver/frodo-cli/releases).
+    -   This change does affect users who run Frodo in `Developer Mode`. The exact effects and required actions are not yet fully documented and understood.
+    -   This change does not effect the installation/update/usage process of users running the Frodo CLI NPM package. However, under the surface there is a big change in that the [Frodo CLI (@rockcarver/frodo-cli)](https://www.npmjs.com/package/@rockcarver/frodo-cli) package is now built on the new [Frodo Library (@rockcarver/frodo-lib)](https://www.npmjs.com/package/@rockcarver/frodo-lib).
+
+### Changed
+
+-   The output of `frodo -v` has changed to include all three versions: cli, lib, and node:
+    ```console
+    % frodo -v
+    cli: v0.11.1-1
+    lib: v0.11.1-6
+    node: v18.7.0
+    ```
+
+## [0.11.1-0] - 2022-08-19 [YANKED]
 
 ## [0.10.4] - 2022-08-13
 
@@ -408,7 +441,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Fixed problem with adding connection profiles
 -   Miscellaneous bug fixes
 
-[Unreleased]: https://github.com/rockcarver/frodo-cli/compare/v0.11.1-2...HEAD
+[Unreleased]: https://github.com/rockcarver/frodo-cli/compare/v0.12.2-1...HEAD
+
+[0.12.2-1]: https://github.com/rockcarver/frodo-cli/compare/v0.12.2-0...v0.12.2-1
+
+[0.12.2-0]: https://github.com/rockcarver/frodo-cli/compare/v0.12.1...v0.12.2-0
+
+[0.12.1]: https://github.com/rockcarver/frodo-cli/compare/v0.12.0...v0.12.1
+
+[0.12.0]: https://github.com/rockcarver/frodo-cli/compare/v0.11.1-2...v0.12.0
 
 [0.11.1-2]: https://github.com/rockcarver/frodo-cli/compare/v0.11.1-1...v0.11.1-2
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rockcarver/frodo-cli",
-  "version": "0.11.1-2",
+  "version": "0.12.2-1",
   "type": "module",
   "description": "A command line interface to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.",
   "keywords": [
@@ -80,24 +80,12 @@
   },
   "dependencies": {
     "@colors/colors": "^1.5.0",
-    "@rockcarver/frodo-lib": "^0.11.1-7",
-    "axios": "^0.27.2",
-    "axios-retry": "^3.3.1",
+    "@rockcarver/frodo-lib": "~0.12.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"
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.18.9",

package/src/cli/cmd_common.js

@@ -1,5 +1,18 @@
 import { Argument, Option } from 'commander';
+import { state } from '@rockcarver/frodo-lib';
+
 import * as global from '../storage/StaticStorage.js';
+import {
+  printMessage,
+  createProgressIndicator,
+  updateProgressIndicator,
+  stopProgressIndicator,
+} from '../utils/Console.js';
+
+state.default.session.setPrintHandler(printMessage);
+state.default.session.setCreateProgressHandler(createProgressIndicator);
+state.default.session.setUpdateProgressHandler(updateProgressIndicator);
+state.default.session.setStopProgressHandler(stopProgressIndicator);
 
 const hostArgumentDescription =
   'Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.';

package/src/utils/Console.js

@@ -0,0 +1,480 @@
+import { SingleBar, Presets } from 'cli-progress';
+import { createSpinner } from 'nanospinner';
+import Table from 'cli-table3';
+// eslint-disable-next-line no-unused-vars
+import * as colors from '@colors/colors';
+import { state } from '@rockcarver/frodo-lib';
+
+/**
+ * Output a data message
+ * @param {Object} message the message
+ */
+function data(message) {
+  switch (typeof message) {
+    case 'object':
+      console.dir(message, { depth: 3 });
+      break;
+    default:
+      console.log(message);
+  }
+}
+
+/**
+ * Output a text message
+ * @param {Object} message the message
+ */
+function text(message) {
+  switch (typeof message) {
+    case 'object':
+      console.dir(message, { depth: 3 });
+      break;
+    default:
+      console.error(message);
+  }
+}
+
+/**
+ * Output an info message
+ * @param {Object} message the message
+ */
+function info(message) {
+  switch (typeof message) {
+    case 'object':
+      console.dir(message, { depth: 3 });
+      break;
+    default:
+      console.error(message.brightCyan);
+  }
+}
+
+/**
+ * Output a warn message
+ * @param {Object} message the message
+ */
+function warn(message) {
+  switch (typeof message) {
+    case 'object':
+      console.dir(message, { depth: 3 });
+      break;
+    default:
+      console.error(message.yellow);
+  }
+}
+
+/**
+ * Output an error message
+ * @param {Object} message the message
+ */
+function error(message) {
+  switch (typeof message) {
+    case 'object':
+      console.dir(message, { depth: 4 });
+      break;
+    default:
+      console.error(message.brightRed);
+  }
+}
+
+/**
+ * Prints a string message to console
+ *
+ * @param {string} message The string message to print
+ * @param {string} [type=text] "text", "info", "warn", "error" or "data". All but
+ * type="data" will be written to stderr.
+ * @param {boolean} [newline=true] Whether to add a new at the end of message
+ *
+ */
+export function printMessage(message, type = 'text', newline = true) {
+  //   if (state.default.session.getItem('scriptFriendly')) {
+  switch (type) {
+    case 'data':
+      if (newline) {
+        data(message);
+      } else {
+        process.stdout.write(message);
+      }
+      break;
+    case 'text':
+      if (newline) {
+        text(message);
+      } else {
+        process.stderr.write(message);
+      }
+      break;
+    case 'info':
+      if (newline) {
+        info(message);
+      } else {
+        process.stderr.write(message.brightCyan);
+      }
+      break;
+    case 'warn':
+      if (newline) {
+        warn(message);
+      } else {
+        process.stderr.write(message.yellow);
+      }
+      break;
+    case 'error':
+      if (newline) {
+        error(message);
+      } else {
+        process.stderr.write(message.brightRed);
+      }
+      break;
+    default:
+      if (newline) {
+        error(message);
+      } else {
+        process.stderr.write(message.bgBrightRed);
+      }
+  }
+}
+
+/**
+ * Creates a progress bar on stderr
+ *
+ * Example:
+ * [========================================] 100% | 49/49 | Analyzing journey - transactional_auth
+ *
+ * @param {Number} total The total number of entries to track progress for
+ * @param {String} message optional progress bar message
+ * @param {Object} options progress bar configuration options
+ *
+ */
+export function createProgressBar(
+  total,
+  message = null,
+  options = {
+    format: '[{bar}] {percentage}% | {value}/{total} | {data}',
+    noTTYOutput: true,
+  }
+) {
+  let opt = options;
+  if (message == null) {
+    opt = {
+      format: '[{bar}] {percentage}% | {value}/{total}',
+      noTTYOutput: true,
+    };
+  }
+  let pBar = state.default.session.getItem('progressBar');
+  if (!pBar) pBar = new SingleBar(opt, Presets.legacy); // create only when needed
+  pBar.start(total, 0, {
+    data: message,
+  });
+  state.default.session.setItem('progressBar', pBar);
+}
+
+/**
+ * Updates the progress bar by 1
+ * @param {string} message optional message to update the progress bar
+ *
+ */
+export function updateProgressBar(message = null) {
+  const pBar = state.default.session.getItem('progressBar');
+  if (message)
+    pBar.increment({
+      data: message,
+    });
+  else pBar.increment();
+}
+
+/**
+ * Stop and hide the progress bar
+ * @param {*} message optional message to update the progress bar
+ */
+export function stopProgressBar(message = null) {
+  const pBar = state.default.session.getItem('progressBar');
+  if (message)
+    pBar.update({
+      data: message,
+    });
+  pBar.stop();
+}
+
+/**
+ * Create the spinner
+ * @param {String} message optional spinner message
+ */
+export function showSpinner(message) {
+  const spinner = createSpinner(message).start();
+  state.default.session.setItem('Spinner', spinner);
+}
+
+/**
+ * Stop the spinner
+ * @param {String} message optional message to update the spinner
+ */
+export function stopSpinner(message = null) {
+  const spinner = state.default.session.getItem('Spinner');
+  if (spinner) {
+    let options = {};
+    if (message) options = { text: message };
+    spinner.stop(options);
+  }
+}
+
+/**
+ * Succeed the spinner. Stop and render success checkmark with optional message.
+ * @param {String} message optional message to update the spinner
+ */
+export function succeedSpinner(message = null) {
+  const spinner = state.default.session.getItem('Spinner');
+  if (spinner) {
+    let options = {};
+    if (message) options = { text: message };
+    spinner.success(options);
+  }
+}
+
+/**
+ * Warn the spinner
+ * @param {String} message optional message to update the spinner
+ */
+export function warnSpinner(message = null) {
+  const spinner = state.default.session.getItem('Spinner');
+  if (spinner) {
+    let options = {};
+    if (message) options = { text: message };
+    spinner.warn(options);
+  }
+}
+
+/**
+ * Fail the spinner
+ * @param {String} message optional message to update the spinner
+ */
+export function failSpinner(message = null) {
+  const spinner = state.default.session.getItem('Spinner');
+  if (spinner) {
+    let options = {};
+    if (message) options = { text: message };
+    spinner.error(options);
+  }
+}
+
+/**
+ * Spin the spinner
+ * @param {String} message optional message to update the spinner
+ */
+export function spinSpinner(message = null) {
+  const spinner = state.default.session.getItem('Spinner');
+  if (spinner) {
+    let options = {};
+    if (message) options = { text: message };
+    spinner.update(options);
+    spinner.spin();
+  }
+}
+
+export function createProgressIndicator(
+  type = 'determinate',
+  total = 0,
+  message = null
+) {
+  if (type === 'determinate') {
+    createProgressBar(total, message);
+  } else {
+    showSpinner(message);
+  }
+}
+
+export function updateProgressIndicator(message) {
+  const progressBar = state.default.session.getItem('progressBar');
+  if (!progressBar) {
+    spinSpinner(message);
+  } else {
+    updateProgressBar(message);
+  }
+}
+
+export function stopProgressIndicator(message, status = 'none') {
+  const progressBar = state.default.session.getItem('progressBar');
+  if (!progressBar) {
+    switch (status) {
+      case 'none':
+        stopSpinner(message);
+        break;
+      case 'success':
+        succeedSpinner(message);
+        break;
+      case 'warn':
+        warnSpinner(message);
+        break;
+      case 'fail':
+        failSpinner(message);
+        break;
+      default:
+        stopSpinner(message);
+        break;
+    }
+  } else {
+    stopProgressBar(message);
+  }
+}
+
+/**
+ * Create an empty table
+ * @param {[String]} head header row as an array of strings
+ * @returns {CliTable3} an empty table
+ */
+export function createTable(head) {
+  return new Table({
+    head,
+    chars: {
+      top: '',
+      'top-mid': '',
+      'top-left': '',
+      'top-right': '',
+      bottom: '',
+      'bottom-mid': '',
+      'bottom-left': '',
+      'bottom-right': '',
+      left: '',
+      'left-mid': '',
+      mid: '',
+      'mid-mid': '',
+      right: '',
+      'right-mid': '',
+    },
+    style: { 'padding-left': 0, 'padding-right': 0, head: ['brightCyan'] },
+  });
+}
+
+/**
+ * Create a new key/value table
+ * @returns {CliTable3} an empty key/value table
+ */
+export function createKeyValueTable() {
+  return new Table({
+    chars: {
+      top: '',
+      'top-mid': '',
+      'top-left': '',
+      'top-right': '',
+      bottom: '',
+      'bottom-mid': '',
+      'bottom-left': '',
+      'bottom-right': '',
+      left: '',
+      'left-mid': '',
+      mid: '',
+      'mid-mid': '',
+      right: '',
+      'right-mid': '',
+    },
+    style: { 'padding-left': 0, 'padding-right': 0 },
+    wordWrap: true,
+  });
+}
+
+/**
+ * Helper function to determine the total depth of an object
+ * @param {Object} object input object
+ * @returns {Number} total depth of the input object
+ */
+function getObjectDepth(object) {
+  return Object(object) === object
+    ? 1 + Math.max(-1, ...Object.values(object).map(getObjectDepth))
+    : 0;
+}
+
+/**
+ * Helper function to determine if an object has values
+ * @param {Object} object input object
+ * @returns {boolean} true of the object or any of its sub-objects contain values, false otherwise
+ */
+function hasValues(object) {
+  let has = false;
+  const keys = Object.keys(object);
+  for (const key of keys) {
+    if (Object(object[key]) !== object[key]) {
+      return true;
+    }
+    has = has || hasValues(object[key]);
+  }
+  return has;
+}
+
+/**
+ * Helper function (recursive) to add rows to an object table
+ * @param {Object} object object to render
+ * @param {Number} depth total depth of initial object
+ * @param {Number} level current level
+ * @param {CliTable3} table the object table to add the rows to
+ * @returns the updated object table
+ */
+function addRows(object, depth, level, table, keyMap) {
+  const space = '  ';
+  const keys = Object.keys(object);
+  for (const key of keys) {
+    if (Object(object[key]) !== object[key]) {
+      if (level === 1) {
+        table.push([
+          keyMap[key] ? keyMap[key].brightCyan : key.brightCyan,
+          object[key],
+        ]);
+      } else {
+        table.push([
+          {
+            hAlign: 'right',
+            content: keyMap[key] ? keyMap[key].gray : key.gray,
+          },
+          object[key],
+        ]);
+      }
+    }
+  }
+  for (const key of keys) {
+    if (Object(object[key]) === object[key]) {
+      // only print header if there are any values below
+      if (hasValues(object[key])) {
+        let indention = new Array(level).fill(space).join('');
+        if (level < 3) indention = `\n${indention}`;
+        table.push([
+          indention.concat(
+            keyMap[key] ? keyMap[key].brightCyan : key.brightCyan
+          ),
+          '',
+        ]);
+      }
+      // eslint-disable-next-line no-param-reassign
+      table = addRows(object[key], depth, level + 1, table, keyMap);
+    }
+  }
+  return table;
+}
+
+/**
+ * Create and populate an object table from any JSON object. Use for describe commands.
+ * @param {Object} object JSON object to create
+ * @returns {CliTable3} a table that can be printed to the console
+ */
+export function createObjectTable(object, keyMap = {}) {
+  // eslint-disable-next-line no-param-reassign
+  const depth = getObjectDepth(object);
+  // eslint-disable-next-line no-param-reassign
+  const level = 0;
+  // eslint-disable-next-line no-param-reassign
+  const table = new Table({
+    chars: {
+      top: '',
+      'top-mid': '',
+      'top-left': '',
+      'top-right': '',
+      bottom: '',
+      'bottom-mid': '',
+      'bottom-left': '',
+      'bottom-right': '',
+      left: '',
+      'left-mid': '',
+      mid: '',
+      'mid-mid': '',
+      right: '',
+      'right-mid': '',
+    },
+    style: { 'padding-left': 0, 'padding-right': 0, head: ['brightCyan'] },
+  });
+  addRows(object, depth, level + 1, table, keyMap);
+  return table;
+}