@v-office/website-chat 1.1.3 → 1.3.0

package/dist/{protocol-Bmb_uxVQ.d.ts → protocol-Dg1HZNWG.d.ts}

@@ -22,10 +22,16 @@ interface ChatRequest {
   readonly locale: ChatLocale;
   /** The widget's package version: the service offers only components it can render. */
   readonly clientVersion: string;
+  /** The stay the widget keeps in reach for the visitor (its dock bar), so "we'll take it" means that
+   *  one; `null` or absent without one. An older service ignores it (1.3.0). */
+  readonly picked?: string | null;
 }
 /** Why the chat cannot answer: switched off, its budget spent, a reply still running, too many
  *  messages, or anything else. The widget shows its fallback (search and contact links). */
 type ChatUnavailableReason = "off" | "budget" | "busy" | "limit" | "error";
+/** What the service is doing while the visitor waits, for the widget's waiting line (1.3.0). A widget
+ *  shows a step it does not know as plain waiting. */
+type ChatStatusStep = "search" | "rental" | "availability" | "quote" | "reviews";
 /** One server-sent event (`event: <type>`, `data: <json>`), in order. */
 type ChatEvent = {
   readonly type: "session";
@@ -36,6 +42,11 @@ type ChatEvent = {
 } | {
   readonly type: "ui";
   readonly spec: Spec;
+} |
+/** Since 1.3.0; every earlier widget drops an event it does not know. */
+{
+  readonly type: "status";
+  readonly step: ChatStatusStep;
 } | {
   readonly type: "done";
 } | {
@@ -43,4 +54,4 @@ type ChatEvent = {
   readonly reason: ChatUnavailableReason;
 };
 //#endregion
-export { ChatLocale as a, MAX_MESSAGE_CHARS as c, ChatEvent as i, SESSION_TTL_S as l, CHAT_PATH as n, ChatRequest as o, ChatAvailability as r, ChatUnavailableReason as s, CHAT_LOCALES as t };
+export { ChatLocale as a, ChatUnavailableReason as c, ChatEvent as i, MAX_MESSAGE_CHARS as l, CHAT_PATH as n, ChatRequest as o, ChatAvailability as r, ChatStatusStep as s, CHAT_LOCALES as t, SESSION_TTL_S as u };

package/instructions/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 Release notes of `@v-office/website-chat`, newest first. Each version has its own directory.
 
+- `versions/1.3.0/CHANGELOG.md`: release notes for 1.3.0
+- `versions/1.2.0/CHANGELOG.md`: release notes for 1.2.0
 - `versions/1.1.3/CHANGELOG.md`: release notes for 1.1.3
 - `versions/1.1.2/CHANGELOG.md`: release notes for 1.1.2
 - `versions/1.1.1/CHANGELOG.md`: release notes for 1.1.1

package/instructions/MIGRATION.md

@@ -4,6 +4,8 @@
 
 Migration guides of `@v-office/website-chat`, newest first. Apply them in order when skipping versions.
 
+- `versions/1.3.0/MIGRATION.md`: Migration: 1.2.0 to 1.3.0
+- `versions/1.2.0/MIGRATION.md`: Migration: 1.1.3 to 1.2.0
 - `versions/1.1.3/MIGRATION.md`: Migration: 1.1.2 to 1.1.3
 - `versions/1.1.2/MIGRATION.md`: Migration: 1.1.1 to 1.1.2
 - `versions/1.1.1/MIGRATION.md`: Migration: 1.1.0 to 1.1.1

package/instructions/versions/1.2.0/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog: 1.2.0
+
+The chat reads better on phones, says more clearly what each card is for, and tells screen readers what
+happens. Nothing to change on a site.
+
+## Added
+
+- Copy keys `pets` (`{n} Haustier` / `{n} Haustiere`, `{n} pet` / `{n} pets`) and `rentalsFound`
+  ("Gefundene Unterkünfte" / "Rentals found"), with defaults in both languages.
+
+## Changed
+
+- Other free periods (`AlternativeStays`) name the rental they belong to, so dates under one rental's card
+  never read as its prices.
+- Cards name the month ("12.–19. Juli", "12–19 Jul") and the party the price is for, pets included.
+- Compare and the price calendar fit a phone: two readable comparison columns that scroll, rows that line
+  up side by side, and the cheapest arrival scrolled into view.
+- A price breakdown shown on its own names the rental, the dates and the party.
+- On narrow phones a carousel card is only as tall as its content, so its price and booking button stay
+  above the input; in a carousel a long rental name stops at three lines, and counts on cards and in
+  Compare keep their number and noun on one line ("2 Kinder", "2 Schlafzimmer").
+- Touch targets are at least 44 px on touch screens, the first-message suggestions wrap instead of
+  scrolling, and hover styles apply only where there is a pointer.
+- Larger dates and prices, the same visible focus ring on every control, a placeholder with AA contrast,
+  free and taken calendar days that are easy to tell apart in dark mode, visitor messages and chips with
+  an edge, and tidier chips and buttons. The widget still takes its colours from the site's tokens; only
+  some of its own tones changed for these contrasts.
+- A reply opens at its start: when the first card arrives, the visitor's question scrolls to the top of the
+  conversation, and the list follows only a visitor who stays at the bottom. Only the conversation
+  scrolls; the chat's header stays in place.
+- Screen readers hear each finished reply once (`role="log"`) and that the chat is working while it
+  searches; booking links name the rental and the dates; a carousel is announced as the rentals found.
+- The chat shows that it is working until the reply's text arrives, also after its cards. A message the
+  chat cannot answer now is answered in the conversation, with links to the search and the contact page;
+  when the chat was busy or the message failed, it stays in the input to send again.
+- Two first-message suggestions changed: a summer week for a family and next weekend, instead of school
+  holidays, which differ by federal state.
+- `--chat-top` applies only from 1024 px wide. On phones and tablets the chat opens as a full-height sheet
+  over the site's sticky header, which could not be used while the chat was open anyway.
+- The component descriptions in `./catalog` say more precisely when each component fits and what must come
+  first. Nothing renders differently because of them.
+
+## Unchanged
+
+- Props, themes, the `colors` prop and the protocol are as in 1.1.3; existing copy keys keep their meaning.

package/instructions/versions/1.2.0/MIGRATION.md

@@ -0,0 +1,15 @@
+# Migration: 1.1.3 to 1.2.0
+
+No changes required.
+
+- A site that passes `copy` needs nothing for the new keys `pets` and `rentalsFound`: their defaults apply.
+  Code that builds a complete `ChatCopy` object adds both.
+- A site that overrides `suggestions` keeps its own; the new defaults apply only where it does not.
+- A site that sets `--chat-top` keeps it: it still moves the panel below the sticky header on screens from
+  1024 px wide. Below that, the chat covers the header as a full-height sheet.
+
+## 1. Upgrade
+
+```sh
+pnpm add --save-exact @v-office/website-chat@1.2.0
+```

package/instructions/versions/1.3.0/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog: 1.3.0
+
+Quotes say what the price covers, what the guest saves and until when the stay is free to cancel, all from
+the booking system, and a quote shown when the guest has decided hands the stay over to the booking page.
+Nothing to change on a site.
+
+## Added
+
+- Quotes (`StayQuote`) name the total ("Gesamtpreis für 7 Nächte"), show the agency's discount with what
+  the guest saves ("Frühbucher · Sie sparen 112,30 €"), the rate's own name and the free-cancellation date
+  from the booking system ("Kostenlos stornierbar bis 7. Jan. 2027", or "Nicht erstattbar"), and fold the
+  price lines into "Preisdetails". The dates carry their weekdays ("Sa 6. – Sa 13. Feb."), and a small
+  photo sits beside the name.
+- A quote shown when the guest has decided (`handover`) becomes a hand-over card: arrival and departure
+  with weekdays, the party with the children's ages, the rate, the chosen extras, the total as the largest
+  figure, one full-width "Weiter zur Buchung" button, and, where the rental has a booking page, what that page asks
+  next.
+- Cards and Compare label their total the same way and mark a discounted stay with the discount's name.
+- A bar above the input keeps the stay being discussed in reach: its name, total, dates and guests and
+  a "Zur Buchung" button; a tap on its name brings the stay's card back into view. Before a stay is
+  priced it shows what the chat searched with (period, party, nights, wishes), the party marked
+  "angenommen" when the guest named none; a tap on a part puts the start of a correction into the input.
+- The header keeps a "KI" mark beside the title. After the first message the AI notice shrinks to one
+  line ("Preise aus dem Buchungssystem"), with the full notice behind ⓘ.
+- While the guest waits, the chat says what it is doing ("Prüfe den Preis im Buchungssystem …").
+- A message the chat could not answer (busy, failed) can be sent again with "Erneut senden".
+- Optional `privacyPath` prop: the step that starts the chat links the site's privacy policy.
+- Links out of the chat (rental and booking pages, search, contact) carry `ref=chat`, a parameter
+  the site already treats as tracking: it changes no search and is not kept in share links.
+- Calendars mark the days a stay can start on and each free day's price level (cheaper to dearer, never
+  an amount, and only where the levels differ); taken days are hatched, so the calendar reads without
+  colour. Tapping an arrival day fills it alone and shows "Anreise Di 9. Feb." with "Preis anzeigen",
+  which asks the chat for that stay.
+- A stay the booking system refused lists the stay lengths it allows from that arrival ("4 Nächte bis
+  Di 18. Mai"); each asks for its price. "Anderen Anreisetag wählen" starts a new question.
+- Cards from a flexible search switch between their rental's free periods in place: dates, total and
+  booking button change without a new reply, and the bar above the input follows. Periods in one month
+  name it once ("Freie Termine im Mai", pills "8.–15.", "13.–20.").
+- Copy keys: `arrivalPossible`, `cheaper`, `dearer`, `showPrice`, `arrivalOn`, `possibleFrom`, `until`,
+  `otherArrival`, `otherArrivalStarter`, `freePeriods`, `freePeriodsIn`, `datesDiffer` and `otherDate`.
+- Tapping a card's photo opens the rental's photos large inside the chat: uncropped, with the
+  booking system's captions, swiped or stepped through, with the stay's total and "Zur Buchung" kept in
+  the foot. Escape closes the photos first, then the chat. Copy keys `openPhotos`, `closePhotos`.
+- Copy keys, with defaults in both languages: `totalForNights`, `priceDetails`, `dealFallback`, `youSave`,
+  `freeCancellation`, `nonRefundable`, `arrival`, `departure`, `continueToBooking`, `nothingBookedYet`,
+  `handoverSteps` (the three steps under the hand-over's button), `aiBadge`, `noticeShort`,
+  `noticeMore`, `status` (the waiting line per step), `retry`, `privacyLink`, `yourPick`, `yourTrip`,
+  `assumed`, `guests`, `adultsShort`, `weekend` and `tripStarters`.
+- `./catalog`: the optional state the chat service writes for these (`ChatDiscount`, `ChatCancellation`,
+  `ChatTrip`, and optional fields on `ChatStay`, `ChatCalendar`, `ChatImage` and `ChatState`), the
+  `status` event (`ChatStatusStep`), the optional `picked` field of a request, and `versionAtLeast`. A
+  widget that does not draw a field yet ignores it.
+
+## Changed
+
+- The German `book` label reads "Zur Buchung" instead of "Buchen", as a stay link's button (`bookStay`) already did.
+- Under a card's labelled total, the foot shows the dates without repeating the nights.
+- The input reads "Ihre Reise beschreiben …" ("Describe your trip …") and stays one line on a phone; its
+  focus ring shows for keyboard focus only.
+- Quick replies the guest has answered go quiet: only the chosen one stays, outlined and muted. The
+  current ones stay tinted pills, so they never look like the outlined links out of the chat.
+- Buttons keep their full colour while a reply is still being written (they wait for it, as before).
+- Other free periods (`AlternativeStays`) are rows with weekday dates, nights (with a discount's badge)
+  and total that choose a period for the booking button in the bar, instead of chips that left the chat
+  for the booking page. The choice is kept with the conversation and named in the next message.
+- Calendars show free days plain and taken days hatched instead of tinting free days.
+- Cards lead with a larger photo (4:3 for a single card on a phone, flatter in a carousel) with the place
+  and "★ 4,8 (23)" on it and a photo count instead of dots; a card without photos writes them the same
+  way above its name. Photos load in the size the screen needs
+  where the booking system offers several (`srcset`).
+- In dark mode cards, comparisons and calendars rise a step above the conversation with a fine edge,
+  instead of sinking into it. Star ratings take a colour that reads on light and dark surfaces.
+- A carousel card puts the total's label above the total and the button, so the price stays in view; a
+  discount's badge sits on the total's line, never on two. Compare's rows line up at every width, long
+  names cut at three lines.
+- On touch screens a carousel shows dots instead of the arrows and count, fades at the end while more
+  cards follow, and says when its rentals' dates differ. Compare marks a stay on other dates than the first.
+
+## Unchanged
+
+- Props, themes and the existing copy keys keep their meaning. `PriceBreakdown` and `PriceCalendar` still
+  render, for conversations stored before this version.

package/instructions/versions/1.3.0/MIGRATION.md

@@ -0,0 +1,22 @@
+# Migration: 1.2.0 to 1.3.0
+
+No changes required.
+
+- A site whose `copy` sets `book` keeps its own label; the others now read "Zur Buchung" in German.
+- A site that passes `copy` needs nothing for the new keys: their defaults apply. Override
+  `handoverSteps` when the site's booking page asks something else than contact details, payment and an
+  email confirmation (the hand-over lists them only for rentals with a booking page). Code that builds a
+  complete `ChatCopy` object adds the new keys.
+- Pass `privacyPath` (for example `privacyPath="/datenschutz"`) to link the privacy policy where the
+  chat is started.
+- A site that overrides `notice` also overrides `noticeShort`, which stands in for it after the first
+  message (the full `notice` stays behind ⓘ). A site that overrides `placeholder` keeps its own.
+- Analytics may see `ref=chat` on rental, booking, search and contact URLs opened from the chat.
+- Other free periods no longer link to the booking page themselves: a tapped row becomes the stay in
+  the bar above the input, whose "Zur Buchung" opens it.
+
+## 1. Upgrade
+
+```sh
+pnpm add --save-exact @v-office/website-chat@1.3.0
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v-office/website-chat",
-  "version": "1.1.3",
+  "version": "1.3.0",
   "description": "The AI chat of v-office websites: a launcher and a lazily loaded chat panel in a Shadow DOM, talking to the AI Studio chat service, and the json-render catalog (./catalog) the service places its rental cards, stays and links from. Styled through CSS custom properties and curated template themes; consumers need no Tailwind",
   "license": "UNLICENSED",
   "repository": {
@@ -35,7 +35,7 @@
     "@types/react": "19.3.0",
     "@types/react-dom": "19.3.0",
     "@v-office/website-headless": "1.5.0",
-    "@v-office/website-sdk": "3.3.0",
+    "@v-office/website-sdk": "3.6.0",
     "jsdom": "30.0.1",
     "oxfmt": "0.67.0",
     "oxlint": "1.82.0",