@curless/hotel-storefront 0.23.2 → 0.24.1

package/dist/tools.js

@@ -1,4 +1,4 @@
-import { DEFAULT_PAGE, LASTING_REQUESTS, MAX_PAGE, REQUEST_KINDS, REQUEST_NOTE_MAX, } from './backend.js';
+import { DEFAULT_PAGE, FULL_CAPABILITIES, LASTING_REQUESTS, MAX_PAGE, REQUEST_KINDS, REQUEST_NOTE_MAX, } from './backend.js';
 import { isDay, nights as nightsBetween } from './dates.js';
 import { FACILITIES } from './facilities.js';
 import { DESCRIPTION_MAX, POLICY_MAX, hotelText } from './fence.js';
@@ -63,7 +63,69 @@ const cancels = (title, openWorld) => ({
 const DATE = (what) => ({ type: 'string', description: `${what}, as YYYY-MM-DD` });
 /** How many ${nounPlural} one look-up reads - a city's worth, and what a comparison can hold and then some. */
 export const LOOK_UP_MAX = 6;
-export const buildTools = (n, v) => {
+/**
+ * The tools this deployment offers: every tool, less the ones its backend
+ * cannot do, and with the descriptions of the rest saying only what is true
+ * of it - see `BackendCapabilities`.
+ */
+export const buildTools = (n, v, caps = FULL_CAPABILITIES) => forCapabilities(allTools(n, v), n, v, caps);
+/** The tool names a backend with these capabilities leaves out. */
+export const withheldTools = (n, caps) => new Set([
+    ...(caps.members ? [] : [n.signIn, n.signOut, n.forgetPreferences]),
+    ...(caps.extras ? [] : [n.listExtras]),
+    ...(caps.changes || caps.extras ? [] : [n.previewChange, n.changeBooking]),
+]);
+const forCapabilities = (tools, n, v, caps) => {
+    const withheld = withheldTools(n, caps);
+    const without = (schema, ...keys) => {
+        const s = schema;
+        const properties = { ...(s.properties ?? {}) };
+        for (const k of keys)
+            delete properties[k];
+        return { ...s, properties };
+    };
+    return tools
+        .filter((t) => !withheld.has(t.name))
+        .map((t) => {
+        let out = t;
+        if (!caps.extras) {
+            if (t.name === n.addToTrip) {
+                out = {
+                    ...out,
+                    description: `Puts room nights into the trip and returns the whole trip, priced. A room line needs the ${v.noun}, the room type and the dates; \`rooms\` books more than one of that room type. A line is replaced, not stacked: sending the same room and dates again sets that line's room count, and 0 removes it.`,
+                    inputSchema: without(out.inputSchema, 'extra', 'quantity'),
+                };
+            }
+            if (t.name === n.viewTrip) {
+                out = {
+                    ...out,
+                    description: 'The trip as it stands: every room line with its own total, the taxes and fees, and the all-in total, laid out day by day on the card.',
+                };
+            }
+            if (t.name === n.lookUp) {
+                out = {
+                    ...out,
+                    description: out.description.replace(', its add-ons with their ids and prices', ''),
+                };
+            }
+            if (t.name === n.itinerary) {
+                out = JSON.parse(JSON.stringify(out).replaceAll(' and add-ons', ''));
+            }
+        }
+        if (t.name === n.requestBooking) {
+            if (!caps.members)
+                out = { ...out, inputSchema: without(out.inputSchema, 'rememberRequests') };
+            if (caps.booking === 'pay-at-hotel') {
+                out = {
+                    ...out,
+                    description: `Books the trip's rooms with ${v.brand} for a named guest: each stay becomes the hotel's own reservation, with its own confirmation code, paid at the hotel. No payment is taken here and no card is collected. All of the trip is booked or none of it. Preferences - a bed type, a floor, a late arrival - ride along on the booking as requests the desk tries to meet.`,
+                };
+            }
+        }
+        return out;
+    });
+};
+const allTools = (n, v) => {
     const open = !v.demo;
     const stayProps = {
         checkIn: DATE('The arrival date'),
@@ -578,6 +640,7 @@ const TRIP_SCHEMA = {
         view: { enum: ['trip', 'needs-dates', 'error'] },
         brand: STR,
         toolNames: OBJ,
+        bookingMode: STR,
         vocab: OBJ,
         demo: BOOL,
         demoNote: STR,
@@ -601,6 +664,7 @@ const CANCEL_SCHEMA = {
         view: { enum: ['cancellation-preview', 'cancelled', 'booking-not-found'] },
         brand: STR,
         toolNames: OBJ,
+        bookingMode: STR,
         demo: BOOL,
         demoNote: STR,
         booking: OBJ,
@@ -619,6 +683,7 @@ const CHANGE_SCHEMA = {
         view: { enum: ['change-preview', 'changed', 'booking-not-found'] },
         brand: STR,
         toolNames: OBJ,
+        bookingMode: STR,
         demo: BOOL,
         demoNote: STR,
         booking: OBJ,
@@ -641,6 +706,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['hotels', 'no-hotels', 'destinations'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             vocab: OBJ,
             demo: BOOL,
             demoNote: STR,
@@ -669,6 +735,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['hotel', 'no-rooms', 'hotel-not-found'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             vocab: OBJ,
             demo: BOOL,
             demoNote: STR,
@@ -693,6 +760,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['extras', 'hotel-not-found'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             hotel: OBJ,
@@ -709,6 +777,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['booking', 'needs-guest', 'empty-trip', 'error'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             booking: OBJ,
@@ -729,6 +798,7 @@ export const buildOutputSchemas = (n) => ({
             view: { const: 'bookings' },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             bookings: ARR,
@@ -746,6 +816,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['comparison', 'nothing-to-compare'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             title: STR,
@@ -764,6 +835,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['itinerary', 'empty-itinerary'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             title: STR,
@@ -782,6 +854,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['member', 'member-not-found'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             demoNote: STR,
             member: OBJ,
@@ -799,6 +872,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['member', 'no-member'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             member: OBJ,
         },
         required: ['view'],
@@ -811,6 +885,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['look-up', 'nothing-found'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             hotels: ARR,
             stay: OBJ,
@@ -825,6 +900,7 @@ export const buildOutputSchemas = (n) => ({
             view: { enum: ['policy', 'policies', 'policy-missing', 'hotel-not-found'] },
             brand: STR,
             toolNames: OBJ,
+            bookingMode: STR,
             demo: BOOL,
             hotel: OBJ,
             topic: STR,
@@ -872,10 +948,32 @@ const memberBadge = (deps, key) => {
         }
         : { signedIn: false };
 };
+/**
+ * What was made, in one sentence - which depends on what asking MAKES here.
+ *
+ * ⚠️ HELD IS NOT BOOKED, AND BOOKED IS NOT PAID. The demonstration holds rooms
+ * until a moment and then lets them go; a group's own system makes its own
+ * reservation, kept until cancelled and paid at the hotel. Saying "held until"
+ * of a reservation invents a deadline, and saying "booked" of a hold invents a
+ * room - and a booking whose confirmation has not come back yet is neither,
+ * and is said as exactly that.
+ */
+const bookedLine = (deps, b) => {
+    const total = formatMoney(b.quote.total);
+    if ((deps.backend.capabilities ?? FULL_CAPABILITIES).booking === 'pay-at-hotel') {
+        return b.status === 'requested'
+            ? `${total} all in, to be paid at the hotel. ${deps.vocab.brand} has not confirmed this booking yet - that takes up to eight minutes, and ${deps.tools.listBookings} shows when it has. Nothing has been charged.`
+            : `${total} all in, paid at the hotel. **Nothing has been charged here** - this is ${deps.vocab.brand}'s own reservation, kept until it is cancelled, and ${b.guest.name} pays at check-in.`;
+    }
+    return `${total} all in. **Nothing has been charged** - the rooms are held until ${b.holdUntil?.slice(0, 16).replace('T', ' ')} UTC, and ${b.guest.name} presents a card at check-in.`;
+};
 const common = (deps, key) => ({
     brand: deps.vocab.brand,
     ...(deps.logoUrl ? { logoUrl: deps.logoUrl } : {}),
-    toolNames: deps.tools,
+    toolNames: deps.offered
+        ? Object.fromEntries(Object.entries(deps.tools).filter(([, name]) => deps.offered?.has(name)))
+        : deps.tools,
+    bookingMode: (deps.backend.capabilities ?? FULL_CAPABILITIES).booking,
     vocab: { noun: deps.vocab.noun, nounPlural: deps.vocab.nounPlural },
     ...(deps.vocab.demo ? { demo: true, demoNote: DEMO_NOTE } : { demo: false }),
     ...(key ? memberBadge(deps, key) : {}),
@@ -1882,8 +1980,14 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
         // which narrowing would make the question answerable.
         const oneCurrency = answer.currencies.length === 1;
         const wantedPrice = sort === 'price-low' || sort === 'price-high';
-        const applied = wantedPrice && !oneCurrency ? 'group' : sort;
+        const applied = (wantedPrice && !oneCurrency) || answer.ignored?.sort ? 'group' : sort;
+        // Room terms the backend could not apply are not "filtered to".
+        const filtersSaid = asked.filters && answer.ignored?.roomTerms
+            ? { ...asked.filters, freeCancellation: undefined, breakfast: undefined }
+            : asked.filters;
         const priceNotes = [
+            // What the backend was asked and did not do, in its own words.
+            ...(answer.unapplied ?? []),
             wantedPrice && !oneCurrency
                 ? `These are quoted in ${answer.currencies.length} currencies (${answer.currencies.join(', ')}), and no rate is applied here, so they are not in price order — one city or one country gives one currency.`
                 : '',
@@ -1893,7 +1997,7 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
             answer.overBudget && hotels.length
                 ? `${answer.overBudget} more matched and came in over the ceiling.`
                 : '',
-            asked.filters ? `Filtered to ${filterWords(asked.filters)}.` : '',
+            filtersSaid && filterWords(filtersSaid) ? `Filtered to ${filterWords(filtersSaid)}.` : '',
             // What the prices on a dated list are, in one line - and how many cannot
             // be had at all, so a sold-out hotel is not described as a choice.
             ask.stay
@@ -2054,7 +2158,7 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
             },
             text: [
                 `**${h.name}** · ${enough.length} room ${enough.length === 1 ? 'type' : 'types'} for ${stay.checkIn} to ${stay.checkOut}, ${stay.guests} guests${roomsWanted > 1 ? `, ${roomsWanted} rooms` : ''}.`,
-                ...enough.map((r) => `- ${r.name} — ${formatMoney(r.nightly)} a night, ${formatMoney(r.stayTotal)} for the stay incl. taxes and fees${roomsWanted > 1 ? ` (${formatMoney(multiplyMoney(r.stayTotal, roomsWanted))} for ${roomsWanted} rooms)` : ''}${r.freeCancellationUntil ? `, free to cancel until ${r.freeCancellationUntil.slice(0, 10)}` : r.refundable ? ', the free cancellation window has closed - cancelling costs a night' : ', non-refundable'}`),
+                ...enough.map((r) => `- ${r.name} — ${formatMoney(r.nightly)} a night, ${formatMoney(r.stayTotal)} for the stay incl. taxes and fees${roomsWanted > 1 ? ` (${formatMoney(multiplyMoney(r.stayTotal, roomsWanted))} for ${roomsWanted} rooms)` : ''}${r.freeCancellationUntil ? `, free to cancel until ${r.freeCancellationUntil.slice(0, 10)}` : r.refundable ? ', the free cancellation window has closed - cancelling now has a fee' : ', non-refundable'}`),
                 flex.text,
                 deps.vocab.demo ? DEMO_NOTE : '',
             ]
@@ -2270,7 +2374,9 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
                         error: 'no-such-extra',
                         query: extraRef,
                     },
-                    text: `${detail.hotel.name} does not offer that. ${t.listExtras} lists what it has.`,
+                    text: (deps.backend.capabilities ?? FULL_CAPABILITIES).extras
+                        ? `${detail.hotel.name} does not offer that. ${t.listExtras} lists what it has.`
+                        : `${deps.vocab.brand} ${deps.vocab.nounPlural} sell rooms only here - there are no add-ons.`,
                 };
             }
             const line = {
@@ -2469,11 +2575,11 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
                 },
                 text: [
                     several
-                        ? `${booked.length} bookings, one for each stay - each hotel holds its own nights under its own code, and each is changed or cancelled on its own.`
+                        ? `${booked.length} bookings, one for each stay - each hotel keeps its own nights under its own code, and each is ${(deps.backend.capabilities ?? FULL_CAPABILITIES).changes ? 'changed or cancelled' : 'cancelled'} on its own.`
                         : '',
                     ...booked.flatMap(({ booking, asked }) => [
                         `**${booking.confirmationCode}** · ${booking.hotelName} · ${booking.stay.checkIn} to ${booking.stay.checkOut}`,
-                        `${formatMoney(booking.quote.total)} all in. **Nothing has been charged** - the rooms are held until ${booking.holdUntil?.slice(0, 16).replace('T', ' ')} UTC, and ${booking.guest.name} presents a card at check-in.`,
+                        bookedLine(deps, booking),
                         ...asked,
                     ]),
                     remembered?.line ?? '',
@@ -2737,18 +2843,23 @@ const answerTool = async (deps, name, rawArgs, ctx) => {
         const cancelled = await deps.backend.cancelBooking(ref, who, str(args.reason) || undefined);
         if (!cancelled)
             return asPreview;
+        // ⚠️ WHAT THE HOTEL SAYS IT CHARGED, once it has said. A group's own system
+        // answers a cancellation with its penalty; the preview was our reading of
+        // the rate's terms, and where the two differ the hotel's is the one that
+        // will be charged.
+        const charged = cancelled.cancellationFee ?? preview.fee;
         return {
             structured: {
                 view: 'cancelled',
                 ...common(deps, key),
                 booking: { ...cancelled, quote: quoteForCard(cancelled.quote) },
-                fee: formatMoney(preview.fee),
+                fee: formatMoney(charged),
                 refund: formatMoney(preview.refund),
                 rule: preview.rule,
                 cancellable: false,
             },
             text: [
-                `${cancelled.confirmationCode} is cancelled. ${preview.fee.minor === 0 ? 'No fee.' : `The hotel charges ${formatMoney(preview.fee)}.`}`,
+                `${cancelled.confirmationCode} is cancelled. ${charged.minor === 0 ? 'No fee.' : `The hotel charges ${formatMoney(charged)}.`}`,
                 deps.vocab.demo ? DEMO_NOTE : '',
             ]
                 .filter(Boolean)