dce-commonkit 4.4.0

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

@@ -0,0 +1,123 @@
+"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 validatePhoneNumber_1 = __importDefault(require("./validatePhoneNumber"));
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Valid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var cleanedNumber = '1234567890';
+var cleanedNumberExt = '11234567890';
+var validPhoneNumbers = [
+    {
+        input: '1234567890',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '(123)-456-7890',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '123-456-7890',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '(123)456-7890',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '(123)4567890',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '    123456-7890 ',
+        cleaned: cleanedNumber,
+    },
+    {
+        input: '+1 123 456 7890',
+        cleaned: cleanedNumberExt,
+    },
+    {
+        input: '+1123456 7890',
+        cleaned: cleanedNumberExt,
+    },
+    {
+        input: '+1(123)456-7890',
+        cleaned: cleanedNumberExt,
+    },
+];
+test('Returns true for a given valid phone number and removes any non-digit characters.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        validPhoneNumbers.forEach(function (pair) {
+            var validResponse = {
+                isValid: true,
+                cleanedValue: pair.cleaned,
+            };
+            expect((0, validatePhoneNumber_1.default)(pair.input)).toStrictEqual(validResponse);
+        });
+        return [2 /*return*/];
+    });
+}); });
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Invalid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var invalidPhoneNumbers = [
+    '123456789',
+    '1234567894567890',
+    '1234-567-890',
+    '123456m78',
+    '123 4567 890',
+];
+var invalidResponse = {
+    isValid: false,
+    errorMessage: ERROR_MESSAGES_1.INVALID_PHONE_ERROR,
+};
+test('Returns false for a given valid phone number.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        invalidPhoneNumbers.forEach(function (phoneNumber) {
+            expect((0, validatePhoneNumber_1.default)(phoneNumber)).toStrictEqual(invalidResponse);
+        });
+        return [2 /*return*/];
+    });
+}); });
+//# sourceMappingURL=validatePhoneNumber.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validatePhoneNumber.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/validatePhoneNumber.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,mBAAmB;AACnB,oEAAwE;AAExE,kBAAkB;AAClB,8EAAwD;AAExD,4EAA4E;AAC5E,0EAA0E;AAC1E,4EAA4E;AAE5E,IAAM,aAAa,GAAG,YAAY,CAAC;AACnC,IAAM,gBAAgB,GAAG,aAAa,CAAC;AAEvC,IAAM,iBAAiB,GAAyC;IAC9D;QACE,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,kBAAkB;QACzB,OAAO,EAAE,aAAa;KACvB;IACD;QACE,KAAK,EAAE,iBAAiB;QACxB,OAAO,EAAE,gBAAgB;KAC1B;IACD;QACE,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,gBAAgB;KAC1B;IACD;QACE,KAAK,EAAE,iBAAiB;QACxB,OAAO,EAAE,gBAAgB;KAC1B;CACF,CAAC;AAEF,IAAI,CACF,mFAAmF,EACnF;;QACE,iBAAiB,CAAC,OAAO,CAAC,UAAC,IAAI;YAC7B,IAAM,aAAa,GAA6B;gBAC9C,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,IAAI,CAAC,OAAO;aAC3B,CAAC;YAEF,MAAM,CAAC,IAAA,6BAAmB,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;;;KACJ,CACF,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,IAAM,mBAAmB,GAAa;IACpC,WAAW;IACX,kBAAkB;IAClB,cAAc;IACd,WAAW;IACX,cAAc;CACf,CAAC;AAEF,IAAM,eAAe,GAA6B;IAChD,OAAO,EAAE,KAAK;IACd,YAAY,EAAE,oCAAmB;CAClC,CAAC;AAEF,IAAI,CACF,+CAA+C,EAC/C;;QACE,mBAAmB,CAAC,OAAO,CAAC,UAAC,WAAW;YACtC,MAAM,CAAC,IAAA,6BAAmB,EAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;;;KACJ,CACF,CAAC"}

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

