mts-booking-library 2.4.1 → 2.4.2

package/lib/SubscriptionBooking.js

@@ -0,0 +1,148 @@
+"use strict";
+// import { MTSEnvs } from "../config";
+// import { ServiceBooking } from "../booking/serviceBooking";
+// import { CreateServiceCartRequest, ServiceCart } from "../types/services/ServiceCart";
+// import { Service, ServiceTripsResponse } from "../types/services/Service";
+// import { GetBuyerPassengersDetailsResponse } from "../types/common/Person";
+// import { GetPaymentInformationFromGatewayResponse, GetSellerGatewaysResponse, PaymentMethods } from "../types/common/Payment";
+// import { useTestState } from "../mtsStorage";
+// import { SubscriptionBooking } from "../booking/subscriptionBooking";
+// // Load .env file
+// require('dotenv').config();
+// // How to run the test: npm run test -- SubscriptionBooking.test.ts
+// describe("SubscriptionBooking", () => {
+//   const timeOut = 120000;
+//   const sub_key = process.env.OCP_SUB_KEY_MTS;
+//   const access_token = process.env.ACCESS_TOKEN;
+//   const sellerId = 8; // ATV
+//   // Define localStorage for local testing
+//   if (typeof localStorage === "undefined" || localStorage === null) {
+//     var LocalStorage = require("node-localstorage").LocalStorage;
+//     global.localStorage = new LocalStorage("./scratch");
+//   }
+//   test("search_tpl", async () => {
+//     const booking = new SubscriptionBooking(MTSEnvs.TEST, sub_key!, true, SubscriptionBooking.Languages.EN, access_token, sellerId);
+//     // First, get the departures and destinations
+//     const departures = await booking.getSubscriptionsDepartures() as string[];
+//     expect(departures.length).toBeGreaterThan(0);
+//     expect(departures).toContain("BARDOLINO AUTOSTAZIONE");
+//     const selectedDeparture = "BARDOLINO AUTOSTAZIONE";
+//     const destinations = await booking.getSubscriptionsDestinations(selectedDeparture) as string[];
+//     expect(destinations.length).toBeGreaterThan(0);
+//     expect(destinations).toContain("GARDA AUTOSTAZIONE");
+//     const selectedDestination = "GARDA AUTOSTAZIONE";
+//     // Then get the validity types
+//     const validityTypes = await booking.getSubscriptionsValidityTypes(selectedDeparture, selectedDestination) as SubscriptionBooking.ValidityTypes[];
+//     expect(validityTypes.length).toBeGreaterThan(0);
+//     for (const validityType of validityTypes) {
+//       // Check that all returned validity types are valid
+//       expect(Object.values(SubscriptionBooking.ValidityTypes).includes(validityType)).toBe(true);
+//     }
+//   }, timeOut);
+//   const createCart = async (booking: ServiceBooking): Promise<ServiceCart> => {
+//     const servicesResponse = await booking.getServices(ServiceBooking.Currencies.EUR);
+//     const services = servicesResponse as Service[];
+//     // Build create cart request
+//     let tariffsMatrix = services[0].tariffsMatrix;
+//     tariffsMatrix[0][0].quantity = 1;
+//     const createServiceCartRequest: CreateServiceCartRequest = {
+//         currency: ServiceBooking.Currencies.EUR,
+//         service: {
+//           serviceId: services[0].id,
+//           tariffsMatrix:  tariffsMatrix
+//       }
+//     };
+//     // Create cart
+//     const cart = await booking.createServiceCart(createServiceCartRequest) as ServiceCart;
+//     return cart;
+//   }
+//   test("create_service_cart", async () => {
+//     const booking = new ServiceBooking(MTSEnvs.TEST, sub_key!, true, ServiceBooking.Languages.EN);
+//     const cart = await createCart(booking);
+//     // Check that the cartId was saved to the local storage
+//     expect(useTestState().getState().cartId).toBe(cart.id);
+//     expect(booking.cartId).toBe(cart.id);
+//     // Test the booking status (we test only the Buyer and passenger data, as it will always be required)
+//     expect(booking.bookingStepsToStatus.get(ServiceBooking.BookingSteps.BUYER_PASSENGERS)).toStrictEqual([ true, false, true ]);
+//     expect(booking.bookingStepsToStatus.get(ServiceBooking.BookingSteps.ISSUE)).toStrictEqual([ false, false, true ]);
+//     // Test booking due date
+//     expect(booking.bookingDueDate?.toISOString()).toBe(new Date(cart.bookingDueDate).toISOString());
+//     // Test expired tickets
+//     expect(cart.hasIssuedTickets).toBe(false);
+//     // Test seller data
+//     expect(booking.getSellerId()).toBe(cart.sellerId);
+//     expect(cart.sellerPrivacyUrl.length).toBeGreaterThan(0);
+//     expect(cart.sellerTermsUrl.length).toBeGreaterThan(0);
+//     // Now try to get the cart
+//     const newBooking = await ServiceBooking.createBooking(MTSEnvs.TEST, sub_key!, true, ServiceBooking.Languages.EN);
+//     expect(newBooking.cartId).toBe(cart.id);
+//     expect(newBooking.getCart()?.id).toBe(cart.id)
+//     expect(newBooking.getSellerId()).toBe(cart.sellerId);
+//     // Finally try to delete the cart
+//     await booking.deleteCart();
+//     expect(booking.getCart()).toBe(undefined);
+//     expect(useTestState().getState().cartId).toBe(undefined);
+//   }, timeOut);
+//   test("get_edit_buyer_data", async () => {
+//     const booking = new ServiceBooking(MTSEnvs.TEST, sub_key!, true, ServiceBooking.Languages.EN);
+//     const cart = await createCart(booking);
+//     // First, try to get the buyer data
+//     let buyerDataResponse = await booking.getBuyerPassengersDetails();
+//     expect((buyerDataResponse as GetBuyerPassengersDetailsResponse).passengers.length).toBe(0);
+//     let buyer = (buyerDataResponse as GetBuyerPassengersDetailsResponse).buyer;
+//     expect(buyer).toBe(null);
+//     // Now try to edit the buyer data
+//     buyer = {
+//       id: 0,
+//       name: "TestName",
+//       lastName: "TestSurname",
+//       email: "testBookingLib@infos.it",
+//       phoneNumber: "+391234567890"
+//     }
+//     await booking.updateBuyerPassengersDetails(buyer);
+//     // Finally, get the buyer data again and check that the data was updated
+//     buyerDataResponse = await booking.getBuyerPassengersDetails();
+//     const updatedBuyer = (buyerDataResponse as GetBuyerPassengersDetailsResponse).buyer;
+//     expect(updatedBuyer.id).toBeGreaterThan(0);
+//     expect(updatedBuyer.name).toBe(buyer.name);
+//     expect(updatedBuyer.lastName).toBe(buyer.lastName);
+//     expect(updatedBuyer.email).toBe(buyer.email);
+//     expect(updatedBuyer.phoneNumber).toBe(buyer.phoneNumber);
+//     // Finally try to delete the cart
+//     await booking.deleteCart();
+//     expect(booking.getCart()).toBe(undefined);
+//     expect(useTestState().getState().cartId).toBe(undefined);
+//   }, timeOut);
+//   test("get_gateway_info", async () => {
+//     const booking = new ServiceBooking(MTSEnvs.TEST, sub_key!, true, ServiceBooking.Languages.EN);
+//     const cart = await createCart(booking);
+//     booking.updateSellerId(cart.sellerId);
+//     // First, try to get the buyer data
+//     let buyerDataResponse = await booking.getBuyerPassengersDetails();
+//     expect((buyerDataResponse as GetBuyerPassengersDetailsResponse).passengers.length).toBe(0);
+//     let buyer = (buyerDataResponse as GetBuyerPassengersDetailsResponse).buyer;
+//     expect(buyer).toBe(null);
+//     // Now try to edit the buyer data
+//     buyer = {
+//       id: 0,
+//       name: "TestName",
+//       lastName: "TestSurname",
+//       email: "testBookingLib@infos.it",
+//       phoneNumber: "+391234567890"
+//     }
+//     await booking.updateBuyerPassengersDetails(buyer);
+//     // Try to get the gateways
+//     const gateways = await booking.getSellerGateways() as GetSellerGatewaysResponse;
+//     if (!gateways.payPalGatewayDTO && !gateways.cardGatewayDTO) {
+//       throw new Error("No gateways found");
+//     }
+//     const gateway = gateways.payPalGatewayDTO ? gateways.payPalGatewayDTO : gateways.cardGatewayDTO;
+//     expect(gateway?.id).toBeGreaterThan(0);
+//     // Now try to get the info
+//     const gatewayInfo = await booking.getPaymentInformationFromGateway(gateway?.id ?? 0) as GetPaymentInformationFromGatewayResponse;
+//     // Finally try to delete the cart
+//     await booking.deleteCart();
+//     expect(booking.getCart()).toBe(undefined);
+//     expect(useTestState().getState().cartId).toBe(undefined);
+//   }, timeOut);
+// });

