@medusajs/medusa 1.3.2 → 1.3.3

package/dist/interfaces/base-service.js

@@ -0,0 +1,377 @@
+"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 (_) 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 __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+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));
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var medusa_core_utils_1 = require("medusa-core-utils");
+var typeorm_1 = require("typeorm");
+/**
+ * Common functionality for Services
+ * @interface
+ */
+var BaseService = /** @class */ (function () {
+    function BaseService(container, configModule) {
+        this.configModule = configModule;
+        this.container_ = container;
+    }
+    BaseService.prototype.withTransaction = function (transactionManager) {
+        if (!transactionManager) {
+            return this;
+        }
+        var cloned = new this.constructor(__assign(__assign({}, this.container_), { manager: transactionManager }), this.configModule);
+        cloned.transactionManager_ = transactionManager;
+        return cloned;
+    };
+    /**
+     * Used to build TypeORM queries.
+     * @param selector The selector
+     * @param config The config
+     * @return The QueryBuilderConfig
+     */
+    BaseService.prototype.buildQuery_ = function (selector, config) {
+        if (config === void 0) { config = {}; }
+        var build = function (obj) {
+            return Object.entries(obj).reduce(function (acc, _a) {
+                var _b = __read(_a, 2), key = _b[0], value = _b[1];
+                // Undefined values indicate that they have no significance to the query.
+                // If the query is looking for rows where a column is not set it should use null instead of undefined
+                if (typeof value === "undefined") {
+                    return acc;
+                }
+                var subquery = [];
+                switch (true) {
+                    case value instanceof typeorm_1.FindOperator:
+                        acc[key] = value;
+                        break;
+                    case Array.isArray(value):
+                        acc[key] = (0, typeorm_1.In)(__spreadArray([], __read(value), false));
+                        break;
+                    case value !== null && typeof value === "object":
+                        Object.entries(value).map(function (_a) {
+                            var _b = __read(_a, 2), modifier = _b[0], val = _b[1];
+                            switch (modifier) {
+                                case "lt":
+                                    subquery.push({ operator: "<", value: val });
+                                    break;
+                                case "gt":
+                                    subquery.push({ operator: ">", value: val });
+                                    break;
+                                case "lte":
+                                    subquery.push({ operator: "<=", value: val });
+                                    break;
+                                case "gte":
+                                    subquery.push({ operator: ">=", value: val });
+                                    break;
+                                default:
+                                    acc[key] = value;
+                                    break;
+                            }
+                        });
+                        if (subquery.length) {
+                            acc[key] = (0, typeorm_1.Raw)(function (a) {
+                                return subquery
+                                    .map(function (s, index) { return "".concat(a, " ").concat(s.operator, " :").concat(index); })
+                                    .join(" AND ");
+                            }, subquery.map(function (s) { return s.value; }));
+                        }
+                        break;
+                    default:
+                        acc[key] = value;
+                        break;
+                }
+                return acc;
+            }, {});
+        };
+        var query = {
+            where: build(selector),
+        };
+        if ("deleted_at" in selector) {
+            query.withDeleted = true;
+        }
+        if ("skip" in config) {
+            query.skip = config.skip;
+        }
+        if ("take" in config) {
+            query.take = config.take;
+        }
+        if ("relations" in config) {
+            query.relations = config.relations;
+        }
+        if ("select" in config) {
+            query.select = config.select;
+        }
+        if ("order" in config) {
+            query.order = config.order;
+        }
+        return query;
+    };
+    /**
+     * Confirms whether a given raw id is valid. Fails if the provided
+     * id is null or undefined. The validate function takes an optional config
+     * param, to support checking id prefix and length.
+     * @param rawId - the id to validate.
+     * @param config - optional config
+     * @returns the rawId given that nothing failed
+     */
+    BaseService.prototype.validateId_ = function (rawId, config) {
+        if (config === void 0) { config = {}; }
+        var prefix = config.prefix, length = config.length;
+        if (!rawId) {
+            throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.INVALID_DATA, "Failed to validate id: ".concat(rawId));
+        }
+        if (prefix || length) {
+            var _a = __read(rawId.split("_"), 2), pre = _a[0], rand = _a[1];
+            if (prefix && pre !== prefix) {
+                throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.INVALID_DATA, "The provided id: ".concat(rawId, " does not adhere to prefix constraint: ").concat(prefix));
+            }
+            if (length && length !== rand.length) {
+                throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.INVALID_DATA, "The provided id: ".concat(rawId, " does not adhere to length constraint: ").concat(length));
+            }
+        }
+        return rawId;
+    };
+    BaseService.prototype.shouldRetryTransaction = function (err) {
+        if (!(err === null || err === void 0 ? void 0 : err.code)) {
+            return false;
+        }
+        var code = err === null || err === void 0 ? void 0 : err.code;
+        return code === "40001" || code === "40P01";
+    };
+    /**
+     * Wraps some work within a transactional block. If the service already has
+     * a transaction manager attached this will be reused, otherwise a new
+     * transaction manager is created.
+     * @param work - the transactional work to be done
+     * @param isolationOrErrorHandler - the isolation level to be used for the work.
+     * @param maybeErrorHandlerOrDontFail Potential error handler
+     * @return the result of the transactional work
+     */
+    BaseService.prototype.atomicPhase_ = function (work, isolationOrErrorHandler, maybeErrorHandlerOrDontFail) {
+        return __awaiter(this, void 0, void 0, function () {
+            var errorHandler, isolation, dontFail, doWork, temp_1, doWork_1, result, error_1, error_2, result;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        errorHandler = maybeErrorHandlerOrDontFail;
+                        isolation = isolationOrErrorHandler;
+                        dontFail = false;
+                        if (typeof isolationOrErrorHandler === "function") {
+                            isolation = null;
+                            errorHandler = isolationOrErrorHandler;
+                            dontFail = !!maybeErrorHandlerOrDontFail;
+                        }
+                        if (!this.transactionManager_) return [3 /*break*/, 1];
+                        doWork = function (m) { return __awaiter(_this, void 0, void 0, function () {
+                            var error_3, queryRunner;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        this.manager_ = m;
+                                        this.transactionManager_ = m;
+                                        _a.label = 1;
+                                    case 1:
+                                        _a.trys.push([1, 3, , 8]);
+                                        return [4 /*yield*/, work(m)];
+                                    case 2: return [2 /*return*/, _a.sent()];
+                                    case 3:
+                                        error_3 = _a.sent();
+                                        if (!errorHandler) return [3 /*break*/, 7];
+                                        queryRunner = this.transactionManager_.queryRunner;
+                                        if (!(queryRunner && queryRunner.isTransactionActive)) return [3 /*break*/, 5];
+                                        return [4 /*yield*/, queryRunner.rollbackTransaction()];
+                                    case 4:
+                                        _a.sent();
+                                        _a.label = 5;
+                                    case 5: return [4 /*yield*/, errorHandler(error_3)];
+                                    case 6:
+                                        _a.sent();
+                                        _a.label = 7;
+                                    case 7: throw error_3;
+                                    case 8: return [2 /*return*/];
+                                }
+                            });
+                        }); };
+                        return [2 /*return*/, doWork(this.transactionManager_)];
+                    case 1:
+                        temp_1 = this.manager_;
+                        doWork_1 = function (m) { return __awaiter(_this, void 0, void 0, function () {
+                            var result, error_4;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0:
+                                        this.manager_ = m;
+                                        this.transactionManager_ = m;
+                                        _a.label = 1;
+                                    case 1:
+                                        _a.trys.push([1, 3, , 4]);
+                                        return [4 /*yield*/, work(m)];
+                                    case 2:
+                                        result = _a.sent();
+                                        this.manager_ = temp_1;
+                                        this.transactionManager_ = undefined;
+                                        return [2 /*return*/, result];
+                                    case 3:
+                                        error_4 = _a.sent();
+                                        this.manager_ = temp_1;
+                                        this.transactionManager_ = undefined;
+                                        throw error_4;
+                                    case 4: return [2 /*return*/];
+                                }
+                            });
+                        }); };
+                        if (!isolation) return [3 /*break*/, 9];
+                        result = void 0;
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 4, , 9]);
+                        return [4 /*yield*/, this.manager_.transaction(isolation, function (m) { return doWork_1(m); })];
+                    case 3:
+                        result = _a.sent();
+                        return [2 /*return*/, result];
+                    case 4:
+                        error_1 = _a.sent();
+                        if (!this.shouldRetryTransaction(error_1)) return [3 /*break*/, 5];
+                        return [2 /*return*/, this.manager_.transaction(isolation, function (m) {
+                                return doWork_1(m);
+                            })];
+                    case 5:
+                        if (!errorHandler) return [3 /*break*/, 7];
+                        return [4 /*yield*/, errorHandler(error_1)];
+                    case 6:
+                        _a.sent();
+                        _a.label = 7;
+                    case 7: throw error_1;
+                    case 8: return [3 /*break*/, 9];
+                    case 9:
+                        _a.trys.push([9, 11, , 14]);
+                        return [4 /*yield*/, this.manager_.transaction(function (m) { return doWork_1(m); })];
+                    case 10: return [2 /*return*/, _a.sent()];
+                    case 11:
+                        error_2 = _a.sent();
+                        if (!errorHandler) return [3 /*break*/, 13];
+                        return [4 /*yield*/, errorHandler(error_2)];
+                    case 12:
+                        result = _a.sent();
+                        if (dontFail) {
+                            return [2 /*return*/, result];
+                        }
+                        _a.label = 13;
+                    case 13: throw error_2;
+                    case 14: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Dedicated method to set metadata.
+     * @param obj - the entity to apply metadata to.
+     * @param metadata - the metadata to set
+     * @return resolves to the updated result.
+     */
+    BaseService.prototype.setMetadata_ = function (obj, metadata) {
+        var e_1, _a;
+        var existing = obj.metadata || {};
+        var newData = {};
+        try {
+            for (var _b = __values(Object.entries(metadata)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var _d = __read(_c.value, 2), key = _d[0], value = _d[1];
+                if (typeof key !== "string") {
+                    throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.INVALID_ARGUMENT, "Key type is invalid. Metadata keys must be strings");
+                }
+                newData[key] = value;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return __assign(__assign({}, existing), newData);
+    };
+    return BaseService;
+}());
+exports.default = BaseService;
+//# sourceMappingURL=base-service.js.map

