@v-office/website-sdk 2.10.0 → 2.11.0

package/README.md

@@ -2,9 +2,8 @@
 
 Website-facing SDK facade for vOffice backends.
 
-The 2.8.0 line adds the catalog-backed custom-attribute registry, backend-aware
-atomic filter compositions, and consistent custom-attribute display and highlight
-behavior.
+The current SDK includes catalog-backed custom attributes, backend-aware search,
+and localized v10 REST search discount details.
 See `instructions/CHANGELOG.md` for the complete release history.
 
 ## Install

package/dist/cli.mjs

@@ -16,7 +16,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.10.0";
+var version = "2.11.0";
 //#endregion
 //#region src/cli/output.ts
 const toJson = (value) => Effect.try({

package/dist/index.d.mts

@@ -350,6 +350,14 @@ declare const searchEffect: (input: SearchSearchInput$1) => Effect.Effect<{
       readonly province?: string;
       readonly country?: string;
     };
+    readonly formattedTotal?: string;
+    readonly discount?: {
+      readonly formattedOriginalTotal: string;
+      readonly applied: readonly {
+        readonly label: string;
+        readonly formattedAmount: string;
+      }[];
+    };
     readonly highlights?: readonly string[];
     readonly property?: {
       readonly id: string;
@@ -379,7 +387,6 @@ declare const searchEffect: (input: SearchSearchInput$1) => Effect.Effect<{
         readonly country?: string;
       };
     };
-    readonly formattedTotal?: string;
   }[];
   readonly alternatives?: readonly {
     readonly item: {
@@ -411,6 +418,14 @@ declare const searchEffect: (input: SearchSearchInput$1) => Effect.Effect<{
         readonly province?: string;
         readonly country?: string;
       };
+      readonly formattedTotal?: string;
+      readonly discount?: {
+        readonly formattedOriginalTotal: string;
+        readonly applied: readonly {
+          readonly label: string;
+          readonly formattedAmount: string;
+        }[];
+      };
       readonly highlights?: readonly string[];
       readonly property?: {
         readonly id: string;
@@ -440,12 +455,18 @@ declare const searchEffect: (input: SearchSearchInput$1) => Effect.Effect<{
           readonly country?: string;
         };
       };
-      readonly formattedTotal?: string;
     };
     readonly alternativePeriods: readonly {
+      readonly formattedTotal?: string;
+      readonly discount?: {
+        readonly formattedOriginalTotal: string;
+        readonly applied: readonly {
+          readonly label: string;
+          readonly formattedAmount: string;
+        }[];
+      };
       readonly start: string;
       readonly end: string;
-      readonly formattedTotal?: string;
     }[];
   }[];
   readonly appliedFilters: readonly {

package/dist/instructions/CHANGELOG.md

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

package/dist/instructions/MIGRATION.md

@@ -4,6 +4,7 @@ This file is the versioned migration index for the website SDK instructions.
 
 ## Available Guides
 
+- `versions/2.11.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.10.0 to 2.11.0.
 - `versions/2.10.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.9.0 to 2.10.0.
 - `versions/2.9.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.8.0 to 2.9.0.
 - `versions/2.8.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.7.0 to 2.8.0.

package/dist/instructions/README.md

@@ -1,7 +1,7 @@
 # Website SDK Instructions
 
 These instructions describe the current source targeted for
-`@v-office/website-sdk` 2.10.0. Package versions remain unchanged until the release
+`@v-office/website-sdk` 2.11.0. Package versions remain unchanged until the release
 workflow performs the coordinated core and website bumps.
 
 Use this directory as the consumer-facing reference for the package:
@@ -18,6 +18,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.11.0/`: 2.11.0 search-discount release notes and
+  2.10.0-to-2.11.0 migration guide.
 - `versions/2.10.0/`: 2.10.0 option-booking release notes and 2.9.0-to-2.10.0 migration guide.
 - `versions/2.9.0/`: 2.9.0 highlight-selection release notes and 2.8.0-to-2.9.0 migration guide.
 - `versions/2.8.0/`: 2.8.0 custom-attribute release notes and 2.7.0-to-2.8.0 migration guide.
@@ -76,4 +78,6 @@ website-sdk --backend v10 search --locale de-DE --query "adults=2"
 website-sdk --backend v10 search --locale de-DE --query "adults=2" --sort '{"by":"field","orderBy":{"label":"ASC"}}'
 ```
 
-Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.10.0. v10 config additionally requires `searchEndpoint` as of 2.5.0.
+Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced
+in 2.0.0 and kept in 2.11.0. v10 config additionally requires `searchEndpoint` as
+of 2.5.0.

package/dist/instructions/search.md

@@ -227,6 +227,18 @@ The supported fields are `label`, `name`, all six `roomSummary` counters, `attri
 
 Returns `Promise<RentalSearchOutput>`.
 
+Priced items and alternative periods share this optional discount shape:
+
+```ts
+type SearchDiscount = {
+  readonly formattedOriginalTotal: string;
+  readonly applied: readonly {
+    readonly label: string;
+    readonly formattedAmount: string;
+  }[];
+};
+```
+
 Sample:
 
 ```json
@@ -250,7 +262,16 @@ Sample:
         }
       ],
       "highlights": ["2 bedrooms", "WiFi", "Parking"],
