@v-office/website-chat 1.2.0 → 1.3.0

package/README.md

@@ -28,6 +28,7 @@ Render `WebsiteChat` once in the layout as a client island; see `instructions/ve
 | `locale`      | yes      | `"de"` or `"en"`                                                         |
 | `searchPath`  | yes      | the site's search, for a rental without a page and when the chat is down |
 | `contactPath` | yes      | the site's contact page                                                  |
+| `privacyPath` | no       | the site's privacy policy, linked at the step that starts the chat       |
 | `theme`       | no       | `classic` (default), `soft` or `minimal`: shadows or borders, how round  |
 | `colors`      | no       | `{ primary, secondary, accent }`, any CSS colour, over the site's tokens |
 | `position`    | no       | the entry pill and the panel on the `right` (default) or `left`          |

package/dist/{catalog-ClcCUjf7.js → catalog-Buxzskkg.js}

@@ -31,8 +31,11 @@ const chatCatalog = defineCatalog(schema, {
 			description: "Several rentals side by side, swipeable, each as a RentalCard: search results, instead of several RentalCards. After a flexible search, each rental with its first period as its stayId."
 		},
 		StayQuote: {
-			props: z.object({ stayId: id }),
-			description: "One priced stay: the rental, the dates, the party, the total and a booking button. Show it whenever the visitor asks what one stay costs, with the stayId from quote_stay."
+			props: z.object({
+				stayId: id,
+				handover: z.boolean().optional()
+			}),
+			description: "One priced stay: the rental, the dates, the party, the total and a booking button. Show it whenever the visitor asks what one stay costs, with the stayId from quote_stay or configure_stay. When the visitor decides on a stay ('we'll take it', 'how do we book'), show it again with handover true: it carries the booking button, so the reply need not say where the button is."
 		},
 		PriceBreakdown: {
 			props: z.object({ stayId: id }),
@@ -50,7 +53,7 @@ const chatCatalog = defineCatalog(schema, {
 				rentalId: id,
 				stayId: id.nullable()
 			}),
-			description: "A rental's month calendar of free and taken days, with a stay's dates marked when there is one. Show it whenever the visitor asks when a rental is free, after get_availability. Read-only: the visitor cannot pick days in it."
+			description: "A rental's month calendar of free and taken days, with a stay's dates marked when there is one. Show it whenever the visitor asks when a rental is free, after get_availability."
 		},
 		PriceCalendar: {
 			props: z.object({ rentalId: id }),
@@ -145,6 +148,9 @@ const isAtLeast = (clientVersion, since) => {
 	if (!client || from[0] !== client[0]) return false;
 	return from[1] < client[1] || from[1] === client[1] && from[2] <= client[2];
 };
+/** Whether a widget of `clientVersion` is `since` or newer within the same major, for the service's own
+*  version gates (what it retires, which words it uses); an unreadable version is neither. */
+const versionAtLeast = isAtLeast;
 /** See {@link ComponentsFor}. */
 const componentsFor = (clientVersion) => PLACEABLE_COMPONENTS.filter((name) => isAtLeast(clientVersion, COMPONENT_SINCE[name]));
 /** Whether the widget shows the assistant's `**bold**` as bold text (1.1.0 and later); an older
@@ -187,4 +193,4 @@ const chatSpec = (items, state) => {
 	};
 };
 //#endregion
-export { componentsFor as a, rendersBold as c, chatSpec as i, stateKey as l, PLACEABLE_COMPONENTS as n, handsOverStays as o, chatCatalog as r, parseItem as s, COMPONENT_SINCE as t, statePath as u };
+export { componentsFor as a, rendersBold as c, statePath as d, chatSpec as i, versionAtLeast as l, PLACEABLE_COMPONENTS as n, handsOverStays as o, chatCatalog as r, parseItem as s, COMPONENT_SINCE as t, stateKey as u };

package/dist/catalog.d.ts

@@ -1,4 +1,4 @@
-import { a as ChatLocale, c as MAX_MESSAGE_CHARS, i as ChatEvent, l as SESSION_TTL_S, n as CHAT_PATH, o as ChatRequest, r as ChatAvailability, s as ChatUnavailableReason, t as CHAT_LOCALES } from "./protocol-Bmb_uxVQ.js";
+import { a as ChatLocale, c as ChatUnavailableReason, i as ChatEvent, l as MAX_MESSAGE_CHARS, n as CHAT_PATH, o as ChatRequest, r as ChatAvailability, s as ChatStatusStep, t as CHAT_LOCALES, u as SESSION_TTL_S } from "./protocol-Dg1HZNWG.js";
 import { Spec } from "@json-render/core";
 import { z } from "zod";
 import { Party } from "@v-office/website-headless";
@@ -8,6 +8,9 @@ interface ChatImage {
   readonly src: string;
   /** The PMS's description; empty when it has none. */
   readonly alt: string;
+  /** The PMS's `srcset`, so the browser loads the size the screen needs; only on a card's first
+   *  photos (1.3.0). */
+  readonly srcset?: string;
 }
 /** A rental as the chat shows it: facts from the PMS, never from the model. */
 interface ChatRental {
@@ -32,6 +35,23 @@ interface ChatRental {
     readonly lng: number;
   } | null;
 }
+/** The discount the PMS applied to a stay's total (1.3.0). */
+interface ChatDiscount {
+  /** The PMS's names of the applied discounts ("Frühbucher"); empty when it names none (v9). */
+  readonly labels: readonly string[];
+  /** What the visitor saves, as the PMS formats money ("112,30 €"); `null` when it is not one known
+   *  amount. */
+  readonly saving: string | null;
+}
+/** What cancelling a stay costs under the rate the quote priced, from the PMS's policy (1.3.0):
+ *  free until a day, or nothing refunded any more. */
+type ChatCancellation = {
+  readonly kind: "free";
+  /** `YYYY-MM-DD`, the last day with a full refund. */
+  readonly until: string;
+} | {
+  readonly kind: "none";
+};
 /** A stay of one rental for one party, priced by the PMS. */
 interface ChatStay {
   readonly id: string;
@@ -59,7 +79,20 @@ interface ChatStay {
   readonly services?: readonly {
     readonly id: string;
     readonly count: number;
+    /** The extra's name as the PMS gives it (1.3.0). */
+    readonly label?: string;
   }[];
+  /** The discount in the total; absent or `null` without one (1.3.0). */
+  readonly discount?: ChatDiscount | null;
+  /** The cancellation terms of the quoted rate; absent or `null` when the PMS states none (a search
+   *  result, v9) (1.3.0). */
+  readonly cancellation?: ChatCancellation | null;
+  /** The rate's own name where the agency named it ("Flexibler Tarif"); absent for the PMS's built-in
+   *  rates (1.3.0). */
+  readonly rateName?: string | null;
+  /** A stay the PMS refused: the departures it allows from the same arrival, `YYYY-MM-DD`, ascending,
+   *  at most four; absent when not asked (1.3.0). */
+  readonly departures?: readonly string[];
 }
 /** A day of a rental's calendar: bookable, taken, or outside what can be booked (past, closed). */
 type ChatDayStatus = "free" | "booked" | "closed";
@@ -71,6 +104,11 @@ interface ChatCalendar {
   readonly through: string;
   /** Every day from `from` through `through`. */
   readonly days: Readonly<Record<string, ChatDayStatus>>;
+  /** The free days a stay can start on, `YYYY-MM-DD`; absent when not known (1.3.0). */
+  readonly arrivals?: readonly string[];
+  /** A free day's night-price level among the calendar's priced days, 1 (cheaper) to 3, never an
+   *  amount; absent for a day without a price, and altogether without prices (1.3.0). */
+  readonly levels?: Readonly<Record<string, 1 | 2 | 3>>;
 }
 /** One stay length's totals for the arrivals around the asked one, as the PMS priced them. */
 interface ChatPriceCalendar {
@@ -112,6 +150,36 @@ interface ChatFactGroup {
   readonly label: string;
   readonly items: readonly string[];
 }
+/** What the latest search searched with, for the widget to show what the chat is working from
+ *  (1.3.0). */
+interface ChatTrip {
+  readonly party: Party;
+  /** The search assumed the party (two adults): the visitor named none. */
+  readonly partyAssumed: boolean;
+  /** Fixed dates, months (with a length of stay or weekends), or explicit windows; `null` without
+   *  any. */
+  readonly period: {
+    readonly kind: "dates";
+    readonly start: string;
+    readonly end: string;
+  } | {
+    readonly kind: "months";
+    /** `YYYY-MM`. */
+    readonly months: readonly string[];
+    readonly nights: number | null;
+    readonly weekend: boolean;
+  } | {
+    readonly kind: "windows";
+    /** `YYYY-MM-DD` each. */
+    readonly windows: readonly {
+      readonly from: string;
+      readonly to: string;
+    }[];
+    readonly nights: number;
+  } | null;
+  /** The visitor's wishes the search applied, as the PMS labels its filters. */
+  readonly wishes: readonly string[];
+}
 /** The state of one spec: everything its components read, keyed by the raw id. */
 interface ChatState {
   readonly rentals: Readonly<Record<string, ChatRental>>;
@@ -133,6 +201,11 @@ interface ChatState {
    *  erlaubt"), as the PMS labels its filters, by rental id: the rental has each. With dates or
    *  without; absent when that search applied none. */
   readonly wishes: Readonly<Record<string, readonly string[]>>;
+  /** What the latest search searched with; absent or `null` before any (1.3.0). */
+  readonly trip?: ChatTrip | null;
+  /** A flexible search's free periods of a rental, as ids of stays in `stays` (at most four, the
+   *  card's own among them), by rental id; absent without a flexible search (1.3.0). */
+  readonly periods?: Readonly<Record<string, readonly string[]>>;
 }
 /** An id as one JSON Pointer token (RFC 6901): a v10 rental id may contain `/` or `~`, which would
  *  otherwise change the path a component reads. State stays keyed by the raw id; only paths escape it. */
@@ -208,6 +281,7 @@ export declare const chatCatalog: import("@json-render/core").Catalog<{
     StayQuote: {
       props: z.ZodObject<{
         stayId: z.ZodString;
+        handover: z.ZodOptional<z.ZodBoolean>;
       }, z.core.$strip>;
       description: string;
     };
@@ -305,6 +379,12 @@ type ComponentsFor = (clientVersion: string) => PlaceableComponent[];
 type ParseItem = (item: unknown, allowed: readonly PlaceableComponent[]) => ChatItem | null;
 /** The spec of one reply: the items stacked under the service's root, and the state they read. */
 type ChatSpec = (items: readonly ChatItem[], state: ChatState) => Spec;
+/** Whether a widget of `clientVersion` is `since` or newer within the same major; an unreadable
+ *  version is neither. */
+declare const isAtLeast: (clientVersion: string, since: string) => boolean;
+/** Whether a widget of `clientVersion` is `since` or newer within the same major, for the service's own
+ *  version gates (what it retires, which words it uses); an unreadable version is neither. */
+export declare const versionAtLeast: typeof isAtLeast;
 /** See {@link ComponentsFor}. */
 export declare const componentsFor: ComponentsFor;
 /** Whether the widget shows the assistant's `**bold**` as bold text (1.1.0 and later); an older
@@ -319,4 +399,4 @@ export declare const parseItem: ParseItem;
 /** See {@link ChatSpec}. */
 export declare const chatSpec: ChatSpec;
 //#endregion
-export { CHAT_LOCALES, CHAT_PATH, type ChatAvailability, type ChatCalendar, type ChatDayStatus, type ChatEvent, type ChatFactGroup, type ChatImage, type ChatLocale, type ChatPriceCalendar, type ChatRental, type ChatRequest, type ChatReviews, type ChatState, type ChatStay, type ChatUnavailableReason, MAX_MESSAGE_CHARS, SESSION_TTL_S };
+export { CHAT_LOCALES, CHAT_PATH, type ChatAvailability, type ChatCalendar, type ChatCancellation, type ChatDayStatus, type ChatDiscount, type ChatEvent, type ChatFactGroup, type ChatImage, type ChatLocale, type ChatPriceCalendar, type ChatRental, type ChatRequest, type ChatReviews, type ChatState, type ChatStatusStep, type ChatStay, type ChatTrip, type ChatUnavailableReason, MAX_MESSAGE_CHARS, SESSION_TTL_S };

package/dist/catalog.js

@@ -1,3 +1,3 @@
 import { i as SESSION_TTL_S, n as CHAT_PATH, r as MAX_MESSAGE_CHARS, t as CHAT_LOCALES } from "./protocol-BuNqZAMt.js";
-import { a as componentsFor, c as rendersBold, i as chatSpec, l as stateKey, n as PLACEABLE_COMPONENTS, o as handsOverStays, r as chatCatalog, s as parseItem, t as COMPONENT_SINCE, u as statePath } from "./catalog-ClcCUjf7.js";
-export { CHAT_LOCALES, CHAT_PATH, COMPONENT_SINCE, MAX_MESSAGE_CHARS, PLACEABLE_COMPONENTS, SESSION_TTL_S, chatCatalog, chatSpec, componentsFor, handsOverStays, parseItem, rendersBold, stateKey, statePath };
+import { a as componentsFor, c as rendersBold, d as statePath, i as chatSpec, l as versionAtLeast, n as PLACEABLE_COMPONENTS, o as handsOverStays, r as chatCatalog, s as parseItem, t as COMPONENT_SINCE, u as stateKey } from "./catalog-Buxzskkg.js";
+export { CHAT_LOCALES, CHAT_PATH, COMPONENT_SINCE, MAX_MESSAGE_CHARS, PLACEABLE_COMPONENTS, SESSION_TTL_S, chatCatalog, chatSpec, componentsFor, handsOverStays, parseItem, rendersBold, stateKey, statePath, versionAtLeast };

package/dist/{icons-BK5Lk0cP.js → icons-B0_KM_uQ.js}

@@ -92,6 +92,8 @@ const loadConversation = (endpoint, now = Date.now()) => {
 		return {
 			sessionId: stored.sessionId ?? null,
 			messages: stored.messages,
+			...stored.selected && { selected: stored.selected },
+			...stored.picked && { picked: stored.picked },
 			savedAt: stored.savedAt
 		};
 	} catch {
@@ -146,6 +148,20 @@ const Check = () => /* @__PURE__ */ jsx(Svg, {
 	size: 14,
 	children: /* @__PURE__ */ jsx("path", { d: "M5 12.5l4.5 4.5L19 7.5" })
 });
+/** A discount. */
+const Tag = () => /* @__PURE__ */ jsx(Svg, { children: /* @__PURE__ */ jsx("path", { d: "M3 12V4h8l10 10-8 8zM7.5 8.5h.01" }) });
+/** Free cancellation. */
+const CircleCheck = () => /* @__PURE__ */ jsxs(Svg, { children: [/* @__PURE__ */ jsx("circle", {
+	cx: "12",
+	cy: "12",
+	r: "9"
+}), /* @__PURE__ */ jsx("path", { d: "M8 12.5l2.5 2.5L16 9.5" })] });
+/** Terms without a refund: a fact, not a warning. */
+const CircleInfo = () => /* @__PURE__ */ jsxs(Svg, { children: [/* @__PURE__ */ jsx("circle", {
+	cx: "12",
+	cy: "12",
+	r: "9"
+}), /* @__PURE__ */ jsx("path", { d: "M12 11v5M12 8h.01" })] });
 /** In a photo's place on a card without photos. */
 const House = () => /* @__PURE__ */ jsx(Svg, {
 	size: 32,
@@ -240,4 +256,4 @@ const TopicIcon = ({ text }) => {
 	return /* @__PURE__ */ jsx(Svg, { children: TOPIC_PATHS[topic] });
 };
 //#endregion
-export { House as a, TopicIcon as c, saveConversation as d, chatAvailable as f, Cross as i, clearConversation as l, Check as n, Restart as o, sendMessage as p, Chevron as r, Spark as s, Arrow as t, loadConversation as u };
+export { CircleInfo as a, Restart as c, TopicIcon as d, clearConversation as f, sendMessage as g, chatAvailable as h, CircleCheck as i, Spark as l, saveConversation as m, Check as n, Cross as o, loadConversation as p, Chevron as r, House as s, Arrow as t, Tag as u };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as ChatLocale, t as CHAT_LOCALES } from "./protocol-Bmb_uxVQ.js";
+import { a as ChatLocale, s as ChatStatusStep, t as CHAT_LOCALES } from "./protocol-Dg1HZNWG.js";
 //#region src/copy.d.ts
 interface ChatCopy {
   /** The entry pill's invitation, under the title; on wide screens the pill's field says it. */
@@ -9,8 +9,15 @@ interface ChatCopy {
   /** The chat's name: over the entry pill and in the panel's head. */
   readonly title: string;
   readonly newConversation: string;
-  /** The AI notice under the title (AI Act transparency); have its wording checked for the site. */
+  /** The AI notice under the title (AI Act transparency); have its wording checked for the site. Shown
+   *  in full before the first message, then behind the ⓘ beside `noticeShort`. */
   readonly notice: string;
+  /** The mark beside the title that the chat is an AI, always shown. */
+  readonly aiBadge: string;
+  /** The notice's one line under the title once the conversation runs. */
+  readonly noticeShort: string;
+  /** The ⓘ button's name, which opens the full `notice`. */
+  readonly noticeMore: string;
   /** Shown before the first message. */
   readonly greeting: string;
   /** Tappable first messages, before the visitor wrote anything. */
@@ -19,6 +26,33 @@ interface ChatCopy {
   readonly send: string;
   /** Read out while a reply is on its way. */
   readonly thinking: string;
+  /** What the chat is doing while the visitor waits, by the service's step; `thinking` for any other. */
+  readonly status: Readonly<Record<ChatStatusStep, string>>;
+  /** Sends a message again that the chat could not answer (busy, failed). */
+  readonly retry: string;
+  /** The link to the site's privacy policy at the start step, where the site passes `privacyPath`. */
+  readonly privacyLink: string;
+  /** The bar over the input, for a screen reader: the stay in reach, or what the chat searched with. */
+  readonly yourPick: string;
+  readonly yourTrip: string;
+  /** Beside a party the search assumed because the visitor named none. */
+  readonly assumed: string;
+  /** People in a party, short: `{n}` is the count. */
+  readonly guests: Readonly<Partial<Record<Intl.LDMLPluralRule, string>>> & {
+    readonly other: string;
+  };
+  readonly adultsShort: Readonly<Partial<Record<Intl.LDMLPluralRule, string>>> & {
+    readonly other: string;
+  };
+  /** A search for weekends. */
+  readonly weekend: string;
+  /** What a tap on a part of the trip puts into the input, for the visitor to finish. */
+  readonly tripStarters: {
+    readonly party: string;
+    readonly period: string;
+    readonly nights: string;
+    readonly wishes: string;
+  };
   /** Over the message typed into the entry pill, at the start step that sends it. */
   readonly yourMessage: string;
   /** The consent step: what turning the chat on means. */
@@ -30,7 +64,7 @@ interface ChatCopy {
   readonly contactLink: string;
   readonly bookStay: string;
   readonly viewRental: string;
-  /** A card's short button: book its stay, or see the rental without one. */
+  /** A card's and a quote's short button: book its stay, or see the rental without one. */
   readonly book: string;
   readonly view: string;
   /** @deprecated Not shown since 1.1.1: a card lists the wishes it matches instead. Kept so a site's
@@ -41,8 +75,32 @@ interface ChatCopy {
     readonly other: string;
   };
   readonly total: string;
+  /** Over a stay's total, what it covers; `{n}` is the nights. */
+  readonly totalForNights: Readonly<Partial<Record<Intl.LDMLPluralRule, string>>> & {
+    readonly other: string;
+  };
+  /** The disclosure with a quote's price lines. */
+  readonly priceDetails: string;
+  /** A discount the PMS applied without naming it. */
+  readonly dealFallback: string;
+  /** After a discount's name; `{amount}` is the saving as the PMS formats it. */
+  readonly youSave: string;
+  /** `{date}` is the last day with a full refund. */
+  readonly freeCancellation: string;
+  readonly nonRefundable: string;
+  /** Over the first and the last day in a hand-over card. */
+  readonly arrival: string;
+  readonly departure: string;
+  /** The hand-over card's button to the booking page. */
+  readonly continueToBooking: string;
+  /** Under that button: nothing is booked in the chat, and what the booking page asks next. */
+  readonly nothingBookedYet: string;
+  readonly handoverSteps: readonly string[];
   readonly notBookable: string;
   readonly photo: string;
+  /** A card's photo button, which opens the photos large; `{name}` is the rental's. */
+  readonly openPhotos: string;
+  readonly closePhotos: string;
   readonly previous: string;
   readonly next: string;
   /** A carousel of found rentals, for a screen reader. */
@@ -58,6 +116,30 @@ interface ChatCopy {
   /** A day that is neither free nor taken: past, beyond the bookable range, or no arrival. */
   readonly closed: string;
   readonly yourStay: string;
+  /** A calendar day a stay can start on. */
+  readonly arrivalPossible: string;
+  /** The ends of the calendar's price levels, never an amount. */
+  readonly cheaper: string;
+  readonly dearer: string;
+  /** Asks for a stay's price: a tapped arrival, a stay length the booking system allows. */
+  readonly showPrice: string;
+  /** A tapped arrival, and the message that asks for its price; `{date}` is the day. */
+  readonly arrivalOn: string;
+  /** Over the stays a refused one could be instead; `{date}` is its arrival. */
+  readonly possibleFrom: string;
+  /** Under a stay length: its last day; `{date}` is the departure. */
+  readonly until: string;
+  /** Puts `otherArrivalStarter` into the input, for the visitor to name another arrival. */
+  readonly otherArrival: string;
+  readonly otherArrivalStarter: string;
+  /** Over a card's free periods, which switch its stay in place. */
+  readonly freePeriods: string;
+  /** Over free periods that all lie in one month, whose pills then leave the month out ("14.–21."). */
+  readonly freePeriodsIn: string;
+  /** Under a carousel whose stays have different dates. */
+  readonly datesDiffer: string;
+  /** A comparison's stay on other dates than the first one's. */
+  readonly otherDate: string;
   readonly compareRooms: string;
   readonly compareHighlights: string;
   readonly compareRating: string;
@@ -118,6 +200,9 @@ interface WebsiteChatProps {
   readonly searchPath: string;
   /** The site's contact page: the chat links to it and has no form of its own. */
   readonly contactPath: string;
+  /** The site's privacy policy ("/datenschutz"): the start step links it next to what turning the
+   *  chat on means. No link without it (1.3.0). */
+  readonly privacyPath?: string;
   readonly theme?: ChatTheme;
   readonly colors?: ChatColors;
   readonly position?: "right" | "left";