@rockcarver/frodo-cli 0.14.0 → 0.15.0

package/src/cli/_template/cmd-sub2-delete.ts

@@ -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 sub2 delete');
-
-program
-  .description('Sub2 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, --sub2-id <sub2-id>',
-      'Sub2 id. If specified, -a and -A are ignored.'
-    )
-  )
-  .addOption(
-    new Option('-a, --all', 'Delete all sub2s 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-sub2-describe.ts

@@ -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 sub2 describe');
-
-program
-  .description('Sub2 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, --sub2-id <sub2-id>', 'Sub2 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-sub2-export.ts

@@ -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 sub2 export');
-
-program
-  .description('Sub2 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, --sub2-id <sub2-id>',
-      'Sub2 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 sub2s to a single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Export all sub2s to separate files (*.sub2.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-sub2-import.ts

@@ -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 sub2 import');
-
-program
-  .description('Sub2 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, --sub2-id <sub2-id>',
-      'Sub2 id. If specified, only one sub2 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 sub2s from single file. Ignored with -i.'
-    )
-  )
-  .addOption(
-    new Option(
-      '-A, --all-separate',
-      'Import all sub2s from separate files (*.sub2.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-sub2-list.ts

@@ -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 sub2 list');
-
-program
-  .description('Sub2 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-sub2.ts

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

package/src/cli/_template/cmd.ts

@@ -1,29 +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('cmd')
-    .helpOption('-h, --help', 'Help')
-    .description('Top-level command.')
-    .executableDir(__dirname);
-
-  program.command('sub1', 'Sub1 command.').showHelpAfterError();
-
-  program.command('sub2', 'Sub2 command.').showHelpAfterError();
-
-  program.command('list', 'Sub2 list.').showHelpAfterError();
-
-  program.command('describe', 'Sub2 describe.').showHelpAfterError();
-
-  program.command('export', 'Sub2 export.').showHelpAfterError();
-
-  program.command('import', 'Sub2 import.').showHelpAfterError();
-
-  program.command('delete', 'Sub2 delete.').showHelpAfterError();
-
-  program.showHelpAfterError();
-  return program;
-}

package/src/cli/admin/admin-add-autoid-static-user-mapping.ts

@@ -1,40 +0,0 @@
-import { Command } from 'commander';
-import { Authenticate, Admin, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { addAutoIdStaticUserMapping } = Admin;
-
-const program = new Command('frodo admin add-autoid-static-user-mapping');
-
-program
-  .description(
-    'Add AutoId static user mapping to enable dashboards and other AutoId-based functionality.'
-  )
-  .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(`Adding AutoId static user mapping...`);
-        await addAutoIdStaticUserMapping();
-        console.log('Done.');
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/admin/admin-create-oauth2-client-with-admin-privileges.ts

@@ -1,121 +0,0 @@
-import { Command, Option } from 'commander';
-import { v4 as uuidv4 } from 'uuid';
-import Table from 'cli-table3';
-import { Authenticate, Admin, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { createLongLivedToken, createOAuth2ClientWithAdminPrivileges } = Admin;
-
-const program = new Command(
-  'frodo admin create-oauth2-client-with-admin-privileges'
-);
-
-program
-  .description('Create an oauth2 client with admin privileges.')
-  .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('--client-id [id]', 'Client id.'))
-  .addOption(new Option('--client-secret [secret]', 'Client secret.'))
-  .addOption(
-    new Option(
-      '--llt',
-      'Create a long-lived token and store it in a secret. The default secret name is esv-admin-token and the default token lifetime is 315,360,000 seconds (10 years). Both can be overwritten with the --llt-esv and --llt-ttl options.'
-    )
-  )
-  .addOption(
-    new Option(
-      '--llt-scope [scope]',
-      'Request the following scope(s). This option only applies if used with the --llt option.'
-    ).default('fr:idm:*', 'fr:idm:*')
-  )
-  .addOption(
-    new Option(
-      '--llt-esv [esv]',
-      'Name of the secret to store the token in. This option only applies if used with the --llt option.'
-    ).default('esv-admin-token', 'esv-admin-token')
-  )
-  .addOption(
-    new Option(
-      '--llt-ttl [ttl]',
-      'Token lifetime (seconds). This option only applies if used with the --llt option.'
-    ).default(315360000, '315,360,000 seconds (10 years)')
-  )
-  .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(
-          `Creating oauth2 client with admin privileges in realm "${state.default.session.getRealm()}"...`
-        );
-        let clientId = uuidv4();
-        let clientSecret = uuidv4();
-        if (options.clientId) {
-          clientId = options.clientId;
-        }
-        if (options.clientSecret) {
-          clientSecret = options.clientSecret;
-        }
-        try {
-          await createOAuth2ClientWithAdminPrivileges(clientId, clientSecret);
-        } catch (error) {
-          console.log(error, 'error');
-        }
-        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 },
-          wordWrap: true,
-        });
-        if (options.llt) {
-          try {
-            const response = await createLongLivedToken(
-              clientId,
-              clientSecret,
-              options.scope,
-              options.lltEsv,
-              options.lltTtl
-            );
-            table.push(['Secret Name'['brightCyan'], response.secret]);
-            table.push(['Scope'['brightCyan'], response.scope]);
-            // table.push(['Token Lifetime'.brightCyan, response.expires_in]);
-            table.push(['Expires'['brightCyan'], response.expires_on]);
-          } catch (error) {
-            console.log(error, 'error');
-          }
-        }
-        table.push(['Client ID'['brightCyan'], clientId]);
-        table.push(['Client Secret'['brightCyan'], clientSecret]);
-        console.log(table.toString());
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/admin/admin-get-access-token.ts

@@ -1,59 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, OAuth2OIDCApi, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { clientCredentialsGrant } = OAuth2OIDCApi;
-const { getTokens } = Authenticate;
-
-const program = new Command('frodo admin get-access-token');
-
-program
-  .description('Get an access token using client credentials grant type.')
-  .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('--client-id [id]', 'Client id.').makeOptionMandatory())
-  .addOption(
-    new Option(
-      '--client-secret [secret]',
-      'Client secret.'
-    ).makeOptionMandatory()
-  )
-  .addOption(
-    new Option('--scope [scope]', 'Request the following scope(s).').default(
-      'fr:idm:*',
-      'fr:idm:*'
-    )
-  )
-  .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(
-          `Getting an access token using client "${options.clientId}"...`
-        );
-        const response = (
-          await clientCredentialsGrant(
-            options.clientId,
-            options.clientSecret,
-            options.scope
-          )
-        ).data;
-        console.log(`Token: ${response.access_token}`);
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/admin/admin-grant-oauth2-client-admin-privileges.ts

@@ -1,45 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, Admin, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { grantOAuth2ClientAdminPrivileges } = Admin;
-
-const program = new Command('frodo admin grant-oauth2-client-admin-privileges');
-
-program
-  .description('Grant an oauth2 client admin privileges.')
-  .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('-t, --target <target name or id>', 'Name of the oauth2 client.')
-  )
-  .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(
-          `Granting oauth2 client "${
-            options.target
-          }" in realm "${state.default.session.getRealm()}" admin privileges...`
-        );
-        await grantOAuth2ClientAdminPrivileges(options.target);
-        console.log('Done.');
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/admin/admin-hide-generic-extension-attributes.ts

@@ -1,47 +0,0 @@
-import { Command, Option } from 'commander';
-import { Authenticate, Admin, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { getTokens } = Authenticate;
-const { hideGenericExtensionAttributes } = Admin;
-
-const program = new Command('frodo admin hide-generic-extension-attributes');
-
-program
-  .description('Hide generic extension attributes.')
-  .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('--include-customized', 'Include customized attributes.')
-  )
-  .addOption(new Option('--dry-run', 'Dry-run only, do not perform changes.'))
-  .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(
-          `Hiding generic extension attributes in realm "${state.default.session.getRealm()}"...`
-        );
-        await hideGenericExtensionAttributes(
-          options.includeCustomized,
-          options.dryRun
-        );
-        console.log('Done.');
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();

package/src/cli/admin/admin-list-oauth2-clients-with-admin-privileges.ts

@@ -1,45 +0,0 @@
-import { Command } from 'commander';
-import { Authenticate, Admin, state } from '@rockcarver/frodo-lib';
-import * as common from '../cmd_common.js';
-
-const { listOAuth2AdminClients } = Admin;
-const { getTokens } = Authenticate;
-
-const program = new Command(
-  'frodo admin list-oauth2-clients-with-admin-privileges'
-);
-
-program
-  .description('List oauth2 clients with admin privileges.')
-  .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(
-          `Listing oauth2 clients with admin privileges in realm "${state.default.session.getRealm()}"...`
-        );
-        const adminClients = await listOAuth2AdminClients();
-        adminClients.sort((a, b) => a.localeCompare(b));
-        adminClients.forEach((item) => {
-          console.log(`${item}`);
-        });
-      }
-    }
-    // end command logic inside action handler
-  );
-
-program.parse();