-      "formattedTotal": "1.234,00 €"
+      "formattedTotal": "1.111,00 €",
+      "discount": {
+        "formattedOriginalTotal": "1.234,00 €",
+        "applied": [
+          {
+            "label": "Frühbucher-Rabatt",
+            "formattedAmount": "-123,00 €"
+          }
+        ]
+      }
     }
   ],
   "alternatives": [
@@ -264,7 +285,16 @@ Sample:
         {
           "start": "2026-07-10",
           "end": "2026-07-17",
-          "formattedTotal": "1.456,00 €"
+          "formattedTotal": "1.310,00 €",
+          "discount": {
+            "formattedOriginalTotal": "1.456,00 €",
+            "applied": [
+              {
+                "label": "Frühbucher-Rabatt",
+                "formattedAmount": "-146,00 €"
+              }
+            ]
+          }
         }
       ]
     }
@@ -288,7 +318,15 @@ Sample:
 }
 ```
 
-Search items share the rental base fields and may include `scope`, `address`, `property`, `highlights`, and `formattedTotal`. Exact-period results are returned in `items`; alternative-period suggestions are returned in root-level `alternatives`.
+Search items share the rental base fields and may include `scope`, `address`,
+`property`, `highlights`, and `formattedTotal`. A priced item or alternative period
+may also include `discount`. When it does, `formattedTotal` is the final price and
+`discount.formattedOriginalTotal` is the price before the applied discounts.
+Discount totals, labels, and amounts are already localized and formatted for the
+requested locale; backend numeric amounts and modifier type keys are not exposed.
+`applied` may be empty when the backend supplies an original total without
+individual modifier lines. Exact-period results are returned in `items`;
+alternative-period suggestions are returned in root-level `alternatives`.
 
 `appliedFilters` reports what the backend actually applied, and is what a "remove
 this filter" chip should be built from. `label` is localized presentation and can
@@ -319,6 +357,8 @@ v10 search runs against the dedicated REST search backend (`POST` to the configu
 - `property` is the minimal `{ id, nameOrLabel }` shape. Hydrate `property.location`, `property.images`, or `property.address` from `sdk.static.rentals.getRentals(...)` when a card needs them.
 - Custom-attribute search filters and highlights require the `customAttributes` registry. A definition with no catalog ID cannot be executed, so its query key is left in `unusedFilterKeys`. v9 never executes a custom-attribute filter at all. See `custom-attributes.md`.
 - Fixed-period and flexible searches are priced by the REST backend and require occupancy.
+- Priced items and alternative periods may include localized `discount` details when the REST backend returns them. Legacy v9 search does not populate this field.
+- Search inputs are unchanged. The SDK keeps alternative-cancellation-policy pricing out of search; cancellation-policy selection remains part of the quote and booking flow.
 - Pagination uses the backend `from`/`size` window behind the same opaque `cursor`, capped at 1,000 results.
 
 ## Configuration

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

@@ -0,0 +1,28 @@
+# Changelog: 2.11.0
+
+This release exposes localized v10 REST search discount details on priced search
+results.
+
+## Added
+
+- Priced v10 search items may include an optional `discount` with the localized
+  pre-discount total in `formattedOriginalTotal`.
+- `discount.applied` lists each applied discount as a localized `label` and
+  `formattedAmount`.
+- Alternative-period suggestions expose the same optional discount shape on each
+  priced period.
+
+## Changed
+
+- When `discount` is present, `formattedTotal` remains the final price after the
+  listed discounts.
+- Backend modifier types and numeric amounts remain internal; the public search
+  output contains presentation-ready localized strings.
+
+## Migration Impact
+
+- Existing search calls require no changes because `discount` is optional.
+- Search configuration and input are unchanged.
+- Legacy v9 search does not populate `discount`.
+- Sites can opt in to strike-through pricing and discount labels by reading the
+  new field. See `versions/2.11.0/MIGRATION.md` and `../../search.md`.

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

@@ -0,0 +1,72 @@
+# Migration: 2.10.0 to 2.11.0
+
+2.11.0 adds optional localized discount information to priced v10 search results.
+Existing search calls and rendering remain valid without changes.
+
+## 1. Read the Optional Discount
+
+Exact-period items and individual alternative periods may now include:
+
+```ts
+type SearchDiscount = {
+  readonly formattedOriginalTotal: string;
+  readonly applied: readonly {
+    readonly label: string;
+    readonly formattedAmount: string;
+  }[];
+};
+```
+
+The field is omitted when the REST search backend returns no discount. Keep
+rendering `formattedTotal` as before and add discount presentation only when
+`discount` is present.
+
+## 2. Distinguish Final and Original Totals
+
+When a discount is present:
+
+- `formattedTotal` is the final price after the applied discounts.
+- `discount.formattedOriginalTotal` is the total before those discounts.
+- `discount.applied` contains presentation-ready localized labels and formatted
+  amounts.
+
+All monetary values already include locale-aware currency formatting. Backend
+numeric amounts and modifier type keys are intentionally not exposed.
+
+## 3. Handle Exact and Alternative Periods
+
+For a fixed-period match, read the field from the item:
+
+```ts
+result.items[0]?.discount;
+```
+
+For a nearby-period suggestion, read it from the individual period:
+
+```ts
+result.alternatives?.[0]?.alternativePeriods[0]?.discount;
+```
+
+Each alternative period has independent pricing and may have a different discount
+or no discount.
+
+## 4. Keep Search Inputs Unchanged
+
+No configuration or input migration is required. The SDK continues to request the
+existing default v10 search pricing and does not opt search into alternative
+cancellation-policy pricing.
+
+Legacy v9 search does not populate `discount`; consumers supporting both backends
+must treat it as optional.
+
+## Recommended Verification
+
+1. Run a priced v10 exact-period search that has a configured discount and verify
+   the final and original totals.
+2. Verify each applied entry has a localized label and formatted amount in every
+   supported locale.
+3. Run a priced search without a discount and confirm existing rendering is
+   unchanged.
+4. Check nearby alternative periods independently because discounts can differ by
+   period.
+5. If the site supports v9, confirm its existing search output remains unchanged.

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

@@ -121,6 +121,9 @@ The public output type is unchanged, but v10 search cards now reflect the REST p
 - `property` is the minimal `{ id, nameOrLabel }` shape. Hydrate `property.location`, `property.images`, or `property.address` from `sdk.static.rentals.getRentals(...)` when a search card needs them.
 - Exact-period matches are returned in `items` with `formattedTotal`; nearby suggestions are returned in root-level `alternatives`, unchanged.
 
+Starting with 2.11.0, priced v10 items and alternative periods may also include
+optional localized `discount` details. See `../../search.md`.
+
 ## Backend Behavior
 
 - Fixed-period and flexible searches are priced by the REST backend; occupancy is required for priced searches.

package/instructions/CHANGELOG.md

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

package/instructions/MIGRATION.md

@@ -4,6 +4,7 @@ This file is the versioned migration index for the website SDK instructions.
 
 ## Available Guides
 
+- `versions/2.11.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.10.0 to 2.11.0.
 - `versions/2.10.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.9.0 to 2.10.0.
 - `versions/2.9.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.8.0 to 2.9.0.
 - `versions/2.8.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.7.0 to 2.8.0.

package/instructions/README.md

@@ -1,7 +1,7 @@
 # Website SDK Instructions
 
 These instructions describe the current source targeted for
-`@v-office/website-sdk` 2.10.0. Package versions remain unchanged until the release
+`@v-office/website-sdk` 2.11.0. Package versions remain unchanged until the release
 workflow performs the coordinated core and website bumps.
 
 Use this directory as the consumer-facing reference for the package:
@@ -18,6 +18,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.11.0/`: 2.11.0 search-discount release notes and
+  2.10.0-to-2.11.0 migration guide.
 - `versions/2.10.0/`: 2.10.0 option-booking release notes and 2.9.0-to-2.10.0 migration guide.
 - `versions/2.9.0/`: 2.9.0 highlight-selection release notes and 2.8.0-to-2.9.0 migration guide.
 - `versions/2.8.0/`: 2.8.0 custom-attribute release notes and 2.7.0-to-2.8.0 migration guide.
