@v-office/website-sdk 2.11.0 → 2.12.0

package/instructions/versions/2.12.0/MIGRATION.md

@@ -0,0 +1,194 @@
+# Migration: 2.11.0 to 2.12.0
+
+2.12.0 adds optional discount information to priced legacy v9 search results,
+normalizes empty quote booking-card lines across v9 and v10, and completes v10
+card-level pre-modifier totals across all modifier presentation paths. It also
+rejects unsupported v9 flexible-period searches before transport and restores
+empty-query inventory browsing on v9. Existing supported calls remain valid
+without changes.
+
+## 1. Reuse the Shared Discount Output
+
+Legacy v9 now uses the same optional shape introduced for v10 in 2.11.0:
+
+```ts
+type SearchDiscount = {
+  readonly formattedOriginalTotal: string;
+  readonly applied: readonly {
+    readonly label: string;
+    readonly formattedAmount: string;
+  }[];
+};
+```
+
+For exact-period results, read `discount` from the item:
+
+```ts
+result.items[0]?.discount;
+```
+
+For nearby suggestions, read it from the individual alternative period:
+
+```ts
+result.alternatives?.[0]?.alternativePeriods[0]?.discount;
+```
+
+## 2. Understand the Legacy v9 Mapping
+
+For priced v9 results:
+
+- `calc.total` remains the final `formattedTotal`.
+- `discount` is present only when `calc.oTotal` is greater than `calc.total`.
+- `discount.formattedOriginalTotal` is formatted from `calc.oTotal`.
+- A non-empty `calc.discountName` becomes the label of the single applied entry.
+- The applied amount is the formatted negative difference
+  `calc.total - calc.oTotal`.
+- If the backend supplies no usable discount name, `applied` is empty while the
+  formatted original total remains available.
+
+The SDK omits `discount` when there is no final total or when the original total is
+not greater than the final total.
+
+## 3. Account for Backend Detail Differences
+
+v9 exposes one aggregated discount name and therefore returns at most one
+`discount.applied` entry. v10 search can expose multiple `discount.applied`
+entries. Consumers should render the array without assuming a fixed length.
+
+Both backends return presentation-ready localized strings. Backend numeric amounts
+and internal modifier keys are not part of the public output.
+
+## 4. Account for Booking-Card Cleanup
+
+Quote booking cards on both backends now omit numeric zero-value lines without
+subitems from the `other` section, matching the existing handling of included and
+tax sections.
+
+- A zero-only `other` section is omitted.
+- A mixed `other` section retains its non-zero lines unchanged.
+- Lines with subitems remain available because they still carry descriptive
+  content.
+
+No required booking-card property was added and the public schema remains
+source-compatible. Runtime output can contain fewer empty rows. Sites that used a
+zero-value row to represent a declined service should use explicit selection or
+service state instead of inferring that state from the price breakdown.
+
+## 5. Render v10 Quote Modifiers
+
+On v10, an item at `bookingCardInformation.sections[].lines[].item` can include:
+
+```ts
+{
+  modifiers?: readonly {
+    label: string;
+    amount: string;
+  }[];
+  totalBeforeModifiers?: string;
+}
+```
+
+The card can also include `bookingCardInformation.totalBeforeModifiers`.
+`appliedCharge` and `total` are the final amounts after modifiers. The
+corresponding `totalBeforeModifiers` is the formatted amount before modifiers and
+is omitted when there is no non-zero net modifier effect. `modifiers` is omitted
+when the item has none; entries with the same localized label are grouped and
+their amounts are summed before formatting.
+
+Included, tax, and other lines attach their adjustments to `item.modifiers`.
+Negative modifiers from backend lines that do not map to those sections may
+instead appear as dedicated booking-card lines. In 2.12.0, card-level
+`totalBeforeModifiers` accounts for both forms. v9 quote cards omit these fields.
+
+Example for `de-DE`:
+
+```json
+{
+  "bookingCardInformation": {
+    "sections": [
+      {
+        "lines": [
+          {
+            "item": {
+              "position": "Inklusivpreis",
+              "appliedCharge": "1.554,00 €",
+              "modifiers": [
+                {
+                  "label": "Frühbucher/Last-Minute",
+                  "amount": "-140,00 €"
+                }
+              ],
+              "totalBeforeModifiers": "1.694,00 €"
+            }
+          }
+        ]
+      }
+    ],
+    "total": "1.596,70 €",
+    "totalBeforeModifiers": "1.736,70 €"
+  }
+}
+```
+
+Do not assume a voucher appears as its own section line. Use
+`quote.voucher.status` for voucher application status and the booking-card fields
+for price presentation. To keep price arithmetic visible, render the pre-modifier
+amount, modifier rows, and final amount separately. Whether to display or strike
+through a reference price remains the consuming site's product and legal
+decision.
+
+## 6. Keep Flexible Search Disabled on v9
+
+No configuration or supported request migration is required. Legacy v9 now rejects
+the unsupported flexible-period keys `month`, `dates`, `nights`, and `weekend`
+before transport instead of silently returning an unpriced item list. Keep
+flexible search unavailable on v9 sites and use fixed `start`/`end` period
+queries. v10 flexible search is unchanged.
+
+The rejection is a `CoreSDKError` with operation `v9.search` and occurs before a
+GraphQL request is sent. The public `SearchSearchInput` type remains unchanged
+because its `query` field is an opaque query string.
+
+This release enriches v9 search output when its existing response contains
+sufficient discount data, removes empty quote breakdown rows from both backends,
+and can return the existing optional card-level `totalBeforeModifiers` in
+additional v10 cases.
+
+## 7. Remove Dummy Occupancy from Empty v9 Searches
+
+Legacy v9 now sends an empty backend-filter set as GraphQL `data: null` instead of
+`data: []`. An empty query can therefore browse the first page of searchable
+inventory under the configured rental scope:
+
+```ts
+await sdk.live.search.search({
+  locale: "de-DE",
+  query: "",
+});
+```
+
+Remove workarounds that inject `adults=1` only to make an empty query return
+results. Real occupancy, period, and non-empty backend filters keep their existing
+mapping. Pagination and `limit` still apply, and an undated result does not assert
+availability for a particular stay.
+
+## Recommended Verification
+
+1. Run a priced v9 exact-period search where the original total exceeds the final
+   total and verify the formatted values and label.
+2. Verify discounted v9 alternative periods independently.
+3. Run a v9 search without a discount and confirm existing rendering is unchanged.
+4. Verify a missing v9 discount name produces an empty `applied` array.
+5. Verify v9 rejects `month`, `dates`, `nights`, and `weekend` before transport.
+6. Run an empty v9 query and confirm it returns searchable inventory without a
+   dummy occupancy value.
+7. Recheck a discounted v10 search and confirm its existing multi-entry behavior
+   remains unchanged.
+8. Quote a v9 and v10 rental with a zero-value `other` service and confirm the
+   empty section is absent.
+9. Confirm a mixed `other` section retains only its non-zero lines.
+10. Quote a discounted v10 rental and render `item.modifiers`, item-level
+    `totalBeforeModifiers`, and card-level `totalBeforeModifiers`.
+11. Confirm a v9 quote continues to omit the modifier fields.
+12. Verify a v10 modifier rendered as a dedicated line still contributes to the
+    card-level `totalBeforeModifiers`.

