@aligent/microservice-util-lib 0.1.1

package/dist/remap/remap.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var lodash_1 = __importDefault(require("lodash"));
+/**
+ * Map one object's values to another structure
+ * @param object the object to map from
+ * @param map the keys for the mapping
+ * @returns the remapped object
+ *
+ * @example without a transformer function
+ * ```ts
+ * const map = [
+ *   ['foo', 'baz'],
+ *   ['bar', 'qux.0']
+ * ] as const;
+ * const obj = { foo: 'hi', bar: 7 }
+ * remap(obj, map); // { baz: 'hi', qux: [7] }
+ * ```
+ * @example with a transformer function
+ * ```ts
+ * const map = [
+ *  ['foo', 'baz'],
+ *  ['bar', 'qux.0', (x: number) => x + 1]
+ * ] as const;
+ * const obj = { foo: 'hi', bar: 7 }
+ * remap(obj, map); // { baz: 'hi', qux: [8] }
+ * ```
+ * @example with an empty initial key
+ * ```ts
+ * const map = [
+ *   ['', 'baz', (x: { foo: number, bar: number }) => x.foo + x.bar]
+ * ]
+ * const obj = { foo: 3, bar: 7 }
+ * remap(obj, map); // { baz: 10 }
+ * ```
+ */
+function remap(object, map) {
+    var out = {};
+    map.forEach(function (item) {
+        var parser = item[2] ? item[2] : function (val) { return val; };
+        var value = item[0] ? lodash_1.default.get(object, item[0]) : object;
+        return lodash_1.default.set(out, item[1], parser(value));
+    });
+    return out;
+}
+exports.default = remap;
+//# sourceMappingURL=remap.js.map

package/dist/remap/remap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap.js","sourceRoot":"","sources":["../../src/remap/remap.ts"],"names":[],"mappings":";;;;;AAAA,kDAAuB;AAoKvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,SAAS,KAAK,CAGZ,MAAgB,EAAE,GAAa;IAC/B,IAAM,GAAG,GAAG,EAAE,CAAC;IACf,GAAG,CAAC,OAAO,CAAC,UAAA,IAAI;QACd,IAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAC,GAAQ,IAAK,OAAA,GAAG,EAAH,CAAG,CAAC;QACrD,IAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QACxD,OAAO,gBAAC,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAY,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,OAAO,GAAU,CAAC;AACpB,CAAC;AAID,kBAAe,KAAK,CAAC"}

package/dist/remap/remap.test.d.ts

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

package/dist/remap/remap.test.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var remap_1 = __importDefault(require("./remap"));
+describe('remap', function () {
+    it('remaps an object with one value', function () {
+        var obj = { foo: 7 };
+        var map = [
+            ['foo', 'bar']
+        ];
+        var newObj = (0, remap_1.default)(obj, map);
+        expect(newObj).toEqual({ bar: 7 });
+    });
+    it('uses a remap function', function () {
+        var obj = { foo: 7 };
+        var map = [
+            ['foo', 'bar', function (val) { return val * 2; }]
+        ];
+        var newObj = (0, remap_1.default)(obj, map);
+        expect(newObj).toEqual({ bar: 14 });
+    });
+    it('remaps through multiple levels', function () {
+        var obj = { foo: {
+                bar: 5
+            } };
+        var map = [
+            ['foo.bar', 'baz']
+        ];
+        var newObj = (0, remap_1.default)(obj, map);
+        expect(newObj).toEqual({ baz: 5 });
+    });
+    it('Passes whole object to function when the source key is blank', function () {
+        var obj = { foo: 7, bar: 3 };
+        var fn = jest.fn(function (val) {
+            return val.foo + val.bar;
+        });
+        var map = [
+            ['', 'foo', fn]
+        ];
+        var newObj = (0, remap_1.default)(obj, map);
+        expect(newObj).toEqual({ foo: 10 });
+        expect(fn).toHaveBeenCalledWith(obj);
+    });
+    it('creates arrays when .# is used', function () {
+        var obj = { foo: 1, bar: 2, baz: 7 };
+        var map = [
+            ['foo', 'foo.0'],
+            ['bar', 'foo.1'],
+            ['baz', 'foo.2']
+        ];
+        var newObj = (0, remap_1.default)(obj, map);
+        expect(newObj).toEqual({ foo: [1, 2, 7] });
+    });
+    it('follows the logic in the example code in the docs', function () {
+        var map = [
+            ['foo', 'baz'],
+            ['bar', 'qux.0', function (x) { return x + 1; }]
+        ];
+        var obj = { foo: 'hi', bar: 7 };
+        expect((0, remap_1.default)(obj, map)).toEqual({ baz: 'hi', qux: [8] });
+    });
+});
+//# sourceMappingURL=remap.test.js.map

