#984: refactoring

Accenture · Oct 11, 2023 · 9981086 · 9981086
1 parent 8e2670a
commit 9981086
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/docs/dist/documentation.md b/docs/dist/documentation.md
@@ -7837,7 +7837,7 @@ Util that contains logger and simple util methods
     * [.isFalse(attrValue)](#Util.isFalse) ⇒ <code>boolean</code>
     * [._isValidType(selectedType, [handleOutside])](#Util._isValidType) ⇒ <code>boolean</code>
     * [.getTypeAndSubType(selectedType)](#Util.getTypeAndSubType) ⇒ <code>Array.&lt;string&gt;</code>
-    * [.emailValidator(email)](#Util.emailValidator) ⇒ <code>boolean</code>
+    * [.isEmailValid(email)](#Util.isEmailValid) ⇒ <code>boolean</code>
     * [.getRetrieveTypeChoices()](#Util.getRetrieveTypeChoices) ⇒ <code>Array.&lt;TYPE.SupportedMetadataTypes&gt;</code>
     * [._createNewLoggerTransport([noLogFile])](#Util._createNewLoggerTransport) ⇒ <code>object</code>
     * [.startLogger([restart], [noLogFile])](#Util.startLogger) ⇒ <code>void</code>
@@ -7991,9 +7991,9 @@ helper that deals with extracting type and subtype
 | --- | --- | --- |
 | selectedType | <code>string</code> | "type" or "type-subtype" |
 
-<a name="Util.emailValidator"></a>
+<a name="Util.isEmailValid"></a>
 
-### Util.emailValidator(email) ⇒ <code>boolean</code>
+### Util.isEmailValid(email) ⇒ <code>boolean</code>
 helper that validates email address
 
 **Kind**: static method of [<code>Util</code>](#Util)  

diff --git a/lib/metadataTypes/Automation.js b/lib/metadataTypes/Automation.js
@@ -1730,7 +1730,7 @@ class Automation extends MetadataType {
                         (notification) => notification.notificationType == 'Complete'
                     )?.body;
                     for (const email of completionEmail) {
-                        if (oldCompletionEmails.includes(email) || !Util.emailValidator(email)) {
+                        if (oldCompletionEmails.includes(email) || !Util.isEmailValid(email)) {
                             Util.logger.info(
                                 ` ☇ skipping ${email}- this email address is already in the notifications or is not a valid email`
                             );
@@ -1748,7 +1748,7 @@ class Automation extends MetadataType {
                         (notification) => notification.notificationType == 'Error'
                     )?.body;
                     for (const email of errorEmail) {
-                        if (oldErrorEmails.includes(email) || !Util.emailValidator(email)) {
+                        if (oldErrorEmails.includes(email) || !Util.isEmailValid(email)) {
                             Util.logger.info(
                                 ` ☇ skipping ${email}- this email address is already in the notifications or is not a valid email`
                             );
@@ -1785,7 +1785,7 @@ class Automation extends MetadataType {
                 // completionEmail is an array even if there is only one email
                 if (completionEmail.length > 0) {
                     for (const email of completionEmail) {
-                        if (Util.emailValidator(email)) {
+                        if (Util.isEmailValid(email)) {
                             notificationBody.workers.push({
                                 programId: automationLegacyMapObj.metadata[key].id,
                                 notificationType: 'Complete',
@@ -1815,7 +1815,7 @@ class Automation extends MetadataType {
                 }
                 if (errorEmail.length > 0) {
                     for (const email of errorEmail) {
-                        if (Util.emailValidator(email)) {
+                        if (Util.isEmailValid(email)) {
                             notificationBody.workers.push({
                                 programId: automationLegacyMapObj.metadata[key].id,
                                 notificationType: 'Error',

diff --git a/lib/util/cli.js b/lib/util/cli.js
@@ -79,12 +79,12 @@ const Cli = {
                     return emails
                         .split(',')
                         .map((email) => {
-                            if (!Util.emailValidator(email)) {
+                            if (!Util.isEmailValid(email)) {
                                 Util.logger.info(` ☇ skipping ${email}' - invalid email address`);
                             }
                             return email.trim();
                         })
-                        .filter((email) => Util.emailValidator(email));
+                        .filter((email) => Util.isEmailValid(email));
                 },
             }
         );

diff --git a/lib/util/util.js b/lib/util/util.js
@@ -208,7 +208,7 @@ export const Util = {
      * @param {string} email email to validate
      * @returns {boolean} first elem is type, second elem is subType
      */
-    emailValidator(email) {
+    isEmailValid(email) {
         const regex = new RegExp(
             "^([!#-'*+/-9=?A-Z^-~-]+(.[!#-'*+/-9=?A-Z^-~-]+)*|\"([]!#-[^-~ \\t]|(\\[\\t -~]))+\")@([!#-'*+/-9=?A-Z^-~-]+(.[!#-'*+/-9=?A-Z^-~-]+)*|[[\\t -Z^-~]*])$"
         );