@rockcarver/frodo-cli 0.16.2-1 → 0.17.1

package/CHANGELOG.md

@@ -7,8 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.17.1] - 2022-10-17
+
+### Changed
+
+-   Updated frodo-lib to 0.15.2
+-   Added options to `frodo journey describe` command:
+    -   Added `--verbose` option
+    -   Added `--debug` option
+
+## [0.17.0] - 2022-10-16
+
+### Changed
+
+-   Updated frodo-lib to 0.15.1
+
+### Added
+
+-   \#82: Check for updates
+-   \#86: Support markdown output with `frodo journey describe` command
+    -   Added new `--markdown` option to enable markdown output
+    -   Added new `--output-file` option to enable writing output to a file
+
+### Fixed
+
+-   \#88: `frodo idm export` now properly regognizes  `-N`/`--name` option
+
 ## [0.16.2-1] - 2022-10-11
 
+### Added
+
+-   \#82: Check for updates
+
 ## [0.16.2-0] - 2022-10-11
 
 ### Added
@@ -662,7 +692,11 @@ 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.16.2-1...HEAD
+[Unreleased]: https://github.com/rockcarver/frodo-cli/compare/v0.17.1...HEAD
+
+[0.17.1]: https://github.com/rockcarver/frodo-cli/compare/v0.17.0...v0.17.1
+
+[0.17.0]: https://github.com/rockcarver/frodo-cli/compare/v0.16.2-1...v0.17.0
 
 [0.16.2-1]: https://github.com/rockcarver/frodo-cli/compare/v0.16.2-0...v0.16.2-1
 

package/esm/cli/cmd_common.js

@@ -1,13 +1,13 @@
 import { Argument, Option } from 'commander';
 import { state } from '@rockcarver/frodo-lib';
 import * as global from '../storage/StaticStorage.js';
-import { printMessage, createProgressIndicator, updateProgressIndicator, stopProgressIndicator, verbose, debug } from '../utils/Console.js';
+import { printMessage, createProgressIndicator, updateProgressIndicator, stopProgressIndicator, verboseMessage, debugMessage } from '../utils/Console.js';
 state.default.session.setPrintHandler(printMessage);
+state.default.session.setVerboseHandler(verboseMessage);
+state.default.session.setDebugHandler(debugMessage);
 state.default.session.setCreateProgressHandler(createProgressIndicator);
 state.default.session.setUpdateProgressHandler(updateProgressIndicator);
-state.default.session.setStopProgressHandler(stopProgressIndicator);
-state.default.session.setVerboseHandler(verbose);
-state.default.session.setDebugHandler(debug); // pseudo functions for commands that do not otherwise need to import
+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() {}

package/esm/cli/cmd_common.js.map

