@v-office/website-chat 0.0.0-stage → 1.0.0

package/dist/protocol-Bmb_uxVQ.d.ts

@@ -0,0 +1,46 @@
+import { Spec } from "@json-render/core";
+//#region src/protocol.d.ts
+/** The languages the chat speaks; the widget's `locale` picks one. */
+declare const CHAT_LOCALES: readonly ["de", "en"];
+type ChatLocale = (typeof CHAT_LOCALES)[number];
+/** The path both requests go to, below the service's endpoint. */
+declare const CHAT_PATH = "/v1/chat";
+/** Longest visitor message the service takes. */
+declare const MAX_MESSAGE_CHARS = 2000;
+/** How long the service keeps a conversation after its last message. The widget forgets its own copy
+ *  after the same time, so it never shows a conversation the service no longer knows. */
+declare const SESSION_TTL_S: number;
+/** `GET <endpoint>/v1/chat`. */
+interface ChatAvailability {
+  readonly available: boolean;
+}
+/** `POST <endpoint>/v1/chat`. */
+interface ChatRequest {
+  /** The session the service answered with; `null` for the first message. */
+  readonly sessionId: string | null;
+  readonly message: string;
+  readonly locale: ChatLocale;
+  /** The widget's package version: the service offers only components it can render. */
+  readonly clientVersion: string;
+}
+/** 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";
+/** One server-sent event (`event: <type>`, `data: <json>`), in order. */
+type ChatEvent = {
+  readonly type: "session";
+  readonly sessionId: string;
+} | {
+  readonly type: "text";
+  readonly delta: string;
+} | {
+  readonly type: "ui";
+  readonly spec: Spec;
+} | {
+  readonly type: "done";
+} | {
+  readonly type: "unavailable";
+  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 };

package/dist/protocol-BuNqZAMt.js

@@ -0,0 +1,12 @@
+//#region src/protocol.ts
+/** The languages the chat speaks; the widget's `locale` picks one. */
+const CHAT_LOCALES = ["de", "en"];
+/** The path both requests go to, below the service's endpoint. */
+const CHAT_PATH = "/v1/chat";
+/** Longest visitor message the service takes. */
+const MAX_MESSAGE_CHARS = 2e3;
+/** How long the service keeps a conversation after its last message. The widget forgets its own copy
+*  after the same time, so it never shows a conversation the service no longer knows. */
+const SESSION_TTL_S = 7200;
+//#endregion
+export { SESSION_TTL_S as i, CHAT_PATH as n, MAX_MESSAGE_CHARS as r, CHAT_LOCALES as t };

package/instructions/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+<!-- generated by `node .github/release/cli.mts index`; do not edit by hand -->
+
+Release notes of `@v-office/website-chat`, newest first. Each version has its own directory.
+
+- `versions/1.0.0/CHANGELOG.md`: release notes for 1.0.0

package/instructions/MIGRATION.md

@@ -0,0 +1,7 @@
+# Migration
+
+<!-- generated by `node .github/release/cli.mts index`; do not edit by hand -->
+
+Migration guides of `@v-office/website-chat`, newest first. Apply them in order when skipping versions.
+
+- `versions/1.0.0/MIGRATION.md`: Migration: 1.0.0

