dce-commonkit 4.4.0

package/lib/helpers/validators/findURL.test.js

@@ -0,0 +1,77 @@
+// Import the function to be tested
+// import findURLs from './findURL';
+// // Import constants
+// import { INVALID_STRING_ERRORS, INVALID_REGEX_ERROR } from './shared/constants/ERROR_MESSAGES';
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Valid Tests --------------------------- */
+// /*------------------------------------------------------------------------*/
+// const validTests: { block: string, expected: { start: number, end: number }[] }[] = [
+//   {
+//     block: 'Visit http://example.com for more information.',
+//     expected: [{ start: 6, end: 23 }],
+//   },
+//   {
+//     block: 'Multiple URLs: http://one.com and http://two.com.',
+//     expected: [
+//       { start: 15, end: 29 },
+//       { start: 34, end: 48 },
+//     ],
+//   },
+//   {
+//     block: 'Localhost URLs: http://localhost and http://127.0.0.1.',
+//     expected: [
+//       { start: 16, end: 31 },
+//       { start: 36, end: 52 },
+//     ],
+//   },
+//   {
+//     block: 'Embedded URL: text https://embedded-url.com?query=1&value=2.',
+//     expected: [{ start: 13, end: 51 }],
+//   },
+//   {
+//     block: 'Secure site: https://secure-site.com/path?query=string#fragment',
+//     expected: [{ start: 13, end: 58 }],
+//   },
+// ];
+// test(
+//   'Returns correct start and end indices for valid URLs within a string.',
+//   async () => {
+//     validTests.forEach(({ block, expected }) => {
+//       expect(findURLs(block)).toStrictEqual(expected);
+//     });
+//   },
+// );
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Invalid Tests --------------------------- */
+// /*------------------------------------------------------------------------*/
+// const invalidTests: { block: string, expected: { start: number, end: number }[] }[] = [
+//   {
+//     block: 'No URL.',
+//     expected: [],
+//   },
+//   {
+//     block: 'URL format is wrong: http:/example.com and htt://example.com.',
+//     expected: [],
+//   },
+//   {
+//     block: 'Any punctuation after the URL http://example.com, should not count.',
+//     expected: [{ start: 20, end: 37 }],
+//   },
+//   {
+//     block: 'Starting punctuation ,http://example.com should not count.',
+//     expected: [{ start: 22, end: 39 }],
+//   },
+//   {
+//     block: 'Spaces in the middle http://exa mple.com is invalid.',
+//     expected: [],
+//   },
+// ];
+// test(
+//   'Returns empty array for strings without valid URLs.',
+//   async () => {
+//     invalidTests.forEach(({ block, expected }) => {
+//       expect(findURLs(block)).toStrictEqual(expected);
+//     });
+//   },
+// );
+//# sourceMappingURL=findURL.test.js.map

package/lib/helpers/validators/findURL.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findURL.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/findURL.test.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,oCAAoC;AAEpC,sBAAsB;AACtB,kGAAkG;AAElG,+EAA+E;AAC/E,6EAA6E;AAC7E,+EAA+E;AAE/E,wFAAwF;AACxF,MAAM;AACN,+DAA+D;AAC/D,yCAAyC;AACzC,OAAO;AACP,MAAM;AACN,kEAAkE;AAClE,kBAAkB;AAClB,gCAAgC;AAChC,gCAAgC;AAChC,SAAS;AACT,OAAO;AACP,MAAM;AACN,uEAAuE;AACvE,kBAAkB;AAClB,gCAAgC;AAChC,gCAAgC;AAChC,SAAS;AACT,OAAO;AACP,MAAM;AACN,6EAA6E;AAC7E,0CAA0C;AAC1C,OAAO;AACP,MAAM;AACN,gFAAgF;AAChF,0CAA0C;AAC1C,OAAO;AACP,KAAK;AAEL,QAAQ;AACR,6EAA6E;AAC7E,kBAAkB;AAClB,oDAAoD;AACpD,yDAAyD;AACzD,UAAU;AACV,OAAO;AACP,KAAK;AAEL,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAE/E,0FAA0F;AAC1F,MAAM;AACN,wBAAwB;AACxB,oBAAoB;AACpB,OAAO;AACP,MAAM;AACN,8EAA8E;AAC9E,oBAAoB;AACpB,OAAO;AACP,MAAM;AACN,oFAAoF;AACpF,0CAA0C;AAC1C,OAAO;AACP,MAAM;AACN,2EAA2E;AAC3E,0CAA0C;AAC1C,OAAO;AACP,MAAM;AACN,qEAAqE;AACrE,oBAAoB;AACpB,OAAO;AACP,KAAK;AAEL,QAAQ;AACR,2DAA2D;AAC3D,kBAAkB;AAClB,sDAAsD;AACtD,yDAAyD;AACzD,UAAU;AACV,OAAO;AACP,KAAK"}

