mts-booking-library 1.2.10 → 1.2.12

package/lib/booking/journeyBooking.js

@@ -61,9 +61,20 @@ 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 __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.JourneyBooking = void 0;
 var ErrorResponse_1 = require("../types/ErrorResponse");
+var Reduction_1 = require("../types/common/Reduction");
+var processBookingSteps_1 = require("../utils/processBookingSteps");
 var booking_1 = require("./booking");
 var JourneyBooking = /** @class */ (function (_super) {
     __extends(JourneyBooking, _super);
@@ -106,13 +117,7 @@ var JourneyBooking = /** @class */ (function (_super) {
                                 _this.cartId = cart.id;
                                 _this.bookingDueDate = cartDate; // See Booking class
                                 // Fill the booking process status
-                                _this.bookingStepsToStatus = new Map(Object.entries(cart.stepsToStatus).map(function (_a) {
-                                    var bookingStep = _a[0], values = _a[1];
-                                    return [
-                                        bookingStep,
-                                        values
-                                    ];
-                                }));
+                                _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(cart.stepsToStatus);
                                 _this.createCartTimer(cartDate);
                             }
                         })];
@@ -260,13 +265,7 @@ var JourneyBooking = /** @class */ (function (_super) {
                         // Save the cartId in the localStorage
                         localStorage.setItem("cartId", response.cart.id.toString());
                         // Fill the booking process status
-                        _this.bookingStepsToStatus = new Map(Object.entries(response.cart.stepsToStatus).map(function (_a) {
-                            var bookingStep = _a[0], values = _a[1];
-                            return [
-                                bookingStep,
-                                values
-                            ];
-                        }));
+                        _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(response.cart.stepsToStatus);
                         _this.bookingDueDate = new Date(response.cart.bookingDueDate);
                         _this.createCartTimer(new Date(response.cart.bookingDueDate));
                         return response.cart;
@@ -367,11 +366,12 @@ var JourneyBooking = /** @class */ (function (_super) {
     /**
      * @description This methosd shall be called when the user wants to update the buyer and the passengers information.
      * @param {EditPassengersDetailsRequest} passengersDetails The object containing the buyer and the passengers information.
-     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
     JourneyBooking.prototype.updateBuyerPassengersDetails = function (passengersDetails) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, request, url;
+            var _this = this;
             return __generator(this, function (_a) {
                 // First check that it is possible to call this API
                 if (!this.cart) {
@@ -391,7 +391,12 @@ var JourneyBooking = /** @class */ (function (_super) {
                 });
                 url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/details");
                 return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
-                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        // Update the booking process status
+                        _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(response.stepsToStatus);
+                        return true;
                     })];
             });
         });
