feat: isValidUUID

adobe · Jan 9, 2025 · f85ac7a · f85ac7a
1 parent 5e70a51
commit f85ac7a
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/spacecat-shared-utils/package.json b/packages/spacecat-shared-utils/package.json
@@ -49,6 +49,7 @@
     "@aws-sdk/client-secrets-manager": "3.721.0",
     "@aws-sdk/client-sqs": "3.721.0",
     "@json2csv/plainjs": "7.0.6",
-    "aws-xray-sdk": "3.10.2"
+    "aws-xray-sdk": "3.10.2",
+    "uuid": "11.0.4"
   }
 }
diff --git a/packages/spacecat-shared-utils/src/functions.js b/packages/spacecat-shared-utils/src/functions.js
@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import { validate as uuidValidate } from 'uuid';
+
 // Precompile regular expressions
 const REGEX_ISO_DATE = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/;
 const REGEX_TIME_OFFSET_DATE = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}(Z|[+-]\d{2}:\d{2})/;
@@ -194,6 +196,15 @@ function isValidUrl(urlString) {
   }
 }
 
+/**
+ * Validates whether the given string is a valid UUID.
+ * @param {string} uuid - The string to validate.
+ * @return {boolean} True if the given string is a valid UUID.
+ */
+function isValidUUID(uuid) {
+  return uuidValidate(uuid);
+}
+
 /**
  * Converts a given value to a boolean. Throws an error if the value is not a boolean.
  *
@@ -257,5 +268,6 @@ export {
   isString,
   isValidDate,
   isValidUrl,
+  isValidUUID,
   toBoolean,
 };
diff --git a/packages/spacecat-shared-utils/src/index.d.ts b/packages/spacecat-shared-utils/src/index.d.ts
@@ -43,6 +43,8 @@ export function toBoolean(value: unknown): boolean;
 
 export function isValidUrl(urlString: string): boolean;
 
+export function isValidUUID(uuid: string): boolean;
+
 export function dateAfterDays(days: number, dateString: string): Date;
 
 export function deepEqual(a: unknown, b: unknown): boolean;

diff --git a/packages/spacecat-shared-utils/src/index.js b/packages/spacecat-shared-utils/src/index.js
@@ -27,6 +27,7 @@ export {
   isString,
   isValidDate,
   isValidUrl,
+  isValidUUID,
   toBoolean,
 } from './functions.js';
 

diff --git a/packages/spacecat-shared-utils/test/functions.test.js b/packages/spacecat-shared-utils/test/functions.test.js
@@ -33,6 +33,7 @@ import {
   isString,
   isValidDate,
   isValidUrl,
+  isValidUUID,
   toBoolean,
 } from '../src/index.js';
 
@@ -320,6 +321,25 @@ describe('Shared functions', () => {
     });
   });
 
+  describe('isValidUUID', () => {
+    it('returns false for invalid UUID', async () => {
+      const invalidUUIDs = [
+        null,
+        undefined,
+        1234,
+        true,
+        'invalid uuid',
+        '123e4567-e89b-12d3-a456-42661417',
+      ];
+
+      invalidUUIDs.forEach((uuid) => expect(isValidUUID(uuid)).to.be.false);
+    });
+
+    it('returns true for valid UUID', async () => {
+      expect(isValidUUID('123e4567-e89b-12d3-a456-426614174000')).to.be.true;
+    });
+  });
+
   describe('dateAfterDays', () => {
     const sandbox = sinon.createSandbox();
 

diff --git a/packages/spacecat-shared-utils/test/index.test.js b/packages/spacecat-shared-utils/test/index.test.js
@@ -39,6 +39,7 @@ describe('Index Exports', () => {
     'isString',
     'isValidDate',
     'isValidUrl',
+    'isValidUUID',
     'logWrapper',
     'prependSchema',
     'resolveCustomerSecretsName',