package/lib/helpers/validators/shared/constants/ERROR_MESSAGES.d.ts

@@ -0,0 +1,10 @@
+export declare const INVALID_REGEX_ERROR = "input does not follow the requested format";
+export declare const INVALID_EMAIL_ERROR = "Please provide a valid email address.";
+export declare const INVALID_PHONE_ERROR = "Please provide a valid phone number.";
+export declare const INVALID_STRING_ERRORS: {
+    MIN_LEN: (minLen: number) => string;
+    MAX_LEN: (maxLen: number) => string;
+    LETTERS_ONLY: string;
+    NUMBERS_ONLY: string;
+    MESSAGE_INTRO: string;
+};

package/lib/helpers/validators/shared/constants/ERROR_MESSAGES.js

@@ -0,0 +1,21 @@
+"use strict";
+/*------------------------------------------------------------------------*/
+/* ------------------------------ Constants ----------------------------- */
+/*------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INVALID_STRING_ERRORS = exports.INVALID_PHONE_ERROR = exports.INVALID_EMAIL_ERROR = exports.INVALID_REGEX_ERROR = void 0;
+exports.INVALID_REGEX_ERROR = 'input does not follow the requested format';
+exports.INVALID_EMAIL_ERROR = 'Please provide a valid email address.';
+exports.INVALID_PHONE_ERROR = 'Please provide a valid phone number.';
+exports.INVALID_STRING_ERRORS = {
+    MIN_LEN: function (minLen) {
+        return "input must not be under ".concat(minLen, " character(s)");
+    },
+    MAX_LEN: function (maxLen) {
+        return "input must not be over ".concat(maxLen, " character(s)");
+    },
+    LETTERS_ONLY: 'input must only contain letters',
+    NUMBERS_ONLY: 'input must only contain numbers',
+    MESSAGE_INTRO: 'The following error(s) occurred: ',
+};
+//# sourceMappingURL=ERROR_MESSAGES.js.map

package/lib/helpers/validators/shared/constants/ERROR_MESSAGES.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERROR_MESSAGES.js","sourceRoot":"","sources":["../../../../../src/helpers/validators/shared/constants/ERROR_MESSAGES.ts"],"names":[],"mappings":";AAAA,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;;;AAE/D,QAAA,mBAAmB,GAAG,4CAA4C,CAAC;AACnE,QAAA,mBAAmB,GAAG,uCAAuC,CAAC;AAC9D,QAAA,mBAAmB,GAAG,sCAAsC,CAAC;AAC7D,QAAA,qBAAqB,GAAG;IACnC,OAAO,EAAE,UAAC,MAAc;QACtB,OAAO,kCAA2B,MAAM,kBAAe,CAAC;IAC1D,CAAC;IACD,OAAO,EAAE,UAAC,MAAc;QACtB,OAAO,iCAA0B,MAAM,kBAAe,CAAC;IACzD,CAAC;IACD,YAAY,EAAE,iCAAiC;IAC/C,YAAY,EAAE,iCAAiC;IAC/C,aAAa,EAAE,mCAAmC;CACnD,CAAC"}

package/lib/helpers/validators/shared/helpers/validateRegex.d.ts

@@ -0,0 +1,19 @@
+import ValidationResult from '../types/ValidationResult';
+/**
+ * Determines whether a given input string is considered valid based on
+ *   the provided regex.
+ * @author Austen Money
+ * @param opts object containing all args
+ * @param opts.input user-provided input to validate
+ * @param opts.regex regular expression to check against input
+ * @param [opts.regexDescription] description of what regexString is checking
+ *   for, used to customize error message
+ * @returns the unchanged input if valid, or a customized error message if
+ *   invalid
+ */
+declare const validateRegex: (opts: {
+    input: string;
+    regex: RegExp;
+    regexDescription?: string;
+}) => ValidationResult<string>;
+export default validateRegex;

