mts-booking-library 3.4.0 → 3.6.0

package/lib/booking/journeyBooking.d.ts

@@ -8,6 +8,21 @@ import { JourneySearchRequest, JourneySearchResult } from "../types/journeys/Jou
 import { ReductionTrip } from "../types/journeys/Trip";
 import { ApiCallOptions } from "../utils/apiCall";
 import { Booking } from "./booking";
+type JourneyLineRouteFilters = {
+    lineId?: number | null;
+    routeId?: number | null;
+};
+/**
+ * A stop with optional metadata. `region` and `hint` may be null when the
+ * backend has no Province / City data for the underlying physical stop.
+ * Returned by {@link JourneyBooking.getJourneysDeparturesEnriched} and
+ * {@link JourneyBooking.getJourneysDestinationsEnriched}.
+ */
+export type EnrichedStop = {
+    name: string;
+    region?: string | null;
+    hint?: string | null;
+};
 export declare class JourneyBooking extends Booking {
     private cart?;
     /**
@@ -116,13 +131,26 @@ export declare class JourneyBooking extends Booking {
      * This method returns the possible departures for all journeys (MLP) sold by this seller.
      * @returns The list of possible departures
      */
-    getJourneysDepartures(options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
+    getJourneysDepartures(filtersOrOptions?: JourneyLineRouteFilters | ApiCallOptions, options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
+    /**
+     * Like {@link getJourneysDepartures}, but returns the enriched representation
+     * (name + optional region + optional hint) when the backend exposes it.
+     * Falls back to a flat {name}-only list when the backend response only
+     * carries the legacy `stops` field. Separate from the original method to
+     * avoid breaking the existing `string[]` contract used by other clients.
+     */
+    getJourneysDeparturesEnriched(filtersOrOptions?: JourneyLineRouteFilters | ApiCallOptions, options?: ApiCallOptions): Promise<ErrorResponse | EnrichedStop[]>;
     /**
      * This method returns the possible destination for the journeys sold by this seller that start at the selected departure.
      * @param departureStopName The departure stop name (as returned by {@link getJourneysDepartures})
      * @returns The list of possible destinations
      */
-    getJourneysDestinations(departureStopName: string, options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
+    getJourneysDestinations(departureStopName: string, filtersOrOptions?: JourneyLineRouteFilters | ApiCallOptions, options?: ApiCallOptions): Promise<ErrorResponse | string[]>;
+    /**
+     * Like {@link getJourneysDestinations}, but returns the enriched
+     * representation (see {@link getJourneysDeparturesEnriched}).
+     */
+    getJourneysDestinationsEnriched(departureStopName: string, filtersOrOptions?: JourneyLineRouteFilters | ApiCallOptions, options?: ApiCallOptions): Promise<ErrorResponse | EnrichedStop[]>;
     /**
      * This method returns the journeys that match the given parameters.
      * Note that it will always return the journeys for the one-way trip.
@@ -228,3 +256,4 @@ export declare class JourneyBooking extends Booking {
 export declare namespace JourneyBooking {
     const createBooking: ({ env, subKey, debug, language, sessionId, restoreState, accessToken, sellerId, resellerId, appVersion, os, dbType }: Omit<Booking.BookingConfig, "bookingType">) => Promise<JourneyBooking>;
 }
+export {};

package/lib/booking/journeyBooking.js

@@ -79,6 +79,26 @@ var Reduction_1 = require("../types/common/Reduction");
 var processBookingSteps_1 = require("../utils/processBookingSteps");
 var utils_1 = require("../utils/utils");
 var booking_1 = require("./booking");
+var isJourneyLineRouteFilters = function (value) { return !!value && ("lineId" in value || "routeId" in value); };
+var getJourneyLineRouteParams = function (filters) { return (__assign(__assign({}, ((filters === null || filters === void 0 ? void 0 : filters.lineId) && { lineId: filters.lineId.toString() })), ((filters === null || filters === void 0 ? void 0 : filters.routeId) && { routeId: filters.routeId.toString() }))); };
+var isEnrichedStop = function (x) {
+    return typeof x === "object" && x !== null && typeof x.name === "string";
+};
+/**
+ * Parses the booking-API stop response into the enriched shape. When the
+ * backend doesn't populate `stopsEnriched` (older deployment), reconstructs
+ * a minimal `{name}` list from the flat `stops` array so callers always
+ * receive the same shape.
+ */
+var enrichedStopsFromResponse = function (response) {
+    var _a;
+    var enriched = Array.isArray(response.stopsEnriched)
+        ? response.stopsEnriched.filter(isEnrichedStop)
+        : [];
+    if (enriched.length > 0)
+        return enriched;
+    return ((_a = response.stops) !== null && _a !== void 0 ? _a : []).map(function (name) { return ({ name: name }); });
+};
 var JourneyBooking = /** @class */ (function (_super) {
     __extends(JourneyBooking, _super);
     /**
@@ -219,34 +239,82 @@ var JourneyBooking = /** @class */ (function (_super) {
      * This method returns the possible departures for all journeys (MLP) sold by this seller.
      * @returns The list of possible departures
      */
-    JourneyBooking.prototype.getJourneysDepartures = function (options) {
+    JourneyBooking.prototype.getJourneysDepartures = function (filtersOrOptions, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var url;
+            var filters, requestOptions, searchParams, url;
             return __generator(this, function (_a) {
-                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys/departures?");
-                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
+                filters = isJourneyLineRouteFilters(filtersOrOptions) ? filtersOrOptions : undefined;
+                requestOptions = isJourneyLineRouteFilters(filtersOrOptions) ? options : filtersOrOptions;
+                searchParams = new URLSearchParams(getJourneyLineRouteParams(filters));
+                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys/departures?").concat(searchParams);
+                return [2 /*return*/, this.callGetApi(url, requestOptions).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.stops;
                     })];
             });
         });
     };
+    /**
+     * Like {@link getJourneysDepartures}, but returns the enriched representation
+     * (name + optional region + optional hint) when the backend exposes it.
+     * Falls back to a flat {name}-only list when the backend response only
+     * carries the legacy `stops` field. Separate from the original method to
+     * avoid breaking the existing `string[]` contract used by other clients.
+     */
+    JourneyBooking.prototype.getJourneysDeparturesEnriched = function (filtersOrOptions, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var filters, requestOptions, searchParams, url;
+            return __generator(this, function (_a) {
+                filters = isJourneyLineRouteFilters(filtersOrOptions) ? filtersOrOptions : undefined;
+                requestOptions = isJourneyLineRouteFilters(filtersOrOptions) ? options : filtersOrOptions;
+                searchParams = new URLSearchParams(getJourneyLineRouteParams(filters));
+                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys/departures?").concat(searchParams);
+                return [2 /*return*/, this.callGetApi(url, requestOptions).then(function (response) {
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response))
+                            return response;
+                        return enrichedStopsFromResponse(response);
+                    })];
+            });
+        });
+    };
     /**
      * This method returns the possible destination for the journeys sold by this seller that start at the selected departure.
      * @param departureStopName The departure stop name (as returned by {@link getJourneysDepartures})
      * @returns The list of possible destinations
      */
-    JourneyBooking.prototype.getJourneysDestinations = function (departureStopName, options) {
+    JourneyBooking.prototype.getJourneysDestinations = function (departureStopName, filtersOrOptions, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var searchParams, url;
+            var filters, requestOptions, searchParams, url;
             return __generator(this, function (_a) {
-                searchParams = new URLSearchParams({ departureStopName: departureStopName });
+                filters = isJourneyLineRouteFilters(filtersOrOptions) ? filtersOrOptions : undefined;
+                requestOptions = isJourneyLineRouteFilters(filtersOrOptions) ? options : filtersOrOptions;
+                searchParams = new URLSearchParams(__assign({ departureStopName: departureStopName }, getJourneyLineRouteParams(filters)));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys/destinations?").concat(searchParams);
-                return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
+                return [2 /*return*/, this.callGetApi(url, requestOptions).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response) ? response : response.stops;
                     })];
             });
         });
     };