package/dist/interfaces/base-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-service.js","sourceRoot":"","sources":["../../src/interfaces/base-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uDAA+C;AAC/C,mCAA8D;AAM9D;;;GAGG;AACH;IAQE,qBACE,SAAqB,EACF,YAAqC;QAArC,iBAAY,GAAZ,YAAY,CAAyB;QAExD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;IAC7B,CAAC;IAID,qCAAe,GAAf,UAAgB,kBAAkC;QAChD,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO,IAAI,CAAA;SACZ;QAED,IAAM,MAAM,GAAG,IAAyB,IAAI,CAAC,WAAY,uBAKlD,IAAI,CAAC,UAAU,KAClB,OAAO,EAAE,kBAAkB,KAE7B,IAAI,CAAC,YAAY,CAClB,CAAA;QAED,MAAM,CAAC,mBAAmB,GAAG,kBAAkB,CAAA;QAE/C,OAAO,MAAgB,CAAA;IACzB,CAAC;IAED;;;;;OAKG;IACH,iCAAW,GAAX,UACE,QAA2B,EAC3B,MAAgC;QAAhC,uBAAA,EAAA,WAAgC;QAKhC,IAAM,KAAK,GAAG,UACZ,GAA4B;YAE5B,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,EAAiB;oBAAjB,KAAA,aAAiB,EAAhB,GAAG,QAAA,EAAE,KAAK,QAAA;gBACjD,yEAAyE;gBACzE,qGAAqG;gBACrG,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;oBAChC,OAAO,GAAG,CAAA;iBACX;gBAED,IAAM,QAAQ,GAGR,EAAE,CAAA;gBAER,QAAQ,IAAI,EAAE;oBACZ,KAAK,KAAK,YAAY,sBAAY;wBAChC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;wBAChB,MAAK;oBACP,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBACvB,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,YAAE,2BAAM,KAAmB,UAAE,CAAA;wBACxC,MAAK;oBACP,KAAK,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;wBAC9C,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,CAAC,GAAG,CAClD,UAAC,EAAe;gCAAf,KAAA,aAAe,EAAd,QAAQ,QAAA,EAAE,GAAG,QAAA;4BACb,QAAQ,QAAQ,EAAE;gCAChB,KAAK,IAAI;oCACP,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;oCAC5C,MAAK;gCACP,KAAK,IAAI;oCACP,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;oCAC5C,MAAK;gCACP,KAAK,KAAK;oCACR,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;oCAC7C,MAAK;gCACP,KAAK,KAAK;oCACR,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;oCAC7C,MAAK;gCACP;oCACE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oCAChB,MAAK;6BACR;wBACH,CAAC,CACF,CAAA;wBAED,IAAI,QAAQ,CAAC,MAAM,EAAE;4BACnB,GAAG,CAAC,GAAG,CAAC,GAAG,IAAA,aAAG,EACZ,UAAC,CAAC;gCACA,OAAA,QAAQ;qCACL,GAAG,CAAC,UAAC,CAAC,EAAE,KAAK,IAAK,OAAA,UAAG,CAAC,cAAI,CAAC,CAAC,QAAQ,eAAK,KAAK,CAAE,EAA9B,CAA8B,CAAC;qCACjD,IAAI,CAAC,OAAO,CAAC;4BAFhB,CAEgB,EAClB,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,KAAK,EAAP,CAAO,CAAC,CAC7B,CAAA;yBACF;wBACD,MAAK;oBACP;wBACE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;wBAChB,MAAK;iBACR;gBAED,OAAO,GAAG,CAAA;YACZ,CAAC,EAAE,EAA0C,CAAC,CAAA;QAChD,CAAC,CAAA;QAED,IAAM,KAAK,GAGP;YACF,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC;SACvB,CAAA;QAED,IAAI,YAAY,IAAI,QAAQ,EAAE;YAC5B,KAAK,CAAC,WAAW,GAAG,IAAI,CAAA;SACzB;QAED,IAAI,MAAM,IAAI,MAAM,EAAE;YACpB,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;SACzB;QAED,IAAI,MAAM,IAAI,MAAM,EAAE;YACpB,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;SACzB;QAED,IAAI,WAAW,IAAI,MAAM,EAAE;YACzB,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAA;SACnC;QAED,IAAI,QAAQ,IAAI,MAAM,EAAE;YACtB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;SAC7B;QAED,IAAI,OAAO,IAAI,MAAM,EAAE;YACrB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;SAC3B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;OAOG;IACH,iCAAW,GAAX,UACE,KAAa,EACb,MAAiD;QAAjD,uBAAA,EAAA,WAAiD;QAEzC,IAAA,MAAM,GAAa,MAAM,OAAnB,EAAE,MAAM,GAAK,MAAM,OAAX,CAAW;QACjC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,iCAA0B,KAAK,CAAE,CAClC,CAAA;SACF;QAED,IAAI,MAAM,IAAI,MAAM,EAAE;YACd,IAAA,KAAA,OAAc,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAA,EAA7B,GAAG,QAAA,EAAE,IAAI,QAAoB,CAAA;YACpC,IAAI,MAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBAC5B,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,2BAAoB,KAAK,oDAA0C,MAAM,CAAE,CAC5E,CAAA;aACF;YAED,IAAI,MAAM,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;gBACpC,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,YAAY,EAC9B,2BAAoB,KAAK,oDAA0C,MAAM,CAAE,CAC5E,CAAA;aACF;SACF;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,4CAAsB,GAAtB,UACE,GAA+C;QAE/C,IAAI,CAAC,CAAC,GAAwB,aAAxB,GAAG,uBAAH,GAAG,CAAuB,IAAI,CAAA,EAAE;YACpC,OAAO,KAAK,CAAA;SACb;QACD,IAAM,IAAI,GAAI,GAAwB,aAAxB,GAAG,uBAAH,GAAG,CAAuB,IAAI,CAAA;QAC5C,OAAO,IAAI,KAAK,OAAO,IAAI,IAAI,KAAK,OAAO,CAAA;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACG,kCAAY,GAAlB,UACE,IAA6D,EAC7D,uBAE0C,EAC1C,2BAAkE;;;;;;;wBAE9D,YAAY,GAAG,2BAA2B,CAAA;wBAC1C,SAAS,GAIF,uBAAuB,CAAA;wBAC9B,QAAQ,GAAG,KAAK,CAAA;wBACpB,IAAI,OAAO,uBAAuB,KAAK,UAAU,EAAE;4BACjD,SAAS,GAAG,IAAI,CAAA;4BAChB,YAAY,GAAG,uBAAuB,CAAA;4BACtC,QAAQ,GAAG,CAAC,CAAC,2BAA2B,CAAA;yBACzC;6BAEG,IAAI,CAAC,mBAAmB,EAAxB,wBAAwB;wBACpB,MAAM,GAAG,UAAO,CAAgB;;;;;wCACpC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;wCACjB,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAA;;;;wCAEnB,qBAAM,IAAI,CAAC,CAAC,CAAC,EAAA;4CAApB,sBAAO,SAAa,EAAA;;;6CAEhB,YAAY,EAAZ,wBAAY;wCACR,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAA;6CACpD,CAAA,WAAW,IAAI,WAAW,CAAC,mBAAmB,CAAA,EAA9C,wBAA8C;wCAChD,qBAAM,WAAW,CAAC,mBAAmB,EAAE,EAAA;;wCAAvC,SAAuC,CAAA;;4CAGzC,qBAAM,YAAY,CAAC,OAAK,CAAC,EAAA;;wCAAzB,SAAyB,CAAA;;4CAE3B,MAAM,OAAK,CAAA;;;;6BAEd,CAAA;wBAED,sBAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAA;;wBAEjC,SAAO,IAAI,CAAC,QAAQ,CAAA;wBACpB,WAAS,UAAO,CAAgB;;;;;wCACpC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;wCACjB,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAA;;;;wCAEX,qBAAM,IAAI,CAAC,CAAC,CAAC,EAAA;;wCAAtB,MAAM,GAAG,SAAa;wCAC5B,IAAI,CAAC,QAAQ,GAAG,MAAI,CAAA;wCACpB,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAA;wCACpC,sBAAO,MAAM,EAAA;;;wCAEb,IAAI,CAAC,QAAQ,GAAG,MAAI,CAAA;wCACpB,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAA;wCACpC,MAAM,OAAK,CAAA;;;;6BAEd,CAAA;6BAEG,SAAS,EAAT,wBAAS;wBACP,MAAM,SAAA,CAAA;;;;wBAEC,qBAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CACtC,SAA2B,EAC3B,UAAC,CAAC,IAAK,OAAA,QAAM,CAAC,CAAC,CAAC,EAAT,CAAS,CACjB,EAAA;;wBAHD,MAAM,GAAG,SAGR,CAAA;wBACD,sBAAO,MAAM,EAAA;;;6BAET,IAAI,CAAC,sBAAsB,CAAC,OAAK,CAAC,EAAlC,wBAAkC;wBACpC,sBAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAA2B,EAAE,UAAC,CAAC;gCAC9D,OAAA,QAAM,CAAC,CAAC,CAAC;4BAAT,CAAS,CACV,EAAA;;6BAEG,YAAY,EAAZ,wBAAY;wBACd,qBAAM,YAAY,CAAC,OAAK,CAAC,EAAA;;wBAAzB,SAAyB,CAAA;;4BAE3B,MAAM,OAAK,CAAA;;;;wBAMR,qBAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAC,CAAC,IAAK,OAAA,QAAM,CAAC,CAAC,CAAC,EAAT,CAAS,CAAC,EAAA;6BAAxD,sBAAO,SAAiD,EAAA;;;6BAEpD,YAAY,EAAZ,yBAAY;wBACC,qBAAM,YAAY,CAAC,OAAK,CAAC,EAAA;;wBAAlC,MAAM,GAAG,SAAyB;wBACxC,IAAI,QAAQ,EAAE;4BACZ,sBAAO,MAAM,EAAA;yBACd;;6BAGH,MAAM,OAAK,CAAA;;;;;KAGhB;IAED;;;;;OAKG;IACH,kCAAY,GAAZ,UACE,GAA0C,EAC1C,QAAiC;;QAEjC,IAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;QACnC,IAAM,OAAO,GAAG,EAAE,CAAA;;YAClB,KAA2B,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA,gBAAA,4BAAE;gBAA1C,IAAA,KAAA,mBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;gBACpB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBAC3B,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,gBAAgB,EAClC,oDAAoD,CACrD,CAAA;iBACF;gBACD,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;aACrB;;;;;;;;;QAED,6BACK,QAAQ,GACR,OAAO,EACX;IACH,CAAC;IACH,kBAAC;AAAD,CAAC,AAzUD,IAyUC;AACD,kBAAe,WAAW,CAAA"}

