@rockcarver/frodo-cli 0.12.4-5 → 0.12.4-6

package/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.4-6] - 2022-09-15
+
 ## [0.12.4-5] - 2022-09-13
 
 ## [0.12.4-4] - 2022-09-12
@@ -462,7 +464,9 @@ 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.12.4-5...HEAD
+[Unreleased]: https://github.com/rockcarver/frodo-cli/compare/v0.12.4-6...HEAD
+
+[0.12.4-6]: https://github.com/rockcarver/frodo-cli/compare/v0.12.4-5...v0.12.4-6
 
 [0.12.4-5]: https://github.com/rockcarver/frodo-cli/compare/v0.12.4-4...v0.12.4-5
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rockcarver/frodo-cli",
-  "version": "0.12.4-5",
+  "version": "0.12.4-6",
   "type": "module",
   "description": "A command line interface to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.",
   "keywords": [
@@ -85,7 +85,7 @@
   },
   "dependencies": {
     "@colors/colors": "^1.5.0",
-    "@rockcarver/frodo-lib": "0.12.2-9",
+    "@rockcarver/frodo-lib": "0.12.2-10",
     "cli-progress": "^3.11.2",
     "cli-table3": "^0.6.2",
     "commander": "^9.4.0",
@@ -115,6 +115,7 @@
     "jest": "^28.1.3",
     "map-stream": "^0.0.7",
     "pkg": "^5.8.0",
-    "prettier": "^2.7.1"
+    "prettier": "^2.7.1",
+    "typescript": "^4.8.3"
   }
 }

package/src/app.js

@@ -3,7 +3,8 @@
 import { getVersion, ConnectionProfile } from '@rockcarver/frodo-lib';
 import fs from 'fs';
 import { Command } from 'commander';
-// import pkg from '../package.json' assert { type: 'json' };
+import path from 'path';
+import { fileURLToPath } from 'url';
 
 // commands
 import admin from './cli/admin/admin.js';
@@ -21,8 +22,10 @@ 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(new URL('../package.json', import.meta.url))
+  fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8')
 );
 
 const { initConnectionProfiles } = ConnectionProfile;

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

@@ -102,16 +102,16 @@ program
               options.lltEsv,
               options.lltTtl
             );
-            table.push(['Secret Name'.brightCyan, response.secret]);
-            table.push(['Scope'.brightCyan, response.scope]);
+            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]);
+            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]);
+        table.push(['Client ID'['brightCyan'], clientId]);
+        table.push(['Client Secret'['brightCyan'], clientSecret]);
         console.log(table.toString());
       }
     }

package/src/cli/esv/esv-apply.js

@@ -70,24 +70,24 @@ program
           'Modifier',
         ]);
         for (const secret of updates.secrets) {
-          if (!secret.loaded) {
+          if (!secret['loaded']) {
             updatesTable.push([
               'secret',
-              secret._id,
-              new Date(secret.lastChangeDate).toLocaleString(),
+              secret['_id'],
+              new Date(secret['lastChangeDate']).toLocaleString(),
               // eslint-disable-next-line no-await-in-loop
-              await resolveUserName('teammember', secret.lastChangedBy),
+              await resolveUserName('teammember', secret['lastChangedBy']),
             ]);
           }
         }
         for (const variable of updates.variables) {
-          if (!variable.loaded) {
+          if (!variable['loaded']) {
             updatesTable.push([
               'variable',
-              variable._id,
-              new Date(variable.lastChangeDate).toLocaleString(),
+              variable['_id'],
+              new Date(variable['lastChangeDate']).toLocaleString(),
               // eslint-disable-next-line no-await-in-loop
-              await resolveUserName('teammember', variable.lastChangedBy),
+              await resolveUserName('teammember', variable['lastChangedBy']),
             ]);
           }
         }

package/src/cli/esv/esv-secret-describe.js

@@ -1,8 +1,8 @@
 import { Command, Option } from 'commander';
-import { Authenticate, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Secrets, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
-const { getTokens, Secrets } = Authenticate;
+const { getTokens } = Authenticate;
 const { describeSecret } = Secrets;
 
 const program = new Command('frodo esv secret describe');

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

@@ -3,7 +3,11 @@ import { Authenticate, Idp, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
-const { exportProvider, exportProvidersToFile, exportProvidersToFiles } = Idp;
+const {
+  exportSocialProviderToFile,
+  exportSocialProvidersToFile,
+  exportSocialProvidersToFiles,
+} = Idp;
 
 const program = new Command('frodo idp export');
 
@@ -58,17 +62,17 @@ program
               options.idpId
             }" from realm "${state.default.session.getRealm()}"...`
           );
-          exportProvider(options.idpId, options.file);
+          exportSocialProviderToFile(options.idpId, options.file);
         }
         // --all -a
         else if (options.all) {
           console.log('Exporting all providers to a single file...');
-          exportProvidersToFile(options.file);
+          exportSocialProvidersToFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate) {
           console.log('Exporting all providers to separate files...');
-          exportProvidersToFiles();
+          exportSocialProvidersToFiles();
         }
         // unrecognized combination of options or no options
         else {

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

@@ -4,10 +4,10 @@ import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
 const {
-  importProviderById,
-  importFirstProvider,
-  importProvidersFromFile,
-  importProvidersFromFiles,
+  importSocialProviderFromFile,
+  importFirstSocialProviderFromFile,
+  importSocialProvidersFromFile,
+  importSocialProvidersFromFiles,
 } = Idp;
 
 const program = new Command('frodo idp import');
@@ -63,21 +63,21 @@ program
               options.idpId
             }" into realm "${state.default.session.getRealm()}"...`
           );
