mts-booking-library 2.4.3 → 2.4.4

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/types/common/Cart.d.ts

@@ -1,6 +1,7 @@
 import { Booking } from "../../booking/booking";
 import { Reduction } from "./Reduction";
 import { Extra } from "./Extra";
+import { PaymentMethods } from "./Payment";
 export declare enum SellingMethod {
     LINKAVEL = "LINKAVEL",
     BACKOFFICE = "BACKOFFICE",
@@ -59,6 +60,8 @@ export type Cart = {
     sellerEmailLinkavel: string | null;
     /** The code of the cart */
     cartCode: string;
+    /** If true, the tickets in the cart will be automatically printer after the payment */
+    autoPrintOption: boolean;
     /**
      * A boolean telling whether the cart has issued tickets.
      * Note that if this is the case, the cart will be null because it is not
@@ -114,6 +117,11 @@ export type Cart = {
      * It is expressed in the currency of the cart.
      */
     totalAmountToPay: number;
+    /**
+     * A list of string representing the possible ways to cash in the ticket.
+     * The first element of the list is the default cash in method (and the preferred by the seller).
+     */
+    cashInMethods: PaymentMethods[];
 };
 /** The type that {@link Cart.stepsToStatus} assumes once parsed to a map */
 export type processedStepsToStatus = Map<Booking.BookingSteps, [boolean, boolean, boolean]>;

package/lib/types/common/Tariffs.d.ts

@@ -34,6 +34,16 @@ export type Tariff = {
     label: string;
     /** The number of passengers to which this tariff applies */
     quantity: number;
+    /**
+     * The maximum quantity of this tariff that can be added to the cart.
+     * If this value is null or 0, there is no limit to the quantity of this tariff that can be added to the cart.
+     */
+    quantityPerCart: number;
+    /**
+     * Whether there can only be this tariff in the cart, meaning that if the user selects this tariff,
+     * it should not be possible to select any other tariff
+    */
+    onlyThisTariffInCart: boolean;
     /** The custom code for one-way tickets */
     oneWayCode: string | null;
     /** The custom code for round trip tickets */

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.3",
+  "version": "2.4.4",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -22,7 +22,7 @@
     "node-localstorage": "^3.0.5",
     "prettier": "^3.4.2",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "files": [
     "lib/**/*"