ti2-tourplan 1.0.122 → 1.0.124

package/README.md

@@ -39,3 +39,134 @@ TL;DR Here's what the license entails:
 7. Any modifications of this code base MUST be distributed with the same license, GPLv3.
 8. This software is provided without warranty.
 9. The software author or license can not be held liable for any damages inflicted by the software.
+
+## Cancel Booking (HostConnect)
+
+This plugin cancels bookings using `CancelServicesRequest` (not `CancelBookingRequest`).
+
+### HostConnect XML Request
+
+```xml
+<Request>
+  <CancelServicesRequest>
+    <AgentID>YOUR_AGENT_ID</AgentID>
+    <Password>YOUR_AGENT_PASSWORD</Password>
+    <BookingId>14226</BookingId>
+    <ReturnBooking>Y</ReturnBooking>
+  </CancelServicesRequest>
+</Request>
+```
+
+Equivalent curl:
+
+```bash
+curl --location 'https://<HOSTCONNECT_ENDPOINT>/api/hostConnectApi' \
+--header 'Content-Type: application/xml; charset=utf-8' \
+--header 'requestId: <uuid>' \
+--header 'Accept: application/xml' \
+--data '<Request>
+  <CancelServicesRequest>
+    <AgentID>YOUR_AGENT_ID</AgentID>
+    <Password>YOUR_AGENT_PASSWORD</Password>
+    <BookingId>14226</BookingId>
+    <ReturnBooking>Y</ReturnBooking>
+  </CancelServicesRequest>
+</Request>'
+```
+
+### HostConnect XML Response (example)
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE Reply SYSTEM "hostConnect_5_05_010.dtd">
+<Reply>
+  <CancelServicesReply>
+    <BookingId>14226</BookingId>
+    <Ref>A2IN111975</Ref>
+    <ServiceStatuses>
+      <ServiceStatus>
+        <ServiceLineId>61738</ServiceLineId>
+        <Date>2026-07-03</Date>
+        <SequenceNumber>10</SequenceNumber>
+        <Status>XX</Status>
+      </ServiceStatus>
+    </ServiceStatuses>
+  </CancelServicesReply>
+</Reply>
+```
+
+### Plugin Return Shape
+
+The plugin returns both:
+
+- `cancelServicesReply`: raw parsed `CancelServicesReply` object
+- `cancellation`: normalized object
+  - `id`: from `BookingId`
+  - `status`: aggregate over all `ServiceStatus.Status` values:
+    - same status on all lines => that status (e.g. `XX`)
+    - mixed line statuses => `MIXED`
+
+## Confirm Booking (HostConnect)
+
+This plugin converts a quote to a confirmed booking using HostConnect `QuoteToBookRequest`. Inventory is allocated for each service line when the quote is confirmed; the returned `ServiceStatus` values indicate whether allocation succeeded per line.
+
+### HostConnect XML Request
+
+```xml
+<Request>
+  <QuoteToBookRequest>
+    <AgentID>YOUR_AGENT_ID</AgentID>
+    <Password>YOUR_AGENT_PASSWORD</Password>
+    <BookingId>14226</BookingId>
+  </QuoteToBookRequest>
+</Request>
+```
+
+Equivalent curl:
+
+```bash
+curl --location 'https://<HOSTCONNECT_ENDPOINT>/api/hostConnectApi' \
+--header 'Content-Type: application/xml; charset=utf-8' \
+--header 'requestId: <uuid>' \
+--header 'Accept: application/xml' \
+--data '<Request>
+  <QuoteToBookRequest>
+    <AgentID>YOUR_AGENT_ID</AgentID>
+    <Password>YOUR_AGENT_PASSWORD</Password>
+    <BookingId>14226</BookingId>
+  </QuoteToBookRequest>
+</Request>'
+```
+
+### HostConnect XML Response (example)
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE Reply SYSTEM "hostConnect_5_05_010.dtd">
+<Reply>
+  <QuoteToBookReply>
+    <BookingId>14226</BookingId>
+    <Ref>A2IN111975</Ref>
+    <ServiceStatuses>
+      <ServiceStatus>
+        <Ref>A2IN111975</Ref>
+        <ServiceLineId>61738</ServiceLineId>
+        <Date>2026-07-03</Date>
+        <SequenceNumber>10</SequenceNumber>
+        <Status>OK</Status>
+      </ServiceStatus>
+    </ServiceStatuses>
+  </QuoteToBookReply>
+</Reply>
+```
+
+### Plugin Return Shape
+
+The plugin returns both:
+
+- `confirmBookingReply`: raw parsed HostConnect `QuoteToBookReply` object
+- `booking`: normalized object
+  - `ref`: from `Ref`
+  - `id`: from `BookingId` (or the identifier sent in the request)
+  - `status`: aggregate over all `ServiceStatus.Status` values (same rules as cancel), with fallbacks to `BookingStatus`, `Status`, `payload.status`, then `'Confirmed'`
+  - `serviceLines`: array of `{ ref, serviceLineId, date, sequenceNumber, status }`