package/lib/booking/booking.d.ts

@@ -84,11 +84,12 @@ export declare abstract class Booking {
     getPaymentInformationFromGateway(gatewayId: number, returnUrl?: string, options?: ApiCallOptions): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
     /**
      * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
-     * @param {PaymentMethods} paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},
+     * @param paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},
      * first the {@link Booking.addReduction} API is called with a 100% discount, then tickets are issued with the {@link PaymentMethods.CASH} method.
+     * @param tripId The Id of the trip for which the tickets are issued. This parameter is required when the booking done on the MTSAPP
      * @returns An {@link IssueCartResponse} object.
      */
-    issueCart(paymentMethod: PaymentMethods, options?: ApiCallOptions): Promise<ErrorResponse | IssueCartResponse>;
+    issueCart(paymentMethod: PaymentMethods, tripId?: number, options?: ApiCallOptions): Promise<ErrorResponse | IssueCartResponse>;
     getExtras({ extraId, tariffPlanId }?: {
         /** The extra object identifier. By default, all the extras of the seller are returned. */
         extraId?: number;

package/lib/booking/booking.js

@@ -313,11 +313,12 @@ var Booking = /** @class */ (function () {
     };
     /**
      * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
-     * @param {PaymentMethods} paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},
+     * @param paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},
      * first the {@link Booking.addReduction} API is called with a 100% discount, then tickets are issued with the {@link PaymentMethods.CASH} method.
+     * @param tripId The Id of the trip for which the tickets are issued. This parameter is required when the booking done on the MTSAPP
      * @returns An {@link IssueCartResponse} object.
      */
-    Booking.prototype.issueCart = function (paymentMethod, options) {
+    Booking.prototype.issueCart = function (paymentMethod, tripId, options) {
         return __awaiter(this, void 0, void 0, function () {
             var paymentMethodToSet, issueStep, _i, _a, step, url, body;
             var _b;
@@ -373,10 +374,7 @@ var Booking = /** @class */ (function () {
                         _c.label = 7;
                     case 7:
                         url = "".concat(this.config.API_ENDPOINT, "/v3_booking/carts/issue");
-                        body = {
-                            cartGuid: this.cartGuid,
-                            paymentMethod: paymentMethodToSet === Payment_1.PaymentMethods.PAY_LATER ? null : paymentMethodToSet
-                        };
+                        body = __assign(__assign({ cartGuid: this.cartGuid }, (tripId && { tripId: tripId })), { paymentMethod: paymentMethodToSet === Payment_1.PaymentMethods.PAY_LATER ? null : paymentMethodToSet });
                         return [2 /*return*/, this.callPostApi(url, body, options).then(function (response) {
                                 return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
                             })];

package/lib/booking/journeyBooking.js

@@ -815,7 +815,7 @@ exports.JourneyBooking = JourneyBooking;
 (function (JourneyBooking) {
     var _this = this;
     JourneyBooking.createBooking = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
-        var booking, error_1;
+        var booking, error_1, errorString;
         var env = _b.env, subKey = _b.subKey, debug = _b.debug, language = _b.language, sessionId = _b.sessionId, restoreState = _b.restoreState, accessToken = _b.accessToken, sellerId = _b.sellerId, resellerId = _b.resellerId, appVersion = _b.appVersion, os = _b.os, dbType = _b.dbType;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -852,7 +852,22 @@ exports.JourneyBooking = JourneyBooking;
                         booking.cartGuid = undefined;
                         return [2 /*return*/, booking];
                     }
-                    throw new Error("Could not instantiate JourneyBooking");
+                    errorString = void 0;
+                    if (typeof error_1 === "string") {
+                        errorString = error_1;
+                    }
+                    else if (typeof error_1 === "object") {
+                        try {
+                            errorString = JSON.stringify(error_1);
+                        }
+                        catch (_d) {
+                            errorString = String(error_1);
+                        }
+                    }
+                    else {
+                        errorString = String(error_1);
+                    }
+                    throw new Error("Could not instantiate JourneyBooking. Error: ".concat(errorString));
                 case 5: return [2 /*return*/];
             }
         });

package/lib/booking/serviceBooking.js

@@ -677,7 +677,7 @@ exports.ServiceBooking = ServiceBooking;
 (function (ServiceBooking) {
     var _this = this;
     ServiceBooking.createBooking = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
-        var booking, error_1;
+        var booking, error_1, errorString;
         var env = _b.env, subKey = _b.subKey, debug = _b.debug, language = _b.language, sessionId = _b.sessionId, restoreState = _b.restoreState, accessToken = _b.accessToken, sellerId = _b.sellerId, resellerId = _b.resellerId, appVersion = _b.appVersion, os = _b.os, dbType = _b.dbType;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -714,7 +714,22 @@ exports.ServiceBooking = ServiceBooking;
                         booking.cartGuid = undefined;
                         return [2 /*return*/, booking];
                     }
-                    throw new Error("Could not instantiate JourneyBooking");
+                    errorString = void 0;
+                    if (typeof error_1 === "string") {
+                        errorString = error_1;
+                    }
+                    else if (typeof error_1 === "object") {
+                        try {
+                            errorString = JSON.stringify(error_1);
+                        }
+                        catch (_d) {
+                            errorString = String(error_1);
+                        }
+                    }
+                    else {
+                        errorString = String(error_1);
+                    }
+                    throw new Error("Could not instantiate ServiceBooking. Error: ".concat(errorString));
                 case 5: return [2 /*return*/];
             }
         });

package/lib/booking/subscriptionBooking.js

@@ -727,7 +727,7 @@ exports.SubscriptionBooking = SubscriptionBooking;
 (function (SubscriptionBooking) {
     var _this = this;
     SubscriptionBooking.createBooking = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
-        var booking, error_1;
+        var booking, error_1, errorString;
         var env = _b.env, subKey = _b.subKey, debug = _b.debug, language = _b.language, sessionId = _b.sessionId, restoreState = _b.restoreState, accessToken = _b.accessToken, sellerId = _b.sellerId, resellerId = _b.resellerId, appVersion = _b.appVersion, os = _b.os, dbType = _b.dbType;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -764,7 +764,22 @@ exports.SubscriptionBooking = SubscriptionBooking;
                         booking.cartGuid = undefined;
                         return [2 /*return*/, booking];
                     }
-                    throw new Error("Could not instantiate JourneyBooking");
+                    errorString = void 0;
+                    if (typeof error_1 === "string") {
+                        errorString = error_1;
+                    }
+                    else if (typeof error_1 === "object") {
+                        try {
+                            errorString = JSON.stringify(error_1);
+                        }
+                        catch (_d) {
+                            errorString = String(error_1);
+                        }
+                    }
+                    else {
+                        errorString = String(error_1);
+                    }
+                    throw new Error("Could not instantiate SubscriptionsBooking. Error: ".concat(errorString));
                 case 5: return [2 /*return*/];
             }
         });

package/lib/booking/tplBooking.js

@@ -742,7 +742,7 @@ exports.TplBooking = TplBooking;
 (function (TplBooking) {
     var _this = this;
     TplBooking.createBooking = function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
-        var booking, error_1;
+        var booking, error_1, errorString;
         var env = _b.env, subKey = _b.subKey, debug = _b.debug, language = _b.language, sessionId = _b.sessionId, restoreState = _b.restoreState, accessToken = _b.accessToken, sellerId = _b.sellerId, resellerId = _b.resellerId, appVersion = _b.appVersion, os = _b.os, dbType = _b.dbType;
         return __generator(this, function (_c) {
             switch (_c.label) {
@@ -779,7 +779,22 @@ exports.TplBooking = TplBooking;
                         booking.cartGuid = undefined;
                         return [2 /*return*/, booking];
                     }
-                    throw new Error("Could not instantiate TplBooking");
+                    errorString = void 0;
+                    if (typeof error_1 === "string") {
+                        errorString = error_1;
+                    }
+                    else if (typeof error_1 === "object") {
+                        try {
+                            errorString = JSON.stringify(error_1);
+                        }
+                        catch (_d) {
+                            errorString = String(error_1);
+                        }
+                    }
+                    else {
+                        errorString = String(error_1);
+                    }
+                    throw new Error("Could not instantiate TplBooking. Error: ".concat(errorString));
                 case 5: return [2 /*return*/];
             }
         });

package/lib/utils/testUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This method return the ISO string of the date without GMT. An ISO string looks like this: YYYY-MM-DDThh:mm:ss.mmmZ
+ * @param {Date | string} date the date to convert
+ * @param {boolean} [removeTimezone=true] if true, the timezone will be removed from the ISO string, meaning
+ * that the string will look like this: YYYY-MM-DDThh:mm:ss.mmm
+ * @returns {string} the ISO string
+ */
+export declare const getISOStringWithoutGMT: (date: Date | string | null | undefined, removeTimezone?: boolean) => string | null;

package/lib/utils/testUtils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getISOStringWithoutGMT = void 0;
+/**
+ * This method return the ISO string of the date without GMT. An ISO string looks like this: YYYY-MM-DDThh:mm:ss.mmmZ
+ * @param {Date | string} date the date to convert
+ * @param {boolean} [removeTimezone=true] if true, the timezone will be removed from the ISO string, meaning
+ * that the string will look like this: YYYY-MM-DDThh:mm:ss.mmm
+ * @returns {string} the ISO string
+ */
+var getISOStringWithoutGMT = function (date, removeTimezone) {
+    if (removeTimezone === void 0) { removeTimezone = true; }
+    if (!date)
+        return null;
+    var newDate = new Date(date);
+    var isoString = new Date(newDate.valueOf() - newDate.getTimezoneOffset() * 60000).toISOString();
+    return removeTimezone ? isoString.slice(0, -1) : isoString;
+};
+exports.getISOStringWithoutGMT = getISOStringWithoutGMT;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -17,10 +17,10 @@
   "license": "ISC",
   "devDependencies": {
     "@types/jest": "^29.5.14",
-    "dotenv": "^16.4.5",
+    "dotenv": "^16.4.7",
     "jest": "^29.7.0",
     "node-localstorage": "^3.0.5",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.2",
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.2"
   },
@@ -34,7 +34,7 @@
   "author": "Infoservice s.r.l.",
   "dependencies": {
     "@react-native-async-storage/async-storage": "^2.1.0",
-    "axios": "^1.7.7",
+    "axios": "^1.7.9",
     "zustand": "^4.5.5"
   }
 }