mts-booking-library 1.2.8 → 1.2.9

package/lib/booking/booking.d.ts

@@ -1,6 +1,7 @@
 import { MTSConfig, MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
 import { GetPaymentInformationFromGatewayResponse, GetSellerGatewaysResponse, PaymentMethods } from "../types/common/Payment";
+import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
 export declare abstract class Booking {
     readonly sellerId?: number | undefined;
@@ -45,6 +46,10 @@ export declare abstract class Booking {
     changeCurrency(currency: Booking.Currencies): void;
     changeLanguage(language: string): void;
     getCartExpirationTimeInMs(): Promise<number>;
+    abstract deleteCart(): Promise<ErrorResponse | any>;
+    abstract getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
+    abstract getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    abstract updateBuyerPassengersDetails(request: any): Promise<ErrorResponse | any>;
     /**
      * @description This method allows to add a reduction to the cart
      * @param {AddReductionRequest} request The information about the reduction to add

package/lib/booking/booking.js

@@ -134,6 +134,8 @@ var Booking = /** @class */ (function () {
             });
         });
     };
+    //#endregion
+    //#region Reductions APIs
     /**
      * @description This method allows to add a reduction to the cart
      * @param {AddReductionRequest} request The information about the reduction to add
@@ -209,6 +211,8 @@ var Booking = /** @class */ (function () {
             });
         });
     };
+    //#endregion
+    //#region Payment APIs
     /**
      * @description This method shall be used to get the available payment methods for the cart. They depend on the seller configuration.
      * @returns An {@link ErrorResponse} object in case of error, a {@link GetSellerGatewaysResponse} object otherwise.

package/lib/booking/journeyBooking.d.ts

@@ -24,6 +24,12 @@ export declare class JourneyBooking extends Booking {
     fetchAndSetCart(cartId: number): Promise<void>;
     private createCartTimer;
     fetchCart(cartId: number): Promise<JourneyCart>;
+    /**
+     * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+     * data will be deleted.
+     */
+    deleteCart(): Promise<ErrorResponse | any>;
     /**
     * This method returns the possible departures for all journeys (MLP) sold by this seller.
     * @returns {string[]} The list of possible departures
@@ -58,7 +64,7 @@ export declare class JourneyBooking extends Booking {
      * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
      * as well as a list of the available tariffs for each trip.
      */
