@v-office/website-sdk 2.37.0 → 2.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dist/cli.mjs +3 -3
  2. package/dist/{client-D53W9Uas.mjs → client-CE4V_ybW.mjs} +175 -77
  3. package/dist/index.d.mts +46 -2
  4. package/dist/index.mjs +1 -1
  5. package/dist/instructions/CHANGELOG.md +2 -0
  6. package/dist/instructions/MIGRATION.md +2 -0
  7. package/dist/instructions/quote.md +7 -0
  8. package/dist/instructions/rentals.md +65 -4
  9. package/dist/instructions/search.md +2 -1
  10. package/dist/instructions/versions/2.37.1/CHANGELOG.md +11 -0
  11. package/dist/instructions/versions/2.37.1/MIGRATION.md +10 -0
  12. package/dist/instructions/versions/2.38.0/CHANGELOG.md +123 -0
  13. package/dist/instructions/versions/2.38.0/MIGRATION.md +37 -0
  14. package/dist/{operations-C1VMQYN2.mjs → operations-DMqLD3e2.mjs} +333 -1
  15. package/dist/{rentals-BxkYXAVn.mjs → rentals-BsHvdwQt.mjs} +10 -14
  16. package/dist/{search-pFLiI6QI.mjs → search-DqdRIJwF.mjs} +8 -4
  17. package/dist/{to-rental-highlights-BdxQPpBU.mjs → to-rental-highlights-BE6TdXYa.mjs} +23 -5
  18. package/dist/translations/shared/de-DE/insurance.json +1 -0
  19. package/dist/translations/shared/de-DE/reviews.json +5 -4
  20. package/dist/translations/shared/en-US/insurance.json +1 -0
  21. package/dist/translations/shared/en-US/reviews.json +5 -4
  22. package/dist/translations/v10/de-DE/core.json +17 -4
  23. package/dist/translations/v10/en-US/core.json +53 -40
  24. package/dist/translations/v9/de-DE/core.json +0 -6
  25. package/dist/translations/v9/de-DE/filter.json +4 -0
  26. package/dist/translations/v9/de-DE/rental-attributes.json +2 -2
  27. package/dist/translations/v9/en-US/core.json +0 -6
  28. package/dist/translations/v9/en-US/filter.json +4 -0
  29. package/dist/translations/v9/en-US/rental-attributes.json +2 -2
  30. package/instructions/CHANGELOG.md +2 -0
  31. package/instructions/MIGRATION.md +2 -0
  32. package/instructions/quote.md +7 -0
  33. package/instructions/rentals.md +65 -4
  34. package/instructions/search.md +2 -1
  35. package/instructions/versions/2.37.1/CHANGELOG.md +11 -0
  36. package/instructions/versions/2.37.1/MIGRATION.md +10 -0
  37. package/instructions/versions/2.37.1/release.json +3 -0
  38. package/instructions/versions/2.38.0/CHANGELOG.md +123 -0
  39. package/instructions/versions/2.38.0/MIGRATION.md +37 -0
  40. package/instructions/versions/2.38.0/release.json +3 -0
  41. package/package.json +3 -3
@@ -372,6 +372,13 @@ The selected policy is marked with `selected: true`, and the booking card total
372
372
 
373
373
  Insurance information is exposed on `quote.insurance` when available. The `options` array contains either a `none` option or selectable insurance products.
374
374
 