package/lib/helpers/validators/shared/helpers/validateRegex.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import constants
+var ERROR_MESSAGES_1 = require("../constants/ERROR_MESSAGES");
+/**
+ * Determines whether a given input string is considered valid based on
+ *   the provided regex.
+ * @author Austen Money
+ * @param opts object containing all args
+ * @param opts.input user-provided input to validate
+ * @param opts.regex regular expression to check against input
+ * @param [opts.regexDescription] description of what regexString is checking
+ *   for, used to customize error message
+ * @returns the unchanged input if valid, or a customized error message if
+ *   invalid
+ */
+var validateRegex = function (opts) {
+    // customize error message in case of invalid input
+    var errorMessage = "".concat(ERROR_MESSAGES_1.INVALID_REGEX_ERROR).concat(opts.regexDescription
+        ? ': '
+        : '').concat(opts.regexDescription);
+    // return error message if test is invalid, or input string if valid
+    return (opts.regex.test(opts.input)
+        ? {
+            isValid: true,
+            cleanedValue: opts.input,
+        }
+        : {
+            isValid: false,
+            errorMessage: errorMessage,
+        });
+};
+exports.default = validateRegex;
+//# sourceMappingURL=validateRegex.js.map

package/lib/helpers/validators/shared/helpers/validateRegex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateRegex.js","sourceRoot":"","sources":["../../../../../src/helpers/validators/shared/helpers/validateRegex.ts"],"names":[],"mappings":";;AAGA,mBAAmB;AACnB,8DAAkE;AAElE;;;;;;;;;;;GAWG;AACH,IAAM,aAAa,GAAG,UACpB,IAIC;IAED,mDAAmD;IACnD,IAAM,YAAY,GAAG,UAAG,oCAAmB,SACzC,IAAI,CAAC,gBAAgB;QACnB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,EAAE,SACL,IAAI,CAAC,gBAAgB,CAAE,CAAC;IAE3B,oEAAoE;IACpE,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QACzB,CAAC,CAAC;YACA,OAAO,EAAE,IAAI;YACb,YAAY,EAAE,IAAI,CAAC,KAAK;SACzB;QACD,CAAC,CAAC;YACA,OAAO,EAAE,KAAK;YACd,YAAY,cAAA;SACb,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/lib/helpers/validators/shared/types/ValidationResult.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Result of a validation function.
+ * @author Austen Money
+ */
+type ValidationResult<CleanedValueType> = ({
+    isValid: true;
+    cleanedValue: CleanedValueType;
+} | {
+    isValid: false;
+    errorMessage: string;
+});
+export default ValidationResult;

package/lib/helpers/validators/shared/types/ValidationResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ValidationResult.js.map

package/lib/helpers/validators/shared/types/ValidationResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationResult.js","sourceRoot":"","sources":["../../../../../src/helpers/validators/shared/types/ValidationResult.ts"],"names":[],"mappings":""}

package/lib/helpers/validators/validURL.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This function checks if a given input string is a valid URL.
+ * @author Leisha Bhandari
+ * @param URL: The input string that needs checked as a URL or not.
+ * @returns A true boolean value if the input string is a valid URL, and a false
+ *          boolean value if the input string is a invalid URL
+ */
+declare function isValid(url: string): boolean;

package/lib/helpers/validators/validURL.js

@@ -0,0 +1,20 @@
+/**
+ * This function checks if a given input string is a valid URL.
+ * @author Leisha Bhandari
+ * @param URL: The input string that needs checked as a URL or not.
+ * @returns A true boolean value if the input string is a valid URL, and a false
+ *          boolean value if the input string is a invalid URL
+ */
+function isValid(url) {
+    // Uses the input URL to create a URL object
+    try {
+        new URL(url);
+        // URL constructor does not throw an error, so input URL is valid
+        return true;
+    }
+    catch (err) {
+        // URL constructor throws an error, so input URL is invalid
+        return false;
+    }
+}
+//# sourceMappingURL=validURL.js.map

package/lib/helpers/validators/validURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validURL.js","sourceRoot":"","sources":["../../../src/helpers/validators/validURL.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,GAAW;IAC1B,4CAA4C;IAC5C,IAAI,CAAC;QACH,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACb,iEAAiE;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,2DAA2D;QAC3D,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/lib/helpers/validators/validURL.test.js