@@ -0,0 +1,22 @@
+import ValidationResult from './shared/types/ValidationResult';
+/**
+ * Determines whether a given input string is considered valid based on
+ *   the provided requirements.
+ * @author Austen Money
+ * @param input input string
+ * @param opts options for validation
+ * @returns whether input is considered valid according to reqs - if
+ *   valid, returns a cleaned version of input; if invalid, returns
+ *   a string containing error messages describing which requirements
+ *   were not met.
+ */
+declare const validateString: (input: string, opts: {
+    ignoreWhitespace?: boolean;
+    minLen?: number;
+    maxLen?: number;
+    lettersOnly?: boolean;
+    numbersOnly?: boolean;
+    regexTest?: RegExp;
+    regexDescription?: string;
+}) => ValidationResult<string>;
+export default validateString;

package/lib/helpers/validators/validateString.js

@@ -0,0 +1,124 @@
+"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"));
+var genCommaList_1 = __importDefault(require("../genCommaList"));
+// Import constants
+var ERROR_MESSAGES_1 = require("./shared/constants/ERROR_MESSAGES");
+/*------------------------------------------------------------------------*/
+/* ------------------------------ Constants ----------------------------- */
+/*------------------------------------------------------------------------*/
+// define minimum and maximum range for lowercase ASCII chars
+var LOWERCASE_MIN = 65;
+var LOWERCASE_MAX = 90;
+// define minimum and maximum range for uppercase ASCII chars
+var UPPERCASE_MIN = 97;
+var UPPERCASE_MAX = 122;
+// define minimum and maximum range for ASCII digits
+var DIGIT_MIN = 48;
+var DIGIT_MAX = 57;
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Main Function --------------------------- */
+/*------------------------------------------------------------------------*/
+/**
+ * Determines whether a given input string is considered valid based on
+ *   the provided requirements.
+ * @author Austen Money
+ * @param input input string
+ * @param opts options for validation
+ * @returns whether input is considered valid according to reqs - if
+ *   valid, returns a cleaned version of input; if invalid, returns
+ *   a string containing error messages describing which requirements
+ *   were not met.
+ */
+var validateString = function (input, opts) {
+    // stores all invalid input errors
+    var errorMessages = [];
+    // contains version of input that will be returned
+    var cleanedValue = input;
+    // remove whitespace if required
+    if (opts.ignoreWhitespace) {
+        cleanedValue = input.replace(/\s+/g, '');
+    }
+    // apply max char requirement
+    if (opts.minLen) {
+        if (cleanedValue.length < opts.minLen) {
+            errorMessages.push(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MIN_LEN(opts.minLen));
+        }
+    }
+    // apply max char requirement
+    if (opts.maxLen) {
+        if (cleanedValue.length > opts.maxLen) {
+            errorMessages.push(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MAX_LEN(opts.maxLen));
+        }
+    }
+    // apply alphabetical requirement
+    if (opts.lettersOnly) {
+        // remove diacritics
+        cleanedValue = cleanedValue.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+        var containsNonLetters = (cleanedValue
+            // split into characters
+            .split('')
+            // convert into character codes
+            .map(function (curr) {
+            return curr.charCodeAt(0);
+        })
+            // check for non-letters
+            .some(function (currCode) {
+            return (!(currCode >= LOWERCASE_MIN && currCode <= LOWERCASE_MAX)
+                && !(currCode >= UPPERCASE_MIN && currCode <= UPPERCASE_MAX));
+        }));
+        if (containsNonLetters) {
+            errorMessages.push(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.LETTERS_ONLY);
+        }
+    }
+    // apply numerical requirement
+    if (opts.numbersOnly) {
+        var containsNonNumbers = (cleanedValue
+            // split into characters
+            .split('')
+            // convert into character codes
+            .map(function (curr) {
+            return curr.charCodeAt(0);
+        })
+            // check for non-numbers
+            .some(function (currCode) {
+            return (!(currCode >= DIGIT_MIN && currCode <= DIGIT_MAX));
+        }));
+        if (containsNonNumbers) {
+            errorMessages.push(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.NUMBERS_ONLY);
+        }
+    }
+    // apply regex requirement
+    if (opts.regexTest) {
+        var regex = opts.regexTest;
+        // validate and create customized error message if description is provided
+        var result = (0, validateRegex_1.default)({
+            input: cleanedValue,
+            regex: regex,
+            regexDescription: opts.regexDescription,
+        });
+        // if string did not pass regex validation, add error message
+        if (result.isValid === false) {
+            errorMessages.push(result.errorMessage);
+        }
+    }
+    // combine all error messages into one string to return
+    var errorMessage = "".concat(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MESSAGE_INTRO).concat((0, genCommaList_1.default)(errorMessages), ".");
+    return (
+    // if no error messages, string is valid; if not, it is invalid
+    errorMessages.length === 0
+        ? {
+            isValid: true,
+            cleanedValue: cleanedValue,
+        }
+        : {
+            isValid: false,
+            errorMessage: errorMessage,
+        });
+};
+exports.default = validateString;
+//# sourceMappingURL=validateString.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateString.js","sourceRoot":"","sources":["../../../src/helpers/validators/validateString.ts"],"names":[],"mappings":";;;;;AAAA,iBAAiB;AACjB,iFAA2D;AAC3D,iEAA2C;AAE3C,mBAAmB;AACnB,oEAA0E;AAK1E,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,6DAA6D;AAC7D,IAAM,aAAa,GAAG,EAAE,CAAC;AACzB,IAAM,aAAa,GAAG,EAAE,CAAC;AAEzB,6DAA6D;AAC7D,IAAM,aAAa,GAAG,EAAE,CAAC;AACzB,IAAM,aAAa,GAAG,GAAG,CAAC;AAE1B,oDAAoD;AACpD,IAAM,SAAS,GAAG,EAAE,CAAC;AACrB,IAAM,SAAS,GAAG,EAAE,CAAC;AAErB,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E;;;;;;;;;;GAUG;AACH,IAAM,cAAc,GAAG,UACrB,KAAa,EACb,IAgBC;IAED,kCAAkC;IAClC,IAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,kDAAkD;IAClD,IAAI,YAAY,GAAW,KAAK,CAAC;IAEjC,gCAAgC;IAChC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,6BAA6B;IAC7B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,IAAI,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACtC,aAAa,CAAC,IAAI,CAAC,sCAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,6BAA6B;IAC7B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,IAAI,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACtC,aAAa,CAAC,IAAI,CAAC,sCAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,iCAAiC;IACjC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,oBAAoB;QACpB,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAE7E,IAAM,kBAAkB,GAAG,CACzB,YAAY;YACV,wBAAwB;aACvB,KAAK,CAAC,EAAE,CAAC;YACV,+BAA+B;aAC9B,GAAG,CAAC,UAAC,IAAI;YACR,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC;YACF,wBAAwB;aACvB,IAAI,CAAC,UAAC,QAAQ;YACb,OAAO,CACL,CAAC,CAAC,QAAQ,IAAI,aAAa,IAAI,QAAQ,IAAI,aAAa,CAAC;mBACtD,CAAC,CAAC,QAAQ,IAAI,aAAa,IAAI,QAAQ,IAAI,aAAa,CAAC,CAC7D,CAAC;QACJ,CAAC,CAAC,CACL,CAAC;QAEF,IAAI,kBAAkB,EAAE,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,sCAAqB,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,8BAA8B;IAC9B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAM,kBAAkB,GAAG,CACzB,YAAY;YACV,wBAAwB;aACvB,KAAK,CAAC,EAAE,CAAC;YACV,+BAA+B;aAC9B,GAAG,CAAC,UAAC,IAAI;YACR,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC;YACF,wBAAwB;aACvB,IAAI,CAAC,UAAC,QAAQ;YACb,OAAO,CACL,CAAC,CAAC,QAAQ,IAAI,SAAS,IAAI,QAAQ,IAAI,SAAS,CAAC,CAClD,CAAC;QACJ,CAAC,CAAC,CACL,CAAC;QAEF,IAAI,kBAAkB,EAAE,CAAC;YACvB,aAAa,CAAC,IAAI,CAAC,sCAAqB,CAAC,YAAY,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,0BAA0B;IAC1B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,IAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC;QAE7B,0EAA0E;QAC1E,IAAM,MAAM,GAAG,IAAA,uBAAa,EAAC;YAC3B,KAAK,EAAE,YAAY;YACnB,KAAK,OAAA;YACL,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAC,CAAC;QAEH,6DAA6D;QAC7D,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC7B,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,uDAAuD;IACvD,IAAM,YAAY,GAAG,UAAG,sCAAqB,CAAC,aAAa,SAAG,IAAA,sBAAY,EAAC,aAAa,CAAC,MAAG,CAAC;IAE7F,OAAO;IACL,+DAA+D;IAC/D,aAAa,CAAC,MAAM,KAAK,CAAC;QACxB,CAAC,CAAC;YACA,OAAO,EAAE,IAAI;YACb,YAAY,cAAA;SACb;QACD,CAAC,CAAC;YACA,OAAO,EAAE,KAAK;YACd,YAAY,cAAA;SACb,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,cAAc,CAAC"}

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

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

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

