@rockcarver/frodo-lib 2.0.0-3 → 2.0.0-4

package/esm/ops/AdminOps.mjs

@@ -424,19 +424,29 @@ async function addAdminScopes({
       addDefaultScope = true;
       modClient.coreOAuth2ClientConfig.defaultScopes.value = adminDefaultScopes;
     } else {
-      printMessage(`Client "${clientId}" already has default scopes configured, not adding admin default scope.`);
+      printMessage({
+        message: `Client "${clientId}" already has default scopes configured, not adding admin default scope.`,
+        state
+      });
     }
   }
   if (addScopes.length > 0 || addDefaultScope) {
-    printMessage(`Adding admin scopes to client "${clientId}"...`);
+    printMessage({
+      message: `Adding admin scopes to client "${clientId}"...`,
+      state
+    });
   } else {
-    printMessage(`Client "${clientId}" already has admin scopes.`);
+    printMessage({
+      message: `Client "${clientId}" already has admin scopes.`,
+      state
+    });
   }
   return modClient;
 }
 function addClientCredentialsGrantType({
   clientId,
-  client
+  client,
+  state
 }) {
   const modClient = client;
   let modified = false;
@@ -450,9 +460,15 @@ function addClientCredentialsGrantType({
   }
   modClient.advancedOAuth2ClientConfig.grantTypes.inherited = false;
   if (modified) {
-    printMessage(`Adding client credentials grant type to client "${clientId}"...`);
+    printMessage({
+      message: `Adding client credentials grant type to client "${clientId}"...`,
+      state
+    });
   } else {
-    printMessage(`Client "${clientId}" already has client credentials grant type.`);
+    printMessage({
+      message: `Client "${clientId}" already has client credentials grant type.`,
+      state
+    });
   }
   return modClient;
 }
@@ -467,7 +483,11 @@ async function addAdminStaticUserMapping({
       state
     });
   } catch (error) {
-    printMessage(`Error reading IDM authentication configuration: ${error.message}`, 'error');
+    printMessage({
+      message: `Error reading IDM authentication configuration: ${error.message}`,
+      type: 'error',
+      state
+    });
   }
   let needsAdminMapping = true;
   let addRoles = [];