@@ -0,0 +1,83 @@
+// Import the function to be tested
+// import isValid from './validURL';
+// // Import constants
+// import { INVALID_STRING_ERRORS, INVALID_REGEX_ERROR } from './shared/constants/ERROR_MESSAGES';
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Valid Tests --------------------------- */
+// /*------------------------------------------------------------------------*/
+// const validUrls: string[] = [
+//   'http://example.com',
+//   'https://example.com',
+//   'http://www.example.com',
+//   'https://www.example.com',
+//   'https://example.com/path',
+//   'http://example.com/path',
+//   'https://example.com?query=string',
+//   'http://example.com?query=string',
+//   'https://example.com#fragment',
+//   'http://example.com#fragment',
+//   'http://localhost',
+//   'https://localhost:3000',
+//   'http://localhost:3000',
+//   'http://127.0.0.1',
+//   'http://127.0.0.1:3000',
+//   'ftp://example.com/path',
+//   'ftp://example.com',
+//   'https://127.0.0.1:3000',
+//   'file:///C:/path/to/file'
+// ];
+// test(
+//   'Returns true for a given valid URL.',
+//   async () => {
+//     validUrls.forEach((url) => {
+//       expect(isValid(url)).toBe(true);
+//     });
+//   },
+// );
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Invalid Tests --------------------------- */
+// /*------------------------------------------------------------------------*/
+// const invalidUrls: string[] = [
+//   '',
+//   ' ',
+//   'example',
+//   'http://',
+//   'http://.',
+//   'http://..',
+//   'http://##/',
+//   'http://../',
+//   'http://??/',
+//   'http://#',
+//   'http://##',
+//   '//',
+//   '//a',
+//   '///a',
+//   '///',
+//   'http:///a',
+//   'http://www.foo.bar./',
+//   'http://foo.bar/foo(bar)baz quux',
+//   'http://3628126748',
+//   'http://.www.foo.bar/',
+//   'http://.www.foo.bar./',
+//   'http://123.123.123',
+//   'http://1.1.1.1.1',
+//   'http://example.com:99999',
+//   'http://example.com:80:80',
+//   'http://example.com::80',
+//   'http://example.com:-80',
+//   'http://-example.com',
+//   'http://example.com-',
+//   'http://example.com_',
+//   'http://example..com',
+//   'http://example.com.',
+//   'http://.example.com'
+// ];
+// test(
+//   'Returns false for a given invalid URL.',
+//   async () => {
+//     invalidUrls.forEach((url) => {
+//       expect(isValid(url)).toBe(false);
+//     });
+//   },
+// );
+//# sourceMappingURL=validURL.test.js.map

package/lib/helpers/validators/validURL.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validURL.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/validURL.test.ts"],"names":[],"mappings":"AACA,mCAAmC;AACnC,oCAAoC;AAEpC,sBAAsB;AACtB,kGAAkG;AAElG,+EAA+E;AAC/E,6EAA6E;AAC7E,+EAA+E;AAE/E,gCAAgC;AAChC,0BAA0B;AAC1B,2BAA2B;AAC3B,8BAA8B;AAC9B,+BAA+B;AAC/B,gCAAgC;AAChC,+BAA+B;AAC/B,wCAAwC;AACxC,uCAAuC;AACvC,oCAAoC;AACpC,mCAAmC;AACnC,wBAAwB;AACxB,8BAA8B;AAC9B,6BAA6B;AAC7B,wBAAwB;AACxB,6BAA6B;AAC7B,8BAA8B;AAC9B,yBAAyB;AACzB,8BAA8B;AAC9B,8BAA8B;AAC9B,KAAK;AAEL,QAAQ;AACR,2CAA2C;AAC3C,kBAAkB;AAClB,mCAAmC;AACnC,yCAAyC;AACzC,UAAU;AACV,OAAO;AACP,KAAK;AAEL,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAE/E,kCAAkC;AAClC,QAAQ;AACR,SAAS;AACT,eAAe;AACf,eAAe;AACf,gBAAgB;AAChB,iBAAiB;AACjB,kBAAkB;AAClB,kBAAkB;AAClB,kBAAkB;AAClB,gBAAgB;AAChB,iBAAiB;AACjB,UAAU;AACV,WAAW;AACX,YAAY;AACZ,WAAW;AACX,iBAAiB;AACjB,4BAA4B;AAC5B,uCAAuC;AACvC,yBAAyB;AACzB,4BAA4B;AAC5B,6BAA6B;AAC7B,0BAA0B;AAC1B,wBAAwB;AACxB,gCAAgC;AAChC,gCAAgC;AAChC,8BAA8B;AAC9B,8BAA8B;AAC9B,2BAA2B;AAC3B,2BAA2B;AAC3B,2BAA2B;AAC3B,2BAA2B;AAC3B,2BAA2B;AAC3B,0BAA0B;AAC1B,KAAK;AAEL,QAAQ;AACR,8CAA8C;AAC9C,kBAAkB;AAClB,qCAAqC;AACrC,0CAA0C;AAC1C,UAAU;AACV,OAAO;AACP,KAAK"}

