dce-commonkit 4.4.0

package/lib/helpers/asyncArrayFunctions/someAsync.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for any item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for any item, this function will return true
+ * @returns true if the operator function returns true for any item in the array
+ */
+declare const someAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: Array<T>;
+}) => Promise<any>) => Promise<boolean>;
+export default someAsync;

package/lib/helpers/asyncArrayFunctions/someAsync.js

@@ -0,0 +1,80 @@
+"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 the operator function on each item in the array, returning true if
+ *   the operator function returns true for any item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for any item, this function will return true
+ * @returns true if the operator function returns true for any item in the array
+ */
+var someAsync = function (array, operatorFunction) { return __awaiter(void 0, void 0, void 0, function () {
+    var done, breakNow, i, passed;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                done = false;
+                breakNow = function () {
+                    done = true;
+                };
+                i = 0;
+                _a.label = 1;
+            case 1:
+                if (!(i < array.length && !done)) return [3 /*break*/, 4];
+                return [4 /*yield*/, operatorFunction(array[i], i, {
+                        breakNow: breakNow,
+                        array: array,
+                    })];
+            case 2:
+                passed = _a.sent();
+                if (passed && !done) {
+                    return [2 /*return*/, true];
+                }
+                _a.label = 3;
+            case 3:
+                i++;
+                return [3 /*break*/, 1];
+            case 4: 
+            // Return false because none returned true
+            return [2 /*return*/, false];
+        }
+    });
+}); };
+exports.default = someAsync;
+//# sourceMappingURL=someAsync.js.map

package/lib/helpers/asyncArrayFunctions/someAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"someAsync.js","sourceRoot":"","sources":["../../../src/helpers/asyncArrayFunctions/someAsync.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;GAOG;AACH,IAAM,SAAS,GAAG,UAChB,KAAU,EACV,gBAOiB;;;;;gBAGb,IAAI,GAAG,KAAK,CAAC;gBAKX,QAAQ,GAAG;oBACf,IAAI,GAAG,IAAI,CAAC;gBACd,CAAC,CAAC;gBAGO,CAAC,GAAG,CAAC;;;qBAAE,CAAA,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAA;gBACxB,qBAAM,gBAAgB,CACnC,KAAK,CAAC,CAAC,CAAC,EACR,CAAC,EACD;wBACE,QAAQ,UAAA;wBACR,KAAK,OAAA;qBACN,CACF,EAAA;;gBAPK,MAAM,GAAG,SAOd;gBACD,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;oBACpB,sBAAO,IAAI,EAAC;gBACd,CAAC;;;gBAXwC,CAAC,EAAE,CAAA;;;YAc9C,0CAA0C;YAC1C,sBAAO,KAAK,EAAC;;;KACd,CAAC;AAEF,kBAAe,SAAS,CAAC"}

package/lib/helpers/asyncArrayFunctions/someAsync.test.d.ts

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

package/lib/helpers/asyncArrayFunctions/someAsync.test.js

