mts-booking-library 1.2.35 → 1.3.1

package/lib/config.js

@@ -10,7 +10,7 @@ var MTSEnvs;
 })(MTSEnvs || (exports.MTSEnvs = MTSEnvs = {}));
 var config = {
     ENV: MTSEnvs.PROD,
-    API_ENDPOINT: "https://myticketsolutionapim.azure-api.net/api",
+    API_ENDPOINT: "https://prod-myticketsolutionapim.azure-api.net/api",
     OCP_SUBSCRIPTION_KEY: "",
     ACCESS_TOKEN: undefined,
     DEBUG: false
@@ -21,13 +21,13 @@ var setConfig = function (env, sub_key, debug, access_token) {
     switch (config.ENV) {
         case MTSEnvs.TEST:
         case MTSEnvs.DEV:
-            config.API_ENDPOINT = "https://myticketsolutionapim.azure-api.net/api/dev";
+            config.API_ENDPOINT = "https://dev-myticketsolutionapim.azure-api.net/api";
             break;
         case MTSEnvs.STAGING:
-            config.API_ENDPOINT = "https://myticketsolutionapim.azure-api.net/api/stag";
+            config.API_ENDPOINT = "https://stag-myticketsolutionapim.azure-api.net/api";
             break;
         case MTSEnvs.PROD:
-            config.API_ENDPOINT = "https://myticketsolutionapim.azure-api.net/api";
+            config.API_ENDPOINT = "https://prod-myticketsolutionapim.azure-api.net/api";
             break;
         default:
             throw new Error("Invalid environment");

package/lib/index.d.ts

@@ -2,6 +2,7 @@ export { Booking } from "./booking/booking";
 export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
+export { TplBooking } from "./booking/tplBooking";
 export { Person, DEFAULT_PERSON, initializePerson } from "./types/common/Person";
 export { GetBuyerPassengersDetailsResponse, GetPassenger, BuyerDataStatus } from "./types/common/Person";
 export { EditPassengerRequestType, EditPassengersDetailsRequest } from "./types/common/Person";
@@ -19,6 +20,9 @@ export { Line } from "./types/services/Line";
 export { Service, ServiceTrip } from "./types/services/Service";
 export { ServiceCart, ServiceBookingType, CreateServiceCartRequest } from "./types/services/ServiceCart";
 export { ServiceInfo } from "./types/services/ServiceInfo";
+export { GetTariffsResponse } from "./types/tpl/GetTariffsResponse";
+export { SuperArea } from "./types/tpl/SuperArea";
+export { TplCart, TplBookingType, TplBookingInfo } from "./types/tpl/TplCart";
 export { Subscription } from "./types/subscriptions/Subscriptions";
 export { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse, SubscriptionCalendarDayPeriodInfo } from "./types/subscriptions/SubscriptionAvailabilities";
 export { SubscriptionCart, SubscriptionBookingType, CreateSubscriptionCartRequest, SubscriptionPeriod } from "./types/subscriptions/SubscriptionCart";

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.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.PaymentMethods = exports.GatewayTypes = exports.BuyerDataStatus = exports.initializePerson = exports.DEFAULT_PERSON = 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; } });
@@ -10,6 +10,8 @@ var serviceBooking_1 = require("./booking/serviceBooking");
 Object.defineProperty(exports, "ServiceBooking", { enumerable: true, get: function () { return serviceBooking_1.ServiceBooking; } });
 var subscriptionBooking_1 = require("./booking/subscriptionBooking");
 Object.defineProperty(exports, "SubscriptionBooking", { enumerable: true, get: function () { return subscriptionBooking_1.SubscriptionBooking; } });
+var tplBooking_1 = require("./booking/tplBooking");
+Object.defineProperty(exports, "TplBooking", { enumerable: true, get: function () { return tplBooking_1.TplBooking; } });
 //#endregion
 //#region Export common types
 // @note: Cart is not exported because it is extended by other types

package/lib/mtsStorage.d.ts

