mts-booking-library 1.3.11 → 1.3.13

package/lib/booking/booking.d.ts

@@ -1,5 +1,6 @@
 import { MTSConfig, MTSEnvs } from "../config";
 import { ErrorResponse } from "../types/ErrorResponse";
+import { processedStepsToStatus } from "../types/common/Cart";
 import { GetPaymentInformationFromGatewayResponse, GetSellerGatewaysResponse, PaymentMethods, IssueTicketsResponse } from "../types/common/Payment";
 import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
@@ -18,7 +19,7 @@ export declare abstract class Booking {
      * - The second tells whether the section is completed. <br/>
      * - The third tells whether the section is required. <br/>
      */
-    bookingStepsToStatus: Map<string, boolean[]>;
+    bookingStepsToStatus: processedStepsToStatus;
     cartId: number | undefined;
     bookingDueDate: Date | undefined;
     /**
@@ -48,7 +49,7 @@ export declare abstract class Booking {
     callGetApi(url: string): Promise<ErrorResponse | any>;
     callPostApi(url: string, body: any): Promise<any>;
     callDeleteApi(url: string): Promise<ErrorResponse | any>;
-    getBookingStepsToStatus(): Map<string, boolean[]>;
+    getBookingStepsToStatus(): processedStepsToStatus;
     changeCurrency(currency: Booking.Currencies): void;
     changeLanguage(language: string): void;
     /**

package/lib/booking/journeyBooking.d.ts

@@ -41,7 +41,7 @@ export declare class JourneyBooking extends Booking {
                 resetState: () => void;
             }>>) => void;
             clearStorage: () => void;
-            rehydrate: () => void | Promise<void>;
+            rehydrate: () => Promise<void> | void;
             hasHydrated: () => boolean;
             onHydrate: (fn: (state: {
                 cartId: number | undefined;

package/lib/booking/serviceBooking.d.ts

@@ -38,7 +38,7 @@ export declare class ServiceBooking extends Booking {
                 resetState: () => void;
             }>>) => void;
             clearStorage: () => void;
-            rehydrate: () => void | Promise<void>;
+            rehydrate: () => Promise<void> | void;
             hasHydrated: () => boolean;
             onHydrate: (fn: (state: {
                 cartId: number | undefined;

package/lib/booking/subscriptionBooking.d.ts

@@ -39,7 +39,7 @@ export declare class SubscriptionBooking extends Booking {
                 resetState: () => void;
             }>>) => void;
             clearStorage: () => void;
-            rehydrate: () => void | Promise<void>;
+            rehydrate: () => Promise<void> | void;
             hasHydrated: () => boolean;
             onHydrate: (fn: (state: {
                 cartId: number | undefined;

package/lib/booking/tplBooking.d.ts

@@ -41,7 +41,7 @@ export declare class TplBooking extends Booking {
                 resetState: () => void;
             }>>) => void;
             clearStorage: () => void;
-            rehydrate: () => void | Promise<void>;
+            rehydrate: () => Promise<void> | void;
             hasHydrated: () => boolean;
             onHydrate: (fn: (state: {
                 cartId: number | undefined;

package/lib/index.d.ts

@@ -3,12 +3,14 @@ export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
 export { TplBooking } from "./booking/tplBooking";
+export { useMtsBookingState } from "./mtsStorage";
 export { Person, DEFAULT_PERSON, initializePerson } from "./types/common/Person";
 export { GetBuyerPassengersDetailsResponse, GetPassenger, BuyerDataStatus } from "./types/common/Person";
 export { EditPassengerRequestType, EditPassengersDetailsRequest } from "./types/common/Person";
 export { Tariff, TariffsMatrix, TariffSummary, TariffType, TermsType, PassengerTariff, ExtraTariff } from "./types/common/Tariffs";
 export { Reduction, AddReductionRequest } from "./types/common/Reduction";
 export { Gateway, GetSellerGatewaysResponse, GetPaymentInformationFromGatewayResponse, IssueTicketsResponse, GatewayTypes, PaymentMethods } from "./types/common/Payment";
+export { ReductionType } from "./types/common/Reduction";
 export { ErrorResponse, objectIsMTSErrorResponse } from "./types/ErrorResponse";
 export { BusLayoutCell, BusMatrix, BusCellTypes, SeatStatus } from "./types/journeys/BusMatrix";
 export { JourneyCart, JourneyBookingType, CreateJourneyCartRequest, TripBookingInfo, DEFAULT_CREATE_JOURNEY_CART } from "./types/journeys/JourneyCart";

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_CREATE_JOURNEY_CART = exports.SeatStatus = exports.BusCellTypes = exports.objectIsMTSErrorResponse = exports.PaymentMethods = exports.GatewayTypes = exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = exports.TplBooking = exports.SubscriptionBooking = exports.ServiceBooking = exports.JourneyBooking = exports.Booking = void 0;
+exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_CREATE_JOURNEY_CART = exports.SeatStatus = exports.BusCellTypes = exports.objectIsMTSErrorResponse = exports.ReductionType = exports.PaymentMethods = exports.GatewayTypes = exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = exports.useMtsBookingState = exports.TplBooking = exports.SubscriptionBooking = exports.ServiceBooking = exports.JourneyBooking = exports.Booking = void 0;
 //#region Export Booking classes
 var booking_1 = require("./booking/booking");
 Object.defineProperty(exports, "Booking", { enumerable: true, get: function () { return booking_1.Booking; } });
@@ -13,6 +13,10 @@ Object.defineProperty(exports, "SubscriptionBooking", { enumerable: true, get: f
 var tplBooking_1 = require("./booking/tplBooking");
 Object.defineProperty(exports, "TplBooking", { enumerable: true, get: function () { return tplBooking_1.TplBooking; } });
 //#endregion
+//#region Export Zustand states
+var mtsStorage_1 = require("./mtsStorage");
+Object.defineProperty(exports, "useMtsBookingState", { enumerable: true, get: function () { return mtsStorage_1.useMtsBookingState; } });
+//#endregion
 //#region Export common types
 // @note: Cart is not exported because it is extended by other types
 var Person_1 = require("./types/common/Person");
@@ -23,6 +27,8 @@ Object.defineProperty(exports, "BuyerDataStatus", { enumerable: true, get: funct
 var Payment_1 = require("./types/common/Payment");
 Object.defineProperty(exports, "GatewayTypes", { enumerable: true, get: function () { return Payment_1.GatewayTypes; } });
 Object.defineProperty(exports, "PaymentMethods", { enumerable: true, get: function () { return Payment_1.PaymentMethods; } });
+var Reduction_1 = require("./types/common/Reduction");
+Object.defineProperty(exports, "ReductionType", { enumerable: true, get: function () { return Reduction_1.ReductionType; } });
 var ErrorResponse_1 = require("./types/ErrorResponse");
 Object.defineProperty(exports, "objectIsMTSErrorResponse", { enumerable: true, get: function () { return ErrorResponse_1.objectIsMTSErrorResponse; } });
 //#endregion

package/lib/mtsStorage.d.ts

@@ -9,7 +9,7 @@ export declare const useMtsBookingLocalState: import("zustand").UseBoundStore<Om
     persist: {
         setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
         clearStorage: () => void;
-        rehydrate: () => void | Promise<void>;
+        rehydrate: () => Promise<void> | void;
         hasHydrated: () => boolean;
         onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
         onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
@@ -23,7 +23,7 @@ export declare const useMtsBookingState: () => import("zustand").UseBoundStore<O
     persist: {
         setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
         clearStorage: () => void;
-        rehydrate: () => void | Promise<void>;
+        rehydrate: () => Promise<void> | void;
         hasHydrated: () => boolean;
         onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
         onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
@@ -34,7 +34,7 @@ export declare const useTestState: () => import("zustand").UseBoundStore<Omit<im
     persist: {
         setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
         clearStorage: () => void;
-        rehydrate: () => void | Promise<void>;
+        rehydrate: () => Promise<void> | void;
         hasHydrated: () => boolean;
         onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
         onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;

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

@@ -1,67 +1,102 @@
 import { Booking } from "../../booking/booking";
 import { Reduction } from "./Reduction";
 import { Extra } from "./Extra";
+export declare enum SellingMethod {
+    LINKAVEL = "LINKAVEL",
+    BACKOFFICE = "BACKOFFICE",
+    RESELLER = "RESELLER",
+    MTSAPP = "MTSAPP"
+}
 /**
  * @description Cart is the object returned by the API when a cart is created.
  * Note that depending on the type of booking, this type will be extended with different fields:
  * - TourCart: {@link ServiceCart}
  * - JourneyCart: {@link JourneyCart}
  * - SubscriptionCart: {@link SubscriptionCart}
- * @property {number} id The id of the cart
- * @property {string} cartCode The code of the cart
- * @property {boolean} hasIssuedTickets - 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 possible to add tickets to an issued cart. Thus, all data should be reset.
- * @property {number} sellerId The id of the seller of the tickets in the cart
- * @property {string} sellerPrivacyUrl The url redirecting to the privacy policy of the seller
- * @property {string} sellerTermsUrl The url redirecting to the terms and conditions of the seller
- * @property {Map<string, boolean[]>} stepsToStatus This data structure describes the steps of the booking process.
- * The keys of this dictionary represent the booking steps. See ... for the list of possible steps. If the
- * key is present, then the booking step shall be displayed. The value is a list of 3 booleans:
- * - The first tells whether it is possible to go to that section. If not, other sections must be completed first.
- * - The second tells whether the section is completed.
- * - The third tells whether the section is required.
- * @property {Booking.Currencies} currency The currency of the cart. See {@link Booking.Currencies}
- * @property {number} bookingDueDateRemainingSeconds The number of seconds remaining before the cart expires. This should be equivalent `bookingDueDate`
- * @property {string} bookingDueDate The date and time when the cart expires
- * @property {Reduction[]} reductions The list of reductions applied to the cart
- * @property {Extra[]} extras The list of extras services of the cart
- * @property {string} sellingMethod The selling method of the cart (LinkAvel, Backoffice)
- * @property {number} totalValue The total value of the cart, meaning the sum of the nominal prices of all tickets. It is expressed in the currency of the cart.
- * @property {number} totalResellerFee The total reseller fee of the cart, meaning the sum of the reseller fees of all tickets. It is expressed in the currency of the cart.
- * @property {number} totalCreditFromChange The total credit from change of the cart. This is non zero only during the change process, and represents
- * the credit that the user has from the previous cart. It is expressed in the currency of the cart.
- * @property {number} totalAmountToPay The total amount to pay of the cart, meaning the amount that the user has to pay to complete the booking. This is
- * what is displayed in the payment page. It is expressed in the currency of the cart.
  */
 export type Cart = {
+    /** The id of the cart */
     id: number;
+    /** The id of the seller of the tickets in the cart */
     sellerId: number;
+    /** The url redirecting to the privacy policy of the seller */
     sellerPrivacyUrl: string;
+    /** The url redirecting to the terms and conditions of the seller */
     sellerTermsUrl: string;
+    /** The code of the cart */
     cartCode: string;
+    /**
+     * 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
+     * possible to add tickets to an issued cart. Thus, all data should be reset.
+     */
     hasIssuedTickets: boolean;
-    stepsToStatus: Map<string, boolean[]>;
+    /**
+     * This data structure describes the steps of the booking process.
+     * The keys of this dictionary represent the booking steps. See {@link Booking.BookingSteps}
+     * for the list of possible steps.
+     * If the key is present, then the booking step shall be displayed. The value
+     * is a list of 3 booleans:
+     * - The first tells whether it is possible to go to that section. If not, other
+     * sections must be completed first.
+     * - The second tells whether the section is completed.
+     * - The third tells whether the section is required.
+     */
+    stepsToStatus: Record<Booking.BookingSteps, [boolean, boolean, boolean]>;
+    /** The currency of the cart. See {@link Booking.Currencies} */
     currency: Booking.Currencies;
+    /** The date and time when the cart expires */
     bookingDueDate: string;
+    /**
+     * The number of seconds remaining before the cart expires. This should be equivalent
+     * `bookingDueDate`
+     */
     bookingDueDateRemainingSeconds: number;
+    /** The list of reductions applied to the cart */
     reductions: Reduction[];
+    /** The list of extras services of the cart */
     extras: Extra[];
-    sellingMethod: string;
+    /** The selling method of the cart (LinkAvel, Backoffice) */
+    sellingMethod: SellingMethod;
+    /**
+     * The total value of the cart, meaning the sum of the nominal prices of all tickets.
+     * It is expressed in the currency of the cart.
+     */
     totalValue: number;
+    /**
+     * The total reseller fee of the cart, meaning the sum of the reseller fees of
+     * all tickets. It is expressed in the currency of the cart.
+     */
     totalResellerFee?: number;
+    /**
+     * The total credit from change of the cart. This is non zero only during the
+     * change process, and represents the credit that the user has from the previous
+     * cart. It is expressed in the currency of the cart.
+     */
     totalCreditFromChange: number;
+    /**
+     * The total amount to pay of the cart, meaning the amount that the user has to
+     * pay to complete the booking. This is what is displayed in the payment page.
+     * It is expressed in the currency of the cart.
+     */
     totalAmountToPay: number;
 };
+/** The type that {@link Cart.stepsToStatus} assumes once parsed to a map */
+export type processedStepsToStatus = Map<Booking.BookingSteps, [boolean, boolean, boolean]>;
 /**
  * Base response type for the booking process. All APIs that update the cart, share this.
- *
- * @property {Map<string, boolean[]>} stepsToStatus This data structure describes the steps of the booking process.
- * The keys of this dictionary represent the booking steps. See ... for the list of possible steps. If the
- * key is present, then the booking step shall be displayed. The value is a list of 3 booleans:
- * - The first tells whether it is possible to go to that section. If not, other sections must be completed first.
- * - The second tells whether the section is completed.
- * - The third tells whether the section is required.
  */
 export type BaseBookingProcessResponse = {
-    stepsToStatus: Map<string, boolean[]>;
+    /**
+     * This data structure describes the steps of the booking process.
+     * The keys of this dictionary represent the booking steps. See {@link Booking.BookingSteps}
+     * for the list of possible steps.
+     * If the key is present, then the booking step shall be displayed. The value
+     * is a list of 3 booleans:
+     * - The first tells whether it is possible to go to that section. If not, other
+     * sections must be completed first.
+     * - The second tells whether the section is completed.
+     * - The third tells whether the section is required.
+     */
+    stepsToStatus: Record<Booking.BookingSteps, [boolean, boolean, boolean]>;
 };

package/lib/types/common/Cart.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SellingMethod = void 0;
+var SellingMethod;
+(function (SellingMethod) {
+    SellingMethod["LINKAVEL"] = "LINKAVEL";
+    SellingMethod["BACKOFFICE"] = "BACKOFFICE";
+    SellingMethod["RESELLER"] = "RESELLER";
+    SellingMethod["MTSAPP"] = "MTSAPP";
+})(SellingMethod || (exports.SellingMethod = SellingMethod = {}));

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

@@ -15,9 +15,11 @@ export type Tariff = {
 };
 /**
  * This represents a tariff matrix, returned when searching Journeys or Services.
- * It is a 2D array of {@link Tariff} objects. On the rows, there are the terms types, while on the columns there are the tariff types.
+ * It is a 2D array of {@link Tariff} objects. On the rows, there are the terms types,
+ * while on the columns there are the tariff types. Please note that elements can
+ * be undefined, as tariffs may not be present for every combination of terms type and tariff type.
  */
-export type TariffsMatrix = Tariff[][];
+export type TariffsMatrix = (Tariff | undefined)[][];
 /**
  * This represents a tariff type (e.g. "Adult", "Child", "Over65", ...).
  * @param {number} id - The id of the tariff type in the db.

package/lib/utils/processBookingSteps.d.ts

@@ -1,7 +1,8 @@
+import { Cart, processedStepsToStatus } from "../types/common/Cart";
 /**
  * This function process the stepsToStatus object returned by the BE in several APIs and returns the processed Map.
  * This is necessary because Typescript does not treat the jsonized map as an actual Map making it impossible to use.
  * @param stepsToStatus the stepsToStatus object returned by the BE
  * @returns The processed Map
  */
-export declare const processBookingSteps: (stepsToStatus: any) => Map<string, boolean[]>;
+export declare const processBookingSteps: (stepsToStatus: Cart["stepsToStatus"]) => processedStepsToStatus;

package/lib/utils/processBookingSteps.js

@@ -9,13 +9,7 @@ exports.processBookingSteps = void 0;
  */
 var processBookingSteps = function (stepsToStatus) {
     try {
-        return new Map(Object.entries(stepsToStatus).map(function (_a) {
-            var bookingStep = _a[0], values = _a[1];
-            return [
-                bookingStep,
-                values
-            ];
-        }));
+        return new Map(Object.entries(stepsToStatus));
     }
     catch (error) {
         throw new Error("Error while processing booking steps");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.3.11",
+  "version": "1.3.13",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,9 +18,9 @@
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
-    "prettier": "^3.3.0",
-    "ts-jest": "^29.1.4",
-    "typescript": "^5.4.5"
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.2",
+    "typescript": "^5.5.3"
   },
   "files": [
     "lib/**/*"
@@ -35,6 +35,6 @@
     "axios": "^1.7.2",
     "dotenv": "^16.4.5",
     "node-localstorage": "^3.0.5",
-    "zustand": "^4.5.2"
+    "zustand": "^4.5.4"
   }
 }