mts-booking-library 2.3.3 → 2.4.1

package/README.md

@@ -2,4 +2,7 @@
 1. `npm i`
 1. `npm version patch`
 1. `git push && git push --tags`
-1. `npm publish`
+1. `npm publish`
+
+# Test
+1. `npm install && npm run test`

package/lib/booking/booking.js

@@ -214,11 +214,12 @@ var Booking = /** @class */ (function () {
                 searchParams = new URLSearchParams(__assign(__assign(__assign(__assign({}, (request.personId && { personId: (_a = request.personId) === null || _a === void 0 ? void 0 : _a.toString() })), (request.personCode && { personCode: request.personCode })), (request.phoneNumber && { phoneNumber: request.phoneNumber })), { includeSSN: "true" }));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_customers/persons?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
+                        var _a, _b;
                         // Check for errors
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response))
                             return response;
                         // Return the person details
-                        var person = __assign(__assign({}, response.persons[0]), { socialSecurityNumber: response.persons[0].personDetails.socialSecurityNumber });
+                        var person = __assign(__assign({}, response.persons[0]), { socialSecurityNumber: (_b = (_a = response.persons[0]) === null || _a === void 0 ? void 0 : _a.personDetails) === null || _b === void 0 ? void 0 : _b.socialSecurityNumber });
                         return person;
                     })];
             });

package/lib/booking/journeyBooking.js

@@ -395,11 +395,9 @@ var JourneyBooking = /** @class */ (function (_super) {
                                 }))
                                 : null;
                         });
-                        return {
-                            buyerDataStatus: response.buyerDataStatus,
-                            buyer: response.buyer,
-                            passengers: passengers
-                        };
+                        // Return the response
+                        var res = __assign(__assign({}, response), { passengers: passengers });
+                        return res;
                     })];
             });
         });

package/lib/booking/serviceBooking.js

@@ -373,11 +373,8 @@ var ServiceBooking = /** @class */ (function (_super) {
                         // Check for errors
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response))
                             return response;
-                        return {
-                            buyerDataStatus: response.buyerDataStatus,
-                            buyer: response.buyer,
-                            passengers: []
-                        };
+                        // Return the response
+                        return __assign(__assign({}, response), { passengers: [] });
                     })];
             });
         });

package/lib/booking/subscriptionBooking.d.ts

@@ -169,6 +169,7 @@ export declare namespace SubscriptionBooking {
         CALENDAR_MONTH = "CALENDAR_MONTH",
         CALENDAR_SIX_MONTHS = "CALENDAR_SIX_MONTHS",
         ONE_YEAR = "ONE_YEAR",
-        CALENDAR_YEAR = "CALENDAR_YEAR"
+        CALENDAR_YEAR = "CALENDAR_YEAR",
+        FIVE_SECONDS = "FIVE_SECONDS"
     }
 }

package/lib/booking/subscriptionBooking.js

@@ -421,11 +421,9 @@ var SubscriptionBooking = /** @class */ (function (_super) {
                                 }))
                                 : null;
                         });
-                        return {
-                            buyerDataStatus: response.buyerDataStatus,
-                            buyer: response.buyer,
-                            passengers: passengers
-                        };
+                        // Return the response
+                        var res = __assign(__assign({}, response), { passengers: passengers });
+                        return res;
                     })];
             });
         });
@@ -782,5 +780,6 @@ exports.SubscriptionBooking = SubscriptionBooking;
         ValidityTypes["CALENDAR_SIX_MONTHS"] = "CALENDAR_SIX_MONTHS";
         ValidityTypes["ONE_YEAR"] = "ONE_YEAR";
         ValidityTypes["CALENDAR_YEAR"] = "CALENDAR_YEAR";
+        ValidityTypes["FIVE_SECONDS"] = "FIVE_SECONDS";
     })(ValidityTypes = SubscriptionBooking.ValidityTypes || (SubscriptionBooking.ValidityTypes = {}));
 })(SubscriptionBooking || (exports.SubscriptionBooking = SubscriptionBooking = {}));

package/lib/booking/tplBooking.js

@@ -426,11 +426,8 @@ var TplBooking = /** @class */ (function (_super) {
                         // Check for errors
                         if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response))
                             return response;
-                        return {
-                            buyerDataStatus: response.buyerDataStatus,
-                            buyer: response.buyer,
-                            passengers: null
-                        };
+                        // Return the response
+                        return response;
                     })];
             });
         });

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

@@ -35,23 +35,30 @@ export type GetPersonRequest = {
     personCode?: string;
     phoneNumber?: string;
 };
-/**
- * @description Represents a passenger in the response of the {@link Booking.getPassengersDetails} method. This type extends the {@link Person} type
- * with the `outboundTariffs` and `returnTariffs` properties.
- *
- * @property {string} outboundNotes - The notes for the outbound trip.
- * @property { Map<number, PassengerTariff>} outboundTariffs - A map containing the outbound tariffs for this passenger. The key is the trip id.
- * For every trip, the first element the value is the suggested tariff. The other elements are the other tariffs, so that the user can adjust
- * the tariff for the passenger.
- * @property {string} returnNotes - The notes for the return trip.
- * @property { Map<number, PassengerTariff>} returnTariffs - Same of `outboundTariffs`, but for the return trip.
- */
+/** @description Represents a passenger in the response of the {@link Booking.getPassengersDetails} method. */
 export type GetPassenger = Person & {
+    /** The notes for the outbound trip. */
     outboundNotes: string | null;
+    /**
+     * A map containing the outbound tariffs for this passenger. The key is the trip id.
+     * For every trip, the first element the value is the suggested tariff. The other elements are the other tariffs, so that the user can adjust
+     * the tariff for the passenger.
+     * */
     outboundTariffs: Map<number, PassengerTariff[]>;
+    /** The notes for the return trip. */
     returnNotes: string | null;
+    /** Same of `outboundTariffs`, but for the return trip. */
     returnTariffs: Map<number, PassengerTariff[]> | null;
+    /** Whether the passenger name and last name are required, optional or cannot be specified. */
+    passengerNameLastNameOption: PersonDataFieldStatus;
+    /** Whether the passenger email is required, optional or cannot be specified. */
+    passengerEmailOption: PersonDataFieldStatus;
+    /** Whether the passenger phone number is reuqired, optional or cannot be specified. */
+    passengerPhoneNumberOption: PersonDataFieldStatus;
+    /** Whether the passenger social security number is reuqired, optional or cannot be specified. */
+    passengerSSNOption: PersonDataFieldStatus;
 };
