@medusajs/medusa 1.3.7 → 1.3.8-alpha.0

package/dist/services/sales-channel.js

@@ -61,6 +61,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 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);
@@ -95,35 +106,74 @@ var SalesChannelService = /** @class */ (function (_super) {
         return _this;
     }
     /**
-     * Retrieve a SalesChannel by id
+     * A generic retrieve used to find a sales channel by different attributes.
      *
-     * @experimental This feature is under development and may change in the future.
-     * To use this feature please enable the corresponding feature flag in your medusa backend project.
-     * @returns a sales channel
+     * @param selector - SC selector
+     * @param config - find config
+     * @returns a single SC matching the query or throws
      */
-    SalesChannelService.prototype.retrieve = function (salesChannelId, config) {
+    SalesChannelService.prototype.retrieve_ = function (selector, config) {
         if (config === void 0) { config = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var manager, salesChannelRepo, query, salesChannel;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var manager, salesChannelRepo, _a, relations, query, salesChannel, selectorConstraints;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         manager = this.manager_;
                         salesChannelRepo = manager.getCustomRepository(this.salesChannelRepository_);
-                        query = (0, utils_1.buildQuery)({
-                            id: salesChannelId,
-                        }, config);
-                        return [4 /*yield*/, salesChannelRepo.findOne(query)];
+                        _a = (0, utils_1.buildQuery)(selector, config), relations = _a.relations, query = __rest(_a, ["relations"]);
+                        return [4 /*yield*/, salesChannelRepo.findOneWithRelations(relations, query)];
                     case 1:
-                        salesChannel = _a.sent();
+                        salesChannel = _b.sent();
                         if (!salesChannel) {
-                            throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.NOT_FOUND, "Sales channel with id ".concat(salesChannelId, " was not found"));
+                            selectorConstraints = Object.entries(selector)
+                                .map(function (key, value) { return "".concat(key, ": ").concat(value); })
+                                .join(", ");
+                            throw new medusa_core_utils_1.MedusaError(medusa_core_utils_1.MedusaError.Types.NOT_FOUND, "Sales channel with ".concat(selectorConstraints, " was not found"));
                         }
                         return [2 /*return*/, salesChannel];
                 }
             });
         });
     };
