@rockcarver/frodo-cli 0.14.0 → 0.15.0

package/src/cli/cmd_common.ts

@@ -1,181 +0,0 @@
-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);
-
-// pseudo functions for commands that do not otherwise need to import
-// this file but need to trigger print and progress handler registration
-export function init() {}
-
-const hostArgumentDescription =
-  'Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.';
-export const hostArgument = new Argument('[host]', hostArgumentDescription);
-export const hostArgumentM = new Argument('<host>', hostArgumentDescription);
-
-const realmArgumentDescription =
-  "Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise.";
-export const realmArgument = new Argument(
-  '[realm]',
-  realmArgumentDescription
-).default(
-  global.DEFAULT_REALM_KEY,
-  '"alpha" for Identity Cloud tenants, "/" otherwise.'
-);
-export const realmArgumentM = new Argument('<realm>', realmArgumentDescription);
-
-const userArgumentDescription =
-  'Username to login with. Must be an admin user with appropriate rights to manage authentication journeys/trees.';
-export const userArgument = new Argument('[user]', userArgumentDescription);
-export const userArgumentM = new Argument('<user>', userArgumentDescription);
-
-const passwordArgumentDescription = 'Password.';
-export const passwordArgument = new Argument(
-  '[password]',
-  passwordArgumentDescription
-);
-export const passwordArgumentM = new Argument(
-  '<password>',
-  passwordArgumentDescription
-);
-
-const apiKeyArgumentDescription = 'API key for logging API.';
-export const apiKeyArgument = new Argument('[key]', apiKeyArgumentDescription);
-
-const apiSecretArgumentDescription = 'API secret for logging API.';
-export const apiSecretArgument = new Argument(
-  '[secret]',
-  apiSecretArgumentDescription
-);
-
-const treeOptionDescription =
-  'Specify the name of an authentication journey/tree.';
-export const treeOption = new Option(
-  '-t, --tree <tree>',
-  treeOptionDescription
-);
-export const treeOptionM = new Option(
-  '-t, --tree <tree>',
-  treeOptionDescription
-);
-
-const fileOptionDescription = 'File name.';
-export const fileOption = new Option(
-  '-f, --file <file>',
-  fileOptionDescription
-);
-export const fileOptionM = new Option(
-  '-f, --file <file>',
-  fileOptionDescription
-);
-
-const deploymentOptionDescription =
-  'Override auto-detected deployment type. Valid values for type: \n\
-classic:  A classic Access Management-only deployment with custom layout and configuration. \n\
-cloud:    A ForgeRock Identity Cloud environment. \n\
-forgeops: A ForgeOps CDK or CDM deployment. \n\
-The detected or provided deployment type controls certain behavior like obtaining an Identity \
-Management admin token or not and whether to export/import referenced email templates or how \
-to walk through the tenant admin login flow of Identity Cloud and handle MFA';
-export const deploymentOption = new Option(
-  '-m, --type <type>',
-  deploymentOptionDescription
-).choices(global.DEPLOYMENT_TYPES);
-export const deploymentOptionM = new Option(
-  '-m, --type <type>',
-  deploymentOptionDescription
-).choices(global.DEPLOYMENT_TYPES);
-
-export const insecureOption = new Option(
-  '-k, --insecure',
-  'Allow insecure connections when using SSL/TLS. Has no effect when using a network proxy for https (HTTPS_PROXY=http://<host>:<port>), in that case the proxy must provide this capability.'
-).default(false, "Don't allow insecure connections");
-
-export const nameOption = new Option(
-  '-N, --name <name>',
-  'Config entity name to be exported or imported/updated. Examples are \
-managed, sync, provisioner-xxxx, etc.'
-);
-export const nameOptionM = new Option(
-  '-N, --name <name>',
-  'Config entity name to be exported or imported/updated. Examples are \
-managed, sync, provisioner-xxxx, etc.'
-);
-
-export const managedNameOption = new Option(
-  '-N, --name <name>',
-  'Managed object name to be operated on. Examples are \
-user, role, alpha_user, alpha_role etc.'
-);
-export const managedNameOptionM = new Option(
-  '-N, --name <name>',
-  'Managed object name to be operated on. Examples are \
-user, role, alpha_user, alpha_role etc.'
-);
-
-const dirOptionDescription =
-  'Directory for exporting all configuration entities to.';
-export const dirOption = new Option(
-  '-D, --directory <directory>',
-  dirOptionDescription
-);
-export const dirOptionM = new Option(
-  '-D, --directory <directory>',
-  dirOptionDescription
-);
-
-const entitiesFileOptionDescription =
-  'JSON file that specifies the config entities to export/import.';
-export const entitiesFileOption = new Option(
-  '-E, --entitiesFile <file>',
-  entitiesFileOptionDescription
-);
-export const entitiesFileOptionM = new Option(
-  '-E, --entitiesFile <file>',
-  entitiesFileOptionDescription
-);
-
-const envFileOptionDescription =
-  'File that defines environment specific variables for replacement during configuration export/import.';
-export const envFileOption = new Option(
-  '-e, --envFile <file>',
-  envFileOptionDescription
-);
-export const envFileOptionM = new Option(
-  '-e, --envFile <file>',
-  envFileOptionDescription
-);
-
-const sourcesOptionDescription = 'Comma separated list of log sources';
-const sourcesOptionDefaultValueDescription = 'Log everything';
-export const sourcesOptionM = new Option(
-  '-c, --sources <sources>',
-  sourcesOptionDescription
-).default('am-everything,idm-everything', sourcesOptionDefaultValueDescription);
-
-export const scriptFriendlyOption = new Option(
-  '-s, --scriptFriendly',
-  'Send output of operation to STDOUT in a script-friendly format (JSON) which can be piped to other \
-commands. User messages/warnings are output to STDERR, and are not piped. For example, to only get \
-bearer token: \n\
-<<< frodo info my-tenant -s 2>/dev/null | jq -r .bearerToken >>>'
-).default(false, 'Output as plain text');
-
-treeOptionM.makeOptionMandatory();
-fileOptionM.makeOptionMandatory();
-deploymentOptionM.makeOptionMandatory();
-nameOptionM.makeOptionMandatory();
-dirOptionM.makeOptionMandatory();
-entitiesFileOptionM.makeOptionMandatory();
-envFileOptionM.makeOptionMandatory();
-managedNameOptionM.makeOptionMandatory();
-sourcesOptionM.makeOptionMandatory();