@@ -0,0 +1,227 @@
+"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 });
+var waitMs_1 = __importDefault(require("../waitMs"));
+var someAsync_1 = __importDefault(require("./someAsync"));
+describe('someAsync', function () {
+    it('should return false if the array is empty', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, someAsync_1.default)([], function () {
+                        return Promise.resolve(true);
+                    })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return false if the operator function returns false for all items', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function () {
+                            return Promise.resolve(false);
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return true if the operator function returns true for any item', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function (item) {
+                            return Promise.resolve(item === 3);
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should pass the correct index to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function (item, index) {
+                            expect(index).toBeGreaterThanOrEqual(0);
+                            expect(index).toBeLessThan(array.length);
+                            return Promise.resolve(false);
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should pass the correct array to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function (item, index, _a) {
+                            var arr = _a.array;
+                            expect(arr).toBe(array);
+                            return Promise.resolve(false);
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should stop iterating and return true if the operator function returns true for an item and breakNow is called', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function (item, index, _a) {
+                            var breakNow = _a.breakNow;
+                            if (item === 3) {
+                                breakNow();
+                                return Promise.resolve(true);
+                            }
+                            return Promise.resolve(false);
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle asynchronous operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, (0, waitMs_1.default)(100)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/, Promise.resolve(item === 3)];
+                                }
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle rejected promises from the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function () {
+                            return Promise.reject(new Error('Test error'));
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle thrown errors from the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [1, 2, 3, 4, 5];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function () {
+                            throw new Error('Test error');
+                        })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle empty array and asynchronous operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var array, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    array = [];
+                    return [4 /*yield*/, (0, someAsync_1.default)(array, function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, (0, waitMs_1.default)(100)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/, Promise.resolve(false)];
+                                }
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=someAsync.test.js.map

package/lib/helpers/asyncArrayFunctions/someAsync.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"someAsync.test.js","sourceRoot":"","sources":["../../../src/helpers/asyncArrayFunctions/someAsync.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAA+B;AAC/B,0DAAoC;AAEpC,QAAQ,CAAC,WAAW,EAAE;IACpB,EAAE,CAAC,2CAA2C,EAAE;;;;wBAC/B,qBAAM,IAAA,mBAAS,EAAC,EAAE,EAAE;wBACjC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC/B,CAAC,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE;;;;;oBACvE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE;4BACpC,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBAChC,CAAC,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE;;;;;oBACpE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE,UAAC,IAAI;4BACzC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;wBACrC,CAAC,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE;;;;;oBACrD,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE,UAAC,IAAI,EAAE,KAAK;4BAChD,MAAM,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;4BACxC,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;4BACzC,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBAChC,CAAC,CAAC,EAAA;;oBAJI,MAAM,GAAG,SAIb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE;;;;;oBACrD,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE,UAAC,IAAI,EAAE,KAAK,EAAE,EAAc;gCAAL,GAAG,WAAA;4BAC9D,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;4BACxB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBAChC,CAAC,CAAC,EAAA;;oBAHI,MAAM,GAAG,SAGb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,gHAAgH,EAAE;;;;;oBAC7G,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE,UAAC,IAAI,EAAE,KAAK,EAAE,EAAY;gCAAV,QAAQ,cAAA;4BAC5D,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gCACf,QAAQ,EAAE,CAAC;gCACX,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;4BAC/B,CAAC;4BACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBAChC,CAAC,CAAC,EAAA;;oBANI,MAAM,GAAG,SAMb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE;;;;;oBAC3C,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE,UAAO,IAAI;;;4CAC/C,qBAAM,IAAA,gBAAM,EAAC,GAAG,CAAC,EAAA;;wCAAjB,SAAiB,CAAC;wCAClB,sBAAO,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,EAAC;;;6BACpC,CAAC,EAAA;;oBAHI,MAAM,GAAG,SAGb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE;;;;;oBACzD,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE;4BACpC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;wBACjD,CAAC,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE;;;;;oBACrD,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACf,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE;4BACpC,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;wBAChC,CAAC,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE;;;;;oBAC3D,KAAK,GAAa,EAAE,CAAC;oBACZ,qBAAM,IAAA,mBAAS,EAAC,KAAK,EAAE;;;4CACpC,qBAAM,IAAA,gBAAM,EAAC,GAAG,CAAC,EAAA;;wCAAjB,SAAiB,CAAC;wCAClB,sBAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;6BAC/B,CAAC,EAAA;;oBAHI,MAAM,GAAG,SAGb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/helpers/avg.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get the average of a set of numbers
+ * @author Gabe Abrams
+ * @param nums the numbers to average
+ * @returns average value or 0 if no numbers
+ */
+declare const avg: (nums: number[]) => number;
+export default avg;

package/lib/helpers/avg.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var sum_1 = __importDefault(require("./sum"));
+/**
+ * Get the average of a set of numbers
+ * @author Gabe Abrams
+ * @param nums the numbers to average
+ * @returns average value or 0 if no numbers
+ */
+var avg = function (nums) {
+    // Handle empty array case
+    if (nums.length === 0) {
+        return 0;
+    }
+    // Get the total value
+    var total = (0, sum_1.default)(nums);
+    // Get average
+    return (total / nums.length);
+};
+exports.default = avg;
+//# sourceMappingURL=avg.js.map

package/lib/helpers/avg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avg.js","sourceRoot":"","sources":["../../src/helpers/avg.ts"],"names":[],"mappings":";;;;;AAAA,8CAAwB;AAExB;;;;;GAKG;AACH,IAAM,GAAG,GAAG,UAAC,IAAc;IACzB,0BAA0B;IAC1B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,sBAAsB;IACtB,IAAM,KAAK,GAAG,IAAA,aAAG,EAAC,IAAI,CAAC,CAAC;IAExB,cAAc;IACd,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,kBAAe,GAAG,CAAC"}

package/lib/helpers/avg.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Unit tests for avg helper
+ * @author Gabe Abrams
+ */
+export {};

package/lib/helpers/avg.test.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * Unit tests for avg helper
+ * @author Gabe Abrams
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var avg_1 = __importDefault(require("./avg"));
+describe('helpers > avg', function () {
+    it('should return 0 for an empty array', function () {
+        expect((0, avg_1.default)([])).toEqual(0);
+    });
+    it('should return the correct average for an array of numbers', function () {
+        expect((0, avg_1.default)([1, 2, 3, 4, 5])).toEqual(3);
+    });
+    it('should handle negative numbers', function () {
+        expect((0, avg_1.default)([-1, 0, 1])).toEqual(0);
+    });
+    it('should handle decimal numbers', function () {
+        expect((0, avg_1.default)([1.5, 2.5, 3.5])).toEqual(2.5);
+    });
+});
+//# sourceMappingURL=avg.test.js.map

package/lib/helpers/avg.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avg.test.js","sourceRoot":"","sources":["../../src/helpers/avg.test.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,8CAAwB;AAExB,QAAQ,CAAC,eAAe,EAAE;IACxB,EAAE,CAAC,oCAAoC,EAAE;QACvC,MAAM,CAAC,IAAA,aAAG,EAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE;QAC9D,MAAM,CAAC,IAAA,aAAG,EAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE;QACnC,MAAM,CAAC,IAAA,aAAG,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE;QAClC,MAAM,CAAC,IAAA,aAAG,EAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/helpers/capitalize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Capitalize every word in a string (just the first letter)
+ * @param str string to capitalize
+ * @returns string with every word capitalized
+ */
+declare const capitalize: (str: string) => string;
+export default capitalize;

package/lib/helpers/capitalize.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Capitalize every word in a string (just the first letter)
+ * @param str string to capitalize
+ * @returns string with every word capitalized
+ */
+var capitalize = function (str) {
+    return (str
+        // Split into words
+        .split(' ')
+        // Capitalize first letter of each word
+        .map(function (word) {
+        return word.charAt(0).toUpperCase() + word.substring(1);
+    })
+        // Join back together
+        .join(' '));
+};
+exports.default = capitalize;
+//# sourceMappingURL=capitalize.js.map

package/lib/helpers/capitalize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capitalize.js","sourceRoot":"","sources":["../../src/helpers/capitalize.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,IAAM,UAAU,GAAG,UAAC,GAAW;IAC7B,OAAO,CACL,GAAG;QACD,mBAAmB;SAClB,KAAK,CAAC,GAAG,CAAC;QACX,uCAAuC;SACtC,GAAG,CAAC,UAAC,IAAI;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC;QACF,qBAAqB;SACpB,IAAI,CAAC,GAAG,CAAC,CACb,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,UAAU,CAAC"}

package/lib/helpers/ceilToNumDecimals.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Round a number (ceiling) 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 ceilToNumDecimals: (num: number, numDecimals: number) => number;
+export default ceilToNumDecimals;

package/lib/helpers/ceilToNumDecimals.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Round a number (ceiling) 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 ceilToNumDecimals = function (num, numDecimals) {
+    var rounder = Math.pow(10, numDecimals);
+    return (Math.ceil(num * rounder) / rounder);
+};
+exports.default = ceilToNumDecimals;
+//# sourceMappingURL=ceilToNumDecimals.js.map

package/lib/helpers/ceilToNumDecimals.js.map

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

package/lib/helpers/ceilToNumDecimals.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Test file for the ceilToNumDecimals helper
+ * @author Gabe Abrams
+ */
+export {};

package/lib/helpers/ceilToNumDecimals.test.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * Test file for the ceilToNumDecimals helper
+ * @author Gabe Abrams
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import main function
+var ceilToNumDecimals_1 = __importDefault(require("./ceilToNumDecimals"));
+describe('ceilToNumDecimals', function () {
+    it('should return 0 for 0 with 0 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(0, 0);
+        expect(result).toEqual(0);
+    });
+    it('should return 1 for 1 with 0 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(1, 0);
+        expect(result).toEqual(1);
+    });
+    it('should return 1.24 for 1.234 with 2 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(1.234, 2);
+        expect(result).toEqual(1.24);
+    });
+    it('should return -1.23 for -1.234 with 2 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(-1.234, 2);
+        expect(result).toEqual(-1.23);
+    });
+    it('should return 1234 for 1234 with 0 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(1234, 0);
+        expect(result).toEqual(1234);
+    });
+    it('should return 0.002 for 0.00123 with 3 decimals', function () {
+        var result = (0, ceilToNumDecimals_1.default)(0.00123, 3);
+        expect(result).toEqual(0.002);
+    });
+});
+//# sourceMappingURL=ceilToNumDecimals.test.js.map

