Merge pull request #332 from vscheuber/main

resolves #328 and fixes #331

src/api/BaseApi.ts

@@ -194,7 +194,7 @@ export function generateAmApi({
 
 /**
  * Generates an OAuth2 Axios API instance
- * @param {object} resource Takes an object takes a resource object. example:
+ * @param {object} resource Takes a resource object. example:
  * @param {object} requestOverride Takes an object of AXIOS parameters that can be used to either
  * add on extra information or override default properties https://github.com/axios/axios#request-config
  *

src/api/ReconApi.ts

@@ -0,0 +1,244 @@
+import util from 'util';
+
+import { State } from '../shared/State';
+import { getHostBaseUrl } from '../utils/ForgeRockUtils';
+import { IdObjectSkeletonInterface } from './ApiTypes';
+import { generateIdmApi } from './BaseApi';
+
+const apiVersion = 'resource=1.0';
+const apiConfig = { headers: { 'Accept-API-Version': apiVersion } };
+
+const reconUrlTemplate = '%s/openidm/recon';
+const reconByIdUrlTemplate = '%s/openidm/recon/%s';
+const startReconUrlTemplate = '%s/openidm/recon?_action=recon&mapping=%s';
+const startReconByIdUrlTemplate =
+  '%s/openidm/recon?_action=reconById&mapping=%s&id=%s';
+const cancelReconUrlTemplate = '%s/openidm/recon/%s?_action=cancel';
+
+export type ReconType = IdObjectSkeletonInterface & {
+  mapping: string;
+  state: 'SUCCESS' | string;
+  stage: 'COMPLETED_SUCCESS' | string;
+  stageDescription: string;
+  progress: {
+    source: { existing: { processed: number; total: string } };
+    target: {
+      existing: { processed: number; total: string };
+      created: number;
+      unchanged: number;
+      updated: number;
+      deleted: number;
+    };
+    links: { existing: { processed: number; total: string }; created: number };
+  };
+  situationSummary: {
+    SOURCE_IGNORED: number;
+    TARGET_CHANGED: number;
+    SOURCE_TARGET_CONFLICT: number;
+    FOUND_ALREADY_LINKED: number;
+    UNQUALIFIED: number;
+    ABSENT: number;
+    TARGET_IGNORED: number;
+    MISSING: number;
+    ALL_GONE: number;
+    UNASSIGNED: number;
+    AMBIGUOUS: number;
+    CONFIRMED: number;
+    LINK_ONLY: number;
+    SOURCE_MISSING: number;
+    FOUND: number;
+  };
+  statusSummary: { SUCCESS: number; FAILURE: number };
+  durationSummary: {
+    sourceQuery: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    auditLog: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    defaultPropertyMapping: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    sourceLinkQuery: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    updateTargetObject: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    propertyMappingScript: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    updateLastSync: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    targetObjectQuery: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+    sourcePhase: {
+      min: number;
+      max: number;
+      mean: number;
+      count: number;
+      sum: number;
+      stdDev: number;
+    };
+  };
+  parameters: {
+    sourceIds: [string];
+    sourceQuery: {
+      resourceName: string;
+      _queryFilter: string;
+      _fields: string;
+    };
+    targetQuery: {
+      resourceName: string;
+      queryFilter: string;
+      _fields: string;
+    };
+  };
+  started: string;
+  ended: string;
+  duration: number;
+  sourceProcessedByNode: object;
+};
+
+export type ReconStatusType = IdObjectSkeletonInterface & {
+  state: 'ACTIVE' | string;
+  action: 'cancel' | string;
+  status: 'INITIATED' | string;
+};
+
+export async function getRecons({
+  state,
+}: {
+  state: State;
+}): Promise<ReconType[]> {
+  const urlString = util.format(
+    reconUrlTemplate,
+    getHostBaseUrl(state.getHost())
+  );
+  const { data } = await generateIdmApi({
+    requestOverride: apiConfig,
+    state,
+  }).get(urlString);
+  return data;
+}
+
+export async function getRecon({
+  reconId,
+  state,
+}: {
+  reconId: string;
+  state: State;
+}): Promise<ReconType> {
+  const urlString = util.format(
+    reconByIdUrlTemplate,
+    getHostBaseUrl(state.getHost()),
+    reconId
+  );
+  const { data } = await generateIdmApi({
+    requestOverride: apiConfig,
+    state,
+  }).get(urlString);
+  return data;
+}
+
+export async function startRecon({
+  mappingName,
+  state,
+}: {
+  mappingName: string;
+  state: State;
+}): Promise<ReconStatusType> {
+  const urlString = util.format(
+    startReconUrlTemplate,
+    getHostBaseUrl(state.getHost()),
+    mappingName
+  );
+  const { data } = await generateIdmApi({
+    requestOverride: apiConfig,
+    state,
+  }).post(urlString);
+  return data;
+}
+
+export async function startReconById({
+  mappingName,
+  objectId,
+  state,
+}: {
+  mappingName: string;
+  objectId: string;
+  state: State;
+}): Promise<ReconStatusType> {
+  const urlString = util.format(
+    startReconByIdUrlTemplate,
+    getHostBaseUrl(state.getHost()),
+    mappingName,
+    objectId
+  );
+  const { data } = await generateIdmApi({
+    requestOverride: apiConfig,
+    state,
+  }).post(urlString);
+  return data;
+}
+
+export async function cancelRecon({
+  reconId,
+  state,
+}: {
+  reconId: string;
+  state: State;
+}): Promise<ReconStatusType> {
+  const urlString = util.format(
+    cancelReconUrlTemplate,
+    getHostBaseUrl(state.getHost()),
+    reconId
+  );
+  const { data } = await generateIdmApi({
+    requestOverride: apiConfig,
+    state,
+  }).post(urlString);
+  return data;
+}

src/lib/FrodoLib.ts

@@ -36,6 +36,7 @@ import OrganizationOps, { Organization } from '../ops/OrganizationOps';
 import PolicyOps, { Policy } from '../ops/PolicyOps';
 import PolicySetOps, { PolicySet } from '../ops/PolicySetOps';
 import RealmOps, { Realm } from '../ops/RealmOps';
+import ReconOps, { Recon } from '../ops/ReconOps';
 import ResourceTypeOps, { ResourceType } from '../ops/ResourceTypeOps';
 import Saml2Ops, { Saml2 } from '../ops/Saml2Ops';
 import ScriptOps, { Script } from '../ops/ScriptOps';
@@ -95,6 +96,7 @@ export type Frodo = {
     managed: ManagedObject;
     mapping: Mapping;
     organization: Organization;
+    recon: Recon;
     system: IdmSystem;
   };
 
@@ -230,6 +232,7 @@ const FrodoLib = (config: StateInterface = {}): Frodo => {
       managed: ManagedObjectOps(state),
       mapping: MappingOps(state),
       organization: OrganizationOps(state),
+      recon: ReconOps(state),
       system: IdmSystemOps(state),
     },
 

src/ops/CirclesOfTrustOps.ts

@@ -546,7 +546,7 @@ export async function importCirclesOfTrust({
           hasEntityId = true;
         }
       }
-      if (entityProviders.length || hasEntityId) {
+      if (entityProviders.length === 0 || hasEntityId) {
         try {
           response.push(await createCircleOfTrust({ cotId, cotData, state }));
         } catch (createError) {