@rockcarver/frodo-cli 0.13.3 → 0.14.1

package/src/cli/journey/journey-describe.js

@@ -1,143 +0,0 @@
-import fs from 'fs';
-import { Command, Option } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const {
-  getJourneys,
-  exportJourney,
-  createFileParamTreeExportResolver,
-  describeJourney,
-} = Journey;
-
-const program = new Command('frodo journey describe');
-
-program
-  .description(
-    'If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.'
-  )
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgument)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(
-    new Option(
-      '-i, --journey-id <journey>',
-      'Name of a journey/tree. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-f, --file <file>',
-      'Name of the file to write the exported journey(s) to. Ignored with -A.'
-    )
-  )
-  // .addOption(
-  //   new Option(
-  //     '-o, --override-version <version>',
-  //     "Override version. Notation: 'X.Y.Z' e.g. '7.1.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. Only impacts these actions: -d, -l."
-  //   )
-  // )
-  .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);
-      // TODO: review checks for arguments
-      if (typeof host === 'undefined' || typeof options.file !== 'undefined') {
-        if (
-          typeof host === 'undefined' &&
-          typeof options.file === 'undefined'
-        ) {
-          console.log('Need either [host] or -f.');
-          process.exitCode = 1;
-          return;
-        }
-        console.log(`Describing local journey file ${options.file}...`);
-        try {
-          const fileData = JSON.parse(fs.readFileSync(options.file, 'utf8'));
-          let journeyData = null;
-          // single or multi tree export?
-          // multi - by id
-          if (
-            typeof options.journeyId !== 'undefined' &&
-            fileData.trees &&
-            fileData.trees[options.journeyId]
-          ) {
-            journeyData = fileData.trees[options.journeyId];
-          }
-          // multi - first
-          else if (typeof options.journeyId === 'undefined' && fileData.trees) {
-            [journeyData] = Object.values(fileData.trees);
-          }
-          // single - by id
-          else if (
-            typeof options.journeyId !== 'undefined' &&
-            options.journeyId === fileData.tree?._id
-          ) {
-            journeyData = fileData;
-          }
-          // single
-          else if (
-            typeof options.journeyId === 'undefined' &&
-            fileData.tree?._id
-          ) {
-            journeyData = fileData;
-          }
-          // no journey/tree found
-          else {
-            throw new Error(
-              typeof options.journeyId === 'undefined'
-                ? `No journey found in ${options.file}`
-                : `Journey '${options.journeyId}' not found in ${options.file}`
-            );
-          }
-          describeJourney(
-            journeyData,
-            createFileParamTreeExportResolver(options.file)
-          );
-        } catch (error) {
-          console.log(error.message);
-          process.exitCode = 1;
-        }
-      } else if (await getTokens()) {
-        console.log(
-          `Describing journey(s) in realm "${state.default.session.getRealm()}"...`
-        );
-        if (typeof options.journeyId === 'undefined') {
-          let journeys = [];
-          journeys = await getJourneys();
-          for (const journey of journeys) {
-            try {
-              // eslint-disable-next-line no-await-in-loop, dot-notation
-              const treeData = await exportJourney(journey['_id']);
-              describeJourney(treeData);
-            } catch (error) {
-              console.log(error.message);
-              process.exitCode = 1;
-            }
-          }
-        } else {
-          try {
-            const treeData = await exportJourney(options.journeyId);
-            describeJourney(treeData);
-          } catch (error) {
-            console.log(error.message);
-            process.exitCode = 1;
-          }
-        }
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/journey/journey-export.js

@@ -1,110 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { exportJourneyToFile, exportJourneysToFile, exportJourneysToFiles } =
-  Journey;
-
-const program = new Command('frodo journey export');
-
-program
-  .description('Export journeys/trees.')
-  .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, --journey-id <journey>',
-      'Name of a journey/tree. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-f, --file <file>',
-      'Name of the file to write the exported journey(s) to. Ignored with -A.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Export all the journeys/trees in a realm. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Export all the journeys/trees in a realm as separate files <journey/tree name>.json. Ignored with -i or -a.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--use-string-arrays',
-      'Where applicable, use string arrays to store multi-line text (e.g. scripts).'
-    ).default(false, 'off')
-  )
-  .addOption(
-    new Option(
-      '--no-deps',
-      'Do not include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).'
-    )
-  )
-  .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()) {
-        // export
-        if (options.journeyId) {
-          console.log('Exporting journey...');
-          await exportJourneyToFile(options.journeyId, options.file, {
-            useStringArrays: options.useStringArrays,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // --all -a
-        else if (options.all) {
-          console.log('Exporting all journeys to a single file...');
-          await exportJourneysToFile(options.file, {
-            useStringArrays: options.useStringArrays,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // --all-separate -A
-        else if (options.allSeparate) {
-          console.log('Exporting all journeys to separate files...');
-          await exportJourneysToFiles({
-            useStringArrays: options.useStringArrays,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // unrecognized combination of options or no options
-        else {
-          console.log('Unrecognized combination of options or no options...');
-          program.help();
-        }
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/journey/journey-import.js

@@ -1,127 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const {
-  importJourneyFromFile,
-  importJourneysFromFile,
-  importJourneysFromFiles,
-  importFirstJourneyFromFile,
-} = Journey;
-
-const program = new Command('frodo journey import');
-
-program
-  .description('Import journey/tree.')
-  .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, --journey-id <journey>',
-      'Name of a journey/tree. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-f, --file <file>',
-      'Name of the file to import the journey(s) from. Ignored with -A.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Import all the journeys/trees from single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Import all the journeys/trees from separate files (*.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--re-uuid',
-      'Generate new UUIDs for all nodes during import.'
-    ).default(false, 'off')
-  )
-  .addOption(
-    new Option(
-      '--no-deps',
-      'Do not include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).'
-    )
-  )
-  .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()) {
-        // import
-        if (options.journeyId) {
-          console.log(`Importing journey ${options.journeyId}...`);
-          importJourneyFromFile(options.journeyId, options.file, {
-            reUuid: options.reUuid,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // --all -a
-        else if (options.all && options.file) {
-          console.log(
-            `Importing all journeys from a single file (${options.file})...`
-          );
-          importJourneysFromFile(options.file, {
-            reUuid: options.reUuid,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // --all-separate -A
-        else if (options.allSeparate && !options.file) {
-          console.log(
-            'Importing all journeys from separate files in current directory...'
-          );
-          importJourneysFromFiles({
-            reUuid: options.reUuid,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // import first journey in file
-        else if (options.file) {
-          console.log('Importing first journey in file...');
-          importFirstJourneyFromFile(options.file, {
-            reUuid: options.reUuid,
-            deps: options.deps,
-            verbose: options.verbose,
-          });
-        }
-        // unrecognized combination of options or no options
-        else {
-          console.log('Unrecognized combination of options or no options...');
-          program.help();
-        }
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/journey/journey-list.js

@@ -1,43 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { listJourneys } = Journey;
-
-const program = new Command('frodo journey list');
-
-program
-  .description('List journeys/trees.')
-  .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')
-  )
-  .addOption(new Option('-a, --analyze', 'Analyze journeys for custom nodes.'))
-  .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()) {
-        console.log(
-          `Listing journeys in realm "${state.default.session.getRealm()}"...`
-        );
-        listJourneys(options.long, options.analyze);
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/journey/journey-prune.js

@@ -1,52 +0,0 @@
-import { Command } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import yesno from 'yesno';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { findOrphanedNodes, removeOrphanedNodes } = Journey;
-
-const program = new Command('frodo journey prune');
-
-program
-  .description(
-    'Prune orphaned configuration artifacts left behind after deleting authentication trees. You will be prompted before any destructive operations are performed.'
-  )
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.realmArgument)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .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()) {
-        console.log(
-          `Pruning orphaned configuration artifacts in realm "${state.default.session.getRealm()}"...`
-        );
-        const orphanedNodes = await findOrphanedNodes();
-        if (orphanedNodes.length > 0) {
-          const ok = await yesno({
-            question: 'Prune (permanently delete) orphaned nodes? (y|n):',
-          });
-          if (ok) {
-            await removeOrphanedNodes(orphanedNodes);
-          }
-        } else {
-          console.log('No orphaned nodes found.');
-        }
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/journey/journey.js

@@ -1,37 +0,0 @@
-import { Command } from 'commander';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-export default function setup() {
-  const program = new Command('journey')
-    .helpOption('-h, --help', 'Help')
-    .description('Manage journeys/trees.')
-    .executableDir(__dirname);
-
-  program.command('list', 'List journeys/trees.').showHelpAfterError();
-
-  program
-    .command(
-      'describe',
-      'If host argument is supplied, describe the journey/tree indicated by -t, or all journeys/trees in the realm if no -t is supplied, otherwise describe the journey/tree export file indicated by -f.'
-    )
-    .showHelpAfterError();
-
-  program.command('export', 'Export journeys/trees.').showHelpAfterError();
-
-  program.command('import', 'Import journeys/trees.').showHelpAfterError();
-
-  program.command('delete', 'Delete journeys/trees.').showHelpAfterError();
-
-  program
-    .command(
-      'prune',
-      'Prune orphaned configuration artifacts left behind after deleting authentication trees. You will be prompted before any destructive operations are performed.'
-    )
-    .showHelpAfterError();
-
-  program.showHelpAfterError();
-  return program;
-}

package/src/cli/logging/logs-list.js

@@ -1,77 +0,0 @@
-import {
-  Authenticate,
-  ConnectionProfile,
-  Log,
-  state,
-} from '@rockcarver/frodo-lib';
-import { Command } from 'commander';
-import * as common from '../cmd_common.js';
-
-const { provisionCreds, getLogSources } = Log;
-const { getConnectionProfile, saveConnectionProfile } = ConnectionProfile;
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo journey list');
-program
-  .description('List available ID Cloud log sources.')
-  .helpOption('-h, --help', 'Help')
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.insecureOption)
-  .action(async (host, user, password, options) => {
-    let credsFromParameters = true;
-    state.default.session.setTenant(host);
-    state.default.session.setUsername(user);
-    state.default.session.setPassword(password);
-    state.default.session.setAllowInsecureConnection(options.insecure);
-    console.log('Listing available ID Cloud log sources...');
-    const conn = await getConnectionProfile();
-    state.default.session.setTenant(conn.tenant);
-    if (conn.key != null && conn.secret != null) {
-      credsFromParameters = false;
-      state.default.session.setLogApiKey(conn.key);
-      state.default.session.setLogApiSecret(conn.secret);
-    } else {
-      if (conn.username == null && conn.password == null) {
-        if (
-          !state.default.session.getUsername() &&
-          !state.default.session.getPassword()
-        ) {
-          credsFromParameters = false;
-          console.log(
-            'User credentials not specified as parameters and no saved API key and secret found!',
-            'warn'
-          );
-          return;
-        }
-      } else {
-        state.default.session.setUsername(conn.username);
-        state.default.session.setPassword(conn.password);
-      }
-      if (await getTokens()) {
-        const creds = await provisionCreds();
-        state.default.session.setLogApiKey(creds.api_key_id);
-        state.default.session.setLogApiSecret(creds.api_key_secret);
-      }
-    }
-
-    const sources = await getLogSources();
-    if (sources.length === 0) {
-      console.log(
-        "Can't get sources, possible cause - wrong API key or secret",
-        'error'
-      );
-    } else {
-      if (credsFromParameters) await saveConnectionProfile(); // save new values if they were specified on CLI
-      console.log('Available log sources:');
-      sources.forEach((source) => {
-        console.log(`${source}`, 'info');
-      });
-      console.log('You can use any combination of comma separated sources.');
-      console.log('For example:');
-      console.log(`$ frodo logs tail -c am-core,idm-core ${host}`, 'info');
-    }
-  });
-
-program.parse();

package/src/cli/logging/logs-tail.js

@@ -1,85 +0,0 @@
-import { Command, Option } from 'commander';
-import {
-  Authenticate,
-  ConnectionProfile,
-  Log,
-  state,
-} from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { provisionCreds, tailLogs, resolveLevel } = Log;
-const { getConnectionProfile, saveConnectionProfile } = ConnectionProfile;
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo journey tail');
-program
-  .description('Tail Identity Cloud logs.')
-  .helpOption('-h, --help', 'Help')
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addOption(common.insecureOption)
-  .addOption(common.sourcesOptionM)
-  .addOption(
-    new Option(
-      '-l, --level <level>',
-      'Set log level filter. You can specify the level as a number or a string. \
-Following values are possible (values on the same line are equivalent): \
-\n0, SEVERE, FATAL, or ERROR\n1, WARNING, WARN or CONFIG\
-\n2, INFO or INFORMATION\n3, DEBUG, FINE, FINER or FINEST\
-\n4 or ALL'
-    ).default('ERROR', `${resolveLevel('ERROR')}`)
-  )
-  .addOption(
-    new Option('-t, --transaction-id <txid>', 'Filter by transactionId')
-  )
-  .action(async (host, user, password, options, command) => {
-    let credsFromParameters = true;
-    state.default.session.setTenant(host);
-    state.default.session.setUsername(user);
-    state.default.session.setPassword(password);
-    state.default.session.setAllowInsecureConnection(options.insecure);
-    const conn = await getConnectionProfile();
-    state.default.session.setTenant(conn.tenant);
-    if (conn.key != null && conn.secret != null) {
-      credsFromParameters = false;
-      state.default.session.setLogApiKey(conn.key);
-      state.default.session.setLogApiSecret(conn.secret);
-    } else {
-      if (conn.username == null && conn.password == null) {
-        if (
-          !state.default.session.getUsername() &&
-          !state.default.session.getPassword()
-        ) {
-          credsFromParameters = false;
-          console.log(
-            'User credentials not specified as parameters and no saved API key and secret found!',
-            'warn'
-          );
-          return;
-        }
-      } else {
-        state.default.session.setUsername(conn.username);
-        state.default.session.setPassword(conn.password);
-      }
-      if (await getTokens()) {
-        const creds = await provisionCreds();
-        state.default.session.setLogApiKey(creds.api_key_id);
-        state.default.session.setLogApiSecret(creds.api_key_secret);
-      }
-    }
-    console.log(
-      `Tailing ID Cloud logs from the following sources: ${
-        command.opts().sources
-      } and levels [${resolveLevel(command.opts().level)}]...`
-    );
-    if (credsFromParameters) await saveConnectionProfile(); // save new values if they were specified on CLI
-    await tailLogs(
-      command.opts().sources,
-      resolveLevel(command.opts().level),
-      command.opts().transactionId,
-      null
-    );
-  });
-
-program.parse();