-    getBuyer(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
     /**
      * @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.

package/lib/booking/journeyBooking.js

@@ -82,9 +82,8 @@ var JourneyBooking = /** @class */ (function (_super) {
     function JourneyBooking(env, sub_key, onCartExpiration, debug, language, access_token, sellerId, resellerId) {
         if (debug === void 0) { debug = false; }
         if (language === void 0) { language = booking_1.Booking.Languages.EN; }
-        var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP, debug, language, access_token, sellerId, resellerId) || this;
+        var _this = _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP, debug, language, access_token, sellerId, resellerId) || this;
         // Set cartId
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
@@ -156,6 +155,33 @@ var JourneyBooking = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+     * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+     * data will be deleted.
+     */
+    JourneyBooking.prototype.deleteCart = 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.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/removeBookingFromCart");
+                return [2 /*return*/, this.callPostApi(url, { cartId: this.cart.id }).then(function (response) {
+                        // Clear all data
+                        localStorage.removeItem("cartId");
+                        _this.bookingStepsToStatus = new Map();
+                        _this.cart = undefined;
+                        _this.cartId = undefined;
+                        _this.bookingDueDate = undefined; // See Booking class
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
     /**
     * This method returns the possible departures for all journeys (MLP) sold by this seller.
     * @returns {string[]} The list of possible departures
@@ -308,7 +334,7 @@ var JourneyBooking = /** @class */ (function (_super) {
      * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
      * as well as a list of the available tariffs for each trip.
      */
-    JourneyBooking.prototype.getBuyer = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+    JourneyBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, searchParams, url;
             return __generator(this, function (_a) {

package/lib/booking/serviceBooking.d.ts

@@ -1,5 +1,6 @@
 import { MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
+import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
 import { Service, ServiceTrip } from "../types/services/Service";
 import { CreateServiceCartRequest, ServiceCart } from "../types/services/ServiceCart";
 import { Booking } from "./booking";
@@ -23,6 +24,12 @@ export declare class ServiceBooking extends Booking {
     private createCartTimer;
     fetchCart(cartId: number): Promise<ServiceCart>;
     /**
+   * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+   * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+   * data will be deleted.
+   */
+    deleteCart(): Promise<ErrorResponse | any>;
+    /**
     * This method returns the list of cities in which the seller offers tours.
     * If the sellerId is not set or it is 0, it will return the list of cities for all sellers.
     * @returns {string[]} The list of possible cities
@@ -46,6 +53,27 @@ export declare class ServiceBooking extends Booking {
     */
     getServiceTrips(serviceId: number, date: Date): Promise<ErrorResponse | ServiceTrip[]>;
     createServiceCart(serviceCart: CreateServiceCartRequest): Promise<ErrorResponse | ServiceCart>;
+    /**
+     * @description This method shall be called when the user wants to retrieve information about the buyer and the passengers.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    getBuyerPassengersDetails(): Promise<ErrorResponse | GetBuyerPassengersDetailsResponse>;
+    /**
+     * @description This method shall be called when the user wants to retrieve information about an esisting buyer.
+     * @param {string} [linkavelCardNumber=undefined] The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * A linkavelCardNumber is a string of 9 digits.
+     * @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    /**
+     * @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.
+     */
+    updateBuyerPassengersDetails(buyerDetails: Person): Promise<ErrorResponse | any>;
 }
 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>;

package/lib/booking/serviceBooking.js

@@ -82,9 +82,8 @@ var ServiceBooking = /** @class */ (function (_super) {
     function ServiceBooking(env, sub_key, onCartExpiration, debug, language, access_token, sellerId, resellerId) {
         if (debug === void 0) { debug = false; }
         if (language === void 0) { language = booking_1.Booking.Languages.EN; }
-        var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.SERVICE, debug, language, access_token, sellerId, resellerId) || this;
+        var _this = _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.SERVICE, debug, language, access_token, sellerId, resellerId) || this;
         // Set cartId
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
@@ -156,6 +155,33 @@ var ServiceBooking = /** @class */ (function (_super) {
         });
     };
     /**
+   * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+   * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+   * data will be deleted.
+   */
+    ServiceBooking.prototype.deleteCart = 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.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/removeBookingFromCart");
+                return [2 /*return*/, this.callPostApi(url, { cartId: this.cart.id }).then(function (response) {
+                        // Clear all data
+                        localStorage.removeItem("cartId");
+                        _this.bookingStepsToStatus = new Map();
+                        _this.cart = undefined;
+                        _this.cartId = undefined;
+                        _this.bookingDueDate = undefined; // See Booking class
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
     * This method returns the list of cities in which the seller offers tours.
     * If the sellerId is not set or it is 0, it will return the list of cities for all sellers.
     * @returns {string[]} The list of possible cities
@@ -241,6 +267,105 @@ var ServiceBooking = /** @class */ (function (_super) {
             });
         });
     };
+    //#region Buyer data API
+    /**
+     * @description This method shall be called when the user wants to retrieve information about the buyer and the passengers.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    ServiceBooking.prototype.getBuyerPassengersDetails = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, 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");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/booking/cart/").concat(this.cart.id, "/details?");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        // Check for errors
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        return {
+                            buyerDataStatus: response.buyerDataStatus,
+                            buyer: response.buyer,
+                            passengers: [],
+                        };
+                    })];
+            });
+        });
+    };
+    /**
+     * @description This method shall be called when the user wants to retrieve information about an esisting buyer.
+     * @param {string} [linkavelCardNumber=undefined] The linkavel card number of the buyer. This parameter is required if linkavelCardPhoneNumber is not set.
+     * A linkavelCardNumber is a string of 9 digits.
+     * @param {string} [linkavelCardPhoneNumber=undefined] The linkavel card phone number of the buyer. This parameter is required if linkavelCardNumber is not set.
+     * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
+     * as well as a list of the available tariffs for each trip.
+     */
+    ServiceBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, searchParams, 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");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                if (!linkavelCardNumber && !linkavelCardPhoneNumber) {
+                    throw Error("At least one of the parameters linkavelCardNumber and linkavelCardPhoneNumber must be set");
+                }
+                searchParams = new URLSearchParams({
+                    linkavelCardNumber: linkavelCardNumber !== null && linkavelCardNumber !== void 0 ? linkavelCardNumber : "",
+                    linkavelCardPhoneNumber: linkavelCardPhoneNumber !== null && linkavelCardPhoneNumber !== void 0 ? linkavelCardPhoneNumber : "",
+                });
+                url = "".concat(this.config.API_ENDPOINT, "/buyers?").concat(searchParams, "}");
+                return [2 /*return*/, this.callGetApi(url).then(function (response) {
+                        // Check for errors
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response)) {
+                            return response;
+                        }
+                        return response.buyers[0];
+                    })];
+            });
+        });
+    };
+    /**
+     * @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.
+     */
+    ServiceBooking.prototype.updateBuyerPassengersDetails = function (buyerDetails) {
+        return __awaiter(this, void 0, void 0, function () {
+            var buyerPassengersDetails, request, 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");
+                }
+                buyerPassengersDetails = this.bookingStepsToStatus.get(booking_1.Booking.BookingSteps.BUYER_PASSENGERS);
+                if (!buyerPassengersDetails || !buyerPassengersDetails[0]) {
+                    throw Error("The status of the cart does not allow to call this API");
+                }
+                request = {
+                    buyer: buyerDetails,
+                    passengers: [],
+                };
+                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;
+                    })];
+            });
+        });
+    };
     return ServiceBooking;
 }(booking_1.Booking));
 exports.ServiceBooking = ServiceBooking;