@@ -0,0 +1,163 @@
+"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 helpers
+var genCommaList_1 = __importDefault(require("../genCommaList"));
+// Import constants
+var ERROR_MESSAGES_1 = require("./shared/constants/ERROR_MESSAGES");
+// Import function
+var validateString_1 = __importDefault(require("./validateString"));
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Valid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var validStrings = [
+    'users',
+    'username',
+    'MyValidString',
+    'HereisAnotherValidString',
+    'WoahAnotherValidStringIsHere',
+];
+var validReqs = [
+    {},
+    {
+        minLen: 5,
+    },
+    {
+        minLen: 5,
+        maxLen: 30,
+    },
+    {
+        minLen: 5,
+        maxLen: 30,
+        lettersOnly: true,
+    },
+    {
+        minLen: 5,
+        maxLen: 30,
+        lettersOnly: true,
+        numbersOnly: false,
+    },
+    {
+        minLen: 5,
+        maxLen: 30,
+        lettersOnly: true,
+        numbersOnly: false,
+        ignoreWhitespace: false,
+    },
+];
+test('Returns true for a given valid string.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    var validString, validResponse, validOpt;
+    return __generator(this, function (_a) {
+        validStrings.forEach(function (validString) {
+            validReqs.forEach(function (validReq) {
+                var validResponse = {
+                    isValid: true,
+                    cleanedValue: validString,
+                };
+                expect((0, validateString_1.default)(validString, validReq)).toStrictEqual(validResponse);
+            });
+        });
+        validString = 'A string with whitespace!';
+        validResponse = {
+            isValid: true,
+            cleanedValue: 'Astringwithwhitespace!',
+        };
+        validOpt = {
+            maxLen: 22,
+            ignoreWhitespace: true,
+        };
+        expect((0, validateString_1.default)(validString, validOpt)).toStrictEqual(validResponse);
+        return [2 /*return*/];
+    });
+}); });
+/*------------------------------------------------------------------------*/
+/* ---------------------------- Invalid Tests --------------------------- */
+/*------------------------------------------------------------------------*/
+var invalidStrings = [
+    {
+        input: 'ûšër',
+        reqs: {
+            minLen: 5,
+            lettersOnly: true,
+        },
+        error: [ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MIN_LEN(5)],
+    },
+    {
+        input: '123456789',
+        reqs: {
+            minLen: 10,
+            maxLen: 5,
+            lettersOnly: true,
+        },
+        error: [ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MIN_LEN(10), ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MAX_LEN(5), ERROR_MESSAGES_1.INVALID_STRING_ERRORS.LETTERS_ONLY],
+    },
+    {
+        input: 'String with non-letters!!',
+        reqs: {
+            lettersOnly: true,
+            numbersOnly: true,
+            ignoreWhitespace: true,
+        },
+        error: [ERROR_MESSAGES_1.INVALID_STRING_ERRORS.LETTERS_ONLY, ERROR_MESSAGES_1.INVALID_STRING_ERRORS.NUMBERS_ONLY],
+    },
+    {
+        input: '12345678',
+        reqs: {
+            lettersOnly: true,
+            regexTest: /^\s*(?:\+?(\d{1,3}))?[-. (]*(\d{3})[-. )]*(\d{3})[-. ]*(\d{4})(?: *x(\d+))?\s*$/,
+            regexDescription: 'should be a phone number',
+        },
+        error: [ERROR_MESSAGES_1.INVALID_STRING_ERRORS.LETTERS_ONLY, "".concat(ERROR_MESSAGES_1.INVALID_REGEX_ERROR, ": should be a phone number")],
+    },
+];
+test('Returns false for a given invalid string.', function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        invalidStrings.forEach(function (triple) {
+            var invalidResponse = {
+                isValid: false,
+                errorMessage: "".concat(ERROR_MESSAGES_1.INVALID_STRING_ERRORS.MESSAGE_INTRO).concat((0, genCommaList_1.default)(triple.error), "."),
+            };
+            expect((0, validateString_1.default)(triple.input, triple.reqs)).toStrictEqual(invalidResponse);
+        });
+        return [2 /*return*/];
+    });
+}); });
+//# sourceMappingURL=validateString.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateString.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/validateString.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iBAAiB;AACjB,iEAA2C;AAK3C,mBAAmB;AACnB,oEAA+F;AAE/F,kBAAkB;AAClB,oEAA8C;AAE9C,4EAA4E;AAC5E,0EAA0E;AAC1E,4EAA4E;AAE5E,IAAM,YAAY,GAAa;IAC7B,OAAO;IACP,UAAU;IACV,eAAe;IACf,0BAA0B;IAC1B,8BAA8B;CAC/B,CAAC;AAEF,IAAM,SAAS,GAeT;IACJ,EACC;IACD;QACE,MAAM,EAAE,CAAC;KACV;IACD;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;KACX;IACD;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;QACV,WAAW,EAAE,IAAI;KAClB;IACD;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;QACV,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;KACnB;IACD;QACE,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,EAAE;QACV,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;QAClB,gBAAgB,EAAE,KAAK;KACxB;CACF,CAAC;AAEF,IAAI,CACF,wCAAwC,EACxC;;;QACE,YAAY,CAAC,OAAO,CAAC,UAAC,WAAW;YAC/B,SAAS,CAAC,OAAO,CAAC,UAAC,QAAQ;gBACzB,IAAM,aAAa,GAA6B;oBAC9C,OAAO,EAAE,IAAI;oBACb,YAAY,EAAE,WAAW;iBAC1B,CAAC;gBAEF,MAAM,CAAC,IAAA,wBAAc,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YAC7E,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEG,WAAW,GAAG,2BAA2B,CAAC;QAE1C,aAAa,GAA6B;YAC9C,OAAO,EAAE,IAAI;YACb,YAAY,EAAE,wBAAwB;SACvC,CAAC;QAEI,QAAQ,GAAG;YACf,MAAM,EAAE,EAAE;YACV,gBAAgB,EAAE,IAAI;SACvB,CAAC;QAEF,MAAM,CAAC,IAAA,wBAAc,EAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;;;KAC5E,CACF,CAAC;AAEF,4EAA4E;AAC5E,4EAA4E;AAC5E,4EAA4E;AAE5E,IAAM,cAAc,GAmBd;IACJ;QACE,KAAK,EAAE,MAAM;QACb,IAAI,EAAE;YACJ,MAAM,EAAE,CAAC;YACT,WAAW,EAAE,IAAI;SAClB;QACD,KAAK,EAAE,CAAC,sCAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KAC1C;IACD;QACE,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE;YACJ,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,CAAC;YACT,WAAW,EAAE,IAAI;SAClB;QACD,KAAK,EAAE,CAAC,sCAAqB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,sCAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,sCAAqB,CAAC,YAAY,CAAC;KACjH;IACD;QACE,KAAK,EAAE,2BAA2B;QAClC,IAAI,EAAE;YACJ,WAAW,EAAE,IAAI;YACjB,WAAW,EAAE,IAAI;YACjB,gBAAgB,EAAE,IAAI;SACvB;QACD,KAAK,EAAE,CAAC,sCAAqB,CAAC,YAAY,EAAE,sCAAqB,CAAC,YAAY,CAAC;KAChF;IACD;QACE,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE;YACJ,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,iFAAiF;YAC5F,gBAAgB,EAAE,0BAA0B;SAC7C;QACD,KAAK,EAAE,CAAC,sCAAqB,CAAC,YAAY,EAAE,UAAG,oCAAmB,+BAA4B,CAAC;KAChG;CACF,CAAC;AAEF,IAAI,CACF,2CAA2C,EAC3C;;QACE,cAAc,CAAC,OAAO,CAAC,UAAC,MAAM;YAC5B,IAAM,eAAe,GAA6B;gBAChD,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,UAAG,sCAAqB,CAAC,aAAa,SAAG,IAAA,sBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,MAAG;aACrF,CAAC;YAEF,MAAM,CAAC,IAAA,wBAAc,EAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;;;KACJ,CACF,CAAC"}

