dce-commonkit 4.4.0

package/lib/helpers/parallelLimit.js

@@ -0,0 +1,104 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Run tasks in parallel with a limit on how many tasks can execute at once.
+ *   No guarantees are made about the order of task execution
+ * @author Gabe Abrams
+ * @param taskFunctions functions that start asynchronous tasks and optionally
+ *   resolve with values
+ * @param [limit=no limit] maximum number of asynchronous tasks to permit to run at
+ *   once
+ * @returns array of resolved values in the same order as the task functions
+ */
+var parallelLimit = function (taskFunctions, limit) { return __awaiter(void 0, void 0, void 0, function () {
+    var results;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                results = [];
+                // Wait until finished with all tasks
+                return [4 /*yield*/, new Promise(function (resolve) {
+                        /* ------------- Helpers ------------ */
+                        var nextTaskIndex = 0;
+                        var numFinishedTasks = 0;
+                        /**
+                         * Start the next task
+                         * @author Gabe Abrams
+                         */
+                        var startTask = function () { return __awaiter(void 0, void 0, void 0, function () {
+                            var taskIndex, taskFunction, result;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        taskIndex = nextTaskIndex++;
+                                        taskFunction = taskFunctions[taskIndex];
+                                        if (!taskFunction) {
+                                            return [2 /*return*/];
+                                        }
+                                        return [4 /*yield*/, taskFunction()];
+                                    case 1:
+                                        result = _a.sent();
+                                        // Add results
+                                        results[taskIndex] = result;
+                                        // Tally and finish
+                                        if (++numFinishedTasks === taskFunctions.length) {
+                                            return [2 /*return*/, resolve()];
+                                        }
+                                        // Not finished! Start another task
+                                        startTask();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); };
+                        /* ----------- Start Tasks ---------- */
+                        // If no limit, start all tasks. At least start 1 task
+                        var numTasks = Math.max((limit || taskFunctions.length), 1);
+                        for (var i = 0; i < numTasks; i++) {
+                            startTask();
+                        }
+                    })];
+            case 1:
+                // Wait until finished with all tasks
+                _a.sent();
+                return [2 /*return*/, results];
+        }
+    });
+}); };
+exports.default = parallelLimit;
+//# sourceMappingURL=parallelLimit.js.map

package/lib/helpers/parallelLimit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parallelLimit.js","sourceRoot":"","sources":["../../src/helpers/parallelLimit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;GASG;AACH,IAAM,aAAa,GAAG,UACpB,aAAqC,EACrC,KAAc;;;;;gBAER,OAAO,GAAU,EAAE,CAAC;gBAE1B,qCAAqC;gBACrC,qBAAM,IAAI,OAAO,CAAO,UAAC,OAAO;wBAC9B,wCAAwC;wBAExC,IAAI,aAAa,GAAG,CAAC,CAAC;wBACtB,IAAI,gBAAgB,GAAG,CAAC,CAAC;wBACzB;;;2BAGG;wBACH,IAAM,SAAS,GAAG;;;;;wCACV,SAAS,GAAG,aAAa,EAAE,CAAC;wCAG5B,YAAY,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;wCAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;4CAClB,sBAAO;wCACT,CAAC;wCAGc,qBAAM,YAAY,EAAE,EAAA;;wCAA7B,MAAM,GAAG,SAAoB;wCAEnC,cAAc;wCACd,OAAO,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;wCAE5B,mBAAmB;wCACnB,IAAI,EAAE,gBAAgB,KAAK,aAAa,CAAC,MAAM,EAAE,CAAC;4CAChD,sBAAO,OAAO,EAAE,EAAC;wCACnB,CAAC;wCAED,mCAAmC;wCACnC,SAAS,EAAE,CAAC;;;;6BACb,CAAC;wBAEF,wCAAwC;wBAExC,sDAAsD;wBACtD,IAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;wBAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;4BAClC,SAAS,EAAE,CAAC;wBACd,CAAC;oBACH,CAAC,CAAC,EAAA;;gBAzCF,qCAAqC;gBACrC,SAwCE,CAAC;gBAEH,sBAAO,OAAO,EAAC;;;KAChB,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/lib/helpers/prefixWithAOrAn.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Prefix a word or name with "a" or "an" depending on whether it starts with a
+ *   vowel or not
+ * @author Gabe Abrams
+ * @param text the text to prefix
+ * @param capitalize whether to capitalize the "A" or "An"
+ * @returns the text prefixed with "a" or "an"
+ */
+declare const prefixWithAOrAn: (text: string, capitalize?: boolean) => string;
+export default prefixWithAOrAn;