@@ -76,4 +78,6 @@ website-sdk --backend v10 search --locale de-DE --query "adults=2"
 website-sdk --backend v10 search --locale de-DE --query "adults=2" --sort '{"by":"field","orderBy":{"label":"ASC"}}'
 ```
 
-Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.10.0. v10 config additionally requires `searchEndpoint` as of 2.5.0.
+Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced
+in 2.0.0 and kept in 2.11.0. v10 config additionally requires `searchEndpoint` as
+of 2.5.0.

package/instructions/search.md

@@ -227,6 +227,18 @@ The supported fields are `label`, `name`, all six `roomSummary` counters, `attri
 
 Returns `Promise<RentalSearchOutput>`.
 
+Priced items and alternative periods share this optional discount shape:
+
+```ts
+type SearchDiscount = {
+  readonly formattedOriginalTotal: string;
+  readonly applied: readonly {
+    readonly label: string;
+    readonly formattedAmount: string;
+  }[];
+};
+```
+
 Sample:
 
 ```json
@@ -250,7 +262,16 @@ Sample:
         }
       ],
       "highlights": ["2 bedrooms", "WiFi", "Parking"],
-      "formattedTotal": "1.234,00 €"
+      "formattedTotal": "1.111,00 €",
+      "discount": {
+        "formattedOriginalTotal": "1.234,00 €",
+        "applied": [
+          {
+            "label": "Frühbucher-Rabatt",
+            "formattedAmount": "-123,00 €"
+          }
+        ]
+      }
     }
   ],
   "alternatives": [
@@ -264,7 +285,16 @@ Sample:
         {
           "start": "2026-07-10",
           "end": "2026-07-17",
-          "formattedTotal": "1.456,00 €"
+          "formattedTotal": "1.310,00 €",
+          "discount": {
+            "formattedOriginalTotal": "1.456,00 €",
+            "applied": [
+              {
+                "label": "Frühbucher-Rabatt",
+                "formattedAmount": "-146,00 €"
+              }
+            ]
+          }
         }
       ]
     }
@@ -288,7 +318,15 @@ Sample:
 }
 ```
 
