@rockcarver/frodo-lib 1.0.0 → 2.0.0-2

package/esm/ops/ServiceOps.mjs

@@ -1,5 +1,118 @@
 import { deleteService, deleteServiceNextDescendent, getService, getListOfServices as _getListOfServices, getServiceDescendents, putService, putServiceNextDescendent } from '../api/ServiceApi';
 import { debugMessage, printMessage } from './utils/Console';
+export default class ServiceOps {
+  constructor(state) {
+    this.state = state;
+  }
+  createServiceExportTemplate() {
+    return createServiceExportTemplate();
+  }
+
+  /**
+   * Get list of services
+   * @param {boolean} globalConfig true if the list of global services is requested, false otherwise. Default: false.
+   */
+  async getListOfServices(globalConfig = false) {
+    return getListOfServices({
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Get all services including their descendents.
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   * @returns Promise resolving to an array of services with their descendants
+   */
+  async getFullServices(globalConfig = false) {
+    return getFullServices({
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Deletes the specified service
+   * @param {string} serviceId The service to delete
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   */
+  async deleteFullService(serviceId, globalConfig = false) {
+    return deleteFullService({
+      serviceId,
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Deletes all services
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   */
+  async deleteFullServices(globalConfig = false) {
+    return deleteFullServices({
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Export service. The response can be saved to file as is.
+   * @param serviceId service id/name
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   * @returns {Promise<ServiceExportInterface>} Promise resolving to a ServiceExportInterface object.
+   */
+  async exportService(serviceId, globalConfig = false) {
+    return exportService({
+      serviceId,
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Export all services
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   */
+  async exportServices(globalConfig = false) {
+    return exportServices({
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Imports a single service using a reference to the service and a file to read the data from. Optionally clean (remove) an existing service first
+   * @param {string} serviceId The service id/name to add
+   * @param {ServiceExportInterface} importData The service configuration export data to import
+   * @param {boolean} clean Indicates whether to remove a possible existing service with the same id first.
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   * @returns Promise resolving when the service has been imported
+   */
+  async importService(serviceId, importData, clean, globalConfig = false) {
+    return importService({
+      serviceId,
+      importData,
+      clean,
+      globalConfig,
+      state: this.state
+    });
+  }
+
+  /**
+   * Imports multiple services from the same file. Optionally clean (remove) existing services first
+   * @param {ServiceExportInterface} importData The service configuration export data to import
+   * @param {boolean} clean Indicates whether to remove possible existing services first
+   * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
+   */
+  async importServices(importData, clean, globalConfig = false) {
+    return importServices({
+      importData,
+      clean,
+      globalConfig,
+      state: this.state
+    });
+  }
+}
 /**
  * Create an empty service export template
  * @returns {SingleTreeExportInterface} an empty service export template
@@ -15,9 +128,15 @@ export function createServiceExportTemplate() {
  * Get list of services
  * @param {boolean} globalConfig true if the list of global services is requested, false otherwise. Default: false.
  */
-export async function getListOfServices(globalConfig = false) {
+export async function getListOfServices({
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.getListOfServices: start`);
-  const services = (await _getListOfServices(globalConfig)).result;
+  const services = (await _getListOfServices({
+    globalConfig,
+    state
+  })).result;
   debugMessage(`ServiceOps.getListOfServices: end`);
   return services;
 }
@@ -27,12 +146,26 @@ export async function getListOfServices(globalConfig = false) {
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  * @returns Promise resolving to an array of services with their descendants
  */
-export async function getFullServices(globalConfig = false) {
+export async function getFullServices({
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.getFullServices: start, globalConfig=${globalConfig}`);
-  const serviceList = (await _getListOfServices(globalConfig)).result;
+  const serviceList = (await _getListOfServices({
+    globalConfig,
+    state
+  })).result;
   const fullServiceData = await Promise.all(serviceList.map(async listItem => {
     try {
-      const [service, nextDescendents] = await Promise.all([getService(listItem._id, globalConfig), getServiceDescendents(listItem._id, globalConfig)]);
+      const [service, nextDescendents] = await Promise.all([getService({
+        serviceId: listItem._id,
+        globalConfig,
+        state
+      }), getServiceDescendents({
+        serviceId: listItem._id,
+        globalConfig,
+        state
+      })]);
       return {
         ...service,
         nextDescendents
@@ -57,7 +190,13 @@ export async function getFullServices(globalConfig = false) {
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  * @returns promise resolving to a service object
  */
-async function putFullService(serviceId, fullServiceData, clean, globalConfig = false) {
+async function putFullService({
+  serviceId,
+  fullServiceData,
+  clean,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.putFullService: start, serviceId=${serviceId}, globalConfig=${globalConfig}`);
   const nextDescendents = fullServiceData.nextDescendents;
   delete fullServiceData.nextDescendents;
@@ -66,7 +205,11 @@ async function putFullService(serviceId, fullServiceData, clean, globalConfig =
   if (clean) {
     try {
       debugMessage(`ServiceOps.putFullService: clean`);
-      await deleteFullService(serviceId, globalConfig);
+      await deleteFullService({
+        serviceId,
+        globalConfig,
+        state
+      });
     } catch (error) {
       var _error$response4, _error$response5, _error$response5$data;
       if (!(((_error$response4 = error.response) === null || _error$response4 === void 0 ? void 0 : _error$response4.status) === 404 && ((_error$response5 = error.response) === null || _error$response5 === void 0 ? void 0 : (_error$response5$data = _error$response5.data) === null || _error$response5$data === void 0 ? void 0 : _error$response5$data.message) === 'Not Found')) {
@@ -78,7 +221,12 @@ async function putFullService(serviceId, fullServiceData, clean, globalConfig =
   }
 
   // create service first
-  const result = await putService(serviceId, fullServiceData, globalConfig);
+  const result = await putService({
+    serviceId,
+    serviceData: fullServiceData,
+    globalConfig,
+    state
+  });
 
   // return fast if no next descendents supplied
   if (nextDescendents.length === 0) {
@@ -93,7 +241,14 @@ async function putFullService(serviceId, fullServiceData, clean, globalConfig =
     debugMessage(`ServiceOps.putFullService: descendentId=${descendentId}`);
     let result = undefined;
     try {
-      result = await putServiceNextDescendent(serviceId, type, descendentId, descendent, globalConfig);
+      result = await putServiceNextDescendent({
+        serviceId,
+        serviceType: type,
+        serviceNextDescendentId: descendentId,
+        serviceNextDescendentData: descendent,
+        globalConfig,
+        state
+      });
     } catch (error) {
       var _error$response7, _error$response7$data;
       const message = (_error$response7 = error.response) === null || _error$response7 === void 0 ? void 0 : (_error$response7$data = _error$response7.data) === null || _error$response7$data === void 0 ? void 0 : _error$response7$data.message;
@@ -111,12 +266,23 @@ async function putFullService(serviceId, fullServiceData, clean, globalConfig =
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  * @returns {Promise<AmService[]>} promise resolving to an array of service objects
  */
-async function putFullServices(serviceEntries, clean, globalConfig = false) {
+async function putFullServices({
+  serviceEntries,
+  clean,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.putFullServices: start, globalConfig=${globalConfig}`);
   const results = [];
   for (const [id, data] of serviceEntries) {
     try {
-      const result = await putFullService(id, data, clean, globalConfig);
+      const result = await putFullService({
+        serviceId: id,
+        fullServiceData: data,
+        clean,
+        globalConfig,
+        state
+      });
       results.push(result);
       printMessage(`Imported: ${id}`, 'info');
     } catch (error) {
@@ -138,11 +304,29 @@ async function putFullServices(serviceEntries, clean, globalConfig = false) {
  * @param {string} serviceId The service to delete
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export async function deleteFullService(serviceId, globalConfig = false) {
+export async function deleteFullService({
+  serviceId,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.deleteFullService: start, globalConfig=${globalConfig}`);
-  const serviceNextDescendentData = await getServiceDescendents(serviceId, globalConfig);
-  await Promise.all(serviceNextDescendentData.map(nextDescendent => deleteServiceNextDescendent(serviceId, nextDescendent._type._id, nextDescendent._id, globalConfig)));
-  await deleteService(serviceId, globalConfig);
+  const serviceNextDescendentData = await getServiceDescendents({
+    serviceId,
+    globalConfig,
+    state
+  });
+  await Promise.all(serviceNextDescendentData.map(nextDescendent => deleteServiceNextDescendent({
+    serviceId,
+    serviceType: nextDescendent._type._id,
+    serviceNextDescendentId: nextDescendent._id,
+    globalConfig,
+    state
+  })));
+  await deleteService({
+    serviceId,
+    globalConfig,
+    state
+  });
   debugMessage(`ServiceOps.deleteFullService: end`);
 }
 
@@ -150,13 +334,23 @@ export async function deleteFullService(serviceId, globalConfig = false) {
  * Deletes all services
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export async function deleteFullServices(globalConfig = false) {
+export async function deleteFullServices({
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.deleteFullServices: start, globalConfig=${globalConfig}`);
   try {
-    const serviceList = (await _getListOfServices(globalConfig)).result;
+    const serviceList = (await _getListOfServices({
+      globalConfig,
+      state
+    })).result;
     await Promise.all(serviceList.map(async serviceListItem => {
       try {
-        await deleteFullService(serviceListItem._id, globalConfig);
+        await deleteFullService({
+          serviceId: serviceListItem._id,
+          globalConfig,
+          state
+        });
       } catch (error) {
         var _error$response10, _error$response11, _error$response11$dat;
         if (!(((_error$response10 = error.response) === null || _error$response10 === void 0 ? void 0 : _error$response10.status) === 403 && ((_error$response11 = error.response) === null || _error$response11 === void 0 ? void 0 : (_error$response11$dat = _error$response11.data) === null || _error$response11$dat === void 0 ? void 0 : _error$response11$dat.message) === 'This operation is not available in ForgeRock Identity Cloud.')) {
@@ -180,12 +374,24 @@ export async function deleteFullServices(globalConfig = false) {
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  * @returns {Promise<ServiceExportInterface>} Promise resolving to a ServiceExportInterface object.
  */
-export async function exportService(serviceId, globalConfig = false) {
+export async function exportService({
+  serviceId,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.exportService: start, globalConfig=${globalConfig}`);
   const exportData = createServiceExportTemplate();
   try {
-    const service = await getService(serviceId, globalConfig);
-    service.nextDescendents = await getServiceDescendents(serviceId, globalConfig);
+    const service = await getService({
+      serviceId,
+      globalConfig,
+      state
+    });
+    service.nextDescendents = await getServiceDescendents({
+      serviceId,
+      globalConfig,
+      state
+    });
     exportData.service[serviceId] = service;
   } catch (error) {
     var _error$response14, _error$response14$dat;
@@ -200,11 +406,17 @@ export async function exportService(serviceId, globalConfig = false) {
  * Export all services
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export async function exportServices(globalConfig = false) {
+export async function exportServices({
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.exportServices: start, globalConfig=${globalConfig}`);
   const exportData = createServiceExportTemplate();
   try {
-    const services = await getFullServices(globalConfig);
+    const services = await getFullServices({
+      globalConfig,
+      state
+    });
     for (const service of services) {
       exportData.service[service._type._id] = service;
     }
@@ -225,10 +437,22 @@ export async function exportServices(globalConfig = false) {
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  * @returns Promise resolving when the service has been imported
  */
-export async function importService(serviceId, importData, clean, globalConfig = false) {
+export async function importService({
+  serviceId,
+  importData,
+  clean,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.importService: start, globalConfig=${globalConfig}`);
   const serviceData = importData.service[serviceId];
-  const result = await putFullService(serviceId, serviceData, clean, globalConfig);
+  const result = await putFullService({
+    serviceId,
+    fullServiceData: serviceData,
+    clean,
+    globalConfig,
+    state
+  });
   debugMessage(`ServiceOps.importService: end`);
   return result;
 }
@@ -239,10 +463,20 @@ export async function importService(serviceId, importData, clean, globalConfig =
  * @param {boolean} clean Indicates whether to remove possible existing services first
  * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export async function importServices(importData, clean, globalConfig = false) {
+export async function importServices({
+  importData,
+  clean,
+  globalConfig = false,
+  state
+}) {
   debugMessage(`ServiceOps.importServices: start, globalConfig=${globalConfig}`);
   try {
-    const result = await putFullServices(Object.entries(importData.service), clean, globalConfig);
+    const result = await putFullServices({
+      serviceEntries: Object.entries(importData.service),
+      clean,
+      globalConfig,
+      state
+    });
     debugMessage(`ServiceOps.importServices: end`);
     return result;
   } catch (error) {