package/lib/helpers/prefixWithAOrAn.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Constants
+var VOWELS = ['a', 'e', 'i', 'o', 'u'];
+/**
+ * Prefix a word or name with "a" or "an" depending on whether it starts with a
+ *   vowel or not
+ * @author Gabe Abrams
+ * @param text the text to prefix
+ * @param capitalize whether to capitalize the "A" or "An"
+ * @returns the text prefixed with "a" or "an"
+ */
+var prefixWithAOrAn = function (text, capitalize) {
+    if (capitalize === void 0) { capitalize = false; }
+    // Get the first letter
+    var firstLetter = text.charAt(0).toLowerCase();
+    // Check if starts with vowel
+    var startsWithVowel = VOWELS.includes(firstLetter);
+    // Determine prefix
+    var prefix = startsWithVowel ? 'an' : 'a';
+    if (capitalize) {
+        prefix = prefix.charAt(0).toUpperCase() + prefix.substring(1);
+    }
+    // Return the text prefixed with "a" or "an"
+    return "".concat(prefix, " ").concat(text);
+};
+exports.default = prefixWithAOrAn;
+//# sourceMappingURL=prefixWithAOrAn.js.map

package/lib/helpers/prefixWithAOrAn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefixWithAOrAn.js","sourceRoot":"","sources":["../../src/helpers/prefixWithAOrAn.ts"],"names":[],"mappings":";;AAAA,YAAY;AACZ,IAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAEzC;;;;;;;GAOG;AACH,IAAM,eAAe,GAAG,UAAC,IAAY,EAAE,UAAkB;IAAlB,2BAAA,EAAA,kBAAkB;IACvD,uBAAuB;IACvB,IAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAEjD,6BAA6B;IAC7B,IAAM,eAAe,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAErD,mBAAmB;IACnB,IAAI,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1C,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,4CAA4C;IAC5C,OAAO,UAAG,MAAM,cAAI,IAAI,CAAE,CAAC;AAC7B,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/lib/helpers/roundToNumDecimals.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Round a number to a certain number of decimals
+ * @author Gabe Abrams
+ * @param num the number to round
+ * @param numDecimals the number of decimals to round to
+ * @returns rounded number
+ */
+declare const roundToNumDecimals: (num: number, numDecimals: number) => number;
+export default roundToNumDecimals;

package/lib/helpers/roundToNumDecimals.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Round a number to a certain number of decimals
+ * @author Gabe Abrams
+ * @param num the number to round
+ * @param numDecimals the number of decimals to round to
+ * @returns rounded number
+ */
+var roundToNumDecimals = function (num, numDecimals) {
+    var rounder = Math.pow(10, numDecimals);
+    return (Math.round(num * rounder) / rounder);
+};
+exports.default = roundToNumDecimals;
+//# sourceMappingURL=roundToNumDecimals.js.map

package/lib/helpers/roundToNumDecimals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roundToNumDecimals.js","sourceRoot":"","sources":["../../src/helpers/roundToNumDecimals.ts"],"names":[],"mappings":";;AAAA;;;;;;GAMG;AACH,IAAM,kBAAkB,GAAG,UAAC,GAAW,EAAE,WAAmB;IAC1D,IAAM,OAAO,GAAG,SAAA,EAAE,EAAI,WAAW,CAAA,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/lib/helpers/shuffleArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shuffle a given array
+ * @author Austen Money
+ * @param arr the array to shuffle
+ * @returns the shuffled array
+ */
+declare const shuffleArray: <T>(arr: T[]) => T[];
+export default shuffleArray;

package/lib/helpers/shuffleArray.js

@@ -0,0 +1,29 @@
+"use strict";
+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 });
+/**
+ * Shuffle a given array
+ * @author Austen Money
+ * @param arr the array to shuffle
+ * @returns the shuffled array
+ */
+var shuffleArray = function (arr) {
+    var _a;
+    var newArr = __spreadArray([], arr, true);
+    // Shuffle using Durstenfeld algorithm
+    for (var i = arr.length - 1; i > 0; i--) {
+        var j = Math.floor(Math.random() * (i + 1));
+        _a = [newArr[j], newArr[i]], newArr[i] = _a[0], newArr[j] = _a[1];
+    }
+    return newArr;
+};
+exports.default = shuffleArray;
+//# sourceMappingURL=shuffleArray.js.map

