@v-office/website-sdk 2.7.0 → 2.9.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.
- package/README.md +28 -1
- package/dist/cli.mjs +25 -4
- package/dist/{client-45_ofP_d.mjs → client-CYK_5Vk7.mjs} +385 -187
- package/dist/index.d.mts +24 -4
- package/dist/index.mjs +3 -3
- package/dist/instructions/CHANGELOG.md +4 -1
- package/dist/instructions/MIGRATION.md +4 -1
- package/dist/instructions/README.md +9 -3
- package/dist/instructions/creation.md +82 -66
- package/dist/instructions/custom-attributes.md +560 -0
- package/dist/instructions/filter.md +62 -23
- package/dist/instructions/rentals.md +43 -2
- package/dist/instructions/search.md +29 -3
- package/dist/instructions/versions/2.5.0/MIGRATION.md +5 -0
- package/dist/instructions/versions/2.6.0/CHANGELOG.md +3 -25
- package/dist/instructions/versions/2.6.0/MIGRATION.md +4 -72
- package/dist/instructions/versions/2.7.0/CHANGELOG.md +44 -0
- package/dist/instructions/versions/2.7.0/MIGRATION.md +79 -0
- package/dist/instructions/versions/2.8.0/CHANGELOG.md +63 -0
- package/dist/instructions/versions/2.8.0/MIGRATION.md +252 -0
- package/dist/instructions/versions/2.9.0/CHANGELOG.md +37 -0
- package/dist/instructions/versions/2.9.0/MIGRATION.md +153 -0
- package/dist/{rentals-Lw1qUKIj.mjs → rentals-CFod9H4m.mjs} +21 -21
- package/dist/{search-wcoZw2rt.mjs → search-CO9ID9op.mjs} +16 -133
- package/dist/{to-rental-highlights-CxWlq76f.mjs → to-rental-highlights-B6a_fi0j.mjs} +33 -8
- package/dist/translations/v10/de-DE/core.json +2 -0
- package/dist/translations/v10/en-US/core.json +2 -0
- package/instructions/CHANGELOG.md +4 -1
- package/instructions/MIGRATION.md +4 -1
- package/instructions/README.md +9 -3
- package/instructions/creation.md +82 -66
- package/instructions/custom-attributes.md +560 -0
- package/instructions/filter.md +62 -23
- package/instructions/rentals.md +43 -2
- package/instructions/search.md +29 -3
- package/instructions/versions/2.5.0/MIGRATION.md +5 -0
- package/instructions/versions/2.6.0/CHANGELOG.md +3 -25
- package/instructions/versions/2.6.0/MIGRATION.md +4 -72
- package/instructions/versions/2.7.0/CHANGELOG.md +44 -0
- package/instructions/versions/2.7.0/MIGRATION.md +79 -0
- package/instructions/versions/2.8.0/CHANGELOG.md +63 -0
- package/instructions/versions/2.8.0/MIGRATION.md +252 -0
- package/instructions/versions/2.9.0/CHANGELOG.md +37 -0
- package/instructions/versions/2.9.0/MIGRATION.md +153 -0
- package/package.json +5 -3
|
@@ -1,133 +1,7 @@
|
|
|
1
|
-
import { n as
|
|
2
|
-
import { a as searchQuery, c as VofficeUnitDataFieldSchemas, m as parseVofficeUnitData, n as toImages, r as toAddress, t as toRentalHighlights } from "./to-rental-highlights-
|
|
3
|
-
import { CoreSDKError, STABLE_SEARCH_INPUTS,
|
|
1
|
+
import { a as parseQueryParameters, i as collectQueryParameters, n as makeV9CustomAttributeFilterCapabilities, o as toQueryString, r as toBasicQueryInputs, s as applyVofficeFilterDerivedBasicQueryInputs } from "./client-CYK_5Vk7.mjs";
|
|
2
|
+
import { a as searchQuery, c as VofficeUnitDataFieldSchemas, m as parseVofficeUnitData, n as toImages, r as toAddress, t as toRentalHighlights } from "./to-rental-highlights-B6a_fi0j.mjs";
|
|
3
|
+
import { CoreSDKError, STABLE_SEARCH_INPUTS, daysBetweenLocalDates, expandCustomAttributeFilterCompositions, parseChildrenAges, parseOccupancyCount, resolveExpandedCompositions, toFormattedSearchPrice, toIsoDateFromPeriodQueryDate, toStableSearchInputBackendQueryKeys, toStableSearchInputParameterValues, toStableSearchInputQueryKeys, toUnusedFilterKeys } from "@v-office/sdk-core";
|
|
4
4
|
import { Effect } from "effect";
|
|
5
|
-
//#region src/legacy-v9/parser/search/input/filter/apply-voffice-filter-derived-basic-query-inputs.ts
|
|
6
|
-
const hasBasicQueryInput = ({ basicQueryInputs, key }) => basicQueryInputs.some((input) => input.key === key);
|
|
7
|
-
const derivedBooleanFilters = [{
|
|
8
|
-
key: "pets",
|
|
9
|
-
isSelected: (filter) => (filter.petsCount ?? 0) > 0
|
|
10
|
-
}];
|
|
11
|
-
const applyVofficeFilterDerivedBasicQueryInputs = ({ appliedFilters, basicQueryInputs, filter, locale, translations }) => Effect.gen(function* () {
|
|
12
|
-
const nextAppliedFilters = [...appliedFilters];
|
|
13
|
-
const nextBasicQueryInputs = [...basicQueryInputs];
|
|
14
|
-
for (const derivedFilter of derivedBooleanFilters) {
|
|
15
|
-
if (!derivedFilter.isSelected(filter) || hasBasicQueryInput({
|
|
16
|
-
basicQueryInputs: nextBasicQueryInputs,
|
|
17
|
-
key: derivedFilter.key
|
|
18
|
-
})) continue;
|
|
19
|
-
nextBasicQueryInputs.push({
|
|
20
|
-
key: derivedFilter.key,
|
|
21
|
-
value: true
|
|
22
|
-
});
|
|
23
|
-
nextAppliedFilters.push({
|
|
24
|
-
key: derivedFilter.key,
|
|
25
|
-
label: yield* translations.translate(locale, `filter.${derivedFilter.key}.label`, derivedFilter.key)
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
return {
|
|
29
|
-
appliedFilters: nextAppliedFilters,
|
|
30
|
-
basicQueryInputs: nextBasicQueryInputs
|
|
31
|
-
};
|
|
32
|
-
});
|
|
33
|
-
//#endregion
|
|
34
|
-
//#region src/legacy-v9/parser/search/input/filter/filter-query-keys.ts
|
|
35
|
-
const FILTER_QUERY_KEYS = new Set(Object.keys(stable_filters_default));
|
|
36
|
-
//#endregion
|
|
37
|
-
//#region src/legacy-v9/parser/search/input/filter/to-basic-query-inputs.ts
|
|
38
|
-
const isEnabledBooleanFilter = (value) => {
|
|
39
|
-
const normalizedValue = value.toLowerCase();
|
|
40
|
-
return normalizedValue === "" || normalizedValue === "true" || normalizedValue === "1";
|
|
41
|
-
};
|
|
42
|
-
const toBasicQueryInput = ({ queryKey, value, filter }) => {
|
|
43
|
-
if (filter.type === "BooleanFilter") return isEnabledBooleanFilter(value) ? {
|
|
44
|
-
key: queryKey,
|
|
45
|
-
value: true
|
|
46
|
-
} : void 0;
|
|
47
|
-
if (filter.type === "InputFilter") {
|
|
48
|
-
const numberValue = Number(value);
|
|
49
|
-
if (!Number.isInteger(numberValue) || numberValue < 0) return;
|
|
50
|
-
return {
|
|
51
|
-
key: queryKey,
|
|
52
|
-
value: numberValue
|
|
53
|
-
};
|
|
54
|
-
}
|
|
55
|
-
};
|
|
56
|
-
const toCustomBackendFilterInput = ({ queryKey, value, filter }) => {
|
|
57
|
-
switch (filter.type) {
|
|
58
|
-
case "boolean": return isEnabledBooleanFilter(value) ? {
|
|
59
|
-
key: queryKey,
|
|
60
|
-
value: true
|
|
61
|
-
} : void 0;
|
|
62
|
-
case "int": {
|
|
63
|
-
const numberValue = Number(value);
|
|
64
|
-
return Number.isInteger(numberValue) && numberValue >= 0 ? {
|
|
65
|
-
key: queryKey,
|
|
66
|
-
value: numberValue
|
|
67
|
-
} : void 0;
|
|
68
|
-
}
|
|
69
|
-
case "string": return value.length > 0 ? {
|
|
70
|
-
key: queryKey,
|
|
71
|
-
value
|
|
72
|
-
} : void 0;
|
|
73
|
-
case "option": return filter.options.some((option) => option.value === value) ? {
|
|
74
|
-
key: queryKey,
|
|
75
|
-
value
|
|
76
|
-
} : void 0;
|
|
77
|
-
}
|
|
78
|
-
};
|
|
79
|
-
const toBasicQueryInputs = ({ query, customAttributeFilterDefinitions, locale, translations }) => {
|
|
80
|
-
const appliedFilterEffects = [];
|
|
81
|
-
const basicQueryInputs = [];
|
|
82
|
-
const remainingParameters = [];
|
|
83
|
-
const seenScalarFilters = /* @__PURE__ */ new Set();
|
|
84
|
-
const customBackendFiltersByKey = new Map(customAttributeFilterDefinitions.filter((definition) => definition.source === "backendFilter" && definition.searchable).map((definition) => [definition.key, definition]));
|
|
85
|
-
for (const [queryKey, value] of parseQueryParameters(query)) {
|
|
86
|
-
const filter = stable_filters_default[queryKey];
|
|
87
|
-
const customBackendFilter = customBackendFiltersByKey.get(queryKey);
|
|
88
|
-
if ((!FILTER_QUERY_KEYS.has(queryKey) || filter == null) && customBackendFilter == null) {
|
|
89
|
-
remainingParameters.push([queryKey, value]);
|
|
90
|
-
continue;
|
|
91
|
-
}
|
|
92
|
-
if (seenScalarFilters.has(queryKey)) {
|
|
93
|
-
remainingParameters.push([queryKey, value]);
|
|
94
|
-
continue;
|
|
95
|
-
}
|
|
96
|
-
const basicQueryInput = filter == null ? customBackendFilter != null ? toCustomBackendFilterInput({
|
|
97
|
-
queryKey,
|
|
98
|
-
value,
|
|
99
|
-
filter: customBackendFilter
|
|
100
|
-
}) : void 0 : toBasicQueryInput({
|
|
101
|
-
queryKey,
|
|
102
|
-
value,
|
|
103
|
-
filter
|
|
104
|
-
});
|
|
105
|
-
if (basicQueryInput == null) {
|
|
106
|
-
remainingParameters.push([queryKey, value]);
|
|
107
|
-
continue;
|
|
108
|
-
}
|
|
109
|
-
seenScalarFilters.add(queryKey);
|
|
110
|
-
basicQueryInputs.push(basicQueryInput);
|
|
111
|
-
if (customBackendFilter != null) appliedFilterEffects.push(Effect.succeed({
|
|
112
|
-
key: queryKey,
|
|
113
|
-
label: toCustomAttributeFilterLabel({
|
|
114
|
-
definition: customBackendFilter,
|
|
115
|
-
locale,
|
|
116
|
-
value
|
|
117
|
-
})
|
|
118
|
-
}));
|
|
119
|
-
else appliedFilterEffects.push(translations.translate(locale, `filter.${queryKey}.label`, queryKey).pipe(Effect.map((label) => ({
|
|
120
|
-
key: queryKey,
|
|
121
|
-
label
|
|
122
|
-
}))));
|
|
123
|
-
}
|
|
124
|
-
return {
|
|
125
|
-
appliedFilters: Effect.all(appliedFilterEffects),
|
|
126
|
-
basicQueryInputs,
|
|
127
|
-
remainingQuery: toQueryString(remainingParameters)
|
|
128
|
-
};
|
|
129
|
-
};
|
|
130
|
-
//#endregion
|
|
131
5
|
//#region src/legacy-v9/parser/search/input/search-input-error.ts
|
|
132
6
|
const failInvalidV9SearchInput = (message) => Effect.fail(new CoreSDKError({
|
|
133
7
|
source: "v10",
|
|
@@ -305,6 +179,7 @@ const toVofficeSorting = (sort) => {
|
|
|
305
179
|
//#region src/legacy-v9/parser/search/input/to-query-input.ts
|
|
306
180
|
const toQueryInput = ({ query, sort, customAttributeFilterDefinitions, locale, translations }) => Effect.gen(function* () {
|
|
307
181
|
const compositionResult = expandCustomAttributeFilterCompositions({
|
|
182
|
+
capabilities: makeV9CustomAttributeFilterCapabilities(customAttributeFilterDefinitions),
|
|
308
183
|
customAttributeFilterDefinitions,
|
|
309
184
|
locale,
|
|
310
185
|
query
|
|
@@ -330,8 +205,16 @@ const toQueryInput = ({ query, sort, customAttributeFilterDefinitions, locale, t
|
|
|
330
205
|
locale,
|
|
331
206
|
translations
|
|
332
207
|
});
|
|
208
|
+
const compositionFilters = resolveExpandedCompositions({
|
|
209
|
+
compositions: compositionResult.compositions,
|
|
210
|
+
unusedFilterKeys: [
|
|
211
|
+
...compositionResult.unusedFilterKeys,
|
|
212
|
+
...occupancyResult?.unusedFilterKeys ?? [],
|
|
213
|
+
...toUnusedFilterKeys(basicQueryResult.remainingQuery)
|
|
214
|
+
]
|
|
215
|
+
});
|
|
333
216
|
return {
|
|
334
|
-
appliedFilters: [...
|
|
217
|
+
appliedFilters: [...compositionFilters.appliedFilters, ...appliedFilters],
|
|
335
218
|
queryInput: {
|
|
336
219
|
vofficeData: {
|
|
337
220
|
filter: Object.keys(filter).length > 0 ? filter : void 0,
|
|
@@ -340,7 +223,7 @@ const toQueryInput = ({ query, sort, customAttributeFilterDefinitions, locale, t
|
|
|
340
223
|
},
|
|
341
224
|
basicQueryInputs
|
|
342
225
|
},
|
|
343
|
-
unusedFilterKeys:
|
|
226
|
+
unusedFilterKeys: compositionFilters.unusedFilterKeys
|
|
344
227
|
};
|
|
345
228
|
});
|
|
346
229
|
//#endregion
|
|
@@ -356,7 +239,7 @@ const toFormattedPrice = ({ locale, calc }) => {
|
|
|
356
239
|
};
|
|
357
240
|
//#endregion
|
|
358
241
|
//#region src/legacy-v9/parser/search/to-search-output-item.ts
|
|
359
|
-
const toSearchOutputItem = ({ locale, imageProxyBaseUrl, rentalHighlightPrioritization,
|
|
242
|
+
const toSearchOutputItem = ({ locale, imageProxyBaseUrl, rentalHighlightPrioritization, customAttributes, rental, translations, includeFormattedTotal }) => Effect.gen(function* () {
|
|
360
243
|
const data = parseVofficeUnitData(rental.data);
|
|
361
244
|
const item = {
|
|
362
245
|
id: rental.voffice_id.toString(),
|
|
@@ -371,7 +254,7 @@ const toSearchOutputItem = ({ locale, imageProxyBaseUrl, rentalHighlightPrioriti
|
|
|
371
254
|
locale,
|
|
372
255
|
translations,
|
|
373
256
|
highlightPrioritization: rentalHighlightPrioritization,
|
|
374
|
-
|
|
257
|
+
customAttributes,
|
|
375
258
|
attributes: data
|
|
376
259
|
});
|
|
377
260
|
if (highlights != null) item.highlights = highlights;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { localeToLanguage, makeTranslate,
|
|
1
|
+
import { localeToLanguage, makeTranslate, renderLabeledAttributeValue, renderResolvedCustomAttribute, toCountry } from "@v-office/sdk-core";
|
|
2
2
|
import { Effect, Schema } from "effect";
|
|
3
3
|
//#region codegen/v9/heuristic-generation/v9-data.ts
|
|
4
4
|
/**
|
|
@@ -5870,23 +5870,45 @@ const toV9RentalHighlightKey = (key) => {
|
|
|
5870
5870
|
};
|
|
5871
5871
|
//#endregion
|
|
5872
5872
|
//#region src/legacy-v9/parser/rentals/to-rental-highlights.ts
|
|
5873
|
-
const
|
|
5873
|
+
const RENTAL_VIEW_HIGHLIGHT_KEYS = /* @__PURE__ */ new Set([
|
|
5874
|
+
"beachview",
|
|
5875
|
+
"cityView",
|
|
5876
|
+
"countrysideView",
|
|
5877
|
+
"gardenView",
|
|
5878
|
+
"innerCourtView",
|
|
5879
|
+
"lakeview",
|
|
5880
|
+
"mountainview",
|
|
5881
|
+
"poolView",
|
|
5882
|
+
"quietStreetView",
|
|
5883
|
+
"riverView",
|
|
5884
|
+
"seaview",
|
|
5885
|
+
"valleyView"
|
|
5886
|
+
]);
|
|
5887
|
+
const toRentalHighlights = ({ locale, translations, highlightPrioritization, customAttributes, attributes }) => Effect.gen(function* () {
|
|
5874
5888
|
const highlights = [];
|
|
5875
5889
|
const seenKeys = /* @__PURE__ */ new Set();
|
|
5876
5890
|
const knownAttributes = attributes.known;
|
|
5877
5891
|
const translate = makeTranslate(translations, locale);
|
|
5892
|
+
let hasViewHighlight = false;
|
|
5878
5893
|
for (const highlightKey of highlightPrioritization) {
|
|
5894
|
+
const isViewHighlight = RENTAL_VIEW_HIGHLIGHT_KEYS.has(highlightKey);
|
|
5895
|
+
if (isViewHighlight && hasViewHighlight) continue;
|
|
5879
5896
|
const v9Key = toV9RentalHighlightKey(highlightKey);
|
|
5880
5897
|
if (v9Key == null) {
|
|
5881
5898
|
if (seenKeys.has(highlightKey)) continue;
|
|
5882
5899
|
seenKeys.add(highlightKey);
|
|
5883
|
-
const
|
|
5884
|
-
|
|
5885
|
-
|
|
5900
|
+
const attribute = customAttributes.byKey[highlightKey];
|
|
5901
|
+
if (attribute === void 0) continue;
|
|
5902
|
+
const binding = attribute.v9;
|
|
5903
|
+
const highlight = renderResolvedCustomAttribute({
|
|
5904
|
+
attribute,
|
|
5886
5905
|
locale,
|
|
5887
|
-
value: knownAttributes[
|
|
5906
|
+
value: binding === void 0 ? void 0 : knownAttributes[binding] ?? attributes.unknown[binding]
|
|
5888
5907
|
});
|
|
5889
|
-
if (highlight != null)
|
|
5908
|
+
if (highlight != null) {
|
|
5909
|
+
highlights.push(highlight);
|
|
5910
|
+
if (isViewHighlight) hasViewHighlight = true;
|
|
5911
|
+
}
|
|
5890
5912
|
continue;
|
|
5891
5913
|
}
|
|
5892
5914
|
if (seenKeys.has(v9Key)) continue;
|
|
@@ -5898,7 +5920,10 @@ const toRentalHighlights = ({ locale, translations, highlightPrioritization, cus
|
|
|
5898
5920
|
locale,
|
|
5899
5921
|
value: knownAttributes[v9Key]
|
|
5900
5922
|
});
|
|
5901
|
-
if (highlight != null)
|
|
5923
|
+
if (highlight != null) {
|
|
5924
|
+
highlights.push(highlight);
|
|
5925
|
+
if (isViewHighlight) hasViewHighlight = true;
|
|
5926
|
+
}
|
|
5902
5927
|
}
|
|
5903
5928
|
return highlights;
|
|
5904
5929
|
});
|
|
@@ -5077,6 +5077,8 @@
|
|
|
5077
5077
|
"RentalAttributesCategory.MEDIA.label": "Medien",
|
|
5078
5078
|
"RentalAttributesCategory.OTHER.label": "Andere",
|
|
5079
5079
|
"RentalAttributesCategory.OUTDOORS.label": "Außenbereich",
|
|
5080
|
+
"RentalAttributesCategory.roomSummary.label": "Zimmer",
|
|
5081
|
+
"RentalAttributesCategory.vicinity.label": "Umgebung",
|
|
5080
5082
|
"RentalAttributesCategory.PRACTICAL_NECESSITIES.label": "Praktische Notwendigkeiten",
|
|
5081
5083
|
"RentalAttributesCategory.PROPERTY_DETAILS_RULES.label": "Objektdetails & Regeln",
|
|
5082
5084
|
"RentalAttributesCategory.PROPERTY_TYPE_LOCATION.label": "Unterkunftstyp & Standort",
|
|
@@ -5077,6 +5077,8 @@
|
|
|
5077
5077
|
"RentalAttributesCategory.MEDIA.label": "Media",
|
|
5078
5078
|
"RentalAttributesCategory.OTHER.label": "Other",
|
|
5079
5079
|
"RentalAttributesCategory.OUTDOORS.label": "Outdoor Area",
|
|
5080
|
+
"RentalAttributesCategory.roomSummary.label": "Rooms",
|
|
5081
|
+
"RentalAttributesCategory.vicinity.label": "Vicinity",
|
|
5080
5082
|
"RentalAttributesCategory.PRACTICAL_NECESSITIES.label": "Practical Necessities",
|
|
5081
5083
|
"RentalAttributesCategory.PROPERTY_DETAILS_RULES.label": "Property Details & Rules",
|
|
5082
5084
|
"RentalAttributesCategory.PROPERTY_TYPE_LOCATION.label": "Property Type & Location",
|
|
@@ -4,7 +4,10 @@ This file is the versioned changelog index for the website SDK instructions.
|
|
|
4
4
|
|
|
5
5
|
## Versions
|
|
6
6
|
|
|
7
|
-
- `versions/2.
|
|
7
|
+
- `versions/2.9.0/CHANGELOG.md`: `@v-office/website-sdk` 2.9.0 release notes.
|
|
8
|
+
- `versions/2.8.0/CHANGELOG.md`: `@v-office/website-sdk` 2.8.0 release notes.
|
|
9
|
+
- `versions/2.7.0/CHANGELOG.md`: `@v-office/website-sdk` 2.7.0 release notes.
|
|
10
|
+
- `versions/2.6.0/CHANGELOG.md`: compatibility note for an unreleased version label.
|
|
8
11
|
- `versions/2.5.0/CHANGELOG.md`: `@v-office/website-sdk` 2.5.0 release notes.
|
|
9
12
|
- `versions/2.4.3/CHANGELOG.md`: `@v-office/website-sdk` 2.4.3 documentation release notes.
|
|
10
13
|
- `versions/2.4.2/CHANGELOG.md`: `@v-office/website-sdk` 2.4.2 release notes.
|
|
@@ -4,7 +4,10 @@ This file is the versioned migration index for the website SDK instructions.
|
|
|
4
4
|
|
|
5
5
|
## Available Guides
|
|
6
6
|
|
|
7
|
-
- `versions/2.
|
|
7
|
+
- `versions/2.9.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.8.0 to 2.9.0.
|
|
8
|
+
- `versions/2.8.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.7.0 to 2.8.0.
|
|
9
|
+
- `versions/2.7.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.5.x to 2.7.0.
|
|
10
|
+
- `versions/2.6.0/MIGRATION.md`: compatibility note for an unreleased version label.
|
|
8
11
|
- `versions/2.5.0/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.4.3 to 2.5.0.
|
|
9
12
|
- `versions/2.4.3/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.4.2 to 2.4.3.
|
|
10
13
|
- `versions/2.4.2/MIGRATION.md`: migrate from `@v-office/website-sdk` 2.4.1 to 2.4.2.
|
package/instructions/README.md
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
# Website SDK Instructions
|
|
2
2
|
|
|
3
|
-
These instructions describe
|
|
3
|
+
These instructions describe the current source targeted for
|
|
4
|
+
`@v-office/website-sdk` 2.9.0. Package versions remain unchanged until the release
|
|
5
|
+
workflow performs the coordinated core and website bumps.
|
|
4
6
|
|
|
5
7
|
Use this directory as the consumer-facing reference for the package:
|
|
6
8
|
|
|
7
9
|
- `creation.md`: SDK construction, config, options, and CLI config files.
|
|
8
10
|
- `rentals.md`: `sdk.static.rentals.getRentals`.
|
|
9
11
|
- `filter.md`: `sdk.static.filter.getFilters`.
|
|
12
|
+
- `custom-attributes.md`: custom attribute catalog, configuration, per-backend behaviour, and the v9-to-v10 move.
|
|
10
13
|
- `search.md`: `sdk.live.search.search`.
|
|
11
14
|
- `availability.md`: date-picker availability flows.
|
|
12
15
|
- `quote.md`: quote, additional services, cancellation policy, and insurance flows.
|
|
@@ -15,7 +18,10 @@ Use this directory as the consumer-facing reference for the package:
|
|
|
15
18
|
- `document-structured-json.md`: `sdk.static.documents.getTermsAndPrivacyPolicy` and structured document JSON rendering rules.
|
|
16
19
|
- `CHANGELOG.md`: versioned changelog index.
|
|
17
20
|
- `MIGRATION.md`: versioned migration index.
|
|
18
|
-
- `versions/2.
|
|
21
|
+
- `versions/2.9.0/`: 2.9.0 highlight-selection release notes and 2.8.0-to-2.9.0 migration guide.
|
|
22
|
+
- `versions/2.8.0/`: 2.8.0 custom-attribute release notes and 2.7.0-to-2.8.0 migration guide.
|
|
23
|
+
- `versions/2.7.0/`: 2.7.0 release notes and 2.5.x-to-2.7.0 migration guide.
|
|
24
|
+
- `versions/2.6.0/`: compatibility pointers for the unreleased 2.6.0 version label.
|
|
19
25
|
- `versions/2.5.0/`: 2.5.0 release notes and 2.4.3-to-2.5.0 migration guide.
|
|
20
26
|
- `versions/2.4.3/`: 2.4.3 documentation release notes and migration guide.
|
|
21
27
|
- `versions/2.4.2/`: 2.4.2 release notes and 2.4.1-to-2.4.2 migration guide.
|
|
@@ -69,4 +75,4 @@ website-sdk --backend v10 search --locale de-DE --query "adults=2"
|
|
|
69
75
|
website-sdk --backend v10 search --locale de-DE --query "adults=2" --sort '{"by":"field","orderBy":{"label":"ASC"}}'
|
|
70
76
|
```
|
|
71
77
|
|
|
72
|
-
Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.
|
|
78
|
+
Config file examples in these docs use the flat `WebsiteSDKConfig` shape introduced in 2.0.0 and kept in 2.9.0. v10 config additionally requires `searchEndpoint` as of 2.5.0.
|
package/instructions/creation.md
CHANGED
|
@@ -81,6 +81,7 @@ const options = defineWebsiteSDKOptions({
|
|
|
81
81
|
},
|
|
82
82
|
rentalHighlightPrioritization: ["bedrooms", "bathrooms", "maxPersons", "wifi"],
|
|
83
83
|
rentalPropertyHighlightPrioritization: ["wifi", "parking"],
|
|
84
|
+
customAttributes,
|
|
84
85
|
customAttributeFilterDefinitions: [],
|
|
85
86
|
translationOverrides: {},
|
|
86
87
|
});
|
|
@@ -91,8 +92,8 @@ const options = defineWebsiteSDKOptions({
|
|
|
91
92
|
```ts
|
|
92
93
|
type WebsiteSDKOptions = {
|
|
93
94
|
translationOverrides?: TranslationOverrides;
|
|
95
|
+
customAttributes?: CustomAttributeRegistrySnapshot;
|
|
94
96
|
customAttributeFilterDefinitions?: readonly CustomAttributeFilterDefinition[];
|
|
95
|
-
customAttributeDefinitionManifest?: CustomAttributeDefinitionManifest;
|
|
96
97
|
rentalHighlightPrioritization?: readonly RentalHighlightPrioritizationKey[];
|
|
97
98
|
rentalPropertyHighlightPrioritization?: readonly RentalPropertyHighlightPrioritizationKey[];
|
|
98
99
|
rentalScope?: RentalScope;
|
|
@@ -100,12 +101,24 @@ type WebsiteSDKOptions = {
|
|
|
100
101
|
};
|
|
101
102
|
```
|
|
102
103
|
|
|
104
|
+
`rentalHighlightPrioritization` and `rentalPropertyHighlightPrioritization` select
|
|
105
|
+
which facts become highlights and set their order. They are ordered allowlists, not
|
|
106
|
+
sorts over every available fact. A key that is not listed is not emitted even when
|
|
107
|
+
the source contains a value. This affects `highlights` only, not `attributes` or
|
|
108
|
+
`vicinity`. Property highlights are available only with v10 property data.
|
|
109
|
+
|
|
110
|
+
For either option, `undefined` uses the SDK default and `[]` emits no highlights.
|
|
111
|
+
Duplicate keys are emitted once; unknown, unsupported, or unresolved keys are
|
|
112
|
+
ignored. When several configured rental view facts have values, only the first one
|
|
113
|
+
in the ordered allowlist is emitted. View-type descriptors qualify a view and are
|
|
114
|
+
not part of this strongest-view selection.
|
|
115
|
+
|
|
103
116
|
Unset options are normalized by the SDK:
|
|
104
117
|
|
|
118
|
+
- `customAttributes` defaults to an empty registry.
|
|
105
119
|
- `customAttributeFilterDefinitions` defaults to `[]`.
|
|
106
|
-
- `
|
|
107
|
-
- `
|
|
108
|
-
- `rentalPropertyHighlightPrioritization` defaults to the SDK default property highlight order.
|
|
120
|
+
- `rentalHighlightPrioritization` defaults to the SDK default rental highlight selection.
|
|
121
|
+
- `rentalPropertyHighlightPrioritization` defaults to the SDK default property highlight selection.
|
|
109
122
|
- `rentalScope` defaults to `{}`.
|
|
110
123
|
- `shouldAddProposedAdditionalServiceAmount` defaults to `false`.
|
|
111
124
|
- `translationOverrides` is omitted unless provided.
|
|
@@ -130,31 +143,45 @@ const options = defineWebsiteSDKOptions({
|
|
|
130
143
|
|
|
131
144
|
The scope is always applied internally and is not returned by `static.filter.getFilters(...)`. Use it for website-level or tenant-level constraints.
|
|
132
145
|
|
|
133
|
-
## Custom
|
|
146
|
+
## Custom Attributes
|
|
134
147
|
|
|
135
|
-
|
|
148
|
+
Custom attributes are configured through `customAttributes`, built by
|
|
149
|
+
`defineCustomAttributes` from the workspace catalog plus your product policy:
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
const customAttributes = defineCustomAttributes({
|
|
153
|
+
catalog,
|
|
154
|
+
select: {
|
|
155
|
+
region: {
|
|
156
|
+
label: { "de-DE": "Region", "en-US": "Region" },
|
|
157
|
+
filter: true,
|
|
158
|
+
optionLabels: {
|
|
159
|
+
north: { "de-DE": "Nord", "en-US": "North" },
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
},
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
const options = defineWebsiteSDKOptions({ customAttributes });
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
See `custom-attributes.md` for the catalog, the selection shape, per-backend
|
|
169
|
+
behaviour, and the v9-to-v10 move.
|
|
170
|
+
|
|
171
|
+
## Backend Filters and Composed Filters
|
|
172
|
+
|
|
173
|
+
`customAttributeFilterDefinitions` holds the two filter concepts that are _not_
|
|
174
|
+
custom attributes:
|
|
136
175
|
|
|
137
176
|
```ts
|
|
138
177
|
const options = defineWebsiteSDKOptions({
|
|
139
178
|
customAttributeFilterDefinitions: [
|
|
140
179
|
{
|
|
141
|
-
key: "
|
|
142
|
-
source: "
|
|
143
|
-
category: "
|
|
144
|
-
label: {
|
|
145
|
-
|
|
146
|
-
"en-US": "Region",
|
|
147
|
-
},
|
|
148
|
-
type: "option",
|
|
149
|
-
options: [
|
|
150
|
-
{
|
|
151
|
-
value: "north",
|
|
152
|
-
label: {
|
|
153
|
-
"de-DE": "Nord",
|
|
154
|
-
"en-US": "North",
|
|
155
|
-
},
|
|
156
|
-
},
|
|
157
|
-
],
|
|
180
|
+
key: "atLeastTwoBedrooms",
|
|
181
|
+
source: "backendFilter",
|
|
182
|
+
category: "LIVING_SLEEPING",
|
|
183
|
+
label: { "de-DE": "Mind. zwei Schlafzimmer", "en-US": "At least two bedrooms" },
|
|
184
|
+
type: "boolean",
|
|
158
185
|
searchable: true,
|
|
159
186
|
internal: false,
|
|
160
187
|
},
|
|
@@ -165,59 +192,30 @@ const options = defineWebsiteSDKOptions({
|
|
|
165
192
|
Supported filter types:
|
|
166
193
|
|
|
167
194
|
- `boolean`: accepts enabled query values such as `?key`, `?key=true`, or `?key=1`.
|
|
168
|
-
- `int`: accepts integer query values
|
|
195
|
+
- `int`: accepts integer query values. The definition includes a `numericBounds`
|
|
196
|
+
object; omit its `min` and `max` fields when the UI needs no bounds.
|
|
169
197
|
- `option`: accepts one of the configured `options` values and exposes those options through `getFilters`.
|
|
170
198
|
- `string`: accepts any non-empty query value as an exact raw value.
|
|
171
199
|
- `complex`: composition-only type that expands one boolean query-string filter into other configured filters.
|
|
172
200
|
|
|
173
201
|
Supported sources:
|
|
174
202
|
|
|
175
|
-
- `
|
|
176
|
-
- `
|
|
177
|
-
|
|
203
|
+
- `backendFilter`: backed by backend-defined search filter keys, mainly for v9 hub filters. Advertised and executed by v9 only.
|
|
204
|
+
- `composition`: expands one boolean query-string filter into other configured
|
|
205
|
+
filters. It is advertised only when every configured leaf can execute on the
|
|
206
|
+
active backend, and no generated leaf is committed unless all leaves are valid.
|
|
207
|
+
Nested compositions are rejected while recursive expansion is unsupported.
|
|
208
|
+
|
|
209
|
+
For a new v9 `backendFilter` key, ask someone at be-on! with Hub access to add or
|
|
210
|
+
confirm the backend filter before configuring it in the SDK.
|
|
178
211
|
|
|
179
|
-
|
|
212
|
+
Exposure:
|
|
180
213
|
|
|
181
214
|
- `internal: false` exposes searchable filters through `static.filter.getFilters(...)`.
|
|
182
215
|
- `internal: true` keeps filters usable by search and compositions but hides them from `getFilters`.
|
|
183
|
-
- `searchable: false` keeps custom attributes as display metadata only.
|
|
184
|
-
|
|
185
|
-
## Custom Attribute Definition Manifest
|
|
186
|
-
|
|
187
|
-
The v10 REST search backend filters and returns custom attributes by definition ID, while SDK configuration and query strings use keys. Because definition IDs are workspace/environment specific, use `customAttributeDefinitionManifest` to give the SDK a key-to-ID and ID-to-key mapping:
|
|
188
216
|
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
customAttributeDefinitionManifest: {
|
|
192
|
-
byKey: {
|
|
193
|
-
region: { id: "def-1", key: "region", type: "OPTION", visibility: "PUBLIC" },
|
|
194
|
-
},
|
|
195
|
-
byId: {
|
|
196
|
-
"def-1": { id: "def-1", key: "region", type: "OPTION", visibility: "PUBLIC" },
|
|
197
|
-
},
|
|
198
|
-
},
|
|
199
|
-
});
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
```ts
|
|
203
|
-
type CustomAttributeDefinitionManifestEntry = {
|
|
204
|
-
id: string;
|
|
205
|
-
key: string;
|
|
206
|
-
type: "BOOLEAN" | "INT" | "STRING" | "OPTION";
|
|
207
|
-
visibility: "PUBLIC" | string | null;
|
|
208
|
-
options?: readonly { value: string; label?: Record<string, string> }[];
|
|
209
|
-
};
|
|
210
|
-
|
|
211
|
-
type CustomAttributeDefinitionManifest = {
|
|
212
|
-
byKey: Record<string, CustomAttributeDefinitionManifestEntry>;
|
|
213
|
-
byId: Record<string, CustomAttributeDefinitionManifestEntry>;
|
|
214
|
-
};
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
- Generate the manifest at build time from your definitions source, and pass a separate manifest per workspace/environment because IDs are not portable.
|
|
218
|
-
- Custom-attribute keys that have no manifest entry are left in `unusedFilterKeys` instead of being applied as filters.
|
|
219
|
-
- Only definitions with `visibility` of `PUBLIC` (or `null`) are surfaced as v10 search highlights; others are ignored.
|
|
220
|
-
- The manifest is only used by v10 search. v9 and the non-search v10 endpoints ignore it.
|
|
217
|
+
`internal` is a UI-visibility choice, not a security boundary — an internal filter is
|
|
218
|
+
still parseable from a query string. See `custom-attributes.md`.
|
|
221
219
|
|
|
222
220
|
## Translation Overrides
|
|
223
221
|
|
|
@@ -262,8 +260,26 @@ Example `website-sdk-options.json`:
|
|
|
262
260
|
"rentalScope": {
|
|
263
261
|
"propertyId": "property-1"
|
|
264
262
|
},
|
|
265
|
-
"
|
|
263
|
+
"customAttributes": {
|
|
264
|
+
"catalog": {
|
|
265
|
+
"privateSauna": {
|
|
266
|
+
"id": "GQYKYgMVh28X7VLGursbkt",
|
|
267
|
+
"type": "BOOLEAN"
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
"select": {
|
|
271
|
+
"privateSauna": {
|
|
272
|
+
"label": { "de-DE": "Sauna", "en-US": "Sauna" },
|
|
273
|
+
"filter": true
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
},
|
|
277
|
+
"rentalHighlightPrioritization": ["bedrooms", "privateSauna", "wifi"],
|
|
266
278
|
"customAttributeFilterDefinitions": [],
|
|
267
279
|
"translationOverrides": {}
|
|
268
280
|
}
|
|
269
281
|
```
|
|
282
|
+
|
|
283
|
+
CLI options carry the custom-attribute **catalog and selection inputs**, not a
|
|
284
|
+
pre-built registry. The CLI validates and joins them before creating the SDK. See
|
|
285
|
+
`custom-attributes.md` for the complete shape and key-collision rules.
|