+    /**
+     * Retrieve a SalesChannel by id
+     *
+     * @param salesChannelId - id of the channel to retrieve
+     * @param config - SC config
+     * @experimental This feature is under development and may change in the future.
+     * To use this feature please enable the corresponding feature flag in your medusa backend project.
+     * @returns a sales channel
+     */
+    SalesChannelService.prototype.retrieve = function (salesChannelId, config) {
+        if (config === void 0) { config = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.retrieve_({ id: salesChannelId }, config)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Find a sales channel by name.
+     *
+     * @param name of the sales channel
+     * @param config - find config
+     * @return a sales channel with matching name
+     */
+    SalesChannelService.prototype.retrieveByName = function (name, config) {
+        if (config === void 0) { config = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.retrieve_({ name: name }, config)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Lists sales channels based on the provided parameters and includes the count of
      * sales channels that match the query.

package/dist/services/sales-channel.js.map

@@ -1 +1 @@
-{"version":3,"file":"sales-channel.js","sourceRoot":"","sources":["../../src/services/sales-channel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,uDAA+C;AAI/C,4CAAsD;AACtD,kCAAqC;AASrC;IAAkC,uCAAsB;IActD,6BAAY,EAKW;YAJrB,sBAAsB,4BAAA,EACtB,eAAe,qBAAA,EACf,OAAO,aAAA,EACP,YAAY,kBAAA;QAJd;QAME,8CAA8C;QAC9C,kBAAM;YACJ,sBAAsB,wBAAA;YACtB,eAAe,iBAAA;YACf,OAAO,SAAA;YACP,YAAY,cAAA;SACb,CAAC,SAMH;QAJC,KAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,KAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,KAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,KAAI,CAAC,aAAa,GAAG,YAAY,CAAA;;IACnC,CAAC;IAED;;;;;;OAMG;IACG,sCAAQ,GAAd,UACE,cAAsB,EACtB,MAAqC;QAArC,uBAAA,EAAA,WAAqC;;;;;;wBAE/B,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;wBACvB,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAClD,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wBAEK,KAAK,GAAG,IAAA,kBAAU,EACtB;4BACE,EAAE,EAAE,cAAc;yBACnB,EACD,MAAM,CACP,CAAA;wBAEoB,qBAAM,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAA;;wBAApD,YAAY,GAAG,SAAqC;wBAE1D,IAAI,CAAC,YAAY,EAAE;4BACjB,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,SAAS,EAC3B,gCAAyB,cAAc,mBAAgB,CACxD,CAAA;yBACF;wBAED,sBAAO,YAAY,EAAA;;;;KACpB;IAED;;;;;;OAMG;IACG,0CAAY,GAAlB,UACE,QAAqC,EACrC,MAGC;QAHD,uBAAA,EAAA;YACE,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,EAAE;SACT;;;;;;wBAEK,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;wBACvB,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAClD,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wBAEK,SAAS,gBAAQ,QAAQ,CAAE,CAAA;wBAEjC,IAAI,GAAG,IAAI,SAAS,EAAE;4BACpB,CAAC,GAAG,SAAS,CAAC,CAAC,CAAA;4BACf,OAAO,SAAS,CAAC,CAAC,CAAA;yBACnB;wBAEK,KAAK,GAAG,IAAA,kBAAU,EAAC,SAAS,EAAE,MAAM,CAAC,CAAA;6BAEvC,CAAC,EAAD,wBAAC;wBACI,qBAAM,gBAAgB,CAAC,gCAAgC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAA;4BAAxE,sBAAO,SAAiE,EAAA;4BAGnE,qBAAM,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAA;4BAAjD,sBAAO,SAA0C,EAAA;;;;KAClD;IAED;;;;;;OAMG;IACG,oCAAM,GAAZ,UAAa,IAA6B;;;;;4BACjC,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,OAAO;;;;;wCACrC,gBAAgB,GACpB,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;wCAErD,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;wCAElD,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,OAAO,CAAC;iDACxB,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,YAAY,CAAC,EAAE;6CACpB,CAAC,EAAA;;wCAJJ,SAII,CAAA;wCAEG,qBAAM,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAA;4CAAhD,sBAAO,SAAyC,EAAA;;;6BACjD,CAAC,EAAA;4BAbF,sBAAO,SAaL,EAAA;;;;KACH;IAEK,oCAAM,GAAZ,UACE,cAAsB,EACtB,IAA6B;;;;;4BAEtB,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;;wCAChD,gBAAgB,GACpB,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;wCAEjD,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;;wCAAlD,YAAY,GAAG,SAAmC;;4CAExD,KAAkB,KAAA,SAAA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,4CAAE;gDAA1B,GAAG;gDACZ,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oDACpC,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;iDAC9B;6CACF;;;;;;;;;wCAEc,qBAAM,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAA;;wCAAlD,MAAM,GAAG,SAAyC;wCAExD,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,kBAAkB,CAAC;iDACnC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,MAAM,CAAC,EAAE;6CACd,CAAC,EAAA;;wCAJJ,SAII,CAAA;wCAEJ,sBAAO,MAAM,EAAA;;;6BACd,CAAC,EAAA;4BArBF,sBAAO,SAqBL,EAAA;;;;KACH;IAED;;;;;OAKG;IACG,oCAAM,GAAZ,UAAa,cAAsB;;;;;4BAC1B,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAEoB,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,KAAK,CAC5D,cAAM,OAAA,KAAK,CAAC,EAAN,CAAM,CACb,EAAA;;wCAFK,YAAY,GAAG,SAEpB;wCAED,IAAI,CAAC,YAAY,EAAE;4CACjB,sBAAM;yCACP;wCAEa,qBAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;gDAC9C,MAAM,EAAE,CAAC,0BAA0B,CAAC;6CACrC,CAAC,EAAA;;wCAFI,KAAK,GAAG,SAEZ;wCAEF,IAAI,YAAY,CAAC,EAAE,MAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,wBAAwB,CAAA,EAAE;4CACvD,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,WAAW,EAC7B,6CAA6C,CAC9C,CAAA;yCACF;wCAED,qBAAM,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,EAAA;;wCAA/C,SAA+C,CAAA;wCAE/C,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,kBAAkB,CAAC;iDACnC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,cAAc;6CACnB,CAAC,EAAA;;wCAJJ,SAII,CAAA;;;;6BACL,CAAC,EAAA;4BA/BF,sBAAO,SA+BL,EAAA;;;;KACH;IAED;;;OAGG;IACG,2CAAa,GAAnB;;;;gBACE,sBAAO,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;wCAClC,qBAAM,IAAI,CAAC,aAAa;yCACnC,eAAe,CAAC,kBAAkB,CAAC;yCACnC,QAAQ,CAAC;wCACR,SAAS,EAAE,CAAC,uBAAuB,CAAC;qCACrC,CAAC,EAAA;;oCAJE,KAAK,GAAG,SAIV;oCAEJ,IAAI,KAAK,CAAC,wBAAwB,EAAE;wCAClC,sBAAO,KAAK,CAAC,qBAAqB,EAAA;qCACnC;oCAE2B,qBAAM,IAAI,CAAC,MAAM,CAAC;4CAC5C,WAAW,EAAE,mBAAmB;4CAChC,IAAI,EAAE,uBAAuB;4CAC7B,WAAW,EAAE,KAAK;yCACnB,CAAC,EAAA;;oCAJI,mBAAmB,GAAG,SAI1B;oCAEF,qBAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;4CAClE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE;yCACjD,CAAC,EAAA;;oCAFF,SAEE,CAAA;oCAEF,sBAAO,mBAAmB,EAAA;;;yBAC3B,CAAC,EAAA;;;KACH;IAED;;;;;OAKG;IACG,4CAAc,GAApB,UACE,cAAsB,EACtB,UAAoB;;;;;4BAEb,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAED,qBAAM,gBAAgB,CAAC,cAAc,CAAC,cAAc,EAAE,UAAU,CAAC,EAAA;;wCAAjE,SAAiE,CAAA;wCAE1D,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;4CAA1C,sBAAO,SAAmC,EAAA;;;6BAC3C,CAAC,EAAA;4BARF,sBAAO,SAQL,EAAA;;;;KACH;IAED;;;;;OAKG;IACG,yCAAW,GAAjB,UACE,cAAsB,EACtB,UAAoB;;;;;4BAEb,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAED,qBAAM,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,UAAU,CAAC,EAAA;;wCAA9D,SAA8D,CAAA;wCAEvD,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;4CAA1C,sBAAO,SAAmC,EAAA;;;6BAC3C,CAAC,EAAA;4BARF,sBAAO,SAQL,EAAA;;;;KACH;IA1QM,0BAAM,GAAG;QACd,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,uBAAuB;KACjC,CAAA;IAuQH,0BAAC;CAAA,AA5QD,CAAkC,mCAAsB,GA4QvD;AAED,kBAAe,mBAAmB,CAAA"}
+{"version":3,"file":"sales-channel.js","sourceRoot":"","sources":["../../src/services/sales-channel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA,uDAA+C;AAI/C,4CAAsD;AACtD,kCAAqC;AASrC;IAAkC,uCAAsB;IActD,6BAAY,EAKW;YAJrB,sBAAsB,4BAAA,EACtB,eAAe,qBAAA,EACf,OAAO,aAAA,EACP,YAAY,kBAAA;QAJd;QAME,8CAA8C;QAC9C,kBAAM;YACJ,sBAAsB,wBAAA;YACtB,eAAe,iBAAA;YACf,OAAO,SAAA;YACP,YAAY,cAAA;SACb,CAAC,SAMH;QAJC,KAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,KAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,KAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,KAAI,CAAC,aAAa,GAAG,YAAY,CAAA;;IACnC,CAAC;IAED;;;;;;OAMG;IACa,uCAAS,GAAzB,UACE,QAAgC,EAChC,MAAqC;QAArC,uBAAA,EAAA,WAAqC;;;;;;wBAE/B,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;wBAEvB,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAClD,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wBAEK,KAA0B,IAAA,kBAAU,EAAC,QAAQ,EAAE,MAAM,CAAC,EAApD,SAAS,eAAA,EAAK,KAAK,cAArB,aAAuB,CAAF,CAAiC;wBAEvC,qBAAM,gBAAgB,CAAC,oBAAoB,CAC9D,SAAmC,EACnC,KAAK,CACN,EAAA;;wBAHK,YAAY,GAAG,SAGpB;wBAED,IAAI,CAAC,YAAY,EAAE;4BACX,mBAAmB,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;iCACjD,GAAG,CAAC,UAAC,GAAG,EAAE,KAAK,IAAK,OAAA,UAAG,GAAG,eAAK,KAAK,CAAE,EAAlB,CAAkB,CAAC;iCACvC,IAAI,CAAC,IAAI,CAAC,CAAA;4BAEb,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,SAAS,EAC3B,6BAAsB,mBAAmB,mBAAgB,CAC1D,CAAA;yBACF;wBAED,sBAAO,YAAY,EAAA;;;;KACpB;IAED;;;;;;;;OAQG;IACG,sCAAQ,GAAd,UACE,cAAsB,EACtB,MAAqC;QAArC,uBAAA,EAAA,WAAqC;;;;4BAE9B,qBAAM,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,MAAM,CAAC,EAAA;4BAA3D,sBAAO,SAAoD,EAAA;;;;KAC5D;IAED;;;;;;OAMG;IACG,4CAAc,GAApB,UACE,IAAY,EACZ,MAAqC;QAArC,uBAAA,EAAA,WAAqC;;;;4BAE9B,qBAAM,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,MAAA,EAAE,EAAE,MAAM,CAAC,EAAA;4BAA7C,sBAAO,SAAsC,EAAA;;;;KAC9C;IAED;;;;;;OAMG;IACG,0CAAY,GAAlB,UACE,QAAqC,EACrC,MAGC;QAHD,uBAAA,EAAA;YACE,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,EAAE;SACT;;;;;;wBAEK,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;wBACvB,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,CAClD,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wBAEK,SAAS,gBAAQ,QAAQ,CAAE,CAAA;wBAEjC,IAAI,GAAG,IAAI,SAAS,EAAE;4BACpB,CAAC,GAAG,SAAS,CAAC,CAAC,CAAA;4BACf,OAAO,SAAS,CAAC,CAAC,CAAA;yBACnB;wBAEK,KAAK,GAAG,IAAA,kBAAU,EAAC,SAAS,EAAE,MAAM,CAAC,CAAA;6BAEvC,CAAC,EAAD,wBAAC;wBACI,qBAAM,gBAAgB,CAAC,gCAAgC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAA;4BAAxE,sBAAO,SAAiE,EAAA;4BAGnE,qBAAM,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAA;4BAAjD,sBAAO,SAA0C,EAAA;;;;KAClD;IAED;;;;;;OAMG;IACG,oCAAM,GAAZ,UAAa,IAA6B;;;;;4BACjC,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,OAAO;;;;;wCACrC,gBAAgB,GACpB,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;wCAErD,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;wCAElD,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,OAAO,CAAC;iDACxB,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,YAAY,CAAC,EAAE;6CACpB,CAAC,EAAA;;wCAJJ,SAII,CAAA;wCAEG,qBAAM,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAA;4CAAhD,sBAAO,SAAyC,EAAA;;;6BACjD,CAAC,EAAA;4BAbF,sBAAO,SAaL,EAAA;;;;KACH;IAEK,oCAAM,GAAZ,UACE,cAAsB,EACtB,IAA6B;;;;;4BAEtB,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;;wCAChD,gBAAgB,GACpB,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;wCAEjD,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;;wCAAlD,YAAY,GAAG,SAAmC;;4CAExD,KAAkB,KAAA,SAAA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,4CAAE;gDAA1B,GAAG;gDACZ,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oDACpC,YAAY,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;iDAC9B;6CACF;;;;;;;;;wCAEc,qBAAM,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAA;;wCAAlD,MAAM,GAAG,SAAyC;wCAExD,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,kBAAkB,CAAC;iDACnC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,MAAM,CAAC,EAAE;6CACd,CAAC,EAAA;;wCAJJ,SAII,CAAA;wCAEJ,sBAAO,MAAM,EAAA;;;6BACd,CAAC,EAAA;4BArBF,sBAAO,SAqBL,EAAA;;;;KACH;IAED;;;;;OAKG;IACG,oCAAM,GAAZ,UAAa,cAAsB;;;;;4BAC1B,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAEoB,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,KAAK,CAC5D,cAAM,OAAA,KAAK,CAAC,EAAN,CAAM,CACb,EAAA;;wCAFK,YAAY,GAAG,SAEpB;wCAED,IAAI,CAAC,YAAY,EAAE;4CACjB,sBAAM;yCACP;wCAEa,qBAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;gDAC9C,MAAM,EAAE,CAAC,0BAA0B,CAAC;6CACrC,CAAC,EAAA;;wCAFI,KAAK,GAAG,SAEZ;wCAEF,IAAI,YAAY,CAAC,EAAE,MAAK,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,wBAAwB,CAAA,EAAE;4CACvD,MAAM,IAAI,+BAAW,CACnB,+BAAW,CAAC,KAAK,CAAC,WAAW,EAC7B,6CAA6C,CAC9C,CAAA;yCACF;wCAED,qBAAM,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,EAAA;;wCAA/C,SAA+C,CAAA;wCAE/C,qBAAM,IAAI,CAAC,gBAAgB;iDACxB,eAAe,CAAC,kBAAkB,CAAC;iDACnC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE;gDACxC,EAAE,EAAE,cAAc;6CACnB,CAAC,EAAA;;wCAJJ,SAII,CAAA;;;;6BACL,CAAC,EAAA;4BA/BF,sBAAO,SA+BL,EAAA;;;;KACH;IAED;;;OAGG;IACG,2CAAa,GAAnB;;;;gBACE,sBAAO,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;wCAClC,qBAAM,IAAI,CAAC,aAAa;yCACnC,eAAe,CAAC,kBAAkB,CAAC;yCACnC,QAAQ,CAAC;wCACR,SAAS,EAAE,CAAC,uBAAuB,CAAC;qCACrC,CAAC,EAAA;;oCAJE,KAAK,GAAG,SAIV;oCAEJ,IAAI,KAAK,CAAC,wBAAwB,EAAE;wCAClC,sBAAO,KAAK,CAAC,qBAAqB,EAAA;qCACnC;oCAE2B,qBAAM,IAAI,CAAC,MAAM,CAAC;4CAC5C,WAAW,EAAE,mBAAmB;4CAChC,IAAI,EAAE,uBAAuB;4CAC7B,WAAW,EAAE,KAAK;yCACnB,CAAC,EAAA;;oCAJI,mBAAmB,GAAG,SAI1B;oCAEF,qBAAM,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC;4CAClE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE;yCACjD,CAAC,EAAA;;oCAFF,SAEE,CAAA;oCAEF,sBAAO,mBAAmB,EAAA;;;yBAC3B,CAAC,EAAA;;;KACH;IAED;;;;;OAKG;IACG,4CAAc,GAApB,UACE,cAAsB,EACtB,UAAoB;;;;;4BAEb,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAED,qBAAM,gBAAgB,CAAC,cAAc,CAAC,cAAc,EAAE,UAAU,CAAC,EAAA;;wCAAjE,SAAiE,CAAA;wCAE1D,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;4CAA1C,sBAAO,SAAmC,EAAA;;;6BAC3C,CAAC,EAAA;4BARF,sBAAO,SAQL,EAAA;;;;KACH;IAED;;;;;OAKG;IACG,yCAAW,GAAjB,UACE,cAAsB,EACtB,UAAoB;;;;;4BAEb,qBAAM,IAAI,CAAC,YAAY,CAAC,UAAO,kBAAkB;;;;;wCAChD,gBAAgB,GAAG,kBAAkB,CAAC,mBAAmB,CAC7D,IAAI,CAAC,uBAAuB,CAC7B,CAAA;wCAED,qBAAM,gBAAgB,CAAC,WAAW,CAAC,cAAc,EAAE,UAAU,CAAC,EAAA;;wCAA9D,SAA8D,CAAA;wCAEvD,qBAAM,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAA;4CAA1C,sBAAO,SAAmC,EAAA;;;6BAC3C,CAAC,EAAA;4BARF,sBAAO,SAQL,EAAA;;;;KACH;IA3SM,0BAAM,GAAG;QACd,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,uBAAuB;QAChC,OAAO,EAAE,uBAAuB;KACjC,CAAA;IAwSH,0BAAC;CAAA,AA7SD,CAAkC,mCAAsB,GA6SvD;AAED,kBAAe,mBAAmB,CAAA"}

package/dist/services/swap.d.ts

@@ -1,11 +1,33 @@
-export default SwapService;
-declare const SwapService_base: any;
+import { EntityManager } from "typeorm";
+import { TransactionBaseService } from "../interfaces";
+import LineItemAdjustmentService from "./line-item-adjustment";
+import { FindConfig, Selector } from "../types/common";
+import { SwapRepository } from "../repositories/swap";
+import CartService from "./cart";
+import { CustomShippingOptionService, EventBusService, FulfillmentService, InventoryService, LineItemService, OrderService, PaymentProviderService, ReturnService, ShippingOptionService, TotalsService } from "./index";
+import { Cart, LineItem, Order, ReturnItem, Swap } from "../models";
+import { CreateShipmentConfig } from "../types/fulfillment";
+declare type InjectedProps = {
+    manager: EntityManager;
+    swapRepository: typeof SwapRepository;
+    cartService: CartService;
+    eventBus: EventBusService;
+    orderService: OrderService;
+    returnService: ReturnService;
+    totalsService: TotalsService;
+    eventBusService: EventBusService;
+    lineItemService: LineItemService;
+    inventoryService: InventoryService;
+    fulfillmentService: FulfillmentService;
+    shippingOptionService: ShippingOptionService;
+    paymentProviderService: PaymentProviderService;
+    lineItemAdjustmentService: LineItemAdjustmentService;
+    customShippingOptionService: CustomShippingOptionService;
+};
 /**
  * Handles swaps
- * @extends BaseService
  */
-declare class SwapService extends SwapService_base {
-    [x: string]: any;
+declare class SwapService extends TransactionBaseService {
     static Events: {
         CREATED: string;
         RECEIVED: string;
@@ -17,209 +39,171 @@ declare class SwapService extends SwapService_base {
         REFUND_PROCESSED: string;
         FULFILLMENT_CREATED: string;
     };
-    constructor({ manager, swapRepository, eventBusService, cartService, totalsService, returnService, lineItemService, paymentProviderService, shippingMethodTaxLineRepository, shippingOptionService, fulfillmentService, orderService, inventoryService, customShippingOptionService, lineItemAdjustmentService, }: {
-        manager: any;
-        swapRepository: any;
-        eventBusService: any;
-        cartService: any;
-        totalsService: any;
-        returnService: any;
-        lineItemService: any;
-        paymentProviderService: any;
-        shippingMethodTaxLineRepository: any;
-        shippingOptionService: any;
-        fulfillmentService: any;
-        orderService: any;
-        inventoryService: any;
-        customShippingOptionService: any;
-        lineItemAdjustmentService: any;
-    });
-    /** @private @const {EntityManager} */
-    private manager_;
-    /** @private @const {SwapModel} */
-    private swapRepository_;
-    /** @private @const {TotalsService} */
-    private totalsService_;
-    /** @private @const {LineItemService} */
-    private lineItemService_;
-    /** @private @const {ReturnService} */
-    private returnService_;
-    /** @private @const {PaymentProviderService} */
-    private paymentProviderService_;
-    /** @private @const {CartService} */
-    private cartService_;
-    /** @private @const {FulfillmentService} */
-    private fulfillmentService_;
-    /** @private @const {OrderService} */
-    private orderService_;
-    /** @private @const {ShippingOptionService} */
-    private shippingOptionService_;
-    /** @private @const {InventoryService} */
-    private inventoryService_;
-    /** @private @const {EventBusService} */
-    private eventBus_;
-    /** @private @const {typeof ShippingMethodTaxLineRepository} */
-    private shippingTaxLineRepo_;
-    /** @private @const {CustomShippingOptionService} */
-    private customShippingOptionService_;
-    /** @private @const {LineItemAdjustmentService} */
-    private lineItemAdjustmentService_;
-    withTransaction(transactionManager: any): SwapService;
-    transformQueryForCart_(config: any): any;
+    protected manager_: EntityManager;
+    protected transactionManager_: EntityManager | undefined;
+    protected readonly swapRepository_: typeof SwapRepository;
+    protected readonly cartService_: CartService;
+    protected readonly eventBus_: EventBusService;
+    protected readonly orderService_: OrderService;
+    protected readonly returnService_: ReturnService;
+    protected readonly totalsService_: TotalsService;
+    protected readonly lineItemService_: LineItemService;
+    protected readonly inventoryService_: InventoryService;
+    protected readonly fulfillmentService_: FulfillmentService;
+    protected readonly shippingOptionService_: ShippingOptionService;
+    protected readonly paymentProviderService_: PaymentProviderService;
+    protected readonly lineItemAdjustmentService_: LineItemAdjustmentService;
+    protected readonly customShippingOptionService_: CustomShippingOptionService;
+    constructor({ manager, swapRepository, eventBusService, cartService, totalsService, returnService, lineItemService, paymentProviderService, shippingOptionService, fulfillmentService, orderService, inventoryService, customShippingOptionService, lineItemAdjustmentService, }: InjectedProps);
+    /**
+     * Transform find config object for retrieval.
+     *
+     * @param config parsed swap find config
+     * @return transformed find swap config
+     */
+    protected transformQueryForCart(config: Omit<FindConfig<Swap>, "select"> & {
+        select?: string[];
+    }): Omit<FindConfig<Swap>, "select"> & {
+        select?: string[];
+    } & {
+        cartSelects: FindConfig<Cart>["select"];
+        cartRelations: FindConfig<Cart>["relations"];
+    };
     /**
      * Retrieves a swap with the given id.
-     * @param {string} id - the id of the swap to retrieve
-     * @param {Object} config - the configuration to retrieve the swap
-     * @return {Promise<Swap>} the swap
+     *
+     * @param id - the id of the swap to retrieve
+     * @param config - the configuration to retrieve the swap
+     * @return the swap
      */
-    retrieve(id: string, config?: any): Promise<Swap>;
+    retrieve(id: string, config?: Omit<FindConfig<Swap>, "select"> & {
+        select?: string[];
+    }): Promise<Swap | never>;
     /**
      * Retrieves a swap based on its associated cart id
-     * @param {string} cartId - the cart id that the swap's cart has
-     * @param {string[]} relations - the relations to retrieve swap
-     * @return {Promise<Swap>} the swap
-     */
-    retrieveByCartId(cartId: string, relations?: string[]): Promise<Swap>;
-    /**
-     * @param {Object} selector - the query object for find
-     * @param {Object} config - the configuration used to find the objects. contains relations, skip, and take.
-     * @return {Promise} the result of the find operation
+     *
+     * @param cartId - the cart id that the swap's cart has
+     * @param relations - the relations to retrieve swap
+     * @return the swap
      */
-    list(selector: any, config?: any): Promise<any>;
+    retrieveByCartId(cartId: string, relations?: FindConfig<Swap>["relations"]): Promise<Swap | never>;
     /**
-     * @typedef OrderLike
-     * @property {Array<LineItem>} items - the items on the order
-     */
-    /**
-     * @typedef ReturnItem
-     * @property {string} item_id - the id of the item in the order to return from.
-     * @property {number} quantity - the amount of the item to return.
-     */
-    /**
-     * Goes through a list of return items to ensure that they exist on the
-     * original order. If the item exists it is verified that the quantity to
-     * return is not higher than the original quantity ordered.
-     * @param {OrderLike} order - the order to return from
-     * @param {Array<ReturnItem>} returnItems - the items to return
-     * @return {Array<ReturnItems>} the validated returnItems
-     */
-    validateReturnItems_(order: {
-        /**
-         * - the items on the order
-         */
-        items: Array<LineItem>;
-    }, returnItems: {
-        /**
-         * - the id of the item in the order to return from.
-         */
-        item_id: string;
-        /**
-         * - the amount of the item to return.
-         */
-        quantity: number;
-    }[]): Array<ReturnItems>;
-    /**
-     * @typedef PreliminaryLineItem
-     * @property {string} variant_id - the id of the variant to create an item from
-     * @property {number} quantity - the amount of the variant to add to the line item
+     * List swaps.
+     *
+     * @param selector - the query object for find
+     * @param config - the configuration used to find the objects. contains relations, skip, and take.
+     * @return the result of the find operation
      */
+    list(selector: Selector<Swap>, config?: FindConfig<Swap>): Promise<Swap[]>;
     /**
      * Creates a swap from an order, with given return items, additional items
      * and an optional return shipping method.
-     * @param {Order} order - the order to base the swap off.
-     * @param {Array<ReturnItem>} returnItems - the items to return in the swap.
-     * @param {Array<PreliminaryLineItem> | undefined} additionalItems - the items to send to
-     *  the customer.
-     * @param {ReturnShipping?} returnShipping - an optional shipping method for
-     *  returning the returnItems.
-     * @param {Object} custom - contains relevant custom information. This object may
+     *
+     * @param order - the order to base the swap off
+     * @param returnItems - the items to return in the swap
+     * @param additionalItems - the items to send to the customer
+     * @param returnShipping - an optional shipping method for returning the returnItems
+     * @param custom - contains relevant custom information. This object may
      *  include no_notification which will disable sending notification when creating
-     *  swap. If set, it overrules the attribute inherited from the order.
-     * @return {Promise<Swap>} the newly created swap.
-     */
-    create(order: Order, returnItems: {
-        /**
-         * - the id of the item in the order to return from.
-         */
-        item_id: string;
-        /**
-         * - the amount of the item to return.
-         */
-        quantity: number;
-    }[], additionalItems: {
-        /**
-         * - the id of the variant to create an item from
-         */
-        variant_id: string;
-        /**
-         * - the amount of the variant to add to the line item
-         */
-        quantity: number;
-    }[] | undefined, returnShipping: ReturnShipping | null, custom?: any): Promise<Swap>;
-    processDifference(swapId: any): Promise<any>;
-    update(swapId: any, update: any): Promise<any>;
-    /**
-     * Creates a cart from the given swap and order. The cart can be used to pay
+     *  swap. If set, it overrules the attribute inherited from the order
+     * @return the newly created swap
+     */
+    create(order: Order, returnItems: Partial<ReturnItem>[], additionalItems?: Pick<LineItem, "variant_id" | "quantity">[], returnShipping?: {
+        option_id: string;
+        price?: number;
+    }, custom?: {
+        no_notification?: boolean;
+        idempotency_key?: string;
+        allow_backorder?: boolean;
+    }): Promise<Swap | never>;
+    /**
+     * Process difference for the requested swap.
+     *
+     * @param swapId id of a swap being processed
+     * @return processed swap
+     */
+    processDifference(swapId: string): Promise<Swap | never>;
+    /**
+     * Update the swap record.
+     *
+     * @param swapId id of a swap to update
+     * @param update new data
+     * @return updated swap record
+     */
+    update(swapId: string, update: Partial<Swap>): Promise<Swap>;
+    /**
+     * Creates a cart from the given swap. The cart can be used to pay
      * for differences associated with the swap. The swap represented by the
      * swapId must belong to the order. Fails if there is already a cart on the
      * swap.
-     * @param {string} swapId - the id of the swap to create the cart from
-     * @param {object[]} customShippingOptions - the shipping options
-     * @param {Order} order - the order to create the cart from
-     * @return {Promise<Swap>} the swap with its cart_id prop set to the id of
-     *   the new cart.
+     *
+     * @param swapId - the id of the swap to create the cart from
+     * @param customShippingOptions - the shipping options
+     * @return the swap with its cart_id prop set to the id of the new cart.
      */
-    createCart(swapId: string, customShippingOptions?: object[]): Promise<Swap>;
+    createCart(swapId: string, customShippingOptions?: {
+        option_id: string;
+        price: number;
+    }[]): Promise<Swap | never>;
     /**
-     *@param {string} swapId - The id of the swap
+     * Register a cart completion
+     *
+     * @param swapId - The id of the swap
+     * @return swap related to the cart
      */
-    registerCartCompletion(swapId: string): Promise<any>;
+    registerCartCompletion(swapId: string): Promise<Swap | never>;
     /**
      * Cancels a given swap if possible. A swap can only be canceled if all
      * related returns, fulfillments, and payments have been canceled. If a swap
      * is associated with a refund, it cannot be canceled.
-     * @param {string} swapId - the id of the swap to cancel.
-     * @return {Promise<Swap>} the canceled swap.
+     *
+     * @param swapId - the id of the swap to cancel.
+     * @return the canceled swap.
      */
-    cancel(swapId: string): Promise<Swap>;
+    cancel(swapId: string): Promise<Swap | never>;
     /**
-     * Fulfills the addtional items associated with the swap. Will call the
+     * Fulfills the additional items associated with the swap. Will call the
      * fulfillment providers associated with the shipping methods.
+     *
      * @param {string} swapId - the id of the swap to fulfill,
      * @param {object} config - optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag.
      * @return {Promise<Swap>} the updated swap with new status and fulfillments.
      */
-    createFulfillment(swapId: string, config?: object): Promise<Swap>;
+    createFulfillment(swapId: string, config?: CreateShipmentConfig): Promise<Swap | never>;
     /**
      * Cancels a fulfillment (if related to a swap)
-     * @param {string} fulfillmentId - the ID of the fulfillment to cancel
-     * @return {Swap} updated swap
+     *
+     * @param fulfillmentId - the ID of the fulfillment to cancel
+     * @return updated swap
      */
-    cancelFulfillment(fulfillmentId: string): Swap;
+    cancelFulfillment(fulfillmentId: string): Promise<Swap | never>;
     /**
      * Marks a fulfillment as shipped and attaches tracking numbers.
-     * @param {string} swapId - the id of the swap that has been shipped.
-     * @param {string} fulfillmentId - the id of the specific fulfillment that
-     *   has been shipped
-     * @param {TrackingLink[] | undefined} trackingLinks - the tracking numbers associated
-     *   with the shipment
-     * @param {object} config - optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag.
-     * @return {Promise<Swap>} the updated swap with new fulfillments and status.
+     *
+     * @param swapId - the id of the swap that has been shipped.
+     * @param fulfillmentId - the id of the specific fulfillment that has been shipped
+     * @param trackingLinks - the tracking numbers associated with the shipment
+     * @param config - optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag.
+     * @return the updated swap with new fulfillments and status.
      */
-    createShipment(swapId: string, fulfillmentId: string, trackingLinks: TrackingLink[] | undefined, config?: object): Promise<Swap>;
+    createShipment(swapId: string, fulfillmentId: string, trackingLinks?: {
+        tracking_number: string;
+    }[], config?: CreateShipmentConfig): Promise<Swap | never>;
     /**
      * Dedicated method to delete metadata for a swap.
-     * @param {string} swapId - the order to delete metadata from.
-     * @param {string} key - key for metadata field
-     * @return {Promise} resolves to the updated result.
+     *
+     * @param swapId - the order to delete metadata from.
+     * @param key - key for metadata field
+     * @return resolves to the updated result.
      */
-    deleteMetadata(swapId: string, key: string): Promise<any>;
+    deleteMetadata(swapId: string, key: string): Promise<Swap | never>;
     /**
      * Registers the swap return items as received so that they cannot be used
      * as a part of other swaps/returns.
-     * @param {string} id - the id of the order with the swap.
-     * @param {string} swapId - the id of the swap that has been received.
-     * @return {Promise<Order>} the resulting order
+     *
+     * @param id - the id of the order with the swap.
+     * @return the resulting order
      */
-    registerReceived(id: string): Promise<Order>;
+    registerReceived(id: any): Promise<Swap | never>;
 }
+export default SwapService;