375
+ The `none` option's text comes from the translation table, in the quote's locale, so `translationOverrides` can change it:
376
+
377
+ | When | Keys | de-DE | en-US |
378
+ | ---------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------- | -------------------------------------- |
379
+ | Insurance products are offered (v9 with ERGO or URV) | `insurance.none.label`, `insurance.none.description` | Ich verzichte auf den angebotenen Reiseschutz | I decline the offered travel insurance |
380
+ | Nothing is offered (v10, v9 without a provider) | `insurance.notOffered.label` | Keine Versicherung | No insurance |
381
+
375
382
  ```json
376
383
  {
377
384
  "options": [
@@ -56,6 +56,12 @@ Sample item:
56
56
  "headline": "Holiday apartment near the sea",
57
57
  "description": "Short localized rental description."
58
58
  },
59
+ "capacity": {
60
+ "maxGuests": 4,
61
+ "bedrooms": 2,
62
+ "bathrooms": 1,
63
+ "livingAreaSqm": 61
64
+ },
59
65
  "highlights": ["2 bedrooms", "Wi-Fi", "Parking"],
60
66
  "attributes": [
61
67
  {
@@ -72,7 +78,7 @@ Sample item:
72
78
  "items": [
73
79
  {
74
80
  "id": "form-response-1",
75
- "author": "Ada Lovelace, visited in July 2026",
81
+ "author": "Ada Lovelace, stayed in July 2026",
76
82
  "rating": "5",
77
83
  "createdAt": "2026-07-10T10:00:00.000Z",
78
84
  "text": "Great stay."
@@ -81,7 +87,7 @@ Sample item:
81
87
  "summary": {
82
88
  "rating": "4.8",
83
89
  "count": "12",
84
- "classification": "Excellent"
90
+ "classification": "Exceptional"
85
91
  }
86
92
  }
87
93
  }
@@ -89,6 +95,50 @@ Sample item:
89
95
 
90
96
  Optional fields include `scope`, `address`, `property`, `rooms`, `roomSummary`, `vicinity`, and `reviews`.
91
97
 
98
+ ### Texts in another language
99
+
100
+ When a rental or its property has no text in the requested locale, the SDK returns the German
101
+ text and lists the field in `descriptionFallbacks` (on the rental and on `property`), so a site
102
+ can mark it as German (`lang="de"`, a note):
103
+
104
+ ```json
105
+ {
106
+ "description": {
107
+ "headline": "Flat with sea view",
108
+ "description": "Ruhige Wohnung am Deich."
109
+ },
110
+ "descriptionFallbacks": { "description": "de-DE" }
111
+ }
112
+ ```
113
+
114
+ Only fields served in another language are listed; `descriptionFallbacks` is omitted when every
115
+ text is in the requested locale, and always for `de-DE`.
116
+
117
+ - v10 reads every language of a text and takes the German one when the requested one is empty.
118
+ - v9: the be-on! Hub already answers a missing translation with the German text, without saying
119
+ so. For a locale other than `de-DE`, `getRentals` and `getRentalsByIds` also ask the Hub for
120
+ the German texts and mark every field whose text is the same. This is one extra Hub query, of the texts alone, per
121
+ 128 rentals (and one facility query with `facilityObjectGroupRelationAttributeId`), only for
122
+ non-German locales.
123
+
124
+ Rental names, region names and attribute texts are not covered.
125
+
126
+ ### Capacity
127
+
128
+ `capacity` states the counts as numbers: `maxGuests`, `maxAdults`, `bedrooms`, `bathrooms`,
129
+ `rooms` and `livingAreaSqm`. Read counts from here, not from the text of `highlights` or
130
+ `roomSummary`: the numbers do not change with the locale or with `translationOverrides`. A
131
+ count the backend does not state, or states as 0, is omitted, never 0.
132
+
133
+ | Field | v10 | v9 |
134
+ | -------------------------------- | ----------------------------------------------------- | ------------------------------------- |
135
+ | `maxGuests` | room summary `maxPersons` (bed capacity) | unit `beds` (sleeping places) |
136
+ | `maxAdults` | room summary `maxAdults` (beds not for children only) | never stated |
137
+ | `bedrooms`, `bathrooms`, `rooms` | room summary | unit `bedrooms`, `bathrooms`, `rooms` |
138
+ | `livingAreaSqm` | `attributes.squareMeters` | unit `squareMeters` |
139
+
140
+ Search items carry the same `capacity`.
141
+
92
142
  ### Legacy v9 Images
93
143
 
94
144
  v9 rental `images` and facility `property.images` come from vOffice's image service
@@ -144,7 +194,8 @@ From 2.18.0, v9 static rentals populate additional fields on the existing
144
194
  `HOUSE_FAC` and `FLAT_FAC` normalize to `HOLIDAY_HOME_COMPLEX` and
145
195
  `APARTMENT_COMPLEX`. The normalized value is localized through
146
196
  `Property.propertyType.option.*`; for example, `HOLIDAY_HOME_COMPLEX` is
147
- returned as `Ferienpark` for `de-DE`. Unknown types and malformed optional data
197
+ returned as `Ferienhausanlage` for `de-DE`. From 2.38.0 v10 localizes
198
+ `property.propertyType` the same way instead of returning the enum. Unknown types and malformed optional data
148
199
  are omitted. This fills the existing property schema and does not add public
149
200
  fields.
150
201
 
@@ -355,7 +406,17 @@ type RentalReview =
355
406
 
356
407
  For v10, public answers with the same form-response ID are combined into one review item. Its `rating` is the average of the valid `STARS` answers in that response, and its `text` contains the non-empty `TEXT` answers. Missing public customer data leaves `author` undefined.
357
408
 
358
- `createdAt` is the form response'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 form responses with valid ratings and does not necessarily equal `items.length`.
409
+ `createdAt` is the form response'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 form responses with valid ratings and does not necessarily equal `items.length`. It reads `reviews.summary.count.one` for one rating and `reviews.summary.count` otherwise.
410
+
411
+ `summary.classification` is the rating band, translated as `reviews.summary.classification.<band>`, on both backends:
412
+
413
+ | Average | Band | de-DE | en-US |
414
+ | ------- | ----------- | ------------ | ----------- |
415
+ | ≥ 4.5 | `excellent` | Hervorragend | Exceptional |
416
+ | ≥ 4.0 | `very-good` | Sehr gut | Very good |
417
+ | ≥ 3.0 | `good` | Gut | Good |
418
+ | ≥ 2.0 | `fair` | Ordentlich | Decent |
419
+ | < 2.0 | `poor` | Ausreichend | Adequate |
359
420
 
360
421
  ### Legacy v9 Reviews
361
422
 
@@ -710,7 +710,8 @@ Sample:
710
710
  ```