package/dist/remap/remap.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remap.test.js","sourceRoot":"","sources":["../../src/remap/remap.test.ts"],"names":[],"mappings":";;;;;AAAA,kDAA4B;AAE5B,QAAQ,CAAC,OAAO,EAAE;IAChB,EAAE,CAAC,iCAAiC,EAAE;QACpC,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACvB,IAAM,GAAG,GAAG;YACV,CAAC,KAAK,EAAE,KAAK,CAAC;SACN,CAAC;QACX,IAAM,MAAM,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE;QAC1B,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACvB,IAAM,GAAG,GAAG;YACV,CAAC,KAAK,EAAE,KAAK,EAAE,UAAC,GAAW,IAAK,OAAA,GAAG,GAAG,CAAC,EAAP,CAAO,CAAC;SAChC,CAAC;QACX,IAAM,MAAM,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE;QACnC,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE;gBACjB,GAAG,EAAE,CAAC;aACP,EAAC,CAAC;QACH,IAAM,GAAG,GAAG;YACV,CAAC,SAAS,EAAE,KAAK,CAAC;SACV,CAAC;QACX,IAAM,MAAM,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE;QACjE,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QAC/B,IAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,UAAC,GAAe;YACjC,OAAO,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAM,GAAG,GAAG;YACV,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC;SACP,CAAC;QACX,IAAM,MAAM,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE;QACnC,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACvC,IAAM,GAAG,GAAG;YACV,CAAC,KAAK,EAAE,OAAO,CAAC;YAChB,CAAC,KAAK,EAAE,OAAO,CAAC;YAChB,CAAC,KAAK,EAAE,OAAO,CAAC;SACR,CAAC;QACX,IAAM,MAAM,GAAG,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE;QACtD,IAAM,GAAG,GAAG;YACV,CAAC,KAAK,EAAE,KAAK,CAAC;YACd,CAAC,KAAK,EAAE,OAAO,EAAE,UAAC,CAAS,IAAK,OAAA,CAAC,GAAG,CAAC,EAAL,CAAK,CAAC;SAC9B,CAAC;QACX,IAAM,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QAClC,MAAM,CAAC,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/retryWrapper/retryWrapper.d.ts

@@ -0,0 +1,40 @@
+/** Configuration for the retryWrapper */
+interface RetryConfig {
+    /**
+     * The number of retries to attempt after the first run
+     * @default 1
+     */
+    retries?: number;
+    /**
+     * The base delay between retries (in ms)
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * The amount to increase the delay by each retry (in ms)
+     * @default 0
+     */
+    backoffAmount?: number;
+    /**
+     * A callback to run before each retry
+     * @param retries the number of retries so far (will start at 1)
+     * @param error the error from the last attempt
+     * @param config the configuration supplied to the retryWrapper
+     */
+    onRetry?: (retries: number, error: Error, config: RetryConfig) => void;
+}
+/**
+ * Retry an async function if it fails
+ * @param fn the function to be retried
+ * @param config the configuration for retries
+ * @example
+ * ```ts
+ * retryWrapper(someAsyncFunction, {
+ *   retries: 3,
+ *   onRetry: (_, error) => console.error(error)
+ * });
+ * ```
+ */
+declare function retryWrapper<T>(fn: () => Promise<T>, config: RetryConfig): Promise<T>;
+export { RetryConfig };
+export default retryWrapper;

package/dist/retryWrapper/retryWrapper.js