+/** @deprecated Use PersonDataFieldStatus */
 export declare enum BuyerDataStatus {
     /** The buyer data are optional. PersonDetails form shall be displayed, but the user can skip it. */
     OPTIONAL = 0,
@@ -60,14 +67,28 @@ export declare enum BuyerDataStatus {
     /** The buyer data cannot be specified. PersonDetails form shall not be displayed. */
     CANNOT_BE_SPECIFIED = 2
 }
-/**
- * Represents the response of the {@link getBuyerPassengersDetails} method.
- */
+export declare enum PersonDataFieldStatus {
+    /** The field (e.g. the buyer's email) is optional. The input shall be displayed, but the user can skip it. */
+    OPTIONAL = "OPTIONAL",
+    /** The field (e.g. the buyer's email) is required. the input shall be displayed and the user cannot skip it. */
+    REQUIRED = "REQUIRED",
+    /** The field (e.g. the buyer's email) cannot be specified. The input shall not be displayed. */
+    CANNOT_BE_SPECIFIED = "CANNOT_BE_SPECIFIED"
+}
+/** Represents the response of the {@link getBuyerPassengersDetails} method. */
 export type GetBuyerPassengersDetailsResponse = {
-    /** Whether the form for the buyer data is required, optional or cannot be specified. */
+    /** @deprecated Whether the form for the buyer data is required, optional or cannot be specified. */
     buyerDataStatus: BuyerDataStatus;
     /** The {@link Person} object representing the buyer. */
     buyer: PersonDetails | null;
+    /** Whether the buyer name and last name are required, optional or cannot be specified. */
+    buyerNameLastNameOption: PersonDataFieldStatus;
+    /** Whether the buyer email is required, optional or cannot be specified. */
+    buyerEmailOption: PersonDataFieldStatus;
+    /** Whether the buyer phone number is reuqired, optional or cannot be specified. */
+    buyerPhoneNumberOption: PersonDataFieldStatus;
+    /** Whether the buyer social security number is reuqired, optional or cannot be specified. */
+    buyerSSNOption: PersonDataFieldStatus;
     /** An array of {@link GetPassenger} objects representing the passengers. */
     passengers: GetPassenger[] | null;
 };

package/lib/types/common/Person.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = void 0;
+exports.PersonDataFieldStatus = exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = void 0;
 exports.DEFAULT_PERSON = {
     id: 0,
     personCode: "",
@@ -16,6 +16,7 @@ var initializePerson = function (person) {
     return person;
 };
 exports.initializePerson = initializePerson;
+/** @deprecated Use PersonDataFieldStatus */
 var BuyerDataStatus;
 (function (BuyerDataStatus) {
     /** The buyer data are optional. PersonDetails form shall be displayed, but the user can skip it. */
@@ -25,3 +26,12 @@ var BuyerDataStatus;
     /** The buyer data cannot be specified. PersonDetails form shall not be displayed. */
     BuyerDataStatus[BuyerDataStatus["CANNOT_BE_SPECIFIED"] = 2] = "CANNOT_BE_SPECIFIED";
 })(BuyerDataStatus || (exports.BuyerDataStatus = BuyerDataStatus = {}));
+var PersonDataFieldStatus;
+(function (PersonDataFieldStatus) {
+    /** The field (e.g. the buyer's email) is optional. The input shall be displayed, but the user can skip it. */
+    PersonDataFieldStatus["OPTIONAL"] = "OPTIONAL";
+    /** The field (e.g. the buyer's email) is required. the input shall be displayed and the user cannot skip it. */
+    PersonDataFieldStatus["REQUIRED"] = "REQUIRED";
+    /** The field (e.g. the buyer's email) cannot be specified. The input shall not be displayed. */
+    PersonDataFieldStatus["CANNOT_BE_SPECIFIED"] = "CANNOT_BE_SPECIFIED";
+})(PersonDataFieldStatus || (exports.PersonDataFieldStatus = PersonDataFieldStatus = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "2.3.3",
+  "version": "2.4.1",
   "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.3.3",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.6.3"
+    "typescript": "^5.7.2"
   },
   "files": [
     "lib/**/*"
@@ -33,7 +33,7 @@
   ],
   "author": "Infoservice s.r.l.",
   "dependencies": {
-    "@react-native-async-storage/async-storage": "^2.0.0",
+    "@react-native-async-storage/async-storage": "^2.1.0",
     "axios": "^1.7.7",
     "zustand": "^4.5.5"
   }

package/lib/SubscriptionBooking.js

@@ -1,148 +0,0 @@
-"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/utils/testUtils.d.ts

@@ -1,8 +0,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
- */
-export declare const getISOStringWithoutGMT: (date: Date | string | null | undefined, removeTimezone?: boolean) => string | null;

package/lib/utils/testUtils.js

@@ -1,19 +0,0 @@
-"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;