package/dist/interfaces/batch-job-strategy.d.ts

@@ -0,0 +1,34 @@
+import { TransactionBaseService } from "./transaction-base-service";
+import { CreateBatchJobInput } from "../types/batch-job";
+import { BatchJobService } from "../services";
+import { BatchJob } from "../models";
+export interface IBatchJobStrategy<T extends TransactionBaseService<never>> extends TransactionBaseService<T> {
+    /**
+     * Method for preparing a batch job for processing
+     */
+    prepareBatchJobForProcessing(batchJobEntity: CreateBatchJobInput, req: Express.Request): Promise<CreateBatchJobInput>;
+    /**
+     * Method for pre-processing a batch job
+     */
+    preProcessBatchJob(batchJobId: string): Promise<void>;
+    /**
+     *  Method does the actual processing of the job. Should report back on the progress of the operation.
+     */
+    processJob(batchJobId: string): Promise<void>;
+    /**
+     * Builds and returns a template file that can be downloaded and filled in
+     */
+    buildTemplate(): Promise<string>;
+}
+export declare abstract class AbstractBatchJobStrategy<T extends TransactionBaseService<never, TContainer>, TContainer = unknown> extends TransactionBaseService<T, TContainer> implements IBatchJobStrategy<T> {
+    static identifier: string;
+    static batchType: string;
+    protected abstract batchJobService_: BatchJobService;
+    prepareBatchJobForProcessing(batchJob: CreateBatchJobInput, req: Express.Request): Promise<CreateBatchJobInput>;
+    preProcessBatchJob(batchJobId: string): Promise<void>;
+    abstract processJob(batchJobId: string): Promise<void>;
+    abstract buildTemplate(): Promise<string>;
+    protected shouldRetryOnProcessingError(batchJob: BatchJob, err: unknown): Promise<boolean>;
+    protected handleProcessingError<T>(batchJobId: string, err: unknown, result: T): Promise<void>;
+}
+export declare function isBatchJobStrategy(object: unknown): object is IBatchJobStrategy<never>;