-          importProviderById(options.idpId, options.file);
+          importSocialProviderFromFile(options.idpId, options.file);
         }
         // --all -a
         else if (options.all && options.file) {
           console.log(
             `Importing all providers from a single file (${options.file})...`
           );
-          importProvidersFromFile(options.file);
+          importSocialProvidersFromFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate && !options.file) {
           console.log(
             'Importing all providers from separate files in current directory...'
           );
-          importProvidersFromFiles();
+          importSocialProvidersFromFiles();
         }
         // import first provider from file
         else if (options.file) {
@@ -86,7 +86,7 @@ program
               options.file
             }" into realm "${state.default.session.getRealm()}"...`
           );
-          importFirstProvider(options.file);
+          importFirstSocialProviderFromFile(options.file);
         }
         // unrecognized combination of options or no options
         else {

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

@@ -3,7 +3,7 @@ import { Authenticate, Idp, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
-const { listProviders } = Idp;
+const { listSocialProviders } = Idp;
 
 const program = new Command('frodo idp list');
 
@@ -33,7 +33,7 @@ program
         console.log(
           `Listing providers in realm "${state.default.session.getRealm()}"...`
         );
-        listProviders();
+        listSocialProviders();
       }
     }
     // end command logic inside action handler

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

@@ -4,7 +4,7 @@ import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
-const { getJourneys, exportTree, describeTree } = Journey;
+const { getJourneys, exportJourney, describeJourney } = Journey;
 
 const program = new Command('frodo journey describe');
 
@@ -61,7 +61,7 @@ program
         try {
           const data = fs.readFileSync(options.file, 'utf8');
           const journeyData = JSON.parse(data);
-          describeTree(journeyData);
+          describeJourney(journeyData);
         } catch (error) {
           console.log(error.message);
           process.exitCode = 1;
@@ -76,8 +76,8 @@ program
           for (const journey of journeys) {
             try {
               // eslint-disable-next-line no-await-in-loop
-              const treeData = await exportTree(journey._id);
-              describeTree(treeData);
+              const treeData = await exportJourney(journey['_id']);
+              describeJourney(treeData);
             } catch (error) {
               console.log(error.message);
               process.exitCode = 1;
@@ -85,8 +85,8 @@ program
           }
         } else {
           try {
-            const treeData = await exportTree(options.journeyId);
-            describeTree(treeData);
+            const treeData = await exportJourney(options.journeyId);
+            describeJourney(treeData);
           } catch (error) {
             console.log(error.message);
             process.exitCode = 1;

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

@@ -1,9 +1,9 @@
 import { Command, Option } from 'commander';
-import { Authenticate, Saml, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Saml2, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
-const { describeProvider } = Saml;
+const { describeSaml2Provider } = Saml2;
 
 const program = new Command('frodo saml describe');
 
@@ -33,7 +33,7 @@ program
             options.entityId
           } in realm "${state.default.session.getRealm()}"...`
         );
-        describeProvider(options.entityId);
+        describeSaml2Provider(options.entityId);
       }
     }
     // end command logic inside action handler

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

@@ -1,10 +1,14 @@
 import { Command, Option } from 'commander';
-import { Authenticate, Saml, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Saml2, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
 
-const { exportProvider, exportProvidersToFile, exportProvidersToFiles } = Saml;
+const {
+  exportSaml2ProviderToFile,
+  exportSaml2ProvidersToFile,
+  exportSaml2ProvidersToFiles,
+} = Saml2;
 
 const program = new Command('frodo saml export');
 
@@ -59,17 +63,17 @@ program
               options.entityId
             }" from realm "${state.default.session.getRealm()}"...`
           );
-          exportProvider(options.entityId, options.file);
+          exportSaml2ProviderToFile(options.entityId, options.file);
         }
         // --all -a
         else if (options.all) {
           console.log('Exporting all providers to a single file...');
-          exportProvidersToFile(options.file);
+          exportSaml2ProvidersToFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate) {
           console.log('Exporting all providers to separate files...');
-          exportProvidersToFiles();
+          exportSaml2ProvidersToFiles();
         }
         // unrecognized combination of options or no options
         else {

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

@@ -1,15 +1,15 @@
 import { Command, Option } from 'commander';
-import { Authenticate, Saml, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Saml2, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
 
 const {
-  importProvider,
-  importProvidersFromFile,
-  importProvidersFromFiles,
-  importFirstProvider,
-} = Saml;
+  importSaml2ProviderFromFile,
+  importSaml2ProvidersFromFile,
+  importSaml2ProvidersFromFiles,
+  importFirstSaml2ProviderFromFile,
+} = Saml2;
 
 const program = new Command('frodo saml import');
 
@@ -64,21 +64,21 @@ program
               options.entityId
             }" into realm "${state.default.session.getRealm()}"...`
           );