package/src/cli/conn/conn-add.ts

@@ -1,65 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, ConnectionProfile, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { saveConnectionProfile } = ConnectionProfile;
-
-const program = new Command('frodo conn add');
-
-program
-  .description(
-    'Add a new connection profiles. You have to specify a URL, username and password at a minimum.\nOptionally, for Identity Cloud, you can also add a log API key and secret.'
-  )
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addArgument(common.userArgument)
-  .addArgument(common.passwordArgument)
-  .addArgument(common.apiKeyArgument)
-  .addArgument(common.apiSecretArgument)
-  .addOption(common.deploymentOption)
-  .addOption(common.insecureOption)
-  .addOption(new Option('--no-validate', 'Do not validate connection.'))
-  .addOption(
-    new Option(
-      '--authentication-service [service]',
-      'Name of the authentication service/tree to use.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--authentication-header-overrides [headers]',
-      'Map of headers: {"host":"am.example.com:8081"}.'
-    )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, user, password, key, secret, options) => {
-      state.default.session.setTenant(host);
-      state.default.session.setUsername(user);
-      state.default.session.setPassword(password);
-      state.default.session.setLogApiKey(key);
-      state.default.session.setLogApiSecret(secret);
-      state.default.session.setDeploymentType(options.type);
-      state.default.session.setAllowInsecureConnection(options.insecure);
-      if (options.authenticationService) {
-        state.default.session.setAuthenticationService(
-          options.authenticationService
-        );
-      }
-      if (options.authenticationHeaderOverrides) {
-        state.default.session.setAuthenticationHeaderOverrides(
-          JSON.parse(options.authenticationHeaderOverrides)
-        );
-      }
-      if ((options.validate && (await getTokens())) || !options.validate) {
-        saveConnectionProfile();
-      } else {
-        process.exitCode = 1;
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/conn/conn-delete.ts

@@ -1,22 +0,0 @@
-import { Command } from 'commander';
-import { ConnectionProfile } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { deleteConnectionProfile } = ConnectionProfile;
-
-const program = new Command('frodo conn delete');
-
-program
-  .description('Delete connection profiles.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .action(
-    // implement command logic inside action handler
-    async (host) => {
-      deleteConnectionProfile(host);
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/conn/conn-describe.ts

@@ -1,23 +0,0 @@
-import { Command, Option } from 'commander';
-import { ConnectionProfile } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { describeConnectionProfile } = ConnectionProfile;
-
-const program = new Command('frodo conn describe');
-
-program
-  .description('Describe connection profile.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addArgument(common.hostArgumentM)
-  .addOption(new Option('--show-secrets', 'Show passwords and secrets.'))
-  .action(
-    // implement command logic inside action handler
-    async (host, options) => {
-      describeConnectionProfile(host, options.showSecrets);
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

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

@@ -1,27 +0,0 @@
-import { Command, Option } from 'commander';
-import { ConnectionProfile } from '@rockcarver/frodo-lib';
-import { init } from '../cmd_common.js';
-
-const { listConnectionProfiles } = ConnectionProfile;
-
-// pseudo init to trigger print and progress handler registration
-init();
-
-const program = new Command('frodo conn list');
-
-program
-  .description('List connection profiles.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError()
-  .addOption(
-    new Option('-l, --long', 'Long with all fields.').default(false, 'false')
-  )
-  .action(
-    // implement command logic inside action handler
-    async (options) => {
-      listConnectionProfiles(options.long);
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/conn/conn.ts

@@ -1,28 +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('conn')
-    .alias('connection')
-    // for backwards compatibility
-    .alias('connections')
-    .helpOption('-h, --help', 'Help')
-    .description('Manage connection profiles.')
-    .executableDir(__dirname);
-
-  program.command('add', 'Add connection profiles.').showHelpAfterError();
-
-  program.command('delete', 'Delete connection profiles.').showHelpAfterError();
-
-  program
-    .command('describe', 'Describe connection profiles.')
-    .showHelpAfterError();
-
-  program.command('list', 'List connection profiles.').showHelpAfterError();
-
-  program.showHelpAfterError();
-  return program;
-}

package/src/cli/email/email-template-export.ts

@@ -1,90 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, EmailTemplate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const {
-  exportEmailTemplatesToFile,
-  exportEmailTemplatesToFiles,
-  exportEmailTemplateToFile,
-} = EmailTemplate;
-
-const program = new Command('frodo email template export');
-
-program
-  .description('Export email templates.')
-  .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, --template-id <template-id>',
-      'Email template id/name. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-f, --file [file]',
-      'Name of the export file. Ignored with -A. Defaults to <template-id>.template.email.json.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Export all email templates to a single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Export all email templates as separate files <template-id>.template.email.json. Ignored with -i, and -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()) {
-        // export by id/name
-        if (options.templateId) {
-          console.log(
-            `Exporting email template "${
-              options.templateId
-            }" from realm "${state.default.session.getRealm()}"...`
-          );
-          exportEmailTemplateToFile(options.templateId, options.file);
-        }
-        // --all -a
-        else if (options.all) {
-          console.log('Exporting all email templates to a single file...');
-          exportEmailTemplatesToFile(options.file);
-        }
-        // --all-separate -A
-        else if (options.allSeparate) {
-          console.log('Exporting all email templates to separate files...');
-          exportEmailTemplatesToFiles();
-        }
-        // unrecognized combination of options or no options
-        else {
-          console.log(
-            'Unrecognized combination of options or no options...',
-            'error'
-          );
-          program.help();
-        }
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/email/email-template-import.ts

@@ -1,90 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, EmailTemplate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const {
-  importEmailTemplateFromFile,
-  importEmailTemplatesFromFile,
-  importEmailTemplatesFromFiles,
-  importFirstEmailTemplateFromFile,
-} = EmailTemplate;
-
-const program = new Command('frodo email template import');
-
-program
-  .description('Import email templates.')
-  .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, --template-id <template-id>',
-      'Email template id/name. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(new Option('-f, --file <file>', 'Name of the import file.'))
-  .addOption(
-    new Option(
-      '-a, --all',
-      'Import all email templates from single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Import all email templates from separate files (*.template.email.json) in the current directory. Ignored with -i or -a.'
-    )
-  )
-  .action(
-    // implement program 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 by id
-        if (options.file && options.templateId) {
-          console.log(`Importing email template "${options.templateId}"...`);
-          importEmailTemplateFromFile(options.templateId, options.file);
-        }
-        // --all -a
-        else if (options.all && options.file) {
-          console.log(
-            `Importing all email templates from a single file (${options.file})...`
-          );
-          importEmailTemplatesFromFile(options.file);
-        }
-        // --all-separate -A
-        else if (options.allSeparate && !options.file) {
-          console.log(
-            'Importing all email templates from separate files (*.template.email.json) in current directory...'
-          );
-          importEmailTemplatesFromFiles();
-        }
-        // import first template from file
-        else if (options.file) {
-          console.log(
-            `Importing first email template from file "${options.file}"...`
-          );
-          importFirstEmailTemplateFromFile(options.file);
-        }
-        // unrecognized combination of options or no options
-        else {
-          console.log('Unrecognized combination of options or no options...');
-          program.help();
-        }
-      }
-    }
-    // end program logic inside action handler
-  );
-
-program.parse();

package/src/cli/email/email-template-list.ts

@@ -1,40 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, EmailTemplate, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { listEmailTemplates } = EmailTemplate;
-
-const program = new Command('frodo email template list');
-
-program
-  .description('List email templates.')
-  .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()) {
-        console.log(`Listing email templates ...`);
-        listEmailTemplates(options.long);
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/email/email-template.ts

@@ -1,16 +0,0 @@
-import { Command } from 'commander';
-
-const program = new Command('frodo email template');
-
-program
-  .description('Manage email templates.')
-  .helpOption('-h, --help', 'Help')
-  .showHelpAfterError();
-
-program.command('list', 'List email templates.').showHelpAfterError();
-
-program.command('export', 'Export email templates.').showHelpAfterError();
-
-program.command('import', 'Import email templates.').showHelpAfterError();
-
-program.parse();

package/src/cli/email/email.ts

@@ -1,17 +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('email')
-    .helpOption('-h, --help', 'Help')
-    .description('Manage email templates and configuration.')
-    .executableDir(__dirname);
-
-  program.command('template', 'Manage email templates.').showHelpAfterError();
-
-  program.showHelpAfterError();
-  return program;
-}