package/instructions/versions/1.0.0/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog: 1.0.0
+
+The first release: the AI chat of a v-office website. A visitor asks for a stay; the chat searches the
+agency's rentals, shows them as cards with the PMS's prices, and links each stay to its rental page with
+the dates and party filled in, where the site's own Quote and checkout take over. The chat never books
+and has no form of its own.
+
+## Added
+
+- `WebsiteChat`, rendered in a Shadow DOM so the site's CSS and the chat's cannot affect each other. It
+  asks the chat service whether the website's chat is on and renders nothing otherwise.
+  - An entry pill in the corner of every page, frosted glass with a ring running round it until the
+    visitor has asked something. On a phone it is one tap; on a wide screen the visitor types into it.
+    Once a conversation exists it offers to continue it.
+  - The panel loads on the first open: a card at the screen's edge over the dimmed page, a sheet from
+    the bottom on a phone. Start suggestions, a waiting indicator, results side by side where there is
+    room, a button for a new conversation.
+  - The conversation follows the visitor from page to page within the tab, for as long as the chat
+    service keeps it (two hours after the last message), so a link from the chat to a rental page
+    does not lose it.
+- A start step: nothing is sent to the AI provider before the visitor reads what the chat does and
+  presses "Start chat". A message typed into the entry pill waits there until then.
+- Looks: three template themes (`classic`, `soft`, `minimal`), the site's `primary` and `secondary`
+  colours, the pill and panel on the `right` or `left`, the site's font, and `--chat-top` /
+  `--chat-width` for a sticky header and a wider panel.
+- Copy in German and English (`DEFAULT_COPY`), each string overridable through `copy`.
+- `./catalog`: the components the chat service places and the wire protocol. Sites do not import it.
+  - Rentals: `RentalCard` (photo gallery, rating, facts, the visitor's wishes the search that found it applied),
+    `RentalCarousel` (several cards side by side, swipeable), `Compare` (two or three rentals column
+    by column), `ReviewSummary` (the PMS's rating, grade, category ratings and a few review texts),
+    `RentalFacts` (a rental's facts in the PMS's groups), `RentalMap` (where it is; the map loads
+    from OpenFreeMap only when the visitor taps it).
+  - Stays: `StayQuote`, `PriceBreakdown` (the quote's lines and total), `AlternativeStays` (other
+    free periods as tappable choices), `AvailabilityCalendar` (free and taken days by month),
+    `PriceCalendar` (the total at the arrivals around the asked one, cheapest marked).
+  - Actions: `StayLink`, `ContactLink`, `QuickReplies` (short answers a visitor taps to send).
+    Every figure in them comes from the PMS; the AI places them by id only.

package/instructions/versions/1.0.0/MIGRATION.md

@@ -0,0 +1,51 @@
+# Migration: 1.0.0
+
+A new package: nothing to migrate. To add the chat to a site:
+
+## 1. Install
+
+```sh
+pnpm add --save-exact @v-office/website-chat@1.0.0
+```
+
+Its peers are React `^19.2.3` and `@v-office/website-headless` 1.1 or later, which a site with the
+platform components has.
+
+## 2. Render it once, in the layout
+
+```astro
+---
+import { WebsiteChat } from "@v-office/website-chat";
+---
+<WebsiteChat
+  client:idle
+  endpoint={import.meta.env.PUBLIC_CHAT_ENDPOINT}
+  locale="de"
+  searchPath="/suche"
+  contactPath="/kontakt"
+/>
+```
+
+- `endpoint` is the AI Studio chat service of the site's environment. AI Studio's builds set
+  `PUBLIC_CHAT_ENDPOINT` to it: pass it as shown and keep no value in the site's `.env`. Without it
+  (a build outside AI Studio) the widget renders nothing.
+- `searchPath` and `contactPath` are the site's own routes: the chat links a rental without a page to the
+  search, and sends a visitor who wants to write to the contact page.
+- Optional: `theme` (`"classic"`, `"soft"`, `"minimal"`), `colors={{ primary, secondary }}`,
+  `position` (`"right"` or `"left"`), `copy` (overrides of single fields of `DEFAULT_COPY`: a string, or the `suggestions` list).
+- A site with a sticky header sets its height as `--chat-top` on an element around the widget (for
+  example `:root { --chat-top: 72px; }`), so the panel and the dimmed page start below the header.
+- With Astro's `<ClientRouter />`, add `transition:persist="website-chat"` so a reply still being
+  written keeps going across page transitions. The panel closes on a page change either way, as on a
+  full page load, and the next page offers to continue the conversation.
+
+## 3. Consent
+
+The chat sends what a visitor types to an AI provider, so nothing is sent before the visitor reads
+what that means and presses the chat's own "Start chat" button. The chat does not read the site's
+consent manager; nothing to configure there.
+
+## 4. Switch it on
+
+The chat stays hidden until an agent switches it on for the website in AI Studio (website settings,
+"Website chat"). Switching it off hides it again without a rebuild.

package/package.json

@@ -1,6 +1,68 @@
 {
   "name": "@v-office/website-chat",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.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": {
+    "type": "git",
+    "url": "git+https://github.com/vofficeGmbh/ai-studio.git",
+    "directory": "packages/website-chat"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "instructions"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./catalog": "./dist/catalog.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@json-render/core": "0.21.0",
+    "@json-render/react": "0.21.0",
+    "maplibre-gl": "^5.24.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "26.5.1",
+    "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
+    "@v-office/website-headless": "1.1.1",
+    "@v-office/website-sdk": "2.34.0",
+    "jsdom": "30.0.1",
+    "oxfmt": "0.67.0",
+    "oxlint": "1.82.0",
+    "oxlint-plugin-react-doctor": "0.9.14",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "tsdown": "0.23.0",
+    "typescript": "7.0.2",
+    "vitest": "5.0.0"
+  },
+  "peerDependencies": {
+    "@v-office/website-headless": ">=1.1.0 <2",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "engines": {
+    "node": "^22.0.0 || ^24.0.0 || ^25.0.0 || >=26.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint .",
+    "lint:fix": "oxlint --fix .",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check",
+    "check": "pnpm run typecheck && pnpm run lint && pnpm run fmt:check",
+    "test": "vitest run && node --test test/dist.node.mjs"
+  }
 }