@v-office/website-sdk 2.22.0 → 2.23.0

package/dist/instructions/creation.md

@@ -110,9 +110,14 @@ type WebsiteSDKOptions = {
   rentalPropertyHighlightPrioritization?: readonly RentalPropertyHighlightPrioritizationKey[];
   rentalScope?: RentalScope;
   shouldAddProposedAdditionalServiceAmount?: boolean;
+  searchAllRentalsAtOnce?: boolean;
 };
 ```
 
+`searchAllRentalsAtOnce` selects how a site searches, on v9 and v10 alike: every
+result with prices in one call (portfolios of up to 100 rentals), or paged results
+plus `mapSearch`. See `search.md`.
+
 `rentalHighlightPrioritization` and `rentalPropertyHighlightPrioritization` select
 which facts become highlights and set their order. They are ordered allowlists, not
 sorts over every available fact. A key that is not listed is not emitted even when
@@ -135,6 +140,7 @@ Unset options are normalized by the SDK:
 - `rentalPropertyHighlightPrioritization` defaults to the SDK default property highlight selection.
 - `rentalScope` defaults to `{}`.
 - `shouldAddProposedAdditionalServiceAmount` defaults to `false`.
+- `searchAllRentalsAtOnce` defaults to `false`.
 - `translationOverrides` is omitted unless provided.
 
 ### v9 Property Highlight Sources

package/dist/instructions/search.md

@@ -403,6 +403,9 @@ fixed-period search without a window, the dates are the requested ones and
 }
 ```
 
