@v-office/website-sdk 2.3.2 → 2.4.0

package/dist/cli.mjs

@@ -15,7 +15,7 @@ var CLICheckFailed = class extends Error {
 const toCLIError = (message, cause) => cause instanceof Error ? new CLICheckFailed(`${message}: ${cause.message}`, { cause }) : new CLICheckFailed(message, { cause });
 //#endregion
 //#region package.json
-var version = "2.3.2";
+var version = "2.4.0";
 //#endregion
 //#region src/cli/output.ts
 const toJson = (value) => Effect.try({

package/dist/index.d.mts

@@ -221,11 +221,21 @@ declare const getRentalsEffect: (input: RentalGetRentalsInput$1) => Effect.Effec
   }[];
   readonly highlights?: readonly string[];
   readonly reviews?: {
-    readonly items: readonly {
+    readonly items: readonly ({
+      readonly id?: string;
+      readonly author?: string;
+      readonly label?: string;
+      readonly createdAt?: string;
       readonly rating: string;
-      readonly author: string;
+      readonly text?: string;
+    } | {
+      readonly id?: string;
+      readonly author?: string;
+      readonly label?: string;
+      readonly createdAt?: string;
+      readonly rating?: string;
       readonly text: string;
-    }[];
+    })[];
     readonly summary?: {
       readonly rating: string;
       readonly count: string;

package/dist/instructions/CHANGELOG.md

@@ -4,6 +4,7 @@ This file is the versioned changelog index for the website SDK instructions.
 
 ## Versions
 
+- `versions/2.4.0/CHANGELOG.md`: `@v-office/website-sdk` 2.4.0 release notes.
 - `versions/2.3.0/CHANGELOG.md`: `@v-office/website-sdk` 2.3.0 release notes.
 - `versions/2.1.0/CHANGELOG.md`: `@v-office/website-sdk` 2.1.0 release notes.
 - `versions/2.0.0/CHANGELOG.md`: `@v-office/website-sdk` 2.0.0 release notes.

package/dist/instructions/MIGRATION.md

@@ -4,6 +4,8 @@ This file is the versioned migration index for the website SDK instructions.
 
 ## Available Guides
 
+- `versions/2.4.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.3.x to 2.4.0.
+- `versions/2.3.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.1.0 to 2.3.0.
 - `versions/2.1.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.0.0 to 2.1.0.
 - `versions/2.0.0/MIGRATION.md`: migrate from the legacy 1.x CMS-style website SDK API to `@v-office/website-sdk` 2.0.0.
 

package/dist/instructions/README.md

@@ -1,6 +1,6 @@
 # Website SDK Instructions
 
-These instructions describe `@v-office/website-sdk` 2.1.0.
+These instructions describe `@v-office/website-sdk` 2.4.0.
 
 Use this directory as the consumer-facing reference for the package:
 
@@ -15,6 +15,8 @@ Use this directory as the consumer-facing reference for the package:
 - `document-structured-json.md`: `sdk.static.documents.getTermsAndPrivacyPolicy` and structured document JSON rendering rules.
 - `CHANGELOG.md`: versioned changelog index.
 - `MIGRATION.md`: versioned migration index.
+- `versions/2.4.0/`: 2.4.0 release notes and 2.3.x-to-2.4.0 migration guide.
+- `versions/2.3.0/`: 2.3.0 release notes and 2.1.0-to-2.3.0 migration guide.
 - `versions/2.1.0/`: 2.1.0 release notes and 2.0.0-to-2.1.0 migration guide.
 - `versions/2.0.0/`: release-specific 2.0.0 changelog and 1.x-to-2.0.0 migration guide.
 
@@ -61,4 +63,4 @@ website-sdk --backend v9 filters --locale en-US
 website-sdk --backend v10 search --locale de-DE --query "adults=2"
 ```
 
-Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.1.0.
+Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.4.0.

package/dist/instructions/rentals.md

@@ -69,8 +69,15 @@ Sample item:
   "reviews": {
     "items": [
       {
+        "id": "rating-answer-1",
         "rating": "5",
-        "author": "Jane",
+        "label": "Overall satisfaction",
+        "createdAt": "2026-07-10T10:00:00.000Z"
+      },
+      {
+        "id": "text-answer-1",
+        "label": "Personal feedback",
+        "createdAt": "2026-07-10T10:00:01.000Z",
         "text": "Great stay."
       }
     ],
@@ -85,6 +92,34 @@ Sample item:
 
 Optional fields include `scope`, `address`, `property`, `rooms`, `roomSummary`, `vicinity`, and `reviews`.
 
+### Review Items
+
+Each review item contains at least `rating` or `text`. `id`, `author`, `label`, and `createdAt` are optional:
+
+```ts
+type RentalReview =
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating: string;
+      text?: string;
+    }
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating?: string;
+      text: string;
+    };
+```
+
+For v10, public `STARS` and `TEXT` answers may be returned as separate items because the backend does not always expose a reliable relationship between them. Do not assign a rating-only item to a text-only item. Missing public customer data leaves `author` undefined.
+
+`createdAt` is the feedback answer's creation timestamp, not a travel date. A text-only rental can have `reviews.items` without `reviews.summary`, so check the summary independently. The localized `summary.count` describes aggregated rating answers and does not necessarily equal `items.length`.
+
 ## Configuration
 
 `v9` config:

package/dist/instructions/versions/2.4.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog: 2.4.0
+
+Release date: 2026-07-15
+
+This release makes all usable v10 public rental feedback available without incorrectly associating independently returned ratings and comments.
+
+## Added
+
+- Added optional `id`, `label`, and `createdAt` fields to rental review items.
+- Added v10 rating-only review items for public `STARS` answers.
+- Added v10 text-only review items for public `TEXT` answers.
+- Added support for returning `reviews` with `items` but without `summary` when a rental only has public text feedback.
+
+## Changed
+
+- Rental review items now require at least one of `rating` or `text`; neither field is universally required.
+- Rental review `author` is now optional because the v10 public feedback API may omit customer information.
+- v10 public feedback answers are returned independently instead of being joined without a reliable submission identifier.
+- Existing review summaries and category ratings continue to aggregate valid public `STARS` answers.
+
+## Migration Impact
+
+- Check `item.rating`, `item.text`, and `item.author` before rendering them.
+- Treat `item.createdAt` as the feedback-answer creation time, not the guest's travel date.
+- Use `item.label` to identify the feedback question or rating category when present.
+- Do not assume `reviews.summary` exists whenever `reviews` exists.
+- Do not assume `reviews.items.length` matches the localized `reviews.summary.count`; items represent public answers while the summary represents aggregate ratings.
+- No SDK construction or configuration changes are required.

package/dist/instructions/versions/2.4.0/MIGRATION.md

@@ -0,0 +1,109 @@
+# Migration: 2.3.x to 2.4.0
+
+This guide covers upgrading `@v-office/website-sdk` from 2.3.x to 2.4.0.
+
+2.4.0 keeps `createWebsiteSDK({ config, options })`, the flat `WebsiteSDKConfig`, and the existing `sdk.static.rentals.getRentals({ locale })` call. The migration affects rental review rendering.
+
+## Rental Review Items
+
+The v10 public feedback API can return ratings and comments as independent answers without a reliable shared submission identifier. The SDK now exposes each usable answer without assigning a comment to an unrelated rating.
+
+Review items therefore support these shapes:
+
+```ts
+type RentalReview =
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating: string;
+      text?: string;
+    }
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating?: string;
+      text: string;
+    };
+```
+
+Every item contains at least `rating` or `text`. Complete items containing both fields remain valid.
+
+### Rendering
+
+Check every optional field independently:
+
+```ts
+for (const rental of await sdk.static.rentals.getRentals({ locale: "de-DE" })) {
+  for (const item of rental.reviews?.items ?? []) {
+    if (item.label !== undefined) {
+      renderReviewLabel(item.label);
+    }
+
+    if (item.rating !== undefined) {
+      renderReviewRating(item.rating);
+    }
+
+    if (item.text !== undefined) {
+      renderReviewText(item.text);
+    }
+
+    renderReviewAuthor(item.author ?? "Anonymous");
+
+    if (item.createdAt !== undefined) {
+      renderFeedbackCreatedAt(item.createdAt);
+    }
+  }
+}
+```
+
+`createdAt` is the public feedback answer's creation timestamp. It is not the guest's arrival or travel date.
+
+### Summary
+
+A rental with text-only public feedback can now return:
+
+```ts
+const rental = {
+  reviews: {
+    items: [
+      {
+        id: "answer-id",
+        label: "Personal feedback",
+        createdAt: "2026-07-10T10:00:00.000Z",
+        text: "A quiet stay.",
+      },
+    ],
+  },
+};
+```
+
+Continue to guard the summary independently:
+
+```ts
+if (rental.reviews?.summary !== undefined) {
+  renderReviewSummary(rental.reviews.summary);
+}
+```
+
+Do not use `reviews.items.length` as the review-summary count. Items represent independently available public answers, while `summary` aggregates valid public rating answers and exposes a localized `count` string.
+
+## Backend Behavior
+
+- v10 returns rating-only and text-only items when those answers are public.
+- Missing public customer data leaves `author` undefined; choose any anonymous label in the application.
+- The SDK does not copy aggregate ratings onto text-only items.
+- Existing v9 review items continue to contain `rating`, `author`, and `text`, but consumers see the shared weakened TypeScript type.
+- Rentals without any usable public rating or text answers continue to omit `reviews`.
+
+## Recommended Steps
+
+1. Upgrade to `@v-office/website-sdk` 2.4.0.
+2. Add presence checks for review `rating`, `text`, and `author`.
+3. Guard `reviews.summary` independently from `reviews`.
+4. Render `label` and `createdAt` where useful.
+5. Avoid pairing separate rating-only and text-only items in application code.
+6. Smoke-test rentals with rating-only, text-only, complete, and absent review data.

package/instructions/CHANGELOG.md

@@ -4,6 +4,7 @@ This file is the versioned changelog index for the website SDK instructions.
 
 ## Versions
 
+- `versions/2.4.0/CHANGELOG.md`: `@v-office/website-sdk` 2.4.0 release notes.
 - `versions/2.3.0/CHANGELOG.md`: `@v-office/website-sdk` 2.3.0 release notes.
 - `versions/2.1.0/CHANGELOG.md`: `@v-office/website-sdk` 2.1.0 release notes.
 - `versions/2.0.0/CHANGELOG.md`: `@v-office/website-sdk` 2.0.0 release notes.

package/instructions/MIGRATION.md

@@ -4,6 +4,8 @@ This file is the versioned migration index for the website SDK instructions.
 
 ## Available Guides
 
+- `versions/2.4.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.3.x to 2.4.0.
+- `versions/2.3.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.1.0 to 2.3.0.
 - `versions/2.1.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.0.0 to 2.1.0.
 - `versions/2.0.0/MIGRATION.md`: migrate from the legacy 1.x CMS-style website SDK API to `@v-office/website-sdk` 2.0.0.
 

package/instructions/README.md

@@ -1,6 +1,6 @@
 # Website SDK Instructions
 
-These instructions describe `@v-office/website-sdk` 2.1.0.
+These instructions describe `@v-office/website-sdk` 2.4.0.
 
 Use this directory as the consumer-facing reference for the package:
 
@@ -15,6 +15,8 @@ Use this directory as the consumer-facing reference for the package:
 - `document-structured-json.md`: `sdk.static.documents.getTermsAndPrivacyPolicy` and structured document JSON rendering rules.
 - `CHANGELOG.md`: versioned changelog index.
 - `MIGRATION.md`: versioned migration index.
+- `versions/2.4.0/`: 2.4.0 release notes and 2.3.x-to-2.4.0 migration guide.
+- `versions/2.3.0/`: 2.3.0 release notes and 2.1.0-to-2.3.0 migration guide.
 - `versions/2.1.0/`: 2.1.0 release notes and 2.0.0-to-2.1.0 migration guide.
 - `versions/2.0.0/`: release-specific 2.0.0 changelog and 1.x-to-2.0.0 migration guide.
 
@@ -61,4 +63,4 @@ website-sdk --backend v9 filters --locale en-US
 website-sdk --backend v10 search --locale de-DE --query "adults=2"
 ```
 
-Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.1.0.
+Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.4.0.

package/instructions/rentals.md

@@ -69,8 +69,15 @@ Sample item:
   "reviews": {
     "items": [
       {
+        "id": "rating-answer-1",
         "rating": "5",
-        "author": "Jane",
+        "label": "Overall satisfaction",
+        "createdAt": "2026-07-10T10:00:00.000Z"
+      },
+      {
+        "id": "text-answer-1",
+        "label": "Personal feedback",
+        "createdAt": "2026-07-10T10:00:01.000Z",
         "text": "Great stay."
       }
     ],
@@ -85,6 +92,34 @@ Sample item:
 
 Optional fields include `scope`, `address`, `property`, `rooms`, `roomSummary`, `vicinity`, and `reviews`.
 
+### Review Items
+
+Each review item contains at least `rating` or `text`. `id`, `author`, `label`, and `createdAt` are optional:
+
+```ts
+type RentalReview =
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating: string;
+      text?: string;
+    }
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating?: string;
+      text: string;
+    };
+```
+
+For v10, public `STARS` and `TEXT` answers may be returned as separate items because the backend does not always expose a reliable relationship between them. Do not assign a rating-only item to a text-only item. Missing public customer data leaves `author` undefined.
+
+`createdAt` is the feedback answer's creation timestamp, not a travel date. A text-only rental can have `reviews.items` without `reviews.summary`, so check the summary independently. The localized `summary.count` describes aggregated rating answers and does not necessarily equal `items.length`.
+
 ## Configuration
 
 `v9` config:

package/instructions/versions/2.4.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog: 2.4.0
+
+Release date: 2026-07-15
+
+This release makes all usable v10 public rental feedback available without incorrectly associating independently returned ratings and comments.
+
+## Added
+
+- Added optional `id`, `label`, and `createdAt` fields to rental review items.
+- Added v10 rating-only review items for public `STARS` answers.
+- Added v10 text-only review items for public `TEXT` answers.
+- Added support for returning `reviews` with `items` but without `summary` when a rental only has public text feedback.
+
+## Changed
+
+- Rental review items now require at least one of `rating` or `text`; neither field is universally required.
+- Rental review `author` is now optional because the v10 public feedback API may omit customer information.
+- v10 public feedback answers are returned independently instead of being joined without a reliable submission identifier.
+- Existing review summaries and category ratings continue to aggregate valid public `STARS` answers.
+
+## Migration Impact
+
+- Check `item.rating`, `item.text`, and `item.author` before rendering them.
+- Treat `item.createdAt` as the feedback-answer creation time, not the guest's travel date.
+- Use `item.label` to identify the feedback question or rating category when present.
+- Do not assume `reviews.summary` exists whenever `reviews` exists.
+- Do not assume `reviews.items.length` matches the localized `reviews.summary.count`; items represent public answers while the summary represents aggregate ratings.
+- No SDK construction or configuration changes are required.

package/instructions/versions/2.4.0/MIGRATION.md

@@ -0,0 +1,109 @@
+# Migration: 2.3.x to 2.4.0
+
+This guide covers upgrading `@v-office/website-sdk` from 2.3.x to 2.4.0.
+
+2.4.0 keeps `createWebsiteSDK({ config, options })`, the flat `WebsiteSDKConfig`, and the existing `sdk.static.rentals.getRentals({ locale })` call. The migration affects rental review rendering.
+
+## Rental Review Items
+
+The v10 public feedback API can return ratings and comments as independent answers without a reliable shared submission identifier. The SDK now exposes each usable answer without assigning a comment to an unrelated rating.
+
+Review items therefore support these shapes:
+
+```ts
+type RentalReview =
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating: string;
+      text?: string;
+    }
+  | {
+      id?: string;
+      author?: string;
+      label?: string;
+      createdAt?: string;
+      rating?: string;
+      text: string;
+    };
+```
+
+Every item contains at least `rating` or `text`. Complete items containing both fields remain valid.
+
+### Rendering
+
+Check every optional field independently:
+
+```ts
+for (const rental of await sdk.static.rentals.getRentals({ locale: "de-DE" })) {
+  for (const item of rental.reviews?.items ?? []) {
+    if (item.label !== undefined) {
+      renderReviewLabel(item.label);
+    }
+
+    if (item.rating !== undefined) {
+      renderReviewRating(item.rating);
+    }
+
+    if (item.text !== undefined) {
+      renderReviewText(item.text);
+    }
+
+    renderReviewAuthor(item.author ?? "Anonymous");
+
+    if (item.createdAt !== undefined) {
+      renderFeedbackCreatedAt(item.createdAt);
+    }
+  }
+}
+```
+
+`createdAt` is the public feedback answer's creation timestamp. It is not the guest's arrival or travel date.
+
+### Summary
+
+A rental with text-only public feedback can now return:
+
+```ts
+const rental = {
+  reviews: {
+    items: [
+      {
+        id: "answer-id",
+        label: "Personal feedback",
+        createdAt: "2026-07-10T10:00:00.000Z",
+        text: "A quiet stay.",
+      },
+    ],
+  },
+};
+```
+
+Continue to guard the summary independently:
+
+```ts
+if (rental.reviews?.summary !== undefined) {
+  renderReviewSummary(rental.reviews.summary);
+}
+```
+
+Do not use `reviews.items.length` as the review-summary count. Items represent independently available public answers, while `summary` aggregates valid public rating answers and exposes a localized `count` string.
+
+## Backend Behavior
+
+- v10 returns rating-only and text-only items when those answers are public.
+- Missing public customer data leaves `author` undefined; choose any anonymous label in the application.
+- The SDK does not copy aggregate ratings onto text-only items.
+- Existing v9 review items continue to contain `rating`, `author`, and `text`, but consumers see the shared weakened TypeScript type.
+- Rentals without any usable public rating or text answers continue to omit `reviews`.
+
+## Recommended Steps
+
+1. Upgrade to `@v-office/website-sdk` 2.4.0.
+2. Add presence checks for review `rating`, `text`, and `author`.
+3. Guard `reviews.summary` independently from `reviews`.
+4. Render `label` and `createdAt` where useful.
+5. Avoid pairing separate rating-only and text-only items in application code.
+6. Smoke-test rentals with rating-only, text-only, complete, and absent review data.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v-office/website-sdk",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "description": "Website-facing SDK facade backed by @v-office/sdk-core",
   "bin": {
     "website-sdk": "./dist/cli.mjs"
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "3.2.0",
-    "@v-office/sdk-core": "^1.4.1",
+    "@v-office/sdk-core": "^1.5.0",
     "effect": "4.0.0-beta.85",
     "graphql": "16.14.2",
     "yaml": "^2.9.0"