mts-booking-library 1.1.2 → 1.1.4

package/lib/booking/subscriptionBooking.d.ts

@@ -1,6 +1,8 @@
 import { MTSEnvs } from "../config";
 import { Cart } from "../types/common/Cart";
-import { Subscription } from "../types/subscriptions/Subscrptions";
+import { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse } from "../types/subscriptions/SubscriptionAvailabilities";
+import { CreateSubscriptionCartRequest } from "../types/subscriptions/SubscriptionCart";
+import { Subscription } from "../types/subscriptions/Subscriptions";
 import { Booking } from "./booking";
 export declare class SubscriptionBooking extends Booking {
     private cart?;
@@ -19,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
     */
-    getSubscrptionsDestinations(departureStopName: string): Promise<string[]>;
+    getSubscirptionsDestinations(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.
@@ -27,7 +29,7 @@ export declare class SubscriptionBooking extends Booking {
     * @param {string} destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
     * @returns {ValidityTypes[]} The list of possible validity types
     */
-    getSubscrptionsValidityTypes(departureStopName: string, destinationStopName: string): Promise<SubscriptionBooking.ValidityTypes[]>;
+    getSubscriptionsValidityTypes(departureStopName: string, destinationStopName: string): Promise<SubscriptionBooking.ValidityTypes[]>;
     /**
     * This method returns the subscriptions that match the given parameters.
     * Note that it will always return the subscription for the one-way trip.
@@ -37,8 +39,15 @@ export declare class SubscriptionBooking extends Booking {
     * @param {string} validityType The validity type (as returned by {@link getSubscriptionsValidityTypes})
     * @returns {Array<Subscription>} The subscriptions that match the given parameters
     */
-    getSubscrptions(departureStopName: string, destinationStopName: string, validityType: string): Promise<Subscription[]>;
-    getSubscrptionAvailabilities(departureStopName: string, destinationStopName: string, validityType: string): Promise<Subscription[]>;
+    getSubscriptions(departureStopName: string, destinationStopName: string, validityType: string): Promise<Subscription[]>;
+    /**
+     * This method returns the availability of the subscription for the given parameters.
+     * Note that, contrary for the previous method, you should make one single request for both the outbound and return trip.
+     * @param {GetSubscriptionAvailabilityRequest} request the request object containing the parameters for the availability check
+     * @returns {GetSubscriptionAvailabilityResponse} The availability of the subscription for the given parameters
+     */
+    getSubscriptionAvailabilities(request: GetSubscriptionAvailabilityRequest): Promise<GetSubscriptionAvailabilityResponse>;
+    createSubscriptionCart(request: CreateSubscriptionCartRequest): Promise<any>;
 }
 export declare namespace SubscriptionBooking {
     enum ValidityTypes {

package/lib/booking/subscriptionBooking.js

@@ -69,8 +69,14 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     __extends(SubscriptionBooking, _super);
     function SubscriptionBooking(env, sub_key, onCartExpiration, debug, access_token, sellerId) {
         if (debug === void 0) { debug = false; }
+        var _this = 
         // Call Booking constructor
-        return _super.call(this, env, sub_key, onCartExpiration, debug, access_token, sellerId) || this;
+        _super.call(this, env, sub_key, onCartExpiration, debug, access_token, sellerId) || this;
+        var cartId = localStorage.getItem("cartId");
+        if (cartId) {
+            _this.fetchAndSetCart(parseInt(cartId));
+        }
+        return _this;
     }
     SubscriptionBooking.prototype.getCart = function () {
         return this.cart;
@@ -135,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.getSubscrptionsDestinations = function (departureStopName) {
+    SubscriptionBooking.prototype.getSubscirptionsDestinations = function (departureStopName) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
@@ -151,7 +157,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     * @param {string} destinationStopName The destination stop name (as returned by {@link getSubscriptionsDstinations})
     * @returns {ValidityTypes[]} The list of possible validity types
     */
-    SubscriptionBooking.prototype.getSubscrptionsValidityTypes = function (departureStopName, destinationStopName) {
+    SubscriptionBooking.prototype.getSubscriptionsValidityTypes = function (departureStopName, destinationStopName) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
@@ -169,7 +175,7 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     * @param {string} validityType The validity type (as returned by {@link getSubscriptionsValidityTypes})
     * @returns {Array<Subscription>} The subscriptions that match the given parameters
     */
-    SubscriptionBooking.prototype.getSubscrptions = function (departureStopName, destinationStopName, validityType) {
+    SubscriptionBooking.prototype.getSubscriptions = function (departureStopName, destinationStopName, validityType) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
@@ -178,15 +184,30 @@ var SubscriptionBooking = /** @class */ (function (_super) {
             });
         });
     };
-    SubscriptionBooking.prototype.getSubscrptionAvailabilities = function (departureStopName, destinationStopName, validityType) {
+    /**
+     * This method returns the availability of the subscription for the given parameters.
+     * Note that, contrary for the previous method, you should make one single request for both the outbound and return trip.
+     * @param {GetSubscriptionAvailabilityRequest} request the request object containing the parameters for the availability check
+     * @returns {GetSubscriptionAvailabilityResponse} The availability of the subscription for the given parameters
+     */
+    SubscriptionBooking.prototype.getSubscriptionAvailabilities = function (request) {
         return __awaiter(this, void 0, void 0, function () {
             var url;
             return __generator(this, function (_a) {
-                url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/search?").concat(new URLSearchParams(__assign(__assign({}, (this.sellerId && { sellerId: this.sellerId.toString() })), { departureStopName: departureStopName, destinationStopName: destinationStopName, validityType: validityType })));
+                url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions/availabilities?").concat(new URLSearchParams(__assign(__assign({}, (this.sellerId && { sellerId: this.sellerId.toString() })), { outboundRouteId: request.outboundRouteId.toString(), returnRouteId: request.returnRouteId.toString(), outboundDeparturePhysicalAgencyStopId: request.outboundDeparturePhysicalAgencyStopId.toString(), outboundDestinationPhysicalAgencyStopId: request.outboundDestinationPhysicalAgencyStopId.toString(), returnDeparturePhysicalAgencyStopId: request.returnDeparturePhysicalAgencyStopId.toString(), returnDestinationPhysicalAgencyStopId: request.returnDestinationPhysicalAgencyStopId.toString(), numberOfPassengers: request.numberOfPassengers.toString(), validityType: request.validityType })));
                 return [2 /*return*/, (0, apiCall_1.makeGet)(url)];
             });
         });
     };
+    SubscriptionBooking.prototype.createSubscriptionCart = function (request) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url;
+            return __generator(this, function (_a) {
+                url = "".concat(this.config.API_ENDPOINT, "/booking/subscriptions");
+                return [2 /*return*/, (0, apiCall_1.makePost)(url, request)];
+            });
+        });
+    };
     return SubscriptionBooking;
 }(booking_1.Booking));
 exports.SubscriptionBooking = SubscriptionBooking;

package/lib/index.d.ts

@@ -12,4 +12,6 @@ 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 { Subscription } from "./types/subscriptions/Subscrptions";
+export { Subscription } from "./types/subscriptions/Subscriptions";
+export { GetSubscriptionAvailabilityRequest, GetSubscriptionAvailabilityResponse, SubscriptionCalendarDayPeriodInfo } from "./types/subscriptions/SubscriptionAvailabilities";
+export { CreateSubscriptionCartRequest, SubscriptionPeriod } from "./types/subscriptions/SubscriptionCart";

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

@@ -0,0 +1,69 @@
+/**
+ * @description This is the object to be passed to `SubscriptionBooking.getSubscrptionAvailabilities`
+ *
+ * @property {number} outboundRouteId - The id of the outbound route.
+ * Its value can be retrieved from {@link Subscription.routeId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} returnRouteId - The id of the return route (0 if the subscription is for a one-way trip)
+ * Its value can be retrieved from {@link Subscription.routeId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} outboundDeparturePhysicalAgencyStopId - The id of the outbound departure stop.
+ * Its value can be retrieved from {@link Subscription.departurePhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} outboundDestinationPhysicalAgencyStopId - The id of the outbound destination stop.
+ * Its value can be retrieved from {@link Subscription.destinationPhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} returnDeparturePhysicalAgencyStopId - The id of the return departure stop (0 if the subscription is for a one-way trip).
+ * Its value can be retrieved from {@link Subscription.departurePhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} returnDestinationPhysicalAgencyStopId - The id of the return destination stop (0 if the subscription is for a one-way trip).
+ * Its value can be retrieved from {@link Subscription.destinationPhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} numberOfPassengers - The number of passengers to be booked.
+ * @property {string} validityType - The validity type of the subscription (as returned by {@link SubscriptionBooking.getSubscriptionsValidityTypes})
+ */
+export type GetSubscriptionAvailabilityRequest = {
+    outboundRouteId: number;
+    returnRouteId: number;
+    outboundDeparturePhysicalAgencyStopId: number;
+    outboundDestinationPhysicalAgencyStopId: number;
+    returnDeparturePhysicalAgencyStopId: number;
+    returnDestinationPhysicalAgencyStopId: number;
+    numberOfPassengers: number;
+    validityType: string;
+};
+/**
+ * @description This is the object to be returned by to `SubscriptionBooking.getSubscrptionAvailabilities`,
+ * containing general information about the selected subscription as well as the list of periods in which it is possible to
+ * book the subscription.
+ *
+ * @property {string} departureStopName - The name of the departure stop.
+ * @property {string} destinationStopName - The name of the destination stop.
+ * @property {Date} outboundDepartureTime - The departure time of the outbound trip.
+ * @property {Date} outboundDestinationTime - The destination time of the outbound trip.
+ * @property {Date} returnDepartureTime - The departure time of the return trip.
+ * @property {Date} returnDestinationTime - The destination time of the return trip.
+ * @property {SubscriptionCalendarDayPeriodInfo[]} periods - The list of periods for which the availability of the subscription was checked.
+ */
+export type GetSubscriptionAvailabilityResponse = {
+    departureStopName: string;
+    destinationStopName: string;
+    outboundDepartureTime: Date;
+    outboundDestinationTime: Date;
+    returnDepartureTime: Date;
+    returnDestinationTime: Date;
+    periods: SubscriptionCalendarDayPeriodInfo[];
+};
+/**
+ * @description This is the object descibing the availability of a subscription for a given period.
+ * Note that it is possible to book a subscription only is both {@link journeyAvailable} and {@link isAvailable} are true.
+ *
+ * @property {string} periodName - The name of the period (e.g. "July 2023")
+ * @property {Date} dateFrom - The start date of the period.
+ * @property {Date} dateTo - The end date of the period.
+ * @property {number} price - The price of the subscription for the given period.
+ * @property {boolean} journeyAvailable - Whether this subscription is available in this period.
+ * @property {boolean} isAvailable - If this subscription is available (i.e. if {@link journeyAvailable} is true), this tells whether it can be booked
+ */
+export type SubscriptionCalendarDayPeriodInfo = {
+    periodName: string;
+    dateFrom: Date;
+    dateTo: Date;
+    price: number;
+    journeyAvailable: boolean;
+    isAvailable: boolean;
+};

package/lib/types/subscriptions/SubscriptionAvailabilities.js

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

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

@@ -0,0 +1,39 @@
+/**
+ * @description This is the object to be passed to `SubscriptionBooking.createSubscriptionCart`,
+ * containing information about the selected subscription.
+ *
+ * @property {number} outboundDeparturePhysicalAgencyStopId - The id of the outbound departure stop.
+ * Its value can be retrieved from {@link Subscription.departurePhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} outboundDestinationPhysicalAgencyStopId - The id of the outbound destination stop.
+ * Its value can be retrieved from {@link Subscription.destinationPhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} returnDeparturePhysicalAgencyStopId - The id of the return departure stop (0 if the subscription is for a one-way trip).
+ * Its value can be retrieved from {@link Subscription.departurePhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} returnDestinationPhysicalAgencyStopId - The id of the return destination stop (0 if the subscription is for a one-way trip).
+ * Its value can be retrieved from {@link Subscription.destinationPhysicalAgencyStopId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} outboundRouteId - The id of the outbound route.
+ * Its value can be retrieved from {@link Subscription.routeId}, return value of {@link SubscriptionBooking.getSubscriptions} for the oubound subscription.
+ * @property {number} returnRouteId - The id of the return route (0 if the subscription is for a one-way trip)
+ * Its value can be retrieved from {@link Subscription.routeId}, return value of {@link SubscriptionBooking.getSubscriptions} for the return subscription.
+ * @property {number} numberOfPassengers - The number of passengers to book.
+ * @property {SubscriptionPeriod[]} period - A list of periods for which the subscription should be booked.
+ */
+export type CreateSubscriptionCartRequest = {
+    outboundDeparturePhysicalAgencyStopId: number;
+    outboundDestinationPhysicalAgencyStopId: number;
+    returnDeparturePhysicalAgencyStopId: number;
+    returnDestinationPhysicalAgencyStopId: number;
+    outboundRouteId: number;
+    returnRouteId: number;
+    numberOfPassengers: number;
+    period: SubscriptionPeriod[];
+};
+/**
+ * @description This is the object that describes which perios should be booked.
+ *
+ * @property {string} dateFrom - The start date of the period as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities}.
+ * @property {string} dateTo - The end date of the period as returned by {@link SubscriptionBooking.getSubscrptionAvailabilities}.
+ */
+export type SubscriptionPeriod = {
+    dateFrom: string;
+    dateTo: string;
+};

package/lib/types/subscriptions/SubscriptionCart.js

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

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

@@ -0,0 +1,26 @@
+/**
+ * @description This is the object to be returned by to `SubscriptionBooking.getSubscrptions`, containing information about the selected subscription.
+ *
+ * @property {number} departurePhysicalAgencyStopId - The id of the departure stop.
+ * @property {string} departureStopName - The name of the departure stop.
+ * @property {number} destinationPhysicalAgencyStopId - The id of the destination stop.
+ * @property {string} destinationStopName - The name of the destination stop.
+ * @property {string} departureTime - The time of departure from the departureStop.
+ * @property {string} destinationTime - The time of arrival to the destinationStop.
+ * @property {string} lineName - The name of the line on which the subscription is sold.
+ * @property {number} routeId - The id of the route on which the subscription is sold.
+ * @property {string} routeName - The name of the route on which the subscription is sold.
+ * @property {number} sellerId - The id of the seller selling the subscription.
+ */
+export type Subscription = {
+    departurePhysicalAgencyStopId: number;
+    departureStopName: string;
+    destinationPhysicalAgencyStopId: number;
+    destinationStopName: string;
+    departureTime: string;
+    destinationTime: string;
+    lineName: string;
+    routeId: number;
+    routeName: string;
+    sellerId: number;
+};

package/lib/types/subscriptions/Subscriptions.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.2",
+  "version": "1.1.4",
   "description": "Library for use MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",