@rockcarver/frodo-cli 0.10.4 → 0.11.1-2

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

@@ -1,13 +1,9 @@
 import { Command, Option } from 'commander';
+import { Authenticate, Theme, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
-import { getTokens } from '../../ops/AuthenticateOps.js';
-import storage from '../../storage/SessionStorage.js';
-import { printMessage } from '../../ops/utils/Console.js';
-import {
-  deleteThemeByNameCmd,
-  deleteThemeCmd,
-  deleteThemesCmd,
-} from '../../ops/ThemeOps.js';
+
+const { getTokens } = Authenticate;
+const { deleteThemeByNameCmd, deleteThemeCmd, deleteThemesCmd } = Theme;
 
 const program = new Command('frodo theme delete');
 
@@ -42,41 +38,41 @@ program
   .action(
     // implement command logic inside action handler
     async (host, realm, user, password, options) => {
-      storage.session.setTenant(host);
-      storage.session.setRealm(realm);
-      storage.session.setUsername(user);
-      storage.session.setPassword(password);
-      storage.session.setDeploymentType(options.type);
-      storage.session.setAllowInsecureConnection(options.insecure);
+      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()) {
         // delete by name
         if (options.themeName) {
-          printMessage(
+          console.log(
             `Deleting theme with name "${
               options.themeName
-            }" from realm "${storage.session.getRealm()}"...`
+            }" from realm "${state.default.session.getRealm()}"...`
           );
           deleteThemeByNameCmd(options.themeName, options.file);
         }
         // delete by id
         else if (options.themeId) {
-          printMessage(
+          console.log(
             `Deleting theme with id "${
               options.themeId
-            }" from realm "${storage.session.getRealm()}"...`
+            }" from realm "${state.default.session.getRealm()}"...`
           );
           deleteThemeCmd(options.themeId, options.file);
         }
         // --all -a
         else if (options.all) {
-          printMessage(
-            `Deleting all themes from realm "${storage.session.getRealm()}"...`
+          console.log(
+            `Deleting all themes from realm "${state.default.session.getRealm()}"...`
           );
           deleteThemesCmd(options.file);
         }
         // unrecognized combination of options or no options
         else {
-          printMessage('Unrecognized combination of options or no options...');
+          console.log('Unrecognized combination of options or no options...');
           program.help();
         }
       }

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

@@ -1,14 +1,15 @@
 import { Command, Option } from 'commander';
+import { Authenticate, Theme, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
-import { getTokens } from '../../ops/AuthenticateOps.js';
-import storage from '../../storage/SessionStorage.js';
-import { printMessage } from '../../ops/utils/Console.js';
-import {
+
+const { getTokens } = Authenticate;
+
+const {
   exportThemeById,
   exportThemeByName,
   exportThemesToFile,
   exportThemesToFiles,
-} from '../../ops/ThemeOps.js';
+} = Theme;
 
 const program = new Command('frodo theme export');
 
@@ -55,44 +56,44 @@ program
   .action(
     // implement command logic inside action handler
     async (host, realm, user, password, options) => {
-      storage.session.setTenant(host);
-      storage.session.setRealm(realm);
-      storage.session.setUsername(user);
-      storage.session.setPassword(password);
-      storage.session.setDeploymentType(options.type);
-      storage.session.setAllowInsecureConnection(options.insecure);
+      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 name
         if (options.themeName) {
-          printMessage(
+          console.log(
             `Exporting theme "${
               options.themeName
-            }" from realm "${storage.session.getRealm()}"...`
+            }" from realm "${state.default.session.getRealm()}"...`
           );
           exportThemeByName(options.themeName, options.file);
         }
         // export by id
         else if (options.themeId) {
-          printMessage(
+          console.log(
             `Exporting theme "${
               options.themeId
-            }" from realm "${storage.session.getRealm()}"...`
+            }" from realm "${state.default.session.getRealm()}"...`
           );
           exportThemeById(options.themeId, options.file);
         }
         // --all -a
         else if (options.all) {
-          printMessage('Exporting all themes to a single file...');
+          console.log('Exporting all themes to a single file...');
           exportThemesToFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate) {
-          printMessage('Exporting all themes to separate files...');
+          console.log('Exporting all themes to separate files...');
           exportThemesToFiles();
         }
         // unrecognized combination of options or no options
         else {
-          printMessage(
+          console.log(
             'Unrecognized combination of options or no options...',
             'error'
           );

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

@@ -1,15 +1,16 @@
 import { Command, Option } from 'commander';
+import { Authenticate, Theme, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
-import { getTokens } from '../../ops/AuthenticateOps.js';
-import storage from '../../storage/SessionStorage.js';
-import { printMessage } from '../../ops/utils/Console.js';
-import {
+
+const { getTokens } = Authenticate;
+
+const {
   importFirstThemeFromFile,
   importThemeById,
   importThemeByName,
   importThemesFromFile,
   importThemesFromFiles,
-} from '../../ops/ThemeOps.js';
+} = Theme;
 
 const program = new Command('frodo theme import');
 
@@ -56,57 +57,57 @@ program
   .action(
     // implement command logic inside action handler
     async (host, realm, user, password, options) => {
-      storage.session.setTenant(host);
-      storage.session.setRealm(realm);
-      storage.session.setUsername(user);
-      storage.session.setPassword(password);
-      storage.session.setDeploymentType(options.type);
-      storage.session.setAllowInsecureConnection(options.insecure);
+      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 name
         if (options.file && options.themeName) {
-          printMessage(
+          console.log(
             `Importing theme with name "${
               options.themeName
-            }" into realm "${storage.session.getRealm()}"...`
+            }" into realm "${state.default.session.getRealm()}"...`
           );
           importThemeByName(options.themeName, options.file);
         }
         // import by id
         else if (options.file && options.themeId) {
-          printMessage(
+          console.log(
             `Importing theme with id "${
               options.themeId
-            }" into realm "${storage.session.getRealm()}"...`
+            }" into realm "${state.default.session.getRealm()}"...`
           );
           importThemeById(options.themeId, options.file);
         }
         // --all -a
         else if (options.all && options.file) {
-          printMessage(
+          console.log(
             `Importing all themes from a single file (${options.file})...`
           );
           importThemesFromFile(options.file);
         }
         // --all-separate -A
         else if (options.allSeparate && !options.file) {
-          printMessage(
+          console.log(
             'Importing all themes from separate files in current directory...'
           );
           importThemesFromFiles();
         }
         // import single theme from file
         else if (options.file) {
-          printMessage(
+          console.log(
             `Importing first theme from file "${
               options.file
-            }" into realm "${storage.session.getRealm()}"...`
+            }" into realm "${state.default.session.getRealm()}"...`
           );
           importFirstThemeFromFile(options.file);
         }
         // unrecognized combination of options or no options
         else {
-          printMessage('Unrecognized combination of options or no options...');
+          console.log('Unrecognized combination of options or no options...');
           program.help();
         }
       }

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

@@ -1,9 +1,9 @@
 import { Command, Option } from 'commander';
+import { Authenticate, Theme, state } from '@rockcarver/frodo-lib';
 import * as common from '../cmd_common.js';
-import { getTokens } from '../../ops/AuthenticateOps.js';
-import storage from '../../storage/SessionStorage.js';
-import { printMessage } from '../../ops/utils/Console.js';
-import { listThemes } from '../../ops/ThemeOps.js';
+
+const { getTokens } = Authenticate;
+const { listThemes } = Theme;
 
 const program = new Command('frodo theme list');
 
@@ -23,15 +23,15 @@ program
   .action(
     // implement command logic inside action handler
     async (host, realm, user, password, options) => {
-      storage.session.setTenant(host);
-      storage.session.setRealm(realm);
-      storage.session.setUsername(user);
-      storage.session.setPassword(password);
-      storage.session.setDeploymentType(options.type);
-      storage.session.setAllowInsecureConnection(options.insecure);
+      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()) {
-        printMessage(
-          `Listing themes in realm "${storage.session.getRealm()}"...`
+        console.log(
+          `Listing themes in realm "${state.default.session.getRealm()}"...`
         );
         listThemes(options.long);
       }

package/.eslintrc

@@ -1,29 +0,0 @@
-{
-  "extends": ["airbnb", "prettier"],
-  "parser": "@babel/eslint-parser",
-  "plugins": ["prettier", "jest"],
-  "rules": {
-    "prettier/prettier": ["error"],
-    "import/extensions": [
-      "error",
-      {
-        "js": "always",
-        "json": "always"
-      }
-    ],
-    "no-console": "off",
-    "no-underscore-dangle": "off",
-    "no-restricted-syntax": [
-      "error",
-      // "ForInStatement",
-      // "ForOfStatement",
-      "LabeledStatement",
-      "WithStatement"
-    ],
-    "no-multi-str": "off"
-  },
-  "env": {
-    "jest": true,
-    "jest/globals": true
-  }
-}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,30 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Run command with parameters '...'
-2. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots/command output to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for frodo
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/README.md

@@ -1,273 +0,0 @@
-<!-- README.md for GitHub; the one for NPM is ../README.md. -->
-# Frodo - ForgeROck DO
-
-This is the ForgeROck DO - or short frodo - command line interface, a CLI to manage ForgeRock platform deployments. Frodo supports Identity Cloud tenants, ForgeOps deployments, and classic deployments.
-
-Frodo is the successor to field tools like [amtree.sh](https://github.com/vscheuber/AM-treetool), [fidc-debug-tools](https://github.com/vscheuber/fidc-debug-tools), and ForgeRock-internal utilities.
-
-## Quick start
-
-1. Download the platform specific binary archive from the [release page](https://github.com/rockcarver/frodo/releases) and unzip it to a directory.
-2. Open a terminal and change to the above directory.
-3. Run `frodo conn add` (example below) to setup `frodo` for your ForgeRock environment. If all parameters are correct, `frodo` creates a new [connection profile](#connection-profiles). If you are offline and don't want to validate the data you enter, you can use the --no-validate paramter and frodo stores the [connection profile](#connection-profiles) without validating it.
-    ```console
-    $ frodo conn add https://openam-tenant-name.forgeblocks.com/am john.doe@company.com '5uP3r-53cr3t!'
-    ForgeRock Identity Cloud detected.
-    Connected to ForgeRock Access Management 7.2.0-2022-6-SNAPSHOT Build ee394dde039e790642653a516d498c16759876c1 (2022-July-07 19:49)
-    Saving creds in /Users/john.doe/.frodo/.frodorc...
-    ```
-    **NOTE: MacOS and Windows may not let you run `frodo` right after you download (and unzip) and execute it for the very first time. Please refer to [this page](../docs/BINARIES.md) if this happens.**
-
-4. Test your connection profile using a simple convenience feature in frodo:
-    ```console
-    $ frodo info tenant-name
-    Printing versions and tokens...
-    ForgeRock Identity Cloud detected.
-    Connected to ForgeRock Access Management 7.2.0-2022-6-SNAPSHOT Build ee394dde039e790642653a516d498c16759876c1 (2022-July-07 19:49)
-    Cookie name: 6ac6499e9da2071
-    Session token: g9CMhj7k9Asq...
-    Bearer token: eyJ0eXAiOiJKV...
-    ```
-    Note how the command does not specify the complete tenant URL nor username nor password. I only uses a unique substring that matches the tenant URL and frodo looks up and uses the right [connection profile](#connection-profiles).
-
-5. Now you can use other frodo commands, like `journey`, `logs`, `applications` etc. as desired. **For detailed usage, refer to [this](#usage)**
-
-## Quick Nav
-
-- [Features](#features)
-- [Limitations](#limitations)
-- [Installing](#installing)
-- [Usage](#usage)
-- [Request features or report issues](#feature-requests)
-- [Contributing](#contributing)
-- [Maintaining](#maintaining)
-
-## Features
-
-Frodo allows an administrator to easily connect to and manage any number of Identity Cloud tenants, ForgeOps deployment instances, or classic deployment instances from the command line. The following tasks are currently supported:
-
-- User mode
-
-  Install and run pre-compiled single binaries without any dependencies for MacOS, Windows, and Linux.
-
-- Manage journeys/trees.
-
-  Export, import and pruning of journeys. Frodo handles referenced scripts and email templates.
-
-- Manage applications.
-
-  List, export, and import applications (OAuth2 clients).
-
-- Manage connection profiles.
-
-  Saving and reading credentials (for multiple ForgeRock deployments) from a configuration file.
-
-- Manage email templates.
-
-  List, export, and import email templates.
-
-- Manage IDM configuration.
-
-  Export of IDM configuration. Import is coming.
-
-- Print versions and tokens.
-
-  Obtain ForgeRock session token and admin access_tokens for a ForgeRock Identity Cloud or platform (ForgeOps) deployment
-
-- View Identity Cloud logs.
-
-  List available log sources and tail them.
-
-- Manage realms.
-
-  List realms and show realm details. Allow adding and removing of custom DNS names.
-
-- Manage scripts.
-
-  List, export, and import scripts.
-
-- Manage Identity Cloud environment specific variables and secrets.
-
-  List and view details of secrets and variables in Identity Cloud.
-
-- Platform admin tasks.
-
-  Common tasks administrators need to perform daily that are tedious and repetitive. Advanced tasks, which used to be involved and potentially dangerous if performed manually, now made easy and safe.
-
-  - Create an oauth2 client with admin privileges.
-  - Get an access token using client credentials grant type.
-  - List oauth2 clients with admin privileges.
-  - Grant an oauth2 client admin privileges.
-  - Revoke admin privileges from an oauth2 client.
-  - List oauth2 clients with custom privileges.
-  - List all subjects of static user mappings that are not oauth2 clients.
-  - Remove a subject's static user mapping.
-  - Add AutoId static user mapping to enable dashboards and other AutoId-based functionality.
-  - Hide generic extension attributes.
-  - Show generic extension attributes.
-  - Repair org model (beta).
-
-- Developer mode
-
-  Install and run in developer mode (npm i -g)
-
-## Limitations
-
-`frodo` can't export passwords (including API secrets, etc), so these need to be manually added back to imported configuration or alternatively, edit the export file to add the missing fields before importing.
-
-## Installing
-
-### User Mode
-Individuals who do not intend to develop or contribute to frodo should use this method. Please refer to [Quick Start](#quick-start)
-
-### Developer Mode
-For those who want to contribute or are just curious about the build process.
-
-- Make sure you have Node.js v18 (the version used by developers) or newer and npm.
-- Clone this repo
-  ```console
-  git clone https://github.com/rockcarver/frodo.git
-  ```
-- Install via NPM
-  ```console
-  cd frodo
-  npm install
-  npm i -g
-  ```
-
-### NPM package
-If you are a node developer and want to use frodo as a cli tool or as a library for your own applications, you can install the npm package:
-
-- To install the latest version as a cli tool:
-  ```console
-  npm i -g @rockcarver/frodo-cli
-  ```
-- To install the latest version as a dependency for you own application:
-  ```console
-  npm i --save @rockcarver/frodo-cli
-  ```
-- To install the latest pre-release:
-  ```console
-  npm i @rockcarver/frodo-cli@next
-  ```
-
-## Usage
-
-You can invoke `frodo` from the terminal as long as you're in the directory or sourced/added it to the path.
-
-To get started, refer to [Quick Start](#quick-start).
-
-### Connection Profiles
-A connection profile is a set of ForgeRock environment URL (Access Management base URL), admin username and admin password. It can optionally contain log API key and secret for a ForgeRock Identity Cloud environment. All connection profiless are stored in `~/.frodo/.frodorc`. Passwords are stored encrypted. `.frodorc` can house information for multiple connections.
-
-Use the `frodo conn` sub-commands to manage connections:
--   `frodo conn list` to list all the connections frodo currently knows about for the current machine and user.
--   `frodo conn add` to add a new connection profile.
--   `frodo conn describe` to see all the details of a connection profile.
--   `frodo conn delete` to remove a connection profile.
-
-Once `frodo` saves a connection, you don't have to provide the `host`, `username`, and `password` arguments. You can reference your connection using any unique substring from your host. This is the most common way users would run frodo. For example, if `https://openam-example-use1-dev.id.forgerock.io/am` and `https://openam-example-use1-staging.id.forgerock.io/am` are two saved ForgeRock connections from previous commands, one would simply use:
-
-```console
-frodo info example-use1-dev
-```
-OR
-```console
-frodo info example-use1-staging
-```
-
-### cli options
-You interact with `frodo` using commands and options. You can see the list of options by using the `help` command
-
-```console
-frodo help
-```
-
-```console
-Usage: frodo [options] [command]
-
-Options:
-  -v, --version                            output the version number
-  -h, --help                               display help for command
-
-Commands:
-  admin                                    Platform admin tasks.
-  application                              Manage applications.
-  conn|connection                          Manage connection profiles.
-  email                                    Manage email templates and configuration.
-  esv                                      Manage Environment-Specific Variables (ESVs).
-  idm                                      Manage IDM configuration.
-  idp                                      Manage (social) identity providers.
-  info [options] <host> [user] [password]  Print versions and tokens.
-  journey                                  Manage journeys/trees.
-  logs                                     List/View Identity Cloud logs
-  realm                                    Manage realms.
-  saml                                     Manage SAML entity providers and circles of trust.
-  script                                   Manage scripts.
-  theme                                    Manages themes.
-  help [command]                           display help for command
-```
-
-Or to view options for a specific command
-
-```console
-frodo help journey
-```
-
-```console
-Usage: frodo journey [options] [command]
-
-Manage journeys/trees.
-
-Options:
-  -h, --help      Help
-
-Commands:
-  list            List journeys/trees.
-  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.
-  export          Export journeys/trees.
-  import          Import journeys/trees.
-  delete          Delete journeys/trees.
-  prune           Prune orphaned configuration artifacts left behind after deleting authentication trees. You will be prompted before any destructive operations are performed.
-  help [command]  display help for command
-```
-
-```console
-frodo journey help export
-```
-
-```console
-Usage: frodo journey export [options] <host> [realm] [user] [password]
-
-Export journeys/trees.
-
-Arguments:
-  host                        Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.
-  realm                       Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise. (default: "alpha" for Identity Cloud tenants, "/" otherwise.)
-  user                        Username to login with. Must be an admin user with appropriate rights to manage authentication journeys/trees.
-  password                    Password.
-
-Options:
-  -m, --type <type>           Override auto-detected deployment type. Valid values for type:
-                              classic:  A classic Access Management-only deployment with custom layout and configuration.
-                              cloud:    A ForgeRock Identity Cloud environment.
-                              forgeops: A ForgeOps CDK or CDM deployment.
-                              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 (choices: "classic", "cloud", "forgeops")
-  -k, --insecure              Allow insecure connections when using SSL/TLS (default: Don't allow insecure connections)
-  -i, --journey-id <journey>  Name of a journey/tree. If specified, -a and -A are ignored.
-  -f, --file <file>           Name of the file to write the exported journey(s) to. Ignored with -A.
-  -a, --all                   Export all the journeys/trees in a realm. Ignored with -i.
-  -A, --all-separate          Export all the journeys/trees in a realm as separate files <journey/tree name>.json. Ignored with -i or -a.
-  --use-string-arrays         Where applicable, use string arrays to store multi-line text (e.g. scripts). (default: off)
-  -h, --help                  Help
-```
-
-## Feature requests
-Please use the repository's [issues](https://github.com/rockcarver/frodo/issues) to request new features/enhancements or report bugs/issues.
-
-## Contributing
-If you would like to contribute to frodo, please refer to the [contributing instructions](../docs/CONTRIBUTE.md).
-
-## Maintaining
-If you are a maintainer of this repository, please refer to the [pipeline and release process instructions](../docs/PIPELINE.md).