-Search items share the rental base fields and may include `scope`, `address`, `property`, `highlights`, and `formattedTotal`. Exact-period results are returned in `items`; alternative-period suggestions are returned in root-level `alternatives`.
+Search items share the rental base fields and may include `scope`, `address`,
+`property`, `highlights`, and `formattedTotal`. A priced item or alternative period
+may also include `discount`. When it does, `formattedTotal` is the final price and
+`discount.formattedOriginalTotal` is the price before the applied discounts.
+Discount totals, labels, and amounts are already localized and formatted for the
+requested locale; backend numeric amounts and modifier type keys are not exposed.
+`applied` may be empty when the backend supplies an original total without
+individual modifier lines. Exact-period results are returned in `items`;
+alternative-period suggestions are returned in root-level `alternatives`.
 
 `appliedFilters` reports what the backend actually applied, and is what a "remove
 this filter" chip should be built from. `label` is localized presentation and can
@@ -319,6 +357,8 @@ v10 search runs against the dedicated REST search backend (`POST` to the configu
 - `property` is the minimal `{ id, nameOrLabel }` shape. Hydrate `property.location`, `property.images`, or `property.address` from `sdk.static.rentals.getRentals(...)` when a card needs them.
 - Custom-attribute search filters and highlights require the `customAttributes` registry. A definition with no catalog ID cannot be executed, so its query key is left in `unusedFilterKeys`. v9 never executes a custom-attribute filter at all. See `custom-attributes.md`.
 - Fixed-period and flexible searches are priced by the REST backend and require occupancy.
+- Priced items and alternative periods may include localized `discount` details when the REST backend returns them. Legacy v9 search does not populate this field.
+- Search inputs are unchanged. The SDK keeps alternative-cancellation-policy pricing out of search; cancellation-policy selection remains part of the quote and booking flow.
 - Pagination uses the backend `from`/`size` window behind the same opaque `cursor`, capped at 1,000 results.
 
 ## Configuration

package/instructions/versions/2.11.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog: 2.11.0
+
+This release exposes localized v10 REST search discount details on priced search
+results.
+
+## Added
+
+- Priced v10 search items may include an optional `discount` with the localized
+  pre-discount total in `formattedOriginalTotal`.
+- `discount.applied` lists each applied discount as a localized `label` and
+  `formattedAmount`.
+- Alternative-period suggestions expose the same optional discount shape on each
+  priced period.
+
+## Changed
+
+- When `discount` is present, `formattedTotal` remains the final price after the
+  listed discounts.
+- Backend modifier types and numeric amounts remain internal; the public search
+  output contains presentation-ready localized strings.
+
+## Migration Impact
+
+- Existing search calls require no changes because `discount` is optional.
+- Search configuration and input are unchanged.
+- Legacy v9 search does not populate `discount`.
+- Sites can opt in to strike-through pricing and discount labels by reading the
+  new field. See `versions/2.11.0/MIGRATION.md` and `../../search.md`.

package/instructions/versions/2.11.0/MIGRATION.md

@@ -0,0 +1,72 @@
+# Migration: 2.10.0 to 2.11.0
+
+2.11.0 adds optional localized discount information to priced v10 search results.
+Existing search calls and rendering remain valid without changes.
+
+## 1. Read the Optional Discount
+
+Exact-period items and individual alternative periods may now include:
+
+```ts
+type SearchDiscount = {
+  readonly formattedOriginalTotal: string;
+  readonly applied: readonly {
+    readonly label: string;
+    readonly formattedAmount: string;
+  }[];
+};
+```
+
+The field is omitted when the REST search backend returns no discount. Keep
+rendering `formattedTotal` as before and add discount presentation only when
+`discount` is present.
+
+## 2. Distinguish Final and Original Totals
+
+When a discount is present:
+
+- `formattedTotal` is the final price after the applied discounts.
+- `discount.formattedOriginalTotal` is the total before those discounts.
+- `discount.applied` contains presentation-ready localized labels and formatted
+  amounts.
+
+All monetary values already include locale-aware currency formatting. Backend
+numeric amounts and modifier type keys are intentionally not exposed.
+
+## 3. Handle Exact and Alternative Periods
+
+For a fixed-period match, read the field from the item:
+
+```ts
+result.items[0]?.discount;
+```
+
+For a nearby-period suggestion, read it from the individual period:
+
+```ts
+result.alternatives?.[0]?.alternativePeriods[0]?.discount;
+```
+
+Each alternative period has independent pricing and may have a different discount
+or no discount.
+
+## 4. Keep Search Inputs Unchanged
+
+No configuration or input migration is required. The SDK continues to request the
+existing default v10 search pricing and does not opt search into alternative
+cancellation-policy pricing.
+
+Legacy v9 search does not populate `discount`; consumers supporting both backends
+must treat it as optional.
+
+## Recommended Verification
+
+1. Run a priced v10 exact-period search that has a configured discount and verify
+   the final and original totals.
+2. Verify each applied entry has a localized label and formatted amount in every
+   supported locale.
+3. Run a priced search without a discount and confirm existing rendering is
+   unchanged.
+4. Check nearby alternative periods independently because discounts can differ by
+   period.
+5. If the site supports v9, confirm its existing search output remains unchanged.

package/instructions/versions/2.5.0/MIGRATION.md

@@ -121,6 +121,9 @@ The public output type is unchanged, but v10 search cards now reflect the REST p
 - `property` is the minimal `{ id, nameOrLabel }` shape. Hydrate `property.location`, `property.images`, or `property.address` from `sdk.static.rentals.getRentals(...)` when a search card needs them.
 - Exact-period matches are returned in `items` with `formattedTotal`; nearby suggestions are returned in root-level `alternatives`, unchanged.
 
+Starting with 2.11.0, priced v10 items and alternative periods may also include
+optional localized `discount` details. See `../../search.md`.
+
 ## Backend Behavior
 
 - Fixed-period and flexible searches are priced by the REST backend; occupancy is required for priced searches.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v-office/website-sdk",
-  "version": "2.10.0",
+  "version": "2.11.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.10.0",
+    "@v-office/sdk-core": "^1.11.0",
     "effect": "4.0.0-beta.85",
     "graphql": "16.14.2",
     "yaml": "^2.9.0"