package/dist/interfaces/batch-job-strategy.js

@@ -0,0 +1,182 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 (_) 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 __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+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 });
+exports.isBatchJobStrategy = exports.AbstractBatchJobStrategy = void 0;
+var transaction_base_service_1 = require("./transaction-base-service");
+var AbstractBatchJobStrategy = /** @class */ (function (_super) {
+    __extends(AbstractBatchJobStrategy, _super);
+    function AbstractBatchJobStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    AbstractBatchJobStrategy.prototype.prepareBatchJobForProcessing = function (batchJob, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    req) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, batchJob];
+            });
+        });
+    };
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    AbstractBatchJobStrategy.prototype.preProcessBatchJob = function (batchJobId) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/];
+            });
+        });
+    };
+    AbstractBatchJobStrategy.prototype.shouldRetryOnProcessingError = function (
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    batchJob, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    err) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, false];
+            });
+        });
+    };
+    AbstractBatchJobStrategy.prototype.handleProcessingError = function (batchJobId, err, result) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.atomicPhase_(function (transactionManager) { return __awaiter(_this, void 0, void 0, function () {
+                            var batchJob, shouldRetry, errMessage, errCode, resultError, existingErrors, retryCount;
+                            var _a, _b, _c, _d, _e;
+                            return __generator(this, function (_f) {
+                                switch (_f.label) {
+                                    case 0: return [4 /*yield*/, this.batchJobService_
+                                            .withTransaction(transactionManager)
+                                            .retrieve(batchJobId)];
+                                    case 1:
+                                        batchJob = (_f.sent());
+                                        return [4 /*yield*/, this.shouldRetryOnProcessingError(batchJob, err)];
+                                    case 2:
+                                        shouldRetry = _f.sent();
+                                        errMessage = (_a = err.message) !== null && _a !== void 0 ? _a : "Something went wrong with the batchJob ".concat(batchJob.id);
+                                        errCode = (_b = err.code) !== null && _b !== void 0 ? _b : "unknown";
+                                        resultError = { message: errMessage, code: errCode, err: err };
+                                        if (!shouldRetry) return [3 /*break*/, 4];
+                                        existingErrors = (_d = (_c = batchJob === null || batchJob === void 0 ? void 0 : batchJob.result) === null || _c === void 0 ? void 0 : _c.errors) !== null && _d !== void 0 ? _d : [];
+                                        retryCount = (_e = batchJob.context.retry_count) !== null && _e !== void 0 ? _e : 0;
+                                        return [4 /*yield*/, this.batchJobService_
+                                                .withTransaction(transactionManager)
+                                                .update(batchJobId, {
+                                                context: {
+                                                    retry_count: retryCount + 1,
+                                                },
+                                                result: __assign(__assign({}, result), { errors: __spreadArray(__spreadArray([], __read(existingErrors), false), [resultError], false) }),
+                                            })];
+                                    case 3:
+                                        _f.sent();
+                                        return [3 /*break*/, 6];
+                                    case 4: return [4 /*yield*/, this.batchJobService_
+                                            .withTransaction(transactionManager)
+                                            .setFailed(batchJob, resultError)];
+                                    case 5:
+                                        _f.sent();
+                                        _f.label = 6;
+                                    case 6: return [2 /*return*/];
+                                }
+                            });
+                        }); })];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return AbstractBatchJobStrategy;
+}(transaction_base_service_1.TransactionBaseService));
+exports.AbstractBatchJobStrategy = AbstractBatchJobStrategy;
+function isBatchJobStrategy(object) {
+    return object instanceof AbstractBatchJobStrategy;
+}
+exports.isBatchJobStrategy = isBatchJobStrategy;
+//# sourceMappingURL=batch-job-strategy.js.map

