@v-office/website-sdk 2.21.0 → 2.23.0

package/instructions/versions/2.23.0/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog: 2.23.0
+
+A search that the backend has not answered before is slow: the v9 backend prices
+the rentals of one request one after another, about 40–75 ms per rental, and caches
+only whole searches. A site that shows every result with its price on a map had to
+request all of them in one call, which took 3–9 s for a portfolio of about 70
+rentals on v9. Separate requests are priced in parallel, and a search that selects
+no prices costs almost nothing. This release uses both, with the same API on v9 and
+v10 so a site keeps its code when it switches backend: small portfolios get every
+priced result in one call, large portfolios get a map search next to a paged list.
+
+Measured against a v9 hub with 74 rentals, first request for a date range: 71
+results in 8.6 s with one request, 2.1 s with `searchAllRentalsAtOnce`. A search
+with few results gains nothing and costs the count request: 18 results in 1.4 s
+before, 1.7 s now.
+
+## Added
+
+- The `searchAllRentalsAtOnce` option (default `false`), on v9 and v10. With
+  `true`, `sdk.live.search.search` returns every result with its price in one call
+  and takes no `cursor` or `limit`. A search that matches more than
+  `SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS` (100) rentals, or a passed `cursor` or
+  `limit`, rejects with the `CoreSDKError` operation `search.allRentalsAtOnce`. The
+  whole call counts as one request for the search rate limit.
+  - v9: counts the matches without prices, then fetches the priced results as
+    parallel backend pages of ten, at most eight at a time. An oversized search is
+    refused before any price is requested. When a booking between the requests
+    shifts rentals across page boundaries, it asks for all results in one request
+    instead.
+  - v10: one request for 101 results; refused when the response total is above 100.
+- `sdk.live.search.mapSearch({ locale, query })` in the default mode, on v9 and
+  v10: every rental the search matches, with `id` and `location`, plus
+  `totalCount`, `appliedFilters` and `unusedFilterKeys`, without prices. It
+  rejects with the operation `search.mapSearch` when the SDK was created with
+  `searchAllRentalsAtOnce: true`. v9 loads up to 1,000 matches per backend request;
+  v10 answers up to 1,000 matches, its result window.
+- `pageInfo.totalCount` on every search output: the number of rentals the backend
+  matched over all pages.
+- The types `WebsiteSDKAllRentalsAtOnce`, `WebsiteSDKV9AllRentalsAtOnce`,
+  `WebsiteSDKV10AllRentalsAtOnce` with their `...Live` types and
+  `V9SearchAllRentalsAtOnceInput`, and from `@v-office/sdk-core` 1.24.0
+  `SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS`, `SearchMapSearchInput`,
+  `SearchMapSearchOutput`, `SearchMapSearchOutputItem`,
+  `SearchAllRentalsAtOnceInput` and the matching schemas. `createWebsiteSDK`
+  returns an `...AllRentalsAtOnce` type when `searchAllRentalsAtOnce: true` is
+  written in the options; it has no `mapSearch` and no `cursor`/`limit`.
+
+## Changed
+
+- `v9`: a search requests only the rental data the search output reads (`name`,
+  `address`, `regionName`, `images`, the attribute behind each configured rental
+  highlight, configured custom attributes and `rentalDataAttributes`) instead of
+  every known attribute: 56 instead of 450 attributes with the default highlights,
+  and a response of 52 KB instead of 164 KB gzipped (624 KB instead of 1,471 KB
+  uncompressed) for 71 rentals. The output is unchanged.
+- Requires `@v-office/sdk-core` 1.24.0.
+
+## Unchanged
+
+- A paged search in the default mode, on v9 and v10: same request per call, same
+  items, alternatives and prices; `pageInfo` gains `totalCount`. On v9 verified
+  against the hub with 2.22.0 side by side.

package/instructions/versions/2.23.0/MIGRATION.md

@@ -0,0 +1,33 @@
+# Migration: 2.22.0 to 2.23.0
+
+## 1. Upgrade
+
+```sh
+pnpm add @v-office/website-sdk@2.23.0
+```
+
+No changes are required. The default mode searches as before, and the search
+output only gains `pageInfo.totalCount`.
+
+## 2. Show every result with its price on list and map (up to 100 rentals)
+
+Create the SDK with `searchAllRentalsAtOnce: true` and drop the pagination loop:
+one `search` call returns every result with `pageInfo.hasNextPage: false`. Remove
+`cursor` and `limit` from the input; the call rejects them. The same code works on
+v9 and v10.
+
+```ts
+const sdk = createWebsiteSDK({ config, options: { searchAllRentalsAtOnce: true } });
+const { items, alternatives, pageInfo } = await sdk.live.search.search({ locale, query });
+```
+
+## 3. Map for a larger portfolio (default mode)
+
+Load the map with `mapSearch` and page the list with `search`. Use `totalCount`
+from `mapSearch` to load a search with few matches in one call and show its prices
+on the map; see `search.md`, "All Rentals At Once Or Map Search".
+
+```ts
+const map = await sdk.live.search.mapSearch({ locale, query });
+// map.items: { id, location? }[] for every match; map.totalCount
+```

package/instructions/versions/2.23.0/release.json

@@ -0,0 +1,3 @@
+{
+  "componentsAffectedByHeadlessChange": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v-office/website-sdk",
-  "version": "2.21.0",
+  "version": "2.23.0",
   "description": "Website-facing SDK facade backed by @v-office/sdk-core",
   "bin": {
     "website-sdk": "./dist/cli.mjs"
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "3.2.0",
-    "@v-office/sdk-core": "1.23.0",
+    "@v-office/sdk-core": "1.24.0",
     "effect": "4.0.0-rc.115",
     "graphql": "17.0.2",
     "yaml": "^2.9.0"
@@ -69,7 +69,11 @@
     "build": "tsdown",
     "codegen:v9:properties": "node codegen/v9/heuristic-generation/generate/index.ts && oxfmt codegen/v9/heuristic-generation/v9-data.ts",
     "codegen:v9:graphql": "graphql-codegen --config codegen/v9/graphql-codegen/codegen.ts",
-    "codegen": "pnpm run codegen:v9:properties && pnpm run codegen:v9:graphql",
+    "codegen:v9:v0:types": "pnpm --package=typescript@6.0.3 --package=openapi-typescript@7.13.0 dlx openapi-typescript codegen/v9/v0/openapi.yaml -o codegen/v9/v0/generated/openapi-types.ts && oxfmt codegen/v9/v0/generated/openapi-types.ts",
+    "codegen:v9:v0": "node codegen/v9/v0/generate/index.ts && oxfmt codegen/v9/v0/generated/v0-data.ts",
+    "codegen:v9:v1:types": "pnpm --package=typescript@6.0.3 --package=openapi-typescript@7.13.0 dlx openapi-typescript codegen/v9/v1/openapi.yaml -o codegen/v9/v1/generated/openapi-types.ts && oxfmt codegen/v9/v1/generated/openapi-types.ts",
+    "codegen:v9:v1": "node codegen/v9/v1/generate/index.ts && oxfmt codegen/v9/v1/generated/v1-data.ts",
+    "codegen": "pnpm run codegen:v9:properties && pnpm run codegen:v9:graphql && pnpm run codegen:v9:v0:types && pnpm run codegen:v9:v0 && pnpm run codegen:v9:v1:types && pnpm run codegen:v9:v1",
     "dev": "tsdown --watch",
     "typecheck": "tsc --noEmit",
     "lint": "oxlint .",