@rockcarver/frodo-lib 0.17.3 → 0.17.4

package/esm/ops/Saml2Ops.mjs

@@ -1,11 +1,11 @@
 import _ from 'lodash';
 import { Saml2ProiderLocation } from '../api/ApiTypes';
-import { createProvider, deleteProvider, findProviders, getProviderByLocationAndId as _getProviderByLocationAndId, getProviderMetadata as _getProviderMetadata, getProviderMetadataUrl as _getProviderMetadataUrl, getRawProvider as _getRawProvider, getProviders, getRawProviders as _getRawProviders, putRawProvider as _putRawProvider } from '../api/Saml2Api';
+import { createProvider, deleteRawProvider, findProviders, getProviderByLocationAndId as _getProviderByLocationAndId, getProviderMetadata as _getProviderMetadata, getProviderMetadataUrl as _getProviderMetadataUrl, getRawProvider as _getRawProvider, getProviders, getRawProviders as _getRawProviders, putRawProvider as _putRawProvider, deleteProviderByLocationAndId } from '../api/Saml2Api';
 import { getScript } from '../api/ScriptApi';
 import { decode, decodeBase64Url, encode, encodeBase64Url } from '../api/utils/Base64';
-import { createOrUpdateScript } from './ScriptOps';
+import { putScript } from './ScriptOps';
 import { createProgressIndicator, debugMessage, printMessage, stopProgressIndicator, updateProgressIndicator } from './utils/Console';
