mts-booking-library 1.1.4 → 1.1.6

package/lib/booking/booking.d.ts

@@ -1,7 +1,9 @@
 import { MTSConfig, MTSEnvs } from "../config";
 export declare abstract class Booking {
     readonly sellerId?: number | undefined;
+    readonly bookingType: Booking.BookingTypes;
     readonly config: MTSConfig;
+    selectedCurrency: Booking.Currencies;
     cartStatus: Booking.CartStatus;
     bookingDueDate: Date | undefined;
     onCartExpiration: () => void;
@@ -10,16 +12,18 @@ export declare abstract class Booking {
     * @param {string} env The environment in which the app is running. Can be "dev", "stag" or "prod"
     * @param {string} sub_key The subscription key for using the APIs
     * @param {() => void} onCartExpiration A callback function that will be called when the cart expires
+    * @param {Booking.BookingTypes} bookingType The type of booking. Can be "MLP", "SERVICE" or "MLP_SUBSCRIPTION"
     * @param {string} [access_token=undefined] The access token for calling MTS APIs
     * @param {number} [sellerId=undefined] The id of the seller. If not set, it will return the results for all sellers
     */
-    constructor(env: MTSEnvs, sub_key: string, onCartExpiration: () => void, debug?: boolean, access_token?: string, sellerId?: number);
+    constructor(env: MTSEnvs, sub_key: string, onCartExpiration: () => void, bookingType: Booking.BookingTypes, debug?: boolean, access_token?: string, sellerId?: number);
     /**
      * This method allows to renew the access token for calling MTS APIs
      * @param {string} access_token The new access token
      */
     renewAccessToken(access_token: string): void;
     getCartStatus(): Booking.CartStatus;
+    changeCurrency(currency: Booking.Currencies): void;
     getCartExpirationTimeInMs(): Promise<number>;
 }
 export declare namespace Booking {
@@ -39,6 +43,6 @@ export declare namespace Booking {
     enum BookingTypes {
         MLP = "MLP",
         SERVICE = "SERVICE",
-        MLP_SUBSCRIPTIONS = "MLP_SUBSCRIPTIONS"
+        MLP_SUBSCRIPTION = "MLP_SUBSCRIPTION"
     }
 }

package/lib/booking/booking.js

@@ -44,14 +44,17 @@ var Booking = /** @class */ (function () {
     * @param {string} env The environment in which the app is running. Can be "dev", "stag" or "prod"
     * @param {string} sub_key The subscription key for using the APIs
     * @param {() => void} onCartExpiration A callback function that will be called when the cart expires
+    * @param {Booking.BookingTypes} bookingType The type of booking. Can be "MLP", "SERVICE" or "MLP_SUBSCRIPTION"
     * @param {string} [access_token=undefined] The access token for calling MTS APIs
     * @param {number} [sellerId=undefined] The id of the seller. If not set, it will return the results for all sellers
     */
-    function Booking(env, sub_key, onCartExpiration, debug, access_token, sellerId) {
+    function Booking(env, sub_key, onCartExpiration, bookingType, debug, access_token, sellerId) {
         if (debug === void 0) { debug = false; }
+        this.selectedCurrency = Booking.Currencies.EUR;
         this.cartStatus = Booking.CartStatus.EMPTY;
         this.sellerId = sellerId || undefined;
         this.config = (0, config_1.setConfig)(env, sub_key, debug, access_token);
+        this.bookingType = bookingType;
         this.onCartExpiration = onCartExpiration;
     }
     /**
@@ -64,6 +67,9 @@ var Booking = /** @class */ (function () {
     Booking.prototype.getCartStatus = function () {
         return this.cartStatus;
     };
+    Booking.prototype.changeCurrency = function (currency) {
+        this.selectedCurrency = currency;
+    };
     Booking.prototype.getCartExpirationTimeInMs = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -100,6 +106,6 @@ exports.Booking = Booking;
     (function (BookingTypes) {
         BookingTypes["MLP"] = "MLP";
         BookingTypes["SERVICE"] = "SERVICE";
-        BookingTypes["MLP_SUBSCRIPTIONS"] = "MLP_SUBSCRIPTIONS";
+        BookingTypes["MLP_SUBSCRIPTION"] = "MLP_SUBSCRIPTION";
     })(BookingTypes = Booking.BookingTypes || (Booking.BookingTypes = {}));
 })(Booking || (exports.Booking = Booking = {}));

package/lib/booking/journeyBooking.js

@@ -71,7 +71,7 @@ var JourneyBooking = /** @class */ (function (_super) {
         if (debug === void 0) { debug = false; }
         var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, debug, access_token, sellerId) || this;
+        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP, debug, access_token, sellerId) || this;
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
             _this.fetchAndSetCart(parseInt(cartId));
@@ -178,6 +178,7 @@ var JourneyBooking = /** @class */ (function (_super) {
                 return [2 /*return*/, (0, apiCall_1.makePost)(url, tripCart).then(function (cart) {
                         _this.cart = cart.cart;
                         _this.cartStatus = cart.cart.status;
+                        _this.bookingDueDate = new Date(cart.cart.bookingDueDate);
                         _this.createCartTimer(new Date(cart.cart.bookingDueDate));
                         return cart.cart;
                     })];

package/lib/booking/serviceBooking.js

@@ -71,7 +71,7 @@ var ServiceBooking = /** @class */ (function (_super) {
         if (debug === void 0) { debug = false; }
         var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, debug, access_token, sellerId) || this;
+        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.SERVICE, debug, access_token, sellerId) || this;
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
             _this.fetchAndSetCart(parseInt(cartId));
@@ -179,6 +179,7 @@ var ServiceBooking = /** @class */ (function (_super) {
                 return [2 /*return*/, (0, apiCall_1.makePost)(url, serviceCart).then(function (cart) {
                         _this.cart = cart.cart;
                         _this.cartStatus = cart.cart.status;
+                        _this.bookingDueDate = new Date(cart.cart.bookingDueDate);
                         _this.createCartTimer(new Date(cart.cart.bookingDueDate));
                         return cart.cart;
                     })];

package/lib/booking/subscriptionBooking.d.ts

@@ -1,7 +1,7 @@
 import { MTSEnvs } from "../config";
 import { Cart } from "../types/common/Cart";
 import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
-import { CreateSubscriptionCartRequest } from "../types/subscriptions/SubscriptionCart";
+import { CreateSubscriptionCartRequest, SubscriptionCart } from "../types/subscriptions/SubscriptionCart";
 import { Subscription } from "../types/subscriptions/Subscriptions";
 import { Booking } from "./booking";
 export declare class SubscriptionBooking extends Booking {
@@ -21,7 +21,7 @@ export declare class SubscriptionBooking extends Booking {
     * @param {string} departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
     * @returns {string[]} The list of possible destinations
     */
-    getSubscirptionsDestinations(departureStopName: string): Promise<string[]>;
+    getSubscriptionsDestinations(departureStopName: string): Promise<string[]>;
     /**
     * This method returns the possible validity types for the subscriptions sold by this seller between the selected departure and destination.
     * The validity type is the duration of the subscription (1 week, 1 month, etc.). See {@link ValidityTypes} for more details.
@@ -47,7 +47,7 @@ export declare class SubscriptionBooking extends Booking {
      * @returns {GetSubscriptionAvailabilityResponse} The availability of the subscription for the given parameters
      */
     getSubscriptionAvailabilities(request: GetSubscriptionAvailabilityRequest): Promise<GetSubscriptionAvailabilityResponse>;
-    createSubscriptionCart(request: CreateSubscriptionCartRequest): Promise<any>;
+    createSubscriptionCart(request: CreateSubscriptionCartRequest): Promise<SubscriptionCart>;
 }
 export declare namespace SubscriptionBooking {
     enum ValidityTypes {

package/lib/booking/subscriptionBooking.js

@@ -71,7 +71,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
         if (debug === void 0) { debug = false; }
         var _this = 
         // Call Booking constructor
-        _super.call(this, env, sub_key, onCartExpiration, debug, access_token, sellerId) || this;
+        _super.call(this, env, sub_key, onCartExpiration, booking_1.Booking.BookingTypes.MLP_SUBSCRIPTION, debug, access_token, sellerId) || this;
         var cartId = localStorage.getItem("cartId");
         if (cartId) {
             _this.fetchAndSetCart(parseInt(cartId));
@@ -141,7 +141,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     * @param {string} departureStopName The departure stop name (as returned by {@link getSubscriptionsDepartures})
     * @returns {string[]} The list of possible destinations
     */
-    SubscriptionBooking.prototype.getSubscirptionsDestinations = function (departureStopName) {
+    SubscriptionBooking.prototype.getSubscriptionsDestinations = function (departureStopName) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
@@ -202,9 +202,16 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     SubscriptionBooking.prototype.createSubscriptionCart = function (request) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
+            var _this = this;
             return __generator(this, function (_a) {
                 url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions");
-                return [2 /*return*/, (0, apiCall_1.makePost)(url, request)];
+                return [2 /*return*/, (0, apiCall_1.makePost)(url, request).then(function (cart) {
+                        _this.cart = cart.cart;
+                        _this.cartStatus = cart.cart.status;
+                        _this.bookingDueDate = new Date(cart.cart.bookingDueDate);
+                        _this.createCartTimer(new Date(cart.cart.bookingDueDate));
+                        return cart.cart;
+                    })];
             });
         });
     };

package/lib/index.d.ts

@@ -1,9 +1,10 @@
+export { Booking } from "./booking/booking";
 export { JourneyBooking } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
 export { Person, PassengersDetails, DEFAULT_PERSON } from "./types/common/Person";
 export { TariffMatrix, TariffSummary, TariffType, TermsType } from "./types/common/Tariffs";
-export { JourneyCart, JourneyBookingType, CreateJourneyCartRequest, JourneyBookingInfo } from "./types/journeys/JourneyCart";
+export { JourneyCart, JourneyBookingType, CreateJourneyCartRequest, TripBookingInfo, DEFAULT_CREATE_JOURNEY_CART } from "./types/journeys/JourneyCart";
 export { JourneyInfo } from "./types/journeys/JourneyInfo";
 export { JourneySearchRequest, JourneySearchResult, DEFAULT_JOURNEY_SEARCH } from "./types/journeys/JourneySearch";
 export { Stop } from "./types/journeys/Stop";

package/lib/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_PERSON = exports.SubscriptionBooking = exports.ServiceBooking = exports.JourneyBooking = void 0;
+exports.DEFAULT_JOURNEY_SEARCH = exports.DEFAULT_CREATE_JOURNEY_CART = exports.DEFAULT_PERSON = 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; } });
 var journeyBooking_1 = require("./booking/journeyBooking");
 Object.defineProperty(exports, "JourneyBooking", { enumerable: true, get: function () { return journeyBooking_1.JourneyBooking; } });
 var serviceBooking_1 = require("./booking/serviceBooking");
@@ -13,6 +15,11 @@ Object.defineProperty(exports, "SubscriptionBooking", { enumerable: true, get: f
 // @note: Cart is not exported because it is extended by other types
 var Person_1 = require("./types/common/Person");
 Object.defineProperty(exports, "DEFAULT_PERSON", { enumerable: true, get: function () { return Person_1.DEFAULT_PERSON; } });
+//#endregion
+//#region Export JourneyBooking types
+// TODO: BusMatrix.ts
+var JourneyCart_1 = require("./types/journeys/JourneyCart");
+Object.defineProperty(exports, "DEFAULT_CREATE_JOURNEY_CART", { enumerable: true, get: function () { return JourneyCart_1.DEFAULT_CREATE_JOURNEY_CART; } });
 var JourneySearch_1 = require("./types/journeys/JourneySearch");
 Object.defineProperty(exports, "DEFAULT_JOURNEY_SEARCH", { enumerable: true, get: function () { return JourneySearch_1.DEFAULT_JOURNEY_SEARCH; } });
 //#endregion

package/lib/types/ErrorResponse.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @description Error response type as returned by the BackEnd
+ *
+ * @property {number} statusCode - The status code of the error (e.g. 400)
+ * @property {string} message - The message of the error (e.g. "Invalid parameters")
+ */
 export type ErrorResponse = {
     statusCode: number;
     message: string;

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

@@ -1,5 +1,4 @@
 import { Booking } from "../../booking/booking";
-import { Person } from "./Person";
 /**
  * @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:
@@ -11,6 +10,8 @@ import { Person } from "./Person";
  * @property {Booking.CartStatus} status The status of the cart. See {@link Booking.CartStatus}
  * @property {Booking.CartStatus} nextStatus The next status of the cart. See {@link Booking.CartStatus}
  * @property {Booking.Currencies} currency The currency of the cart. See {@link Booking.Currencies}
+ * @property {string} bookingDueDate The date and time when the cart expires
+ * @property {number} buyerId The id of the buyer
  */
 export type Cart = {
     id: number;
@@ -19,7 +20,7 @@ export type Cart = {
     nextStatus: Booking.CartStatus;
     currency: Booking.Currencies;
     bookingDueDate: string;
-    buyer: Person;
+    buyerId: number;
     reductions: {
         tripId: number;
         tripName: string;

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

@@ -3,14 +3,15 @@ import { Cart } from "../common/Cart";
 import { TariffMatrix, TariffSummary } from "../common/Tariffs";
 import { Stop } from "./Stop";
 /**
- * @description Object containing information about the selected journey, to be used when booking the journey.
+ * @description Object containing information about a trip of a selected journey. This object is part of the {@link CreateJourneyCartRequest} object
+ * and describes a single trip of the journey (either outbound or return).
  *
  * @property {number} tripId - The unique identifier for the trip.
  * @property {number} departureStopId - The unique identifier for the departure stop.
  * @property {number} destinationStopId - The unique identifier for the destination stop.
  * @property {TariffMatrix} tariffsMatrix - The tariff matrix for pricing the outbound journey.
  */
-export type JourneyBookingInfo = {
+export type TripBookingInfo = {
     tripId: number;
     departureStopId: number;
     destinationStopId: number;
@@ -21,15 +22,18 @@ export type JourneyBookingInfo = {
  *
  * @property {number|undefined} [cartId=0] - The unique identifier for the cart (optional).
  * @property {Booking.Currencies} currency - The currency in which the journey is priced.
- * @property {JourneyBookingInfo[]} outboundJourney - Information about outbound journeys.
- * @property {JourneyBookingInfo[]|null} returnJourney - Information about return journeys (optional, can be null).
+ * @property {TripBookingInfo[]} outboundJourney - Information about outbound journeys. This is an array of {@link TripBookingInfo} objects.
+ * Note that when searching for journeys, the `trips` property of the {@link JourneySearchResult} object contains an array of {@link Trip} objects.
+ * Each trip should be mapped into a {@link TripBookingInfo} object.
+ * @property {TripBookingInfo[] | null} returnJourney - Information about return journeys (optional, can be null). See outboundJourney.
  */
 export type CreateJourneyCartRequest = {
     cartId?: number;
     currency: Booking.Currencies;
-    outboundJourney: JourneyBookingInfo[];
-    returnJourney: JourneyBookingInfo[] | null;
+    outboundJourney: TripBookingInfo[];
+    returnJourney: TripBookingInfo[] | null;
 };
+export declare const DEFAULT_CREATE_JOURNEY_CART: CreateJourneyCartRequest;
 /**
  * @description Represents a `JourneyCart`, which extends the {@link Cart} type by including additional
  * information about the bookings
@@ -43,7 +47,7 @@ export type JourneyCart = Cart & {
 /**
  * @description Represents a `JourneyBooking`, which contains information about a journey booking.
  *
- * @property {Booking.BookingTypes} type - The type of booking.
+ * @property {Booking.BookingTypes} type - The type of booking. For journeys, this is always `Booking.BookingTypes.MLP`.
  * @property {TariffSummary[]} summary - An array of {@link TariffSummary} objects representing the tariff summary
  * associated with this journey booking.
  * @property {Stop[]} info - An array of {@link Stop} objects representing the stops associated with this journey booking.

package/lib/types/journeys/JourneyCart.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CREATE_JOURNEY_CART = void 0;
+var booking_1 = require("../../booking/booking");
+exports.DEFAULT_CREATE_JOURNEY_CART = {
+    cartId: 0,
+    currency: booking_1.Booking.Currencies.EUR,
+    outboundJourney: [],
+    returnJourney: null,
+};

package/lib/types/services/ServiceCart.d.ts

@@ -32,9 +32,9 @@ export type ServiceCart = Cart & {
     bookings: ServiceBookingType[];
 };
 /**
- * @description Represents a `JourneyBooking`, which contains information about a journey booking.
+ * @description Represents a `ServiceBooking`, which contains information about a service booking.
  *
- * @property {Booking.BookingTypes} type - The type of booking.
+ * @property {Booking.BookingTypes} type - The type of booking. For services, this is always `Booking.BookingTypes.SERVICE`.
  * @property {TariffSummary[]} summary - An array of {@link TariffSummary} objects representing the tariff summary
  * associated with this journey booking.
  * @property {ServiceTrip} info - An array of {@link ServiceTrip} objects representing the stops associated with this journey booking.

package/lib/types/subscriptions/SubscriptionCart.d.ts

@@ -1,3 +1,6 @@
+import { Booking } from "../../booking/booking";
+import { Cart } from "../common/Cart";
+import { SubscriptionInfo } from "./SubscriptionInfo";
 /**
  * @description This is the object to be passed to `SubscriptionBooking.createSubscriptionCart`,
  * containing information about the selected subscription.
@@ -37,3 +40,23 @@ export type SubscriptionPeriod = {
     dateFrom: string;
     dateTo: string;
 };
+/**
+ * @description Represents a `SubscriptionCart`, which extends the {@link Cart} type by including additional information about the bookings.
+ *
+ * @property {SubscriptionBookingType[]} bookings - An array of {@link SubscriptionBookingType} objects representing the created subscriptions.
+ */
+export type SubscriptionCart = Cart & {
+    bookings: SubscriptionBookingType[];
+};
+/**
+ * @description Represents a `SubscriptionBooking`, which contains information about a subscription booking.
+ *
+ * @property {Booking.BookingTypes} type - The type of booking. For subscriptions, this is always `Booking.BookingTypes.SUBSCRIPTION`.
+ * @property {TariffSummary[]} summary - An array of {@link TariffSummary} objects representing the tariff summary
+ * associated with this journey booking.
+ * @property {ServiceTrip} info - An array of {@link ServiceTrip} objects representing the stops associated with this journey booking.
+ */
+export type SubscriptionBookingType = {
+    type: Booking.BookingTypes;
+    info: SubscriptionInfo;
+};

package/lib/types/subscriptions/SubscriptionInfo.d.ts

@@ -0,0 +1,39 @@
+import { SubscriptionBooking } from "../../booking/subscriptionBooking";
+/**
+ * @description This object contains information about the created subscription.
+ *
+ * @property {string} periodsNames - The names of the periods for which the subscription was booked (e.g. "July 2023")
+ * @property {boolean} isRoundTrip - Whether the subscription is for a round trip or not.
+ * @property {SubscriptionBooking.ValidityTypes} validity - The validity of the subscription.
+ * @property {number} totalPrice - The total price of the subscription.
+ * @property {string} outboundLineName - The name of the line for the outbound trip.
+ * @property {string} outboundRouteName - The name of the route for the outbound trip.
+ * @property {string} outboundDepartureStopName - The name of the departure stop for the outbound trip.
+ * @property {string} outboundDestinationStopName - The name of the destination stop for the outbound trip.
+ * @property {string} outboundDepartureStopTime - The departure time (only time, not date) for the outbound trip.
+ * @property {string} outboundDestinationStopTime - The destination time (only time, not date) for the outbound trip.
+ * @property {string} returnLineName - The name of the line for the return trip.
+ * @property {string} returnRouteName - The name of the route for the return trip.
+ * @property {string} returnDepartureStopName - The name of the departure stop for the return trip.
+ * @property {string} returnDestinationStopName - The name of the destination stop for the return trip.
+ * @property {string} returnDepartureStopTime - The departure time (only time, not date) for the return trip.
+ * @property {string} returnDestinationStopTime - The destination time (only time, not date) for the return trip.
+ */
+export type SubscriptionInfo = {
+    periodsNames: string;
+    isRoundTrip: boolean;
+    validity: SubscriptionBooking.ValidityTypes;
+    totalPrice: number;
+    outboundLineName: string;
+    outboundRouteName: string;
+    outboundDepartureStopName: string;
+    outboundDestinationStopName: string;
+    outboundDepartureStopTime: string;
+    outboundDestinationStopTime: string;
+    returnLineName: string;
+    returnRouteName: string;
+    returnDepartureStopName: string;
+    returnDestinationStopName: string;
+    returnDepartureStopTime: string;
+    returnDestinationStopTime: string;
+};

package/lib/types/subscriptions/SubscriptionInfo.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Library for use MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",