@@ -0,0 +1,121 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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;
+    return g = { next: verb(0), "throw": verb(1), "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 });
+/**
+ * Retry an async function if it fails
+ * @param fn the function to be retried
+ * @param config the configuration for retries
+ * @param retryCount the number of retries so far
+ * @param error the error from teh last retry
+ */
+function retryWrapperInternal(fn, config, retryCount, error) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (config.retries < 0) {
+                        throw error;
+                    }
+                    if (error) {
+                        if (config.onRetry) {
+                            config.onRetry(retryCount, error, config);
+                        }
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 6]);
+                    return [4 /*yield*/, fn()];
+                case 2:
+                    result = _a.sent();
+                    return [2 /*return*/, result];
+                case 3:
+                    err_1 = _a.sent();
+                    return [4 /*yield*/, (function () { return new Promise(function (res) { return setTimeout(res, config.delay); }); })()];
+                case 4:
+                    _a.sent();
+                    return [4 /*yield*/, retryWrapperInternal(fn, __assign(__assign({}, config), { retries: config.retries - 1, delay: config.delay + config.backoffAmount }), retryCount + 1, err_1)];
+                case 5: return [2 /*return*/, _a.sent()];
+                case 6: return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * Retry an async function if it fails
+ * @param fn the function to be retried
+ * @param config the configuration for retries
+ * @example
+ * ```ts
+ * retryWrapper(someAsyncFunction, {
+ *   retries: 3,
+ *   onRetry: (_, error) => console.error(error)
+ * });
+ * ```
+ */
+function retryWrapper(fn, config) {
+    return __awaiter(this, void 0, void 0, function () {
+        var defaultConfig;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    defaultConfig = {
+                        retries: 1,
+                        delay: 0,
+                        backoffAmount: 0,
+                        onRetry: function () { return null; }
+                    };
+                    return [4 /*yield*/, retryWrapperInternal(fn, __assign(__assign({}, defaultConfig), config), 0)];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    });
+}
+exports.default = retryWrapper;
+//# sourceMappingURL=retryWrapper.js.map

package/dist/retryWrapper/retryWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryWrapper.js","sourceRoot":"","sources":["../../src/retryWrapper/retryWrapper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA;;;;;;GAMG;AACH,SAAe,oBAAoB,CACjC,EAAoB,EACpB,MAA6B,EAC7B,UAAkB,EAClB,KAAa;;;;;;oBAEb,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE;wBACtB,MAAM,KAAK,CAAC;qBACb;oBACD,IAAI,KAAK,EAAE;wBACT,IAAI,MAAM,CAAC,OAAO,EAAE;4BAClB,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;yBAC3C;qBACF;;;;oBAEgB,qBAAM,EAAE,EAAE,EAAA;;oBAAnB,MAAM,GAAG,SAAU;oBACzB,sBAAO,MAAM,EAAC;;;oBAEd,qBAAM,CAAC,cAAM,OAAA,IAAI,OAAO,CAAC,UAAC,GAAG,IAAK,OAAA,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,EAA7B,CAA6B,CAAC,EAAnD,CAAmD,CAAC,EAAE,EAAA;;oBAAnE,SAAmE,CAAC;oBAC7D,qBAAM,oBAAoB,CAC/B,EAAE,wBAEG,MAAM,KACT,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,EAC3B,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,aAAa,KAE5C,UAAU,GAAG,CAAC,EACd,KAAG,CACJ,EAAA;wBATD,sBAAO,SASN,EAAC;;;;;CAEL;AAED;;;;;;;;;;;GAWG;AACH,SAAe,YAAY,CACzB,EAAoB,EACpB,MAAmB;;;;;;oBAEb,aAAa,GAA0B;wBAC3C,OAAO,EAAE,CAAC;wBACV,KAAK,EAAE,CAAC;wBACR,aAAa,EAAE,CAAC;wBAChB,OAAO,EAAE,cAAM,OAAA,IAAI,EAAJ,CAAI;qBACpB,CAAC;oBACK,qBAAM,oBAAoB,CAC/B,EAAE,wBAEG,aAAa,GACb,MAAM,GAEX,CAAC,CACF,EAAA;wBAPD,sBAAO,SAON,EAAC;;;;CACH;AAGD,kBAAe,YAAY,CAAC"}

package/dist/retryWrapper/retryWrapper.test.d.ts

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

package/dist/retryWrapper/retryWrapper.test.js

