@rockcarver/frodo-cli 0.14.0 → 0.15.0

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

@@ -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.ts

@@ -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.e2e.test_.ts

@@ -1,142 +0,0 @@
-// import { jest } from '@jest/globals';
-import { spawn, spawnSync } from 'child_process';
-
-const ansiEscapeCodes =
-  // eslint-disable-next-line no-control-regex
-  /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g;
-
-/**
- * delete all journeys and import baseline and additional test journeys
- */
-beforeAll(async () => {
-  // delete all journeys
-  const deleteJourneysCmd = spawnSync('frodo', [
-    'journey',
-    'delete',
-    '--all',
-    'frodo-dev',
-  ]);
-  if (deleteJourneysCmd.status > 0) {
-    console.error(deleteJourneysCmd.stderr.toString());
-    console.log(deleteJourneysCmd.stdout.toString());
-  }
-
-  // import baseline journeys
-  const importBaselineJourneysCmd = spawnSync(
-    'frodo',
-    ['journey', 'import', '--all-separate', 'frodo-dev'],
-    {
-      cwd: `test/e2e/journey/baseline`,
-    }
-  );
-  if (importBaselineJourneysCmd.status > 0) {
-    console.error(importBaselineJourneysCmd.stderr.toString());
-    console.log(importBaselineJourneysCmd.stdout.toString());
-  }
-
-  // import additional test journeys
-  const importTestJourneysCmd = spawnSync(
-    'frodo',
-    ['journey', 'import', '--all-separate', 'frodo-dev'],
-    {
-      cwd: `test/e2e/journey/list`,
-    }
-  );
-  if (importTestJourneysCmd.status > 0) {
-    console.error(importTestJourneysCmd.stderr.toString());
-    console.log(importTestJourneysCmd.stdout.toString());
-  }
-});
-
-describe('frodo journey list', () => {
-  it('"frodo journey list": should list the names of the default journeys', (done) => {
-    const journeyList = spawn('frodo', ['journey', 'list', 'frodo-dev']);
-    const expected = [
-      'Disabled',
-      'ForgottenUsername',
-      'Login',
-      'PasswordGrant',
-      'ProgressiveProfile',
-      'Registration',
-      'ResetPassword',
-      'UpdatePassword',
-      '',
-    ].join('\n');
-
-    const chunks = [];
-    journeyList.stdout.on('data', (chunk) => {
-      chunks.push(chunk);
-    });
-
-    journeyList.stdout.on('end', () => {
-      const output = Buffer.concat(chunks).toString();
-      try {
-        expect(output).toBe(expected);
-        done();
-      } catch (error) {
-        done(error);
-      }
-    });
-  });
-
-  const expectedLong = [
-    'Listing journeys in realm "alpha"...',
-    'Name              │Status  │Tags               ',
-    'Disabled          │disabled│Prototype          ',
-    'ForgottenUsername │enabled │Username Reset     ',
-    'Login             │enabled │Authentication     ',
-    'PasswordGrant     │enabled │                   ',
-    'ProgressiveProfile│enabled │Progressive Profile',
-    'Registration      │enabled │Registration       ',
-    'ResetPassword     │enabled │Password Reset     ',
-    'UpdatePassword    │enabled │Password Reset     ',
-    '',
-  ].join('\n');
-
-  it('"frodo journey list -l": should list the names, status, and tags of the default journeys', (done) => {
-    const journeyList = spawn('frodo', ['journey', 'list', '-l', 'frodo-dev']);
-
-    const chunks = [];
-    journeyList.stdout.on('data', (chunk) => {
-      chunks.push(chunk);
-    });
-
-    journeyList.stdout.on('end', () => {
-      const output = Buffer.concat(chunks)
-        .toString()
-        .replace(ansiEscapeCodes, '');
-      try {
-        expect(output).toBe(expectedLong);
-        done();
-      } catch (error) {
-        done(error);
-      }
-    });
-  });
-
-  it('"frodo journey list --long": should list the names, status, and tags of the default journeys', (done) => {
-    const journeyList = spawn('frodo', [
-      'journey',
-      'list',
-      '--long',
-      'frodo-dev',
-    ]);
-
-    const chunks = [];
-    journeyList.stdout.on('data', (chunk) => {
-      chunks.push(chunk);
-    });
-
-    journeyList.stdout.on('end', () => {
-      const output = Buffer.concat(chunks)
-        .toString()
-        .replace(ansiEscapeCodes, '');
-      try {
-        expect(output).toBe(expectedLong);
-        done();
-      } catch (error) {
-        done(error);
-      }
-    });
-  });
-});

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

@@ -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.ts

@@ -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.ts

@@ -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.ts

@@ -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.ts

@@ -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();