package/dist/interfaces/batch-job-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-job-strategy.js","sourceRoot":"","sources":["../../src/interfaces/batch-job-strategy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAmE;AAgCnE;IAIU,4CAAqC;IAJ/C;;IA+EA,CAAC;IAnEO,+DAA4B,GAAlC,UACE,QAA6B;IAC7B,6DAA6D;IAC7D,GAAoB;;;gBAEpB,sBAAO,QAAQ,EAAA;;;KAChB;IAED,6DAA6D;IAChD,qDAAkB,GAA/B,UAAgC,UAAkB;;;gBAChD,sBAAM;;;KACP;IAMe,+DAA4B,GAA5C;IACE,6DAA6D;IAC7D,QAAkB;IAClB,6DAA6D;IAC7D,GAAY;;;gBAEZ,sBAAO,KAAK,EAAA;;;KACb;IAEe,wDAAqB,GAArC,UACE,UAAkB,EAClB,GAAY,EACZ,MAAS;;;;;4BAEF,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;4CACpC,qBAAM,IAAI,CAAC,gBAAgB;6CAC1C,eAAe,CAAC,kBAAkB,CAAC;6CACnC,QAAQ,CAAC,UAAU,CAAC,EAAA;;wCAFjB,QAAQ,GAAG,CAAC,SAEK,CAA0B;wCAE7B,qBAAM,IAAI,CAAC,4BAA4B,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAA;;wCAApE,WAAW,GAAG,SAAsD;wCAEpE,UAAU,GACd,MAAC,GAA2B,CAAC,OAAO,mCACpC,iDAA0C,QAAQ,CAAC,EAAE,CAAE,CAAA;wCACnD,OAAO,GAAG,MAAC,GAAiC,CAAC,IAAI,mCAAI,SAAS,CAAA;wCAC9D,WAAW,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAA,EAAE,CAAA;6CAE3D,WAAW,EAAX,wBAAW;wCACP,cAAc,GAClB,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,0CAAE,MAAM,mCAAK,EAA4B,CAAA;wCACrD,UAAU,GAAG,MAAA,QAAQ,CAAC,OAAO,CAAC,WAAW,mCAAI,CAAC,CAAA;wCAEpD,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,kBAAkB,CAAC;iDACnC,MAAM,CAAC,UAAU,EAAE;gDAClB,OAAO,EAAE;oDACP,WAAW,EAAE,UAAU,GAAG,CAAC;iDAC5B;gDACD,MAAM,wBACD,MAAM,KACT,MAAM,yCAAM,cAAc,YAAE,WAAW,YACxC;6CACF,CAAC,EAAA;;wCAVJ,SAUI,CAAA;;4CAEJ,qBAAM,IAAI,CAAC,gBAAgB;6CACxB,eAAe,CAAC,kBAAkB,CAAC;6CACnC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAA;;wCAFnC,SAEmC,CAAA;;;;;6BAEtC,CAAC,EAAA;4BAlCF,sBAAO,SAkCL,EAAA;;;;KACH;IACH,+BAAC;AAAD,CAAC,AA/ED,CAIU,iDAAsB,GA2E/B;AA/EqB,4DAAwB;AAiF9C,SAAgB,kBAAkB,CAChC,MAAe;IAEf,OAAO,MAAM,YAAY,wBAAwB,CAAA;AACnD,CAAC;AAJD,gDAIC"}