@@ -1 +1 @@
-{"version":3,"file":"cmd_common.js","names":["Argument","Option","state","global","printMessage","createProgressIndicator","updateProgressIndicator","stopProgressIndicator","verbose","debug","default","session","setPrintHandler","setCreateProgressHandler","setUpdateProgressHandler","setStopProgressHandler","setVerboseHandler","setDebugHandler","init","hostArgumentDescription","hostArgument","hostArgumentM","realmArgumentDescription","realmArgument","DEFAULT_REALM_KEY","realmArgumentM","userArgumentDescription","userArgument","userArgumentM","passwordArgumentDescription","passwordArgument","passwordArgumentM","apiKeyArgumentDescription","apiKeyArgument","apiSecretArgumentDescription","apiSecretArgument","treeOptionDescription","treeOption","treeOptionM","fileOptionDescription","fileOption","fileOptionM","deploymentOptionDescription","deploymentOption","choices","DEPLOYMENT_TYPES","deploymentOptionM","insecureOption","verboseOption","debugOption","managedNameOption","managedNameOptionM","dirOptionDescription","dirOption","dirOptionM","entitiesFileOptionDescription","entitiesFileOption","entitiesFileOptionM","envFileOptionDescription","envFileOption","envFileOptionM","sourcesOptionDescription","sourcesOptionDefaultValueDescription","sourcesOptionM","scriptFriendlyOption","makeOptionMandatory"],"sources":["cli/cmd_common.ts"],"sourcesContent":["import { Argument, Option } from 'commander';\nimport { state } from '@rockcarver/frodo-lib';\nimport * as global from '../storage/StaticStorage.js';\nimport {\n  printMessage,\n  createProgressIndicator,\n  updateProgressIndicator,\n  stopProgressIndicator,\n  verbose,\n  debug\n} from '../utils/Console.js';\n\nstate.default.session.setPrintHandler(printMessage);\nstate.default.session.setCreateProgressHandler(createProgressIndicator);\nstate.default.session.setUpdateProgressHandler(updateProgressIndicator);\nstate.default.session.setStopProgressHandler(stopProgressIndicator);\nstate.default.session.setVerboseHandler(verbose);\nstate.default.session.setDebugHandler(debug);\n\n// pseudo functions for commands that do not otherwise need to import\n// this file but need to trigger print and progress handler registration\nexport function init() {}\n\nconst hostArgumentDescription =\n  'Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.';\nexport const hostArgument = new Argument('[host]', hostArgumentDescription);\nexport const hostArgumentM = new Argument('<host>', hostArgumentDescription);\n\nconst realmArgumentDescription =\n  \"Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise.\";\nexport const realmArgument = new Argument(\n  '[realm]',\n  realmArgumentDescription\n).default(\n  global.DEFAULT_REALM_KEY,\n  '\"alpha\" for Identity Cloud tenants, \"/\" otherwise.'\n);\nexport const realmArgumentM = new Argument('<realm>', realmArgumentDescription);\n\nconst userArgumentDescription =\n  'Username to login with. Must be an admin user with appropriate rights to manage authentication journeys/trees.';\nexport const userArgument = new Argument('[user]', userArgumentDescription);\nexport const userArgumentM = new Argument('<user>', userArgumentDescription);\n\nconst passwordArgumentDescription = 'Password.';\nexport const passwordArgument = new Argument(\n  '[password]',\n  passwordArgumentDescription\n);\nexport const passwordArgumentM = new Argument(\n  '<password>',\n  passwordArgumentDescription\n);\n\nconst apiKeyArgumentDescription = 'API key for logging API.';\nexport const apiKeyArgument = new Argument('[key]', apiKeyArgumentDescription);\n\nconst apiSecretArgumentDescription = 'API secret for logging API.';\nexport const apiSecretArgument = new Argument(\n  '[secret]',\n  apiSecretArgumentDescription\n);\n\nconst treeOptionDescription =\n  'Specify the name of an authentication journey/tree.';\nexport const treeOption = new Option(\n  '-t, --tree <tree>',\n  treeOptionDescription\n);\nexport const treeOptionM = new Option(\n  '-t, --tree <tree>',\n  treeOptionDescription\n);\n\nconst fileOptionDescription = 'File name.';\nexport const fileOption = new Option(\n  '-f, --file <file>',\n  fileOptionDescription\n);\nexport const fileOptionM = new Option(\n  '-f, --file <file>',\n  fileOptionDescription\n);\n\nconst deploymentOptionDescription =\n  'Override auto-detected deployment type. Valid values for type: \\n\\\nclassic:  A classic Access Management-only deployment with custom layout and configuration. \\n\\\ncloud:    A ForgeRock Identity Cloud environment. \\n\\\nforgeops: A ForgeOps CDK or CDM deployment. \\n\\\nThe detected or provided deployment type controls certain behavior like obtaining an Identity \\\nManagement admin token or not and whether to export/import referenced email templates or how \\\nto walk through the tenant admin login flow of Identity Cloud and handle MFA';\nexport const deploymentOption = new Option(\n  '-m, --type <type>',\n  deploymentOptionDescription\n).choices(global.DEPLOYMENT_TYPES);\nexport const deploymentOptionM = new Option(\n  '-m, --type <type>',\n  deploymentOptionDescription\n).choices(global.DEPLOYMENT_TYPES);\n\nexport const insecureOption = new Option(\n  '-k, --insecure',\n  '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.'\n).default(false, \"Don't allow insecure connections\");\n\nexport const verboseOption = new Option(\n  '--verbose',\n  'Verbose output during command execution. If specified, may or may not produce additional output.'\n);\n\nexport const debugOption = new Option(\n  '--debug',\n  'Debug output during command execution. If specified, may or may not produce additional output helpful for troubleshooting.'\n);\n\nexport const managedNameOption = new Option(\n  '-N, --name <name>',\n  'Managed object name to be operated on. Examples are \\\nuser, role, alpha_user, alpha_role etc.'\n);\nexport const managedNameOptionM = new Option(\n  '-N, --name <name>',\n  'Managed object name to be operated on. Examples are \\\nuser, role, alpha_user, alpha_role etc.'\n);\n\nconst dirOptionDescription =\n  'Directory for exporting all configuration entities to.';\nexport const dirOption = new Option(\n  '-D, --directory <directory>',\n  dirOptionDescription\n);\nexport const dirOptionM = new Option(\n  '-D, --directory <directory>',\n  dirOptionDescription\n);\n\nconst entitiesFileOptionDescription =\n  'JSON file that specifies the config entities to export/import.';\nexport const entitiesFileOption = new Option(\n  '-E, --entitiesFile <file>',\n  entitiesFileOptionDescription\n);\nexport const entitiesFileOptionM = new Option(\n  '-E, --entitiesFile <file>',\n  entitiesFileOptionDescription\n);\n\nconst envFileOptionDescription =\n  'File that defines environment specific variables for replacement during configuration export/import.';\nexport const envFileOption = new Option(\n  '-e, --envFile <file>',\n  envFileOptionDescription\n);\nexport const envFileOptionM = new Option(\n  '-e, --envFile <file>',\n  envFileOptionDescription\n);\n\nconst sourcesOptionDescription = 'Comma separated list of log sources';\nconst sourcesOptionDefaultValueDescription = 'Log everything';\nexport const sourcesOptionM = new Option(\n  '-c, --sources <sources>',\n  sourcesOptionDescription\n).default('am-everything,idm-everything', sourcesOptionDefaultValueDescription);\n\nexport const scriptFriendlyOption = new Option(\n  '-s, --scriptFriendly',\n  'Send output of operation to STDOUT in a script-friendly format (JSON) which can be piped to other \\\ncommands. User messages/warnings are output to STDERR, and are not piped. For example, to only get \\\nbearer token: \\n\\\n<<< frodo info my-tenant -s 2>/dev/null | jq -r .bearerToken >>>'\n).default(false, 'Output as plain text');\n\ntreeOptionM.makeOptionMandatory();\nfileOptionM.makeOptionMandatory();\ndeploymentOptionM.makeOptionMandatory();\ndirOptionM.makeOptionMandatory();\nentitiesFileOptionM.makeOptionMandatory();\nenvFileOptionM.makeOptionMandatory();\nmanagedNameOptionM.makeOptionMandatory();\nsourcesOptionM.makeOptionMandatory();\n"],"mappings":"AAAA,SAASA,QAAT,EAAmBC,MAAnB,QAAiC,WAAjC;AACA,SAASC,KAAT,QAAsB,uBAAtB;AACA,OAAO,KAAKC,MAAZ,MAAwB,6BAAxB;AACA,SACEC,YADF,EAEEC,uBAFF,EAGEC,uBAHF,EAIEC,qBAJF,EAKEC,OALF,EAMEC,KANF,QAOO,qBAPP;AASAP,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBC,eAAtB,CAAsCR,YAAtC;AACAF,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBE,wBAAtB,CAA+CR,uBAA/C;AACAH,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBG,wBAAtB,CAA+CR,uBAA/C;AACAJ,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBI,sBAAtB,CAA6CR,qBAA7C;AACAL,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBK,iBAAtB,CAAwCR,OAAxC;AACAN,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBM,eAAtB,CAAsCR,KAAtC,E,CAEA;AACA;;AACA,OAAO,SAASS,IAAT,GAAgB,CAAE;AAEzB,MAAMC,uBAAuB,GAC3B,iIADF;AAEA,OAAO,MAAMC,YAAY,GAAG,IAAIpB,QAAJ,CAAa,QAAb,EAAuBmB,uBAAvB,CAArB;AACP,OAAO,MAAME,aAAa,GAAG,IAAIrB,QAAJ,CAAa,QAAb,EAAuBmB,uBAAvB,CAAtB;AAEP,MAAMG,wBAAwB,GAC5B,yFADF;AAEA,OAAO,MAAMC,aAAa,GAAG,IAAIvB,QAAJ,CAC3B,SAD2B,EAE3BsB,wBAF2B,EAG3BZ,OAH2B,CAI3BP,MAAM,CAACqB,iBAJoB,EAK3B,oDAL2B,CAAtB;AAOP,OAAO,MAAMC,cAAc,GAAG,IAAIzB,QAAJ,CAAa,SAAb,EAAwBsB,wBAAxB,CAAvB;AAEP,MAAMI,uBAAuB,GAC3B,gHADF;AAEA,OAAO,MAAMC,YAAY,GAAG,IAAI3B,QAAJ,CAAa,QAAb,EAAuB0B,uBAAvB,CAArB;AACP,OAAO,MAAME,aAAa,GAAG,IAAI5B,QAAJ,CAAa,QAAb,EAAuB0B,uBAAvB,CAAtB;AAEP,MAAMG,2BAA2B,GAAG,WAApC;AACA,OAAO,MAAMC,gBAAgB,GAAG,IAAI9B,QAAJ,CAC9B,YAD8B,EAE9B6B,2BAF8B,CAAzB;AAIP,OAAO,MAAME,iBAAiB,GAAG,IAAI/B,QAAJ,CAC/B,YAD+B,EAE/B6B,2BAF+B,CAA1B;AAKP,MAAMG,yBAAyB,GAAG,0BAAlC;AACA,OAAO,MAAMC,cAAc,GAAG,IAAIjC,QAAJ,CAAa,OAAb,EAAsBgC,yBAAtB,CAAvB;AAEP,MAAME,4BAA4B,GAAG,6BAArC;AACA,OAAO,MAAMC,iBAAiB,GAAG,IAAInC,QAAJ,CAC/B,UAD+B,EAE/BkC,4BAF+B,CAA1B;AAKP,MAAME,qBAAqB,GACzB,qDADF;AAEA,OAAO,MAAMC,UAAU,GAAG,IAAIpC,MAAJ,CACxB,mBADwB,EAExBmC,qBAFwB,CAAnB;AAIP,OAAO,MAAME,WAAW,GAAG,IAAIrC,MAAJ,CACzB,mBADyB,EAEzBmC,qBAFyB,CAApB;AAKP,MAAMG,qBAAqB,GAAG,YAA9B;AACA,OAAO,MAAMC,UAAU,GAAG,IAAIvC,MAAJ,CACxB,mBADwB,EAExBsC,qBAFwB,CAAnB;AAIP,OAAO,MAAME,WAAW,GAAG,IAAIxC,MAAJ,CACzB,mBADyB,EAEzBsC,qBAFyB,CAApB;AAKP,MAAMG,2BAA2B,GAC/B;AACF;AACA;AACA;AACA;AACA;AACA,6EAPA;AAQA,OAAO,MAAMC,gBAAgB,GAAG,IAAI1C,MAAJ,CAC9B,mBAD8B,EAE9ByC,2BAF8B,EAG9BE,OAH8B,CAGtBzC,MAAM,CAAC0C,gBAHe,CAAzB;AAIP,OAAO,MAAMC,iBAAiB,GAAG,IAAI7C,MAAJ,CAC/B,mBAD+B,EAE/ByC,2BAF+B,EAG/BE,OAH+B,CAGvBzC,MAAM,CAAC0C,gBAHgB,CAA1B;AAKP,OAAO,MAAME,cAAc,GAAG,IAAI9C,MAAJ,CAC5B,gBAD4B,EAE5B,4LAF4B,EAG5BS,OAH4B,CAGpB,KAHoB,EAGb,kCAHa,CAAvB;AAKP,OAAO,MAAMsC,aAAa,GAAG,IAAI/C,MAAJ,CAC3B,WAD2B,EAE3B,kGAF2B,CAAtB;AAKP,OAAO,MAAMgD,WAAW,GAAG,IAAIhD,MAAJ,CACzB,SADyB,EAEzB,4HAFyB,CAApB;AAKP,OAAO,MAAMiD,iBAAiB,GAAG,IAAIjD,MAAJ,CAC/B,mBAD+B,EAE/B;AACF,wCAHiC,CAA1B;AAKP,OAAO,MAAMkD,kBAAkB,GAAG,IAAIlD,MAAJ,CAChC,mBADgC,EAEhC;AACF,wCAHkC,CAA3B;AAMP,MAAMmD,oBAAoB,GACxB,wDADF;AAEA,OAAO,MAAMC,SAAS,GAAG,IAAIpD,MAAJ,CACvB,6BADuB,EAEvBmD,oBAFuB,CAAlB;AAIP,OAAO,MAAME,UAAU,GAAG,IAAIrD,MAAJ,CACxB,6BADwB,EAExBmD,oBAFwB,CAAnB;AAKP,MAAMG,6BAA6B,GACjC,gEADF;AAEA,OAAO,MAAMC,kBAAkB,GAAG,IAAIvD,MAAJ,CAChC,2BADgC,EAEhCsD,6BAFgC,CAA3B;AAIP,OAAO,MAAME,mBAAmB,GAAG,IAAIxD,MAAJ,CACjC,2BADiC,EAEjCsD,6BAFiC,CAA5B;AAKP,MAAMG,wBAAwB,GAC5B,sGADF;AAEA,OAAO,MAAMC,aAAa,GAAG,IAAI1D,MAAJ,CAC3B,sBAD2B,EAE3ByD,wBAF2B,CAAtB;AAIP,OAAO,MAAME,cAAc,GAAG,IAAI3D,MAAJ,CAC5B,sBAD4B,EAE5ByD,wBAF4B,CAAvB;AAKP,MAAMG,wBAAwB,GAAG,qCAAjC;AACA,MAAMC,oCAAoC,GAAG,gBAA7C;AACA,OAAO,MAAMC,cAAc,GAAG,IAAI9D,MAAJ,CAC5B,yBAD4B,EAE5B4D,wBAF4B,EAG5BnD,OAH4B,CAGpB,8BAHoB,EAGYoD,oCAHZ,CAAvB;AAKP,OAAO,MAAME,oBAAoB,GAAG,IAAI/D,MAAJ,CAClC,sBADkC,EAElC;AACF;AACA;AACA,iEALoC,EAMlCS,OANkC,CAM1B,KAN0B,EAMnB,sBANmB,CAA7B;AAQP4B,WAAW,CAAC2B,mBAAZ;AACAxB,WAAW,CAACwB,mBAAZ;AACAnB,iBAAiB,CAACmB,mBAAlB;AACAX,UAAU,CAACW,mBAAX;AACAR,mBAAmB,CAACQ,mBAApB;AACAL,cAAc,CAACK,mBAAf;AACAd,kBAAkB,CAACc,mBAAnB;AACAF,cAAc,CAACE,mBAAf"}
+{"version":3,"file":"cmd_common.js","names":["Argument","Option","state","global","printMessage","createProgressIndicator","updateProgressIndicator","stopProgressIndicator","verboseMessage","debugMessage","default","session","setPrintHandler","setVerboseHandler","setDebugHandler","setCreateProgressHandler","setUpdateProgressHandler","setStopProgressHandler","init","hostArgumentDescription","hostArgument","hostArgumentM","realmArgumentDescription","realmArgument","DEFAULT_REALM_KEY","realmArgumentM","userArgumentDescription","userArgument","userArgumentM","passwordArgumentDescription","passwordArgument","passwordArgumentM","apiKeyArgumentDescription","apiKeyArgument","apiSecretArgumentDescription","apiSecretArgument","treeOptionDescription","treeOption","treeOptionM","fileOptionDescription","fileOption","fileOptionM","deploymentOptionDescription","deploymentOption","choices","DEPLOYMENT_TYPES","deploymentOptionM","insecureOption","verboseOption","debugOption","managedNameOption","managedNameOptionM","dirOptionDescription","dirOption","dirOptionM","entitiesFileOptionDescription","entitiesFileOption","entitiesFileOptionM","envFileOptionDescription","envFileOption","envFileOptionM","sourcesOptionDescription","sourcesOptionDefaultValueDescription","sourcesOptionM","scriptFriendlyOption","makeOptionMandatory"],"sources":["cli/cmd_common.ts"],"sourcesContent":["import { Argument, Option } from 'commander';\nimport { state } from '@rockcarver/frodo-lib';\nimport * as global from '../storage/StaticStorage.js';\nimport {\n  printMessage,\n  createProgressIndicator,\n  updateProgressIndicator,\n  stopProgressIndicator,\n  verboseMessage,\n  debugMessage,\n} from '../utils/Console.js';\n\nstate.default.session.setPrintHandler(printMessage);\nstate.default.session.setVerboseHandler(verboseMessage);\nstate.default.session.setDebugHandler(debugMessage);\nstate.default.session.setCreateProgressHandler(createProgressIndicator);\nstate.default.session.setUpdateProgressHandler(updateProgressIndicator);\nstate.default.session.setStopProgressHandler(stopProgressIndicator);\n\n// pseudo functions for commands that do not otherwise need to import\n// this file but need to trigger print and progress handler registration\nexport function init() {}\n\nconst hostArgumentDescription =\n  'Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.';\nexport const hostArgument = new Argument('[host]', hostArgumentDescription);\nexport const hostArgumentM = new Argument('<host>', hostArgumentDescription);\n\nconst realmArgumentDescription =\n  \"Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise.\";\nexport const realmArgument = new Argument(\n  '[realm]',\n  realmArgumentDescription\n).default(\n  global.DEFAULT_REALM_KEY,\n  '\"alpha\" for Identity Cloud tenants, \"/\" otherwise.'\n);\nexport const realmArgumentM = new Argument('<realm>', realmArgumentDescription);\n\nconst userArgumentDescription =\n  'Username to login with. Must be an admin user with appropriate rights to manage authentication journeys/trees.';\nexport const userArgument = new Argument('[user]', userArgumentDescription);\nexport const userArgumentM = new Argument('<user>', userArgumentDescription);\n\nconst passwordArgumentDescription = 'Password.';\nexport const passwordArgument = new Argument(\n  '[password]',\n  passwordArgumentDescription\n);\nexport const passwordArgumentM = new Argument(\n  '<password>',\n  passwordArgumentDescription\n);\n\nconst apiKeyArgumentDescription = 'API key for logging API.';\nexport const apiKeyArgument = new Argument('[key]', apiKeyArgumentDescription);\n\nconst apiSecretArgumentDescription = 'API secret for logging API.';\nexport const apiSecretArgument = new Argument(\n  '[secret]',\n  apiSecretArgumentDescription\n);\n\nconst treeOptionDescription =\n  'Specify the name of an authentication journey/tree.';\nexport const treeOption = new Option(\n  '-t, --tree <tree>',\n  treeOptionDescription\n);\nexport const treeOptionM = new Option(\n  '-t, --tree <tree>',\n  treeOptionDescription\n);\n\nconst fileOptionDescription = 'File name.';\nexport const fileOption = new Option(\n  '-f, --file <file>',\n  fileOptionDescription\n);\nexport const fileOptionM = new Option(\n  '-f, --file <file>',\n  fileOptionDescription\n);\n\nconst deploymentOptionDescription =\n  'Override auto-detected deployment type. Valid values for type: \\n\\\nclassic:  A classic Access Management-only deployment with custom layout and configuration. \\n\\\ncloud:    A ForgeRock Identity Cloud environment. \\n\\\nforgeops: A ForgeOps CDK or CDM deployment. \\n\\\nThe detected or provided deployment type controls certain behavior like obtaining an Identity \\\nManagement admin token or not and whether to export/import referenced email templates or how \\\nto walk through the tenant admin login flow of Identity Cloud and handle MFA';\nexport const deploymentOption = new Option(\n  '-m, --type <type>',\n  deploymentOptionDescription\n).choices(global.DEPLOYMENT_TYPES);\nexport const deploymentOptionM = new Option(\n  '-m, --type <type>',\n  deploymentOptionDescription\n).choices(global.DEPLOYMENT_TYPES);\n\nexport const insecureOption = new Option(\n  '-k, --insecure',\n  '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.'\n).default(false, \"Don't allow insecure connections\");\n\nexport const verboseOption = new Option(\n  '--verbose',\n  'Verbose output during command execution. If specified, may or may not produce additional output.'\n);\n\nexport const debugOption = new Option(\n  '--debug',\n  'Debug output during command execution. If specified, may or may not produce additional output helpful for troubleshooting.'\n);\n\nexport const managedNameOption = new Option(\n  '-N, --name <name>',\n  'Managed object name to be operated on. Examples are \\\nuser, role, alpha_user, alpha_role etc.'\n);\nexport const managedNameOptionM = new Option(\n  '-N, --name <name>',\n  'Managed object name to be operated on. Examples are \\\nuser, role, alpha_user, alpha_role etc.'\n);\n\nconst dirOptionDescription =\n  'Directory for exporting all configuration entities to.';\nexport const dirOption = new Option(\n  '-D, --directory <directory>',\n  dirOptionDescription\n);\nexport const dirOptionM = new Option(\n  '-D, --directory <directory>',\n  dirOptionDescription\n);\n\nconst entitiesFileOptionDescription =\n  'JSON file that specifies the config entities to export/import.';\nexport const entitiesFileOption = new Option(\n  '-E, --entitiesFile <file>',\n  entitiesFileOptionDescription\n);\nexport const entitiesFileOptionM = new Option(\n  '-E, --entitiesFile <file>',\n  entitiesFileOptionDescription\n);\n\nconst envFileOptionDescription =\n  'File that defines environment specific variables for replacement during configuration export/import.';\nexport const envFileOption = new Option(\n  '-e, --envFile <file>',\n  envFileOptionDescription\n);\nexport const envFileOptionM = new Option(\n  '-e, --envFile <file>',\n  envFileOptionDescription\n);\n\nconst sourcesOptionDescription = 'Comma separated list of log sources';\nconst sourcesOptionDefaultValueDescription = 'Log everything';\nexport const sourcesOptionM = new Option(\n  '-c, --sources <sources>',\n  sourcesOptionDescription\n).default('am-everything,idm-everything', sourcesOptionDefaultValueDescription);\n\nexport const scriptFriendlyOption = new Option(\n  '-s, --scriptFriendly',\n  'Send output of operation to STDOUT in a script-friendly format (JSON) which can be piped to other \\\ncommands. User messages/warnings are output to STDERR, and are not piped. For example, to only get \\\nbearer token: \\n\\\n<<< frodo info my-tenant -s 2>/dev/null | jq -r .bearerToken >>>'\n).default(false, 'Output as plain text');\n\ntreeOptionM.makeOptionMandatory();\nfileOptionM.makeOptionMandatory();\ndeploymentOptionM.makeOptionMandatory();\ndirOptionM.makeOptionMandatory();\nentitiesFileOptionM.makeOptionMandatory();\nenvFileOptionM.makeOptionMandatory();\nmanagedNameOptionM.makeOptionMandatory();\nsourcesOptionM.makeOptionMandatory();\n"],"mappings":"AAAA,SAASA,QAAT,EAAmBC,MAAnB,QAAiC,WAAjC;AACA,SAASC,KAAT,QAAsB,uBAAtB;AACA,OAAO,KAAKC,MAAZ,MAAwB,6BAAxB;AACA,SACEC,YADF,EAEEC,uBAFF,EAGEC,uBAHF,EAIEC,qBAJF,EAKEC,cALF,EAMEC,YANF,QAOO,qBAPP;AASAP,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBC,eAAtB,CAAsCR,YAAtC;AACAF,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBE,iBAAtB,CAAwCL,cAAxC;AACAN,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBG,eAAtB,CAAsCL,YAAtC;AACAP,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBI,wBAAtB,CAA+CV,uBAA/C;AACAH,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBK,wBAAtB,CAA+CV,uBAA/C;AACAJ,KAAK,CAACQ,OAAN,CAAcC,OAAd,CAAsBM,sBAAtB,CAA6CV,qBAA7C,E,CAEA;AACA;;AACA,OAAO,SAASW,IAAT,GAAgB,CAAE;AAEzB,MAAMC,uBAAuB,GAC3B,iIADF;AAEA,OAAO,MAAMC,YAAY,GAAG,IAAIpB,QAAJ,CAAa,QAAb,EAAuBmB,uBAAvB,CAArB;AACP,OAAO,MAAME,aAAa,GAAG,IAAIrB,QAAJ,CAAa,QAAb,EAAuBmB,uBAAvB,CAAtB;AAEP,MAAMG,wBAAwB,GAC5B,yFADF;AAEA,OAAO,MAAMC,aAAa,GAAG,IAAIvB,QAAJ,CAC3B,SAD2B,EAE3BsB,wBAF2B,EAG3BZ,OAH2B,CAI3BP,MAAM,CAACqB,iBAJoB,EAK3B,oDAL2B,CAAtB;AAOP,OAAO,MAAMC,cAAc,GAAG,IAAIzB,QAAJ,CAAa,SAAb,EAAwBsB,wBAAxB,CAAvB;AAEP,MAAMI,uBAAuB,GAC3B,gHADF;AAEA,OAAO,MAAMC,YAAY,GAAG,IAAI3B,QAAJ,CAAa,QAAb,EAAuB0B,uBAAvB,CAArB;AACP,OAAO,MAAME,aAAa,GAAG,IAAI5B,QAAJ,CAAa,QAAb,EAAuB0B,uBAAvB,CAAtB;AAEP,MAAMG,2BAA2B,GAAG,WAApC;AACA,OAAO,MAAMC,gBAAgB,GAAG,IAAI9B,QAAJ,CAC9B,YAD8B,EAE9B6B,2BAF8B,CAAzB;AAIP,OAAO,MAAME,iBAAiB,GAAG,IAAI/B,QAAJ,CAC/B,YAD+B,EAE/B6B,2BAF+B,CAA1B;AAKP,MAAMG,yBAAyB,GAAG,0BAAlC;AACA,OAAO,MAAMC,cAAc,GAAG,IAAIjC,QAAJ,CAAa,OAAb,EAAsBgC,yBAAtB,CAAvB;AAEP,MAAME,4BAA4B,GAAG,6BAArC;AACA,OAAO,MAAMC,iBAAiB,GAAG,IAAInC,QAAJ,CAC/B,UAD+B,EAE/BkC,4BAF+B,CAA1B;AAKP,MAAME,qBAAqB,GACzB,qDADF;AAEA,OAAO,MAAMC,UAAU,GAAG,IAAIpC,MAAJ,CACxB,mBADwB,EAExBmC,qBAFwB,CAAnB;AAIP,OAAO,MAAME,WAAW,GAAG,IAAIrC,MAAJ,CACzB,mBADyB,EAEzBmC,qBAFyB,CAApB;AAKP,MAAMG,qBAAqB,GAAG,YAA9B;AACA,OAAO,MAAMC,UAAU,GAAG,IAAIvC,MAAJ,CACxB,mBADwB,EAExBsC,qBAFwB,CAAnB;AAIP,OAAO,MAAME,WAAW,GAAG,IAAIxC,MAAJ,CACzB,mBADyB,EAEzBsC,qBAFyB,CAApB;AAKP,MAAMG,2BAA2B,GAC/B;AACF;AACA;AACA;AACA;AACA;AACA,6EAPA;AAQA,OAAO,MAAMC,gBAAgB,GAAG,IAAI1C,MAAJ,CAC9B,mBAD8B,EAE9ByC,2BAF8B,EAG9BE,OAH8B,CAGtBzC,MAAM,CAAC0C,gBAHe,CAAzB;AAIP,OAAO,MAAMC,iBAAiB,GAAG,IAAI7C,MAAJ,CAC/B,mBAD+B,EAE/ByC,2BAF+B,EAG/BE,OAH+B,CAGvBzC,MAAM,CAAC0C,gBAHgB,CAA1B;AAKP,OAAO,MAAME,cAAc,GAAG,IAAI9C,MAAJ,CAC5B,gBAD4B,EAE5B,4LAF4B,EAG5BS,OAH4B,CAGpB,KAHoB,EAGb,kCAHa,CAAvB;AAKP,OAAO,MAAMsC,aAAa,GAAG,IAAI/C,MAAJ,CAC3B,WAD2B,EAE3B,kGAF2B,CAAtB;AAKP,OAAO,MAAMgD,WAAW,GAAG,IAAIhD,MAAJ,CACzB,SADyB,EAEzB,4HAFyB,CAApB;AAKP,OAAO,MAAMiD,iBAAiB,GAAG,IAAIjD,MAAJ,CAC/B,mBAD+B,EAE/B;AACF,wCAHiC,CAA1B;AAKP,OAAO,MAAMkD,kBAAkB,GAAG,IAAIlD,MAAJ,CAChC,mBADgC,EAEhC;AACF,wCAHkC,CAA3B;AAMP,MAAMmD,oBAAoB,GACxB,wDADF;AAEA,OAAO,MAAMC,SAAS,GAAG,IAAIpD,MAAJ,CACvB,6BADuB,EAEvBmD,oBAFuB,CAAlB;AAIP,OAAO,MAAME,UAAU,GAAG,IAAIrD,MAAJ,CACxB,6BADwB,EAExBmD,oBAFwB,CAAnB;AAKP,MAAMG,6BAA6B,GACjC,gEADF;AAEA,OAAO,MAAMC,kBAAkB,GAAG,IAAIvD,MAAJ,CAChC,2BADgC,EAEhCsD,6BAFgC,CAA3B;AAIP,OAAO,MAAME,mBAAmB,GAAG,IAAIxD,MAAJ,CACjC,2BADiC,EAEjCsD,6BAFiC,CAA5B;AAKP,MAAMG,wBAAwB,GAC5B,sGADF;AAEA,OAAO,MAAMC,aAAa,GAAG,IAAI1D,MAAJ,CAC3B,sBAD2B,EAE3ByD,wBAF2B,CAAtB;AAIP,OAAO,MAAME,cAAc,GAAG,IAAI3D,MAAJ,CAC5B,sBAD4B,EAE5ByD,wBAF4B,CAAvB;AAKP,MAAMG,wBAAwB,GAAG,qCAAjC;AACA,MAAMC,oCAAoC,GAAG,gBAA7C;AACA,OAAO,MAAMC,cAAc,GAAG,IAAI9D,MAAJ,CAC5B,yBAD4B,EAE5B4D,wBAF4B,EAG5BnD,OAH4B,CAGpB,8BAHoB,EAGYoD,oCAHZ,CAAvB;AAKP,OAAO,MAAME,oBAAoB,GAAG,IAAI/D,MAAJ,CAClC,sBADkC,EAElC;AACF;AACA;AACA,iEALoC,EAMlCS,OANkC,CAM1B,KAN0B,EAMnB,sBANmB,CAA7B;AAQP4B,WAAW,CAAC2B,mBAAZ;AACAxB,WAAW,CAACwB,mBAAZ;AACAnB,iBAAiB,CAACmB,mBAAlB;AACAX,UAAU,CAACW,mBAAX;AACAR,mBAAmB,CAACQ,mBAApB;AACAL,cAAc,CAACK,mBAAf;AACAd,kBAAkB,CAACc,mBAAnB;AACAF,cAAc,CAACE,mBAAf"}