@@ -0,0 +1,44 @@
+type MtsBookingState = {
+    cartId: number | undefined;
+};
+type MtsBookingAction = {
+    updateCartId: (cartId: MtsBookingState["cartId"]) => void;
+    resetState: () => void;
+};
+export declare const useMtsBookingLocalState: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<MtsBookingState & MtsBookingAction>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => void | Promise<void>;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>;
+    };
+}>;
+/**
+ * This hook will return the correct Zustand state based on the application which runs the library
+ */
+export declare const useMtsBookingState: () => import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<MtsBookingState & MtsBookingAction>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => void | Promise<void>;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>;
+    };
+}>;
+export declare const useTestState: () => import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<MtsBookingState & MtsBookingAction>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => void | Promise<void>;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        onFinishHydration: (fn: (state: MtsBookingState & MtsBookingAction) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<MtsBookingState & MtsBookingAction, MtsBookingState & MtsBookingAction>>;
+    };
+}>;
+export {};

package/lib/mtsStorage.js

@@ -0,0 +1,48 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useTestState = exports.useMtsBookingState = exports.useMtsBookingLocalState = void 0;
+var async_storage_1 = require("@react-native-async-storage/async-storage");
+var zustand_1 = require("zustand");
+var middleware_1 = require("zustand/middleware");
+var INITIAL_STATE = {
+    cartId: 0,
+};
+var useMtsBookingAsyncState = (0, zustand_1.create)((0, middleware_1.persist)(function (set) { return (__assign(__assign({}, INITIAL_STATE), { updateCartId: function (cartId) { return set(function () { return ({ cartId: cartId }); }); }, resetState: function () { return set(function () { return INITIAL_STATE; }); } })); }, {
+    name: "mts-booking-storage",
+    storage: (0, middleware_1.createJSONStorage)(function () { return async_storage_1.default; })
+}));
+exports.useMtsBookingLocalState = (0, zustand_1.create)((0, middleware_1.persist)(function (set) { return (__assign(__assign({}, INITIAL_STATE), { updateCartId: function (cartId) { return set(function () { return ({ cartId: cartId }); }); }, resetState: function () { return set(function () { return INITIAL_STATE; }); } })); }, {
+    name: "mts-booking-storage",
+    storage: (0, middleware_1.createJSONStorage)(function () { return localStorage; })
+}));
+/**
+ * This hook will return the correct Zustand state based on the application which runs the library
+ */
+var useMtsBookingState = function () {
+    if (typeof document !== 'undefined') {
+        // Web application
+        return exports.useMtsBookingLocalState;
+    }
+    // react-native application
+    return useMtsBookingAsyncState;
+};
+exports.useMtsBookingState = useMtsBookingState;
+var useTestState = function () {
+    if (typeof localStorage === "undefined" || localStorage === null) {
+        var LocalStorage = require("node-localstorage").LocalStorage;
+        global.localStorage = new LocalStorage("./scratch");
+    }
+    return exports.useMtsBookingLocalState;
+};
+exports.useTestState = useTestState;

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

@@ -0,0 +1,17 @@
+/**
+ * This type represents a city
+ * @param {number} id The id of the city in the database
+ * @param {string} name The name of the city
+ * @param {string} stateName The name of the state where the city is located (e.g. "Italy")
+ * @param {string} regionName The name of the region where the city is located (e.g. "Lombardia")
+ * @param {string} provinceName The name of the province where the city is located (e.g. "Milano")
+ * @param {string} shortProvinceName The short name of the province where the city is located (e.g. "MI")
+ */
+export type City = {
+    id: number;
+    name: string;
+    stateName: string;
+    regionName: string;
+    provinceName: string;
+    shortProvinceName: string;
+};