@@ -489,7 +509,10 @@ async function addAdminStaticUserMapping({
     return newMapping;
   });
   if (needsAdminMapping) {
-    printMessage(`Creating static user mapping for client "${name}"...`);
+    printMessage({
+      message: `Creating static user mapping for client "${name}"...`,
+      state
+    });
     mappings.push({
       subject: name,
       localUser: 'internal/user/openidm-admin',
@@ -499,7 +522,10 @@ async function addAdminStaticUserMapping({
   }
   authentication['rsFilter']['staticUserMapping'] = mappings;
   if (addRoles.length > 0 || needsAdminMapping) {
-    printMessage(`Adding admin roles to static user mapping for client "${name}"...`);
+    printMessage({
+      message: `Adding admin roles to static user mapping for client "${name}"...`,
+      state
+    });
     try {
       await putConfigEntity({
         entityId: 'authentication',
@@ -507,11 +533,22 @@ async function addAdminStaticUserMapping({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   } else {
-    printMessage(`Static user mapping for client "${name}" already has admin roles.`);
+    printMessage({
+      message: `Static user mapping for client "${name}" already has admin roles.`,
+      state
+    });
   }
 }
 
@@ -564,7 +601,10 @@ export async function addAutoIdStaticUserMapping({
     return newMapping;
   });
   if (needsAdminMapping) {
-    printMessage(`Creating static user mapping for AutoId client "${name}"...`);
+    printMessage({
+      message: `Creating static user mapping for AutoId client "${name}"...`,
+      state
+    });
     mappings.push({
       subject: name,
       localUser: 'internal/user/idm-provisioning',
@@ -574,7 +614,10 @@ export async function addAutoIdStaticUserMapping({
   }
   authentication.rsFilter.staticUserMapping = mappings;
   if (addRoles.length > 0 || needsAdminMapping) {
-    printMessage(`Adding required roles to static user mapping for AutoId client "${name}"...`);
+    printMessage({
+      message: `Adding required roles to static user mapping for AutoId client "${name}"...`,
+      state
+    });
     try {
       await putConfigEntity({
         entityId: 'authentication',
@@ -582,11 +625,22 @@ export async function addAutoIdStaticUserMapping({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   } else {
-    printMessage(`Static user mapping for AutoId client "${name}" already has all required roles.`);
+    printMessage({
+      message: `Static user mapping for AutoId client "${name}" already has all required roles.`,
+      state
+    });
   }
 }
 export async function grantOAuth2ClientAdminPrivileges({
@@ -610,7 +664,8 @@ export async function grantOAuth2ClientAdminPrivileges({
   });
   client = addClientCredentialsGrantType({
     clientId,
-    client
+    client,
+    state
   });
   await putOAuth2Client({
     clientId,
@@ -636,26 +691,39 @@ async function removeAdminScopes({
     finalScopes = modClient.coreOAuth2ClientConfig.scopes.value.filter(scope => !allAdminScopes.includes(scope));
   }
   if (modClient.coreOAuth2ClientConfig.scopes.value.length > finalScopes.length) {
-    printMessage(`Removing admin scopes from client "${name}"...`);
+    printMessage({
+      message: `Removing admin scopes from client "${name}"...`,
+      state
+    });
     modClient.coreOAuth2ClientConfig.scopes.value = finalScopes;
   } else {
-    printMessage(`Client "${name}" has no admin scopes.`);
+    printMessage({
+      message: `Client "${name}" has no admin scopes.`,
+      state
+    });
   }
   let finalDefaultScopes = [];
   if (modClient.coreOAuth2ClientConfig.defaultScopes && modClient.coreOAuth2ClientConfig.defaultScopes.value) {
     finalDefaultScopes = modClient.coreOAuth2ClientConfig.defaultScopes.value.filter(scope => !adminDefaultScopes.includes(scope));
   }
   if (modClient.coreOAuth2ClientConfig.defaultScopes.value.length > finalDefaultScopes.length) {
-    printMessage(`Removing admin default scopes from client "${name}"...`);
+    printMessage({
+      message: `Removing admin default scopes from client "${name}"...`,
+      state
+    });
     modClient.coreOAuth2ClientConfig.defaultScopes.value = finalDefaultScopes;
   } else {
-    printMessage(`Client "${name}" has no admin default scopes.`);
+    printMessage({
+      message: `Client "${name}" has no admin default scopes.`,
+      state
+    });
   }
   return modClient;
 }
 function removeClientCredentialsGrantType({
   clientId,
-  client
+  client,
+  state
 }) {
   const modClient = client;
   let modified = false;
@@ -665,10 +733,16 @@ function removeClientCredentialsGrantType({
     modified = modClient.advancedOAuth2ClientConfig.grantTypes.value.length > finalGrantTypes.length;
   }
   if (modified) {
-    printMessage(`Removing client credentials grant type from client "${clientId}"...`);
+    printMessage({
+      message: `Removing client credentials grant type from client "${clientId}"...`,
+      state
+    });
     modClient.advancedOAuth2ClientConfig.grantTypes.value = finalGrantTypes;
   } else {
-    printMessage(`Client "${clientId}" does not allow client credentials grant type.`);
+    printMessage({
+      message: `Client "${clientId}" does not allow client credentials grant type.`,
+      state
+    });
   }
   return modClient;
 }
@@ -698,9 +772,15 @@ async function removeAdminStaticUserMapping({
   authentication.rsFilter.staticUserMapping = mappings;
   if (modified || removeMapping) {
     if (removeMapping) {
-      printMessage(`Removing static user mapping for client "${name}"...`);
+      printMessage({
+        message: `Removing static user mapping for client "${name}"...`,
+        state
+      });
     } else {
-      printMessage(`Removing admin roles from static user mapping for client "${name}"...`);
+      printMessage({
+        message: `Removing admin roles from static user mapping for client "${name}"...`,
+        state
+      });
     }
     try {
       await putConfigEntity({
@@ -709,11 +789,22 @@ async function removeAdminStaticUserMapping({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   } else {
-    printMessage(`Static user mapping for client "${name}" has no admin roles.`);
+    printMessage({
+      message: `Static user mapping for client "${name}" has no admin roles.`,
+      state
+    });
   }
 }
 export async function revokeOAuth2ClientAdminPrivileges({
@@ -737,7 +828,8 @@ export async function revokeOAuth2ClientAdminPrivileges({
   });
   client = removeClientCredentialsGrantType({
     clientId,
-    client
+    client,
+    state
   });
   await putOAuth2Client({
     clientId,
@@ -774,7 +866,11 @@ export async function createOAuth2ClientWithAdminPrivileges({
       state
     });
   } catch (error) {
-    printMessage(`Error creating oauth2 client: ${error.message}`, 'error');
+    printMessage({
+      message: `Error creating oauth2 client: ${error.message}`,
+      state,
+      type: 'error'
+    });
   }
 }
 export async function createLongLivedToken({
@@ -830,7 +926,11 @@ export async function createLongLivedToken({
     } catch (error) {
       if (_.get(error, 'response.data.code') === 400 && _.get(error, 'response.data.message') === 'Failed to create secret, the secret already exists') {
         const newSecret = `${secret}-${expires}`;
-        printMessage(`esv '${secret}' already exists, using ${newSecret}`, 'warn');
+        printMessage({
+          message: `esv '${secret}' already exists, using ${newSecret}`,
+          type: 'warn',
+          state
+        });
         await putSecret({
           secretId: newSecret,
           value: response.access_token,
@@ -863,7 +963,10 @@ export async function removeStaticUserMapping({
   });
   authentication.rsFilter.staticUserMapping = mappings;
   if (removeMapping) {
-    printMessage(`Removing static user mapping for subject "${subject}"...`);
+    printMessage({
+      message: `Removing static user mapping for subject "${subject}"...`,
+      state
+    });
     try {
       await putConfigEntity({
         entityId: 'authentication',
@@ -871,11 +974,22 @@ export async function removeStaticUserMapping({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   } else {
-    printMessage(`No static user mapping for subject "${subject}" found.`);
+    printMessage({
+      message: `No static user mapping for subject "${subject}" found.`,
+      state
+    });
   }
 }
 export async function hideGenericExtensionAttributes({
@@ -898,21 +1012,33 @@ export async function hideGenericExtensionAttributes({
     propertyNames.forEach(name => {
       if (isEqualJson(GENERIC_EXTENSION_ATTRIBUTES[name], object.schema.properties[name], ['viewable', 'usageDescription']) || includeCustomized) {
         if (object.schema.properties[name].viewable) {
-          printMessage(`${name}: hide`);
+          printMessage({
+            message: `${name}: hide`,
+            state
+          });
           // eslint-disable-next-line no-param-reassign
           object.schema.properties[name].viewable = false;
         } else {
-          printMessage(`${name}: ignore (already hidden)`);
+          printMessage({
+            message: `${name}: ignore (already hidden)`,
+            state
+          });
         }
       } else {
-        printMessage(`${name}: skip (customized)`);
+        printMessage({
+          message: `${name}: skip (customized)`,
+          state
+        });
       }
     });
     return object;
   });
   managed.objects = updatedObjects;
   if (dryRun) {
-    printMessage('Dry-run only. Changes are not saved.');
+    printMessage({
+      message: 'Dry-run only. Changes are not saved.',
+      state
+    });
   } else {
     try {
       await putConfigEntity({
@@ -921,8 +1047,16 @@ export async function hideGenericExtensionAttributes({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   }
 }
@@ -946,21 +1080,33 @@ export async function showGenericExtensionAttributes({
     propertyNames.forEach(name => {
       if (isEqualJson(GENERIC_EXTENSION_ATTRIBUTES[name], object.schema.properties[name], ['viewable', 'usageDescription']) || includeCustomized) {
         if (!object.schema.properties[name].viewable) {
-          printMessage(`${name}: show`);
+          printMessage({
+            message: `${name}: show`,
+            state
+          });
           // eslint-disable-next-line no-param-reassign
           object.schema.properties[name].viewable = true;
         } else {
-          printMessage(`${name}: ignore (already showing)`);
+          printMessage({
+            message: `${name}: ignore (already showing)`,
+            state
+          });
         }
       } else {
-        printMessage(`${name}: skip (customized)`);
+        printMessage({
+          message: `${name}: skip (customized)`,
+          state
+        });
       }
     });
     return object;
   });
   managed.objects = updatedObjects;
   if (dryRun) {
-    printMessage('Dry-run only. Changes are not saved.');
+    printMessage({
+      message: 'Dry-run only. Changes are not saved.',
+      state
+    });
   } else {
     try {
       await putConfigEntity({
@@ -969,8 +1115,16 @@ export async function showGenericExtensionAttributes({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   }
 }
@@ -991,15 +1145,25 @@ async function repairOrgModelUser({
     })) {
       return object;
     }
-    printMessage(`${object.name}: checking...`);
+    printMessage({
+      message: `${object.name}: checking...`,
+      state
+    });
     RDVPs.forEach(name => {
       if (!object.schema.properties[name].queryConfig.flattenProperties) {
-        printMessage(`- ${name}: repairing - needs flattening`, 'warn');
+        printMessage({
+          message: `- ${name}: repairing - needs flattening`,
+          type: 'warn',
+          state
+        });
         // eslint-disable-next-line no-param-reassign
         object.schema.properties[name].queryConfig.flattenProperties = true;
         repairData = true;
       } else {
-        printMessage(`- ${name}: OK`);
+        printMessage({
+          message: `- ${name}: OK`,
+          state
+        });
       }
     });
     return object;
@@ -1013,8 +1177,16 @@ async function repairOrgModelUser({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   }
   return repairData;
@@ -1036,15 +1208,25 @@ async function repairOrgModelOrg({
     })) {
       return object;
     }
-    printMessage(`${object.name}: checking...`);
+    printMessage({
+      message: `${object.name}: checking...`,
+      state
+    });
     RDVPs.forEach(name => {
       if (!object.schema.properties[name].queryConfig.flattenProperties) {
-        printMessage(`- ${name}: repairing - needs flattening`, 'warn');
+        printMessage({
+          message: `- ${name}: repairing - needs flattening`,
+          type: 'warn',
+          state
+        });
         // eslint-disable-next-line no-param-reassign
         object.schema.properties[name].queryConfig.flattenProperties = true;
         repairData = true;
       } else {
-        printMessage(`- ${name}: OK`);
+        printMessage({
+          message: `- ${name}: OK`,
+          state
+        });
       }
     });
     return object;
@@ -1058,8 +1240,16 @@ async function repairOrgModelOrg({
         state
       });
     } catch (putConfigEntityError) {
-      printMessage(putConfigEntityError, 'error');
-      printMessage(`Error: ${putConfigEntityError}`, 'error');
+      printMessage({
+        message: putConfigEntityError,
+        type: 'error',
+        state
+      });
+      printMessage({
+        message: `Error: ${putConfigEntityError}`,
+        type: 'error',
+        state
+      });
     }
   }
   return repairData;
@@ -1099,7 +1289,11 @@ export async function repairOrgModel({
     await extendOrgModelPermissins(dryRun);
   }
   if (dryRun) {
-    printMessage('Dry-run only. Changes are not saved.', 'warn');
+    printMessage({
+      message: 'Dry-run only. Changes are not saved.',
+      type: 'warn',
+      state
+    });
   }
 }