@@ -456,11 +461,12 @@ var JourneyBooking = /** @class */ (function (_super) {
      * @description This method shall be called when the user wants to change the assigned seats of a trip.
      * @param {number} tripId The id of the trip for which the seats should be changed
      * @param {number[]} newSeatsIds The ids of the new seats, as found the {@link BusMatrix}
-     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
     JourneyBooking.prototype.changeSeatsOfTrip = function (tripId, newSeatsIds) {
         return __awaiter(this, void 0, void 0, function () {
             var seatSelectionStatus, url;
+            var _this = this;
             return __generator(this, function (_a) {
                 // First check that it is possible to call this API
                 if (!this.cart) {
@@ -472,11 +478,304 @@ var JourneyBooking = /** @class */ (function (_super) {
                 }
                 url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/seats");
                 return [2 /*return*/, this.callPostApi(url, { tripId: tripId, seatsIds: newSeatsIds }).then(function (response) {
-                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        // Update the booking process status
+                        _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(response.stepsToStatus);
+                        return true;
                     })];
             });
         });
     };
+    //#region Reductions APIs
+    /**
+     * @description This method shall be called when the user wants to retrieve the trips in the cart, for adding a available reduction
+     * to a specific trip (rather than to the whole cart).
+     * @see {@link Booking.addReduction} for detailed info on how to add a reduction.
+     * @returns An {@link ErrorResponse} object in case of error, a list of {@link ReductionTrip} otherwise, representing the trips in the cart.
+     */
+    JourneyBooking.prototype.getCartTrips = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/payment/reduction/trips");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.trips;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
+     * @param {AddReductionRequest} request The information about the reduction to add
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    JourneyBooking.prototype.addReduction = function (request) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, _b, _c, _d, _i, step, url;
+            var _this = this;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        // First check that it is possible to call this API
+                        if (!this.cartId || this.cartId === 0) {
+                            throw Error("Cart is not initialized yet");
+                        }
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep)
+                            throw Error("Booking step not found!");
+                        if (!!discountsStep[0]) return [3 /*break*/, 5];
+                        _b = [booking_1.Booking.BookingSteps.SEATS_SELECTION, booking_1.Booking.BookingSteps.EXTRAS];
+                        _c = [];
+                        for (_d in _b)
+                            _c.push(_d);
+                        _i = 0;
+                        _e.label = 1;
+                    case 1:
+                        if (!(_i < _c.length)) return [3 /*break*/, 4];
+                        _d = _c[_i];
+                        if (!(_d in _b)) return [3 /*break*/, 3];
+                        step = _d;
+                        if (!!((_a = this.bookingStepsToStatus.get(step)) !== null && _a !== void 0 ? _a : [false])[0]) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.markBookingStepCompleted(step)];
+                    case 2:
+                        _e.sent();
+                        _e.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        // Check again if the discounts step is accessible
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep || !discountsStep[0]) {
+                            throw Error("The status of the cart does not allow to call this API");
+                        }
+                        _e.label = 5;
+                    case 5:
+                        url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cartId, "/payment/reduction");
+                        return [2 /*return*/, this.callPostApi(url, request).then(function (response) {
+                                var _a, _b;
+                                if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                                    return response;
+                                }
+                                var reductionResponse = response;
+                                // Update the booking process status
+                                _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(reductionResponse.stepsToStatus);
+                                // Update the cart
+                                _this.cart = __assign(__assign({}, _this.cart), { totalAmountToPay: reductionResponse.totalAmountToPay, reductions: __spreadArray(__spreadArray([], ((_b = (_a = _this.cart) === null || _a === void 0 ? void 0 : _a.reductions) !== null && _b !== void 0 ? _b : []), true), [reductionResponse.reduction], false) });
+                                return true;
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * @description This method allows to remove a reduction from the whole cart or from a single trip in the cart.
+     * @param tripId The id of the trip from which the reduction should be removed. If the tripId is 0, then the reduction
+     * will be removed from the whole cart.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    JourneyBooking.prototype.removeReduction = function (tripId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, queryParams, url;
+            var _this = this;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                if (!discountsStep || !discountsStep[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                queryParams = new URLSearchParams({ tripId: tripId.toString() });
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cartId, "/payment/reduction?").concat(queryParams);
+                return [2 /*return*/, this.callDeleteApi(url).then(function (response) {
+                        var _a, _b, _c;
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        var reductionResponse = response;
+                        // Update the booking process status
+                        _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(reductionResponse.stepsToStatus);
+                        // Update the cart
+                        _this.cart = __assign(__assign({}, _this.cart), { totalAmountToPay: reductionResponse.totalAmountToPay, reductions: (_c = (_b = (_a = _this.cart) === null || _a === void 0 ? void 0 : _a.reductions) === null || _b === void 0 ? void 0 : _b.filter(function (reduction) { return reduction.type === Reduction_1.ReductionType.WALLET ||
+                                reduction.type === Reduction_1.ReductionType.VOUCHER ||
+                                (reduction.type === Reduction_1.ReductionType.CASH && reduction.tripId !== tripId); })) !== null && _c !== void 0 ? _c : [] });
+                        return true;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method allows the user to use the balance in his wallet to pay the cart. If the balance of
+     * the wallet is enough to pay the cart, the cart will be paid fully. Otherwise, the user will be asked to pay the
+     * remaining amount with another payment method.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
+     */
+    JourneyBooking.prototype.useWallet = function () {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, _b, _c, _d, _i, step, url;
+            var _this = this;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        // First check that it is possible to call this API
+                        if (!this.cartId || this.cartId === 0) {
+                            throw Error("Cart is not initialized yet");
+                        }
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep)
+                            throw Error("Booking step not found!");
+                        if (!!discountsStep[0]) return [3 /*break*/, 5];
+                        _b = [booking_1.Booking.BookingSteps.SEATS_SELECTION, booking_1.Booking.BookingSteps.EXTRAS];
+                        _c = [];
+                        for (_d in _b)
+                            _c.push(_d);
+                        _i = 0;
+                        _e.label = 1;
+                    case 1:
+                        if (!(_i < _c.length)) return [3 /*break*/, 4];
+                        _d = _c[_i];
+                        if (!(_d in _b)) return [3 /*break*/, 3];
+                        step = _d;
+                        if (!!((_a = this.bookingStepsToStatus.get(step)) !== null && _a !== void 0 ? _a : [false])[0]) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.markBookingStepCompleted(step)];
+                    case 2:
+                        _e.sent();
+                        _e.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        // Check again if the discounts step is accessible
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep || !discountsStep[0]) {
+                            throw Error("The status of the cart does not allow to call this API");
+                        }
+                        _e.label = 5;
+                    case 5:
+                        url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cartId, "/payment/wallet");
+                        return [2 /*return*/, this.callPostApi(url, {}).then(function (response) {
+                                var _a, _b;
+                                if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                                    return response;
+                                }
+                                var reductionResponse = response;
+                                // Update the booking process status
+                                _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(reductionResponse.stepsToStatus);
+                                // Update the cart
+                                _this.cart = __assign(__assign({}, _this.cart), { totalAmountToPay: reductionResponse.totalAmountToPay, reductions: __spreadArray(__spreadArray([], ((_b = (_a = _this.cart) === null || _a === void 0 ? void 0 : _a.reductions) !== null && _b !== void 0 ? _b : []), true), [reductionResponse.reduction], false) });
+                                return true;
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * @description This method allows to remove a waller reduction from the cart.
+     *
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    JourneyBooking.prototype.removeWalletReduction = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            var _this = this;
+            return __generator(this, function (_a) {
+                // First check that it is possible to call this API
+                if (!this.cartId || this.cartId === 0) {
+                    throw Error("Cart is not initialized yet");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cartId, "/payment/wallet");
+                return [2 /*return*/, this.callDeleteApi(url).then(function (response) {
+                        var _a, _b, _c;
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        var reductionResponse = response;
+                        // Update the booking process status
+                        _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(reductionResponse.stepsToStatus);
+                        // Update the cart
+                        _this.cart = __assign(__assign({}, _this.cart), { totalAmountToPay: reductionResponse.totalAmountToPay, reductions: (_c = (_b = (_a = _this.cart) === null || _a === void 0 ? void 0 : _a.reductions) === null || _b === void 0 ? void 0 : _b.filter(function (reduction) { return reduction.type !== Reduction_1.ReductionType.WALLET; })) !== null && _c !== void 0 ? _c : [] });
+                        return true;
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method allows the user to use a voucher to pay the cart.
+     * If the balance of the value of the voucher is enough to pay the cart, the cart will be paid fully.
+     * Otherwise, the user will be asked to pay the remaining amount with another payment method.
+     * @param {string} voucherCode The code of the voucher to use
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
+     */
+    JourneyBooking.prototype.useVoucher = function (voucherCode) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var discountsStep, _b, _c, _d, _i, step, url;
+            var _this = this;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        // First check that it is possible to call this API
+                        if (!this.cartId || this.cartId === 0) {
+                            throw Error("Cart is not initialized yet");
+                        }
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep)
+                            throw Error("Booking step not found!");
+                        if (!!discountsStep[0]) return [3 /*break*/, 5];
+                        _b = [booking_1.Booking.BookingSteps.SEATS_SELECTION, booking_1.Booking.BookingSteps.EXTRAS];
+                        _c = [];
+                        for (_d in _b)
+                            _c.push(_d);
+                        _i = 0;
+                        _e.label = 1;
+                    case 1:
+                        if (!(_i < _c.length)) return [3 /*break*/, 4];
+                        _d = _c[_i];
+                        if (!(_d in _b)) return [3 /*break*/, 3];
+                        step = _d;
+                        if (!!((_a = this.bookingStepsToStatus.get(step)) !== null && _a !== void 0 ? _a : [false])[0]) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.markBookingStepCompleted(step)];
+                    case 2:
+                        _e.sent();
+                        _e.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        // Check again if the discounts step is accessible
+                        discountsStep = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.DISCOUNTS);
+                        if (!discountsStep || !discountsStep[0]) {
+                            throw Error("The status of the cart does not allow to call this API");
+                        }
+                        _e.label = 5;
+                    case 5:
+                        url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cartId, "/payment/voucher");
+                        return [2 /*return*/, this.callPostApi(url, { voucherCode: voucherCode }).then(function (response) {
+                                var _a, _b;
+                                if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                                    return response;
+                                }
+                                var reductionResponse = response;
+                                // Update the booking process status
+                                _this.bookingStepsToStatus = (0, processBookingSteps_1.processBookingSteps)(reductionResponse.stepsToStatus);
+                                // Update the cart
+                                _this.cart = __assign(__assign({}, _this.cart), { totalAmountToPay: reductionResponse.totalAmountToPay, reductions: __spreadArray(__spreadArray([], ((_b = (_a = _this.cart) === null || _a === void 0 ? void 0 : _a.reductions) !== null && _b !== void 0 ? _b : []), true), [reductionResponse.reduction], false) });
+                                return true;
+                            })];
+                }
+            });
+        });
+    };
     return JourneyBooking;
 }(booking_1.Booking));
 exports.JourneyBooking = JourneyBooking;