package/instructions/versions/2.5.0/MIGRATION.md

@@ -124,6 +124,9 @@ The public output type is unchanged, but v10 search cards now reflect the REST p
 Starting with 2.11.0, priced v10 items and alternative periods may also include
 optional localized `discount` details. See `../../search.md`.
 
+Starting with 2.12.0, legacy v9 maps the same optional shape from its aggregated
+original total and discount name when the original total exceeds the final total.
+
 ## 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.11.0",
+  "version": "2.12.0",
   "description": "Website-facing SDK facade backed by @v-office/sdk-core",
   "bin": {
     "website-sdk": "./dist/cli.mjs"
@@ -41,21 +41,23 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "3.2.0",
-    "@v-office/sdk-core": "^1.11.0",
+    "@v-office/sdk-core": "^1.12.0",
     "effect": "4.0.0-beta.85",
-    "graphql": "16.14.2",
+    "graphql": "17.0.2",
     "yaml": "^2.9.0"
   },
   "devDependencies": {
-    "@effect/language-service": "0.86.2",
-    "@graphql-codegen/cli": "7.1.3",
-    "@graphql-codegen/client-preset": "6.0.1",
-    "@types/node": "26.0.0",
-    "@typescript/native-preview": "7.0.0-dev.20260622.1",
-    "oxfmt": "0.55.0",
-    "oxlint": "1.70.0",
-    "tsdown": "0.22.3",
-    "typescript": "6.0.3"
+    "@effect/tsgo": "0.31.0",
+    "@graphql-codegen/cli": "7.2.0",
+    "@graphql-codegen/client-preset": "6.1.1",
+    "@types/node": "26.1.2",
+    "oxfmt": "0.62.0",
+    "oxlint": "1.77.0",
+    "tsdown": "0.22.14",
+    "typescript": "7.0.2"
+  },
+  "engines": {
+    "node": "^22.0.0 || ^24.0.0 || ^25.0.0 || >=26.0.0"
   },
   "scripts": {
     "p": "pnpm run playground:json",
@@ -72,7 +74,7 @@
     "lint:fix": "oxlint --fix .",
     "fmt": "oxfmt",
     "fmt:check": "oxfmt --check",
-    "check": "pnpm run typecheck && pnpm run lint",
+    "check": "pnpm run typecheck && pnpm run lint && pnpm run fmt:check",
     "test": "pnpm run build && node --test test/*.test.mjs",
     "playground:custom-attributes": "pnpm run build && node --env-file=.env playground/custom-attributes.ts"
   }