-          importProvider(options.entityId, options.file);
+          importSaml2ProviderFromFile(options.entityId, options.file);
         }
         // --all -a
         else if (options.all && options.file) {
           console.log(
             `Importing all providers from a single file (${options.file})...`
           );
-          importProvidersFromFile(options.file);
+          importSaml2ProvidersFromFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate && !options.file) {
           console.log(
             'Importing all providers from separate files (*.saml.json) in current directory...'
           );
-          importProvidersFromFiles();
+          importSaml2ProvidersFromFiles();
         }
         // import first provider from file
         else if (options.file) {
@@ -87,7 +87,7 @@ program
               options.file
             }" into realm "${state.default.session.getRealm()}"...`
           );
-          importFirstProvider(options.file);
+          importFirstSaml2ProviderFromFile(options.file);
         }
         // unrecognized combination of options or no options
         else {

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

@@ -1,9 +1,9 @@
 import { Command, Option } from 'commander';
-import { Authenticate, Saml, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Saml2, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
-const { listProviders } = Saml;
+const { listSaml2Providers } = Saml2;
 
 const program = new Command('frodo saml list');
 
@@ -33,7 +33,7 @@ program
         console.log(
           `Listing SAML entity providers in realm "${state.default.session.getRealm()}"...`
         );
-        listProviders(options.long);
+        listSaml2Providers(options.long);
       }
     }
     // end command logic inside action handler

package/src/cli/saml/saml-metadata-export.js

@@ -1,10 +1,10 @@
 import { Command, Option } from 'commander';
-import { Authenticate, Saml, state } from '@rockcarver/frodo-lib';
+import { Authenticate, Saml2, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
 
 const { getTokens } = Authenticate;
 
-const { exportMetadata } = Saml;
+const { exportSaml2Metadata } = Saml2;
 
 const program = new Command('frodo saml metadata export');
 
@@ -53,7 +53,7 @@ program
               options.entityId
             }" from realm "${state.default.session.getRealm()}"...`
           );
-          exportMetadata(options.entityId, options.file);
+          exportSaml2Metadata(options.entityId, options.file);
         }
         // // --all-separate -A
         // else if (options.allSeparate) {

package/src/cli/theme/theme-delete.js

@@ -52,7 +52,7 @@ program
               options.themeName
             }" from realm "${state.default.session.getRealm()}"...`
           );
-          deleteThemeByNameCmd(options.themeName, options.file);
+          deleteThemeByNameCmd(options.themeName);
         }
         // delete by id
         else if (options.themeId) {
@@ -61,14 +61,14 @@ program
               options.themeId
             }" from realm "${state.default.session.getRealm()}"...`
           );