package/lib/booking/subscriptionBooking.d.ts

@@ -26,6 +26,12 @@ export declare class SubscriptionBooking extends Booking {
     private createCartTimer;
     fetchCart(cartId: number): Promise<Cart>;
     /**
+   * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+   * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+   * data will be deleted.
+   */
+    deleteCart(): Promise<ErrorResponse | any>;
+    /**
     * This method returns the possible departures for all subscriptions sold by this seller.
     * @returns {string[]} The list of possible departures
     */
@@ -81,7 +87,7 @@ export declare class SubscriptionBooking extends Booking {
      * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
      * as well as a list of the available tariffs for each trip.
      */
-    getBuyer(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
+    getBuyerFromLinkavelCard(linkavelCardNumber?: string, linkavelCardPhoneNumber?: string): Promise<ErrorResponse | Person>;
     /**
      * @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.

package/lib/booking/subscriptionBooking.js

@@ -82,9 +82,8 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     function SubscriptionBooking(env, sub_key, onCartExpiration, debug, language, access_token, sellerId, resellerId) {
         if (debug === void 0) { debug = false; }
         if (language === void 0) { language = booking_1.Booking.Languages.EN; }
-        var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP_SUBSCRIPTION, debug, language, access_token, sellerId, resellerId) || this;
+        var _this = _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP_SUBSCRIPTION, debug, language, access_token, sellerId, resellerId) || this;
         // Set cartId
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
@@ -157,6 +156,33 @@ var SubscriptionBooking = /** @class */ (function (_super) {
         });
     };
     /**
+   * This method allows to delete a cart, thus allowing the user to exit from the booking process.
+   * @returns An {@link ErrorResponse} object in case of error, nothing otherwise. Note that also in case of error, all
+   * data will be deleted.
+   */
+    SubscriptionBooking.prototype.deleteCart = 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.cart) {
+                    throw Error("Cart is not initialized yet");
+                }
+                url = "".concat(this.config.API_ENDPOINT, "/removeBookingFromCart");
+                return [2 /*return*/, this.callPostApi(url, { cartId: this.cart.id }).then(function (response) {
+                        // Clear all data
+                        localStorage.removeItem("cartId");
+                        _this.bookingStepsToStatus = new Map();
+                        _this.cart = undefined;
+                        _this.cartId = undefined;
+                        _this.bookingDueDate = undefined; // See Booking class
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
+    /**
     * This method returns the possible departures for all subscriptions sold by this seller.
     * @returns {string[]} The list of possible departures
     */
@@ -357,7 +383,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
      * @returns An object of type {@link GetBuyerPassengersDetailsResponse} containing the buyer and the passengers information,
      * as well as a list of the available tariffs for each trip.
      */
-    SubscriptionBooking.prototype.getBuyer = function (linkavelCardNumber, linkavelCardPhoneNumber) {
+    SubscriptionBooking.prototype.getBuyerFromLinkavelCard = function (linkavelCardNumber, linkavelCardPhoneNumber) {
         return __awaiter(this, void 0, void 0, function () {
             var buyerPassengersDetails, searchParams, url;
             return __generator(this, function (_a) {

package/lib/utils/apiCall.js

@@ -114,28 +114,28 @@ var makePost = function (url, data) { return __awaiter(void 0, void 0, void 0, f
         }
         return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
                 var response, error_2, resError;
-                var _a, _b, _c;
-                return __generator(this, function (_d) {
-                    switch (_d.label) {
+                var _a, _b, _c, _d, _e;
+                return __generator(this, function (_f) {
+                    switch (_f.label) {
                         case 0:
-                            _d.trys.push([0, 2, , 3]);
+                            _f.trys.push([0, 2, , 3]);
                             return [4 /*yield*/, axios_1.default.post(url, data, {
                                     headers: __assign({ "Content-Type": "application/json", "Ocp-Apim-Subscription-Key": (0, config_1.getConfig)().OCP_SUBSCRIPTION_KEY }, ((0, config_1.getConfig)().ACCESS_TOKEN && { "Authorization": "Bearer ".concat((0, config_1.getConfig)().ACCESS_TOKEN) })),
                                 })];
                         case 1:
-                            response = _d.sent();
+                            response = _f.sent();
                             if (debug) {
                                 console.log("PostResponseData", url, response.data);
                             }
                             resolve(response.data);
                             return [3 /*break*/, 3];
                         case 2:
-                            error_2 = _d.sent();
+                            error_2 = _f.sent();
                             if (axios_1.default.isAxiosError(error_2)) {
                                 resError = {
                                     httpStatus: ((_a = error_2.response) === null || _a === void 0 ? void 0 : _a.status) || 500,
-                                    mtsCode: ((_b = error_2.response) === null || _b === void 0 ? void 0 : _b.data.error.code) || 500,
-                                    message: ((_c = error_2.response) === null || _c === void 0 ? void 0 : _c.data.error.message) || "Unknown error",
+                                    mtsCode: ((_c = (_b = error_2.response) === null || _b === void 0 ? void 0 : _b.data.error) === null || _c === void 0 ? void 0 : _c.code) || 500,
+                                    message: ((_e = (_d = error_2.response) === null || _d === void 0 ? void 0 : _d.data.error) === null || _e === void 0 ? void 0 : _e.message) || "Unknown error",
                                 };
                                 if (debug) {
                                     console.log("GetResponseError", url, resError);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.2.8",
+  "version": "1.2.9",
   "description": "Library for use MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,10 +14,10 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "^29.5.7",
+    "@types/jest": "^29.5.10",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "files": [
     "lib/**/*"
@@ -28,7 +28,7 @@
   ],
   "author": "M",
   "dependencies": {
-    "axios": "^1.6.0",
+    "axios": "^1.6.2",
     "node-localstorage": "^3.0.5"
   }
 }