@rockcarver/frodo-lib 0.16.2-9 → 0.17.1

package/esm/ops/OAuth2ClientOps.mjs

@@ -1,22 +1,23 @@
 import fs from 'fs';
 import { createTable, printMessage } from './utils/Console';
 import { getTypedFilename, saveToFile, titleCase, validateImport } from './utils/ExportImportUtils';
-import storage from '../storage/SessionStorage';
+import * as state from '../shared/State';
 import { getOAuth2Client, getOAuth2Clients, putOAuth2Client } from '../api/OAuth2ClientApi';
 import { getOAuth2Provider } from '../api/OAuth2ProviderApi';
 import { getRealmName } from '../api/utils/ApiUtils';
+
 /**
  * List OAuth2 clients
  */
-
 export async function listOAuth2Clients(long = false) {
   try {
     const clients = (await getOAuth2Clients()).data.result;
     clients.sort((a, b) => a._id.localeCompare(b._id));
-
     if (long) {
-      const table = createTable(['Client Id', 'Status', 'Client Type', 'Grant Types', 'Scopes', 'Redirect URIs' // 'Description',
+      const table = createTable(['Client Id', 'Status', 'Client Type', 'Grant Types', 'Scopes', 'Redirect URIs'
+      // 'Description',
       ]);
+
       const grantTypesMap = {
         authorization_code: 'Authz Code',
         client_credentials: 'Client Creds',
@@ -31,9 +32,11 @@ export async function listOAuth2Clients(long = false) {
         'urn:ietf:params:oauth:grant-type:jwt-bearer': 'JWT Bearer'
       };
       clients.forEach(client => {
-        table.push([client._id, client.coreOAuth2ClientConfig.status === 'Active' ? 'Active'['brightGreen'] : client.coreOAuth2ClientConfig.status.brightRed, client.coreOAuth2ClientConfig.clientType, client.advancedOAuth2ClientConfig.grantTypes.map(type => grantTypesMap[type]).join('\n'), client.coreOAuth2ClientConfig.scopes.join('\n'), client.coreOAuth2ClientConfig.redirectionUris.join('\n') // wordwrap(client.description, 30),
+        table.push([client._id, client.coreOAuth2ClientConfig.status === 'Active' ? 'Active'['brightGreen'] : client.coreOAuth2ClientConfig.status.brightRed, client.coreOAuth2ClientConfig.clientType, client.advancedOAuth2ClientConfig.grantTypes.map(type => grantTypesMap[type]).join('\n'), client.coreOAuth2ClientConfig.scopes.join('\n'), client.coreOAuth2ClientConfig.redirectionUris.join('\n')
+        // wordwrap(client.description, 30),
         ]);
       });
+
       printMessage(table.toString(), 'data');
     } else {
       clients.forEach(client => {
@@ -44,77 +47,68 @@ export async function listOAuth2Clients(long = false) {
     printMessage(`Error listing applications - ${error}`, 'error');
   }
 }
+
 /**
  * Export OAuth2 client to file
  * @param {String} id client id
  * @param {String} file file name
  */
-
 export async function exportOAuth2ClientToFile(id, file) {
   let fileName = getTypedFilename(id, 'oauth2.app');
-
   if (file) {
     fileName = file;
   }
-
   const oauth2Service = (await getOAuth2Provider()).data;
   const client = (await getOAuth2Client(id)).data;
   client._provider = oauth2Service;
   saveToFile('application', [client], '_id', fileName);
 }
+
 /**
  * Export all OAuth2 clients to file
  * @param {String} file file name
  */
-
 export async function exportOAuth2ClientsToFile(file) {
-  let fileName = getTypedFilename(`all${titleCase(getRealmName(storage.session.getRealm()))}Applications`, 'oauth2.app');
-
+  let fileName = getTypedFilename(`all${titleCase(getRealmName(state.getRealm()))}Applications`, 'oauth2.app');
   if (file) {
     fileName = file;
   }
-
   const oauth2Service = (await getOAuth2Provider()).data;
   const clients = (await getOAuth2Clients()).data.result;
   const exportData = [];
-
   for (const client of clients) {
     client._provider = oauth2Service;
     exportData.push(client);
   }
-
   saveToFile('application', exportData, '_id', fileName);
 }
+
 /**
  * Export all OAuth2 clients to separate files
  */
-
 export async function exportOAuth2ClientsToFiles() {
   const oauth2Service = (await getOAuth2Provider()).data;
   const clients = (await getOAuth2Clients()).data.result;
-
   for (const client of clients) {
     client._provider = oauth2Service;
     const fileName = getTypedFilename(client._id, 'oauth2.app');
     saveToFile('application', [client], '_id', fileName);
   }
 }
+
 /**
  * Import OAuth2 clients from file
  * @param {String} file file name
  */
-
 export async function importOAuth2ClientsFromFile(file) {
   fs.readFile(file, 'utf8', async (err, data) => {
     if (err) throw err;
     const applicationData = JSON.parse(data);
-
     if (validateImport(applicationData.meta)) {
       for (const id in applicationData.application) {
         if (Object.prototype.hasOwnProperty.call(applicationData.application, id)) {
           delete applicationData.application[id]._provider;
           delete applicationData.application[id]._rev;
-
           try {
             await putOAuth2Client(id, applicationData.application[id]);
             printMessage(`Imported ${id}`);

package/esm/ops/OpsTypes.mjs

@@ -5,17 +5,15 @@
 /**
  * Tree import options
  */
-export let NodeClassification;
 
+export let NodeClassification;
 (function (NodeClassification) {
   NodeClassification["STANDARD"] = "standard";
   NodeClassification["CUSTOM"] = "custom";
   NodeClassification["CLOUD"] = "cloud";
   NodeClassification["PREMIUM"] = "premium";
 })(NodeClassification || (NodeClassification = {}));
-
 export let JourneyClassification;
-
 (function (JourneyClassification) {
   JourneyClassification["STANDARD"] = "standard";
   JourneyClassification["CUSTOM"] = "custom";

package/esm/ops/OrganizationOps.mjs

@@ -1,25 +1,23 @@
 import { queryAllManagedObjectsByType } from '../api/IdmConfigApi';
-import storage from '../storage/SessionStorage';
+import * as state from '../shared/State';
 import { printMessage } from './utils/Console';
+
 /**
  * Get organization managed object type
  * @returns {String} organization managed object type in this realm
  */
-
 export function getRealmManagedOrganization() {
   let realmManagedOrg = 'organization';
-
-  if (storage.session.getDeploymentType() === global.CLOUD_DEPLOYMENT_TYPE_KEY) {
-    realmManagedOrg = `${storage.session.getRealm()}_organization`;
+  if (state.getDeploymentType() === global.CLOUD_DEPLOYMENT_TYPE_KEY) {
+    realmManagedOrg = `${state.getRealm()}_organization`;
   }
-
   return realmManagedOrg;
 }
+
 /**
  * Get organizations
  * @returns {Promise} promise resolving to an object containing an array of organization objects
  */
-
 export async function getOrganizations() {
   const orgs = [];
   let result = {
@@ -30,7 +28,6 @@ export async function getOrganizations() {
     totalPagedResults: -1,
     remainingPagedResults: -1
   };
-
   try {
     do {
       try {
@@ -40,7 +37,6 @@ export async function getOrganizations() {
         printMessage(queryAllManagedObjectsByTypeError, 'error');
         printMessage(`Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`, 'error');
       }
-
       orgs.concat(result.result);
       printMessage('.', 'text', false);
     } while (result.pagedResultsCookie);
@@ -48,10 +44,10 @@ export async function getOrganizations() {
     printMessage(error.response.data, 'error');
     printMessage(`Error retrieving all organizations: ${error}`, 'error');
   }
-
   return orgs;
-} // unfinished work
+}
 
+// unfinished work
 export async function listOrganizationsTopDown() {
   const orgs = [];
   let result = {
@@ -62,7 +58,6 @@ export async function listOrganizationsTopDown() {
     totalPagedResults: -1,
     remainingPagedResults: -1
   };
-
   do {
     try {
       // eslint-disable-next-line no-await-in-loop
@@ -71,11 +66,9 @@ export async function listOrganizationsTopDown() {
       printMessage(queryAllManagedObjectsByTypeError, 'error');
       printMessage(`Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`, 'error');
     }
-
     orgs.concat(result.result);
     printMessage('.', 'text', false);
   } while (result.pagedResultsCookie);
-
   return orgs;
 }
 //# sourceMappingURL=OrganizationOps.js.map

package/esm/ops/RealmOps.mjs

@@ -1,14 +1,13 @@
 import { createKeyValueTable, createTable, printMessage } from './utils/Console';
 import { getRealmByName, getRealms, putRealm } from '../api/RealmApi';
+
 /**
  * List realms
  * @param {boolean} long Long list format with details
  */
-
 export async function listRealms(long = false) {
   try {
     const realms = (await getRealms()).data.result;
-
     if (long) {
       const table = createTable(['Name'['brightCyan'], 'Status'['brightCyan'], 'Custom Domains'['brightCyan'], 'Parent'['brightCyan']]);
       realms.forEach(realmConfig => {
@@ -25,11 +24,11 @@ export async function listRealms(long = false) {
     printMessage(error.response.data, 'error');
   }
 }
+
 /**
  * Describe realm
  * @param {String} realm realm name
  */
-
 export async function describe(realm) {
   try {
     const realmConfig = await getRealmByName(realm);
@@ -44,12 +43,12 @@ export async function describe(realm) {
     printMessage(`Realm ${realm} not found!`, 'error');
   }
 }
+
 /**
  * Add custom DNS domain name (realm DNS alias)
  * @param {String} realm realm name
  * @param {String} domain domain name
  */
-
 export async function addCustomDomain(realm, domain) {
   try {
     let realmConfig = await getRealmByName(realm);
@@ -59,7 +58,6 @@ export async function addCustomDomain(realm, domain) {
         exists = true;
       }
     });
-
     if (!exists) {
       try {
         realmConfig.aliases.push(domain.toLowerCase());
@@ -79,17 +77,16 @@ export async function addCustomDomain(realm, domain) {
     printMessage(`${error.message}`, 'error');
   }
 }
+
 /**
  * Remove custom DNS domain name (realm DNS alias)
  * @param {String} realm realm name
  * @param {String} domain domain name
  */
-
 export async function removeCustomDomain(realm, domain) {
   try {
     let realmConfig = await getRealmByName(realm);
     const aliases = realmConfig.aliases.filter(alias => domain.toLowerCase() !== alias.toLowerCase());
-
     if (aliases.length < realmConfig.aliases.length) {
       try {
         realmConfig.aliases = aliases;

package/esm/ops/Saml2Ops.mjs

@@ -11,8 +11,9 @@ export const roleMap = {
   serviceProvider: 'SP',
   attributeQueryProvider: 'AttrQuery',
   xacmlPolicyEnforcementPoint: 'XACML PEP'
-}; // use a function vs a template variable to avoid problems in loops
+};
 
+// use a function vs a template variable to avoid problems in loops
 export function createSaml2ExportTemplate() {
   return {
     meta: {},
@@ -24,105 +25,97 @@ export function createSaml2ExportTemplate() {
     }
   };
 }
+
 /**
  * Get SAML2 entity provider stubs
  * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
  */
-
 export async function getSaml2ProviderStubs() {
   const {
     result
   } = await getProviders();
   return result;
 }
+
 /**
  * Geta SAML2 entity provider by location and id
  * @param {string} location Entity provider location (hosted or remote)
  * @param {string} entityId64 Base64-encoded provider entity id
  * @returns {Promise} a promise that resolves to a saml2 entity provider object
  */
-
 export async function getProviderByLocationAndId(location, entityId64) {
   return _getProviderByLocationAndId(location, entityId64);
 }
+
 /**
  * Get a SAML2 entity provider's metadata URL by entity id
  * @param {string} entityId SAML2 entity id
  * @returns {string} the URL to get the metadata from
  */
-
 export function getProviderMetadataUrl(entityId) {
   return _getProviderMetadataUrl(entityId);
 }
+
 /**
  * Get a SAML2 entity provider's metadata by entity id
  * @param {String} entityId SAML2 entity id
  * @returns {Promise} a promise that resolves to an object containing a SAML2 metadata
  */
-
 export async function getProviderMetadata(entityId) {
   return _getProviderMetadata(entityId);
 }
+
 /**
  * Include dependencies in the export file
  * @param {Object} providerData Object representing a SAML entity provider
  * @param {Object} fileData File data object to add dependencies to
  */
-
 async function exportDependencies(providerData, fileData) {
   const attrMapperScriptId = _.get(providerData, ['identityProvider', 'assertionProcessing', 'attributeMapper', 'attributeMapperScript']);
-
   if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
     const scriptData = await getScript(attrMapperScriptId);
-    scriptData.script = convertBase64TextToArray(scriptData.script); // eslint-disable-next-line no-param-reassign
-
+    scriptData.script = convertBase64TextToArray(scriptData.script);
+    // eslint-disable-next-line no-param-reassign
     fileData.script[attrMapperScriptId] = scriptData;
   }
-
   const idpAdapterScriptId = _.get(providerData, ['identityProvider', 'advanced', 'idpAdapter', 'idpAdapterScript']);
-
   if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
     const scriptData = await getScript(idpAdapterScriptId);
-    scriptData.script = convertBase64TextToArray(scriptData.script); // eslint-disable-next-line no-param-reassign
-
+    scriptData.script = convertBase64TextToArray(scriptData.script);
+    // eslint-disable-next-line no-param-reassign
     fileData.script[idpAdapterScriptId] = scriptData;
   }
-
-  const metaDataResponse = await getProviderMetadata(providerData.entityId); // eslint-disable-next-line no-param-reassign
-
+  const metaDataResponse = await getProviderMetadata(providerData.entityId);
+  // eslint-disable-next-line no-param-reassign
   fileData.saml.metadata[providerData._id] = convertBase64UrlTextToArray(encodeBase64Url(metaDataResponse));
 }
+
 /**
  *
  * @param {String} entityId Provider entity id
  * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
  */
-
-
 export async function getSaml2ProviderStub(entityId) {
   debugMessage(`Saml2Ops.getSaml2ProviderStub: start [entityId=${entityId}]`);
   const found = await findProviders(`entityId eq '${entityId}'`);
-
   switch (found.resultCount) {
     case 0:
       throw new Error(`No provider with entity id '${entityId}' found`);
-
     case 1:
       {
         debugMessage(`Saml2Ops.getSaml2ProviderStub: end [entityId=${entityId}]`);
         return found.result[0];
       }
-
     default:
       throw new Error(`Multiple providers with entity id '${entityId}' found`);
   }
 }
+
 /**
  * Export a single entity provider. The response can be saved to file as is.
  * @param {String} entityId Provider entity id
  * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
  */
-
 export async function getSaml2Provider(entityId) {
   debugMessage(`Saml2Ops.getSaml2Provider: start [entityId=${entityId}]`);
   const stub = await getSaml2ProviderStub(entityId);
@@ -134,12 +127,12 @@ export async function getSaml2Provider(entityId) {
   debugMessage(`Saml2Ops.getSaml2Provider: end [entityId=${entityId}]`);
   return providerData;
 }
+
 /**
  * Export a single entity provider. The response can be saved to file as is.
  * @param {String} entityId Provider entity id
  * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-
 export async function exportSaml2Provider(entityId) {
   debugMessage(`Saml2Ops.exportSaml2Provider: start [entityId=${entityId}]`);
   const exportData = createSaml2ExportTemplate();
@@ -154,108 +147,89 @@ export async function exportSaml2Provider(entityId) {
   debugMessage(`Saml2Ops.exportSaml2Provider: end [entityId=${entityId}]`);
   return exportData;
 }
+
 /**
  * Export all entity providers. The response can be saved to file as is.
  * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-
 export async function exportSaml2Providers() {
   const fileData = createSaml2ExportTemplate();
   const stubs = await getSaml2ProviderStubs();
-
   for (const stub of stubs) {
     const providerData = await getProviderByLocationAndId(stub.location, stub._id);
     await exportDependencies(providerData, fileData);
     fileData.saml[stub.location][providerData._id] = providerData;
   }
-
   return fileData;
 }
+
 /**
  * Include dependencies from the import file
  * @param {Object} providerData Object representing a SAML entity provider
  * @param {Object} fileData File data object to read dependencies from
  */
-
 async function importDependencies(providerData, fileData) {
   debugMessage(`Saml2Ops.importDependencies: start`);
-
   const attrMapperScriptId = _.get(providerData, ['identityProvider', 'assertionProcessing', 'attributeMapper', 'attributeMapperScript']);
-
   if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {
     debugMessage(`Saml2Ops.importDependencies: attributeMapperScript=${attrMapperScriptId}`);
-
     const scriptData = _.get(fileData, ['script', attrMapperScriptId]);
-
     scriptData.script = convertTextArrayToBase64(scriptData.script);
     await createOrUpdateScript(attrMapperScriptId, scriptData);
   }
-
   const idpAdapterScriptId = _.get(providerData, ['identityProvider', 'advanced', 'idpAdapter', 'idpAdapterScript']);
-
   if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {
     debugMessage(`Saml2Ops.importDependencies: idpAdapterScript=${idpAdapterScriptId}`);
-
     const scriptData = _.get(fileData, ['script', idpAdapterScriptId]);
-
     scriptData.script = convertTextArrayToBase64(scriptData.script);
     await createOrUpdateScript(idpAdapterScriptId, scriptData);
   }
-
   debugMessage(`Saml2Ops.importDependencies: end`);
 }
+
 /**
  * Find provider in import file and return its location
  * @param {String} entityId64 Base64-encoded provider entity id
  * @param {Object} data Import file json data
  * @returns {String} 'hosted' or 'remote' if found, undefined otherwise
  */
-
-
 function getLocation(entityId64, data) {
   if (data.saml.hosted[entityId64]) {
     return Saml2ProiderLocation.HOSTED;
   }
-
   if (data.saml.remote[entityId64]) {
     return Saml2ProiderLocation.REMOTE;
   }
-
   return undefined;
 }
+
 /**
  * Import a SAML entity provider
  * @param {string} entityId Provider entity id
  * @param {Saml2ExportInterface} importData Import data
  */
-
-
 export async function importSaml2Provider(entityId, importData) {
   debugMessage(`Saml2Ops.importSaml2Provider: start`);
   const entityId64 = encode(entityId, false);
   const location = getLocation(entityId64, importData);
-
   if (location) {
     const providerData = importData.saml[location][entityId64];
     await importDependencies(providerData, importData);
     let metaData = null;
-
     if (location === Saml2ProiderLocation.REMOTE) {
       metaData = convertTextArrayToBase64Url(importData.saml.metadata[entityId64]);
     }
-
     await createProvider(location, providerData, metaData);
   } else {
     throw new Error(`Provider ${entityId} not found in import data!`);
   }
-
   debugMessage(`Saml2Ops.importSaml2Provider: end`);
 }
+
 /**
  * Import SAML entity providers
  * @param {Saml2ExportInterface} importData Import data
  */
-
 export async function importSaml2Providers(importData) {
   debugMessage(`Saml2Ops.importSaml2Providers: start`);
   const myStatus = {
@@ -264,7 +238,6 @@ export async function importSaml2Providers(importData) {
     warnings: 0,
     failures: 0
   };
-
   try {
     // find providers in hosted and in remote and map locations
     const hostedIds = Object.keys(importData.saml.hosted);
@@ -272,13 +245,11 @@ export async function importSaml2Providers(importData) {
     const providerIds = hostedIds.concat(remoteIds);
     myStatus.total = providerIds.length;
     createProgressIndicator(providerIds.length, 'Importing providers...');
-
     for (const entityId64 of providerIds) {
       debugMessage(`Saml2Ops.importSaml2Providers: entityId=${decodeBase64Url(entityId64)}`);
       const location = hostedIds.includes(entityId64) ? Saml2ProiderLocation.HOSTED : Saml2ProiderLocation.REMOTE;
       const entityId = decode(entityId64);
       const providerData = importData.saml[location][entityId64];
-
       try {
         await importDependencies(providerData, importData);
       } catch (importDependenciesErr) {
@@ -286,13 +257,10 @@ export async function importSaml2Providers(importData) {
         printMessage(`\nWarning importing dependencies for ${entityId}`, 'warn');
         printMessage(importDependenciesErr.response.data, 'error');
       }
-
       let metaData = null;
-
       if (location === Saml2ProiderLocation.REMOTE) {
         metaData = convertTextArrayToBase64Url(importData.saml.metadata[entityId64]);
       }
-
       try {
         await createProvider(location, providerData, metaData);
         myStatus.successes += 1;
@@ -303,23 +271,22 @@ export async function importSaml2Providers(importData) {
         printMessage(createProviderErr, 'error');
       }
     }
-
     myStatus.message = `${myStatus.successes}/${myStatus.total} providers imported.`;
     stopProgressIndicator(myStatus.message);
   } catch (error) {
     myStatus.failures += 1;
     printMessage(`\nError importing providers ${error.message}`, 'error');
   }
-
   debugMessage(`Saml2Ops.importSaml2Providers: end`);
   return myStatus;
-} // Contributions using legacy APIs. Need to investigate if those will be deprecated in the future
+}
+
+// Contributions using legacy APIs. Need to investigate if those will be deprecated in the future
 
 /**
  * Deletes entity provider
  * @param {string} entityId The entity id for the entity to be deleted
  */
-
 export async function deleteSaml2Provider(entityId) {
   try {
     await deleteProvider(entityId);
@@ -327,10 +294,10 @@ export async function deleteSaml2Provider(entityId) {
     printMessage(error.message, 'error');
   }
 }
+
 /**
  * Deletes all entity providers.
  */
-
 export async function deleteSaml2Providers() {
   const applicationList = (await getRawProviders()).result;
   const deleteApplicationPromises = [];
@@ -339,35 +306,34 @@ export async function deleteSaml2Providers() {
     deleteApplicationPromises.push(deleteSaml2Provider(item._id));
   });
   const deleteApplicationResult = await Promise.all(deleteApplicationPromises);
-
   if (deleteApplicationResult.length == applicationList.length) {
     printMessage('SAML Entity cleanup done', 'info');
   }
 }
+
 /**
  * Retrieves all entity providers using the legacy federation enpoints.
  * @returns {Promise} a promise that resolves to an object containing an array of providers
  */
-
 export async function getRawProviders() {
   return _getRawProviders();
 }
+
 /**
  * Retrieves all entity providers using the legacy federation enpoints.
  * @param {string} entityId The entity provider id
  * @returns {Promise} a promise that resolves to an object containing an array of providers
  */
-
 export async function getRawProvider(entityId) {
   return _getRawProvider(entityId);
 }
+
 /**
  * Stores a new SAML2 entity provider
  * @param {string} entityId The entity provider id
  * @param {string} entityData The actual data containing the entity provider configuration
  * @returns {Promise} Promise that resolves to a provider object
  */
-
 export async function putRawProvider(entityId, entityData) {
   return _putRawProvider(entityId, entityData);
 }