@rockcarver/frodo-lib 0.16.2-8 → 0.17.0

package/types/ops/OpsTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/OpsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,YAAY,EACb,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACxC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3D,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACrD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,CAAC,EAAE,MAAM,GAAG,0BAA0B,EAAE,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC1C,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtD;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,oBAAY,qBAAqB;IAC/B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB","file":"OpsTypes.d.ts","sourcesContent":["import {\n  AgentSkeleton,\n  AmServiceSkeleton,\n  CircleOfTrustSkeleton,\n  EmailTemplateSkeleton,\n  NodeSkeleton,\n  Saml2ProviderSkeleton,\n  ScriptSkeleton,\n  SocialIdpSkeleton,\n  ThemeSkeleton,\n  TreeSkeleton,\n} from '../api/ApiTypes';\n\n/**\n * Tree export options\n */\nexport interface TreeExportOptions {\n  /**\n   * Where applicable, use string arrays to store multi-line text (e.g. scripts).\n   */\n  useStringArrays: boolean;\n  /**\n   * Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).\n   */\n  deps: boolean;\n}\n\n/**\n * Tree import options\n */\nexport interface TreeImportOptions {\n  /**\n   * Generate new UUIDs for all nodes during import.\n   */\n  reUuid: boolean;\n  /**\n   * Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).\n   */\n  deps: boolean;\n}\n\nexport interface ExportMetaData {\n  origin: string;\n  originAmVersion: string;\n  exportedBy: string;\n  exportDate: string;\n  exportTool: string;\n  exportToolVersion: string;\n}\n\nexport interface SingleTreeExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  innerNodes?: Record<string, NodeSkeleton>;\n  innernodes?: Record<string, NodeSkeleton>;\n  nodes: Record<string, NodeSkeleton>;\n  scripts: Record<string, ScriptSkeleton>;\n  emailTemplates: Record<string, EmailTemplateSkeleton>;\n  socialIdentityProviders: Record<string, SocialIdpSkeleton>;\n  themes: ThemeSkeleton[];\n  saml2Entities: Record<string, Saml2ProviderSkeleton>;\n  circlesOfTrust: Record<string, CircleOfTrustSkeleton>;\n  tree: TreeSkeleton;\n}\n\nexport interface MultiTreeExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  trees: Record<string, SingleTreeExportInterface>;\n}\n\nexport interface AgentExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  agents: Record<string, AgentSkeleton>;\n}\n\nexport interface ServiceExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  service: Record<string, AmServiceSkeleton>;\n}\n\nexport interface TreeDependencyMapInterface {\n  [k: string]: TreeDependencyMapInterface[];\n}\n\nexport interface TreeExportResolverInterface {\n  (treeId: string): Promise<SingleTreeExportInterface>;\n}\n\nexport enum NodeClassification {\n  STANDARD = 'standard',\n  CUSTOM = 'custom',\n  CLOUD = 'cloud',\n  PREMIUM = 'premium',\n}\n\nexport enum JourneyClassification {\n  STANDARD = 'standard',\n  CUSTOM = 'custom',\n  CLOUD = 'cloud',\n  PREMIUM = 'premium',\n}\n"]}
+{"version":3,"sources":["../src/ops/OpsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,YAAY,EACb,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACxC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3D,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACrD,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACvC,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACpC,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B;IACzC,CAAC,CAAC,EAAE,MAAM,GAAG,0BAA0B,EAAE,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC1C,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtD;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,oBAAY,qBAAqB;IAC/B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB","file":"OpsTypes.d.ts","sourcesContent":["import {\n  AgentSkeleton,\n  AmServiceSkeleton,\n  CircleOfTrustSkeleton,\n  EmailTemplateSkeleton,\n  NodeSkeleton,\n  Saml2ProviderSkeleton,\n  ScriptSkeleton,\n  SocialIdpSkeleton,\n  ThemeSkeleton,\n  TreeSkeleton,\n} from '../api/ApiTypes';\n\n/**\n * Tree export options\n */\nexport interface TreeExportOptions {\n  /**\n   * Where applicable, use string arrays to store multi-line text (e.g. scripts).\n   */\n  useStringArrays: boolean;\n  /**\n   * Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).\n   */\n  deps: boolean;\n}\n\n/**\n * Tree import options\n */\nexport interface TreeImportOptions {\n  /**\n   * Generate new UUIDs for all nodes during import.\n   */\n  reUuid: boolean;\n  /**\n   * Include any dependencies (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).\n   */\n  deps: boolean;\n}\n\nexport interface ExportMetaData {\n  origin: string;\n  originAmVersion: string;\n  exportedBy: string;\n  exportDate: string;\n  exportTool: string;\n  exportToolVersion: string;\n}\n\nexport interface SingleTreeExportInterface {\n  meta?: ExportMetaData;\n  innerNodes?: Record<string, NodeSkeleton>;\n  innernodes?: Record<string, NodeSkeleton>;\n  nodes: Record<string, NodeSkeleton>;\n  scripts: Record<string, ScriptSkeleton>;\n  emailTemplates: Record<string, EmailTemplateSkeleton>;\n  socialIdentityProviders: Record<string, SocialIdpSkeleton>;\n  themes: ThemeSkeleton[];\n  saml2Entities: Record<string, Saml2ProviderSkeleton>;\n  circlesOfTrust: Record<string, CircleOfTrustSkeleton>;\n  tree: TreeSkeleton;\n}\n\nexport interface MultiTreeExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  trees: Record<string, SingleTreeExportInterface>;\n}\n\nexport interface AgentExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  agents: Record<string, AgentSkeleton>;\n}\n\nexport interface Saml2ExportInterface {\n  meta?: ExportMetaData;\n  script: Record<string, ScriptSkeleton>;\n  saml: {\n    hosted: Record<string, Saml2ProviderSkeleton>;\n    remote: Record<string, Saml2ProviderSkeleton>;\n    metadata: Record<string, string[]>;\n  };\n}\n\nexport interface ServiceExportInterface {\n  meta?: Record<string, ExportMetaData>;\n  service: Record<string, AmServiceSkeleton>;\n}\n\nexport interface TreeDependencyMapInterface {\n  [k: string]: TreeDependencyMapInterface[];\n}\n\nexport interface TreeExportResolverInterface {\n  (treeId: string): Promise<SingleTreeExportInterface>;\n}\n\nexport enum NodeClassification {\n  STANDARD = 'standard',\n  CUSTOM = 'custom',\n  CLOUD = 'cloud',\n  PREMIUM = 'premium',\n}\n\nexport enum JourneyClassification {\n  STANDARD = 'standard',\n  CUSTOM = 'custom',\n  CLOUD = 'cloud',\n  PREMIUM = 'premium',\n}\n\nexport interface MultiOpStatusInterface {\n  total: number;\n  successes: number;\n  warnings: number;\n  failures: number;\n  message?: string;\n}\n"]}

package/types/ops/OrganizationOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/OrganizationOps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAgB,2BAA2B,WAQ1C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,mBAkCrC;AAGD,wBAAsB,wBAAwB,mBA6B7C","file":"OrganizationOps.d.ts","sourcesContent":["import { queryAllManagedObjectsByType } from '../api/IdmConfigApi';\nimport storage from '../storage/SessionStorage';\nimport { printMessage } from './utils/Console';\n\n/**\n * Get organization managed object type\n * @returns {String} organization managed object type in this realm\n */\nexport function getRealmManagedOrganization() {\n  let realmManagedOrg = 'organization';\n  if (\n    storage.session.getDeploymentType() === global.CLOUD_DEPLOYMENT_TYPE_KEY\n  ) {\n    realmManagedOrg = `${storage.session.getRealm()}_organization`;\n  }\n  return realmManagedOrg;\n}\n\n/**\n * Get organizations\n * @returns {Promise} promise resolving to an object containing an array of organization objects\n */\nexport async function getOrganizations() {\n  const orgs = [];\n  let result = {\n    result: [],\n    resultCount: 0,\n    pagedResultsCookie: null,\n    totalPagedResultsPolicy: 'NONE',\n    totalPagedResults: -1,\n    remainingPagedResults: -1,\n  };\n  try {\n    do {\n      try {\n        // eslint-disable-next-line no-await-in-loop\n        result = await queryAllManagedObjectsByType(\n          getRealmManagedOrganization(),\n          ['name', 'parent/*/name', 'children/*/name'],\n          result.pagedResultsCookie\n        );\n      } catch (queryAllManagedObjectsByTypeError) {\n        printMessage(queryAllManagedObjectsByTypeError, 'error');\n        printMessage(\n          `Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`,\n          'error'\n        );\n      }\n      orgs.concat(result.result);\n      printMessage('.', 'text', false);\n    } while (result.pagedResultsCookie);\n  } catch (error) {\n    printMessage(error.response.data, 'error');\n    printMessage(`Error retrieving all organizations: ${error}`, 'error');\n  }\n  return orgs;\n}\n\n// unfinished work\nexport async function listOrganizationsTopDown() {\n  const orgs = [];\n  let result = {\n    result: [],\n    resultCount: 0,\n    pagedResultsCookie: null,\n    totalPagedResultsPolicy: 'NONE',\n    totalPagedResults: -1,\n    remainingPagedResults: -1,\n  };\n  do {\n    try {\n      // eslint-disable-next-line no-await-in-loop\n      result = await queryAllManagedObjectsByType(\n        getRealmManagedOrganization(),\n        ['name', 'parent/*/name', 'children/*/name'],\n        result.pagedResultsCookie\n      );\n    } catch (queryAllManagedObjectsByTypeError) {\n      printMessage(queryAllManagedObjectsByTypeError, 'error');\n      printMessage(\n        `Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`,\n        'error'\n      );\n    }\n    orgs.concat(result.result);\n    printMessage('.', 'text', false);\n  } while (result.pagedResultsCookie);\n  return orgs;\n}\n"]}
+{"version":3,"sources":["../src/ops/OrganizationOps.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,wBAAgB,2BAA2B,WAM1C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,mBAkCrC;AAGD,wBAAsB,wBAAwB,mBA6B7C","file":"OrganizationOps.d.ts","sourcesContent":["import { queryAllManagedObjectsByType } from '../api/IdmConfigApi';\nimport * as state from '../shared/State';\nimport { printMessage } from './utils/Console';\n\n/**\n * Get organization managed object type\n * @returns {String} organization managed object type in this realm\n */\nexport function getRealmManagedOrganization() {\n  let realmManagedOrg = 'organization';\n  if (state.getDeploymentType() === global.CLOUD_DEPLOYMENT_TYPE_KEY) {\n    realmManagedOrg = `${state.getRealm()}_organization`;\n  }\n  return realmManagedOrg;\n}\n\n/**\n * Get organizations\n * @returns {Promise} promise resolving to an object containing an array of organization objects\n */\nexport async function getOrganizations() {\n  const orgs = [];\n  let result = {\n    result: [],\n    resultCount: 0,\n    pagedResultsCookie: null,\n    totalPagedResultsPolicy: 'NONE',\n    totalPagedResults: -1,\n    remainingPagedResults: -1,\n  };\n  try {\n    do {\n      try {\n        // eslint-disable-next-line no-await-in-loop\n        result = await queryAllManagedObjectsByType(\n          getRealmManagedOrganization(),\n          ['name', 'parent/*/name', 'children/*/name'],\n          result.pagedResultsCookie\n        );\n      } catch (queryAllManagedObjectsByTypeError) {\n        printMessage(queryAllManagedObjectsByTypeError, 'error');\n        printMessage(\n          `Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`,\n          'error'\n        );\n      }\n      orgs.concat(result.result);\n      printMessage('.', 'text', false);\n    } while (result.pagedResultsCookie);\n  } catch (error) {\n    printMessage(error.response.data, 'error');\n    printMessage(`Error retrieving all organizations: ${error}`, 'error');\n  }\n  return orgs;\n}\n\n// unfinished work\nexport async function listOrganizationsTopDown() {\n  const orgs = [];\n  let result = {\n    result: [],\n    resultCount: 0,\n    pagedResultsCookie: null,\n    totalPagedResultsPolicy: 'NONE',\n    totalPagedResults: -1,\n    remainingPagedResults: -1,\n  };\n  do {\n    try {\n      // eslint-disable-next-line no-await-in-loop\n      result = await queryAllManagedObjectsByType(\n        getRealmManagedOrganization(),\n        ['name', 'parent/*/name', 'children/*/name'],\n        result.pagedResultsCookie\n      );\n    } catch (queryAllManagedObjectsByTypeError) {\n      printMessage(queryAllManagedObjectsByTypeError, 'error');\n      printMessage(\n        `Error querying ${getRealmManagedOrganization()} objects: ${queryAllManagedObjectsByTypeError}`,\n        'error'\n      );\n    }\n    orgs.concat(result.result);\n    printMessage('.', 'text', false);\n  } while (result.pagedResultsCookie);\n  return orgs;\n}\n"]}

package/types/ops/Saml2Ops.d.ts

@@ -1,60 +1,70 @@
+import { Saml2ProviderSkeleton, Saml2ProviderStub } from '../api/ApiTypes';
+import { MultiOpStatusInterface, Saml2ExportInterface } from './OpsTypes';
 export declare const roleMap: {
     identityProvider: string;
     serviceProvider: string;
     attributeQueryProvider: string;
     xacmlPolicyEnforcementPoint: string;
 };
+export declare function createSaml2ExportTemplate(): Saml2ExportInterface;
 /**
- * List entity providers
- * @param {boolean} long Long list format with details
+ * Get SAML2 entity provider stubs
+ * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs
  */
-export declare function listSaml2Providers(long?: boolean): Promise<void>;
+export declare function getSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
 /**
- * Export a single entity provider to file
- * @param {String} entityId Provider entity id
- * @param {String} file Optional filename
+ * 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 declare function exportSaml2ProviderToFile(entityId: any, file?: any): Promise<void>;
+export declare function getProviderByLocationAndId(location: string, entityId64: string): Promise<any>;
 /**
- * Export provider metadata to file
- * @param {String} entityId Provider entity id
- * @param {String} file Optional filename
+ * 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 declare function exportSaml2Metadata(entityId: any, file?: any): Promise<void>;
+export declare function getProviderMetadataUrl(entityId: string): string;
 /**
- * Describe an entity provider's configuration
- * @param {String} entityId Provider entity id
+ * 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 declare function describeSaml2Provider(entityId: any): Promise<void>;
+export declare function getProviderMetadata(entityId: any): Promise<any>;
 /**
- * Export all entity providers to one file
- * @param {String} file Optional filename
+ *
+ * @param {String} entityId Provider entity id
+ * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.
  */
-export declare function exportSaml2ProvidersToFile(file?: any): Promise<void>;
+export declare function getSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
 /**
- * Export all entity providers to individual files
+ * 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 declare function exportSaml2ProvidersToFiles(): Promise<void>;
+export declare function getSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
 /**
- * Import a SAML entity provider by entity id from file
+ * Export a single entity provider. The response can be saved to file as is.
  * @param {String} entityId Provider entity id
- * @param {String} file Import file name
+ * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-export declare function importSaml2ProviderFromFile(entityId: any, file: any): Promise<void>;
+export declare function exportSaml2Provider(entityId: string): Promise<Saml2ExportInterface>;
 /**
- * Import first SAML entity provider from file
- * @param {String} file Import file name
+ * Export all entity providers. The response can be saved to file as is.
+ * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.
  */
-export declare function importFirstSaml2ProviderFromFile(file: any): Promise<void>;
+export declare function exportSaml2Providers(): Promise<Saml2ExportInterface>;
 /**
- * Import all SAML entity providers from file
- * @param {String} file Import file name
+ * Import a SAML entity provider
+ * @param {string} entityId Provider entity id
+ * @param {Saml2ExportInterface} importData Import data
  */
-export declare function importSaml2ProvidersFromFile(file: any): Promise<void>;
+export declare function importSaml2Provider(entityId: string, importData: Saml2ExportInterface): Promise<void>;
 /**
- * Import all SAML entity providers from all *.saml.json files in the current directory
+ * Import SAML entity providers
+ * @param {Saml2ExportInterface} importData Import data
  */
-export declare function importSaml2ProvidersFromFiles(): Promise<void>;
+export declare function importSaml2Providers(importData: Saml2ExportInterface): Promise<MultiOpStatusInterface>;
 /**
  * Deletes entity provider
  * @param {string} entityId The entity id for the entity to be deleted
@@ -65,33 +75,20 @@ export declare function deleteSaml2Provider(entityId: string): Promise<void>;
  */
 export declare function deleteSaml2Providers(): Promise<void>;
 /**
- * Exports a RAW SAML entity, which means the raw xml is included.
- * @param {string} entityId Reference to the entity for export
- * @param {string} file Optional filename for the exported file
- */
-export declare function exportRawSaml2ProviderToFile(entityId: any, file?: any): Promise<void>;
-/**
- * Export all entity providers raw to one file
- * @param {String} file Optional filename
- */
-export declare function exportRawSaml2ProvidersToFile(file?: any): Promise<void>;
-/**
- * Export all entity providers to individual files
- */
-export declare function exportRawSaml2ProvidersToFiles(): Promise<void>;
-/**
- * Imports the RAW provider info from a single file.
- * @param file Import file name
+ * Retrieves all entity providers using the legacy federation enpoints.
+ * @returns {Promise} a promise that resolves to an object containing an array of providers
  */
-export declare function importRawSaml2ProvidersFromFile(file: string): Promise<void>;
+export declare function getRawProviders(): Promise<any>;
 /**
- * Whenever the SAML RAW file were exported using the exportRAW functionality this function
- * is used to read them back in. Only files with the .samlRaw.json extension will be imported.
- * @param {string} directory The directory from which to import the files
+ * 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 declare function importRawSaml2ProvidersFromFiles(directory: any): Promise<void>;
+export declare function getRawProvider(entityId: string): Promise<any>;
 /**
- * Imports a raw SAML export file (containing one entity).
- * @param {string} file The import file
+ * 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 declare function importRawSaml2ProviderFromFile(file: any): Promise<void>;
+export declare function putRawProvider(entityId: string, entityData: any): Promise<any>;

package/types/ops/Saml2Ops.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/Saml2Ops.ts"],"names":[],"mappings":"AAuCA,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC;AAeF;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,UAAQ,iBAsBpD;AAuCD;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,QAAQ,KAAA,EAAE,IAAI,MAAO,iBA2CpE;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,QAAQ,KAAA,EAAE,IAAI,MAAO,iBAoB9D;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,QAAQ,KAAA,iBA8CnD;AAED;;;GAGG;AACH,wBAAsB,0BAA0B,CAAC,IAAI,MAAO,iBAgC3D;AAED;;GAEG;AACH,wBAAsB,2BAA2B,kBAsBhD;AAgDD;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,QAAQ,KAAA,EAAE,IAAI,KAAA,iBAqC/D;AAED;;;GAGG;AACH,wBAAsB,gCAAgC,CAAC,IAAI,KAAA,iBA8C1D;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAAC,IAAI,KAAA,iBAoCtD;AAED;;GAEG;AACH,wBAAsB,6BAA6B,kBAoDlD;AAID;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,iBAMzD;AAED;;GAEG;AACH,wBAAsB,oBAAoB,kBAWzC;AAED;;;;GAIG;AACH,wBAAsB,4BAA4B,CAAC,QAAQ,KAAA,EAAE,IAAI,MAAO,iBAavE;AAED;;;GAGG;AACH,wBAAsB,6BAA6B,CAAC,IAAI,MAAO,iBAuB9D;AAED;;GAEG;AACH,wBAAsB,8BAA8B,kBA6BnD;AAED;;;GAGG;AACH,wBAAsB,+BAA+B,CAAC,IAAI,EAAE,MAAM,iBA6BjE;AAED;;;;GAIG;AACH,wBAAsB,gCAAgC,CAAC,SAAS,KAAA,iBAsC/D;AAED;;;GAGG;AACH,wBAAsB,8BAA8B,CAAC,IAAI,KAAA,iBAexD","file":"Saml2Ops.d.ts","sourcesContent":["import fs from 'fs';\nimport _ from 'lodash';\nimport path from 'path';\nimport {\n  createProvider,\n  deleteProvider,\n  findProviders,\n  getProviderByLocationAndId,\n  getProviderMetadata,\n  getProviderMetadataUrl,\n  getRawProvider,\n  getProviders,\n  getRawProviders,\n  putRawProvider,\n} from '../api/Saml2Api';\nimport { getScript } from '../api/ScriptApi';\nimport { decode, encode, encodeBase64Url } from '../api/utils/Base64';\nimport { createOrUpdateScript } from './ScriptOps';\nimport {\n  createObjectTable,\n  createProgressIndicator,\n  createTable,\n  printMessage,\n  stopProgressIndicator,\n  updateProgressIndicator,\n} from './utils/Console';\nimport {\n  convertBase64TextToArray,\n  convertBase64UrlTextToArray,\n  convertTextArrayToBase64,\n  convertTextArrayToBase64Url,\n  getRealmString,\n  getTypedFilename,\n  saveJsonToFile,\n  saveTextToFile,\n  saveToFile,\n  validateImport,\n} from './utils/ExportImportUtils';\n\nexport const roleMap = {\n  identityProvider: 'IDP',\n  serviceProvider: 'SP',\n  attributeQueryProvider: 'AttrQuery',\n  xacmlPolicyEnforcementPoint: 'XACML PEP',\n};\n\n// use a function vs a template variable to avoid problems in loops\nfunction getFileDataTemplate() {\n  return {\n    meta: {},\n    script: {},\n    saml: {\n      hosted: {},\n      remote: {},\n      metadata: {},\n    },\n  };\n}\n\n/**\n * List entity providers\n * @param {boolean} long Long list format with details\n */\nexport async function listSaml2Providers(long = false) {\n  const providerList = (await getProviders()).result;\n  providerList.sort((a, b) => a._id.localeCompare(b._id));\n  if (!long) {\n    for (const provider of providerList) {\n      printMessage(`${provider.entityId}`, 'data');\n    }\n  } else {\n    const table = createTable([\n      'Entity Id'['brightCyan'],\n      'Location'['brightCyan'],\n      'Role(s)'['brightCyan'],\n    ]);\n    for (const provider of providerList) {\n      table.push([\n        provider.entityId,\n        provider.location,\n        provider.roles.map((role) => roleMap[role]).join(', '),\n      ]);\n    }\n    printMessage(table.toString());\n  }\n}\n\n/**\n * Include dependencies in the export file\n * @param {Object} providerData Object representing a SAML entity provider\n * @param {Object} fileData File data object to add dependencies to\n */\nasync function exportDependencies(providerData, fileData) {\n  const attrMapperScriptId = _.get(providerData, [\n    'identityProvider',\n    'assertionProcessing',\n    'attributeMapper',\n    'attributeMapperScript',\n  ]);\n  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {\n    const scriptData = await getScript(attrMapperScriptId);\n    scriptData.script = convertBase64TextToArray(scriptData.script);\n    // eslint-disable-next-line no-param-reassign\n    fileData.script[attrMapperScriptId] = scriptData;\n  }\n  const idpAdapterScriptId = _.get(providerData, [\n    'identityProvider',\n    'advanced',\n    'idpAdapter',\n    'idpAdapterScript',\n  ]);\n  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {\n    const scriptData = await getScript(idpAdapterScriptId);\n    scriptData.script = convertBase64TextToArray(scriptData.script);\n    // eslint-disable-next-line no-param-reassign\n    fileData.script[idpAdapterScriptId] = scriptData;\n  }\n  const metaDataResponse = await getProviderMetadata(providerData.entityId);\n  // eslint-disable-next-line no-param-reassign\n  fileData.saml.metadata[providerData._id] = convertBase64UrlTextToArray(\n    encodeBase64Url(metaDataResponse)\n  );\n}\n\n/**\n * Export a single entity provider to file\n * @param {String} entityId Provider entity id\n * @param {String} file Optional filename\n */\nexport async function exportSaml2ProviderToFile(entityId, file = null) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(entityId, 'saml');\n  }\n  createProgressIndicator(1, `Exporting provider ${entityId}`);\n  try {\n    const found = await findProviders(`entityId eq '${entityId}'`, 'location');\n    switch (found.resultCount) {\n      case 0:\n        printMessage(`No provider with entity id '${entityId}' found`, 'error');\n        break;\n      case 1:\n        {\n          const { location } = found.result[0];\n          const id = found.result[0]._id;\n          try {\n            const response = await getProviderByLocationAndId(location, id);\n            const providerData = response;\n            updateProgressIndicator(`Writing file ${fileName}`);\n            const fileData = getFileDataTemplate();\n            fileData.saml[location][providerData._id] = providerData;\n            await exportDependencies(providerData, fileData);\n            saveJsonToFile(fileData, fileName);\n            stopProgressIndicator(\n              `Exported ${entityId.brightCyan} to ${fileName.brightCyan}.`\n            );\n          } catch (err) {\n            stopProgressIndicator(`${err}`);\n            printMessage(err, 'error');\n          }\n        }\n        break;\n      default:\n        printMessage(\n          `Multiple providers with entity id '${entityId}' found`,\n          'error'\n        );\n    }\n  } catch (error) {\n    stopProgressIndicator(`${error}`);\n    printMessage(error.message, 'error');\n  }\n}\n\n/**\n * Export provider metadata to file\n * @param {String} entityId Provider entity id\n * @param {String} file Optional filename\n */\nexport async function exportSaml2Metadata(entityId, file = null) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(entityId, 'metadata', 'xml');\n  }\n  createProgressIndicator(1, `Exporting metadata for: ${entityId}`);\n  getProviderMetadata(entityId)\n    .then(async (response) => {\n      updateProgressIndicator(`Writing file ${fileName}`);\n      // printMessage(response.data, 'error');\n      const metaData = response;\n      saveTextToFile(metaData, fileName);\n      stopProgressIndicator(\n        `Exported ${entityId.brightCyan} metadata to ${fileName.brightCyan}.`\n      );\n    })\n    .catch((err) => {\n      stopProgressIndicator(`${err}`);\n      printMessage(err, 'error');\n    });\n}\n\n/**\n * Describe an entity provider's configuration\n * @param {String} entityId Provider entity id\n */\nexport async function describeSaml2Provider(entityId) {\n  try {\n    const found = await findProviders(\n      `entityId eq '${entityId}'`,\n      'location,roles'\n    );\n    switch (found.resultCount) {\n      case 0:\n        printMessage(`No provider with entity id '${entityId}' found`, 'error');\n        break;\n      case 1:\n        {\n          try {\n            const { location } = found.result[0];\n            const id = found.result[0]._id;\n            const roles = found.result[0].roles\n              .map((role) => roleMap[role])\n              .join(', ');\n            const response = await getProviderByLocationAndId(location, id);\n            const rawProviderData = response;\n            delete rawProviderData._id;\n            delete rawProviderData._rev;\n            rawProviderData.location = location;\n            rawProviderData.roles = roles;\n            rawProviderData.metadataUrl = getProviderMetadataUrl(entityId);\n            // const fullProviderData = getFileDataTemplate();\n            // fullProviderData.saml[location][rawProviderData._id] =\n            //   rawProviderData;\n            // await exportDependencies(rawProviderData, fullProviderData);\n            // describe the provider\n            const table = createObjectTable(rawProviderData);\n            printMessage(table.toString());\n          } catch (err) {\n            printMessage(err, 'error');\n          }\n        }\n        break;\n      default:\n        printMessage(\n          `Multiple providers with entity id '${entityId}' found`,\n          'error'\n        );\n    }\n  } catch (error) {\n    printMessage(error.message, 'error');\n  }\n}\n\n/**\n * Export all entity providers to one file\n * @param {String} file Optional filename\n */\nexport async function exportSaml2ProvidersToFile(file = null) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(`all${getRealmString()}Providers`, 'saml');\n  }\n  try {\n    const fileData = getFileDataTemplate();\n    const found = await getProviders();\n    if (found.resultCount > 0) {\n      createProgressIndicator(found.resultCount, 'Exporting providers');\n      for (const stubData of found.result) {\n        updateProgressIndicator(`Exporting provider ${stubData.entityId}`);\n        // eslint-disable-next-line no-await-in-loop\n        const providerData = await getProviderByLocationAndId(\n          stubData.location,\n          stubData._id\n        );\n        // eslint-disable-next-line no-await-in-loop\n        await exportDependencies(providerData, fileData);\n        fileData.saml[stubData.location][providerData._id] = providerData;\n      }\n      saveJsonToFile(fileData, fileName);\n      stopProgressIndicator(\n        `${found.resultCount} providers exported to ${fileName}.`\n      );\n    } else {\n      printMessage('No entity providers found.', 'info');\n    }\n  } catch (error) {\n    printMessage(error.message, 'error');\n    printMessage(`exportProvidersToFile: ${error.response?.status}`, 'error');\n  }\n}\n\n/**\n * Export all entity providers to individual files\n */\nexport async function exportSaml2ProvidersToFiles() {\n  const found = await getProviders();\n  if (found.resultCount > 0) {\n    createProgressIndicator(found.resultCount, 'Exporting providers');\n    for (const stubData of found.result) {\n      updateProgressIndicator(`Exporting provider ${stubData.entityId}`);\n      const fileName = getTypedFilename(stubData.entityId, 'saml');\n      const fileData = getFileDataTemplate();\n      // eslint-disable-next-line no-await-in-loop\n      const providerData = await getProviderByLocationAndId(\n        stubData.location,\n        stubData._id\n      );\n      // eslint-disable-next-line no-await-in-loop\n      await exportDependencies(providerData, fileData);\n      fileData.saml[stubData.location][providerData._id] = providerData;\n      saveJsonToFile(fileData, fileName);\n    }\n    stopProgressIndicator(`${found.resultCount} providers exported.`);\n  } else {\n    printMessage('No entity providers found.', 'info');\n  }\n}\n\n/**\n * Include dependencies from the import file\n * @param {Object} providerData Object representing a SAML entity provider\n * @param {Object} fileData File data object to read dependencies from\n */\nasync function importDependencies(providerData, fileData) {\n  const attrMapperScriptId = _.get(providerData, [\n    'identityProvider',\n    'assertionProcessing',\n    'attributeMapper',\n    'attributeMapperScript',\n  ]);\n  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {\n    const scriptData = _.get(fileData, ['script', attrMapperScriptId]);\n    scriptData.script = convertTextArrayToBase64(scriptData.script);\n    await createOrUpdateScript(attrMapperScriptId, scriptData);\n  }\n  const idpAdapterScriptId = _.get(providerData, [\n    'identityProvider',\n    'advanced',\n    'idpAdapter',\n    'idpAdapterScript',\n  ]);\n  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {\n    const scriptData = _.get(fileData, ['script', idpAdapterScriptId]);\n    scriptData.script = convertTextArrayToBase64(scriptData.script);\n    await createOrUpdateScript(attrMapperScriptId, scriptData);\n  }\n}\n\n/**\n * Find provider in import file and return its location\n * @param {String} entityId64 Base64-encoded provider entity id\n * @param {Object} fileData Import file json data\n * @returns {String} 'hosted' or 'remote' if found, undefined otherwise\n */\nfunction getLocation(entityId64, fileData) {\n  if (_.get(fileData, ['saml', 'hosted', entityId64])) {\n    return 'hosted';\n  }\n  if (_.get(fileData, ['saml', 'remote', entityId64])) {\n    return 'remote';\n  }\n  return undefined;\n}\n\n/**\n * Import a SAML entity provider by entity id from file\n * @param {String} entityId Provider entity id\n * @param {String} file Import file name\n */\nexport async function importSaml2ProviderFromFile(entityId, file) {\n  const entityId64 = encode(entityId, false);\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      createProgressIndicator(1, 'Importing provider...');\n      const location = getLocation(entityId64, fileData);\n      if (location) {\n        const providerData = _.get(fileData, ['saml', location, entityId64]);\n        updateProgressIndicator(`Importing ${entityId}`);\n        await importDependencies(providerData, fileData);\n        let metaData = null;\n        if (location === 'remote') {\n          metaData = convertTextArrayToBase64Url(\n            fileData.saml.metadata[entityId64]\n          );\n        }\n        createProvider(location, providerData, metaData)\n          .then(() => {\n            stopProgressIndicator(\n              `Successfully imported provider ${entityId}.`\n            );\n          })\n          .catch((createProviderErr) => {\n            printMessage(`\\nError importing provider ${entityId}`, 'error');\n            printMessage(createProviderErr.response, 'error');\n          });\n      } else {\n        stopProgressIndicator(\n          `Provider ${entityId.brightCyan} not found in ${file.brightCyan}!`\n        );\n      }\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Import first SAML entity provider from file\n * @param {String} file Import file name\n */\nexport async function importFirstSaml2ProviderFromFile(file) {\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      createProgressIndicator(1, 'Importing provider...');\n      // find providers in hosted and if none exist in remote\n      let location = 'hosted';\n      let providerIds = _.keys(fileData.saml[location]);\n      if (providerIds.length === 0) {\n        location = 'remote';\n        providerIds = _.keys(fileData.saml[location]);\n        if (providerIds.length === 0) {\n          location = null;\n        }\n      }\n      if (location) {\n        const entityId64 = providerIds[0];\n        const entityId = decode(entityId64);\n        const providerData = _.get(fileData, ['saml', location, entityId64]);\n        updateProgressIndicator(`Importing ${entityId}`);\n        await importDependencies(providerData, fileData);\n        let metaData = null;\n        if (location === 'remote') {\n          metaData = convertTextArrayToBase64Url(\n            fileData.saml.metadata[entityId64]\n          );\n        }\n        createProvider(location, providerData, metaData)\n          .then(() => {\n            stopProgressIndicator(\n              `Successfully imported provider ${entityId}.`\n            );\n          })\n          .catch((createProviderErr) => {\n            stopProgressIndicator(`Error importing provider ${entityId}`);\n            printMessage(`\\nError importing provider ${entityId}`, 'error');\n            printMessage(createProviderErr.response.data, 'error');\n          });\n      } else {\n        stopProgressIndicator(`No providers found in ${file.brightCyan}!`);\n      }\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Import all SAML entity providers from file\n * @param {String} file Import file name\n */\nexport async function importSaml2ProvidersFromFile(file) {\n  fs.readFile(file, 'utf8', async (err, data) => {\n    if (err) throw err;\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      // find providers in hosted and in remote and map locations\n      const hostedIds = _.keys(fileData.saml.hosted);\n      const remoteIds = _.keys(fileData.saml.remote);\n      const providerIds = hostedIds.concat(remoteIds);\n      createProgressIndicator(providerIds.length, 'Importing providers...');\n      for (const entityId64 of providerIds) {\n        const location = hostedIds.includes(entityId64) ? 'hosted' : 'remote';\n        const entityId = decode(entityId64);\n        const providerData = _.get(fileData, ['saml', location, entityId64]);\n        // eslint-disable-next-line no-await-in-loop\n        await importDependencies(providerData, fileData);\n        let metaData = null;\n        if (location === 'remote') {\n          metaData = convertTextArrayToBase64Url(\n            fileData.saml.metadata[entityId64]\n          );\n        }\n        try {\n          // eslint-disable-next-line no-await-in-loop\n          await createProvider(location, providerData, metaData);\n          updateProgressIndicator(`Imported ${entityId}`);\n        } catch (createProviderErr) {\n          printMessage(`\\nError importing provider ${entityId}`, 'error');\n          printMessage(createProviderErr.response.data, 'error');\n        }\n      }\n      stopProgressIndicator(`Providers imported.`);\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Import all SAML entity providers from all *.saml.json files in the current directory\n */\nexport async function importSaml2ProvidersFromFiles() {\n  const names = fs.readdirSync('.');\n  const jsonFiles = names.filter((name) =>\n    name.toLowerCase().endsWith('.saml.json')\n  );\n  createProgressIndicator(jsonFiles.length, 'Importing providers...');\n  let total = 0;\n  let totalErrors = 0;\n  for (const file of jsonFiles) {\n    const data = fs.readFileSync(file, 'utf8');\n    const fileData = JSON.parse(data);\n    if (validateImport(fileData.meta)) {\n      // find providers in hosted and in remote and map locations\n      const hostedIds = _.keys(fileData.saml.hosted);\n      const remoteIds = _.keys(fileData.saml.remote);\n      const providerIds = hostedIds.concat(remoteIds);\n      total += providerIds.length;\n      let errors = 0;\n      for (const entityId64 of providerIds) {\n        const location = hostedIds.includes(entityId64) ? 'hosted' : 'remote';\n        const entityId = decode(entityId64);\n        const providerData = _.get(fileData, ['saml', location, entityId64]);\n        importDependencies(providerData, fileData);\n        let metaData = null;\n        if (location === 'remote') {\n          metaData = convertTextArrayToBase64Url(\n            fileData.saml.metadata[entityId64]\n          );\n        }\n        try {\n          // eslint-disable-next-line no-await-in-loop\n          await createProvider(location, providerData, metaData);\n          // updateProgressIndicator(`Imported ${entityId}`);\n        } catch (createProviderErr) {\n          errors += 1;\n          printMessage(`\\nError importing provider ${entityId}`, 'error');\n          printMessage(createProviderErr.response.data, 'error');\n        }\n      }\n      totalErrors += errors;\n      updateProgressIndicator(\n        `Imported ${providerIds.length - errors} provider(s) from ${file}`\n      );\n    } else {\n      printMessage(`Validation of ${file} failed!`, 'error');\n    }\n  }\n  stopProgressIndicator(\n    `Imported ${total - totalErrors} of ${total} provider(s) from ${\n      jsonFiles.length\n    } file(s).`\n  );\n}\n\n// Contributions using legacy APIs. Need to investigate if those will be deprecated in the future\n\n/**\n * Deletes entity provider\n * @param {string} entityId The entity id for the entity to be deleted\n */\nexport async function deleteSaml2Provider(entityId: string) {\n  try {\n    await deleteProvider(entityId);\n  } catch (error) {\n    printMessage(error.message, 'error');\n  }\n}\n\n/**\n * Deletes all entity providers.\n */\nexport async function deleteSaml2Providers() {\n  const applicationList = (await getRawProviders()).result;\n  const deleteApplicationPromises = [];\n  applicationList.forEach((item) => {\n    printMessage(`Deleting Application ${item._id}`, 'error');\n    deleteApplicationPromises.push(deleteSaml2Provider(item._id));\n  });\n  const deleteApplicationResult = await Promise.all(deleteApplicationPromises);\n  if (deleteApplicationResult.length == applicationList.length) {\n    printMessage('SAML Entity cleanup done', 'info');\n  }\n}\n\n/**\n * Exports a RAW SAML entity, which means the raw xml is included.\n * @param {string} entityId Reference to the entity for export\n * @param {string} file Optional filename for the exported file\n */\nexport async function exportRawSaml2ProviderToFile(entityId, file = null) {\n  printMessage(`Exporting SAML application ${entityId}`, 'info');\n  let fileName = entityId;\n  if (file) {\n    fileName = file;\n  }\n  createProgressIndicator(1, `Exporting raw entity: ${entityId}`);\n  await getRawProvider(entityId).then(async (response) => {\n    updateProgressIndicator(`Writing file ${fileName}`);\n    const rawData = response;\n    saveTextToFile(JSON.stringify(rawData, null, 2), fileName);\n    stopProgressIndicator(`Exported ${entityId} metadata to ${fileName}.`);\n  });\n}\n\n/**\n * Export all entity providers raw to one file\n * @param {String} file Optional filename\n */\nexport async function exportRawSaml2ProvidersToFile(file = null) {\n  let fileName = file;\n  if (!fileName) {\n    fileName = getTypedFilename(\n      `all${getRealmString()}ProvidersRaw`,\n      'samlRaw'\n    );\n  }\n  try {\n    const samlApplicationList = (await getRawProviders()).result;\n\n    saveToFile('application', samlApplicationList, '_id', fileName);\n    printMessage(\n      `All RAW saml entity providers exported to: ${fileName}`,\n      'info'\n    );\n  } catch (error) {\n    printMessage(error.message, 'error');\n    printMessage(\n      `exportProvidersRawToFile: ${error.response?.status}`,\n      'error'\n    );\n  }\n}\n\n/**\n * Export all entity providers to individual files\n */\nexport async function exportRawSaml2ProvidersToFiles() {\n  const samlApplicationList = (await getRawProviders()).result;\n  let hasError = false;\n  createProgressIndicator(\n    samlApplicationList.length,\n    'Exporting RAW providers'\n  );\n  let exportedAmount = 0;\n  for (const item of samlApplicationList) {\n    updateProgressIndicator(`Exporting provider ${item.entityId}`);\n    try {\n      const samlApplicationData = await getRawProvider(item._id);\n      const fileName = getTypedFilename(\n        `${item._id}${getRealmString()}ProviderRaw`,\n        'samlRaw'\n      );\n      saveToFile('application', [samlApplicationData], '_id', fileName);\n      exportedAmount++;\n    } catch (error) {\n      hasError = true;\n      printMessage(`Unable to export:  ${item._id}`, 'error');\n    }\n  }\n  stopProgressIndicator(`${exportedAmount} providers exported.`);\n  if (!hasError) {\n    printMessage('All entities exported.', 'info');\n  } else {\n    printMessage('All other entities exported.', 'info');\n  }\n}\n\n/**\n * Imports the RAW provider info from a single file.\n * @param file Import file name\n */\nexport async function importRawSaml2ProvidersFromFile(file: string) {\n  fs.readFile(file, 'utf8', async function (err, data) {\n    if (err) throw err;\n    const samlEntityData = JSON.parse(data);\n    let amountOfEntities = 0;\n    for (const id in samlEntityData.application) {\n      if (id.length) {\n        amountOfEntities++;\n      }\n    }\n    if (validateImport(samlEntityData.meta)) {\n      createProgressIndicator(amountOfEntities, 'Importing providers...');\n      for (const id in samlEntityData.application) {\n        // remove the \"_rev\" data before PUT\n        delete samlEntityData.application[id]._rev;\n        await putRawProvider(id, samlEntityData.application[id]).then(\n          (result) => {\n            if (result === null) {\n              printMessage(`Import validation failed for ${id}`, 'error');\n            }\n          }\n        );\n        updateProgressIndicator(`Imported ${id}...`);\n      }\n      stopProgressIndicator(`Import done`);\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n\n/**\n * Whenever the SAML RAW file were exported using the exportRAW functionality this function\n * is used to read them back in. Only files with the .samlRaw.json extension will be imported.\n * @param {string} directory The directory from which to import the files\n */\nexport async function importRawSaml2ProvidersFromFiles(directory) {\n  const files = fs.readdirSync(directory);\n  const filesToImport = files.filter(\n    (file) => file.indexOf('.samlRaw.json') > -1\n  );\n\n  if (filesToImport.length > 0) {\n    createProgressIndicator(filesToImport.length, 'Importing providers...');\n    filesToImport.forEach(async (file) => {\n      const filePathAbsolute = path.join(directory, file);\n      filesToImport.push(file);\n      const samlEntityData = JSON.parse(\n        fs.readFileSync(filePathAbsolute, 'utf8')\n      );\n      if (validateImport(samlEntityData.meta)) {\n        for (const id in samlEntityData.application) {\n          // remove the \"_rev\" data before PUT\n          delete samlEntityData.application[id]._rev;\n          await putRawProvider(id, samlEntityData.application[id]).then(\n            (result) => {\n              if (result === null) {\n                printMessage(`Import validation failed for ${id}`, 'error');\n              }\n            }\n          );\n          updateProgressIndicator(`Imported ${id}...`);\n        }\n      } else {\n        printMessage('Import validation failed...', 'error');\n      }\n    });\n    stopProgressIndicator(`Import done`);\n  } else {\n    printMessage(\n      'Import failed, no files to import. (check extension to be .samlRaw.json)',\n      'warn'\n    );\n  }\n}\n\n/**\n * Imports a raw SAML export file (containing one entity).\n * @param {string} file The import file\n */\nexport async function importRawSaml2ProviderFromFile(file) {\n  printMessage(`Importing SAML Entity ${file}...`, 'info');\n  if (file.indexOf('.samlRaw.json') > -1) {\n    const samlEntityData = JSON.parse(fs.readFileSync(file, 'utf8'));\n    if (validateImport(samlEntityData.meta)) {\n      for (const id in samlEntityData.application) {\n        // remove the \"_rev\" data before PUT\n        delete samlEntityData.application[id]._rev;\n        const result = await putRawProvider(id, samlEntityData.application[id]);\n        printMessage(`Imported ${id}`, 'info');\n      }\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  }\n}\n"]}
+{"version":3,"sources":["../src/ops/Saml2Ops.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,iBAAiB,CAAC;AAoBzB,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAgB1E,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC;AAGF,wBAAgB,yBAAyB,IAAI,oBAAoB,CAUhE;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAG1E;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAC9C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,gBAGnB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,QAAQ,KAAA,gBAEjD;AAuCD;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,iBAAiB,CAAC,CAa5B;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,qBAAqB,CAAC,CAQhC;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC,CAW/B;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAY1E;AA2DD;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAkBf;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,sBAAsB,CAAC,CA0DjC;AAID;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,iBAMzD;AAED;;GAEG;AACH,wBAAsB,oBAAoB,kBAWzC;AAED;;;GAGG;AACH,wBAAsB,eAAe,iBAEpC;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,gBAEpD;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,KAAA,gBAEhE","file":"Saml2Ops.d.ts","sourcesContent":["import _ from 'lodash';\nimport {\n  Saml2ProiderLocation,\n  Saml2ProviderSkeleton,\n  Saml2ProviderStub,\n} from '../api/ApiTypes';\nimport {\n  createProvider,\n  deleteProvider,\n  findProviders,\n  getProviderByLocationAndId as _getProviderByLocationAndId,\n  getProviderMetadata as _getProviderMetadata,\n  getProviderMetadataUrl as _getProviderMetadataUrl,\n  getRawProvider as _getRawProvider,\n  getProviders,\n  getRawProviders as _getRawProviders,\n  putRawProvider as _putRawProvider,\n} from '../api/Saml2Api';\nimport { getScript } from '../api/ScriptApi';\nimport {\n  decode,\n  decodeBase64Url,\n  encode,\n  encodeBase64Url,\n} from '../api/utils/Base64';\nimport { MultiOpStatusInterface, Saml2ExportInterface } from './OpsTypes';\nimport { createOrUpdateScript } from './ScriptOps';\nimport {\n  createProgressIndicator,\n  debugMessage,\n  printMessage,\n  stopProgressIndicator,\n  updateProgressIndicator,\n} from './utils/Console';\nimport {\n  convertBase64TextToArray,\n  convertBase64UrlTextToArray,\n  convertTextArrayToBase64,\n  convertTextArrayToBase64Url,\n} from './utils/ExportImportUtils';\n\nexport const roleMap = {\n  identityProvider: 'IDP',\n  serviceProvider: 'SP',\n  attributeQueryProvider: 'AttrQuery',\n  xacmlPolicyEnforcementPoint: 'XACML PEP',\n};\n\n// use a function vs a template variable to avoid problems in loops\nexport function createSaml2ExportTemplate(): Saml2ExportInterface {\n  return {\n    meta: {},\n    script: {},\n    saml: {\n      hosted: {},\n      remote: {},\n      metadata: {},\n    },\n  } as Saml2ExportInterface;\n}\n\n/**\n * Get SAML2 entity provider stubs\n * @returns {Promise<Saml2ProviderStub[]>} a promise that resolves to an array of saml2 entity stubs\n */\nexport async function getSaml2ProviderStubs(): Promise<Saml2ProviderStub[]> {\n  const { result } = await getProviders();\n  return result;\n}\n\n/**\n * Geta SAML2 entity provider by location and id\n * @param {string} location Entity provider location (hosted or remote)\n * @param {string} entityId64 Base64-encoded provider entity id\n * @returns {Promise} a promise that resolves to a saml2 entity provider object\n */\nexport async function getProviderByLocationAndId(\n  location: string,\n  entityId64: string\n) {\n  return _getProviderByLocationAndId(location, entityId64);\n}\n\n/**\n * Get a SAML2 entity provider's metadata URL by entity id\n * @param {string} entityId SAML2 entity id\n * @returns {string} the URL to get the metadata from\n */\nexport function getProviderMetadataUrl(entityId: string): string {\n  return _getProviderMetadataUrl(entityId);\n}\n\n/**\n * Get a SAML2 entity provider's metadata by entity id\n * @param {String} entityId SAML2 entity id\n * @returns {Promise} a promise that resolves to an object containing a SAML2 metadata\n */\nexport async function getProviderMetadata(entityId) {\n  return _getProviderMetadata(entityId);\n}\n\n/**\n * Include dependencies in the export file\n * @param {Object} providerData Object representing a SAML entity provider\n * @param {Object} fileData File data object to add dependencies to\n */\nasync function exportDependencies(providerData, fileData) {\n  const attrMapperScriptId = _.get(providerData, [\n    'identityProvider',\n    'assertionProcessing',\n    'attributeMapper',\n    'attributeMapperScript',\n  ]);\n  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {\n    const scriptData = await getScript(attrMapperScriptId);\n    scriptData.script = convertBase64TextToArray(scriptData.script);\n    // eslint-disable-next-line no-param-reassign\n    fileData.script[attrMapperScriptId] = scriptData;\n  }\n  const idpAdapterScriptId = _.get(providerData, [\n    'identityProvider',\n    'advanced',\n    'idpAdapter',\n    'idpAdapterScript',\n  ]);\n  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {\n    const scriptData = await getScript(idpAdapterScriptId);\n    scriptData.script = convertBase64TextToArray(scriptData.script);\n    // eslint-disable-next-line no-param-reassign\n    fileData.script[idpAdapterScriptId] = scriptData;\n  }\n  const metaDataResponse = await getProviderMetadata(providerData.entityId);\n  // eslint-disable-next-line no-param-reassign\n  fileData.saml.metadata[providerData._id] = convertBase64UrlTextToArray(\n    encodeBase64Url(metaDataResponse)\n  );\n}\n\n/**\n *\n * @param {String} entityId Provider entity id\n * @returns {Promise<Saml2ProviderStub>} Promise resolving to a Saml2ExportInterface object.\n */\nexport async function getSaml2ProviderStub(\n  entityId: string\n): Promise<Saml2ProviderStub> {\n  debugMessage(`Saml2Ops.getSaml2ProviderStub: start [entityId=${entityId}]`);\n  const found = await findProviders(`entityId eq '${entityId}'`);\n  switch (found.resultCount) {\n    case 0:\n      throw new Error(`No provider with entity id '${entityId}' found`);\n    case 1: {\n      debugMessage(`Saml2Ops.getSaml2ProviderStub: end [entityId=${entityId}]`);\n      return found.result[0];\n    }\n    default:\n      throw new Error(`Multiple providers with entity id '${entityId}' found`);\n  }\n}\n\n/**\n * Export a single entity provider. The response can be saved to file as is.\n * @param {String} entityId Provider entity id\n * @returns {Promise<Saml2ProviderSkeleton>} Promise resolving to a Saml2ExportInterface object.\n */\nexport async function getSaml2Provider(\n  entityId: string\n): Promise<Saml2ProviderSkeleton> {\n  debugMessage(`Saml2Ops.getSaml2Provider: start [entityId=${entityId}]`);\n  const stub = await getSaml2ProviderStub(entityId);\n  const { location } = stub;\n  const id = stub._id;\n  const providerData = await getProviderByLocationAndId(location, id);\n  debugMessage(`Saml2Ops.getSaml2Provider: end [entityId=${entityId}]`);\n  return providerData;\n}\n\n/**\n * Export a single entity provider. The response can be saved to file as is.\n * @param {String} entityId Provider entity id\n * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.\n */\nexport async function exportSaml2Provider(\n  entityId: string\n): Promise<Saml2ExportInterface> {\n  debugMessage(`Saml2Ops.exportSaml2Provider: start [entityId=${entityId}]`);\n  const exportData = createSaml2ExportTemplate();\n  const stub = await getSaml2ProviderStub(entityId);\n  const { location } = stub;\n  const id = stub._id;\n  const providerData = await getProviderByLocationAndId(location, id);\n  exportData.saml[stub.location][providerData._id] = providerData;\n  await exportDependencies(providerData, exportData);\n  debugMessage(`Saml2Ops.exportSaml2Provider: end [entityId=${entityId}]`);\n  return exportData;\n}\n\n/**\n * Export all entity providers. The response can be saved to file as is.\n * @returns {Promise<Saml2ExportInterface>} Promise resolving to a Saml2ExportInterface object.\n */\nexport async function exportSaml2Providers(): Promise<Saml2ExportInterface> {\n  const fileData = createSaml2ExportTemplate();\n  const stubs = await getSaml2ProviderStubs();\n  for (const stub of stubs) {\n    const providerData = await getProviderByLocationAndId(\n      stub.location,\n      stub._id\n    );\n    await exportDependencies(providerData, fileData);\n    fileData.saml[stub.location][providerData._id] = providerData;\n  }\n  return fileData;\n}\n\n/**\n * Include dependencies from the import file\n * @param {Object} providerData Object representing a SAML entity provider\n * @param {Object} fileData File data object to read dependencies from\n */\nasync function importDependencies(providerData, fileData) {\n  debugMessage(`Saml2Ops.importDependencies: start`);\n  const attrMapperScriptId = _.get(providerData, [\n    'identityProvider',\n    'assertionProcessing',\n    'attributeMapper',\n    'attributeMapperScript',\n  ]);\n  if (attrMapperScriptId && attrMapperScriptId !== '[Empty]') {\n    debugMessage(\n      `Saml2Ops.importDependencies: attributeMapperScript=${attrMapperScriptId}`\n    );\n    const scriptData = _.get(fileData, ['script', attrMapperScriptId]);\n    scriptData.script = convertTextArrayToBase64(scriptData.script);\n    await createOrUpdateScript(attrMapperScriptId, scriptData);\n  }\n  const idpAdapterScriptId = _.get(providerData, [\n    'identityProvider',\n    'advanced',\n    'idpAdapter',\n    'idpAdapterScript',\n  ]);\n  if (idpAdapterScriptId && idpAdapterScriptId !== '[Empty]') {\n    debugMessage(\n      `Saml2Ops.importDependencies: idpAdapterScript=${idpAdapterScriptId}`\n    );\n    const scriptData = _.get(fileData, ['script', idpAdapterScriptId]);\n    scriptData.script = convertTextArrayToBase64(scriptData.script);\n    await createOrUpdateScript(idpAdapterScriptId, scriptData);\n  }\n  debugMessage(`Saml2Ops.importDependencies: end`);\n}\n\n/**\n * Find provider in import file and return its location\n * @param {String} entityId64 Base64-encoded provider entity id\n * @param {Object} data Import file json data\n * @returns {String} 'hosted' or 'remote' if found, undefined otherwise\n */\nfunction getLocation(\n  entityId64: string,\n  data: Saml2ExportInterface\n): Saml2ProiderLocation {\n  if (data.saml.hosted[entityId64]) {\n    return Saml2ProiderLocation.HOSTED;\n  }\n  if (data.saml.remote[entityId64]) {\n    return Saml2ProiderLocation.REMOTE;\n  }\n  return undefined;\n}\n\n/**\n * Import a SAML entity provider\n * @param {string} entityId Provider entity id\n * @param {Saml2ExportInterface} importData Import data\n */\nexport async function importSaml2Provider(\n  entityId: string,\n  importData: Saml2ExportInterface\n): Promise<void> {\n  debugMessage(`Saml2Ops.importSaml2Provider: start`);\n  const entityId64 = encode(entityId, false);\n  const location = getLocation(entityId64, importData);\n  if (location) {\n    const providerData = importData.saml[location][entityId64];\n    await importDependencies(providerData, importData);\n    let metaData = null;\n    if (location === Saml2ProiderLocation.REMOTE) {\n      metaData = convertTextArrayToBase64Url(\n        importData.saml.metadata[entityId64]\n      );\n    }\n    await createProvider(location, providerData, metaData);\n  } else {\n    throw new Error(`Provider ${entityId} not found in import data!`);\n  }\n  debugMessage(`Saml2Ops.importSaml2Provider: end`);\n}\n\n/**\n * Import SAML entity providers\n * @param {Saml2ExportInterface} importData Import data\n */\nexport async function importSaml2Providers(\n  importData: Saml2ExportInterface\n): Promise<MultiOpStatusInterface> {\n  debugMessage(`Saml2Ops.importSaml2Providers: start`);\n  const myStatus: MultiOpStatusInterface = {\n    total: 0,\n    successes: 0,\n    warnings: 0,\n    failures: 0,\n  };\n  try {\n    // find providers in hosted and in remote and map locations\n    const hostedIds = Object.keys(importData.saml.hosted);\n    const remoteIds = Object.keys(importData.saml.remote);\n    const providerIds = hostedIds.concat(remoteIds);\n    myStatus.total = providerIds.length;\n    createProgressIndicator(providerIds.length, 'Importing providers...');\n    for (const entityId64 of providerIds) {\n      debugMessage(\n        `Saml2Ops.importSaml2Providers: entityId=${decodeBase64Url(entityId64)}`\n      );\n      const location = hostedIds.includes(entityId64)\n        ? Saml2ProiderLocation.HOSTED\n        : Saml2ProiderLocation.REMOTE;\n      const entityId = decode(entityId64);\n      const providerData = importData.saml[location][entityId64];\n      try {\n        await importDependencies(providerData, importData);\n      } catch (importDependenciesErr) {\n        myStatus.warnings += 1;\n        printMessage(\n          `\\nWarning importing dependencies for ${entityId}`,\n          'warn'\n        );\n        printMessage(importDependenciesErr.response.data, 'error');\n      }\n      let metaData = null;\n      if (location === Saml2ProiderLocation.REMOTE) {\n        metaData = convertTextArrayToBase64Url(\n          importData.saml.metadata[entityId64]\n        );\n      }\n      try {\n        await createProvider(location, providerData, metaData);\n        myStatus.successes += 1;\n        updateProgressIndicator(`Imported ${entityId}`);\n      } catch (createProviderErr) {\n        myStatus.failures += 1;\n        printMessage(`\\nError importing provider ${entityId}`, 'error');\n        printMessage(createProviderErr, 'error');\n      }\n    }\n    myStatus.message = `${myStatus.successes}/${myStatus.total} providers imported.`;\n    stopProgressIndicator(myStatus.message);\n  } catch (error) {\n    myStatus.failures += 1;\n    printMessage(`\\nError importing providers ${error.message}`, 'error');\n  }\n  debugMessage(`Saml2Ops.importSaml2Providers: end`);\n  return myStatus;\n}\n\n// Contributions using legacy APIs. Need to investigate if those will be deprecated in the future\n\n/**\n * Deletes entity provider\n * @param {string} entityId The entity id for the entity to be deleted\n */\nexport async function deleteSaml2Provider(entityId: string) {\n  try {\n    await deleteProvider(entityId);\n  } catch (error) {\n    printMessage(error.message, 'error');\n  }\n}\n\n/**\n * Deletes all entity providers.\n */\nexport async function deleteSaml2Providers() {\n  const applicationList = (await getRawProviders()).result;\n  const deleteApplicationPromises = [];\n  applicationList.forEach((item) => {\n    printMessage(`Deleting Application ${item._id}`, 'error');\n    deleteApplicationPromises.push(deleteSaml2Provider(item._id));\n  });\n  const deleteApplicationResult = await Promise.all(deleteApplicationPromises);\n  if (deleteApplicationResult.length == applicationList.length) {\n    printMessage('SAML Entity cleanup done', 'info');\n  }\n}\n\n/**\n * Retrieves all entity providers using the legacy federation enpoints.\n * @returns {Promise} a promise that resolves to an object containing an array of providers\n */\nexport async function getRawProviders() {\n  return _getRawProviders();\n}\n\n/**\n * Retrieves all entity providers using the legacy federation enpoints.\n * @param {string} entityId The entity provider id\n * @returns {Promise} a promise that resolves to an object containing an array of providers\n */\nexport async function getRawProvider(entityId: string) {\n  return _getRawProvider(entityId);\n}\n\n/**\n * Stores a new SAML2 entity provider\n * @param {string} entityId The entity provider id\n * @param {string} entityData The actual data containing the entity provider configuration\n * @returns {Promise} Promise that resolves to a provider object\n */\nexport async function putRawProvider(entityId: string, entityData) {\n  return _putRawProvider(entityId, entityData);\n}\n"]}

package/types/ops/ScriptOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/ScriptOps.ts"],"names":[],"mappings":"AAsBA;;GAEG;AACH,wBAAsB,WAAW,CAAC,IAAI,UAAQ,iBA+B7C;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,iBAelD;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,KAAA,iBAwB7C;AAED;;GAEG;AACH,wBAAsB,oBAAoB,kBAgBzC;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EAAE,KAAA,EAAE,IAAI,KAAA;;;GAwBlD;AAED,wBAAsB,qBAAqB,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,MAAM,UAAQ,iBAiDrE","file":"ScriptOps.d.ts","sourcesContent":["import fs from 'fs';\nimport { v4 as uuidv4 } from 'uuid';\nimport { applyNameCollisionPolicy } from './utils/OpsUtils';\nimport {\n  createProgressIndicator,\n  createTable,\n  printMessage,\n  stopProgressIndicator,\n  updateProgressIndicator,\n} from './utils/Console';\nimport { getScriptByName, getScripts, putScript } from '../api/ScriptApi';\nimport wordwrap from './utils/Wordwrap';\nimport {\n  convertBase64TextToArray,\n  convertTextArrayToBase64,\n  getTypedFilename,\n  saveToFile,\n  titleCase,\n  validateImport,\n} from './utils/ExportImportUtils';\nimport storage from '../storage/SessionStorage';\n\n/**\n * List scripts\n */\nexport async function listScripts(long = false) {\n  try {\n    const scripts = (await getScripts()).result;\n    scripts.sort((a, b) => a.name.localeCompare(b.name));\n    if (long) {\n      const table = createTable([\n        'Name',\n        'UUID',\n        'Language',\n        'Context',\n        'Description',\n      ]);\n      const langMap = { JAVASCRIPT: 'JS', GROOVY: 'Groovy' };\n      scripts.forEach((script) => {\n        table.push([\n          wordwrap(script.name, 25, '  '),\n          script._id,\n          langMap[script.language],\n          wordwrap(titleCase(script.context.split('_').join(' ')), 25),\n          wordwrap(script.description, 30),\n        ]);\n      });\n      printMessage(table.toString(), 'data');\n    } else {\n      scripts.forEach((script) => {\n        printMessage(`${script.name}`, 'data');\n      });\n    }\n  } catch (error) {\n    printMessage(`Error listing scripts - ${error}`, 'error');\n  }\n}\n\n/**\n * Export script to file\n * @param {String} name script name\n * @param {String} file file name\n */\nexport async function exportScriptByName(name, file) {\n  let fileName = getTypedFilename(name, 'script');\n  if (file) {\n    fileName = file;\n  }\n  const scriptData = (await getScriptByName(name)).result;\n  if (scriptData.length > 1) {\n    printMessage(`Multiple scripts with name ${name} found...`, 'error');\n  }\n  scriptData.forEach((element) => {\n    const scriptTextArray = convertBase64TextToArray(element.script);\n    // eslint-disable-next-line no-param-reassign\n    element.script = scriptTextArray;\n  });\n  saveToFile('script', scriptData, '_id', fileName);\n}\n\n/**\n * Export all scripts to single file\n * @param {String} file file name\n */\nexport async function exportScriptsToFile(file) {\n  let fileName = getTypedFilename(\n    `all${storage.session.getRealm()}Scripts`,\n    'script'\n  );\n  if (file) {\n    fileName = file;\n  }\n  const scriptList = (await getScripts()).result;\n  const allScriptsData = [];\n  createProgressIndicator(scriptList.length, 'Exporting script');\n  for (const item of scriptList) {\n    updateProgressIndicator(`Reading script ${item.name}`);\n    // eslint-disable-next-line no-await-in-loop\n    const scriptData = (await getScriptByName(item.name)).result;\n    scriptData.forEach((element) => {\n      const scriptTextArray = convertBase64TextToArray(element.script);\n      // eslint-disable-next-line no-param-reassign\n      element.script = scriptTextArray;\n      allScriptsData.push(element);\n    });\n  }\n  stopProgressIndicator('Done');\n  saveToFile('script', allScriptsData, '_id', fileName);\n}\n\n/**\n * Export all scripts to individual files\n */\nexport async function exportScriptsToFiles() {\n  const scriptList = (await getScripts()).result;\n  createProgressIndicator(scriptList.length, 'Exporting script');\n  for (const item of scriptList) {\n    updateProgressIndicator(`Reading script ${item.name}`);\n    // eslint-disable-next-line no-await-in-loop\n    const scriptData = (await getScriptByName(item.name)).result;\n    scriptData.forEach((element) => {\n      const scriptTextArray = convertBase64TextToArray(element.script);\n      // eslint-disable-next-line no-param-reassign\n      element.script = scriptTextArray;\n    });\n    const fileName = getTypedFilename(item.name, 'script');\n    saveToFile('script', scriptData, '_id', fileName);\n  }\n  stopProgressIndicator('Done');\n}\n\n/**\n * Import script\n * @param {String} id script uuid\n * @param {Object} data script object\n * @returns {Object} a status object\n */\nexport async function createOrUpdateScript(id, data) {\n  try {\n    await putScript(id, data);\n    return { error: false, name: data.name };\n  } catch (e) {\n    if (e.response.status === 409) {\n      printMessage(\n        `createOrUpdateScript WARNING: script with name ${data.name} already exists, using renaming policy... <name> => <name - imported (n)>`,\n        'warn'\n      );\n      const newName = applyNameCollisionPolicy(data.name);\n      // console.log(newName);\n      printMessage(`Trying to save script as ${newName}`, 'warn');\n      // eslint-disable-next-line no-param-reassign\n      data.name = newName;\n      await createOrUpdateScript(id, data);\n      return { error: false, name: data.name };\n    }\n    printMessage(\n      `createOrUpdateScript ERROR: put script error, script ${id} - ${e.message}`,\n      'error'\n    );\n    return { error: true, name: data.name };\n  }\n}\n\nexport async function importScriptsFromFile(name, file, reUuid = false) {\n  fs.readFile(file, 'utf8', (err, data) => {\n    if (err) throw err;\n    const scriptData = JSON.parse(data);\n    if (validateImport(scriptData.meta)) {\n      createProgressIndicator(Object.keys(scriptData.script).length, '');\n      for (const existingId in scriptData.script) {\n        if ({}.hasOwnProperty.call(scriptData.script, existingId)) {\n          let newId = existingId;\n          // console.log(id);\n          const encodedScript = convertTextArrayToBase64(\n            scriptData.script[existingId].script\n          );\n          scriptData.script[existingId].script = encodedScript;\n          if (reUuid) {\n            newId = uuidv4();\n            // printMessage(\n            //   `Re-uuid-ing script ${scriptData.script[existingId].name} ${existingId} => ${newId}...`\n            // );\n            scriptData.script[existingId]._id = newId;\n          }\n          if (name) {\n            // printMessage(\n            //   `Renaming script ${scriptData.script[existingId].name} => ${options.script}...`\n            // );\n            scriptData.script[existingId].name = name;\n          }\n          updateProgressIndicator(\n            `Importing ${scriptData.script[existingId].name}`\n          );\n          // console.log(scriptData.script[id]);\n          createOrUpdateScript(newId, scriptData.script[existingId]).then(\n            (result) => {\n              if (result == null)\n                printMessage(\n                  `Error importing ${scriptData.script[existingId].name}`,\n                  'error'\n                );\n            }\n          );\n          if (name) break;\n        }\n      }\n      stopProgressIndicator('Done');\n      // printMessage('Done');\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n"]}
+{"version":3,"sources":["../src/ops/ScriptOps.ts"],"names":[],"mappings":"AAsBA;;GAEG;AACH,wBAAsB,WAAW,CAAC,IAAI,UAAQ,iBA+B7C;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,iBAelD;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,KAAA,iBAqB7C;AAED;;GAEG;AACH,wBAAsB,oBAAoB,kBAgBzC;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EAAE,KAAA,EAAE,IAAI,KAAA;;;GAwBlD;AAED,wBAAsB,qBAAqB,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,MAAM,UAAQ,iBAiDrE","file":"ScriptOps.d.ts","sourcesContent":["import fs from 'fs';\nimport { v4 as uuidv4 } from 'uuid';\nimport { applyNameCollisionPolicy } from './utils/OpsUtils';\nimport {\n  createProgressIndicator,\n  createTable,\n  printMessage,\n  stopProgressIndicator,\n  updateProgressIndicator,\n} from './utils/Console';\nimport { getScriptByName, getScripts, putScript } from '../api/ScriptApi';\nimport wordwrap from './utils/Wordwrap';\nimport {\n  convertBase64TextToArray,\n  convertTextArrayToBase64,\n  getTypedFilename,\n  saveToFile,\n  titleCase,\n  validateImport,\n} from './utils/ExportImportUtils';\nimport * as state from '../shared/State';\n\n/**\n * List scripts\n */\nexport async function listScripts(long = false) {\n  try {\n    const scripts = (await getScripts()).result;\n    scripts.sort((a, b) => a.name.localeCompare(b.name));\n    if (long) {\n      const table = createTable([\n        'Name',\n        'UUID',\n        'Language',\n        'Context',\n        'Description',\n      ]);\n      const langMap = { JAVASCRIPT: 'JS', GROOVY: 'Groovy' };\n      scripts.forEach((script) => {\n        table.push([\n          wordwrap(script.name, 25, '  '),\n          script._id,\n          langMap[script.language],\n          wordwrap(titleCase(script.context.split('_').join(' ')), 25),\n          wordwrap(script.description, 30),\n        ]);\n      });\n      printMessage(table.toString(), 'data');\n    } else {\n      scripts.forEach((script) => {\n        printMessage(`${script.name}`, 'data');\n      });\n    }\n  } catch (error) {\n    printMessage(`Error listing scripts - ${error}`, 'error');\n  }\n}\n\n/**\n * Export script to file\n * @param {String} name script name\n * @param {String} file file name\n */\nexport async function exportScriptByName(name, file) {\n  let fileName = getTypedFilename(name, 'script');\n  if (file) {\n    fileName = file;\n  }\n  const scriptData = (await getScriptByName(name)).result;\n  if (scriptData.length > 1) {\n    printMessage(`Multiple scripts with name ${name} found...`, 'error');\n  }\n  scriptData.forEach((element) => {\n    const scriptTextArray = convertBase64TextToArray(element.script);\n    // eslint-disable-next-line no-param-reassign\n    element.script = scriptTextArray;\n  });\n  saveToFile('script', scriptData, '_id', fileName);\n}\n\n/**\n * Export all scripts to single file\n * @param {String} file file name\n */\nexport async function exportScriptsToFile(file) {\n  let fileName = getTypedFilename(`all${state.getRealm()}Scripts`, 'script');\n  if (file) {\n    fileName = file;\n  }\n  const scriptList = (await getScripts()).result;\n  const allScriptsData = [];\n  createProgressIndicator(scriptList.length, 'Exporting script');\n  for (const item of scriptList) {\n    updateProgressIndicator(`Reading script ${item.name}`);\n    // eslint-disable-next-line no-await-in-loop\n    const scriptData = (await getScriptByName(item.name)).result;\n    scriptData.forEach((element) => {\n      const scriptTextArray = convertBase64TextToArray(element.script);\n      // eslint-disable-next-line no-param-reassign\n      element.script = scriptTextArray;\n      allScriptsData.push(element);\n    });\n  }\n  stopProgressIndicator('Done');\n  saveToFile('script', allScriptsData, '_id', fileName);\n}\n\n/**\n * Export all scripts to individual files\n */\nexport async function exportScriptsToFiles() {\n  const scriptList = (await getScripts()).result;\n  createProgressIndicator(scriptList.length, 'Exporting script');\n  for (const item of scriptList) {\n    updateProgressIndicator(`Reading script ${item.name}`);\n    // eslint-disable-next-line no-await-in-loop\n    const scriptData = (await getScriptByName(item.name)).result;\n    scriptData.forEach((element) => {\n      const scriptTextArray = convertBase64TextToArray(element.script);\n      // eslint-disable-next-line no-param-reassign\n      element.script = scriptTextArray;\n    });\n    const fileName = getTypedFilename(item.name, 'script');\n    saveToFile('script', scriptData, '_id', fileName);\n  }\n  stopProgressIndicator('Done');\n}\n\n/**\n * Import script\n * @param {String} id script uuid\n * @param {Object} data script object\n * @returns {Object} a status object\n */\nexport async function createOrUpdateScript(id, data) {\n  try {\n    await putScript(id, data);\n    return { error: false, name: data.name };\n  } catch (e) {\n    if (e.response?.status === 409) {\n      printMessage(\n        `createOrUpdateScript WARNING: script with name ${data.name} already exists, using renaming policy... <name> => <name - imported (n)>`,\n        'warn'\n      );\n      const newName = applyNameCollisionPolicy(data.name);\n      // console.log(newName);\n      printMessage(`Trying to save script as ${newName}`, 'warn');\n      // eslint-disable-next-line no-param-reassign\n      data.name = newName;\n      await createOrUpdateScript(id, data);\n      return { error: false, name: data.name };\n    }\n    printMessage(\n      `createOrUpdateScript ERROR: put script error, script ${id} - ${e.message}`,\n      'error'\n    );\n    return { error: true, name: data.name };\n  }\n}\n\nexport async function importScriptsFromFile(name, file, reUuid = false) {\n  fs.readFile(file, 'utf8', (err, data) => {\n    if (err) throw err;\n    const scriptData = JSON.parse(data);\n    if (validateImport(scriptData.meta)) {\n      createProgressIndicator(Object.keys(scriptData.script).length, '');\n      for (const existingId in scriptData.script) {\n        if ({}.hasOwnProperty.call(scriptData.script, existingId)) {\n          let newId = existingId;\n          // console.log(id);\n          const encodedScript = convertTextArrayToBase64(\n            scriptData.script[existingId].script\n          );\n          scriptData.script[existingId].script = encodedScript;\n          if (reUuid) {\n            newId = uuidv4();\n            // printMessage(\n            //   `Re-uuid-ing script ${scriptData.script[existingId].name} ${existingId} => ${newId}...`\n            // );\n            scriptData.script[existingId]._id = newId;\n          }\n          if (name) {\n            // printMessage(\n            //   `Renaming script ${scriptData.script[existingId].name} => ${options.script}...`\n            // );\n            scriptData.script[existingId].name = name;\n          }\n          updateProgressIndicator(\n            `Importing ${scriptData.script[existingId].name}`\n          );\n          // console.log(scriptData.script[id]);\n          createOrUpdateScript(newId, scriptData.script[existingId]).then(\n            (result) => {\n              if (result == null)\n                printMessage(\n                  `Error importing ${scriptData.script[existingId].name}`,\n                  'error'\n                );\n            }\n          );\n          if (name) break;\n        }\n      }\n      stopProgressIndicator('Done');\n      // printMessage('Done');\n    } else {\n      printMessage('Import validation failed...', 'error');\n    }\n  });\n}\n"]}

package/types/ops/ServiceAccountOps.d.ts

@@ -0,0 +1,20 @@
+import { JwksInterface } from './JoseOps';
+import { ObjectSkeletonInterface } from '../api/ApiTypes';
+export interface SvcacctInterface {
+    name: string;
+    description: string;
+    accountStatus: 'Active' | 'Inactive';
+    scopes: string[];
+    jwks: string;
+}
+export declare function isServiceAccountsFeatureAvailable(): Promise<boolean>;
+/**
+ * Create service account
+ * @param {string} name Human-readable name of service account
+ * @param {string} description Description of service account
+ * @param {'Active' | 'Inactive'} accountStatus Service account status
+ * @param {string[]} scopes Scopes.
+ * @param {JwksInterface} jwks Java Web Key Set
+ * @returns {Promise<ObjectSkeletonInterface>} A promise resolving to a service account object
+ */
+export declare function createServiceAccount(name: string, description: string, accountStatus: 'Active' | 'Inactive', scopes: string[], jwks: JwksInterface): Promise<ObjectSkeletonInterface>;

package/types/ops/ServiceAccountOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ops/ServiceAccountOps.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAM1D,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,GAAG,UAAU,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAGD,wBAAsB,iCAAiC,IAAI,OAAO,CAAC,OAAO,CAAC,CAe1E;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,QAAQ,GAAG,UAAU,EACpC,MAAM,EAAE,MAAM,EAAE,EAChB,IAAI,EAAE,aAAa,GAClB,OAAO,CAAC,uBAAuB,CAAC,CAYlC","file":"ServiceAccountOps.d.ts","sourcesContent":["import { createManagedObject } from '../api/ManagedObjectApi';\nimport { JwksInterface } from './JoseOps';\nimport { ObjectSkeletonInterface } from '../api/ApiTypes';\nimport { debugMessage } from './utils/Console';\nimport { getConfigEntity } from './IdmOps';\n\nconst moType = 'svcacct';\n\nexport interface SvcacctInterface {\n  name: string;\n  description: string;\n  accountStatus: 'Active' | 'Inactive';\n  scopes: string[];\n  jwks: string;\n}\n\nlet serviceAccountsFeatureAvailable: boolean = undefined;\nexport async function isServiceAccountsFeatureAvailable(): Promise<boolean> {\n  debugMessage(`ServiceAccountOps.isServiceAccountsFeatureAvailable: start`);\n  // only look up the schema once\n  if (typeof serviceAccountsFeatureAvailable !== 'undefined')\n    return serviceAccountsFeatureAvailable;\n\n  serviceAccountsFeatureAvailable = false;\n  const schema = await getConfigEntity('managed');\n  for (const object of schema['objects']) {\n    if (object['name'] === 'svcacct') serviceAccountsFeatureAvailable = true;\n  }\n  debugMessage(\n    `ServiceAccountOps.isServiceAccountsFeatureAvailable: end, available=${serviceAccountsFeatureAvailable}`\n  );\n  return serviceAccountsFeatureAvailable;\n}\n\n/**\n * Create service account\n * @param {string} name Human-readable name of service account\n * @param {string} description Description of service account\n * @param {'Active' | 'Inactive'} accountStatus Service account status\n * @param {string[]} scopes Scopes.\n * @param {JwksInterface} jwks Java Web Key Set\n * @returns {Promise<ObjectSkeletonInterface>} A promise resolving to a service account object\n */\nexport async function createServiceAccount(\n  name: string,\n  description: string,\n  accountStatus: 'Active' | 'Inactive',\n  scopes: string[],\n  jwks: JwksInterface\n): Promise<ObjectSkeletonInterface> {\n  const payload: SvcacctInterface = {\n    name,\n    description,\n    accountStatus,\n    scopes,\n    jwks: JSON.stringify(jwks),\n  };\n  debugMessage(`SvcacctOps: createSvcacct: payload:`);\n  debugMessage(payload);\n  const result = await createManagedObject(moType, payload);\n  return result;\n}\n"]}

package/types/ops/ServiceOps.d.ts

@@ -11,44 +11,52 @@ interface FullService extends AmServiceSkeleton {
 export declare function createServiceExportTemplate(): ServiceExportInterface;
 /**
  * Get list of services
+ * @param {boolean} globalConfig true if the list of global services is requested, false otherwise. Default: false.
  */
-export declare function getListOfServices(): Promise<import("../api/ServiceApi").ServiceListItem[]>;
+export declare function getListOfServices(globalConfig?: boolean): Promise<import("../api/ServiceApi").ServiceListItem[]>;
 /**
  * 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
  */
-export declare function getFullServices(): Promise<FullService[]>;
+export declare function getFullServices(globalConfig?: boolean): Promise<FullService[]>;
 /**
  * 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.
  */
-export declare function deleteFullService(serviceId: string): Promise<void>;
+export declare function deleteFullService(serviceId: string, globalConfig?: boolean): Promise<void>;
 /**
  * Deletes all services
+ * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export declare function deleteFullServices(): Promise<void>;
+export declare function deleteFullServices(globalConfig?: boolean): Promise<void>;
 /**
  * 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.
  */
-export declare function exportService(serviceId: string): Promise<ServiceExportInterface>;
+export declare function exportService(serviceId: string, globalConfig?: boolean): Promise<ServiceExportInterface>;
 /**
  * Export all services
- * @param {string} file Options filename for the file, otherwise all{realm}Services.service.json will be the name
+ * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.
  */
-export declare function exportServices(): Promise<ServiceExportInterface>;
+export declare function exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>;
 /**
  * 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 {string} file Reference to the filename with the data for the service
+ * @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 declare function importService(serviceId: string, importData: ServiceExportInterface, clean: boolean): Promise<AmServiceSkeleton>;
+export declare function importService(serviceId: string, importData: ServiceExportInterface, clean: boolean, globalConfig?: boolean): Promise<AmServiceSkeleton>;
 /**
  * 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.
  */
-export declare function importServices(importData: ServiceExportInterface, clean: boolean): Promise<AmServiceSkeleton[]>;
+export declare function importServices(importData: ServiceExportInterface, clean: boolean, globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
 export {};

package/types/ops/ServiceOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ops/ServiceOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAQL,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAGpD,UAAU,WAAY,SAAQ,iBAAiB;IAC7C,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,sBAAsB,CAKpE;AAED;;GAEG;AACH,wBAAsB,iBAAiB,2DAKtC;AAED;;;GAGG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAoC9D;AA0GD;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,SAAS,EAAE,MAAM,iBAcxD;AAED;;GAEG;AACH,wBAAsB,kBAAkB,kBA+BvC;AAED;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,sBAAsB,CAAC,CAajC;AAED;;;GAGG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,sBAAsB,CAAC,CActE;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,OAAO,GACb,OAAO,CAAC,iBAAiB,CAAC,CAM5B;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAClC,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,OAAO,gCAmBf","file":"ServiceOps.d.ts","sourcesContent":["import { AmServiceSkeleton } from '../api/ApiTypes';\nimport {\n  deleteService,\n  deleteServiceNextDescendent,\n  getService,\n  getListOfServices as _getListOfServices,\n  getServiceDescendents,\n  putService,\n  putServiceNextDescendent,\n  ServiceNextDescendent,\n} from '../api/ServiceApi';\nimport { ServiceExportInterface } from './OpsTypes';\nimport { debugMessage, printMessage } from './utils/Console';\n\ninterface FullService extends AmServiceSkeleton {\n  nextDescendents?: ServiceNextDescendent[];\n}\n\n/**\n * Create an empty service export template\n * @returns {SingleTreeExportInterface} an empty service export template\n */\nexport function createServiceExportTemplate(): ServiceExportInterface {\n  return {\n    meta: {},\n    service: {},\n  } as ServiceExportInterface;\n}\n\n/**\n * Get list of services\n */\nexport async function getListOfServices() {\n  debugMessage(`ServiceOps.getListOfServices: start`);\n  const services = (await _getListOfServices()).result;\n  debugMessage(`ServiceOps.getListOfServices: end`);\n  return services;\n}\n\n/**\n * Get all services including their descendents.\n * @returns Promise resolving to an array of services with their descendants\n */\nexport async function getFullServices(): Promise<FullService[]> {\n  debugMessage(`ServiceOps.getFullServices: start`);\n  const serviceList = (await _getListOfServices()).result;\n\n  const fullServiceData = await Promise.all(\n    serviceList.map(async (listItem) => {\n      try {\n        const [service, nextDescendents] = await Promise.all([\n          getService(listItem._id),\n          getServiceDescendents(listItem._id),\n        ]);\n\n        return {\n          ...service,\n          nextDescendents,\n        };\n      } catch (error) {\n        if (\n          !(\n            error.response?.status === 403 &&\n            error.response?.data?.message ===\n              'This operation is not available in ForgeRock Identity Cloud.'\n          )\n        ) {\n          const message = error.response?.data?.message;\n          printMessage(\n            `Unable to retrieve data for ${listItem._id} with error: ${message}`,\n            'error'\n          );\n        }\n      }\n    })\n  );\n\n  debugMessage(`ServiceOps.getFullServices: end`);\n  return fullServiceData.filter((data) => !!data); // make sure to filter out any undefined objects\n}\n\n/**\n * Saves a service using the provide id and data, including descendents\n * @param {string} serviceId the service id / name\n * @param {string} fullServiceData service object including descendants\n * @returns promise resolving to a service object\n */\nasync function putFullService(\n  serviceId: string,\n  fullServiceData: FullService,\n  clean: boolean\n): Promise<AmServiceSkeleton> {\n  debugMessage(`ServiceOps.putFullService: start, serviceId=${serviceId}`);\n  const nextDescendents = fullServiceData.nextDescendents;\n\n  delete fullServiceData.nextDescendents;\n  delete fullServiceData._rev;\n  delete fullServiceData.enabled;\n\n  if (clean) {\n    try {\n      debugMessage(`ServiceOps.putFullService: clean`);\n      await deleteFullService(serviceId);\n    } catch (error) {\n      if (\n        !(\n          error.response?.status === 404 &&\n          error.response?.data?.message === 'Not Found'\n        )\n      ) {\n        const message = error.response?.data?.message;\n        printMessage(\n          `Error deleting service '${serviceId}' before import: ${message}`,\n          'error'\n        );\n      }\n    }\n  }\n\n  // create service first\n  const result = await putService(serviceId, fullServiceData);\n\n  // return fast if no next descendents supplied\n  if (nextDescendents.length === 0) {\n    debugMessage(`ServiceOps.putFullService: end (w/o descendents)`);\n    return result;\n  }\n\n  // now create next descendents\n  await Promise.all(\n    nextDescendents.map(async (descendent) => {\n      const type = descendent._type._id;\n      const descendentId = descendent._id;\n      debugMessage(`ServiceOps.putFullService: descendentId=${descendentId}`);\n      let result = undefined;\n      try {\n        result = await putServiceNextDescendent(\n          serviceId,\n          type,\n          descendentId,\n          descendent\n        );\n      } catch (error) {\n        const message = error.response?.data?.message;\n        printMessage(\n          `Put descendent '${descendentId}' of service '${serviceId}': ${message}`,\n          'error'\n        );\n      }\n      return result;\n    })\n  );\n  debugMessage(`ServiceOps.putFullService: end (w/ descendents)`);\n}\n\n/**\n * Saves multiple services using the serviceEntries which contain both id and data with descendants\n * @param {[string, FullService][]} serviceEntries The services to add\n * @param {boolean} clean Indicates whether to remove possible existing services first\n * @returns {Promise<AmService[]>} promise resolving to an array of service objects\n */\nasync function putFullServices(\n  serviceEntries: [string, FullService][],\n  clean: boolean\n): Promise<AmServiceSkeleton[]> {\n  debugMessage(`ServiceOps.putFullServices: start`);\n  const results: AmServiceSkeleton[] = [];\n  for (const [id, data] of serviceEntries) {\n    try {\n      const result = await putFullService(id, data, clean);\n      results.push(result);\n      printMessage(`Imported: ${id}`, 'info');\n    } catch (error) {\n      const message = error.response?.data?.message;\n      const detail = error.response?.data?.detail;\n      printMessage(`Import service '${id}': ${message}`, 'error');\n      if (detail) {\n        printMessage(`Details: ${JSON.stringify(detail)}`, 'error');\n      }\n    }\n  }\n  debugMessage(`ServiceOps.putFullServices: end`);\n  return results;\n}\n\n/**\n * Deletes the specified service\n * @param {string} serviceId The service to delete\n */\nexport async function deleteFullService(serviceId: string) {\n  const serviceNextDescendentData = await getServiceDescendents(serviceId);\n\n  await Promise.all(\n    serviceNextDescendentData.map((nextDescendent) =>\n      deleteServiceNextDescendent(\n        serviceId,\n        nextDescendent._type._id,\n        nextDescendent._id\n      )\n    )\n  );\n\n  await deleteService(serviceId);\n}\n\n/**\n * Deletes all services\n */\nexport async function deleteFullServices() {\n  debugMessage(`ServiceOps.deleteFullServices: start`);\n  try {\n    const serviceList = (await _getListOfServices()).result;\n\n    await Promise.all(\n      serviceList.map(async (serviceListItem) => {\n        try {\n          await deleteFullService(serviceListItem._id);\n        } catch (error) {\n          if (\n            !(\n              error.response?.status === 403 &&\n              error.response?.data?.message ===\n                'This operation is not available in ForgeRock Identity Cloud.'\n            )\n          ) {\n            const message = error.response?.data?.message;\n            printMessage(\n              `Delete service '${serviceListItem._id}': ${message}`,\n              'error'\n            );\n          }\n        }\n      })\n    );\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Delete services: ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.deleteFullServices: end`);\n}\n\n/**\n * Export service. The response can be saved to file as is.\n * @param serviceId service id/name\n * @returns {Promise<ServiceExportInterface>} Promise resolving to a ServiceExportInterface object.\n */\nexport async function exportService(\n  serviceId: string\n): Promise<ServiceExportInterface> {\n  debugMessage(`ServiceOps.exportService: start`);\n  const exportData = createServiceExportTemplate();\n  try {\n    const service = await getService(serviceId);\n    service.nextDescendents = await getServiceDescendents(serviceId);\n    exportData.service[serviceId] = service;\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Export service '${serviceId}': ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.exportService: end`);\n  return exportData;\n}\n\n/**\n * Export all services\n * @param {string} file Options filename for the file, otherwise all{realm}Services.service.json will be the name\n */\nexport async function exportServices(): Promise<ServiceExportInterface> {\n  debugMessage(`ServiceOps.exportServices: start`);\n  const exportData = createServiceExportTemplate();\n  try {\n    const services = await getFullServices();\n    for (const service of services) {\n      exportData.service[service._type._id] = service;\n    }\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Export servics: ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.exportServices: end`);\n  return exportData;\n}\n\n/**\n * 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\n * @param {string} serviceId The service id/name to add\n * @param {boolean} clean Indicates whether to remove a possible existing service with the same id first.\n * @param {string} file Reference to the filename with the data for the service\n * @returns Promise resolving when the service has been imported\n */\nexport async function importService(\n  serviceId: string,\n  importData: ServiceExportInterface,\n  clean: boolean\n): Promise<AmServiceSkeleton> {\n  debugMessage(`ServiceOps.importService: start`);\n  const serviceData = importData.service[serviceId];\n  const result = await putFullService(serviceId, serviceData, clean);\n  debugMessage(`ServiceOps.importService: end`);\n  return result;\n}\n\n/**\n * Imports multiple services from the same file. Optionally clean (remove) existing services first\n * @param {boolean} clean Indicates whether to remove possible existing services first\n */\nexport async function importServices(\n  importData: ServiceExportInterface,\n  clean: boolean\n) {\n  debugMessage(`ServiceOps.importServices: start`);\n  try {\n    const result = await putFullServices(\n      Object.entries(importData.service),\n      clean\n    );\n    debugMessage(`ServiceOps.importServices: end`);\n    return result;\n  } catch (error) {\n    const message = error.response?.data?.message;\n    const detail = error.response?.data?.detail;\n    printMessage(`Unable to import services: error: ${message}`, 'error');\n    if (detail) {\n      printMessage(`Details: ${JSON.stringify(detail)}`, 'error');\n    }\n    throw error;\n  }\n}\n"]}
+{"version":3,"sources":["../src/ops/ServiceOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAQL,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAGpD,UAAU,WAAY,SAAQ,iBAAiB;IAC7C,eAAe,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,sBAAsB,CAKpE;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,YAAY,UAAQ,0DAK3D;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,YAAY,UAAQ,GACnB,OAAO,CAAC,WAAW,EAAE,CAAC,CAsCxB;AAmHD;;;;GAIG;AACH,wBAAsB,iBAAiB,CACrC,SAAS,EAAE,MAAM,EACjB,YAAY,UAAQ,iBAuBrB;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,YAAY,UAAQ,iBAiC5D;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,YAAY,UAAQ,GACnB,OAAO,CAAC,sBAAsB,CAAC,CAgBjC;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAClC,YAAY,UAAQ,GACnB,OAAO,CAAC,sBAAsB,CAAC,CAgBjC;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,OAAO,EACd,YAAY,UAAQ,GACnB,OAAO,CAAC,iBAAiB,CAAC,CAW5B;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,UAAU,EAAE,sBAAsB,EAClC,KAAK,EAAE,OAAO,EACd,YAAY,UAAQ,gCAsBrB","file":"ServiceOps.d.ts","sourcesContent":["import { AmServiceSkeleton } from '../api/ApiTypes';\nimport {\n  deleteService,\n  deleteServiceNextDescendent,\n  getService,\n  getListOfServices as _getListOfServices,\n  getServiceDescendents,\n  putService,\n  putServiceNextDescendent,\n  ServiceNextDescendent,\n} from '../api/ServiceApi';\nimport { ServiceExportInterface } from './OpsTypes';\nimport { debugMessage, printMessage } from './utils/Console';\n\ninterface FullService extends AmServiceSkeleton {\n  nextDescendents?: ServiceNextDescendent[];\n}\n\n/**\n * Create an empty service export template\n * @returns {SingleTreeExportInterface} an empty service export template\n */\nexport function createServiceExportTemplate(): ServiceExportInterface {\n  return {\n    meta: {},\n    service: {},\n  } as ServiceExportInterface;\n}\n\n/**\n * Get list of services\n * @param {boolean} globalConfig true if the list of global services is requested, false otherwise. Default: false.\n */\nexport async function getListOfServices(globalConfig = false) {\n  debugMessage(`ServiceOps.getListOfServices: start`);\n  const services = (await _getListOfServices(globalConfig)).result;\n  debugMessage(`ServiceOps.getListOfServices: end`);\n  return services;\n}\n\n/**\n * Get all services including their descendents.\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n * @returns Promise resolving to an array of services with their descendants\n */\nexport async function getFullServices(\n  globalConfig = false\n): Promise<FullService[]> {\n  debugMessage(\n    `ServiceOps.getFullServices: start, globalConfig=${globalConfig}`\n  );\n  const serviceList = (await _getListOfServices(globalConfig)).result;\n\n  const fullServiceData = await Promise.all(\n    serviceList.map(async (listItem) => {\n      try {\n        const [service, nextDescendents] = await Promise.all([\n          getService(listItem._id, globalConfig),\n          getServiceDescendents(listItem._id, globalConfig),\n        ]);\n\n        return {\n          ...service,\n          nextDescendents,\n        };\n      } catch (error) {\n        if (\n          !(\n            error.response?.status === 403 &&\n            error.response?.data?.message ===\n              'This operation is not available in ForgeRock Identity Cloud.'\n          )\n        ) {\n          const message = error.response?.data?.message;\n          printMessage(\n            `Unable to retrieve data for ${listItem._id} with error: ${message}`,\n            'error'\n          );\n        }\n      }\n    })\n  );\n\n  debugMessage(`ServiceOps.getFullServices: end`);\n  return fullServiceData.filter((data) => !!data); // make sure to filter out any undefined objects\n}\n\n/**\n * Saves a service using the provide id and data, including descendents\n * @param {string} serviceId the service id / name\n * @param {string} fullServiceData service object including descendants\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n * @returns promise resolving to a service object\n */\nasync function putFullService(\n  serviceId: string,\n  fullServiceData: FullService,\n  clean: boolean,\n  globalConfig = false\n): Promise<AmServiceSkeleton> {\n  debugMessage(\n    `ServiceOps.putFullService: start, serviceId=${serviceId}, globalConfig=${globalConfig}`\n  );\n  const nextDescendents = fullServiceData.nextDescendents;\n\n  delete fullServiceData.nextDescendents;\n  delete fullServiceData._rev;\n  delete fullServiceData.enabled;\n\n  if (clean) {\n    try {\n      debugMessage(`ServiceOps.putFullService: clean`);\n      await deleteFullService(serviceId, globalConfig);\n    } catch (error) {\n      if (\n        !(\n          error.response?.status === 404 &&\n          error.response?.data?.message === 'Not Found'\n        )\n      ) {\n        const message = error.response?.data?.message;\n        printMessage(\n          `Error deleting service '${serviceId}' before import: ${message}`,\n          'error'\n        );\n      }\n    }\n  }\n\n  // create service first\n  const result = await putService(serviceId, fullServiceData, globalConfig);\n\n  // return fast if no next descendents supplied\n  if (nextDescendents.length === 0) {\n    debugMessage(`ServiceOps.putFullService: end (w/o descendents)`);\n    return result;\n  }\n\n  // now create next descendents\n  await Promise.all(\n    nextDescendents.map(async (descendent) => {\n      const type = descendent._type._id;\n      const descendentId = descendent._id;\n      debugMessage(`ServiceOps.putFullService: descendentId=${descendentId}`);\n      let result = undefined;\n      try {\n        result = await putServiceNextDescendent(\n          serviceId,\n          type,\n          descendentId,\n          descendent,\n          globalConfig\n        );\n      } catch (error) {\n        const message = error.response?.data?.message;\n        printMessage(\n          `Put descendent '${descendentId}' of service '${serviceId}': ${message}`,\n          'error'\n        );\n      }\n      return result;\n    })\n  );\n  debugMessage(`ServiceOps.putFullService: end (w/ descendents)`);\n}\n\n/**\n * Saves multiple services using the serviceEntries which contain both id and data with descendants\n * @param {[string, FullService][]} serviceEntries The services to add\n * @param {boolean} clean Indicates whether to remove possible existing services first\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n * @returns {Promise<AmService[]>} promise resolving to an array of service objects\n */\nasync function putFullServices(\n  serviceEntries: [string, FullService][],\n  clean: boolean,\n  globalConfig = false\n): Promise<AmServiceSkeleton[]> {\n  debugMessage(\n    `ServiceOps.putFullServices: start, globalConfig=${globalConfig}`\n  );\n  const results: AmServiceSkeleton[] = [];\n  for (const [id, data] of serviceEntries) {\n    try {\n      const result = await putFullService(id, data, clean, globalConfig);\n      results.push(result);\n      printMessage(`Imported: ${id}`, 'info');\n    } catch (error) {\n      const message = error.response?.data?.message;\n      const detail = error.response?.data?.detail;\n      printMessage(`Import service '${id}': ${message}`, 'error');\n      if (detail) {\n        printMessage(`Details: ${JSON.stringify(detail)}`, 'error');\n      }\n    }\n  }\n  debugMessage(`ServiceOps.putFullServices: end`);\n  return results;\n}\n\n/**\n * Deletes the specified service\n * @param {string} serviceId The service to delete\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n */\nexport async function deleteFullService(\n  serviceId: string,\n  globalConfig = false\n) {\n  debugMessage(\n    `ServiceOps.deleteFullService: start, globalConfig=${globalConfig}`\n  );\n  const serviceNextDescendentData = await getServiceDescendents(\n    serviceId,\n    globalConfig\n  );\n\n  await Promise.all(\n    serviceNextDescendentData.map((nextDescendent) =>\n      deleteServiceNextDescendent(\n        serviceId,\n        nextDescendent._type._id,\n        nextDescendent._id,\n        globalConfig\n      )\n    )\n  );\n\n  await deleteService(serviceId, globalConfig);\n  debugMessage(`ServiceOps.deleteFullService: end`);\n}\n\n/**\n * Deletes all services\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n */\nexport async function deleteFullServices(globalConfig = false) {\n  debugMessage(\n    `ServiceOps.deleteFullServices: start, globalConfig=${globalConfig}`\n  );\n  try {\n    const serviceList = (await _getListOfServices(globalConfig)).result;\n\n    await Promise.all(\n      serviceList.map(async (serviceListItem) => {\n        try {\n          await deleteFullService(serviceListItem._id, globalConfig);\n        } catch (error) {\n          if (\n            !(\n              error.response?.status === 403 &&\n              error.response?.data?.message ===\n                'This operation is not available in ForgeRock Identity Cloud.'\n            )\n          ) {\n            const message = error.response?.data?.message;\n            printMessage(\n              `Delete service '${serviceListItem._id}': ${message}`,\n              'error'\n            );\n          }\n        }\n      })\n    );\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Delete services: ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.deleteFullServices: end`);\n}\n\n/**\n * Export service. The response can be saved to file as is.\n * @param serviceId service id/name\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n * @returns {Promise<ServiceExportInterface>} Promise resolving to a ServiceExportInterface object.\n */\nexport async function exportService(\n  serviceId: string,\n  globalConfig = false\n): Promise<ServiceExportInterface> {\n  debugMessage(`ServiceOps.exportService: start, globalConfig=${globalConfig}`);\n  const exportData = createServiceExportTemplate();\n  try {\n    const service = await getService(serviceId, globalConfig);\n    service.nextDescendents = await getServiceDescendents(\n      serviceId,\n      globalConfig\n    );\n    exportData.service[serviceId] = service;\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Export service '${serviceId}': ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.exportService: end`);\n  return exportData;\n}\n\n/**\n * Export all services\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n */\nexport async function exportServices(\n  globalConfig = false\n): Promise<ServiceExportInterface> {\n  debugMessage(\n    `ServiceOps.exportServices: start, globalConfig=${globalConfig}`\n  );\n  const exportData = createServiceExportTemplate();\n  try {\n    const services = await getFullServices(globalConfig);\n    for (const service of services) {\n      exportData.service[service._type._id] = service;\n    }\n  } catch (error) {\n    const message = error.response?.data?.message;\n    printMessage(`Export servics: ${message}`, 'error');\n  }\n  debugMessage(`ServiceOps.exportServices: end`);\n  return exportData;\n}\n\n/**\n * 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\n * @param {string} serviceId The service id/name to add\n * @param {ServiceExportInterface} importData The service configuration export data to import\n * @param {boolean} clean Indicates whether to remove a possible existing service with the same id first.\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n * @returns Promise resolving when the service has been imported\n */\nexport async function importService(\n  serviceId: string,\n  importData: ServiceExportInterface,\n  clean: boolean,\n  globalConfig = false\n): Promise<AmServiceSkeleton> {\n  debugMessage(`ServiceOps.importService: start, globalConfig=${globalConfig}`);\n  const serviceData = importData.service[serviceId];\n  const result = await putFullService(\n    serviceId,\n    serviceData,\n    clean,\n    globalConfig\n  );\n  debugMessage(`ServiceOps.importService: end`);\n  return result;\n}\n\n/**\n * Imports multiple services from the same file. Optionally clean (remove) existing services first\n * @param {ServiceExportInterface} importData The service configuration export data to import\n * @param {boolean} clean Indicates whether to remove possible existing services first\n * @param {boolean} globalConfig true if the global service is the target of the operation, false otherwise. Default: false.\n */\nexport async function importServices(\n  importData: ServiceExportInterface,\n  clean: boolean,\n  globalConfig = false\n) {\n  debugMessage(\n    `ServiceOps.importServices: start, globalConfig=${globalConfig}`\n  );\n  try {\n    const result = await putFullServices(\n      Object.entries(importData.service),\n      clean,\n      globalConfig\n    );\n    debugMessage(`ServiceOps.importServices: end`);\n    return result;\n  } catch (error) {\n    const message = error.response?.data?.message;\n    const detail = error.response?.data?.detail;\n    printMessage(`Unable to import services: error: ${message}`, 'error');\n    if (detail) {\n      printMessage(`Details: ${JSON.stringify(detail)}`, 'error');\n    }\n    throw error;\n  }\n}\n"]}