package/lib/helpers/ceilToNumDecimals.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ceilToNumDecimals.test.js","sourceRoot":"","sources":["../../src/helpers/ceilToNumDecimals.test.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;AAEH,uBAAuB;AACvB,0EAAoD;AAEpD,QAAQ,CAAC,mBAAmB,EAAE;IAC5B,EAAE,CAAC,uCAAuC,EAAE;QAC1C,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE;QAC1C,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE;QACjD,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE;QACnD,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE;QAChD,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE;QACpD,IAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/helpers/cloneDeep.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Deeply clones an object
+ * @author Yuen Ler Chow
+ * @param obj the object to clone
+ * @returns a deep clone of the object
+ */
+declare const cloneDeep: <T>(obj: T) => T;
+export default cloneDeep;

package/lib/helpers/cloneDeep.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var nanoclone_1 = __importDefault(require("nanoclone"));
+/**
+ * Deeply clones an object
+ * @author Yuen Ler Chow
+ * @param obj the object to clone
+ * @returns a deep clone of the object
+ */
+var cloneDeep = nanoclone_1.default;
+exports.default = cloneDeep;
+//# sourceMappingURL=cloneDeep.js.map

package/lib/helpers/cloneDeep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloneDeep.js","sourceRoot":"","sources":["../../src/helpers/cloneDeep.ts"],"names":[],"mappings":";;;;;AAAA,wDAA8B;AAE9B;;;;;GAKG;AACH,IAAM,SAAS,GAAqB,mBAAK,CAAC;AAE1C,kBAAe,SAAS,CAAC"}