package/lib/types/common/City.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,11 +1,13 @@
 /**
- * This represents a tariff, a part of a {@link TariffsMatrix} (returned when searching Journeys or Services).
+ * This represents a tariff, which defined the price to pay for a certain ticket.
+ * @param {number} id - The id of the tariff.
  * @param {number} tariffTypeId - The id of the tariff type.
  * @param {number} termsTypeId - The id of the terms type.
  * @param {number} value - The value of the tariff (in the currency specified in the {@link Booking} object).
  * @param {number} quantity - The number of passengers to which this tariff applies.
  */
 export type Tariff = {
+    id: number;
     tariffTypeId: number;
     termsTypeId: number;
     value: number;
@@ -17,7 +19,8 @@ export type Tariff = {
  */
 export type TariffsMatrix = Tariff[][];
 /**
- * This represents a tariff type, returned when searching Journeys or Services. This shall be used the build the header of the tariff matrix.
+ * This represents a tariff type (e.g. "Adult", "Child", "Over65", ...).
+ * @param {number} id - The id of the tariff type in the db.
  * @param {string} name - The name of the tariff type.
  * @param {string} description - The description of the tariff type.
  * @param {boolean} requiredPassengersName - Whether the passengers' names are required for this tariff type.
@@ -26,6 +29,7 @@ export type TariffsMatrix = Tariff[][];
  * including info on the rules that apply to it.
  */
 export type TariffType = {
+    id: number;
     name: string;
     description: string;
     requiredPassengersName: boolean;
@@ -33,7 +37,8 @@ export type TariffType = {
     bookingProcessDescription: string;
 };
 /**
- * This represents a terms type, returned when searching Journeys or Services. This shall be used the build the header of the rows of the tariff matrix.
+ * This represents a terms type (e.g. "Standard", "Business", ...).
+ * @param {number} id - The id of the terms type in the db.
  * @param {string} name - The name of the terms type.
  * @param {string} description - The description of the terms type.
  * @param {boolean} isRefundAllowed - Whether tickets refunds are allowed for this terms type.
@@ -43,6 +48,7 @@ export type TariffType = {
  * including info on the rules that apply to it.
  */
 export type TermsType = {
+    id: number;
     name: string;
     description: string;
     isRefundAllowed: boolean;

package/lib/types/journeys/JourneyInfo.d.ts

@@ -1,7 +1,8 @@
 /**
  * @description Represents information about a journey.
  *
- * @property {string} sellerName - The name of the seller offering the journey.
+ * @property {string} sellerName - The name of the seller operating the journey.
+ * @property {string} sellerId - The id of the seller operating the journey.
  * @property {string} minimumTotalPrice - The minimum total price for booking the journey, meaning the price if all passenger choose the cheapest tariff.
  * @property {number} remainingSeats - The number of remaining seats for the journey.
  * @property {number} totalNumberOfSeats - The total number of seats for the journey (including booked seats).
@@ -10,6 +11,7 @@
  */
 export type JourneyInfo = {
     sellerName: string;
+    sellerId: string;
     minimumTotalPrice: string;
     remainingSeats: number;
     totalNumberOfSeats: number;

package/lib/types/tpl/GetTariffsResponse.d.ts

@@ -0,0 +1,12 @@
+import { Tariff } from "../common/Tariffs";
+/**
+ * This represents the response of the API {@link TplBooking.getTariffs}.
+ * @param {Tariff[]} tariffs - The list of available tariffs. This is meant to be a fast access for displaying the data.
+ * In particular, this array is equivalent to `tariffPlanToTariffs[0]`
+ * @param {Map<number, Tariff[]>} tariffPlanToTariffs - A map that associates a tariff plan to the list of tariffs available for that tariff plan.
+ * The key is the tariff plan id, while the value is the list of available tariffs.
+ */
+export type GetTariffsResponse = {
+    tariffs: Tariff[];
+    tariffPlanToTariffs: Map<number, Tariff[]>;
+};

package/lib/types/tpl/GetTariffsResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/tpl/SuperArea.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This type represents a super area. It is the return object of the {@link TplBooking.getSuperAreas} method.
+ * @param {number} id The id of the super area in the database
+ * @param {string} name The name of the super area
+ * @param {string} shortName The short name of the super area
+ * @param {string} description The description of the super area
+ */
+export type SuperArea = {
+    id: number;
+    name: string;
+    shortName: string;
+    description: string;
+};

package/lib/types/tpl/SuperArea.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/tpl/TplCart.d.ts

@@ -0,0 +1,41 @@
+import { Booking } from "../../booking/booking";
+import { Cart } from "../common/Cart";
+import { TariffSummary } from "../common/Tariffs";
+/**
+ * @description Represents a `TplCart`, which extends the {@link Cart} type by including additional
+ * information about the bookings
+ *
+ * @property {JourneyBookingType[]} bookings - An array of {@link TplBookingType} objects representing the bookings associated
+ * with this tpl cart.
+ */
+export type TplCart = Cart & {
+    bookings: TplBookingType[];
+};
+/**
+ * @description Represents a `Tpl`, which contains information about a tpl booking.
+ *
+ * @property {Booking.BookingTypes} type - The type of booking. For journeys, this is always `Booking.BookingTypes.TPL`.
+ * @property {TariffSummary[]} summary - An array of {@link TariffSummary} objects representing the tariff summary
+ * associated with this tpl booking.
+ * @property {TplBookingInfo} info - An {@link TplBookingInfo} object containing general information about the booking.
+ */
+export type TplBookingType = {
+    type: Booking.BookingTypes;
+    info: TplBookingInfo;
+    summary: TariffSummary[];
+};
+/**
+ * @description Represents a `TplBookingInfo`, which contains general information about a tpl booking.
+ * @property {boolean} isSubscription - Whether the booking is a subscription or a single ticket.
+ * @property {number} superAreaId - The id of the super area.
+ * @property {number} validity - The validity of the ticket (or of the subscription).
+ * @property {string} startDate - The start date of the ticket (or of the subscription).
+ * @property {string} endDate - The end date of the ticket (or of the subscription).
+ */
+export type TplBookingInfo = {
+    isSubscription: boolean;
+    superAreaId: number;
+    validity: number;
+    startDate: string;
+    endDate: string;
+};

package/lib/types/tpl/TplCart.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/apiCall.js

@@ -145,8 +145,8 @@ var makePost = function (url, data) { return __awaiter(void 0, void 0, void 0, f
                             error_2 = _h.sent();
                             if (axios_1.default.isAxiosError(error_2)) {
                                 resError = {
-                                    httpStatus: ((_a = error_2.response) === null || _a === void 0 ? void 0 : _a.status) || 500,
-                                    mtsCode: ((_d = (_c = (_b = error_2.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.error) === null || _d === void 0 ? void 0 : _d.code) || 500,
+                                    httpStatus: ((_a = error_2.response) === null || _a === void 0 ? void 0 : _a.status) || 0,
+                                    mtsCode: ((_d = (_c = (_b = error_2.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.error) === null || _d === void 0 ? void 0 : _d.code) || 0,
                                     message: ((_g = (_f = (_e = error_2.response) === null || _e === void 0 ? void 0 : _e.data) === null || _f === void 0 ? void 0 : _f.error) === null || _g === void 0 ? void 0 : _g.message) || "Unknown error",
                                 };
                                 if (debug) {
@@ -195,8 +195,8 @@ var makeDelete = function (url) { return __awaiter(void 0, void 0, void 0, funct
                             error_3 = _h.sent();
                             if (axios_1.default.isAxiosError(error_3)) {
                                 resError = {
-                                    httpStatus: ((_a = error_3.response) === null || _a === void 0 ? void 0 : _a.status) || 500,
-                                    mtsCode: ((_d = (_c = (_b = error_3.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.error) === null || _d === void 0 ? void 0 : _d.code) || 500,
+                                    httpStatus: ((_a = error_3.response) === null || _a === void 0 ? void 0 : _a.status) || 0,
+                                    mtsCode: ((_d = (_c = (_b = error_3.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.error) === null || _d === void 0 ? void 0 : _d.code) || 0,
                                     message: ((_g = (_f = (_e = error_3.response) === null || _e === void 0 ? void 0 : _e.data) === null || _f === void 0 ? void 0 : _f.error) === null || _g === void 0 ? void 0 : _g.message) || "Unknown error",
                                 };
                                 if (debug) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mts-booking-library",
-  "version": "1.2.35",
-  "description": "Library for use MyTicketSolution Booking API",
+  "version": "1.3.1",
+  "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
@@ -17,7 +17,7 @@
     "@types/jest": "^29.5.12",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.2"
   },
   "files": [
     "lib/**/*"
@@ -26,9 +26,11 @@
     "myticketsolution",
     "booking"
   ],
-  "author": "M",
+  "author": "Infoservice s.r.l.",
   "dependencies": {
-    "axios": "^1.6.7",
-    "node-localstorage": "^3.0.5"
+    "@react-native-async-storage/async-storage": "^1.23.1",
+    "axios": "^1.6.8",
+    "node-localstorage": "^3.0.5",
+    "zustand": "^4.5.2"
   }
 }