package/dist/interfaces/csv-parser.d.ts

@@ -0,0 +1,46 @@
+import { AwilixContainer } from "awilix";
+/**
+ * Generic validation interface used to run validation logic on every line or record.
+ * All different validation objects should implement this interface
+ */
+export interface ICsvValidator<TCsvLine, TBuiltLine> {
+    /**
+     *
+     * @param value value of column or property
+     * @param context includes contextual information such as line number, line, etc.
+     */
+    validate: (value: TBuiltLine, context: CsvParserContext<TCsvLine>) => Promise<boolean | never>;
+}
+export declare type CsvParserContext<TLine> = LineContext<TLine> & {
+    column: string;
+};
+export declare type LineContext<TLine> = {
+    lineNumber: number;
+    line: TLine;
+};
+/**
+ * Abstract class implementation of the IValidator interface.
+ * All validation objects part of the schema should extend this class.
+ */
+export declare abstract class AbstractCsvValidator<TCsvLine, TBuiltLine> implements ICsvValidator<TCsvLine, TBuiltLine> {
+    protected readonly container: AwilixContainer;
+    constructor(container: AwilixContainer);
+    abstract validate(builtLine: TBuiltLine, context: CsvParserContext<TCsvLine>): Promise<boolean | never>;
+}
+export declare type CsvSchemaColumn<TCsvLine, TBuiltLine> = {
+    name: string;
+    required?: boolean;
+    validator?: AbstractCsvValidator<TCsvLine, TBuiltLine>;
+} & ({
+    mapTo?: string;
+    transform?: ColumnTransformer<TCsvLine>;
+} | {
+    match?: RegExp;
+    reducer?: ColumnReducer<TCsvLine, TBuiltLine>;
+    transform?: ColumnTransformer<TCsvLine>;
+});
+export declare type ColumnTransformer<TCsvLine> = (value: string, context: CsvParserContext<TCsvLine>) => unknown;
+export declare type ColumnReducer<TCsvLine = unknown, TBuiltLine = unknown> = (builtLine: TBuiltLine, key: string, value: string, context: CsvParserContext<TCsvLine>) => TBuiltLine;
+export declare type CsvSchema<TCsvLine = unknown, TBuiltLine = unknown> = {
+    columns: CsvSchemaColumn<TCsvLine, TBuiltLine>[];
+};