@rockcarver/frodo-cli 0.13.3 → 0.14.1

package/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.14.1] - 2022-10-03
+
+### Fixed
+
+-   \#66: Removed unnecessary files from npm package
+
+## [0.14.0] - 2022-10-03
+
+### Changed
+
+-   Updated frodo-lib to 0.12.7
+-   Changes to `frodo journey describe` command:
+    -   Added journey status (enabled/disabled)
+    -   Added journey/node classification:
+        Classifications are shown for the whole journey and for each node type and node, making it easy to determine why a journey is classified a certain way.
+        -   `standard`: can run on any instance of a ForgeRock platform
+        -   `cloud`: utilize nodes, which are exclusively available in the ForgeRock Identity Cloud
+        -   `premium`: utilizes nodes, which come at a premium
+        -   `custom`: utilizes nodes not included in the ForgeRock platform release
+    -   Added journey categories/tags
+    -   Added consideration of version from export file meta data when using `-f [file]` option to describe a juorney export
+    -   Added `-o`/`--override-version` parameter. Notation: `major.minor.patch` e.g. `7.2.0`. Override detected version with any version. This is helpful in order to check if journeys in one environment would be compatible running in another environment (e.g. in preparation of migrating from on-prem to ForgeRock Identity Cloud.
+-   \#59: Converted frodo-cli to TypeScript
+
 ## [0.13.3] - 2022-09-30
 
 ### Added
@@ -570,7 +594,11 @@ 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.13.3...HEAD
+[Unreleased]: https://github.com/rockcarver/frodo-cli/compare/v0.14.1...HEAD
+
+[0.14.1]: https://github.com/rockcarver/frodo-cli/compare/v0.14.0...v0.14.1
+
+[0.14.0]: https://github.com/rockcarver/frodo-cli/compare/v0.13.3...v0.14.0
 
 [0.13.3]: https://github.com/rockcarver/frodo-cli/compare/v0.13.2...v0.13.3
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rockcarver/frodo-cli",
-  "version": "0.13.3",
+  "version": "0.14.1",
   "type": "module",
   "description": "A command line interface to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.",
   "keywords": [
@@ -27,14 +27,17 @@
   "bugs": {
     "url": "https://github.com/rockcarver/frodo-cli/issues"
   },
-  "main": "src/app.js",
+  "main": "esm/app.js",
   "scripts": {
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test": "npx tsc && node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:list": "node --experimental-vm-modules node_modules/jest/bin/jest.js --listTests",
     "test:e2e": "node --experimental-vm-modules node_modules/jest/bin/jest.js --runInBand e2e",
     "test:e2e:list": "node --experimental-vm-modules node_modules/jest/bin/jest.js --listTests e2e",
     "lint": "npx eslint --ext .js --ignore-path .gitignore .",
-    "build": "npx gulp"
+    "build": "npx gulp",
+    "build:local": "npx gulp build-local",
+    "build:binary": "npx gulp build-binary",
+    "watch": "npx gulp watch"
   },
   "contributors": [
     {
@@ -60,7 +63,7 @@
   ],
   "license": "MIT",
   "bin": {
-    "frodo": "./src/app.js"
+    "frodo": "./esm/app.js"
   },
   "babel": {
     "plugins": [
@@ -84,10 +87,10 @@
     ]
   },
   "dependencies": {
-    "@colors/colors": "^1.5.0",
-    "@rockcarver/frodo-lib": "0.12.6",
+    "@rockcarver/frodo-lib": "0.12.7",
     "cli-progress": "^3.11.2",
     "cli-table3": "^0.6.2",
+    "colors": "^1.4.0",
     "commander": "^9.4.0",
     "nanospinner": "^1.1.0",
     "uuid": "^8.3.2",
@@ -97,6 +100,9 @@
     "@babel/eslint-parser": "^7.18.9",
     "@babel/plugin-syntax-import-assertions": "^7.16.7",
     "@babel/plugin-transform-modules-commonjs": "^7.16.8",
+    "@babel/preset-env": "^7.19.3",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/colors": "^1.2.1",
     "babel-plugin-transform-import-meta": "^2.1.1",
     "del": "^6.0.0",
     "eslint": "^8.21.0",
@@ -111,6 +117,7 @@
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-install": "^1.1.0",
+    "gulp-rename": "^2.0.0",
     "gulp-sourcemaps": "^3.0.0",
     "jest": "^28.1.3",
     "map-stream": "^0.0.7",

package/src/app.js

@@ -1,63 +0,0 @@
-#!/usr/bin/env -S node --no-warnings --enable-source-maps --experimental-specifier-resolution=node
-
-import { getVersion, ConnectionProfile } from '@rockcarver/frodo-lib';
-import fs from 'fs';
-import { Command } from 'commander';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-// commands
-import admin from './cli/admin/admin.js';
-import app from './cli/app/app.js';
-import conn from './cli/conn/conn.js';
-import email from './cli/email/email.js';
-import esv from './cli/esv/esv.js';
-import idm from './cli/idm/idm.js';
-import idp from './cli/idp/idp.js';
-import info from './cli/info/info.js';
-import journey from './cli/journey/journey.js';
-import logging from './cli/logging/logs.js';
-import realm from './cli/realm/realm.js';
-import saml from './cli/saml/saml.js';
-import script from './cli/script/script.js';
-import theme from './cli/theme/theme.js';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-const pkg = JSON.parse(
-  fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8')
-);
-
-const { initConnectionProfiles } = ConnectionProfile;
-
-const program = new Command('frodo').version(
-  `cli: v${pkg.version}\nlib: ${getVersion()}\nnode: ${process.version}`,
-  '-v, --version'
-);
-
-(async () => {
-  try {
-    initConnectionProfiles();
-
-    program.addCommand(admin());
-    program.addCommand(app());
-    program.addCommand(conn());
-    program.addCommand(email());
-    program.addCommand(esv());
-    program.addCommand(idm());
-    program.addCommand(idp());
-    program.addCommand(info());
-    program.addCommand(journey());
-    program.addCommand(logging());
-    program.addCommand(realm());
-    program.addCommand(saml());
-    program.addCommand(script());
-    program.addCommand(theme());
-
-    program.showHelpAfterError();
-    program.enablePositionalOptions();
-    program.parse();
-  } catch (e) {
-    console.log(`ERROR: exception running frodo - ${e}`, 'error');
-  }
-})();

package/src/cli/_template/cmd-delete.js

@@ -1,56 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd delete');
-
-program
-  .description('Cmd delete.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --cmd-id <cmd-id>',
-      'Cmd id. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option('-a, --all', 'Delete all cmds in a realm. Ignored with -i.')
-  )
-  .addOption(
-    new Option(
-      '--no-deep',
-      'No deep delete. This leaves orphaned configuration artifacts behind.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--verbose',
-      'Verbose output during command execution. If specified, may or may not produce additional output.'
-    ).default(false, 'off')
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-describe.js

@@ -1,36 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd describe');
-
-program
-  .description('Cmd describe.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(new Option('-i, --cmd-id <cmd-id>', 'Cmd id.'))
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-export.js

@@ -1,54 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd export');
-
-program
-  .description('Cmd export.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --cmd-id <cmd-id>',
-      'Cmd id. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(new Option('-f, --file <file>', 'Name of the export file.'))
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Export all cmds to a single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Export all cmds to separate files (*.cmd.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-import.js

@@ -1,54 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd import');
-
-program
-  .description('Cmd import.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --cmd-id <cmd-id>',
-      'Cmd id. If specified, only one cmd is imported and the options -a and -A are ignored.'
-    )
-  )
-  .addOption(new Option('-f, --file <file>', 'Name of the file to import.'))
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Import all cmds from single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Import all cmds from separate files (*.cmd.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-list.js

@@ -1,38 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd list');
-
-program
-  .description('Cmd list.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option('-l, --long', 'Long with all fields.').default(false, 'false')
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1-delete.js

@@ -1,56 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd sub1 delete');
-
-program
-  .description('Sub1 delete.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --sub1-id <sub1-id>',
-      'Sub1 id. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option('-a, --all', 'Delete all sub1s in a realm. Ignored with -i.')
-  )
-  .addOption(
-    new Option(
-      '--no-deep',
-      'No deep delete. This leaves orphaned configuration artifacts behind.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--verbose',
-      'Verbose output during command execution. If specified, may or may not produce additional output.'
-    ).default(false, 'off')
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1-describe.js

@@ -1,36 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd sub1 describe');
-
-program
-  .description('Sub1 describe.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(new Option('-i, --sub1-id <sub1-id>', 'Sub1 id.'))
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1-export.js

@@ -1,54 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd sub1 export');
-
-program
-  .description('Sub1 export.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --sub1-id <sub1-id>',
-      'Sub1 id. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(new Option('-f, --file <file>', 'Name of the export file.'))
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Export all sub1s to a single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Export all sub1s to separate files (*.sub1.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1-import.js

@@ -1,54 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd sub1 import');
-
-program
-  .description('Sub1 import.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --sub1-id <sub1-id>',
-      'Sub1 id. If specified, only one sub1 is imported and the options -a and -A are ignored.'
-    )
-  )
-  .addOption(new Option('-f, --file <file>', 'Name of the file to import.'))
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Import all sub1s from single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Import all sub1s from separate files (*.sub1.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1-list.js

@@ -1,38 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo cmd sub1 list');
-
-program
-  .description('Sub1 list.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option('-l, --long', 'Long with all fields.').default(false, 'false')
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setRealm(realm);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (await getTokens()) {
-        // code goes here
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/_template/cmd-sub1.js

@@ -1,20 +0,0 @@
-import { Command } from 'commander';
-
-const program = new Command('frodo cmd sub1');
-
-program
-  .description('Sub1 command.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError();
-
-program.command('list', 'Sub1 list.').showHelpAfterError();
-
-program.command('describe', 'Sub1 describe.').showHelpAfterError();
-
-program.command('export', 'Sub1 export.').showHelpAfterError();
-
-program.command('import', 'Sub1 import.').showHelpAfterError();
-
-program.command('delete', 'Sub1 delete.').showHelpAfterError();
-
-program.parse();