-          deleteThemeCmd(options.themeId, options.file);
+          deleteThemeCmd(options.themeId);
         }
         // --all -a
         else if (options.all) {
           console.log(
             `Deleting all themes from realm "${state.default.session.getRealm()}"...`
           );
-          deleteThemesCmd(options.file);
+          deleteThemesCmd();
         }
         // unrecognized combination of options or no options
         else {

package/src/utils/Console.js

@@ -105,7 +105,7 @@ export function printMessage(message, type = 'text', newline = true) {
       if (newline) {
         info(message);
       } else {
-        process.stderr.write(message.brightCyan);
+        process.stderr.write(message['brightCyan']);
       }
       break;
     case 'warn':
@@ -119,14 +119,14 @@ export function printMessage(message, type = 'text', newline = true) {
       if (newline) {
         error(message);
       } else {
-        process.stderr.write(message.brightRed);
+        process.stderr.write(message['brightRed']);
       }
       break;
     default:
       if (newline) {
         error(message);
       } else {
-        process.stderr.write(message.bgBrightRed);
+        process.stderr.write(message['bgBrightRed']);
       }
   }
 }
@@ -315,11 +315,11 @@ export function stopProgressIndicator(message, status = 'none') {
 
 /**
  * Create an empty table
- * @param {[String]} head header row as an array of strings
- * @returns {CliTable3} an empty table
+ * @param {string[]} head header row as an array of strings
+ * @returns {any} an empty table
  */
 export function createTable(head) {
-  return new Table({
+  const table = new Table({
     head,
     chars: {
       top: '',
@@ -339,14 +339,15 @@ export function createTable(head) {
     },
     style: { 'padding-left': 0, 'padding-right': 0, head: ['brightCyan'] },
   });
+  return table;
 }
 
 /**
  * Create a new key/value table
- * @returns {CliTable3} an empty key/value table
+ * @returns {any} an empty key/value table
  */
 export function createKeyValueTable() {
-  return new Table({
+  const table = new Table({
     chars: {
       top: '',
       'top-mid': '',
@@ -366,6 +367,7 @@ export function createKeyValueTable() {
     style: { 'padding-left': 0, 'padding-right': 0 },
     wordWrap: true,
   });
+  return table;
 }
 
 /**
@@ -398,10 +400,10 @@ function hasValues(object) {
 
 /**
  * Helper function (recursive) to add rows to an object table
- * @param {Object} object object to render
- * @param {Number} depth total depth of initial object
- * @param {Number} level current level
- * @param {CliTable3} table the object table to add the rows to
+ * @param {object} object object to render
+ * @param {number} depth total depth of initial object
+ * @param {number} level current level
+ * @param {any} table the object table to add the rows to
  * @returns the updated object table
  */
 function addRows(object, depth, level, table, keyMap) {
@@ -411,7 +413,7 @@ function addRows(object, depth, level, table, keyMap) {
     if (Object(object[key]) !== object[key]) {
       if (level === 1) {
         table.push([
-          keyMap[key] ? keyMap[key].brightCyan : key.brightCyan,
+          keyMap[key] ? keyMap[key].brightCyan : key['brightCyan'],
           object[key],
         ]);
       } else {
@@ -433,7 +435,7 @@ function addRows(object, depth, level, table, keyMap) {
         if (level < 3) indention = `\n${indention}`;
         table.push([
           indention.concat(
-            keyMap[key] ? keyMap[key].brightCyan : key.brightCyan
+            keyMap[key] ? keyMap[key].brightCyan : key['brightCyan']
           ),
           '',
         ]);
@@ -448,7 +450,7 @@ function addRows(object, depth, level, table, keyMap) {
 /**
  * Create and populate an object table from any JSON object. Use for describe commands.
  * @param {Object} object JSON object to create
- * @returns {CliTable3} a table that can be printed to the console
+ * @returns {any} a table that can be printed to the console
  */
 export function createObjectTable(object, keyMap = {}) {
   // eslint-disable-next-line no-param-reassign

package/tsconfig.json

@@ -7,7 +7,7 @@
     // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
     // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
     // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    "disableSolutionSearching": false /* Opt a project out of multi-project reference checking when editing. */,
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
@@ -41,7 +41,7 @@
 
     /* JavaScript Support */
     "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    "checkJs": true /* Enable error reporting in type-checked JavaScript files. */,
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 
     /* Emit */
@@ -71,7 +71,7 @@
     /* Interop Constraints */
     "isolatedModules": false /* Ensure that each file can be safely transpiled without relying on other imports. */,
     "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
-    "esModuleInterop": false /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
     // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
     "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
 
@@ -102,5 +102,5 @@
   },
   "files": ["src/app.js"],
   "include": ["src/**/*.js"],
-  "exclude": ["src/**/*.test.js"]
+  "exclude": ["src/**/*.test.js", "src/**/*.test_.js"]
 }