package/index.js

@@ -10,6 +10,8 @@ const Normalizer = require('./normalizer');
 
 const { searchAvailabilityForItinerary } = require('./availability/itinerary-availability');
 const { addServiceToItinerary } = require('./itinerary-add-service');
+const { cancelBooking } = require('./itinerary-cancel-booking');
+const { confirmBooking } = require('./itinerary-confirm-booking');
 const { searchProductsForItinerary } = require('./itinerary-products-search');
 const { searchItineraries } = require('./itinerary-search');
 const { hostConnectXmlOptions } = require('./utils');
@@ -679,6 +681,38 @@ class BuyerPlugin {
     });
   }
 
+  /**
+   * Cancel a booking.
+   */
+  async cancelBooking({
+    axios,
+    token,
+    payload,
+  }) {
+    return cancelBooking({
+      axios,
+      token,
+      payload,
+      callTourplan: this.callTourplan.bind(this),
+    });
+  }
+
+  /**
+   * Convert a quote to a confirmed booking.
+   */
+  async confirmBooking({
+    axios,
+    token,
+    payload,
+  }) {
+    return confirmBooking({
+      axios,
+      token,
+      payload,
+      callTourplan: this.callTourplan.bind(this),
+    });
+  }
+
   async searchItineraries({
     axios,
     typeDefsAndQueries,

package/index.test.js

@@ -132,6 +132,306 @@ describe('search tests', () => {
         }
       });
     });