package/lib/helpers/waitMs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Wait for a certain number of ms
+ * @author Gabe Abrams
+ * @param ms number of ms to wait
+ */
+declare const waitMs: (ms?: number) => Promise<unknown>;
+export default waitMs;

package/lib/helpers/waitMs.js

@@ -0,0 +1,68 @@
+"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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Wait for a certain number of ms
+ * @author Gabe Abrams
+ * @param ms number of ms to wait
+ */
+var waitMs = function () {
+    var args_1 = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args_1[_i] = arguments[_i];
+    }
+    return __awaiter(void 0, __spreadArray([], args_1, true), void 0, function (ms) {
+        if (ms === void 0) { ms = 0; }
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve) {
+                    setTimeout(resolve, ms);
+                })];
+        });
+    });
+};
+exports.default = waitMs;
+//# sourceMappingURL=waitMs.js.map

package/lib/helpers/waitMs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitMs.js","sourceRoot":"","sources":["../../src/helpers/waitMs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;GAIG;AACH,IAAM,MAAM,GAAG;;;;;gFAAO,EAAM;QAAN,mBAAA,EAAA,MAAM;;YAC1B,sBAAO,IAAI,OAAO,CAAC,UAAC,OAAO;oBACzB,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC1B,CAAC,CAAC,EAAC;;;CACJ,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,63 @@
+import ErrorWithCode from './errors/ErrorWithCode';
+import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
+import HOUR_IN_MS from './constants/HOUR_IN_MS';
+import DAY_IN_MS from './constants/DAY_IN_MS';
+import LOG_REVIEW_ROUTE_PATH_PREFIX from './constants/LOG_REVIEW_ROUTE_PATH_PREFIX';
+import LOG_ROUTE_PATH from './constants/LOG_ROUTE_PATH';
+import LOG_REVIEW_STATUS_ROUTE from './constants/LOG_REVIEW_STATUS_ROUTE';
+import LOG_REVIEW_GET_LOGS_ROUTE from './constants/LOG_REVIEW_GET_LOGS_ROUTE';
+import SELECT_ADMIN_CHECK_ROUTE from './constants/SELECT_ADMIN_CHECK_ROUTE';
+import abbreviate from './helpers/abbreviate';
+import avg from './helpers/avg';
+import ceilToNumDecimals from './helpers/ceilToNumDecimals';
+import floorToNumDecimals from './helpers/floorToNumDecimals';
+import forceNumIntoBounds from './helpers/forceNumIntoBounds';
+import padDecimalZeros from './helpers/padDecimalZeros';
+import padZerosLeft from './helpers/padZerosLeft';
+import roundToNumDecimals from './helpers/roundToNumDecimals';
+import sum from './helpers/sum';
+import waitMs from './helpers/waitMs';
+import getOrdinal from './helpers/getOrdinal';
+import getTimeInfoInET from './helpers/getTimeInfoInET';
+import startMinWait from './helpers/startMinWait';
+import getHumanReadableDate from './helpers/getHumanReadableDate';
+import getPartOfDay from './helpers/getPartOfDay';
+import stringsToHumanReadableList from './helpers/stringsToHumanReadableList';
+import onlyKeepLetters from './helpers/onlyKeepLetters';
+import parallelLimit from './helpers/parallelLimit';
+import getMonthName from './helpers/getMonthName';
+import genCSV from './helpers/genCSV';
+import extractProp from './helpers/extractProp';
+import compareArraysByProp from './helpers/compareArraysByProp';
+import getLocalTimeInfo from './helpers/getLocalTimeInfo';
+import genCommaList from './helpers/genCommaList';
+import validateEmail from './helpers/validators/validateEmail';
+import validatePhoneNumber from './helpers/validators/validatePhoneNumber';
+import validateString from './helpers/validators/validateString';
+import idify from './helpers/idify';
+import prefixWithAOrAn from './helpers/prefixWithAOrAn';
+import everyAsync from './helpers/asyncArrayFunctions/everyAsync';
+import filterAsync from './helpers/asyncArrayFunctions/filterAsync';
+import forEachAsync from './helpers/asyncArrayFunctions/forEachAsync';
+import mapAsync from './helpers/asyncArrayFunctions/mapAsync';
+import someAsync from './helpers/asyncArrayFunctions/someAsync';
+import capitalize from './helpers/capitalize';
+import shuffleArray from './helpers/shuffleArray';
+import getWordCount from './helpers/getWordCount';
+import cloneDeep from './helpers/cloneDeep';
+import getTimestampFromTimeInfoInET from './helpers/getTimestampFromTimeInfoInET';
+import ParamType from './types/ParamType';
+import DayOfWeek from './types/DayOfWeek';
+import Log from './types/Log';
+import LogType from './types/LogType';
+import LogSource from './types/LogSource';
+import LogAction from './types/LogAction';
+import LogBuiltInMetadata from './types/LogBuiltInMetadata';
+import LogMetadataType from './types/LogMetadataType';
+import LogFunction from './types/LogFunction';
+import LogTypeSpecificInfo from './types/Log/LogTypeSpecificInfo';
+import LogMainInfo from './types/Log/LogMainInfo';
+import LogSourceSpecificInfo from './types/Log/LogSourceSpecificInfo';
+import LogLevel from './types/LogLevel';
+import CommonKitErrorCode from './types/CommonKitErrorCode';
+export { ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, LOG_REVIEW_ROUTE_PATH_PREFIX, LOG_ROUTE_PATH, LOG_REVIEW_STATUS_ROUTE, LOG_REVIEW_GET_LOGS_ROUTE, SELECT_ADMIN_CHECK_ROUTE, CommonKitErrorCode, ParamType, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, LogTypeSpecificInfo, LogMainInfo, LogSourceSpecificInfo, LogLevel, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, getWordCount, cloneDeep, getTimestampFromTimeInfoInET, };