mts-booking-library 1.0.5 → 1.1.1

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

@@ -0,0 +1,16 @@
+/**
+ * @description Represents a stop in a journey.
+ *
+ * @property {number} id - The unique identifier for the stop.
+ * @property {Date} departureTime - The time when the journey departs from this stop.
+ * @property {Date} destinationTime - The time when the journey arrives at this stop.
+ * @property {string} name - The name of the stop.
+ * @property {string} address - The address of the stop.
+ */
+export type Stop = {
+    id: number;
+    departureTime: Date;
+    destinationTime: Date;
+    name: string;
+    address: string;
+};

package/lib/types/{Journeys → journeys}/Trip.d.ts

@@ -1,4 +1,4 @@
-import { TariffMatrix, TariffType, TermsType } from "../TermsAndTariffs";
+import { TariffMatrix, TariffType, TermsType } from "../common/Tariffs";
 export type Trip = {
     id: number;
     date: Date;

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

@@ -0,0 +1,14 @@
+/**
+ * @description Represents a line on which the service is sold.
+ *
+ * @property {number} id - The unique identifier for the line.
+ * @property {string} name - The name of the line.
+ * @property {string} linkavelDescription - A description of the line, to be used in {@link https://linkavel.com/} or in other ecommerses.
+ * @property {string} backofficeNotes - Additional notes or information about the line for internal use.
+ */
+export type Line = {
+    id: number;
+    name: string;
+    linkavelDescription: string;
+    backofficeNotes: string;
+};

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

@@ -0,0 +1,33 @@
+import { TariffMatrix, TariffType, TermsType } from "../common/Tariffs";
+import { Line } from "./Line";
+import { ServiceInfo } from "./ServiceInfo";
+/**
+ * @description Represents a service offering, including information about the service, tariffs,
+ * terms, and other details.
+ *
+ * @property {number} id - The unique identifier for the service.
+ * @property {Line} line - Information about the line or route associated with the service.
+ * @property {ServiceInfo} info - Information about the service itself.
+ * @property {TariffMatrix} tariffsMatrix - The tariff matrix for pricing.
+ * @property {TariffType[]} tariffTypes - An array of tariff types available for the service.
+ * @property {TermsType[]} termsTypes - An array of terms types related to the service.
+ * @property {boolean} isDateOptional - Indicates whether a date can be optionally specified for this service.
+ * @property {boolean} isDateRequired - Indicates whether specifying a date is required for booking.
+ * @property {boolean} isTripMandatory - Indicates whether the selection of the trip in the selected date is mandatory.
+ */
+export type Service = {
+    id: number;
+    line: Line;
+    info: ServiceInfo;
+    tariffsMatrix: TariffMatrix;
+    tariffTypes: TariffType[];
+    termsTypes: TermsType[];
+    isDateOptional: boolean;
+    isDateRequired: boolean;
+    isTripMandatory: boolean;
+};
+export type ServiceTrip = {
+    tripId?: number;
+    date: Date;
+    name: string;
+};

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

@@ -0,0 +1,46 @@
+import { Booking } from "../../booking/booking";
+import { Cart } from "../common/Cart";
+import { TariffMatrix, TariffSummary } from "../common/Tariffs";
+import { ServiceTrip } from "./Service";
+/**
+ * @description This is the object to be passed to `ServiceBooking.createServiceCart`, containing information about the selected service.
+ *
+ * @property {Booking.Currencies} currency - The currency in which the service is priced.
+ * @property {Object} service - Information about the selected service.
+ * @property {number} service.serviceId - The unique identifier for the service.
+ * @property {TariffMatrix} service.tariffsMatrix - The tariff matrix for pricing the service.
+ * @property {Date|undefined} [service.date] - The date for the service (optional).
+ * @property {number|undefined} [service.tripId] - The unique identifier for the trip (optional).
+ */
+export type CreateServiceCartRequest = {
+    currency: Booking.Currencies;
+    service: {
+        serviceId: number;
+        tariffsMatrix: TariffMatrix;
+        date?: Date;
+        tripId?: number;
+    };
+};
+/**
+ * @description Represents a `JourneyCart`, which extends the {@link Cart} type by including additional
+ * information about the bookings
+ *
+ * @property {ServiceBooking[]} bookings - An array of {@link ServiceBookingType} objects representing the bookings associated
+ * with this journey cart.
+ */
+export type ServiceCart = Cart & {
+    bookings: ServiceBookingType[];
+};
+/**
+ * @description Represents a `JourneyBooking`, which contains information about a journey booking.
+ *
+ * @property {Booking.BookingTypes} type - The type of booking.
+ * @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 ServiceBookingType = {
+    type: Booking.BookingTypes;
+    summary: TariffSummary[];
+    info: ServiceTrip;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * @description Represents information about a service.
+ *
+ * @property {string} sellerName - The name of the seller offering the service.
+ * @property {string} minimumTotalPrice - The minimum total price for booking the service, meaning the price if all passenger choose the cheapest tariff.
+ * @property {string} bookingProcessMessage - Optional message to be displayed to the user when booking this service.
+ * @property {boolean} isBookable - Indicates whether the service is bookable (true) or not (false).
+ */
+export type ServiceInfo = {
+    sellerName: string;
+    minimumTotalPrice: string;
+    bookingProcessMessage: string;
+    isBookable: boolean;
+};

package/lib/utils/apiCall.js

@@ -51,8 +51,12 @@ exports.makePost = exports.makeGet = void 0;
 var axios_1 = require("axios");
 var config_1 = require("../config");
 var makeGet = function (url) { return __awaiter(void 0, void 0, void 0, function () {
+    var debug;
     return __generator(this, function (_a) {
-        console.log("GET ".concat(url));
+        debug = (0, config_1.getConfig)().DEBUG;
+        if (debug) {
+            console.log("GetRequestData", url);
+        }
         return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
                 var response, error_1, resError;
                 return __generator(this, function (_a) {
@@ -64,11 +68,17 @@ var makeGet = function (url) { return __awaiter(void 0, void 0, void 0, function
                                 })];
                         case 1:
                             response = _a.sent();
+                            if (debug) {
+                                console.log("GetResponseData", url, response.data);
+                            }
                             resolve(response.data);
                             return [3 /*break*/, 3];
                         case 2:
                             error_1 = _a.sent();
                             resError = error_1.response.data;
+                            if (debug) {
+                                console.log("GetResponseError", url, resError);
+                            }
                             reject(resError);
                             return [3 /*break*/, 3];
                         case 3: return [2 /*return*/];
@@ -79,8 +89,12 @@ var makeGet = function (url) { return __awaiter(void 0, void 0, void 0, function
 }); };
 exports.makeGet = makeGet;
 var makePost = function (url, data) { return __awaiter(void 0, void 0, void 0, function () {
+    var debug;
     return __generator(this, function (_a) {
-        console.log("POST ".concat(url));
+        debug = (0, config_1.getConfig)().DEBUG;
+        if (debug) {
+            console.log("PostRequestData", url, data);
+        }
         return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
                 var response, error_2, resError;
                 return __generator(this, function (_a) {
@@ -92,11 +106,17 @@ var makePost = function (url, data) { return __awaiter(void 0, void 0, void 0, f
                                 })];
                         case 1:
                             response = _a.sent();
+                            if (debug) {
+                                console.log("PostResponseData", url, response.data);
+                            }
                             resolve(response.data);
                             return [3 /*break*/, 3];
                         case 2:
                             error_2 = _a.sent();
                             resError = error_2.response.data;
+                            if (debug) {
+                                console.log("PostResponseError", url, resError);
+                            }
                             reject(resError);
                             return [3 /*break*/, 3];
                         case 3: return [2 /*return*/];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mts-booking-library",
-  "version": "1.0.5",
+  "version": "1.1.1",
   "description": "Library for use MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,7 +14,7 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@types/jest": "^29.5.4",
+    "@types/jest": "^29.5.5",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.2.2"
@@ -28,7 +28,7 @@
   ],
   "author": "M",
   "dependencies": {
-    "axios": "^1.5.0",
+    "axios": "^1.5.1",
     "node-localstorage": "^3.0.5"
   }
 }

package/lib/types/Booking.js

@@ -1 +0,0 @@
-"use strict";

package/lib/types/Cart.d.ts

@@ -1,79 +0,0 @@
-import { Booking } from "..";
-import { Person } from "./Person";
-import { TariffMatrix } from "./TermsAndTariffs";
-export type Cart = {
-    id: number;
-    cartCode: string;
-    status: Booking.CartStatus;
-    nextStatus: Booking.CartStatus;
-    currency: string;
-    bookingDueDate: string;
-    bookings: {
-        type: string;
-        summary: {
-            quantity: number;
-            label: string;
-            value: number;
-        }[];
-    }[];
-    info: {
-        stops: {
-            id: number;
-            departureTime: Date;
-            destinationTime: Date;
-            name: string;
-            address: string;
-        }[];
-    };
-    buyer: Person;
-    reductions: {
-        tripId: number;
-        tripName: string;
-        value: number;
-        isPercentage: boolean;
-        voucherCode?: string;
-    }[];
-    isSeatsSelectionAllowed: boolean;
-    sellingMethod: string;
-    totalValue: number;
-    totalResellerFee?: number;
-    totalCreditFromChange: number;
-    totalAmountToPay: number;
-    extas: {
-        id: number;
-        resourceId: number;
-        name: string;
-        description: string;
-        notes: string;
-        tariff: {
-            tariffId: number;
-            tariffName: string;
-        };
-    }[];
-};
-export type TourCart = {
-    cartId?: number;
-    currency: Booking.Currencies;
-    tour: {
-        tourId: number;
-        date?: Date;
-        tripId?: number;
-        tariffsMatrix: TariffMatrix;
-    };
-};
-export type JourneyCart = {
-    cartId?: number;
-    currency: Booking.Currencies;
-    outboundJourney: {
-        departureStopId: number;
-        destinationStopId: number;
-        tripId: number;
-        tariffsMatrix: TariffMatrix;
-    }[];
-    returnJourney: {
-        tripId: number;
-        departureStopId: number;
-        destinationStopId: number;
-        tariffsMatrix: TariffMatrix;
-    }[] | null;
-};

package/lib/types/Details.d.ts

@@ -1,9 +0,0 @@
-import { Person } from "./Person";
-export type Details = {
-    passengers: Person[] & {
-        tripsToTariffs: {
-            [tripId: number]: number;
-        };
-    };
-    buyer: Person;
-};

package/lib/types/Info.d.ts

@@ -1,8 +0,0 @@
-export type Info = {
-    sellerName: string;
-    minimumTotalPrice: string;
-    remainingSeats?: number;
-    totalNumberOfSeats?: number;
-    bookingProcessMessage: string;
-    isBookable: boolean;
-};

package/lib/types/Journey.d.ts

@@ -1,8 +0,0 @@
-import { Info } from "./Info";
-import { Stop } from "./Stop";
-import { Trip } from "./Trip";
-export type Journey = {
-    stops: Stop[];
-    info: Info;
-    trips: Trip[];
-};

package/lib/types/JourneySearch.d.ts

@@ -1,9 +0,0 @@
-import { Booking } from "..";
-export type JourneySearch = {
-    departureStopName: string;
-    destinationStopName: string;
-    passengersNumber: number;
-    date: Date;
-    currency: Booking.Currencies;
-    isRoundtrip: boolean;
-};

package/lib/types/Journeys/BusMatrix.js

@@ -1 +0,0 @@
-"use strict";

package/lib/types/Journeys/Journey.d.ts

@@ -1,8 +0,0 @@
-import { Stop } from "./Stop";
-import { Info } from "../Info";
-import { Trip } from "./Trip";
-export type Journey = {
-    stops: Stop[];
-    info: Info;
-    trips: Trip[];
-};

package/lib/types/Journeys/JourneySearch.d.ts

@@ -1,11 +0,0 @@
-import { Booking } from "../..";
-export type JourneySearch = {
-    departureStopName: string | undefined;
-    destinationStopName: string | undefined;
-    passengersNumber: number;
-    date: Date;
-    roundTripDate: Date | null;
-    currency: Booking.Currencies;
-    isRoundtrip: boolean;
-};
-export declare const DefaultJourneySearch: JourneySearch;

package/lib/types/Journeys/Stop.d.ts

@@ -1,7 +0,0 @@
-export type Stop = {
-    id: number;
-    departureTime: Date;
-    destinationTime: Date;
-    name: string;
-    address: string;
-};

package/lib/types/Line.d.ts

@@ -1,6 +0,0 @@
-export type Line = {
-    id: number;
-    name: string;
-    linkavelDescription: string;
-    backofficeNotes: string;
-};

package/lib/types/Person.d.ts

@@ -1,7 +0,0 @@
-export type Person = {
-    id: number;
-    name: string;
-    lastName: string;
-    email: string;
-    phoneNumber: string;
-};

package/lib/types/Stop.d.ts

@@ -1,7 +0,0 @@
-export type Stop = {
-    id: number;
-    departureTime: Date;
-    destinationTime: Date;
-    name: string;
-    address: string;
-};

package/lib/types/Stop.js

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

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

@@ -1,6 +0,0 @@
-export declare enum ValidityTypes {
-    WORKING_WEEK = "WORKING_WEEK",
-    WEEKLY = "WEEKLY",
-    MONTHLY = "MONTHLY",
-    YEARLY = "YEARLY"
-}

package/lib/types/Subscriptions/ValidityTypes.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidityTypes = void 0;
-var ValidityTypes;
-(function (ValidityTypes) {
-    ValidityTypes["WORKING_WEEK"] = "WORKING_WEEK";
-    ValidityTypes["WEEKLY"] = "WEEKLY";
-    ValidityTypes["MONTHLY"] = "MONTHLY";
-    ValidityTypes["YEARLY"] = "YEARLY";
-})(ValidityTypes || (exports.ValidityTypes = ValidityTypes = {}));

package/lib/types/TermsAndTariffs.js

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

package/lib/types/Tour.d.ts

@@ -1,18 +0,0 @@
-import { Info } from "./Info";
-import { Line } from "./Line";
-import { TariffMatrix, TariffType, TermsType } from "./TermsAndTariffs";
-export type Tour = {
-    id: number;
-    line: Line;
-    info: Info;
-    tariffsMatrix: TariffMatrix;
-    tariffTypes: TariffType[];
-    termsTypes: TermsType[];
-    isDateOptional: boolean;
-    isDateRequired: boolean;
-    isTripMandatory: boolean;
-};
-export type TourTrip = {
-    tripId: number;
-    hour: Date;
-};

package/lib/types/Tour.js

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

package/lib/types/Tours/Tour.d.ts

@@ -1,18 +0,0 @@
-import { Info } from "../Info";
-import { Line } from "../Line";
-import { TariffMatrix, TariffType, TermsType } from "../TermsAndTariffs";
-export type Tour = {
-    id: number;
-    line: Line;
-    info: Info;
-    tariffsMatrix: TariffMatrix;
-    tariffTypes: TariffType[];
-    termsTypes: TermsType[];
-    isDateOptional: boolean;
-    isDateRequired: boolean;
-    isTripMandatory: boolean;
-};
-export type TourTrip = {
-    tripId: number;
-    hour: Date;
-};

package/lib/types/Tours/Tour.js

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

package/lib/types/Tours.js

@@ -1 +0,0 @@
-"use strict";

package/lib/types/Trip.d.ts

@@ -1,9 +0,0 @@
-import { TariffMatrix, TariffType, TermsType } from "./TermsAndTariffs";
-export type Trip = {
-    id: number;
-    departureStopName: string;
-    destinationStopName: string;
-    tariffsMatrix: TariffMatrix;
-    tariffTypes: TariffType[];
-    termsTypes: TermsType[];
-};

package/lib/types/Trip.js

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

package/lib/types/TripSearch.d.ts

@@ -1,9 +0,0 @@
-import { Booking } from "..";
-export type TripSearch = {
-    departureStopName: string;
-    destinationStopName: string;
-    passengersNumber: number;
-    date: Date;
-    currency: Booking.Currencies;
-    isRoundtrip: boolean;
-};

package/lib/types/TripSearch.js

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