package/lib/helpers/validators/validateEmail.d.ts

@@ -0,0 +1,11 @@
+import ValidationResult from './shared/types/ValidationResult';
+/**
+ * Determines whether a given email address is valid.
+ * @author Austen Money
+ * @param email email address to validate
+ * @returns whether email fulfills proper formatting requirements, includes a
+ *   cleaned version of the address without leading or trailing
+ *   whitespace if valid or an error message if invalid.
+ */
+declare const validateEmail: (email: string) => ValidationResult<string>;
+export default validateEmail;

package/lib/helpers/validators/validateEmail.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import helpers
+var validateRegex_1 = __importDefault(require("./shared/helpers/validateRegex"));
+// Import constants
+var ERROR_MESSAGES_1 = require("./shared/constants/ERROR_MESSAGES");
+/**
+ * Determines whether a given email address is valid.
+ * @author Austen Money
+ * @param email email address to validate
+ * @returns whether email fulfills proper formatting requirements, includes a
+ *   cleaned version of the address without leading or trailing
+ *   whitespace if valid or an error message if invalid.
+ */
+var validateEmail = function (email) {
+    // validation regex, sourced from HTML living standard: http://www.whatwg.org/specs/web-apps/current-work/multipage/forms.html#e-mail-state-(type=email)
+    // eslint-disable-next-line max-len
+    var emailRegex = /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
+    // remove leading and trailing whitespace
+    var cleanedValue = email.replace(/^\s+|\s+$/g, '');
+    // validate email with regex, and return error if not valid
+    return ((0, validateRegex_1.default)({
+        input: cleanedValue,
+        regex: emailRegex,
+    }).isValid
+        ? {
+            isValid: true,
+            cleanedValue: cleanedValue,
+        }
+        : {
+            isValid: false,
+            errorMessage: ERROR_MESSAGES_1.INVALID_EMAIL_ERROR,
+        });
+};
+exports.default = validateEmail;
+//# sourceMappingURL=validateEmail.js.map

package/lib/helpers/validators/validateEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateEmail.js","sourceRoot":"","sources":["../../../src/helpers/validators/validateEmail.ts"],"names":[],"mappings":";;;;;AAAA,iBAAiB;AACjB,iFAA2D;AAE3D,mBAAmB;AACnB,oEAAwE;AAKxE;;;;;;;GAOG;AACH,IAAM,aAAa,GAAG,UACpB,KAAa;IAEb,wJAAwJ;IACxJ,mCAAmC;IACnC,IAAM,UAAU,GAAG,uIAAuI,CAAC;IAE3J,yCAAyC;IACzC,IAAM,YAAY,GAAW,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE7D,2DAA2D;IAC3D,OAAO,CACL,IAAA,uBAAa,EACX;QACE,KAAK,EAAE,YAAY;QACnB,KAAK,EAAE,UAAU;KAClB,CACF,CAAC,OAAO;QACP,CAAC,CAAC;YACA,OAAO,EAAE,IAAI;YACb,YAAY,cAAA;SACb;QACD,CAAC,CAAC;YACA,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,oCAAmB;SAClC,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/lib/helpers/validators/validateEmail.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/helpers/validators/validateEmail.test.js