package/lib/helpers/compareArraysByProp.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Compare two arrays of objects by only comparing the values in a specific
+ *  property (e.g. compare user arrays by comparing their user.id values)
+ * @author Gabe Abrams
+ * @param a the first array
+ * @param b the second array
+ * @param prop the property to compare with, or an array of props to compare
+ *   with (if array, all values associated with those props must match)
+ * @returns true if the arrays contain the same objects as determined by
+ *   the values associated with each object's prop
+ */
+declare const compareArraysByProp: (a: any[], b: any[], prop: string | string[]) => boolean;
+export default compareArraysByProp;

package/lib/helpers/compareArraysByProp.js

@@ -0,0 +1,62 @@
+"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 });
+/**
+ * Compare two arrays of objects by only comparing the values in a specific
+ *  property (e.g. compare user arrays by comparing their user.id values)
+ * @author Gabe Abrams
+ * @param a the first array
+ * @param b the second array
+ * @param prop the property to compare with, or an array of props to compare
+ *   with (if array, all values associated with those props must match)
+ * @returns true if the arrays contain the same objects as determined by
+ *   the values associated with each object's prop
+ */
+var compareArraysByProp = function (a, b, prop) {
+    // Immediately return if size of arrays is different
+    if (a.length !== b.length) {
+        return false;
+    }
+    // Get all props
+    var props = (Array.isArray(prop) ? prop : [prop]);
+    // Clone second array so we can work on it
+    var bCloned = __spreadArray([], b, true);
+    var _loop_1 = function (i) {
+        // Find matching element in b
+        var matchingIndex = bCloned.findIndex(function (bItem) {
+            // Compare based on all props
+            return props.every(function (propToCompareBy) {
+                var _a;
+                var aVal = ((_a = a[i]) !== null && _a !== void 0 ? _a : {})[propToCompareBy];
+                var bVal = (bItem !== null && bItem !== void 0 ? bItem : {})[propToCompareBy];
+                return aVal === bVal;
+            });
+        });
+        // Check if no match
+        var noMatch = (matchingIndex < 0);
+        // If no match, there's no corresponding element in b
+        if (noMatch) {
+            return { value: false };
+        }
+        // Remove the matching element
+        bCloned.splice(matchingIndex, 1);
+    };
+    // Remove elements from b as we find them in a
+    for (var i = 0; i < a.length; i++) {
+        var state_1 = _loop_1(i);
+        if (typeof state_1 === "object")
+            return state_1.value;
+    }
+    // If we made it here, all elements in a have a corresponding element in b
+    return true;
+};
+exports.default = compareArraysByProp;
+//# sourceMappingURL=compareArraysByProp.js.map

package/lib/helpers/compareArraysByProp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compareArraysByProp.js","sourceRoot":"","sources":["../../src/helpers/compareArraysByProp.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA;;;;;;;;;;GAUG;AACH,IAAM,mBAAmB,GAAG,UAC1B,CAAQ,EACR,CAAQ,EACR,IAAuB;IAEvB,oDAAoD;IACpD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpD,0CAA0C;IAC1C,IAAM,OAAO,qBAAO,CAAC,OAAC,CAAC;4BAGd,CAAC;QACR,6BAA6B;QAC7B,IAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,UAAC,KAAK;YAC5C,6BAA6B;YAC7B,OAAO,KAAK,CAAC,KAAK,CAAC,UAAC,eAAe;;gBACjC,IAAM,IAAI,GAAG,CAAC,MAAA,CAAC,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC;gBAC3C,IAAM,IAAI,GAAG,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC;gBAC5C,OAAO,IAAI,KAAK,IAAI,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,oBAAoB;QACpB,IAAM,OAAO,GAAG,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;QAEpC,qDAAqD;QACrD,IAAI,OAAO,EAAE,CAAC;4BACL,KAAK;QACd,CAAC;QAED,8BAA8B;QAC9B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;;IArBnC,8CAA8C;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;8BAAxB,CAAC;;;KAqBT;IAED,0EAA0E;IAC1E,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}