package/lib/booking/serviceBooking.d.ts

@@ -1,6 +1,7 @@
 import { MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
 import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
+import { AddReductionRequest } from "../types/common/Reduction";
 import { Service, ServiceTrip } from "../types/services/Service";
 import { CreateServiceCartRequest, ServiceCart } from "../types/services/ServiceCart";
 import { Booking } from "./booking";
@@ -71,9 +72,43 @@ export declare class ServiceBooking extends Booking {
     /**
      * @description This method shall be called when the user wants to update the buyer information.
      * @param {Person} buyerDetails The object containing the buyer information.
-     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
      */
-    updateBuyerPassengersDetails(buyerDetails: Person): Promise<ErrorResponse | any>;
+    updateBuyerPassengersDetails(buyerDetails: Person): Promise<ErrorResponse | boolean>;
+    /**
+     * @description This method allows to add a reduction to the whole cart or to a single trip in the cart.
+     * @param {AddReductionRequest} request The information about the reduction to add
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    addReduction(request: AddReductionRequest): Promise<ErrorResponse | boolean>;
+    /**
+     * @description This method allows to remove a reduction from the whole cart or from a single trip in the cart.
+     * @param tripId The id of the trip from which the reduction should be removed. If the tripId is 0, then the reduction
+     * will be removed from the whole cart.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    removeReduction(tripId: number): Promise<ErrorResponse | boolean>;
+    /**
+     * @description This method allows the user to use the balance in his wallet to pay the cart. If the balance of
+     * the wallet is enough to pay the cart, the cart will be paid fully. Otherwise, the user will be asked to pay the
+     * remaining amount with another payment method.
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
+     */
+    useWallet(): Promise<ErrorResponse | boolean>;
+    /**
+     * @description This method allows to remove a waller reduction from the cart.
+     *
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise. Also, the cart is updated.
+     */
+    removeWalletReduction(): Promise<ErrorResponse | boolean>;
+    /**
+     * @description This method allows the user to use a voucher to pay the cart.
+     * If the balance of the value of the voucher is enough to pay the cart, the cart will be paid fully.
+     * Otherwise, the user will be asked to pay the remaining amount with another payment method.
+     * @param {string} voucherCode The code of the voucher to use
+     * @returns An {@link ErrorResponse} object in case of error, true otherwise.
+     */
+    useVoucher(voucherCode: string): Promise<ErrorResponse | boolean>;
 }
 export declare namespace ServiceBooking {
     const createBooking: (env: MTSEnvs, sub_key: string, onCartExpiration: () => void, debug: boolean, language: string, access_token?: string, sellerId?: number, resellerId?: number) => Promise<ServiceBooking>;