+    /**
+     * Like {@link getJourneysDestinations}, but returns the enriched
+     * representation (see {@link getJourneysDeparturesEnriched}).
+     */
+    JourneyBooking.prototype.getJourneysDestinationsEnriched = function (departureStopName, filtersOrOptions, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var filters, requestOptions, searchParams, url;
+            return __generator(this, function (_a) {
+                filters = isJourneyLineRouteFilters(filtersOrOptions) ? filtersOrOptions : undefined;
+                requestOptions = isJourneyLineRouteFilters(filtersOrOptions) ? options : filtersOrOptions;
+                searchParams = new URLSearchParams(__assign({ departureStopName: departureStopName }, getJourneyLineRouteParams(filters)));
+                url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys/destinations?").concat(searchParams);
+                return [2 /*return*/, this.callGetApi(url, requestOptions).then(function (response) {
+                        if ((0, ErrorResponse_1.objectIsMTSErrorResponse)(response))
+                            return response;
+                        return enrichedStopsFromResponse(response);
+                    })];
+            });
+        });
+    };
     /**
      * This method returns the journeys that match the given parameters.
      * Note that it will always return the journeys for the one-way trip.
@@ -262,7 +330,7 @@ var JourneyBooking = /** @class */ (function (_super) {
                 if (request.departureStopName === undefined || request.destinationStopName === undefined) {
                     throw Error("Fields departureStopName and destinationStopName are required");
                 }
-                searchParams = new URLSearchParams(__assign(__assign(__assign({ departureStopName: request.departureStopName, destinationStopName: request.destinationStopName, passengersNumber: request.passengersNumber.toString(), outboundDate: request.outboundDate.dateTime }, (request.returnDate && { returnDate: request.returnDate.dateTime })), { currency: request.currency, outboundTripId: (_b = (_a = request.outboundTripId) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null" }), (this.cartGuid && { cartGuid: this.cartGuid })));
+                searchParams = new URLSearchParams(__assign(__assign(__assign(__assign(__assign({ departureStopName: request.departureStopName, destinationStopName: request.destinationStopName, passengersNumber: request.passengersNumber.toString(), outboundDate: request.outboundDate.dateTime }, (request.returnDate && { returnDate: request.returnDate.dateTime })), { currency: request.currency, outboundTripId: (_b = (_a = request.outboundTripId) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null" }), (request.lineId && { lineId: request.lineId.toString() })), (request.routeId && { routeId: request.routeId.toString() })), (this.cartGuid && { cartGuid: this.cartGuid })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_booking/journeys_v4?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export { Booking } from "./booking/booking";
-export { JourneyBooking } from "./booking/journeyBooking";
+export { JourneyBooking, EnrichedStop } from "./booking/journeyBooking";
 export { ServiceBooking } from "./booking/serviceBooking";
 export { SubscriptionBooking } from "./booking/subscriptionBooking";
 export { TplBooking } from "./booking/tplBooking";

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

@@ -12,6 +12,8 @@ export type JourneySearchRequest = {
     currency: Booking.Currencies;
     isRoundTrip: boolean;
     outboundTripId?: number | null;
+    lineId?: number | null;
+    routeId?: number | null;
 };
 export declare const DEFAULT_JOURNEY_SEARCH: JourneySearchRequest;
 export type JourneySearchResult = {

package/package.json

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