mts-booking-library 3.0.14 → 3.2.0

package/lib/booking/booking.d.ts

@@ -78,11 +78,13 @@ export declare abstract class Booking {
     /**
      * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
      * @param gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
-     * @param returnUrl The url to which the user will be redirected after the payment. This value shall be set only if the
-     * chosen gateway is {@link GatewayTypes.PAYPAL} or {@link GatewayTypes.WORLDLINE}
+     * @param returnOrigin The FE origin (scheme+host+port, e.g. `window.location.origin`) that the gateway should redirect
+     * back to after the payment. The BE validates this against a per-app allowlist and stitches the canonical
+     * `/booking?step=BOOKING_STEP_PAYMENT_PROCESSING&cartGuid={guid}` path on top. Pass `window.location.origin` from the
+     * caller — the BE owns the rest. Replaces the legacy full-URL `returnUrl` parameter (BE 3.2.0+).
      * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
      */
-    getPaymentInformationFromGateway(gatewayId: number, returnUrl?: string, options?: ApiCallOptions): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
+    getPaymentInformationFromGateway(gatewayId: number, returnOrigin: string, options?: ApiCallOptions): Promise<ErrorResponse | GetPaymentInformationFromGatewayResponse>;
     /**
      * @description This method shall be used to issue the tickets. It must be called after the payment was successful.
      * @param paymentMethod The payment method used to pay the cart. If the chosen method is {@link PaymentMethods.ZERO_COST},

package/lib/booking/booking.js

@@ -285,11 +285,13 @@ var Booking = /** @class */ (function () {
     /**
      * @description This method shall be used to get all necessary informations to initialize a payment with a certain gateway.
      * @param gatewayId The id of the gateway to use. Its value shall be taken from the response of the {@link Booking.getSellerGateways} API
-     * @param returnUrl The url to which the user will be redirected after the payment. This value shall be set only if the
-     * chosen gateway is {@link GatewayTypes.PAYPAL} or {@link GatewayTypes.WORLDLINE}
+     * @param returnOrigin The FE origin (scheme+host+port, e.g. `window.location.origin`) that the gateway should redirect
+     * back to after the payment. The BE validates this against a per-app allowlist and stitches the canonical
+     * `/booking?step=BOOKING_STEP_PAYMENT_PROCESSING&cartGuid={guid}` path on top. Pass `window.location.origin` from the
+     * caller — the BE owns the rest. Replaces the legacy full-URL `returnUrl` parameter (BE 3.2.0+).
      * @returns An {@link ErrorResponse} object in case of error, a {@link GetPaymentInformationFromGatewayResponse} object otherwise.
      */
-    Booking.prototype.getPaymentInformationFromGateway = function (gatewayId, returnUrl, options) {
+    Booking.prototype.getPaymentInformationFromGateway = function (gatewayId, returnOrigin, options) {
         return __awaiter(this, void 0, void 0, function () {
             var issueStep, searchParams, url;
             return __generator(this, function (_a) {
@@ -301,7 +303,7 @@ var Booking = /** @class */ (function () {
                 if (!issueStep || !issueStep[0]) {
                     throw Error("The status of the cart does not allow to call this API");
                 }
-                searchParams = new URLSearchParams(__assign({ gatewayId: gatewayId.toString(), cartGuid: this.cartGuid }, (returnUrl && { returnUrl: returnUrl })));
+                searchParams = new URLSearchParams(__assign({ gatewayId: gatewayId.toString(), cartGuid: this.cartGuid }, (returnOrigin && { returnOrigin: returnOrigin })));
                 url = "".concat(this.config.API_ENDPOINT, "/v3_payment/paymentInformation?").concat(searchParams);
                 return [2 /*return*/, this.callGetApi(url, options).then(function (response) {
                         return (0, ErrorResponse_1.objectIsMTSErrorResponse)(response)

package/lib/booking/journeyBooking.js

@@ -134,17 +134,20 @@ var JourneyBooking = /** @class */ (function (_super) {
     };
     JourneyBooking.prototype.fetchAndSetCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var cart;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var cart, isDeadCart;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0: return [4 /*yield*/, this.fetchCart(cartGuid, options)];
                     case 1:
-                        cart = _a.sent();
+                        cart = _c.sent();
                         if (!cart)
                             return [2 /*return*/];
+                        isDeadCart = cart.hasCanceledTickets === true && ((_b = (_a = cart.bookings) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0;
                         if (cart.bookingDueDateTime &&
                             new Date(cart.bookingDueDateTime.dateTime) > new Date() &&
-                            !cart.hasIssuedTickets) {
+                            !cart.hasIssuedTickets &&
+                            !isDeadCart) {
                             this.cart = cart;
                             this.cartGuid = cart.guid;
                             this.bookingDueDateTime = cart.bookingDueDateTime; // See Booking class

package/lib/booking/serviceBooking.js

@@ -134,17 +134,20 @@ var ServiceBooking = /** @class */ (function (_super) {
     };
     ServiceBooking.prototype.fetchAndSetCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var cart;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var cart, isDeadCart;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0: return [4 /*yield*/, this.fetchCart(cartGuid, options)];
                     case 1:
-                        cart = _a.sent();
+                        cart = _c.sent();
                         if (!cart)
                             return [2 /*return*/];
+                        isDeadCart = cart.hasCanceledTickets === true && ((_b = (_a = cart.bookings) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0;
                         if (cart.bookingDueDateTime &&
                             new Date(cart.bookingDueDateTime.dateTime) > new Date() &&
-                            !cart.hasIssuedTickets) {
+                            !cart.hasIssuedTickets &&
+                            !isDeadCart) {
                             this.cart = cart;
                             this.cartGuid = cart.guid;
                             this.bookingDueDateTime = cart.bookingDueDateTime; // See Booking class

package/lib/booking/subscriptionBooking.js

@@ -134,17 +134,20 @@ var SubscriptionBooking = /** @class */ (function (_super) {
     };
     SubscriptionBooking.prototype.fetchAndSetCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var cart;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var cart, isDeadCart;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0: return [4 /*yield*/, this.fetchCart(cartGuid, options)];
                     case 1:
-                        cart = _a.sent();
+                        cart = _c.sent();
                         if (!cart)
                             return [2 /*return*/];
+                        isDeadCart = cart.hasCanceledTickets === true && ((_b = (_a = cart.bookings) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0;
                         if (cart.bookingDueDateTime &&
                             new Date(cart.bookingDueDateTime.dateTime) > new Date() &&
-                            !cart.hasIssuedTickets) {
+                            !cart.hasIssuedTickets &&
+                            !isDeadCart) {
                             this.cart = cart;
                             this.cartGuid = cart.guid;
                             this.bookingDueDateTime = cart.bookingDueDateTime; // See Booking class

package/lib/booking/tplBooking.js

@@ -141,17 +141,20 @@ var TplBooking = /** @class */ (function (_super) {
     };
     TplBooking.prototype.fetchAndSetCart = function (cartGuid, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var cart;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var cart, isDeadCart;
+            var _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0: return [4 /*yield*/, this.fetchCart(cartGuid, options)];
                     case 1:
-                        cart = _a.sent();
+                        cart = _c.sent();
                         if (!cart)
                             return [2 /*return*/];
+                        isDeadCart = cart.hasCanceledTickets === true && ((_b = (_a = cart.bookings) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0;
                         if (cart.bookingDueDateTime &&
                             new Date(cart.bookingDueDateTime.dateTime) > new Date() &&
-                            !cart.hasIssuedTickets) {
+                            !cart.hasIssuedTickets &&
+                            !isDeadCart) {
                             this.cart = cart;
                             this.cartGuid = cart.guid;
                             this.bookingDueDateTime = cart.bookingDueDateTime; // See Booking class

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

@@ -113,6 +113,14 @@ export type Cart = {
      * possible to add tickets to an issued cart. Thus, all data should be reset.
      */
     hasIssuedTickets: boolean;
+    /**
+     * True when at least one ticket attached to the cart has been canceled (e.g. all
+     * gateway transactions expired before capture and the parent service transaction
+     * also expired, auto-canceling the ticket). Combined with an empty `bookings`
+     * list this flags a dead cart that the library will drop from persisted state.
+     * Optional for forward compatibility against backends that pre-date the field.
+     */
+    hasCanceledTickets?: boolean;
     /** The booking due date as ISO string */
     bookingDueDateTime: DateWithTimeZone;
     /** The ids of the tickets in the cart */

package/package.json

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