@@ -0,0 +1,234 @@
+"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;
+    return g = { next: verb(0), "throw": verb(1), "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 retryWrapper_1 = __importDefault(require("./retryWrapper"));
+describe('retryWrapper', function () {
+    it('returns function\'s result', 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, retryWrapper_1.default)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                        return [2 /*return*/, 3];
+                    }); }); }, {
+                        retries: 1
+                    })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(3);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('retries the function the correct amount of times', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var fn, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error('Test Error');
+                        });
+                    }); });
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, { retries: 3 })];
+                case 2:
+                    _b.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    _a = _b.sent();
+                    expect(fn).toHaveBeenCalledTimes(4);
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); });
+    it('errors if the function returns an error every time', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var fn, ex_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error('Test Error');
+                        });
+                    }); });
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, { retries: 3 })];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    ex_1 = _a.sent();
+                    expect(ex_1).toBeTruthy();
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); });
+    it('retries after error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var count, fn, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    count = 0;
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            if (count < 2) {
+                                count++;
+                                throw new Error('Test Error');
+                            }
+                            return [2 /*return*/, true];
+                        });
+                    }); });
+                    _a = expect;
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, { retries: 3 })];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toBe(true);
+                    expect(fn).toHaveBeenCalledTimes(3);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('adds a delay between tries', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var fn, retries, delay, startTime, _a, totalTime;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error('Test Error');
+                        });
+                    }); });
+                    retries = 3;
+                    delay = 300;
+                    startTime = Date.now();
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, {
+                            retries: retries,
+                            delay: delay
+                        })];
+                case 2:
+                    _b.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    _a = _b.sent();
+                    return [3 /*break*/, 4];
+                case 4:
+                    totalTime = Date.now() - startTime;
+                    expect(totalTime).toBeGreaterThanOrEqual((retries + 1) * delay);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('calls the onRetry function when a retry happens', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var onRetry, fn, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    onRetry = jest.fn();
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error('Test Error');
+                        });
+                    }); });
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, {
+                            retries: 1,
+                            onRetry: onRetry
+                        })];
+                case 2:
+                    _b.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    _a = _b.sent();
+                    return [3 /*break*/, 4];
+                case 4:
+                    expect(onRetry).toHaveBeenCalledTimes(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('accurately counts retries', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var onRetry, err, fn, _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    onRetry = jest.fn();
+                    err = new Error('Test Error');
+                    fn = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw err;
+                        });
+                    }); });
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, retryWrapper_1.default)(fn, {
+                            retries: 3,
+                            onRetry: onRetry
+                        })];
+                case 2:
+                    _b.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    _a = _b.sent();
+                    return [3 /*break*/, 4];
+                case 4:
+                    expect(onRetry).toHaveBeenLastCalledWith(3, err, {
+                        retries: 0,
+                        onRetry: onRetry,
+                        delay: 0,
+                        backoffAmount: 0
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=retryWrapper.test.js.map

package/dist/retryWrapper/retryWrapper.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryWrapper.test.js","sourceRoot":"","sources":["../../src/retryWrapper/retryWrapper.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gEAA0C;AAE1C,QAAQ,CAAC,cAAc,EAAE;IACvB,EAAE,CAAC,4BAA4B,EAAE;;;;wBAChB,qBAAM,IAAA,sBAAY,EAAC;wBAAY,sBAAA,CAAC,EAAA;6BAAA,EAAE;wBAC/C,OAAO,EAAE,CAAC;qBACX,CAAC,EAAA;;oBAFI,MAAM,GAAG,SAEb;oBACF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;;;SACxB,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE;;;;;oBAC/C,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;;yBAC/B,CAAC,CAAC;;;;oBAGD,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAA;;oBAAtC,SAAsC,CAAC;;;;oBAEvC,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;;SAEvC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE;;;;;oBACjD,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;;yBAC/B,CAAC,CAAC;;;;oBAGD,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAA;;oBAAtC,SAAsC,CAAC;;;;oBAEvC,MAAM,CAAC,IAAE,CAAC,CAAC,UAAU,EAAE,CAAC;;;;;SAE3B,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE;;;;;oBACpB,KAAK,GAAG,CAAC,CAAC;oBACR,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,IAAI,KAAK,GAAG,CAAC,EAAE;gCACb,KAAK,EAAE,CAAC;gCACR,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;6BAC/B;4BACD,sBAAO,IAAI,EAAC;;yBACb,CAAC,CAAC;oBAEH,KAAA,MAAM,CAAA;oBAAC,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAA;;oBAA7C,kBAAO,SAAsC,EAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC1D,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SACrC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE;;;;;oBACzB,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;;yBAC/B,CAAC,CAAC;oBAEG,OAAO,GAAG,CAAC,CAAC;oBACZ,KAAK,GAAG,GAAG,CAAC;oBAEZ,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;;;;oBAG3B,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE;4BACrB,OAAO,SAAA;4BACP,KAAK,OAAA;yBACN,CAAC,EAAA;;oBAHF,SAGE,CAAC;;;;;;oBAIC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;oBAEzC,MAAM,CAAC,SAAS,CAAC,CAAC,sBAAsB,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;;;;SACjE,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE;;;;;oBAC9C,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;oBACpB,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;;yBAC/B,CAAC,CAAC;;;;oBAGD,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE;4BACrB,OAAO,EAAE,CAAC;4BACV,OAAO,SAAA;yBACR,CAAC,EAAA;;oBAHF,SAGE,CAAC;;;;;;oBAIL,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SAC1C,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE;;;;;oBACxB,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;oBACpB,GAAG,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;oBAC9B,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;;4BACjB,MAAM,GAAG,CAAC;;yBACX,CAAC,CAAC;;;;oBAGD,qBAAM,IAAA,sBAAY,EAAC,EAAE,EAAE;4BACrB,OAAO,EAAE,CAAC;4BACV,OAAO,SAAA;yBACR,CAAC,EAAA;;oBAHF,SAGE,CAAC;;;;;;oBAIL,MAAM,CAAC,OAAO,CAAC,CAAC,wBAAwB,CAAC,CAAC,EAAE,GAAG,EAAE;wBAC/C,OAAO,EAAE,CAAC;wBACV,OAAO,SAAA;wBACP,KAAK,EAAE,CAAC;wBACR,aAAa,EAAE,CAAC;qBACjB,CAAC,CAAC;;;;SACJ,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/s3/s3.d.ts

@@ -0,0 +1,47 @@
+import { S3 } from 'aws-sdk';
+/** A data access object for an S3 bucket */
+declare class S3Dao {
+    private s3;
+    private bucket;
+    /**
+     * @param bucket the location of the bucket that objects should be stored in
+     */
+    constructor(bucket: string);
+    /**
+     * Store data in an S3 bucket
+     * @param data the data to store
+     * @param name the name to call the object in S3 @default the hash of the data
+     * @returns an object which can be used to fetch the data
+     */
+    storeData<T>(data: T, name?: string): Promise<S3.GetObjectRequest>;
+    /**
+     * Store an array of object as individual chunks in S3
+     * @param data the data to store
+     * @param chunkSize the number of entries that should be in each chunk
+     * @returns an array of objects which can be used to fetch the chunks
+     */
+    storeChunked<T extends any[]>(data: T, chunkSize: number): Promise<S3.GetObjectRequest[]>;
+    /**
+     * Fetch an object from the S3 bucket
+     * @param objectDetails the object which describes the location of the object
+     * @returns the body of the object
+     */
+    fetchData<T>(objectDetails: S3.GetObjectRequest): Promise<T>;
+    /**
+     * Generator to fetch chunked data, chunk by chunk
+     * @param chunks the list of object chunks
+     */
+    fetchChunks<T>(chunks: S3.GetObjectRequest[]): AsyncGenerator<{
+        chunk: T;
+        s3Object: S3.GetObjectRequest;
+    }, {
+        chunk: T;
+        s3Object: S3.GetObjectRequest;
+    }, unknown>;
+    /**
+     * Delete an object from the S3 bucket
+     * @param objectDetails the object to delete
+     */
+    deleteData(objectDetails: S3.GetObjectRequest): Promise<import("aws-sdk/lib/request").PromiseResult<S3.DeleteObjectOutput, import("aws-sdk").AWSError>>;
+}
+export default S3Dao;