package/lib/helpers/shuffleArray.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shuffleArray.js","sourceRoot":"","sources":["../../src/helpers/shuffleArray.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA;;;;;GAKG;AACH,IAAM,YAAY,GAAG,UAAI,GAAQ;;IAC/B,IAAM,MAAM,qBAAO,GAAG,OAAC,CAAC;IAExB,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,IAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9C,KAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAA9C,MAAM,CAAC,CAAC,CAAC,QAAA,EAAE,MAAM,CAAC,CAAC,CAAC,QAAA,CAA2B;IAClD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/lib/helpers/startMinWait.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Start a dynamic wait, call the function once the operation has completed and
+ *   the dynamic wait will continue waiting for the rest of the minimum time
+ * @author Gabe Abrams
+ * @param minWaitMs the minimum number of ms to wait
+ * @returns async function to call to finish the wait
+ */
+declare const startMinWait: (minWaitMs: number) => () => Promise<void>;
+export default startMinWait;

package/lib/helpers/startMinWait.js

@@ -0,0 +1,79 @@
+"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 other helpers
+var waitMs_1 = __importDefault(require("./waitMs"));
+/**
+ * Start a dynamic wait, call the function once the operation has completed and
+ *   the dynamic wait will continue waiting for the rest of the minimum time
+ * @author Gabe Abrams
+ * @param minWaitMs the minimum number of ms to wait
+ * @returns async function to call to finish the wait
+ */
+var startMinWait = function (minWaitMs) {
+    var startTimestamp = Date.now();
+    /**
+     * Finish the remaining time to wait
+     * @author Gabe Abrams
+     */
+    return function () { return __awaiter(void 0, void 0, void 0, function () {
+        var endTimestamp, elapsedTimeMs, remainingTimeToWaitMs;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    endTimestamp = Date.now();
+                    elapsedTimeMs = (endTimestamp - startTimestamp);
+                    remainingTimeToWaitMs = minWaitMs - elapsedTimeMs;
+                    if (remainingTimeToWaitMs <= 0) {
+                        return [2 /*return*/];
+                    }
+                    // Perform wait
+                    return [4 /*yield*/, (0, waitMs_1.default)(remainingTimeToWaitMs)];
+                case 1:
+                    // Perform wait
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+};
+exports.default = startMinWait;
+//# sourceMappingURL=startMinWait.js.map

package/lib/helpers/startMinWait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startMinWait.js","sourceRoot":"","sources":["../../src/helpers/startMinWait.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uBAAuB;AACvB,oDAA8B;AAE9B;;;;;;GAMG;AACH,IAAM,YAAY,GAAG,UAAC,SAAiB;IACrC,IAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAElC;;;OAGG;IACH,OAAO;;;;;oBACC,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAG1B,aAAa,GAAG,CAAC,YAAY,GAAG,cAAc,CAAC,CAAC;oBAChD,qBAAqB,GAAG,SAAS,GAAG,aAAa,CAAC;oBACxD,IAAI,qBAAqB,IAAI,CAAC,EAAE,CAAC;wBAC/B,sBAAO;oBACT,CAAC;oBAED,eAAe;oBACf,qBAAM,IAAA,gBAAM,EAAC,qBAAqB,CAAC,EAAA;;oBADnC,eAAe;oBACf,SAAmC,CAAC;;;;SACrC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/lib/helpers/stringsToHumanReadableList.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Create a human readable list from an array of strings.
+ *   For example, ['apple', 'orange'] becomes "apple and orange"
+ *   and ['apple', 'orange', 'mango'] becomes "apple, orange, and mango"
+ * @author Gabe Abrams
+ * @param items list of items in the list
+ * @returns human-readable list
+ */
+declare const stringsToHumanReadableList: (items: string[]) => string;
+export default stringsToHumanReadableList;

package/lib/helpers/stringsToHumanReadableList.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Create a human readable list from an array of strings.
+ *   For example, ['apple', 'orange'] becomes "apple and orange"
+ *   and ['apple', 'orange', 'mango'] becomes "apple, orange, and mango"
+ * @author Gabe Abrams
+ * @param items list of items in the list
+ * @returns human-readable list
+ */
+var stringsToHumanReadableList = function (items) {
+    // Handle 0-item case
+    if (items.length === 0) {
+        return '';
+    }
+    // Handle 1-item case
+    if (items.length === 1) {
+        return items[0];
+    }
+    // Handle 2-item case
+    if (items.length === 2) {
+        return "".concat(items[0], " and ").concat(items[1]);
+    }
+    // Handle 3+ item case
+    var list = '';
+    items.forEach(function (item, i) {
+        if (i === items.length - 1) {
+            // Last item
+            list += ", and ".concat(item);
+        }
+        // Previous items
+        list += ", ".concat(item);
+    });
+    return list;
+};
+exports.default = stringsToHumanReadableList;
+//# sourceMappingURL=stringsToHumanReadableList.js.map

package/lib/helpers/stringsToHumanReadableList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringsToHumanReadableList.js","sourceRoot":"","sources":["../../src/helpers/stringsToHumanReadableList.ts"],"names":[],"mappings":";;AAAA;;;;;;;GAOG;AACH,IAAM,0BAA0B,GAAG,UAAC,KAAe;IACjD,qBAAqB;IACrB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,qBAAqB;IACrB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,qBAAqB;IACrB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,UAAG,KAAK,CAAC,CAAC,CAAC,kBAAQ,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC;IACvC,CAAC;IAED,sBAAsB;IACtB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,YAAY;YACZ,IAAI,IAAI,gBAAS,IAAI,CAAE,CAAC;QAC1B,CAAC;QAED,iBAAiB;QACjB,IAAI,IAAI,YAAK,IAAI,CAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,kBAAe,0BAA0B,CAAC"}

package/lib/helpers/sum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sum the numbers in an array
+ * @author Gabe Abrams
+ * @param nums the numbers to sum
+ * @returns the sum of the numbers
+ */
+declare const sum: (nums: number[]) => number;
+export default sum;

package/lib/helpers/sum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Sum the numbers in an array
+ * @author Gabe Abrams
+ * @param nums the numbers to sum
+ * @returns the sum of the numbers
+ */
+var sum = function (nums) {
+    return nums.reduce(function (a, b) {
+        return (a + b);
+    }, 0);
+};
+exports.default = sum;
+//# sourceMappingURL=sum.js.map

package/lib/helpers/sum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sum.js","sourceRoot":"","sources":["../../src/helpers/sum.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,IAAM,GAAG,GAAG,UAAC,IAAc;IACzB,OAAO,IAAI,CAAC,MAAM,CAChB,UAAC,CAAS,EAAE,CAAS;QACnB,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACjB,CAAC,EACD,CAAC,CACF,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,GAAG,CAAC"}

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

@@ -0,0 +1,9 @@
+/**
+ * This function converts a string to title case based on Chicago Title Case
+ * Style rules.
+ * @author Leisha Bhandari
+ * @param input: The input string that needs to be converted to Chicago title
+ *               case.
+ * @returns Input string converted to title case
+ */
+declare const chicagoTitleCase: (input: string) => string;

package/lib/helpers/validators/ChicagoTitleCase.js

@@ -0,0 +1,31 @@
+/**
+ * This function converts a string to title case based on Chicago Title Case
+ * Style rules.
+ * @author Leisha Bhandari
+ * @param input: The input string that needs to be converted to Chicago title
+ *               case.
+ * @returns Input string converted to title case
+ */
+var chicagoTitleCase = function (input) {
+    // List of lowercase words according to Chicago Manual of Style
+    var lowerCaseWords = [
+        'in', 'nor', 'of', 'on', 'or', 'as', 'at', 'but', 'by',
+        'for', 'if', 'so', 'the', 'a', 'an', 'and', 'to', 'up',
+        'yet'
+    ];
+    return input
+        // Converts given input string to lowercase
+        .toLowerCase()
+        // Splits the given string into separate words
+        .split(' ')
+        .map(function (word, index, words) {
+        // Capitalize the first word, last word, and the words that aren't
+        // in lowerCaseWords
+        return index === 0 || !lowerCaseWords.includes(word) || index === words.length - 1
+            ? "".concat(word.charAt(0).toUpperCase()).concat(word.slice(1)) // Capitalize the first letter
+            : word;
+    } // Nothing happens to the word
+    )
+        .join(' '); // Joins the words back 
+};
+//# sourceMappingURL=ChicagoTitleCase.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChicagoTitleCase.js","sourceRoot":"","sources":["../../../src/helpers/validators/ChicagoTitleCase.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,IAAM,gBAAgB,GAAG,UAAC,KAAa;IACpC,+DAA+D;IAChE,IAAM,cAAc,GAAa;QAC/B,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI;QACtD,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI;QACtD,KAAK;KACN,CAAC;IAEF,OAAO,KAAK;QACV,2CAA2C;SAC1C,WAAW,EAAE;QACd,8CAA8C;SAC7C,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,UAAC,IAAI,EAAE,KAAK,EAAE,KAAK;QACtB,kEAAkE;QAClE,oBAAoB;QACpB,OAAA,KAAK,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC;YACzE,CAAC,CAAC,UAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,SAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,CAAC,8BAA8B;YAClF,CAAC,CAAC,IAAI;IAFR,CAEQ,CAAC,8BAA8B;KACxC;SACA,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,wBAAwB;AACxC,CAAC,CAAC"}

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

@@ -0,0 +1,79 @@
+// Importing the testing function
+// import chicagoTitleCase from './chicagoTitleCase';
+// // Import constants
+// import { INVALID_STRING_ERRORS, INVALID_REGEX_ERROR } from './shared/constants/ERROR_MESSAGES';
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Valid Tests --------------------------- */
+// /*------------------------------------------------------------------------*/
+// const validTests: { input: string, expected: string }[] = [
+//   {
+//     input: 'this is the american language',
+//     expected: 'This the American language',
+//   },
+//   {
+//     input: 'to kill a mockingbird',
+//     expected: 'To Kill a Mockingbird',
+//   },
+//   {
+//     input: 'the lord of the rings',
+//     expected: 'The Lord of the Rings',
+//   },
+//   {
+//     input: 'pride and prejudice',
+//     expected: 'Pride and Prejudice',
+//   },
+//   {
+//     input: 'the road not taken',
+//     expected: 'The Road Not Taken',
+//   },
+// ];
+// test(
+//   'Converts strings to Chicago title case correctly.',
+//   async () => {
+//     validTests.forEach(({ input, expected }) => {
+//       expect(chicagoTitleCase(input)).toBe(expected);
+//     });
+//   },
+// );
+// /*------------------------------------------------------------------------*/
+// /* ---------------------------- Edge Cases ---------------------------- */
+// /*------------------------------------------------------------------------*/
+// const edgeCases: { input: string, expected: string }[] = [
+//   {
+//     input: 'x',
+//     expected: 'X',
+//   },
+//   {
+//     input: ' ',
+//     expected: ' ',
+//   },
+//   {
+//     input: '',
+//     expected: '',
+//   },
+//   {
+//     input: 'the',
+//     expected: 'The',
+//   },
+//   {
+//     input: 'THE ROAD NOT TAKEN',
+//     expected: 'The Road Not Taken',
+//   },
+//   {
+//     input: 'tO kiLL A mOckingBirD',
+//     expected: 'To Kill a Mockingbird',
+//   },
+//   {
+//     input: 'pRiDe And pReduJiCe',
+//     expected: 'Pride and Prejudice',
+//   },
+// ];
+// test(
+//   'Handles the edge cases for the function that converts a string to Chicago Title Case.',
+//   async () => {
+//     edgeCases.forEach(({ input, expected }) => {
+//       expect(chicagoTitleCase(input)).toBe(expected);
+//     });
+//   },
+// );
+//# sourceMappingURL=ChicagoTitleCase.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ChicagoTitleCase.test.js","sourceRoot":"","sources":["../../../src/helpers/validators/ChicagoTitleCase.test.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,qDAAqD;AAErD,sBAAsB;AACtB,kGAAkG;AAElG,+EAA+E;AAC/E,6EAA6E;AAC7E,+EAA+E;AAE/E,8DAA8D;AAC9D,MAAM;AACN,8CAA8C;AAC9C,8CAA8C;AAC9C,OAAO;AACP,MAAM;AACN,sCAAsC;AACtC,yCAAyC;AACzC,OAAO;AACP,MAAM;AACN,sCAAsC;AACtC,yCAAyC;AACzC,OAAO;AACP,MAAM;AACN,oCAAoC;AACpC,uCAAuC;AACvC,OAAO;AACP,MAAM;AACN,mCAAmC;AACnC,sCAAsC;AACtC,OAAO;AACP,KAAK;AAEL,QAAQ;AACR,yDAAyD;AACzD,kBAAkB;AAClB,oDAAoD;AACpD,wDAAwD;AACxD,UAAU;AACV,OAAO;AACP,KAAK;AAEL,+EAA+E;AAC/E,6EAA6E;AAC7E,+EAA+E;AAE/E,6DAA6D;AAC7D,MAAM;AACN,kBAAkB;AAClB,qBAAqB;AACrB,OAAO;AACP,MAAM;AACN,kBAAkB;AAClB,qBAAqB;AACrB,OAAO;AACP,MAAM;AACN,iBAAiB;AACjB,oBAAoB;AACpB,OAAO;AACP,MAAM;AACN,oBAAoB;AACpB,uBAAuB;AACvB,OAAO;AACP,MAAM;AACN,mCAAmC;AACnC,sCAAsC;AACtC,OAAO;AACP,MAAM;AACN,sCAAsC;AACtC,yCAAyC;AACzC,OAAO;AACP,MAAM;AACN,oCAAoC;AACpC,uCAAuC;AACvC,OAAO;AACP,KAAK;AAEL,QAAQ;AACR,6FAA6F;AAC7F,kBAAkB;AAClB,mDAAmD;AACnD,wDAAwD;AACxD,UAAU;AACV,OAAO;AACP,KAAK"}

package/lib/helpers/validators/findURL.js

@@ -0,0 +1,39 @@
+// /**
+//  * This function finds URLs within a given string and returns an array of 
+//  * their locations.
+//  * @author Leisha Bhandari
+//  * @param block: The block of text to search for URLs
+//  * @returns Arrays where each of them contain the start and end index of the URL
+//  */
+// function findURLs(block: string): { start: number, end: number }[] {
+//   // Expression representing the skeleton of a URL to help match and find the  
+//   // URLs within the block of text (Also takes care of Unicode characters)
+//   const urlSkeleton = /(https?:\/\/[^\s\u0000-\u001F.,]+[^\s\u0000-\u001F.,]?(?:\?[^\s\u0000-\u001F]+)?(?:#[^\s\u0000-\u001F]+)?)/g;
+//   const found: { start: number, end: number }[] = [];
+//   let match: RegExpExecArray | null;
+//   // While loop to find the URLs in the given block of texts using the URL 
+//   // skeleton
+//   while ((match === urlSkeleton.exec(block)) 
+//          && match !== null) {
+//     // To find the beginning index of the URL
+//     let start = match.index;
+//     // To find the last index of the URL
+//     let end = match.index + match[0].length;
+//     // If statements to check whether the URL is followed by some kind of 
+//     // punctuation mark
+//     if (block.charAt(end) === '.' || /[,;:!?"]/.test(block.charAt(end))) {
+//       end--;
+//     }
+//     // While statement to make sure that the URL does not start with a 
+//     // punctuation mark
+//     while (start > 0 && /[.,:;!?]/.test(block.charAt(start - 1))) {
+//       start--;
+//     }
+//     // The object with start and end index of the URL is found and pushed to 
+//     // the found array
+//     found.push({ start, end });
+//   }
+//   // Returns the array of the found URLs location
+//   return found;
+// }
+//# sourceMappingURL=findURL.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"findURL.js","sourceRoot":"","sources":["../../../src/helpers/validators/findURL.ts"],"names":[],"mappings":"AAAA,MAAM;AACN,6EAA6E;AAC7E,sBAAsB;AACtB,6BAA6B;AAC7B,wDAAwD;AACxD,mFAAmF;AACnF,MAAM;AACN,uEAAuE;AACvE,kFAAkF;AAClF,6EAA6E;AAC7E,uIAAuI;AACvI,wDAAwD;AACxD,uCAAuC;AAEvC,8EAA8E;AAC9E,gBAAgB;AAChB,gDAAgD;AAChD,gCAAgC;AAChC,gDAAgD;AAChD,+BAA+B;AAC/B,2CAA2C;AAC3C,+CAA+C;AAE/C,6EAA6E;AAC7E,0BAA0B;AAC1B,6EAA6E;AAC7E,eAAe;AACf,QAAQ;AAER,0EAA0E;AAC1E,0BAA0B;AAC1B,sEAAsE;AACtE,iBAAiB;AACjB,QAAQ;AAER,gFAAgF;AAChF,yBAAyB;AACzB,kCAAkC;AAClC,MAAM;AAEN,oDAAoD;AACpD,kBAAkB;AAClB,IAAI"}