@@ -0,0 +1,140 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import constants
+var ERROR_MESSAGES_1 = require("./shared/constants/ERROR_MESSAGES");
+// Import function
+var validateEmail_1 = __importDefault(require("./validateEmail"));
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Valid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var validEmailPairs = [
+    {
+        input: 'username@gmail.com',
+        cleaned: 'username@gmail.com',
+    },
+    {
+        input: 'u@hotmail.org',
+        cleaned: 'u@hotmail.org',
+    },
+    {
+        input: '   username@gmail.com',
+        cleaned: 'username@gmail.com',
+    },
+    {
+        input: 'username@gmail.com        ',
+        cleaned: 'username@gmail.com',
+    },
+    {
+        input: ' username@gmail.com ',
+        cleaned: 'username@gmail.com',
+    },
+    {
+        input: 'username@harvard.edu',
+        cleaned: 'username@harvard.edu',
+    },
+    {
+        input: 'username@harvard.subdomain.edu',
+        cleaned: 'username@harvard.subdomain.edu',
+    },
+    {
+        input: '\nusername@harvard.subdomain.edu',
+        cleaned: 'username@harvard.subdomain.edu',
+    },
+    {
+        input: '\n\tusername@harvard.subdomain.edu',
+        cleaned: 'username@harvard.subdomain.edu',
+    },
+    {
+        input: 'username@harvard.subdomain.edu\n',
+        cleaned: 'username@harvard.subdomain.edu',
+    },
+    {
+        input: 'username@harvard.subdomain.edu\n\t',
+        cleaned: 'username@harvard.subdomain.edu',
+    },
+];
+test('Returns true for a given valid email and removes any leading or trailing whitespace.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        validEmailPairs.forEach(function (pair) {
+            var validResponse = {
+                isValid: true,
+                cleanedValue: pair.cleaned,
+            };
+            expect((0, validateEmail_1.default)(pair.input)).toStrictEqual(validResponse);
+        });
+        return [2 /*return*/];
+    });
+}); });
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Invalid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var invalidEmails = [
+    '',
+    ' ',
+    'gmail.com',
+    '@gmail.com ',
+    'username',
+    'username@.com',
+    'user name@gmail.com',
+    'username @gmail.com',
+    'username@ gmail.com',
+    'username@gmail .com',
+    'username\t@gmail.com',
+    'username\n@gmail.com',
+    'username@gmail\n.com',
+    'username@gmail.\tcom',
+    'user\nname@gmail.com',
+    'user\tname@gmail.com',
+];
+var invalidResponse = {
+    isValid: false,
+    errorMessage: ERROR_MESSAGES_1.INVALID_EMAIL_ERROR,
+};
+test('Returns false for a given invalid email.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        invalidEmails.forEach(function (email) {
+            expect((0, validateEmail_1.default)(email)).toStrictEqual(invalidResponse);
+        });
+        return [2 /*return*/];
+    });
+}); });
+//# sourceMappingURL=validateEmail.test.js.map

package/lib/helpers/validators/validateEmail.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateEmail.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/validateEmail.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,mBAAmB;AACnB,oEAAwE;AAExE,kBAAkB;AAClB,kEAA4C;AAE5C,4EAA4E;AAC5E,0EAA0E;AAC1E,4EAA4E;AAE5E,IAAM,eAAe,GAAyC;IAC5D;QACE,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,oBAAoB;KAC9B;IACD;QACE,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,eAAe;KACzB;IACD;QACE,KAAK,EAAE,uBAAuB;QAC9B,OAAO,EAAE,oBAAoB;KAC9B;IACD;QACE,KAAK,EAAE,4BAA4B;QACnC,OAAO,EAAE,oBAAoB;KAC9B;IACD;QACE,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,oBAAoB;KAC9B;IACD;QACE,KAAK,EAAE,sBAAsB;QAC7B,OAAO,EAAE,sBAAsB;KAChC;IACD;QACE,KAAK,EAAE,gCAAgC;QACvC,OAAO,EAAE,gCAAgC;KAC1C;IACD;QACE,KAAK,EAAE,kCAAkC;QACzC,OAAO,EAAE,gCAAgC;KAC1C;IACD;QACE,KAAK,EAAE,oCAAoC;QAC3C,OAAO,EAAE,gCAAgC;KAC1C;IACD;QACE,KAAK,EAAE,kCAAkC;QACzC,OAAO,EAAE,gCAAgC;KAC1C;IACD;QACE,KAAK,EAAE,oCAAoC;QAC3C,OAAO,EAAE,gCAAgC;KAC1C;CACF,CAAC;AAEF,IAAI,CACF,sFAAsF,EACtF;;QACE,eAAe,CAAC,OAAO,CAAC,UAAC,IAAI;YAC3B,IAAM,aAAa,GAA6B;gBAC9C,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,IAAI,CAAC,OAAO;aAC3B,CAAC;YAEF,MAAM,CAAC,IAAA,uBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;;;KACJ,CACF,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,IAAM,aAAa,GAAa;IAC9B,EAAE;IACF,GAAG;IACH,WAAW;IACX,aAAa;IACb,UAAU;IACV,eAAe;IACf,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;CACvB,CAAC;AAEF,IAAM,eAAe,GAA6B;IAChD,OAAO,EAAE,KAAK;IACd,YAAY,EAAE,oCAAmB;CAClC,CAAC;AAEF,IAAI,CACF,0CAA0C,EAC1C;;QACE,aAAa,CAAC,OAAO,CAAC,UAAC,KAAK;YAC1B,MAAM,CAAC,IAAA,uBAAa,EAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;;;KACJ,CACF,CAAC"}