-import { convertBase64TextToArray, convertBase64UrlTextToArray, convertTextArrayToBase64, convertTextArrayToBase64Url } from './utils/ExportImportUtils';
+import { convertBase64TextToArray, convertBase64UrlTextToArray, convertTextArrayToBase64, convertTextArrayToBase64Url, getMetadata } from './utils/ExportImportUtils';
 export const roleMap = {
   identityProvider: 'IDP',
   serviceProvider: 'SP',
@@ -16,7 +16,7 @@ export const roleMap = {
 // use a function vs a template variable to avoid problems in loops
 export function createSaml2ExportTemplate() {
   return {
-    meta: {},
+    meta: getMetadata(),
     script: {},
     saml: {
       hosted: {},
@@ -40,7 +40,7 @@ export async function getSaml2ProviderStubs() {
 /**
  * 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
+ * @param {string} entityId64 Base64-encoded-without-padding provider entity id
  * @returns {Promise} a promise that resolves to a saml2 entity provider object
  */
 export async function getProviderByLocationAndId(location, entityId64) {
@@ -58,8 +58,8 @@ export function 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
+ * @param {string} entityId SAML2 entity id
+ * @returns {Promise<object>} a promise that resolves to an object containing a SAML2 metadata
  */
 export async function getProviderMetadata(entityId) {
   return _getProviderMetadata(entityId);
@@ -67,8 +67,8 @@ export async function 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
+ * @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']);
@@ -92,7 +92,7 @@ async function exportDependencies(providerData, fileData) {
 
 /**
  *
- * @param {String} entityId Provider entity id
+ * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
  */
 export async function getSaml2ProviderStub(entityId) {
@@ -113,7 +113,7 @@ export async function getSaml2ProviderStub(entityId) {
 
 /**
  * Export a single entity provider. The response can be saved to file as is.
- * @param {String} entityId Provider entity id
+ * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
  */
 export async function getSaml2Provider(entityId) {
@@ -128,9 +128,42 @@ export async function getSaml2Provider(entityId) {
   return providerData;
 }
 
+/**
+ * Delete an 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 deleteSaml2Provider(entityId) {
+  debugMessage(`Saml2Ops.deleteSaml2Provider: start [entityId=${entityId}]`);
+  const stub = await getSaml2ProviderStub(entityId);
+  const {
+    location
+  } = stub;
+  const id = stub._id;
+  const providerData = await deleteProviderByLocationAndId(location, id);
+  debugMessage(`Saml2Ops.deleteSaml2Provider: end [entityId=${entityId}]`);
+  return providerData;
+}
+
+/**
+ * Delete all entity providers.
+ * @returns {Promise<Saml2ProviderSkeleton[]>} Promise resolving to an array of Saml2ProviderSkeleton objects.
+ */
+export async function deleteSaml2Providers() {
+  debugMessage(`Saml2Ops.deleteSaml2Providers: start`);
+  const providers = [];
+  const stubs = await getSaml2ProviderStubs();
+  for (const stub of stubs) {
+    const provider = await deleteProviderByLocationAndId(stub.location, stub._id);
+    providers.push(provider);
+  }
+  debugMessage(`Saml2Ops.deleteSaml2Providers: end [deleted ${providers.length} providers]`);
+  return providers;
+}
+
 /**
  * Export a single entity provider. The response can be saved to file as is.
- * @param {String} entityId Provider entity id
+ * @param {string} entityId Provider entity id
  * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
 export async function exportSaml2Provider(entityId) {
@@ -165,8 +198,8 @@ export async function exportSaml2Providers() {
 
 /**
  * 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
+ * @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`);
@@ -175,23 +208,23 @@ async function importDependencies(providerData, fileData) {
     debugMessage(`Saml2Ops.importDependencies: attributeMapperScript=${attrMapperScriptId}`);
     const scriptData = _.get(fileData, ['script', attrMapperScriptId]);
     scriptData.script = convertTextArrayToBase64(scriptData.script);
-    await createOrUpdateScript(attrMapperScriptId, scriptData);
+    await putScript(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);
+    await putScript(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
+ * @param {string} entityId64 Base64-encoded provider entity id
+ * @param {Saml2ExportInterface} data Import file json data
+ * @returns {string} 'hosted' or 'remote' if found, undefined otherwise
  */
 function getLocation(entityId64, data) {
   if (data.saml.hosted[entityId64]) {
@@ -224,6 +257,7 @@ export async function importSaml2Provider(entityId, importData) {
     throw new Error(`Provider ${entityId} not found in import data!`);
   }
   debugMessage(`Saml2Ops.importSaml2Provider: end`);
+  return true;
 }
 
 /**
@@ -286,36 +320,37 @@ export async function importSaml2Providers(importData) {
 /**
  * Deletes entity provider
  * @param {string} entityId The entity id for the entity to be deleted
+ * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.
  */
-export async function deleteSaml2Provider(entityId) {
-  try {
-    await deleteProvider(entityId);
-  } catch (error) {
-    printMessage(error.message, 'error');
-  }
+export async function deleteRawSaml2Provider(entityId) {
+  debugMessage(`Saml2Ops.deleteSaml2Provider: start [entityId=${entityId}]`);
+  const response = await deleteRawProvider(entityId);
+  debugMessage(`Saml2Ops.deleteSaml2Provider: end [entityId=${entityId}]`);
+  return response;
 }
 
 /**
  * Deletes all entity providers.
  */
-export async function deleteSaml2Providers() {
-  const applicationList = (await getRawProviders()).result;
+export async function deleteRawSaml2Providers() {
+  const applicationList = (await getRawSaml2Providers()).result;
   const deleteApplicationPromises = [];
   applicationList.forEach(item => {
     printMessage(`Deleting Application ${item._id}`, 'error');
-    deleteApplicationPromises.push(deleteSaml2Provider(item._id));
+    deleteApplicationPromises.push(deleteRawProvider(item._id));
   });
   const deleteApplicationResult = await Promise.all(deleteApplicationPromises);
   if (deleteApplicationResult.length == applicationList.length) {
     printMessage('SAML Entity cleanup done', 'info');
   }
+  return deleteApplicationResult;
 }
 
 /**
  * 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() {
+export async function getRawSaml2Providers() {
   return _getRawProviders();
 }
 
@@ -324,7 +359,7 @@ export async function getRawProviders() {
  * @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) {
+export async function getRawSaml2Provider(entityId) {
   return _getRawProvider(entityId);
 }
 
@@ -334,7 +369,7 @@ export async function getRawProvider(entityId) {
  * @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) {
+export async function putRawSaml2Provider(entityId, entityData) {
   return _putRawProvider(entityId, entityData);
 }
 //# sourceMappingURL=Saml2Ops.js.map