mts-booking-library 3.0.6 → 3.0.7

package/lib/booking/serviceBooking.d.ts

@@ -2,8 +2,9 @@ import { ErrorResponse } from "../types/ErrorResponse";
 import { CreateUpdateCartRequest } from "../types/common/Cart";
 import { GetBuyerPassengersDetailsResponse, Person } from "../types/common/Person";
 import { AddReductionRequest } from "../types/common/Reduction";
-import { Service, ServiceTripsResponse } from "../types/services/Service";
+import { Service } from "../types/services/Service";
 import { ServiceCart } from "../types/services/ServiceCart";
+import { GetTripsResponse } from "../types/tpl/Trips";
 import { ApiCallOptions } from "../utils/apiCall";
 import { Booking } from "./booking";
 export declare class ServiceBooking extends Booking {
@@ -132,7 +133,7 @@ export declare class ServiceBooking extends Booking {
      * @param dateString The date on which to get the tours, in ISO string format
      * @returns {ServiceTripsResponse} The returned information about the tour (tripId and hour)
      */
-    getServiceTrips(serviceId: number, dateString: string, options?: ApiCallOptions): Promise<ErrorResponse | ServiceTripsResponse>;
+    getServiceTrips(serviceId: number, dateString: string, options?: ApiCallOptions): Promise<ErrorResponse | GetTripsResponse>;
     /**
      * This method creates a service cart for the given parameters.
      * @returns The created cart

package/lib/booking/tplBooking.d.ts

@@ -7,6 +7,7 @@ import { TariffType, TermsType } from "../types/common/Tariffs";
 import { GetTariffsResponse } from "../types/tpl/GetTariffsResponse";
 import { GetSuperAreasRequest, SuperArea } from "../types/tpl/SuperArea";
 import { BookingSkip, TplCart } from "../types/tpl/TplCart";
+import { GetTripsResponse } from "../types/tpl/Trips";
 import { ApiCallOptions } from "../utils/apiCall";
 import { Booking } from "./booking";
 export declare class TplBooking extends Booking {
@@ -145,6 +146,16 @@ export declare class TplBooking extends Booking {
      * @returns A {@link GetTariffsResponse} if the call is successful, an {@link ErrorResponse} object otherwise.
      */
     getTariffs(superAreaId: number, termsTypeId: number | null, onlyTickets: boolean, onlySubscriptions: boolean, options?: ApiCallOptions): Promise<ErrorResponse | GetTariffsResponse>;
+    /**
+     * This method returns the tours available for the given date. This method can be used if the seller wants the user to book a specific date
+     * and/or a specific hour for the tour.
+     * You should call this method only if {@link Tariff.isDateOptional} or {@link Tariff.isDateRequired} is true for the selected tour.
+     * @param superAreaId The id of the selected super area (can be retrieved in the object {@link SuperArea} returned by {@link getSuperAreas})
+     * @param tariffId The id of the selected tariff (can be retrieved in the object {@link Tariff} returned by {@link getTariffs})
+     * @param dateString The date on which to get the tours, in ISO date string format
+     * @returns {GetTripsResponse} The returned information about the tour (tripId and hour)
+     */
+    getTplTrips(superAreaId: number, tariffId: number, dateString: string, options?: ApiCallOptions): Promise<ErrorResponse | GetTripsResponse>;
     /**
      * This method creates a tpl cart for the given parameters.
      * @returns The created cart

package/lib/booking/tplBooking.js

@@ -237,7 +237,7 @@ var TplBooking = /** @class */ (function (_super) {
         return __awaiter(this, void 0, void 0, function () {
             var searchParams, url;
             return __generator(this, function (_a) {
-                searchParams = new URLSearchParams(__assign(__assign({ includeBasicInfo: "true", includeAreaIds: "false", includeTariffIds: "false", includeRouteIds: "false" }, (request.cityId && { cityId: request.cityId.toString() })), (request.tripId && { tripId: request.tripId.toString() })));
+                searchParams = new URLSearchParams(__assign(__assign({ includeBasicInfo: "true", includeImage: "true", includeAreaIds: "false", includeTariffIds: "false", includeRouteIds: "false", includeMultilingualDescriptions: "false" }, (request.cityId && { cityId: request.cityId.toString() })), (request.tripId && { tripId: request.tripId.toString() })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_resources/superAreas?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.superAreas;
@@ -313,6 +313,31 @@ var TplBooking = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * This method returns the tours available for the given date. This method can be used if the seller wants the user to book a specific date
+     * and/or a specific hour for the tour.
+     * You should call this method only if {@link Tariff.isDateOptional} or {@link Tariff.isDateRequired} is true for the selected tour.
+     * @param superAreaId The id of the selected super area (can be retrieved in the object {@link SuperArea} returned by {@link getSuperAreas})
+     * @param tariffId The id of the selected tariff (can be retrieved in the object {@link Tariff} returned by {@link getTariffs})
+     * @param dateString The date on which to get the tours, in ISO date string format
+     * @returns {GetTripsResponse} The returned information about the tour (tripId and hour)
+     */
+    TplBooking.prototype.getTplTrips = function (superAreaId, tariffId, dateString, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var searchParams, url;
+            return __generator(this, function (_a) {
+                searchParams = new URLSearchParams({
+                    superAreaId: superAreaId.toString(),
+                    tariffId: tariffId.toString(),
+                    dateString: dateString
+                });
+                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/tpl/trips?").concat(searchParams);
+                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
+                        return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response;
+                    })];
+            });
+        });
+    };
     /**
      * This method creates a tpl cart for the given parameters.
      * @returns The created cart

package/lib/index.d.ts

@@ -22,7 +22,7 @@ export { JourneySearchRequest, JourneySearchResult, DEFAULT_JOURNEY_SEARCH } fro
 export { Stop } from "./types/journeys/Stop";
 export { Trip, CartTrip, ReductionTrip } from "./types/journeys/Trip";
 export { Line } from "./types/services/Line";
-export { Service, TripIdAndHour, ServiceTripsResponse, ServiceTrip } from "./types/services/Service";
+export { Service, ServiceTrip } from "./types/services/Service";
 export { ServiceCart, ServiceBookingType } from "./types/services/ServiceCart";
 export { ServiceInfo } from "./types/services/ServiceInfo";
 export { GetTariffsResponse } from "./types/tpl/GetTariffsResponse";

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

@@ -48,6 +48,14 @@ export type Tariff = {
     roundTripCode: string | null;
     /** Whether the tariff is active */
     isActive: boolean;
+    /** For TPL Tours, this tells whether it is possible to select a date for this tariff */
+    isDateOptional: boolean;
+    /** For TPL Tours, this tells whether it is mandatory to select a date for this tariff */
+    isDateRequired: boolean;
+    /** For TPL Tours, this tells whether it is mandatory to select a time for the selected date for this tariff */
+    isTripMandatory: boolean;
+    /** For TPL Tours, this is the list of possible dates to select for this tariff, in ISO date string format. */
+    possibleDates: string[];
 };
 /**
  * This represents a tariff matrix, returned when searching Journeys or Services.

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

@@ -26,12 +26,6 @@ export type Service = {
     isDateRequired: boolean;
     isTripMandatory: boolean;
 };
-export type TripIdAndHour = {
-    /** The id of the trip. */
-    tripId: number;
-    /** The hour of the trip. */
-    hour: string;
-};
 export type ServiceTrip = {
     /** The name of the service */
     name: string;
@@ -40,13 +34,3 @@ export type ServiceTrip = {
     /** The id of the trip, if set. */
     tripId?: number;
 };
-/**
- * @description Represents a response from the service trips endpoint
- * @param {boolean} areThereTrips - Indicates whether there are trips available for the service.
- * @param {TripIdAndHour[]} trips - An array of {@link TripIdAndHour} objects representing the available trips. This can be empty
- * even if `areThereTrips` is true, as the user might be not allowed to select a specific trip.
- */
-export type ServiceTripsResponse = {
-    areThereTrips: boolean;
-    trips: TripIdAndHour[];
-};

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

@@ -1,15 +1,17 @@
-/**
- * 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
- */
+/** This type represents a super area. It is the return object of the {@link TplBooking.getSuperAreas} method. */
 export type SuperArea = {
+    /** The id of the super area in the database */
     id: number;
+    /** The name of the super area */
     name: string;
+    /** The short name of the super area */
     shortName: string;
+    /** The description of the super area */
     description: string;
+    /** The description of the super area to be shown in the booking process. This is returned in the language requested by the client */
+    bookingProcessDescription: string;
+    /** The url of the image of the super area */
+    imageUrl: string;
 };
 export type GetSuperAreasRequest = {
     /** The id of the city (as returned by the {@link TplBooking.getCities} method). If present, only the super areas associated with this city will be returned. */

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

@@ -0,0 +1,16 @@
+export type TripIdAndHour = {
+    /** The id of the trip. */
+    tripId: number;
+    /** The hour of the trip. */
+    hour: string;
+};
+/**
+ * @description Represents a response from the service trips endpoint
+ * @param {boolean} areThereTrips - Indicates whether there are trips available for the service.
+ * @param {TripIdAndHour[]} trips - An array of {@link TripIdAndHour} objects representing the available trips. This can be empty
+ * even if `areThereTrips` is true, as the user might be not allowed to select a specific trip.
+ */
+export type GetTripsResponse = {
+    areThereTrips: boolean;
+    trips: TripIdAndHour[];
+};

package/lib/types/tpl/Trips.js

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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "mts-booking-library",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "Library for using MyTicketSolution Booking API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "pretest": "tsc --noEmit",
     "test": "jest --config jestconfig.json",
     "prepare": "npm audit --audit-level=moderate && npm run build",
@@ -22,16 +22,16 @@
     "@eslint/js": "^9.33.0",
     "@types/jest": "^30.0.0",
     "@types/node-localstorage": "^1.3.3",
-    "dotenv": "^17.2.1",
+    "dotenv": "^17.3.1",
     "eslint": "^9.33.0",
     "eslint-config-prettier": "^10.1.8",
-    "globals": "^16.3.0",
-    "jest": "^30.0.5",
+    "globals": "^17.4.0",
+    "jest": "^30.2.0",
     "node-localstorage": "^3.0.5",
-    "prettier": "^3.6.2",
-    "ts-jest": "^29.4.1",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.40.0"
+    "prettier": "^3.8.1",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.1"
   },
   "files": [
     "lib/**/*"
@@ -42,8 +42,8 @@
   ],
   "author": "Infoservice s.r.l.",
   "dependencies": {
-    "@react-native-async-storage/async-storage": "~2.2.0",
-    "axios": "~1.13.0",
-    "zustand": "~5.0.8"
+    "@react-native-async-storage/async-storage": "~3.0.1",
+    "axios": "~1.13.6",
+    "zustand": "~5.0.11"
   }
 }