+`pageInfo.totalCount` is the number of rentals the backend matched for the search
+over all pages.
+
 `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
 repeat, so it cannot identify a filter; `key` plus `value` can. `value` is the
@@ -424,6 +427,84 @@ the expanded leaf entries. A UI may collapse those leaves under the composition
 display, but should keep the returned keys and canonical values when removing direct
 filters.
 
+## All Rentals At Once Or Map Search
+
+A search that prices many results is slow the first time the backend sees it, and
+a list next to a map should not wait for every price. An SDK therefore works in one
+of two modes, chosen with the `searchAllRentalsAtOnce` option (default `false`).
+Both modes behave the same on v9 and v10, so a site keeps its code when it moves
+from one backend to the other.
+
+### `searchAllRentalsAtOnce: true`
+
+For portfolios of up to `SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS` (100) rentals.
+`sdk.live.search.search` returns every result with its price in one call, so a list
+and a map can show all results with prices at the same time:
+
+```ts
+const sdk = createWebsiteSDK({ config, options: { searchAllRentalsAtOnce: true } });
+const output = await sdk.live.search.search({ locale: "de-DE", query: "adults=2" });
+// output.pageInfo: { hasNextPage: false, totalCount }
+```
+
+- The input has no `cursor` and no `limit`; passing either rejects the call with a
+  `CoreSDKError` whose `operation` is `search.allRentalsAtOnce`.
+- When the search matches more than 100 rentals, the call rejects with the same
+  `operation`. Use the default mode for such a portfolio.
+- `mapSearch` is not available: with `searchAllRentalsAtOnce: true` written in the
+  code, the returned `WebsiteSDKV9AllRentalsAtOnce`, `WebsiteSDKV10AllRentalsAtOnce`
+  or `WebsiteSDKAllRentalsAtOnce` type has no `mapSearch` and no `cursor`/`limit`;
+  when the value is only known at runtime, `mapSearch` rejects with the `operation`
+  `search.mapSearch`.
+- The call counts as one request for the search rate limit.
+
+### `searchAllRentalsAtOnce: false` (default)
+
+`sdk.live.search.search` is paged as before. `sdk.live.search.mapSearch` returns
+every rental the search matches, with its location and without prices:
+
+```ts
+const map = await sdk.live.search.mapSearch({ locale: "de-DE", query: "adults=2" });
+// map: { items: { id, location? }[], totalCount, appliedFilters, unusedFilterKeys }
+```
+
+`mapSearch` takes the same `query` as `search`, so map and list use the same
+filters. Because it arrives before any result is priced, its `totalCount` can also
+decide how to load the list: at most `SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS`
+matches can be loaded in one `search` call with that `limit` and shown with prices on
+the map (matched by `id`); more matches are paged, with a map without prices.
+
+```ts
+const map = await sdk.live.search.mapSearch({ locale, query });
+if (map.totalCount <= SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS) {
+  const all = await sdk.live.search.search({
+    locale,
+    query,
+    limit: SEARCH_ALL_RENTALS_AT_ONCE_MAX_RESULTS,
+  });
+} else {
+  const page = await sdk.live.search.search({ locale, query, limit: 24, cursor });
+}
+```
+
+In this mode a `search` call is one backend request, whatever its `limit`.
+
+### How each backend does it
+
+- v9 prices the rentals of one request one after another, but separate requests in
+  parallel. `searchAllRentalsAtOnce` counts the matches without prices first, then
+  fetches the priced results as backend pages of ten, at most eight at a time, and
+  merges them in backend order; an oversized search is refused before any price is
+  requested. When a booking between the requests moves rentals across page
+  boundaries, the pages disagree with the count; the SDK then asks for all results in
+  one request, a consistent snapshot, instead of returning a set with a gap. `mapSearch` selects no prices and loads up to 1,000 matches per request,
+  as many requests as the matches need.
+- v10 answers the whole result set in one request. `searchAllRentalsAtOnce` asks for
+  101 results and refuses the search when the response total is above 100.
+  `mapSearch` is one request without prices that returns only the location, for up
+  to 1,000 matches: the backend's result window, so `items` holds at most 1,000
+  rentals while `totalCount` can be higher.
+
 ## Backend Behavior
 
 ### v10
@@ -482,6 +563,9 @@ shape:
   length, not the stay itself. The backend returns the bookable stays inside the
   window, earliest first; the SDK keeps that order.
 - v9 never executes a custom-attribute search filter.
+- A search requests only the rental data the search output reads: `name`,
+  `address`, `regionName`, `images`, the attribute behind each configured rental
+  highlight, the configured custom attributes and `rentalDataAttributes`.
 
 The field is omitted when v9 returns no final total or when its original total is
 not greater than the final total. v9 exposes at most one aggregated applied entry,
@@ -493,7 +577,7 @@ Use flat `WebsiteSDKConfig` files and optional `WebsiteSDKOptions`.
 
 For v10, config requires `searchEndpoint` (the full REST search URL) as of 2.5.0. See `creation.md` for `searchEndpoint` and the `customAttributes` option.
 
-Custom filter definitions can extend accepted search query keys. Search requests are rate-limited to one backend request per second with a queue size of five.
+Custom filter definitions can extend accepted search query keys. Search requests are rate-limited to one backend request per second with a queue size of five. A `searchAllRentalsAtOnce` search and a `mapSearch` each count as one request, including every backend request they make.
 
 ## CLI Usage
 

package/dist/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/dist/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/dist/{rentals-DfNu7s7w.mjs → rentals-C1W7EvIC.mjs}

@@ -1,6 +1,6 @@
-import { Ut as V9_FACILITY_ATTRIBUTE_KEYS } from "./client-BtZ30vTP.mjs";
+import { Wt as V9_FACILITY_ATTRIBUTE_KEYS } from "./client-CGO5Pmuv.mjs";
 import { c as parseVofficeUnitData, i as VofficeUnitDataPropertyMetadata, n as VofficeUnitDataPropertyCategoryLabelKeys, o as parseVofficeFacilityData, r as VofficeUnitDataPropertyCategoryValues, s as parseVofficeFeedbackData, t as VofficeUnitDataFieldSchemas } from "./v9-data-BnYxa2Ek.mjs";
-import { a as toAddress, c as rentalFacilitiesForObjectGroupRelationQuery, d as rentalsAllFeedbacksQuery, f as rentalsAllWithoutFeedbacksQuery, i as toImages, l as rentalIdsQuery, n as renderVofficePropertyAttribute, o as toLocalizedString, r as toFacilityImages, t as toRentalHighlights, u as rentalsAllByFacilityObjectGroupsWithoutFeedbacksQuery } from "./to-rental-highlights-CN-wpRh3.mjs";
+import { a as toFacilityImages, c as toLocalizedString, d as rentalFacilitiesForObjectGroupRelationQuery, f as rentalIdsQuery, h as rentalsAllWithoutFeedbacksQuery, i as toLocation, m as rentalsAllFeedbacksQuery, o as toImages, p as rentalsAllByFacilityObjectGroupsWithoutFeedbacksQuery, r as renderVofficePropertyAttribute, s as toAddress, t as toRentalHighlights } from "./to-rental-highlights-C1NF2uuE.mjs";
 import { CoreSDKError, makeTranslate, renderResolvedCustomAttribute, toCustomAttributeList, toResolvedCustomAttributeCategoryTranslationKey } from "@v-office/sdk-core";
 import { Effect } from "effect";
 //#region src/legacy-v9/parser/rentals/to-description.ts
@@ -25,16 +25,6 @@ const toDescription = (data, locale) => {
 	return description;
 };
 //#endregion
-//#region src/legacy-v9/parser/rentals/to-location.ts
-const toLocation = (location) => {
-	if (location == null) return void 0;
-	const [longitude, latitude] = location.coordinates;
-	return {
-		latitude,
-		longitude
-	};
-};
-//#endregion
 //#region src/legacy-v9/parser/rentals/to-property-attributes.ts
 const toPropertyAttributes = ({ attributes, locale, translations }) => Effect.gen(function* () {
 	const items = [];

package/dist/{search-CZ1TRGAB.mjs → search-GjMxosfU.mjs}

@@ -1,6 +1,6 @@
-import { a as parseQueryParameters, i as collectQueryParameters, n as makeV9CustomAttributeFilterCapabilities, o as toQueryString, r as toBasicQueryInputs, s as applyVofficeFilterDerivedBasicQueryInputs } from "./client-BtZ30vTP.mjs";
-import { c as parseVofficeUnitData, t as VofficeUnitDataFieldSchemas } from "./v9-data-BnYxa2Ek.mjs";
-import { a as toAddress, i as toImages, s as searchQuery, t as toRentalHighlights } from "./to-rental-highlights-CN-wpRh3.mjs";
+import { a as parseQueryParameters, i as collectQueryParameters, n as makeV9CustomAttributeFilterCapabilities, o as toQueryString, r as toBasicQueryInputs, s as applyVofficeFilterDerivedBasicQueryInputs } from "./client-CGO5Pmuv.mjs";
+import { c as parseVofficeUnitData } from "./v9-data-BnYxa2Ek.mjs";
+import { i as toLocation, l as mapSearchQuery, n as toV9RentalHighlightKey, o as toImages, s as toAddress, t as toRentalHighlights, u as searchQuery } from "./to-rental-highlights-C1NF2uuE.mjs";
 import { CoreSDKError, STABLE_SEARCH_INPUTS, daysBetweenLocalDates, expandCustomAttributeFilterCompositions, parseChildrenAges, parseOccupancyCount, resolveExpandedCompositions, toFormattedSearchPrice, toIsoDateFromPeriodQueryDate, toStableSearchInputBackendQueryKeys, toStableSearchInputParameterValues, toStableSearchInputQueryKeys, toUnusedFilterKeys } from "@v-office/sdk-core";
 import { Effect } from "effect";
 //#region src/legacy-v9/parser/search/input/search-input-error.ts
@@ -322,6 +322,18 @@ const toSearchPeriods = ({ locale, periods }) => Effect.succeed((periods ?? []).
 }));
 //#endregion
 //#region src/legacy-v9/runtime/search.ts
-const defaultSearchDataAttributes = Object.keys(VofficeUnitDataFieldSchemas);
+/**
+* The rental data `toSearchOutputItem` reads: name, address with the region name,
+* images, and the v9 attribute behind each configured highlight key. Requesting
+* every known attribute instead more than doubles the response for the same output.
+*/
+const toSearchDataAttributes = (rentalHighlightPrioritization) => [.../* @__PURE__ */ new Set([
+	"name",
+	"address",
+	"regionName",
+	"images",
+	...rentalHighlightPrioritization.flatMap((key) => toV9RentalHighlightKey(key) ?? [])
+])];
+const mapSearchDataAttributes = ["loc"];
 //#endregion
-export { defaultSearchDataAttributes, resolveExactMatch, searchQuery, toQueryInput, toSearchOutputItem, toSearchPeriods };
+export { mapSearchDataAttributes, mapSearchQuery, parseVofficeUnitData, resolveExactMatch, searchQuery, toLocation, toQueryInput, toSearchDataAttributes, toSearchOutputItem, toSearchPeriods };