+    describe('cancelBooking', () => {
+      it('cancels a booking by id', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          CancelServicesReply: {
+            BookingId: '316559',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: {
+                ServiceLineId: '61738',
+                Date: '2026-07-03',
+                SequenceNumber: '10',
+                Status: 'XX',
+              },
+            },
+          },
+        }));
+        const retVal = await app.cancelBooking({
+          axios,
+          token,
+          payload: {
+            id: '316559',
+            status: 'Cancelled',
+            clicked: 1719571452,
+          },
+        });
+        expect(mockCallTourplan).toHaveBeenNthCalledWith(1, expect.objectContaining({
+          model: {
+            CancelServicesRequest: expect.objectContaining({
+              BookingId: '316559',
+              ReturnBooking: 'Y',
+            }),
+          },
+        }));
+        expect(retVal).toEqual({
+          cancelServicesReply: {
+            BookingId: '316559',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: {
+                ServiceLineId: '61738',
+                Date: '2026-07-03',
+                SequenceNumber: '10',
+                Status: 'XX',
+              },
+            },
+          },
+          cancellation: {
+            id: '316559',
+            status: 'XX',
+          },
+        });
+      });
+
+      it('cancels a booking by ref', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          CancelServicesReply: {
+            BookingId: '316559',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Status: 'XX',
+              }],
+            },
+          },
+        }));
+        const retVal = await app.cancelBooking({
+          axios,
+          token,
+          payload: {
+            ref: 'ALFI393706',
+            status: 'Cancelled',
+            clicked: 1719571452,
+          },
+        });
+        expect(mockCallTourplan).toHaveBeenNthCalledWith(1, expect.objectContaining({
+          model: {
+            CancelServicesRequest: expect.objectContaining({
+              Ref: 'ALFI393706',
+              ReturnBooking: 'Y',
+            }),
+          },
+        }));
+        expect(retVal).toEqual({
+          cancelServicesReply: {
+            BookingId: '316559',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Status: 'XX',
+              }],
+            },
+          },
+          cancellation: {
+            id: '316559',
+            status: 'XX',
+          },
+        });
+      });
+
+      it('returns MIXED status when service statuses differ', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          CancelServicesReply: {
+            BookingId: '316559',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Status: 'XX',
+              }, {
+                ServiceLineId: '61739',
+                Status: 'RQ',
+              }],
+            },
+          },
+        }));
+        const retVal = await app.cancelBooking({
+          axios,
+          token,
+          payload: {
+            bookingId: '316559',
+            status: 'Cancelled',
+            clicked: 1719571452,
+          },
+        });
+        expect(retVal).toEqual({
+          cancelServicesReply: {
+            BookingId: '316559',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Status: 'XX',
+              }, {
+                ServiceLineId: '61739',
+                Status: 'RQ',
+              }],
+            },
+          },
+          cancellation: {
+            id: '316559',
+            status: 'MIXED',
+          },
+        });
+      });
+
+      it('requires a booking id or reference', async () => {
+        await expect(app.cancelBooking({
+          axios,
+          token,
+          payload: {},
+        })).rejects.toThrow('Must provide booking id or reference for cancellation');
+        expect(mockCallTourplan).not.toHaveBeenCalled();
+      });
+    });
+    describe('confirmBooking', () => {
+      it('converts a quote to a booking by id', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          QuoteToBookReply: {
+            BookingId: '14226',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: {
+                Ref: 'A2IN111975',
+                ServiceLineId: '61738',
+                Date: '2026-07-03',
+                SequenceNumber: '10',
+                Status: 'OK',
+              },
+            },
+          },
+        }));
+        const retVal = await app.confirmBooking({
+          axios,
+          token,
+          payload: {
+            bookingId: '14226',
+          },
+        });
+        expect(mockCallTourplan).toHaveBeenNthCalledWith(1, expect.objectContaining({
+          model: {
+            QuoteToBookRequest: expect.objectContaining({
+              BookingId: '14226',
+            }),
+          },
+        }));
+        expect(retVal).toEqual({
+          confirmBookingReply: {
+            BookingId: '14226',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: {
+                Ref: 'A2IN111975',
+                ServiceLineId: '61738',
+                Date: '2026-07-03',
+                SequenceNumber: '10',
+                Status: 'OK',
+              },
+            },
+          },
+          booking: {
+            ref: 'A2IN111975',
+            id: '14226',
+            status: 'OK',
+            serviceLines: [{
+              ref: 'A2IN111975',
+              serviceLineId: '61738',
+              date: '2026-07-03',
+              sequenceNumber: '10',
+              status: 'OK',
+            }],
+          },
+        });
+      });
+
+      it('converts a quote to a booking by ref', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          QuoteToBookReply: {
+            BookingId: '14226',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Date: '2026-07-03',
+                SequenceNumber: '10',
+                Status: 'OK',
+              }],
+            },
+          },
+        }));
+        const retVal = await app.confirmBooking({
+          axios,
+          token,
+          payload: {
+            ref: 'A2IN111975',
+          },
+        });
+        expect(mockCallTourplan).toHaveBeenNthCalledWith(1, expect.objectContaining({
+          model: {
+            QuoteToBookRequest: expect.objectContaining({
+              Ref: 'A2IN111975',
+            }),
+          },
+        }));
+        expect(retVal.booking.id).toBe('14226');
+        expect(retVal.booking.ref).toBe('A2IN111975');
+        expect(retVal.booking.status).toBe('OK');
+      });
+
+      it('returns MIXED status when service line statuses differ', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          QuoteToBookReply: {
+            BookingId: '14226',
+            Ref: 'A2IN111975',
+            ServiceStatuses: {
+              ServiceStatus: [{
+                ServiceLineId: '61738',
+                Status: 'OK',
+              }, {
+                ServiceLineId: '61739',
+                Status: 'RQ',
+              }],
+            },
+          },
+        }));
+        const retVal = await app.confirmBooking({
+          axios,
+          token,
+          payload: {
+            bookingId: '14226',
+          },
+        });
+        expect(retVal.booking.status).toBe('MIXED');
+        expect(retVal.booking.serviceLines).toHaveLength(2);
+      });
+
+      it('requires a booking id or reference', async () => {
+        await expect(app.confirmBooking({
+          axios,
+          token,
+          payload: {},
+        })).rejects.toThrow('Must provide booking id or reference for confirm booking');
+        expect(mockCallTourplan).not.toHaveBeenCalled();
+      });
+
+      it('falls back to Confirmed when no service statuses are returned', async () => {
+        mockCallTourplan.mockImplementationOnce(async () => ({
+          QuoteToBookReply: {
+            BookingId: '14226',
+            Ref: 'A2IN111975',
+          },
+        }));
+        const retVal = await app.confirmBooking({
+          axios,
+          token,
+          payload: {
+            bookingId: '14226',
+          },
+        });
+        expect(retVal.booking.status).toBe('Confirmed');
+        expect(retVal.booking.serviceLines).toEqual([]);
+      });
+    });
     describe('template tests', () => {
       let template;
       it('get the template', async () => {

package/itinerary-cancel-booking.js

@@ -0,0 +1,72 @@
+const assert = require('assert');
+const R = require('ramda');
+const {
+  hostConnectXmlOptions,
+} = require('./utils');
+const {
+  getBookingIdentifier,
+  getAggregateServiceStatus,
+} = require('./itinerary-hostconnect-helpers');
+
+const extractCancellationReply = replyObj => (
+  R.path(['CancelServicesReply'], replyObj)
+  || {}
+);
+
+const normalizeCancellationResponse = (replyObj, payload, identifier) => {
+  const cancellationReply = extractCancellationReply(replyObj);
+  const aggregateServiceStatus = getAggregateServiceStatus(cancellationReply);
+  return {
+    cancelServicesReply: cancellationReply,
+    cancellation: {
+      id: R.path(['BookingId'], cancellationReply) || identifier.value,
+      status: aggregateServiceStatus
+        || R.path(['BookingStatus'], cancellationReply)
+        || R.path(['Status'], cancellationReply)
+        || payload.status
+        || 'Cancelled',
+    },
+  };
+};
+
+/**
+ * Cancels a booking by id or reference via HostConnect CancelServicesRequest.
+ */
+const cancelBooking = async ({
+  axios,
+  token: {
+    hostConnectEndpoint,
+    hostConnectAgentID,
+    hostConnectAgentPassword,
+  },
+  payload = {},
+  callTourplan,
+}) => {
+  assert(hostConnectEndpoint, 'Must provide token.hostConnectEndpoint for booking cancellation');
+  assert(hostConnectAgentID, 'Must provide token.hostConnectAgentID for booking cancellation');
+  assert(hostConnectAgentPassword, 'Must provide token.hostConnectAgentPassword for booking cancellation');
+  const identifier = getBookingIdentifier(payload);
+  assert(identifier, 'Must provide booking id or reference for cancellation');
+
+  const baseRequest = {
+    AgentID: hostConnectAgentID,
+    Password: hostConnectAgentPassword,
+    [identifier.field]: identifier.value,
+  };
+  const replyObj = await callTourplan({
+    model: {
+      CancelServicesRequest: {
+        ...baseRequest,
+        ReturnBooking: 'Y',
+      },
+    },
+    endpoint: hostConnectEndpoint,
+    axios,
+    xmlOptions: hostConnectXmlOptions,
+  });
+  return normalizeCancellationResponse(replyObj, payload, identifier);
+};
+
+module.exports = {
+  cancelBooking,
+};

package/itinerary-confirm-booking.js

@@ -0,0 +1,72 @@
+const assert = require('assert');
+const R = require('ramda');
+const { hostConnectXmlOptions } = require('./utils');
+const {
+  getBookingIdentifier,
+  getAggregateServiceStatus,
+  mapServiceStatusLines,
+} = require('./itinerary-hostconnect-helpers');
+
+const extractConfirmBookingReply = replyObj => (
+  R.path(['QuoteToBookReply'], replyObj)
+  || {}
+);
+
+const normalizeConfirmBookingResponse = (replyObj, payload, identifier) => {
+  const confirmBookingReply = extractConfirmBookingReply(replyObj);
+  const aggregateServiceStatus = getAggregateServiceStatus(confirmBookingReply);
+  return {
+    confirmBookingReply,
+    booking: {
+      ref: R.path(['Ref'], confirmBookingReply),
+      id: R.path(['BookingId'], confirmBookingReply) || identifier.value,
+      status: aggregateServiceStatus
+        || R.path(['BookingStatus'], confirmBookingReply)
+        || R.path(['Status'], confirmBookingReply)
+        || payload.status
+        || 'Confirmed',
+      serviceLines: mapServiceStatusLines(confirmBookingReply),
+    },
+  };
+};
+
+/**
+ * Converts a quote to a confirmed booking via HostConnect QuoteToBookRequest.
+ * Inventory is allocated for each service line; returned ServiceStatus values
+ * indicate whether allocation succeeded per line.
+ */
+const confirmBooking = async ({
+  axios,
+  token: {
+    hostConnectEndpoint,
+    hostConnectAgentID,
+    hostConnectAgentPassword,
+  },
+  payload = {},
+  callTourplan,
+}) => {
+  assert(hostConnectEndpoint, 'Must provide token.hostConnectEndpoint for confirm booking');
+  assert(hostConnectAgentID, 'Must provide token.hostConnectAgentID for confirm booking');
+  assert(hostConnectAgentPassword, 'Must provide token.hostConnectAgentPassword for confirm booking');
+  const identifier = getBookingIdentifier(payload);
+  assert(identifier, 'Must provide booking id or reference for confirm booking');
+
+  const baseRequest = {
+    AgentID: hostConnectAgentID,
+    Password: hostConnectAgentPassword,
+    [identifier.field]: identifier.value,
+  };
+  const replyObj = await callTourplan({
+    model: {
+      QuoteToBookRequest: baseRequest,
+    },
+    endpoint: hostConnectEndpoint,
+    axios,
+    xmlOptions: hostConnectXmlOptions,
+  });
+  return normalizeConfirmBookingResponse(replyObj, payload, identifier);
+};
+
+module.exports = {
+  confirmBooking,
+};

package/itinerary-hostconnect-helpers.js

@@ -0,0 +1,52 @@
+const R = require('ramda');
+const { escapeInvalidXmlChars } = require('./utils');
+
+const getBookingIdentifier = payload => {
+  const bookingId = payload.bookingId || payload.id;
+  if (bookingId) {
+    return {
+      field: 'BookingId',
+      value: String(bookingId),
+    };
+  }
+  const bookingRef = payload.ref || payload.reference;
+  if (bookingRef) {
+    return {
+      field: 'Ref',
+      value: escapeInvalidXmlChars(String(bookingRef)),
+    };
+  }
+  return null;
+};
+
+const toServiceStatusArray = reply => {
+  let serviceStatuses = R.pathOr([], ['ServiceStatuses', 'ServiceStatus'], reply);
+  if (!Array.isArray(serviceStatuses)) serviceStatuses = [serviceStatuses];
+  return serviceStatuses.filter(Boolean);
+};
+
+const getAggregateServiceStatus = reply => {
+  const statuses = toServiceStatusArray(reply)
+    .map(serviceStatus => R.path(['Status'], serviceStatus))
+    .filter(Boolean)
+    .map(status => String(status).toUpperCase());
+  if (!statuses.length) return null;
+  const uniqueStatuses = [...new Set(statuses)];
+  if (uniqueStatuses.length === 1) return uniqueStatuses[0];
+  return 'MIXED';
+};
+
+const mapServiceStatusLines = reply => toServiceStatusArray(reply).map(serviceStatus => ({
+  ref: R.path(['Ref'], serviceStatus),
+  serviceLineId: R.path(['ServiceLineId'], serviceStatus),
+  date: R.path(['Date'], serviceStatus),
+  sequenceNumber: R.path(['SequenceNumber'], serviceStatus),
+  status: R.path(['Status'], serviceStatus),
+}));
+
+module.exports = {
+  getBookingIdentifier,
+  toServiceStatusArray,
+  getAggregateServiceStatus,
+  mapServiceStatusLines,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2-tourplan",
-  "version": "1.0.122",
+  "version": "1.0.124",
   "description": "Tourplan's TI2 Plugin",
   "main": "index.js",
   "scripts": {
@@ -39,7 +39,7 @@
     "jsonwebtoken": "^8.5.1",
     "moment": "^2.29.1",
     "ramda": "^0.27.1",
-    "ti2": "^1.0.111",
+    "ti2": "^1.0.118",
     "underscore": "^1.13.4",
     "xml-js": "^1.6.11",
     "xml2js": "^0.4.23"