package/lib/helpers/validators/validatePhoneNumber.d.ts

@@ -0,0 +1,11 @@
+import ValidationResult from './shared/types/ValidationResult';
+/**
+ * Determines whether a given phone number is valid.
+ * @author Austen Money
+ * @param phoneNumber phone number to validate
+ * @returns whether phone number is considered valid - if valid, also returns
+ *   a cleaned version of the number without any formatting. If invalid,
+ *   returns an error message.
+ */
+declare const validatePhoneNumber: (phoneNumber: string) => ValidationResult<string>;
+export default validatePhoneNumber;

package/lib/helpers/validators/validatePhoneNumber.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import helpers
+var validateRegex_1 = __importDefault(require("./shared/helpers/validateRegex"));
+// Import constants
+var ERROR_MESSAGES_1 = require("./shared/constants/ERROR_MESSAGES");
+/**
+ * Determines whether a given phone number is valid.
+ * @author Austen Money
+ * @param phoneNumber phone number to validate
+ * @returns whether phone number is considered valid - if valid, also returns
+ *   a cleaned version of the number without any formatting. If invalid,
+ *   returns an error message.
+ */
+var validatePhoneNumber = function (phoneNumber) {
+    // regex to validate phone number
+    var validationRegex = /^\s*(?:\+?(\d{1,3}))?[-. (]*(\d{3})[-. )]*(\d{3})[-. ]*(\d{4})(?: *x(\d+))?\s*$/;
+    // validate phone number with regex
+    var validationResponse = (0, validateRegex_1.default)({
+        input: phoneNumber,
+        regex: validationRegex,
+    });
+    // remove all non-digits from number
+    var cleanedValue = phoneNumber.replace(/\D/g, '');
+    // return cleaned value if valid, or error message if invalid
+    return (validationResponse.isValid
+        ? {
+            isValid: true,
+            cleanedValue: cleanedValue,
+        }
+        : {
+            isValid: false,
+            errorMessage: ERROR_MESSAGES_1.INVALID_PHONE_ERROR,
+        });
+};
+exports.default = validatePhoneNumber;
+//# sourceMappingURL=validatePhoneNumber.js.map

package/lib/helpers/validators/validatePhoneNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatePhoneNumber.js","sourceRoot":"","sources":["../../../src/helpers/validators/validatePhoneNumber.ts"],"names":[],"mappings":";;;;;AAAA,iBAAiB;AACjB,iFAA2D;AAE3D,mBAAmB;AACnB,oEAAwE;AAKxE;;;;;;;GAOG;AACH,IAAM,mBAAmB,GAAG,UAC1B,WAAmB;IAEnB,iCAAiC;IACjC,IAAM,eAAe,GAAG,iFAAiF,CAAC;IAE1G,mCAAmC;IACnC,IAAM,kBAAkB,GAAG,IAAA,uBAAa,EACtC;QACE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,eAAe;KACvB,CACF,CAAC;IAEF,oCAAoC;IACpC,IAAM,YAAY,GAAW,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAE5D,6DAA6D;IAC7D,OAAO,CACL,kBAAkB,CAAC,OAAO;QACxB,CAAC,CAAC;YACA,OAAO,EAAE,IAAI;YACb,YAAY,cAAA;SACb;QACD,CAAC,CAAC;YACA,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,oCAAmB;SAClC,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}

package/lib/helpers/validators/validatePhoneNumber.test.d.ts

@@ -0,0 +1 @@
+export {};