package/esm/cli/idm/idm-export.js

@@ -21,9 +21,9 @@ async (host, realm, user, password, options) => {
 
   if (await getTokens()) {
     // export by id/name
-    if (options.idmName) {
-      console.log(`Exporting object "${options.idmName}" from realm "${state.default.session.getRealm()}"...`);
-      exportConfigEntity(options.idmName, options.file);
+    if (options.name) {
+      console.log(`Exporting object "${options.name}" from realm "${state.default.session.getRealm()}"...`);
+      exportConfigEntity(options.name, options.file);
     } // --all-separate -A
     else if (options.allSeparate && options.directory && options.entitiesFile && options.envFile) {
       console.log(`Exporting IDM configuration objects specified in ${options.entitiesFile} into separate files in ${options.directory} using ${options.envFile} for variable replacement...`);

package/esm/cli/idm/idm-export.js.map

@@ -1 +1 @@
-{"version":3,"file":"idm-export.js","names":["Command","Option","Authenticate","Idm","state","common","getTokens","exportAllConfigEntities","exportAllRawConfigEntities","exportConfigEntity","program","description","helpOption","showHelpAfterError","addArgument","hostArgumentM","realmArgument","userArgument","passwordArgument","addOption","deploymentOption","insecureOption","action","host","realm","user","password","options","default","session","setTenant","setRealm","setUsername","setPassword","setDeploymentType","type","setAllowInsecureConnection","insecure","idmName","console","log","getRealm","file","allSeparate","directory","entitiesFile","envFile","help","parse"],"sources":["cli/idm/idm-export.ts"],"sourcesContent":["import { Command, Option } from 'commander';\nimport { Authenticate, Idm, state } from '@rockcarver/frodo-lib';\nimport * as common from '../cmd_common.js';\n\nconst { getTokens } = Authenticate;\nconst {\n  exportAllConfigEntities,\n  exportAllRawConfigEntities,\n  exportConfigEntity,\n} = Idm;\n\nconst program = new Command('frodo idm export');\n\nprogram\n  .description('Export IDM configuration objects.')\n  .helpOption('-h, --help', 'Help')\n  .showHelpAfterError()\n  .addArgument(common.hostArgumentM)\n  .addArgument(common.realmArgument)\n  .addArgument(common.userArgument)\n  .addArgument(common.passwordArgument)\n  .addOption(common.deploymentOption)\n  .addOption(common.insecureOption)\n  .addOption(\n    new Option(\n      '-N, --name <name>',\n      'Config entity name. E.g. \"managed\", \"sync\", \"provisioner-<connector-name>\", etc.'\n    )\n  )\n  .addOption(new Option('-f, --file [file]', 'Export file. Ignored with -A.'))\n  .addOption(\n    new Option(\n      '-E, --entities-file [entities-file]',\n      'Name of the entity file. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-e, --env-file [envfile]',\n      'Name of the env file. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-a, --all',\n      'Export all IDM configuration objects into a single file in directory -D. Ignored with -N.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-A, --all-separate',\n      'Export all IDM configuration objects into separate JSON files in directory -D. Ignored with -N, and -a.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-D, --directory <directory>',\n      'Export directory. Required with and ignored without -a/-A.'\n    )\n  )\n  .action(\n    // implement command logic inside action handler\n    async (host, realm, user, password, options) => {\n      state.default.session.setTenant(host);\n      state.default.session.setRealm(realm);\n      state.default.session.setUsername(user);\n      state.default.session.setPassword(password);\n      state.default.session.setDeploymentType(options.type);\n      state.default.session.setAllowInsecureConnection(options.insecure);\n      if (await getTokens()) {\n        // export by id/name\n        if (options.idmName) {\n          console.log(\n            `Exporting object \"${\n              options.idmName\n            }\" from realm \"${state.default.session.getRealm()}\"...`\n          );\n          exportConfigEntity(options.idmName, options.file);\n        }\n        // --all-separate -A\n        else if (\n          options.allSeparate &&\n          options.directory &&\n          options.entitiesFile &&\n          options.envFile\n        ) {\n          console.log(\n            `Exporting IDM configuration objects specified in ${options.entitiesFile} into separate files in ${options.directory} using ${options.envFile} for variable replacement...`\n          );\n          exportAllConfigEntities(\n            options.directory,\n            options.entitiesFile,\n            options.envFile\n          );\n        }\n        // --all-separate -A without variable replacement\n        else if (options.allSeparate && options.directory) {\n          console.log(\n            `Exporting all IDM configuration objects into separate files in ${options.directory}...`\n          );\n          exportAllRawConfigEntities(options.directory);\n        }\n        // unrecognized combination of options or no options\n        else {\n          console.log(\n            'Unrecognized combination of options or no options...',\n            'error'\n          );\n          program.help();\n        }\n      }\n    }\n    // end command logic inside action handler\n  );\n\nprogram.parse();\n"],"mappings":"AAAA,SAASA,OAAT,EAAkBC,MAAlB,QAAgC,WAAhC;AACA,SAASC,YAAT,EAAuBC,GAAvB,EAA4BC,KAA5B,QAAyC,uBAAzC;AACA,OAAO,KAAKC,MAAZ,MAAwB,kBAAxB;AAEA,MAAM;EAAEC;AAAF,IAAgBJ,YAAtB;AACA,MAAM;EACJK,uBADI;EAEJC,0BAFI;EAGJC;AAHI,IAIFN,GAJJ;AAMA,MAAMO,OAAO,GAAG,IAAIV,OAAJ,CAAY,kBAAZ,CAAhB;AAEAU,OAAO,CACJC,WADH,CACe,mCADf,EAEGC,UAFH,CAEc,YAFd,EAE4B,MAF5B,EAGGC,kBAHH,GAIGC,WAJH,CAIeT,MAAM,CAACU,aAJtB,EAKGD,WALH,CAKeT,MAAM,CAACW,aALtB,EAMGF,WANH,CAMeT,MAAM,CAACY,YANtB,EAOGH,WAPH,CAOeT,MAAM,CAACa,gBAPtB,EAQGC,SARH,CAQad,MAAM,CAACe,gBARpB,EASGD,SATH,CASad,MAAM,CAACgB,cATpB,EAUGF,SAVH,CAWI,IAAIlB,MAAJ,CACE,mBADF,EAEE,kFAFF,CAXJ,EAgBGkB,SAhBH,CAgBa,IAAIlB,MAAJ,CAAW,mBAAX,EAAgC,+BAAhC,CAhBb,EAiBGkB,SAjBH,CAkBI,IAAIlB,MAAJ,CACE,qCADF,EAEE,2CAFF,CAlBJ,EAuBGkB,SAvBH,CAwBI,IAAIlB,MAAJ,CACE,0BADF,EAEE,wCAFF,CAxBJ,EA6BGkB,SA7BH,CA8BI,IAAIlB,MAAJ,CACE,WADF,EAEE,2FAFF,CA9BJ,EAmCGkB,SAnCH,CAoCI,IAAIlB,MAAJ,CACE,oBADF,EAEE,yGAFF,CApCJ,EAyCGkB,SAzCH,CA0CI,IAAIlB,MAAJ,CACE,6BADF,EAEE,4DAFF,CA1CJ,EA+CGqB,MA/CH,EAgDI;AACA,OAAOC,IAAP,EAAaC,KAAb,EAAoBC,IAApB,EAA0BC,QAA1B,EAAoCC,OAApC,KAAgD;EAC9CvB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBC,SAAtB,CAAgCP,IAAhC;EACAnB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBE,QAAtB,CAA+BP,KAA/B;EACApB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBG,WAAtB,CAAkCP,IAAlC;EACArB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBI,WAAtB,CAAkCP,QAAlC;EACAtB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBK,iBAAtB,CAAwCP,OAAO,CAACQ,IAAhD;EACA/B,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBO,0BAAtB,CAAiDT,OAAO,CAACU,QAAzD;;EACA,IAAI,MAAM/B,SAAS,EAAnB,EAAuB;IACrB;IACA,IAAIqB,OAAO,CAACW,OAAZ,EAAqB;MACnBC,OAAO,CAACC,GAAR,CACG,qBACCb,OAAO,CAACW,OACT,iBAAgBlC,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBY,QAAtB,EAAiC,MAHpD;MAKAhC,kBAAkB,CAACkB,OAAO,CAACW,OAAT,EAAkBX,OAAO,CAACe,IAA1B,CAAlB;IACD,CAPD,CAQA;IARA,KASK,IACHf,OAAO,CAACgB,WAAR,IACAhB,OAAO,CAACiB,SADR,IAEAjB,OAAO,CAACkB,YAFR,IAGAlB,OAAO,CAACmB,OAJL,EAKH;MACAP,OAAO,CAACC,GAAR,CACG,oDAAmDb,OAAO,CAACkB,YAAa,2BAA0BlB,OAAO,CAACiB,SAAU,UAASjB,OAAO,CAACmB,OAAQ,8BADhJ;MAGAvC,uBAAuB,CACrBoB,OAAO,CAACiB,SADa,EAErBjB,OAAO,CAACkB,YAFa,EAGrBlB,OAAO,CAACmB,OAHa,CAAvB;IAKD,CAdI,CAeL;IAfK,KAgBA,IAAInB,OAAO,CAACgB,WAAR,IAAuBhB,OAAO,CAACiB,SAAnC,EAA8C;MACjDL,OAAO,CAACC,GAAR,CACG,kEAAiEb,OAAO,CAACiB,SAAU,KADtF;MAGApC,0BAA0B,CAACmB,OAAO,CAACiB,SAAT,CAA1B;IACD,CALI,CAML;IANK,KAOA;MACHL,OAAO,CAACC,GAAR,CACE,sDADF,EAEE,OAFF;MAIA9B,OAAO,CAACqC,IAAR;IACD;EACF;AACF,CAlGL,CAmGI;AAnGJ;AAsGArC,OAAO,CAACsC,KAAR"}
+{"version":3,"file":"idm-export.js","names":["Command","Option","Authenticate","Idm","state","common","getTokens","exportAllConfigEntities","exportAllRawConfigEntities","exportConfigEntity","program","description","helpOption","showHelpAfterError","addArgument","hostArgumentM","realmArgument","userArgument","passwordArgument","addOption","deploymentOption","insecureOption","action","host","realm","user","password","options","default","session","setTenant","setRealm","setUsername","setPassword","setDeploymentType","type","setAllowInsecureConnection","insecure","name","console","log","getRealm","file","allSeparate","directory","entitiesFile","envFile","help","parse"],"sources":["cli/idm/idm-export.ts"],"sourcesContent":["import { Command, Option } from 'commander';\nimport { Authenticate, Idm, state } from '@rockcarver/frodo-lib';\nimport * as common from '../cmd_common.js';\n\nconst { getTokens } = Authenticate;\nconst {\n  exportAllConfigEntities,\n  exportAllRawConfigEntities,\n  exportConfigEntity,\n} = Idm;\n\nconst program = new Command('frodo idm export');\n\nprogram\n  .description('Export IDM configuration objects.')\n  .helpOption('-h, --help', 'Help')\n  .showHelpAfterError()\n  .addArgument(common.hostArgumentM)\n  .addArgument(common.realmArgument)\n  .addArgument(common.userArgument)\n  .addArgument(common.passwordArgument)\n  .addOption(common.deploymentOption)\n  .addOption(common.insecureOption)\n  .addOption(\n    new Option(\n      '-N, --name <name>',\n      'Config entity name. E.g. \"managed\", \"sync\", \"provisioner-<connector-name>\", etc.'\n    )\n  )\n  .addOption(new Option('-f, --file [file]', 'Export file. Ignored with -A.'))\n  .addOption(\n    new Option(\n      '-E, --entities-file [entities-file]',\n      'Name of the entity file. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-e, --env-file [envfile]',\n      'Name of the env file. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-a, --all',\n      'Export all IDM configuration objects into a single file in directory -D. Ignored with -N.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-A, --all-separate',\n      'Export all IDM configuration objects into separate JSON files in directory -D. Ignored with -N, and -a.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-D, --directory <directory>',\n      'Export directory. Required with and ignored without -a/-A.'\n    )\n  )\n  .action(\n    // implement command logic inside action handler\n    async (host, realm, user, password, options) => {\n      state.default.session.setTenant(host);\n      state.default.session.setRealm(realm);\n      state.default.session.setUsername(user);\n      state.default.session.setPassword(password);\n      state.default.session.setDeploymentType(options.type);\n      state.default.session.setAllowInsecureConnection(options.insecure);\n      if (await getTokens()) {\n        // export by id/name\n        if (options.name) {\n          console.log(\n            `Exporting object \"${\n              options.name\n            }\" from realm \"${state.default.session.getRealm()}\"...`\n          );\n          exportConfigEntity(options.name, options.file);\n        }\n        // --all-separate -A\n        else if (\n          options.allSeparate &&\n          options.directory &&\n          options.entitiesFile &&\n          options.envFile\n        ) {\n          console.log(\n            `Exporting IDM configuration objects specified in ${options.entitiesFile} into separate files in ${options.directory} using ${options.envFile} for variable replacement...`\n          );\n          exportAllConfigEntities(\n            options.directory,\n            options.entitiesFile,\n            options.envFile\n          );\n        }\n        // --all-separate -A without variable replacement\n        else if (options.allSeparate && options.directory) {\n          console.log(\n            `Exporting all IDM configuration objects into separate files in ${options.directory}...`\n          );\n          exportAllRawConfigEntities(options.directory);\n        }\n        // unrecognized combination of options or no options\n        else {\n          console.log(\n            'Unrecognized combination of options or no options...',\n            'error'\n          );\n          program.help();\n        }\n      }\n    }\n    // end command logic inside action handler\n  );\n\nprogram.parse();\n"],"mappings":"AAAA,SAASA,OAAT,EAAkBC,MAAlB,QAAgC,WAAhC;AACA,SAASC,YAAT,EAAuBC,GAAvB,EAA4BC,KAA5B,QAAyC,uBAAzC;AACA,OAAO,KAAKC,MAAZ,MAAwB,kBAAxB;AAEA,MAAM;EAAEC;AAAF,IAAgBJ,YAAtB;AACA,MAAM;EACJK,uBADI;EAEJC,0BAFI;EAGJC;AAHI,IAIFN,GAJJ;AAMA,MAAMO,OAAO,GAAG,IAAIV,OAAJ,CAAY,kBAAZ,CAAhB;AAEAU,OAAO,CACJC,WADH,CACe,mCADf,EAEGC,UAFH,CAEc,YAFd,EAE4B,MAF5B,EAGGC,kBAHH,GAIGC,WAJH,CAIeT,MAAM,CAACU,aAJtB,EAKGD,WALH,CAKeT,MAAM,CAACW,aALtB,EAMGF,WANH,CAMeT,MAAM,CAACY,YANtB,EAOGH,WAPH,CAOeT,MAAM,CAACa,gBAPtB,EAQGC,SARH,CAQad,MAAM,CAACe,gBARpB,EASGD,SATH,CASad,MAAM,CAACgB,cATpB,EAUGF,SAVH,CAWI,IAAIlB,MAAJ,CACE,mBADF,EAEE,kFAFF,CAXJ,EAgBGkB,SAhBH,CAgBa,IAAIlB,MAAJ,CAAW,mBAAX,EAAgC,+BAAhC,CAhBb,EAiBGkB,SAjBH,CAkBI,IAAIlB,MAAJ,CACE,qCADF,EAEE,2CAFF,CAlBJ,EAuBGkB,SAvBH,CAwBI,IAAIlB,MAAJ,CACE,0BADF,EAEE,wCAFF,CAxBJ,EA6BGkB,SA7BH,CA8BI,IAAIlB,MAAJ,CACE,WADF,EAEE,2FAFF,CA9BJ,EAmCGkB,SAnCH,CAoCI,IAAIlB,MAAJ,CACE,oBADF,EAEE,yGAFF,CApCJ,EAyCGkB,SAzCH,CA0CI,IAAIlB,MAAJ,CACE,6BADF,EAEE,4DAFF,CA1CJ,EA+CGqB,MA/CH,EAgDI;AACA,OAAOC,IAAP,EAAaC,KAAb,EAAoBC,IAApB,EAA0BC,QAA1B,EAAoCC,OAApC,KAAgD;EAC9CvB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBC,SAAtB,CAAgCP,IAAhC;EACAnB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBE,QAAtB,CAA+BP,KAA/B;EACApB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBG,WAAtB,CAAkCP,IAAlC;EACArB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBI,WAAtB,CAAkCP,QAAlC;EACAtB,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBK,iBAAtB,CAAwCP,OAAO,CAACQ,IAAhD;EACA/B,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBO,0BAAtB,CAAiDT,OAAO,CAACU,QAAzD;;EACA,IAAI,MAAM/B,SAAS,EAAnB,EAAuB;IACrB;IACA,IAAIqB,OAAO,CAACW,IAAZ,EAAkB;MAChBC,OAAO,CAACC,GAAR,CACG,qBACCb,OAAO,CAACW,IACT,iBAAgBlC,KAAK,CAACwB,OAAN,CAAcC,OAAd,CAAsBY,QAAtB,EAAiC,MAHpD;MAKAhC,kBAAkB,CAACkB,OAAO,CAACW,IAAT,EAAeX,OAAO,CAACe,IAAvB,CAAlB;IACD,CAPD,CAQA;IARA,KASK,IACHf,OAAO,CAACgB,WAAR,IACAhB,OAAO,CAACiB,SADR,IAEAjB,OAAO,CAACkB,YAFR,IAGAlB,OAAO,CAACmB,OAJL,EAKH;MACAP,OAAO,CAACC,GAAR,CACG,oDAAmDb,OAAO,CAACkB,YAAa,2BAA0BlB,OAAO,CAACiB,SAAU,UAASjB,OAAO,CAACmB,OAAQ,8BADhJ;MAGAvC,uBAAuB,CACrBoB,OAAO,CAACiB,SADa,EAErBjB,OAAO,CAACkB,YAFa,EAGrBlB,OAAO,CAACmB,OAHa,CAAvB;IAKD,CAdI,CAeL;IAfK,KAgBA,IAAInB,OAAO,CAACgB,WAAR,IAAuBhB,OAAO,CAACiB,SAAnC,EAA8C;MACjDL,OAAO,CAACC,GAAR,CACG,kEAAiEb,OAAO,CAACiB,SAAU,KADtF;MAGApC,0BAA0B,CAACmB,OAAO,CAACiB,SAAT,CAA1B;IACD,CALI,CAML;IANK,KAOA;MACHL,OAAO,CAACC,GAAR,CACE,sDADF,EAEE,OAFF;MAIA9B,OAAO,CAACqC,IAAR;IACD;EACF;AACF,CAlGL,CAmGI;AAnGJ;AAsGArC,OAAO,CAACsC,KAAR"}

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

@@ -1,8 +1,9 @@
 import fs from 'fs';
 import { Command, Option } from 'commander';
-import { Authenticate, Journey, state } from '@rockcarver/frodo-lib';
-import { describeJourney } from '../../ops/JourneyOps';
+import { Authenticate, ExportImportUtils, Journey, state } from '@rockcarver/frodo-lib';
+import { describeJourney, describeJourneyMd } from '../../ops/JourneyOps';
 import * as common from '../cmd_common.js';
+import { printMessage } from '../../utils/Console';
 const {
   getTokens
 } = Authenticate;
@@ -11,24 +12,30 @@ const {
   exportJourney,
   createFileParamTreeExportResolver
 } = Journey;
+const {
+  saveTextToFile
+} = ExportImportUtils;
 const program = new Command('frodo journey describe');
-program.description('If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.').helpOption('-h, --help', 'Help').showHelpAfterError().addArgument(common.hostArgument).addArgument(common.realmArgument).addArgument(common.userArgument).addArgument(common.passwordArgument).addOption(common.deploymentOption).addOption(common.insecureOption).addOption(new Option('-i, --journey-id <journey>', 'Name of a journey/tree. If specified, -a and -A are ignored.')).addOption(new Option('-f, --file <file>', 'Name of the file to write the exported journey(s) to. Ignored with -A.')).addOption(new Option('-o, --override-version <version>', "Override version. Notation: '<major>.<minor>.<patch>' e.g. '7.2.0'. Override detected version with any version. This is helpful in order to check if journeys in one environment would be compatible running in another environment (e.g. in preparation of migrating from on-prem to ForgeRock Identity Cloud.")).action( // implement command logic inside action handler
+program.description('If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.').helpOption('-h, --help', 'Help').showHelpAfterError().addArgument(common.hostArgument).addArgument(common.realmArgument).addArgument(common.userArgument).addArgument(common.passwordArgument).addOption(common.deploymentOption).addOption(common.insecureOption).addOption(common.verboseOption).addOption(common.debugOption).addOption(new Option('-i, --journey-id <journey>', 'Name of a journey/tree. If specified, -a and -A are ignored.')).addOption(new Option('-f, --file <file>', 'Name of the journey export file to describe. Ignored with -A.')).addOption(new Option('-F, --output-file <file>', 'Name of the file to write the output to.')).addOption(new Option('--markdown', 'Output in markdown.')).addOption(new Option('-o, --override-version <version>', "Override version. Notation: '<major>.<minor>.<patch>' e.g. '7.2.0'. Override detected version with any version. This is helpful in order to check if journeys in one environment would be compatible running in another environment (e.g. in preparation of migrating from on-prem to ForgeRock Identity Cloud.")).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); // TODO: review checks for arguments
+  state.default.session.setAllowInsecureConnection(options.insecure);
+  state.default.session.setVerbose(options.verbose);
+  state.default.session.setDebug(options.debug);
+  if (options.outputFile) state.default.session.setOutputFile(options.outputFile); // TODO: review checks for arguments
 
   if (typeof host === 'undefined' || typeof options.file !== 'undefined') {
     if (typeof host === 'undefined' && typeof options.file === 'undefined') {
-      console.log('Need either [host] or -f.');
+      printMessage('Need either [host] or -f.', 'error');
       process.exitCode = 1;
       return;
     }
 
-    console.log(`Describing local journey file ${options.file}...`);
+    printMessage(`Describing local journey file ${options.file}...`);
 
     try {
       var _fileData$tree, _fileData$tree2;
@@ -56,15 +63,23 @@ async (host, realm, user, password, options) => {
       } // no journey/tree found
       else {
         throw new Error(typeof options.journeyId === 'undefined' ? `No journey found in ${options.file}` : `Journey '${options.journeyId}' not found in ${options.file}`);
-      }
+      } // ANSI text output
+
 
-      await describeJourney(journeyData, createFileParamTreeExportResolver(options.file));
+      if (!options.markdown) {
+        await describeJourney(journeyData, createFileParamTreeExportResolver(options.file));
+      } // Markdown output
+      else {
+        // reset output file
+        if (options.outputFile) saveTextToFile('', options.outputFile);
+        await describeJourneyMd(journeyData, createFileParamTreeExportResolver(options.file));
+      }
     } catch (error) {
-      console.log(error.message);
+      printMessage(error.message, 'error');
       process.exitCode = 1;
     }
   } else if (await getTokens()) {
-    console.log(`Describing journey(s) in realm "${state.default.session.getRealm()}"...`); // override version
+    printMessage(`Describing journey(s) in realm "${state.default.session.getRealm()}"...`); // override version
 
     if (typeof options.overrideVersion !== 'undefined') {
       state.default.session.setAmVersion(options.overrideVersion);
@@ -77,19 +92,35 @@ async (host, realm, user, password, options) => {
       for (const journey of journeys) {
         try {
           // eslint-disable-next-line no-await-in-loop, dot-notation
-          const treeData = await exportJourney(journey['_id']);
-          await describeJourney(treeData);
+          const treeData = await exportJourney(journey['_id']); // ANSI text output
+
+          if (!options.markdown) {
+            await describeJourney(treeData);
+          } // Markdown output
+          else {
+            // reset output file
+            if (options.outputFile) saveTextToFile('', options.outputFile);
+            await describeJourneyMd(treeData);
+          }
         } catch (error) {
-          console.log(error.message);
+          printMessage(error.message, 'error');
           process.exitCode = 1;
         }
       }
     } else {
       try {
-        const treeData = await exportJourney(options.journeyId);
-        await describeJourney(treeData);
+        const treeData = await exportJourney(options.journeyId); // ANSI text output
+
+        if (!options.markdown) {
+          await describeJourney(treeData);
+        } // Markdown output
+        else {
+          // reset output file
+          if (options.outputFile) saveTextToFile('', options.outputFile);
+          await describeJourneyMd(treeData);
+        }
       } catch (error) {
-        console.log(error.message);
+        printMessage(error.message, 'error');
         process.exitCode = 1;
       }
     }

package/esm/cli/journey/journey-describe.js.map

@@ -1 +1 @@
-{"version":3,"file":"journey-describe.js","names":["fs","Command","Option","Authenticate","Journey","state","describeJourney","common","getTokens","getJourneys","exportJourney","createFileParamTreeExportResolver","program","description","helpOption","showHelpAfterError","addArgument","hostArgument","realmArgument","userArgument","passwordArgument","addOption","deploymentOption","insecureOption","action","host","realm","user","password","options","default","session","setTenant","setRealm","setUsername","setPassword","setDeploymentType","type","setAllowInsecureConnection","insecure","file","console","log","process","exitCode","overrideVersion","setAmVersion","fileData","JSON","parse","readFileSync","journeyData","journeyId","trees","Object","values","tree","_id","Error","error","message","getRealm","journeys","journey","treeData"],"sources":["cli/journey/journey-describe.ts"],"sourcesContent":["import fs from 'fs';\nimport { Command, Option } from 'commander';\nimport { Authenticate, Journey, state } from '@rockcarver/frodo-lib';\nimport { describeJourney } from '../../ops/JourneyOps';\nimport * as common from '../cmd_common.js';\n\nconst { getTokens } = Authenticate;\nconst { getJourneys, exportJourney, createFileParamTreeExportResolver } =\n  Journey;\n\nconst program = new Command('frodo journey describe');\n\nprogram\n  .description(\n    'If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.'\n  )\n  .helpOption('-h, --help', 'Help')\n  .showHelpAfterError()\n  .addArgument(common.hostArgument)\n  .addArgument(common.realmArgument)\n  .addArgument(common.userArgument)\n  .addArgument(common.passwordArgument)\n  .addOption(common.deploymentOption)\n  .addOption(common.insecureOption)\n  .addOption(\n    new Option(\n      '-i, --journey-id <journey>',\n      'Name of a journey/tree. If specified, -a and -A are ignored.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-f, --file <file>',\n      'Name of the file to write the exported journey(s) to. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-o, --override-version <version>',\n      \"Override version. Notation: '<major>.<minor>.<patch>' e.g. '7.2.0'. Override detected version with any version. This is helpful in order to check if journeys in one environment would be compatible running in another environment (e.g. in preparation of migrating from on-prem to ForgeRock Identity Cloud.\"\n    )\n  )\n  .action(\n    // implement command logic inside action handler\n    async (host, realm, user, password, options) => {\n      state.default.session.setTenant(host);\n      state.default.session.setRealm(realm);\n      state.default.session.setUsername(user);\n      state.default.session.setPassword(password);\n      state.default.session.setDeploymentType(options.type);\n      state.default.session.setAllowInsecureConnection(options.insecure);\n      // TODO: review checks for arguments\n      if (typeof host === 'undefined' || typeof options.file !== 'undefined') {\n        if (\n          typeof host === 'undefined' &&\n          typeof options.file === 'undefined'\n        ) {\n          console.log('Need either [host] or -f.');\n          process.exitCode = 1;\n          return;\n        }\n        console.log(`Describing local journey file ${options.file}...`);\n        try {\n          // override version\n          if (typeof options.overrideVersion !== 'undefined') {\n            state.default.session.setAmVersion(options.overrideVersion);\n          }\n          const fileData = JSON.parse(fs.readFileSync(options.file, 'utf8'));\n          let journeyData;\n          // single or multi tree export?\n          // multi - by id\n          if (\n            typeof options.journeyId !== 'undefined' &&\n            fileData.trees &&\n            fileData.trees[options.journeyId]\n          ) {\n            journeyData = fileData.trees[options.journeyId];\n          }\n          // multi - first\n          else if (typeof options.journeyId === 'undefined' && fileData.trees) {\n            [journeyData] = Object.values(fileData.trees);\n          }\n          // single - by id\n          else if (\n            typeof options.journeyId !== 'undefined' &&\n            options.journeyId === fileData.tree?._id\n          ) {\n            journeyData = fileData;\n          }\n          // single\n          else if (\n            typeof options.journeyId === 'undefined' &&\n            fileData.tree?._id\n          ) {\n            journeyData = fileData;\n          }\n          // no journey/tree found\n          else {\n            throw new Error(\n              typeof options.journeyId === 'undefined'\n                ? `No journey found in ${options.file}`\n                : `Journey '${options.journeyId}' not found in ${options.file}`\n            );\n          }\n          await describeJourney(\n            journeyData,\n            createFileParamTreeExportResolver(options.file)\n          );\n        } catch (error) {\n          console.log(error.message);\n          process.exitCode = 1;\n        }\n      } else if (await getTokens()) {\n        console.log(\n          `Describing journey(s) in realm \"${state.default.session.getRealm()}\"...`\n        );\n        // override version\n        if (typeof options.overrideVersion !== 'undefined') {\n          state.default.session.setAmVersion(options.overrideVersion);\n        }\n        if (typeof options.journeyId === 'undefined') {\n          let journeys: any[] = [];\n          journeys = await getJourneys();\n          for (const journey of journeys) {\n            try {\n              // eslint-disable-next-line no-await-in-loop, dot-notation\n              const treeData = await exportJourney(journey['_id']);\n              await describeJourney(treeData);\n            } catch (error) {\n              console.log(error.message);\n              process.exitCode = 1;\n            }\n          }\n        } else {\n          try {\n            const treeData = await exportJourney(options.journeyId);\n            await describeJourney(treeData);\n          } catch (error) {\n            console.log(error.message);\n            process.exitCode = 1;\n          }\n        }\n      }\n    }\n    // end command logic inside action handler\n  );\n\nprogram.parse();\n"],"mappings":"AAAA,OAAOA,EAAP,MAAe,IAAf;AACA,SAASC,OAAT,EAAkBC,MAAlB,QAAgC,WAAhC;AACA,SAASC,YAAT,EAAuBC,OAAvB,EAAgCC,KAAhC,QAA6C,uBAA7C;AACA,SAASC,eAAT,QAAgC,sBAAhC;AACA,OAAO,KAAKC,MAAZ,MAAwB,kBAAxB;AAEA,MAAM;EAAEC;AAAF,IAAgBL,YAAtB;AACA,MAAM;EAAEM,WAAF;EAAeC,aAAf;EAA8BC;AAA9B,IACJP,OADF;AAGA,MAAMQ,OAAO,GAAG,IAAIX,OAAJ,CAAY,wBAAZ,CAAhB;AAEAW,OAAO,CACJC,WADH,CAEI,yLAFJ,EAIGC,UAJH,CAIc,YAJd,EAI4B,MAJ5B,EAKGC,kBALH,GAMGC,WANH,CAMeT,MAAM,CAACU,YANtB,EAOGD,WAPH,CAOeT,MAAM,CAACW,aAPtB,EAQGF,WARH,CAQeT,MAAM,CAACY,YARtB,EASGH,WATH,CASeT,MAAM,CAACa,gBATtB,EAUGC,SAVH,CAUad,MAAM,CAACe,gBAVpB,EAWGD,SAXH,CAWad,MAAM,CAACgB,cAXpB,EAYGF,SAZH,CAaI,IAAInB,MAAJ,CACE,4BADF,EAEE,8DAFF,CAbJ,EAkBGmB,SAlBH,CAmBI,IAAInB,MAAJ,CACE,mBADF,EAEE,wEAFF,CAnBJ,EAwBGmB,SAxBH,CAyBI,IAAInB,MAAJ,CACE,kCADF,EAEE,iTAFF,CAzBJ,EA8BGsB,MA9BH,EA+BI;AACA,OAAOC,IAAP,EAAaC,KAAb,EAAoBC,IAApB,EAA0BC,QAA1B,EAAoCC,OAApC,KAAgD;EAC9CxB,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBC,SAAtB,CAAgCP,IAAhC;EACApB,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBE,QAAtB,CAA+BP,KAA/B;EACArB,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBG,WAAtB,CAAkCP,IAAlC;EACAtB,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBI,WAAtB,CAAkCP,QAAlC;EACAvB,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBK,iBAAtB,CAAwCP,OAAO,CAACQ,IAAhD;EACAhC,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBO,0BAAtB,CAAiDT,OAAO,CAACU,QAAzD,EAN8C,CAO9C;;EACA,IAAI,OAAOd,IAAP,KAAgB,WAAhB,IAA+B,OAAOI,OAAO,CAACW,IAAf,KAAwB,WAA3D,EAAwE;IACtE,IACE,OAAOf,IAAP,KAAgB,WAAhB,IACA,OAAOI,OAAO,CAACW,IAAf,KAAwB,WAF1B,EAGE;MACAC,OAAO,CAACC,GAAR,CAAY,2BAAZ;MACAC,OAAO,CAACC,QAAR,GAAmB,CAAnB;MACA;IACD;;IACDH,OAAO,CAACC,GAAR,CAAa,iCAAgCb,OAAO,CAACW,IAAK,KAA1D;;IACA,IAAI;MAAA;;MACF;MACA,IAAI,OAAOX,OAAO,CAACgB,eAAf,KAAmC,WAAvC,EAAoD;QAClDxC,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBe,YAAtB,CAAmCjB,OAAO,CAACgB,eAA3C;MACD;;MACD,MAAME,QAAQ,GAAGC,IAAI,CAACC,KAAL,CAAWjD,EAAE,CAACkD,YAAH,CAAgBrB,OAAO,CAACW,IAAxB,EAA8B,MAA9B,CAAX,CAAjB;MACA,IAAIW,WAAJ,CANE,CAOF;MACA;;MACA,IACE,OAAOtB,OAAO,CAACuB,SAAf,KAA6B,WAA7B,IACAL,QAAQ,CAACM,KADT,IAEAN,QAAQ,CAACM,KAAT,CAAexB,OAAO,CAACuB,SAAvB,CAHF,EAIE;QACAD,WAAW,GAAGJ,QAAQ,CAACM,KAAT,CAAexB,OAAO,CAACuB,SAAvB,CAAd;MACD,CAND,CAOA;MAPA,KAQK,IAAI,OAAOvB,OAAO,CAACuB,SAAf,KAA6B,WAA7B,IAA4CL,QAAQ,CAACM,KAAzD,EAAgE;QACnE,CAACF,WAAD,IAAgBG,MAAM,CAACC,MAAP,CAAcR,QAAQ,CAACM,KAAvB,CAAhB;MACD,CAFI,CAGL;MAHK,KAIA,IACH,OAAOxB,OAAO,CAACuB,SAAf,KAA6B,WAA7B,IACAvB,OAAO,CAACuB,SAAR,wBAAsBL,QAAQ,CAACS,IAA/B,mDAAsB,eAAeC,GAArC,CAFG,EAGH;QACAN,WAAW,GAAGJ,QAAd;MACD,CALI,CAML;MANK,KAOA,IACH,OAAOlB,OAAO,CAACuB,SAAf,KAA6B,WAA7B,uBACAL,QAAQ,CAACS,IADT,4CACA,gBAAeC,GAFZ,EAGH;QACAN,WAAW,GAAGJ,QAAd;MACD,CALI,CAML;MANK,KAOA;QACH,MAAM,IAAIW,KAAJ,CACJ,OAAO7B,OAAO,CAACuB,SAAf,KAA6B,WAA7B,GACK,uBAAsBvB,OAAO,CAACW,IAAK,EADxC,GAEK,YAAWX,OAAO,CAACuB,SAAU,kBAAiBvB,OAAO,CAACW,IAAK,EAH5D,CAAN;MAKD;;MACD,MAAMlC,eAAe,CACnB6C,WADmB,EAEnBxC,iCAAiC,CAACkB,OAAO,CAACW,IAAT,CAFd,CAArB;IAID,CA9CD,CA8CE,OAAOmB,KAAP,EAAc;MACdlB,OAAO,CAACC,GAAR,CAAYiB,KAAK,CAACC,OAAlB;MACAjB,OAAO,CAACC,QAAR,GAAmB,CAAnB;IACD;EACF,CA5DD,MA4DO,IAAI,MAAMpC,SAAS,EAAnB,EAAuB;IAC5BiC,OAAO,CAACC,GAAR,CACG,mCAAkCrC,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsB8B,QAAtB,EAAiC,MADtE,EAD4B,CAI5B;;IACA,IAAI,OAAOhC,OAAO,CAACgB,eAAf,KAAmC,WAAvC,EAAoD;MAClDxC,KAAK,CAACyB,OAAN,CAAcC,OAAd,CAAsBe,YAAtB,CAAmCjB,OAAO,CAACgB,eAA3C;IACD;;IACD,IAAI,OAAOhB,OAAO,CAACuB,SAAf,KAA6B,WAAjC,EAA8C;MAC5C,IAAIU,QAAe,GAAG,EAAtB;MACAA,QAAQ,GAAG,MAAMrD,WAAW,EAA5B;;MACA,KAAK,MAAMsD,OAAX,IAAsBD,QAAtB,EAAgC;QAC9B,IAAI;UACF;UACA,MAAME,QAAQ,GAAG,MAAMtD,aAAa,CAACqD,OAAO,CAAC,KAAD,CAAR,CAApC;UACA,MAAMzD,eAAe,CAAC0D,QAAD,CAArB;QACD,CAJD,CAIE,OAAOL,KAAP,EAAc;UACdlB,OAAO,CAACC,GAAR,CAAYiB,KAAK,CAACC,OAAlB;UACAjB,OAAO,CAACC,QAAR,GAAmB,CAAnB;QACD;MACF;IACF,CAbD,MAaO;MACL,IAAI;QACF,MAAMoB,QAAQ,GAAG,MAAMtD,aAAa,CAACmB,OAAO,CAACuB,SAAT,CAApC;QACA,MAAM9C,eAAe,CAAC0D,QAAD,CAArB;MACD,CAHD,CAGE,OAAOL,KAAP,EAAc;QACdlB,OAAO,CAACC,GAAR,CAAYiB,KAAK,CAACC,OAAlB;QACAjB,OAAO,CAACC,QAAR,GAAmB,CAAnB;MACD;IACF;EACF;AACF,CAnIL,CAoII;AApIJ;AAuIAhC,OAAO,CAACqC,KAAR"}
+{"version":3,"file":"journey-describe.js","names":["fs","Command","Option","Authenticate","ExportImportUtils","Journey","state","describeJourney","describeJourneyMd","common","printMessage","getTokens","getJourneys","exportJourney","createFileParamTreeExportResolver","saveTextToFile","program","description","helpOption","showHelpAfterError","addArgument","hostArgument","realmArgument","userArgument","passwordArgument","addOption","deploymentOption","insecureOption","verboseOption","debugOption","action","host","realm","user","password","options","default","session","setTenant","setRealm","setUsername","setPassword","setDeploymentType","type","setAllowInsecureConnection","insecure","setVerbose","verbose","setDebug","debug","outputFile","setOutputFile","file","process","exitCode","overrideVersion","setAmVersion","fileData","JSON","parse","readFileSync","journeyData","journeyId","trees","Object","values","tree","_id","Error","markdown","error","message","getRealm","journeys","journey","treeData"],"sources":["cli/journey/journey-describe.ts"],"sourcesContent":["import fs from 'fs';\nimport { Command, Option } from 'commander';\nimport {\n  Authenticate,\n  ExportImportUtils,\n  Journey,\n  state,\n} from '@rockcarver/frodo-lib';\nimport { describeJourney, describeJourneyMd } from '../../ops/JourneyOps';\nimport * as common from '../cmd_common.js';\nimport { printMessage } from '../../utils/Console';\n\nconst { getTokens } = Authenticate;\nconst { getJourneys, exportJourney, createFileParamTreeExportResolver } =\n  Journey;\nconst { saveTextToFile } = ExportImportUtils;\n\nconst program = new Command('frodo journey describe');\n\nprogram\n  .description(\n    'If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.'\n  )\n  .helpOption('-h, --help', 'Help')\n  .showHelpAfterError()\n  .addArgument(common.hostArgument)\n  .addArgument(common.realmArgument)\n  .addArgument(common.userArgument)\n  .addArgument(common.passwordArgument)\n  .addOption(common.deploymentOption)\n  .addOption(common.insecureOption)\n  .addOption(common.verboseOption)\n  .addOption(common.debugOption)\n  .addOption(\n    new Option(\n      '-i, --journey-id <journey>',\n      'Name of a journey/tree. If specified, -a and -A are ignored.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-f, --file <file>',\n      'Name of the journey export file to describe. Ignored with -A.'\n    )\n  )\n  .addOption(\n    new Option(\n      '-F, --output-file <file>',\n      'Name of the file to write the output to.'\n    )\n  )\n  .addOption(new Option('--markdown', 'Output in markdown.'))\n  .addOption(\n    new Option(\n      '-o, --override-version <version>',\n      \"Override version. Notation: '<major>.<minor>.<patch>' e.g. '7.2.0'. Override detected version with any version. This is helpful in order to check if journeys in one environment would be compatible running in another environment (e.g. in preparation of migrating from on-prem to ForgeRock Identity Cloud.\"\n    )\n  )\n  .action(\n    // implement command logic inside action handler\n    async (host, realm, user, password, options) => {\n      state.default.session.setTenant(host);\n      state.default.session.setRealm(realm);\n      state.default.session.setUsername(user);\n      state.default.session.setPassword(password);\n      state.default.session.setDeploymentType(options.type);\n      state.default.session.setAllowInsecureConnection(options.insecure);\n      state.default.session.setVerbose(options.verbose);\n      state.default.session.setDebug(options.debug);\n      if (options.outputFile)\n        state.default.session.setOutputFile(options.outputFile);\n      // TODO: review checks for arguments\n      if (typeof host === 'undefined' || typeof options.file !== 'undefined') {\n        if (\n          typeof host === 'undefined' &&\n          typeof options.file === 'undefined'\n        ) {\n          printMessage('Need either [host] or -f.', 'error');\n          process.exitCode = 1;\n          return;\n        }\n        printMessage(`Describing local journey file ${options.file}...`);\n        try {\n          // override version\n          if (typeof options.overrideVersion !== 'undefined') {\n            state.default.session.setAmVersion(options.overrideVersion);\n          }\n          const fileData = JSON.parse(fs.readFileSync(options.file, 'utf8'));\n          let journeyData;\n          // single or multi tree export?\n          // multi - by id\n          if (\n            typeof options.journeyId !== 'undefined' &&\n            fileData.trees &&\n            fileData.trees[options.journeyId]\n          ) {\n            journeyData = fileData.trees[options.journeyId];\n          }\n          // multi - first\n          else if (typeof options.journeyId === 'undefined' && fileData.trees) {\n            [journeyData] = Object.values(fileData.trees);\n          }\n          // single - by id\n          else if (\n            typeof options.journeyId !== 'undefined' &&\n            options.journeyId === fileData.tree?._id\n          ) {\n            journeyData = fileData;\n          }\n          // single\n          else if (\n            typeof options.journeyId === 'undefined' &&\n            fileData.tree?._id\n          ) {\n            journeyData = fileData;\n          }\n          // no journey/tree found\n          else {\n            throw new Error(\n              typeof options.journeyId === 'undefined'\n                ? `No journey found in ${options.file}`\n                : `Journey '${options.journeyId}' not found in ${options.file}`\n            );\n          }\n          // ANSI text output\n          if (!options.markdown) {\n            await describeJourney(\n              journeyData,\n              createFileParamTreeExportResolver(options.file)\n            );\n          }\n          // Markdown output\n          else {\n            // reset output file\n            if (options.outputFile) saveTextToFile('', options.outputFile);\n            await describeJourneyMd(\n              journeyData,\n              createFileParamTreeExportResolver(options.file)\n            );\n          }\n        } catch (error) {\n          printMessage(error.message, 'error');\n          process.exitCode = 1;\n        }\n      } else if (await getTokens()) {\n        printMessage(\n          `Describing journey(s) in realm \"${state.default.session.getRealm()}\"...`\n        );\n        // override version\n        if (typeof options.overrideVersion !== 'undefined') {\n          state.default.session.setAmVersion(options.overrideVersion);\n        }\n        if (typeof options.journeyId === 'undefined') {\n          let journeys: any[] = [];\n          journeys = await getJourneys();\n          for (const journey of journeys) {\n            try {\n              // eslint-disable-next-line no-await-in-loop, dot-notation\n              const treeData = await exportJourney(journey['_id']);\n              // ANSI text output\n              if (!options.markdown) {\n                await describeJourney(treeData);\n              }\n              // Markdown output\n              else {\n                // reset output file\n                if (options.outputFile) saveTextToFile('', options.outputFile);\n                await describeJourneyMd(treeData);\n              }\n            } catch (error) {\n              printMessage(error.message, 'error');\n              process.exitCode = 1;\n            }\n          }\n        } else {\n          try {\n            const treeData = await exportJourney(options.journeyId);\n            // ANSI text output\n            if (!options.markdown) {\n              await describeJourney(treeData);\n            }\n            // Markdown output\n            else {\n              // reset output file\n              if (options.outputFile) saveTextToFile('', options.outputFile);\n              await describeJourneyMd(treeData);\n            }\n          } catch (error) {\n            printMessage(error.message, 'error');\n            process.exitCode = 1;\n          }\n        }\n      }\n    }\n    // end command logic inside action handler\n  );\n\nprogram.parse();\n"],"mappings":"AAAA,OAAOA,EAAP,MAAe,IAAf;AACA,SAASC,OAAT,EAAkBC,MAAlB,QAAgC,WAAhC;AACA,SACEC,YADF,EAEEC,iBAFF,EAGEC,OAHF,EAIEC,KAJF,QAKO,uBALP;AAMA,SAASC,eAAT,EAA0BC,iBAA1B,QAAmD,sBAAnD;AACA,OAAO,KAAKC,MAAZ,MAAwB,kBAAxB;AACA,SAASC,YAAT,QAA6B,qBAA7B;AAEA,MAAM;EAAEC;AAAF,IAAgBR,YAAtB;AACA,MAAM;EAAES,WAAF;EAAeC,aAAf;EAA8BC;AAA9B,IACJT,OADF;AAEA,MAAM;EAAEU;AAAF,IAAqBX,iBAA3B;AAEA,MAAMY,OAAO,GAAG,IAAIf,OAAJ,CAAY,wBAAZ,CAAhB;AAEAe,OAAO,CACJC,WADH,CAEI,yLAFJ,EAIGC,UAJH,CAIc,YAJd,EAI4B,MAJ5B,EAKGC,kBALH,GAMGC,WANH,CAMeX,MAAM,CAACY,YANtB,EAOGD,WAPH,CAOeX,MAAM,CAACa,aAPtB,EAQGF,WARH,CAQeX,MAAM,CAACc,YARtB,EASGH,WATH,CASeX,MAAM,CAACe,gBATtB,EAUGC,SAVH,CAUahB,MAAM,CAACiB,gBAVpB,EAWGD,SAXH,CAWahB,MAAM,CAACkB,cAXpB,EAYGF,SAZH,CAYahB,MAAM,CAACmB,aAZpB,EAaGH,SAbH,CAaahB,MAAM,CAACoB,WAbpB,EAcGJ,SAdH,CAeI,IAAIvB,MAAJ,CACE,4BADF,EAEE,8DAFF,CAfJ,EAoBGuB,SApBH,CAqBI,IAAIvB,MAAJ,CACE,mBADF,EAEE,+DAFF,CArBJ,EA0BGuB,SA1BH,CA2BI,IAAIvB,MAAJ,CACE,0BADF,EAEE,0CAFF,CA3BJ,EAgCGuB,SAhCH,CAgCa,IAAIvB,MAAJ,CAAW,YAAX,EAAyB,qBAAzB,CAhCb,EAiCGuB,SAjCH,CAkCI,IAAIvB,MAAJ,CACE,kCADF,EAEE,iTAFF,CAlCJ,EAuCG4B,MAvCH,EAwCI;AACA,OAAOC,IAAP,EAAaC,KAAb,EAAoBC,IAApB,EAA0BC,QAA1B,EAAoCC,OAApC,KAAgD;EAC9C7B,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBC,SAAtB,CAAgCP,IAAhC;EACAzB,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBE,QAAtB,CAA+BP,KAA/B;EACA1B,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBG,WAAtB,CAAkCP,IAAlC;EACA3B,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBI,WAAtB,CAAkCP,QAAlC;EACA5B,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBK,iBAAtB,CAAwCP,OAAO,CAACQ,IAAhD;EACArC,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBO,0BAAtB,CAAiDT,OAAO,CAACU,QAAzD;EACAvC,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBS,UAAtB,CAAiCX,OAAO,CAACY,OAAzC;EACAzC,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBW,QAAtB,CAA+Bb,OAAO,CAACc,KAAvC;EACA,IAAId,OAAO,CAACe,UAAZ,EACE5C,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBc,aAAtB,CAAoChB,OAAO,CAACe,UAA5C,EAV4C,CAW9C;;EACA,IAAI,OAAOnB,IAAP,KAAgB,WAAhB,IAA+B,OAAOI,OAAO,CAACiB,IAAf,KAAwB,WAA3D,EAAwE;IACtE,IACE,OAAOrB,IAAP,KAAgB,WAAhB,IACA,OAAOI,OAAO,CAACiB,IAAf,KAAwB,WAF1B,EAGE;MACA1C,YAAY,CAAC,2BAAD,EAA8B,OAA9B,CAAZ;MACA2C,OAAO,CAACC,QAAR,GAAmB,CAAnB;MACA;IACD;;IACD5C,YAAY,CAAE,iCAAgCyB,OAAO,CAACiB,IAAK,KAA/C,CAAZ;;IACA,IAAI;MAAA;;MACF;MACA,IAAI,OAAOjB,OAAO,CAACoB,eAAf,KAAmC,WAAvC,EAAoD;QAClDjD,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBmB,YAAtB,CAAmCrB,OAAO,CAACoB,eAA3C;MACD;;MACD,MAAME,QAAQ,GAAGC,IAAI,CAACC,KAAL,CAAW3D,EAAE,CAAC4D,YAAH,CAAgBzB,OAAO,CAACiB,IAAxB,EAA8B,MAA9B,CAAX,CAAjB;MACA,IAAIS,WAAJ,CANE,CAOF;MACA;;MACA,IACE,OAAO1B,OAAO,CAAC2B,SAAf,KAA6B,WAA7B,IACAL,QAAQ,CAACM,KADT,IAEAN,QAAQ,CAACM,KAAT,CAAe5B,OAAO,CAAC2B,SAAvB,CAHF,EAIE;QACAD,WAAW,GAAGJ,QAAQ,CAACM,KAAT,CAAe5B,OAAO,CAAC2B,SAAvB,CAAd;MACD,CAND,CAOA;MAPA,KAQK,IAAI,OAAO3B,OAAO,CAAC2B,SAAf,KAA6B,WAA7B,IAA4CL,QAAQ,CAACM,KAAzD,EAAgE;QACnE,CAACF,WAAD,IAAgBG,MAAM,CAACC,MAAP,CAAcR,QAAQ,CAACM,KAAvB,CAAhB;MACD,CAFI,CAGL;MAHK,KAIA,IACH,OAAO5B,OAAO,CAAC2B,SAAf,KAA6B,WAA7B,IACA3B,OAAO,CAAC2B,SAAR,wBAAsBL,QAAQ,CAACS,IAA/B,mDAAsB,eAAeC,GAArC,CAFG,EAGH;QACAN,WAAW,GAAGJ,QAAd;MACD,CALI,CAML;MANK,KAOA,IACH,OAAOtB,OAAO,CAAC2B,SAAf,KAA6B,WAA7B,uBACAL,QAAQ,CAACS,IADT,4CACA,gBAAeC,GAFZ,EAGH;QACAN,WAAW,GAAGJ,QAAd;MACD,CALI,CAML;MANK,KAOA;QACH,MAAM,IAAIW,KAAJ,CACJ,OAAOjC,OAAO,CAAC2B,SAAf,KAA6B,WAA7B,GACK,uBAAsB3B,OAAO,CAACiB,IAAK,EADxC,GAEK,YAAWjB,OAAO,CAAC2B,SAAU,kBAAiB3B,OAAO,CAACiB,IAAK,EAH5D,CAAN;MAKD,CAzCC,CA0CF;;;MACA,IAAI,CAACjB,OAAO,CAACkC,QAAb,EAAuB;QACrB,MAAM9D,eAAe,CACnBsD,WADmB,EAEnB/C,iCAAiC,CAACqB,OAAO,CAACiB,IAAT,CAFd,CAArB;MAID,CALD,CAMA;MANA,KAOK;QACH;QACA,IAAIjB,OAAO,CAACe,UAAZ,EAAwBnC,cAAc,CAAC,EAAD,EAAKoB,OAAO,CAACe,UAAb,CAAd;QACxB,MAAM1C,iBAAiB,CACrBqD,WADqB,EAErB/C,iCAAiC,CAACqB,OAAO,CAACiB,IAAT,CAFZ,CAAvB;MAID;IACF,CA1DD,CA0DE,OAAOkB,KAAP,EAAc;MACd5D,YAAY,CAAC4D,KAAK,CAACC,OAAP,EAAgB,OAAhB,CAAZ;MACAlB,OAAO,CAACC,QAAR,GAAmB,CAAnB;IACD;EACF,CAxED,MAwEO,IAAI,MAAM3C,SAAS,EAAnB,EAAuB;IAC5BD,YAAY,CACT,mCAAkCJ,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBmC,QAAtB,EAAiC,MAD1D,CAAZ,CAD4B,CAI5B;;IACA,IAAI,OAAOrC,OAAO,CAACoB,eAAf,KAAmC,WAAvC,EAAoD;MAClDjD,KAAK,CAAC8B,OAAN,CAAcC,OAAd,CAAsBmB,YAAtB,CAAmCrB,OAAO,CAACoB,eAA3C;IACD;;IACD,IAAI,OAAOpB,OAAO,CAAC2B,SAAf,KAA6B,WAAjC,EAA8C;MAC5C,IAAIW,QAAe,GAAG,EAAtB;MACAA,QAAQ,GAAG,MAAM7D,WAAW,EAA5B;;MACA,KAAK,MAAM8D,OAAX,IAAsBD,QAAtB,EAAgC;QAC9B,IAAI;UACF;UACA,MAAME,QAAQ,GAAG,MAAM9D,aAAa,CAAC6D,OAAO,CAAC,KAAD,CAAR,CAApC,CAFE,CAGF;;UACA,IAAI,CAACvC,OAAO,CAACkC,QAAb,EAAuB;YACrB,MAAM9D,eAAe,CAACoE,QAAD,CAArB;UACD,CAFD,CAGA;UAHA,KAIK;YACH;YACA,IAAIxC,OAAO,CAACe,UAAZ,EAAwBnC,cAAc,CAAC,EAAD,EAAKoB,OAAO,CAACe,UAAb,CAAd;YACxB,MAAM1C,iBAAiB,CAACmE,QAAD,CAAvB;UACD;QACF,CAbD,CAaE,OAAOL,KAAP,EAAc;UACd5D,YAAY,CAAC4D,KAAK,CAACC,OAAP,EAAgB,OAAhB,CAAZ;UACAlB,OAAO,CAACC,QAAR,GAAmB,CAAnB;QACD;MACF;IACF,CAtBD,MAsBO;MACL,IAAI;QACF,MAAMqB,QAAQ,GAAG,MAAM9D,aAAa,CAACsB,OAAO,CAAC2B,SAAT,CAApC,CADE,CAEF;;QACA,IAAI,CAAC3B,OAAO,CAACkC,QAAb,EAAuB;UACrB,MAAM9D,eAAe,CAACoE,QAAD,CAArB;QACD,CAFD,CAGA;QAHA,KAIK;UACH;UACA,IAAIxC,OAAO,CAACe,UAAZ,EAAwBnC,cAAc,CAAC,EAAD,EAAKoB,OAAO,CAACe,UAAb,CAAd;UACxB,MAAM1C,iBAAiB,CAACmE,QAAD,CAAvB;QACD;MACF,CAZD,CAYE,OAAOL,KAAP,EAAc;QACd5D,YAAY,CAAC4D,KAAK,CAACC,OAAP,EAAgB,OAAhB,CAAZ;QACAlB,OAAO,CAACC,QAAR,GAAmB,CAAnB;MACD;IACF;EACF;AACF,CA9KL,CA+KI;AA/KJ;AAkLAtC,OAAO,CAAC2C,KAAR"}

package/esm/ops/CirclesOfTrustOps.js

@@ -9,4 +9,25 @@ export function getOneLineDescription(cotObj) {
   const description = `[${cotObj._id['brightCyan']}]`;
   return description;
 }
+/**
+ * Get markdown table header
+ * @returns {string} markdown table header
+ */
+
+export function getTableHeaderMd() {
+  let markdown = '';
+  markdown += '| Name/Id | Status | Trusted Providers |\n';
+  markdown += '| ------- | ------ | ----------------- |';
+  return markdown;
+}
+/**
+ * Get a table-row of the circle of trust in markdown
+ * @param {SocialIdpSkeleton} cotObj circle of trust object to describe
+ * @returns {string} a table-row of the circle of trust in markdown
+ */
+
+export function getTableRowMd(cotObj) {
+  const row = `| ${cotObj._id} | ${cotObj.status === 'active' ? ':white_check_mark: `active`' : ':o: `inactive`'} | ${cotObj.trustedProviders.map(provider => provider.split('|')[0]).join('<br>')} |`;
+  return row;
+}
 //# sourceMappingURL=CirclesOfTrustOps.js.map

package/esm/ops/CirclesOfTrustOps.js.map

@@ -1 +1 @@
-{"version":3,"file":"CirclesOfTrustOps.js","names":["getOneLineDescription","cotObj","description","_id"],"sources":["ops/CirclesOfTrustOps.ts"],"sourcesContent":["// import { CircleOfTrustSkeleton } from \"@rockcarver/frodo-lib/types/api/ApiTypes\";\nimport { TypesRaw } from '@rockcarver/frodo-lib';\n\n/**\n * Get a one-line description of the circle of trust object\n * @param {CircleOfTrustSkeleton} cotObj circle of trust object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(cotObj: TypesRaw.CircleOfTrustSkeleton): string {\n  const description = `[${cotObj._id['brightCyan']}]`;\n  return description;\n}\n"],"mappings":"AAAA;;AAGA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,qBAAT,CAA+BC,MAA/B,EAA+E;EACpF,MAAMC,WAAW,GAAI,IAAGD,MAAM,CAACE,GAAP,CAAW,YAAX,CAAyB,GAAjD;EACA,OAAOD,WAAP;AACD"}
+{"version":3,"file":"CirclesOfTrustOps.js","names":["getOneLineDescription","cotObj","description","_id","getTableHeaderMd","markdown","getTableRowMd","row","status","trustedProviders","map","provider","split","join"],"sources":["ops/CirclesOfTrustOps.ts"],"sourcesContent":["// import { CircleOfTrustSkeleton } from \"@rockcarver/frodo-lib/types/api/ApiTypes\";\nimport { TypesRaw } from '@rockcarver/frodo-lib';\n\n/**\n * Get a one-line description of the circle of trust object\n * @param {CircleOfTrustSkeleton} cotObj circle of trust object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(\n  cotObj: TypesRaw.CircleOfTrustSkeleton\n): string {\n  const description = `[${cotObj._id['brightCyan']}]`;\n  return description;\n}\n\n/**\n * Get markdown table header\n * @returns {string} markdown table header\n */\nexport function getTableHeaderMd(): string {\n  let markdown = '';\n  markdown += '| Name/Id | Status | Trusted Providers |\\n';\n  markdown += '| ------- | ------ | ----------------- |';\n  return markdown;\n}\n\n/**\n * Get a table-row of the circle of trust in markdown\n * @param {SocialIdpSkeleton} cotObj circle of trust object to describe\n * @returns {string} a table-row of the circle of trust in markdown\n */\nexport function getTableRowMd(cotObj: TypesRaw.CircleOfTrustSkeleton): string {\n  const row = `| ${cotObj._id} | ${\n    cotObj.status === 'active'\n      ? ':white_check_mark: `active`'\n      : ':o: `inactive`'\n  } | ${cotObj.trustedProviders\n    .map((provider) => provider.split('|')[0])\n    .join('<br>')} |`;\n  return row;\n}\n"],"mappings":"AAAA;;AAGA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,qBAAT,CACLC,MADK,EAEG;EACR,MAAMC,WAAW,GAAI,IAAGD,MAAM,CAACE,GAAP,CAAW,YAAX,CAAyB,GAAjD;EACA,OAAOD,WAAP;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASE,gBAAT,GAAoC;EACzC,IAAIC,QAAQ,GAAG,EAAf;EACAA,QAAQ,IAAI,4CAAZ;EACAA,QAAQ,IAAI,0CAAZ;EACA,OAAOA,QAAP;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,aAAT,CAAuBL,MAAvB,EAAuE;EAC5E,MAAMM,GAAG,GAAI,KAAIN,MAAM,CAACE,GAAI,MAC1BF,MAAM,CAACO,MAAP,KAAkB,QAAlB,GACI,6BADJ,GAEI,gBACL,MAAKP,MAAM,CAACQ,gBAAP,CACHC,GADG,CACEC,QAAD,IAAcA,QAAQ,CAACC,KAAT,CAAe,GAAf,EAAoB,CAApB,CADf,EAEHC,IAFG,CAEE,MAFF,CAEU,IANhB;EAOA,OAAON,GAAP;AACD"}

package/esm/ops/EmailTemplateOps.js

@@ -1,10 +1,36 @@
+import { EmailTemplateRaw } from '@rockcarver/frodo-lib';
 /**
  * Get a one-line description of the email template
  * @param {EmailTemplateSkeleton} templateObj email template object to describe
  * @returns {string} a one-line description
  */
+
 export function getOneLineDescription(templateObj) {
   const description = `[${templateObj._id.split('/')[1]['brightCyan']}] ${templateObj.displayName ? templateObj.displayName : ''} - ${templateObj.defaultLocale ? templateObj.subject[templateObj.defaultLocale] : Object.values(templateObj.subject)[0]}`;
   return description;
 }
+/**
+ * Get markdown table header
+ * @returns {string} markdown table header
+ */
+
+export function getTableHeaderMd() {
+  let markdown = '';
+  markdown += '| Display Name | Locale(s) | Subject | Id |\n';
+  markdown += '| ------------ | --------- | ------- | ---|';
+  return markdown;
+}
+/**
+ * Get a table-row of the email template in markdown
+ * @param {EmailTemplateSkeleton} templateObj email template object to describe
+ * @returns {string} a table-row of the email template in markdown
+ */
+
+export function getTableRowMd(templateObj) {
+  const templateId = templateObj._id.replace(`${EmailTemplateRaw.EMAIL_TEMPLATE_TYPE}/`, '');
+
+  const locales = `${templateObj.defaultLocale}${Object.keys(templateObj.subject).length > 1 ? ` (${Object.keys(templateObj.subject).filter(locale => locale !== templateObj.defaultLocale).join(',')})` : ''}`;
+  const row = `| ${templateObj.name ? templateObj.name : templateId} | ${locales} | ${templateObj.subject[templateObj.defaultLocale]} | \`${templateId}\` |`;
+  return row;
+}
 //# sourceMappingURL=EmailTemplateOps.js.map

package/esm/ops/EmailTemplateOps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EmailTemplateOps.js","names":["getOneLineDescription","templateObj","description","_id","split","displayName","defaultLocale","subject","Object","values"],"sources":["ops/EmailTemplateOps.ts"],"sourcesContent":["import { EmailTemplateSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';\n\n/**\n * Get a one-line description of the email template\n * @param {EmailTemplateSkeleton} templateObj email template object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(\n  templateObj: EmailTemplateSkeleton\n): string {\n  const description = `[${templateObj._id.split('/')[1]['brightCyan']}] ${\n    templateObj.displayName ? templateObj.displayName : ''\n  } - ${\n    templateObj.defaultLocale\n      ? templateObj.subject[templateObj.defaultLocale]\n      : Object.values(templateObj.subject)[0]\n  }`;\n  return description;\n}\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,qBAAT,CACLC,WADK,EAEG;EACR,MAAMC,WAAW,GAAI,IAAGD,WAAW,CAACE,GAAZ,CAAgBC,KAAhB,CAAsB,GAAtB,EAA2B,CAA3B,EAA8B,YAA9B,CAA4C,KAClEH,WAAW,CAACI,WAAZ,GAA0BJ,WAAW,CAACI,WAAtC,GAAoD,EACrD,MACCJ,WAAW,CAACK,aAAZ,GACIL,WAAW,CAACM,OAAZ,CAAoBN,WAAW,CAACK,aAAhC,CADJ,GAEIE,MAAM,CAACC,MAAP,CAAcR,WAAW,CAACM,OAA1B,EAAmC,CAAnC,CACL,EAND;EAOA,OAAOL,WAAP;AACD"}
+{"version":3,"file":"EmailTemplateOps.js","names":["EmailTemplateRaw","getOneLineDescription","templateObj","description","_id","split","displayName","defaultLocale","subject","Object","values","getTableHeaderMd","markdown","getTableRowMd","templateId","replace","EMAIL_TEMPLATE_TYPE","locales","keys","length","filter","locale","join","row","name"],"sources":["ops/EmailTemplateOps.ts"],"sourcesContent":["import { EmailTemplateSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';\nimport { EmailTemplateRaw } from '@rockcarver/frodo-lib';\n\n/**\n * Get a one-line description of the email template\n * @param {EmailTemplateSkeleton} templateObj email template object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(\n  templateObj: EmailTemplateSkeleton\n): string {\n  const description = `[${templateObj._id.split('/')[1]['brightCyan']}] ${\n    templateObj.displayName ? templateObj.displayName : ''\n  } - ${\n    templateObj.defaultLocale\n      ? templateObj.subject[templateObj.defaultLocale]\n      : Object.values(templateObj.subject)[0]\n  }`;\n  return description;\n}\n\n/**\n * Get markdown table header\n * @returns {string} markdown table header\n */\nexport function getTableHeaderMd(): string {\n  let markdown = '';\n  markdown += '| Display Name | Locale(s) | Subject | Id |\\n';\n  markdown += '| ------------ | --------- | ------- | ---|';\n  return markdown;\n}\n\n/**\n * Get a table-row of the email template in markdown\n * @param {EmailTemplateSkeleton} templateObj email template object to describe\n * @returns {string} a table-row of the email template in markdown\n */\nexport function getTableRowMd(templateObj: EmailTemplateSkeleton): string {\n  const templateId = templateObj._id.replace(\n    `${EmailTemplateRaw.EMAIL_TEMPLATE_TYPE}/`,\n    ''\n  );\n  const locales = `${templateObj.defaultLocale}${\n    Object.keys(templateObj.subject).length > 1\n      ? ` (${Object.keys(templateObj.subject)\n          .filter((locale) => locale !== templateObj.defaultLocale)\n          .join(',')})`\n      : ''\n  }`;\n  const row = `| ${\n    templateObj.name ? templateObj.name : templateId\n  } | ${locales} | ${\n    templateObj.subject[templateObj.defaultLocale]\n  } | \\`${templateId}\\` |`;\n  return row;\n}\n"],"mappings":"AACA,SAASA,gBAAT,QAAiC,uBAAjC;AAEA;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,qBAAT,CACLC,WADK,EAEG;EACR,MAAMC,WAAW,GAAI,IAAGD,WAAW,CAACE,GAAZ,CAAgBC,KAAhB,CAAsB,GAAtB,EAA2B,CAA3B,EAA8B,YAA9B,CAA4C,KAClEH,WAAW,CAACI,WAAZ,GAA0BJ,WAAW,CAACI,WAAtC,GAAoD,EACrD,MACCJ,WAAW,CAACK,aAAZ,GACIL,WAAW,CAACM,OAAZ,CAAoBN,WAAW,CAACK,aAAhC,CADJ,GAEIE,MAAM,CAACC,MAAP,CAAcR,WAAW,CAACM,OAA1B,EAAmC,CAAnC,CACL,EAND;EAOA,OAAOL,WAAP;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASQ,gBAAT,GAAoC;EACzC,IAAIC,QAAQ,GAAG,EAAf;EACAA,QAAQ,IAAI,+CAAZ;EACAA,QAAQ,IAAI,6CAAZ;EACA,OAAOA,QAAP;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,aAAT,CAAuBX,WAAvB,EAAmE;EACxE,MAAMY,UAAU,GAAGZ,WAAW,CAACE,GAAZ,CAAgBW,OAAhB,CAChB,GAAEf,gBAAgB,CAACgB,mBAAoB,GADvB,EAEjB,EAFiB,CAAnB;;EAIA,MAAMC,OAAO,GAAI,GAAEf,WAAW,CAACK,aAAc,GAC3CE,MAAM,CAACS,IAAP,CAAYhB,WAAW,CAACM,OAAxB,EAAiCW,MAAjC,GAA0C,CAA1C,GACK,KAAIV,MAAM,CAACS,IAAP,CAAYhB,WAAW,CAACM,OAAxB,EACFY,MADE,CACMC,MAAD,IAAYA,MAAM,KAAKnB,WAAW,CAACK,aADxC,EAEFe,IAFE,CAEG,GAFH,CAEQ,GAHjB,GAII,EACL,EAND;EAOA,MAAMC,GAAG,GAAI,KACXrB,WAAW,CAACsB,IAAZ,GAAmBtB,WAAW,CAACsB,IAA/B,GAAsCV,UACvC,MAAKG,OAAQ,MACZf,WAAW,CAACM,OAAZ,CAAoBN,WAAW,CAACK,aAAhC,CACD,QAAOO,UAAW,MAJnB;EAKA,OAAOS,GAAP;AACD"}

package/esm/ops/IdpOps.js

@@ -7,4 +7,25 @@ export function getOneLineDescription(socialIdpObj) {
   const description = `[${socialIdpObj._id['brightCyan']}] ${socialIdpObj._type._id}`;
   return description;
 }
+/**
+ * Get markdown table header
+ * @returns {string} markdown table header
+ */
+
+export function getTableHeaderMd() {
+  let markdown = '';
+  markdown += '| Name/Id | Status | Type |\n';
+  markdown += '| ------- | ------ | ---- |';
+  return markdown;
+}
+/**
+ * Get a table-row of the social idp in markdown
+ * @param {SocialIdpSkeleton} socialIdpObj social idp object to describe
+ * @returns {string} a table-row of the social idp in markdown
+ */
+
+export function getTableRowMd(socialIdpObj) {
+  const row = `| ${socialIdpObj._id} | ${socialIdpObj.enabled === false ? ':o: `disabled`' : ':white_check_mark: `enabled`'} | ${socialIdpObj._type.name} |`;
+  return row;
+}
 //# sourceMappingURL=IdpOps.js.map

package/esm/ops/IdpOps.js.map

@@ -1 +1 @@
-{"version":3,"file":"IdpOps.js","names":["getOneLineDescription","socialIdpObj","description","_id","_type"],"sources":["ops/IdpOps.ts"],"sourcesContent":["import { SocialIdpSkeleton } from \"@rockcarver/frodo-lib/types/api/ApiTypes\";\n\n/**\n * Get a one-line description of the social idp object\n * @param {SocialIdpSkeleton} socialIdpObj social idp object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(socialIdpObj: SocialIdpSkeleton): string {\n  const description = `[${socialIdpObj._id['brightCyan']}] ${socialIdpObj._type._id}`;\n  return description;\n}\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,qBAAT,CAA+BC,YAA/B,EAAwE;EAC7E,MAAMC,WAAW,GAAI,IAAGD,YAAY,CAACE,GAAb,CAAiB,YAAjB,CAA+B,KAAIF,YAAY,CAACG,KAAb,CAAmBD,GAAI,EAAlF;EACA,OAAOD,WAAP;AACD"}
+{"version":3,"file":"IdpOps.js","names":["getOneLineDescription","socialIdpObj","description","_id","_type","getTableHeaderMd","markdown","getTableRowMd","row","enabled","name"],"sources":["ops/IdpOps.ts"],"sourcesContent":["import { SocialIdpSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';\n\n/**\n * Get a one-line description of the social idp object\n * @param {SocialIdpSkeleton} socialIdpObj social idp object to describe\n * @returns {string} a one-line description\n */\nexport function getOneLineDescription(socialIdpObj: SocialIdpSkeleton): string {\n  const description = `[${socialIdpObj._id['brightCyan']}] ${socialIdpObj._type._id}`;\n  return description;\n}\n\n/**\n * Get markdown table header\n * @returns {string} markdown table header\n */\nexport function getTableHeaderMd(): string {\n  let markdown = '';\n  markdown += '| Name/Id | Status | Type |\\n';\n  markdown += '| ------- | ------ | ---- |';\n  return markdown;\n}\n\n/**\n * Get a table-row of the social idp in markdown\n * @param {SocialIdpSkeleton} socialIdpObj social idp object to describe\n * @returns {string} a table-row of the social idp in markdown\n */\nexport function getTableRowMd(socialIdpObj: SocialIdpSkeleton): string {\n  const row = `| ${socialIdpObj._id} | ${\n    socialIdpObj.enabled === false\n      ? ':o: `disabled`'\n      : ':white_check_mark: `enabled`'\n  } | ${socialIdpObj._type.name} |`;\n  return row;\n}\n"],"mappings":"AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASA,qBAAT,CAA+BC,YAA/B,EAAwE;EAC7E,MAAMC,WAAW,GAAI,IAAGD,YAAY,CAACE,GAAb,CAAiB,YAAjB,CAA+B,KAAIF,YAAY,CAACG,KAAb,CAAmBD,GAAI,EAAlF;EACA,OAAOD,WAAP;AACD;AAED;AACA;AACA;AACA;;AACA,OAAO,SAASG,gBAAT,GAAoC;EACzC,IAAIC,QAAQ,GAAG,EAAf;EACAA,QAAQ,IAAI,+BAAZ;EACAA,QAAQ,IAAI,6BAAZ;EACA,OAAOA,QAAP;AACD;AAED;AACA;AACA;AACA;AACA;;AACA,OAAO,SAASC,aAAT,CAAuBN,YAAvB,EAAgE;EACrE,MAAMO,GAAG,GAAI,KAAIP,YAAY,CAACE,GAAI,MAChCF,YAAY,CAACQ,OAAb,KAAyB,KAAzB,GACI,gBADJ,GAEI,8BACL,MAAKR,YAAY,CAACG,KAAb,CAAmBM,IAAK,IAJ9B;EAKA,OAAOF,GAAP;AACD"}