711
711
 
712
712
  Search items share the rental base fields and may include `scope`, `address`,
713
- `property`, `highlights`, and `formattedTotal`. A priced item or alternative period
713
+ `capacity` (counts as numbers, see the rentals instructions), `property`, `highlights`,
714
+ and `formattedTotal`. A priced item or alternative period
714
715
  may also include `discount`. When it does, `formattedTotal` is the final price and
715
716
  `discount.formattedOriginalTotal` is the price before the applied discounts.
716
717
  Discount totals, labels, and amounts are already localized and formatted for the
@@ -0,0 +1,11 @@
1
+ # Changelog: 2.37.1
2
+
3
+ A fix release: `sdk.static.regions.getRegions` reads v10 region trees again.
4
+
5
+ ## Fixed
6
+
7
+ - v10: `sdk.static.regions.getRegions` rejected every tree that holds regions with
8
+ `The website regions response did not match the region tree contract`, caused by
9
+ `Region <key> has no name`. The API gateway sends region names as JSON text, and 2.37.0
10
+ only read an object. Site builds that read a v10 region tree pass again. Empty trees and
11
+ v9 were not affected.
@@ -0,0 +1,10 @@
1
+ # Migration: 2.37.0 to 2.37.1
2
+
3
+ No changes required. A v10 site that reads `sdk.static.regions.getRegions` needs this version
4
+ for its build to pass once its website has regions.
5
+
6
+ ## 1. Upgrade
7
+
8
+ ```sh
9
+ pnpm add @v-office/website-sdk@2.37.1
10
+ ```
@@ -0,0 +1,123 @@
1
+ # Changelog: 2.38.0
2
+
3
+ Rentals and search items state their counts as numbers, the same on v9 and v10, so a website
4
+ no longer parses them out of translated text that changes with the locale. The SDK's own texts
5
+ read correctly in English and German: counts in their plural form, rating words with one meaning
6
+ per band in both languages, a natural reviewer line, labels instead of key names, a
7
+ translated v10 property type and a translated v10 "no insurance" option. Texts missing in the
8
+ requested language come back in German and are marked as German, on both backends.
9
+
10
+ ## Added
11
+
12
+ - `capacity` on rentals (`getRentals`, `getRentalsByIds`) and on search items, on v9 and v10:
13
+
14
+ ```ts
15
+ capacity?: {
16
+ maxGuests?: number;
17
+ maxAdults?: number;
18
+ bedrooms?: number;
19
+ bathrooms?: number;
20
+ rooms?: number;
21
+ livingAreaSqm?: number;
22
+ };
23
+ ```
24
+
25
+ The values do not depend on the locale or on `translationOverrides`. A count the backend
26
+ does not state, or states as 0, is omitted, never 0; `capacity` itself is omitted when no
27
+ count is stated.
28
+ - v10: from the room summary (`maxPersons` as `maxGuests`, `maxAdults`, `bedrooms`,
29
+ `bathrooms`, `rooms`) and `attributes.squareMeters`.
30
+ - v9: from the unit's `beds` (sleeping places, as `maxGuests`), `bedrooms`, `bathrooms`,
31
+ `rooms` and `squareMeters`. v9 states no adults, so `maxAdults` is always omitted. A v9
32
+ search now also requests these five attributes.
33
+
34
+ - The type `RentalCapacity`.
35
+ - `descriptionFallbacks` on rentals and their `property` (`getRentals`, `getRentalsByIds`):
36
+ the description fields served in another language than requested, with that language
37
+ (`{ "description": "de-DE" }`), so a site can mark German texts on an English page. Omitted
38
+ when every text is in the requested locale, and always for `de-DE`.
39
+
40
+ ## Changed
41
+
42
+ - v10: a description field without a text in the requested locale takes its German text and
43
+ is listed in `descriptionFallbacks`. Before, the field was omitted, so an English rental
44
+ without English texts had no description at all.
45
+ - v9: for a locale other than `de-DE`, `getRentals` and `getRentalsByIds` also ask the be-on!
46
+ Hub for the German texts (one extra query per 128 rentals that selects only the texts, plus one facility query with
47
+ `facilityObjectGroupRelationAttributeId`) and mark the fields the Hub served in German. The
48
+ texts themselves are unchanged: the Hub already served German.
49
+ - Counts render in the plural form of their number, on both backends: "1 guest", "2 bedrooms",
50
+ "1 Gast", "4 Gäste" in `highlights` and v10 `roomSummary`, and "1 bedroom", "2 bedrooms" in
51
+ the v9 bedroom and bathroom filter options. The guest count reads as guests on both backends
52
+ (it was "Maximale Personenzahl" on v10 and "Schlafmöglichkeiten" on v9).
53
+ - The rating words (`reviews.summary.classification`) carry one meaning per band in both
54
+ languages, and both German and English change: a 4.9 rating reads "Hervorragend" /
55
+ "Exceptional". The bands themselves are unchanged (≥ 4.5, ≥ 4.0, ≥ 3.0, ≥ 2.0, below).
56
+ - The English reviewer line reads "Ada, stayed in July 2026" (was "visited on").
57
+ - One rating reads "1 review" / "1 Bewertung" (was "1 reviews" / "1 Bewertungen").
58
+ - v10 `property.propertyType` is translated ("Apartment complex", "Apartmentanlage") as on v9,
59
+ instead of the enum (`APARTMENT_COMPLEX`). Both backends read the labels from one table now:
60
+ v9 kept its own copy, which said "Appartement Komplex" and "Ferienpark".
61
+ - English attribute labels and options that showed their key name now have texts, and all
62
+ English view labels share one spelling ("Sea view", "Mountain view", "Beach view").
63
+ - `valleyViewType` has its own label ("Valley view type", "Art des Talblicks") instead of the
64
+ valley view label.
65
+ - v10 quotes: the `none` insurance option reads "Keine Versicherung" for de-DE and "No
66
+ insurance" for en-US, from the new key `insurance.notOffered.label`, in `quote`,
67
+ `selectInsurance`, `createInsurancePreContract` and `selectInsurancePayment`. It was the
68
+ English "No insurance" in every locale. A v9 quote without an insurance provider reads the
69
+ same key (its text was already localized). With offers, the `none` option stays "Ich
70
+ verzichte auf den angebotenen Reiseschutz" (`insurance.none.label`) on v9, and will on v10.
71
+ - Every changed or new text. A site that overrides one of these keys with `translationOverrides`
72
+ keeps its override; check whether you still need it:
73
+
74
+ | Key | Locale | Before | Now |
75
+ | ---------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
76
+ | `RoomSummary.<field>.count.one` / `.other` (new; `maxPersons`, `maxAdults`, `bedrooms`, `bathrooms`, `rooms`, `livingrooms`) | de-DE | — | Gast / Gäste, Erwachsener / Erwachsene, Schlafzimmer, Badezimmer, Zimmer, Wohnzimmer |
77
+ | same | en-US | — | guest / guests, adult / adults, bedroom / bedrooms, bathroom / bathrooms, room / rooms, living room / living rooms |
78
+ | `RentalAttributes.beds.count.one` / `.other` (v9) | de-DE | Schlafmöglichkeit / Schlafmöglichkeiten | Gast / Gäste |
79
+ | same | en-US | sleeping arrangement / sleeping arrangements | guest / guests |
80
+ | `filter.bedrooms.count.one` / `.other`, `filter.bathrooms.count.one` / `.other` (v9, new) | de-DE | — | Schlafzimmer, Badezimmer |
81
+ | same | en-US | — | bedroom / bedrooms, bathroom / bathrooms |
82
+ | `insurance.notOffered.label` (new) | de-DE / en-US | — (hard-coded "No insurance" on v10 in every locale) | Keine Versicherung / No insurance |
83
+ | `reviews.summary.classification.excellent` | de-DE | Sehr gut | Hervorragend |
84
+ | `reviews.summary.classification.very-good` | de-DE | Gut | Sehr gut |
85
+ | `reviews.summary.classification.good` | de-DE | Ansprechend | Gut |
86
+ | `reviews.summary.classification.fair` | de-DE | Mittelmäßig | Ordentlich |
87
+ | `reviews.summary.classification.poor` | de-DE | Ausreichend | Ausreichend (unchanged) |
88
+ | `reviews.summary.classification.excellent` | en-US | Excellent | Exceptional |
89
+ | `reviews.summary.classification.fair` | en-US | Fair | Decent |
90
+ | `reviews.summary.classification.poor` | en-US | Poor | Adequate |
91
+ | `reviews.summary.count.one` (new) | de-DE / en-US | — | {count} Bewertung / {count} review |
92
+ | `reviews.item.authorWithDate` | en-US | {author}, visited on {date} | {author}, stayed in {date} |
93
+ | `Property.propertyType.option.APARTMENT_COMPLEX` | de-DE | Appartement Komplex | Apartmentanlage (v9 and v10) |
94
+ | `Property.propertyType.option.HOLIDAY_HOME_COMPLEX` | de-DE | Ferienpark (v9 only) | Ferienhausanlage (v9 and v10) |
95
+ | `Property.propertyType.option.HOLIDAY_HOME_COMPLEX` | en-US | Holiday Home Complex | Holiday home complex (v9 and v10) |
96
+ | `RentalAttributes.valleyViewType.label` (new) | de-DE / en-US | — (used the valley view label) | Art des Talblicks / Valley view type |
97
+ | `RentalAttributes.lakeviewType.option.EXCEPTIONALLY_GOOD` | de-DE | außergewöhnlich gut | Außergewöhnlich gut |
98
+ | `RentalAttributes.seaviewType.option.EXCEPTIONALLY_GOOD` | de-DE | außergewöhnlich gut | Außergewöhnlich gut |
99
+ | `RentalAttributes.seaviewType.option.LIMITED` | de-DE | eingeschränkt | Eingeschränkt |
100
+ | `RentalAttributes.beachview.label` | en-US | Beachview | Beach view |
101
+ | `RentalAttributes.cityView.label` | en-US | City View | City view |
102
+ | `RentalAttributes.countrysideView.label` | en-US | Countryside View | Countryside view |
103
+ | `RentalAttributes.countrysideViewType.label` | en-US | Countryside View Type | Countryside view type |
104
+ | `RentalAttributes.gardenView.label` | en-US | Garden View | Garden view |
105
+ | `RentalAttributes.innerCourtView.label` | en-US | Inner Court View | Courtyard view |
106
+ | `RentalAttributes.mountainview.label` | en-US | Mountainview | Mountain view |
107
+ | `RentalAttributes.mountainviewType.label` | en-US | Mountainview Type | Mountain view type |
108
+ | `RentalAttributes.poolView.label` | en-US | Pool View | Pool view |
109
+ | `RentalAttributes.quietStreetView.label` | en-US | Quiet Street View | Quiet street view |
110
+ | `RentalAttributes.riverView.label` | en-US | River View | River view |
111
+ | `RentalAttributes.valleyView.label` | en-US | valleyView | Valley view |
112
+ | `RentalAttributes.lakeviewType.label` | en-US | lakeviewType | Lake view type |
113
+ | `RentalAttributes.seaviewType.label` | en-US | seaviewType | Sea view type |
114
+ | `RentalAttributes.lakeviewType.option.*`, `seaviewType.option.*` | en-US | the key | Exceptionally good, Good, Limited |
115
+ | `RentalAttributes.heatingSystem.option.*` | en-US | the key | Central heating, Electric, Gas bottle, Gas tank, Oil, Stove (`OVEN`), Solar, Air conditioning (`VIA_AC`) |
116
+ | `RentalAttributes.stoveType.option.*` | en-US | the key | Ceramic hob, Gas, Induction, 3-burner stove, 4-burner stove |
117
+ | `RentalAttributes.kitchenType.option.CLOSED` | en-US | the key | Closed |
118
+ | `RentalAttributes.dryerAccess.option.EXKLUSIVE`, `washerAccess.option.EXKLUSIVE` | en-US | the key | Exclusive use |
119
+ | `RentalAttributes.relaxationRoom.label` | en-US | relaxationRoom | Relaxation room |
120
+ | `RentalAttributes.saunaIsPrivate.label` | en-US | saunaIsPrivate | Private sauna |
121
+ | `RentalAttributes.fitnessroom.label` | en-US | fitnessroom | Fitness room |
122
+
123
+ - `highlights` and `roomSummary` still hold text; read counts from `capacity`.
@@ -0,0 +1,37 @@
1
+ # Migration: 2.37.1 to 2.38.0
2
+
3
+ No changes required.
4
+
5
+ ## 1. Upgrade
6
+
7
+ ```sh
8
+ pnpm add @v-office/website-sdk@2.38.0
9
+ ```
10
+
11
+ ## 2. Optional: read counts from `capacity`
12
+
13
+ A site that reads guests, bedrooms, bathrooms, rooms or the living area out of `highlights` or
14
+ `roomSummary` ("4 Maximale Personenzahl", "88 m²") can read `rental.capacity` and
15
+ `item.capacity` instead. Treat a missing field as "not stated" and print nothing for it.
16
+ `@v-office/website-headless` 1.4.0 reads `capacity` for its counts.
17
+
18
+ ## 3. Check texts you parse, compare or override
19
+
20
+ - A site that reads counts out of `highlights` or `roomSummary` by their wording breaks: the
21
+ guest count now reads "4 Gäste" / "4 guests". Read `capacity` instead, or upgrade
22
+ `@v-office/website-headless` to 1.4.0 in the same commit (it reads both).
23
+ - A site that compares v10 `property.propertyType` with `APARTMENT_COMPLEX` or another enum
24
+ value breaks: the field now holds the translated label, as on v9.
25
+ - German rental pages show the new rating words: a rating that read "Sehr gut" now reads
26
+ "Hervorragend", "Gut" reads "Sehr gut", and so on. A site that wants the old words sets them
27
+ with `translationOverrides` (`reviews.summary.classification.<band>`).
28
+ - An override of `RoomSummary.<field>.label` (v10) or `RentalAttributes.beds.label` (v9) no
29
+ longer changes a count line; override the `.count.one` and `.count.other` keys in the
30
+ CHANGELOG instead.
31
+
32
+ ## 4. English pages show German texts where no English exists
33
+
34
+ v10 rentals without an English text now return the German text (before: no text), and both
35
+ backends list such fields in `descriptionFallbacks`. A site that hides a section without an
36
+ English text can check `descriptionFallbacks` instead and decide per field: show the German text
37
+ marked as German (`lang="de"`), or hide it.