@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
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AdditionalServiceLimitExceeded, AvailabilityGetInitialAvailabilityInput, AvailabilityGetInitialAvailabilityInput as AvailabilityGetInitialAvailabilityInput$1, AvailabilityGetInitialAvailabilityOutput, AvailabilityGetInitialAvailabilityOutput as AvailabilityGetInitialAvailabilityOutput$1, AvailabilityGetStartDateSelectedAvailabilityInput, AvailabilityGetStartDateSelectedAvailabilityInput as AvailabilityGetStartDateSelectedAvailabilityInput$1, AvailabilityGetStartDateSelectedAvailabilityOutput, AvailabilityGetStartDateSelectedAvailabilityOutput as AvailabilityGetStartDateSelectedAvailabilityOutput$1, AvailabilityService, BackendKind, BookingBookInput, BookingBookInput as BookingBookInput$1, BookingBookOutput, BookingBookOutput as BookingBookOutput$1, BookingPaymentOption, BookingService, ContactService, ContactSubmitInput, ContactSubmitInput as ContactSubmitInput$1, ContactSubmitOutput, ContactSubmitOutput as ContactSubmitOutput$1, ContactSubmitValidationIssue, ContactSubmitValidationIssueCode, CoreSDKError, CoreSDKError as CMSError, CoreSDKError as CoreSDKError$1,
|
|
1
|
+
import { AdditionalServiceLimitExceeded, AvailabilityGetInitialAvailabilityInput, AvailabilityGetInitialAvailabilityInput as AvailabilityGetInitialAvailabilityInput$1, AvailabilityGetInitialAvailabilityOutput, AvailabilityGetInitialAvailabilityOutput as AvailabilityGetInitialAvailabilityOutput$1, AvailabilityGetStartDateSelectedAvailabilityInput, AvailabilityGetStartDateSelectedAvailabilityInput as AvailabilityGetStartDateSelectedAvailabilityInput$1, AvailabilityGetStartDateSelectedAvailabilityOutput, AvailabilityGetStartDateSelectedAvailabilityOutput as AvailabilityGetStartDateSelectedAvailabilityOutput$1, AvailabilityService, BackendKind, BookingBookInput, BookingBookInput as BookingBookInput$1, BookingBookOutput, BookingBookOutput as BookingBookOutput$1, BookingPaymentOption, BookingService, ContactService, ContactSubmitInput, ContactSubmitInput as ContactSubmitInput$1, ContactSubmitOutput, ContactSubmitOutput as ContactSubmitOutput$1, ContactSubmitValidationIssue, ContactSubmitValidationIssueCode, CoreSDKError, CoreSDKError as CMSError, CoreSDKError as CoreSDKError$1, CustomAttributeCatalog, CustomAttributeCatalogDefinitionInput, CustomAttributeCatalogInput, CustomAttributeCatalogSchema, CustomAttributeCategoryKey, CustomAttributeFilterCategoryKey, CustomAttributeFilterDefinition, CustomAttributeFilterDefinition as CustomAttributeFilterDefinition$1, CustomAttributeFilterExpression, CustomAttributeFilterLabel, CustomAttributeFilterNumericBounds, CustomAttributeFilterOption, CustomAttributeOverridesInput, CustomAttributeRegistry, CustomAttributeRegistrySnapshot, CustomAttributeRegistrySnapshot as CustomAttributeRegistrySnapshot$1, CustomAttributeSelection, DocumentsGetTermsAndPrivacyPolicyInput, DocumentsGetTermsAndPrivacyPolicyInput as DocumentsGetTermsAndPrivacyPolicyInput$1, DocumentsGetTermsAndPrivacyPolicyOutput, DocumentsGetTermsAndPrivacyPolicyOutput as DocumentsGetTermsAndPrivacyPolicyOutput$1, DocumentsService, FilterGetFiltersInput, FilterGetFiltersInput as FilterGetFiltersInput$1, FilterGetFiltersOutput, FilterGetFiltersOutput as FilterGetFiltersOutput$1, FilterService, GuestQuote, GuestQuoteInput, GuestQuoteInsurance, GuestQuoteResult, GuestQuoteSchema, GuestQuoteSelectionResult, GuestQuoteVoucher, InsuranceBookingOutput, InsuranceCustomerInformationInput, InsurancePaymentInformationInput, InsurancePaymentOptionOutput, InsurancePreContractOutput, InvalidAdditionalServiceQuantity, Locale, LocaleSchema, QuoteAddAdditionalServiceInput, QuoteAddAdditionalServiceOutput, QuoteBookInsuranceInput, QuoteBookInsuranceOutput, QuoteClearAdditionalServicesInput, QuoteClearAdditionalServicesOutput, QuoteCreateInsurancePreContractInput, QuoteCreateInsurancePreContractOutput, QuoteQuoteInput, QuoteQuoteInput as QuoteQuoteInput$1, QuoteQuoteOutput, QuoteQuoteOutput as QuoteQuoteOutput$1, QuoteRemoveAdditionalServiceInput, QuoteRemoveAdditionalServiceOutput, QuoteSelectCancellationPolicyInput, QuoteSelectCancellationPolicyOutput, QuoteSelectInsuranceInput, QuoteSelectInsuranceOutput, QuoteSelectInsurancePaymentInput, QuoteSelectInsurancePaymentOutput, QuoteService as QuoteService$1, RentalGetRentalsInput, RentalGetRentalsInput as RentalGetRentalsInput$1, RentalGetRentalsOutput, RentalGetRentalsOutput as RentalGetRentalsOutput$1, RentalHighlightPrioritizationKey, RentalHighlightPrioritizationKey as RentalHighlightPrioritizationKey$1, RentalPropertyHighlightPrioritizationKey, RentalPropertyHighlightPrioritizationKey as RentalPropertyHighlightPrioritizationKey$1, RentalScope, RentalService, ResolvedCustomAttribute, SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, SearchSearchFieldSort, SearchSearchFieldSort as SearchSearchFieldSort$1, SearchSearchFieldSortSchema, SearchSearchInput, SearchSearchInput as SearchSearchInput$1, SearchSearchInputSchema, SearchSearchOutput, SearchSearchOutput as SearchSearchOutput$1, SearchSearchOutputSchema, SearchSearchPriceSort, SearchSearchPriceSortSchema, SearchSearchRandomSort, SearchSearchRandomSortSchema, SearchSearchRatingSort, SearchSearchRatingSortSchema, SearchSearchSort, SearchSearchSort as SearchSearchSort$1, SearchSearchSortSchema, SearchService, SearchSortDirection, SearchSortDirectionSchema, SelectableInsuranceOptionOutput, SelectedInsuranceInformationInput, SubmittableBookingPaymentOption, SubmittableBookingPaymentOption as SubmittableBookingPaymentOption$1, TranslationOverrides, TranslationOverrides as TranslationOverrides$1, UnknownAdditionalService, V10CoreConfig, V9OnlyCustomAttributeInput, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput } from "@v-office/sdk-core";
|
|
2
2
|
import { Context, Effect, Layer, Schema } from "effect";
|
|
3
3
|
import { HttpClient } from "effect/unstable/http";
|
|
4
4
|
|
|
@@ -19,10 +19,29 @@ type WebsiteV10Config = V10CoreConfig & {
|
|
|
19
19
|
};
|
|
20
20
|
type WebsiteSDKConfig = WebsiteV10Config | WebsiteV9Config;
|
|
21
21
|
type WebsiteSDKOptions = {
|
|
22
|
-
readonly translationOverrides?: TranslationOverrides$1;
|
|
22
|
+
readonly translationOverrides?: TranslationOverrides$1; /** The validated registry returned by `defineCustomAttributes`. */
|
|
23
|
+
readonly customAttributes?: CustomAttributeRegistrySnapshot$1;
|
|
23
24
|
readonly customAttributeFilterDefinitions?: readonly CustomAttributeFilterDefinition$1[];
|
|
24
|
-
|
|
25
|
+
/**
|
|
26
|
+
* Selects and orders rental highlights. This is an ordered allowlist, not a sort
|
|
27
|
+
* over every available fact.
|
|
28
|
+
*
|
|
29
|
+
* Only listed keys are emitted, even when an omitted key has a source value.
|
|
30
|
+
* `undefined` uses the SDK default; `[]` emits no rental highlights. Duplicate
|
|
31
|
+
* keys are emitted once, and unknown, unsupported, or unresolved keys are ignored.
|
|
32
|
+
* When multiple listed view facts have values, only the first is emitted. This
|
|
33
|
+
* affects `highlights` only, not `attributes` or `vicinity`.
|
|
34
|
+
*/
|
|
25
35
|
readonly rentalHighlightPrioritization?: readonly RentalHighlightPrioritizationKey$1[];
|
|
36
|
+
/**
|
|
37
|
+
* Selects and orders v10 property highlights. This is an ordered allowlist, not
|
|
38
|
+
* a sort over every available fact.
|
|
39
|
+
*
|
|
40
|
+
* Only listed keys are emitted, even when an omitted key has a source value.
|
|
41
|
+
* `undefined` uses the SDK default; `[]` emits no property highlights. Duplicate
|
|
42
|
+
* keys are emitted once, and unknown, unsupported, or unresolved keys are ignored.
|
|
43
|
+
* This affects `highlights` only, not `attributes` or `vicinity`.
|
|
44
|
+
*/
|
|
26
45
|
readonly rentalPropertyHighlightPrioritization?: readonly RentalPropertyHighlightPrioritizationKey$1[];
|
|
27
46
|
readonly rentalScope?: RentalScope;
|
|
28
47
|
readonly shouldAddProposedAdditionalServiceAmount?: boolean;
|
|
@@ -432,6 +451,7 @@ declare const searchEffect: (input: SearchSearchInput$1) => Effect.Effect<{
|
|
|
432
451
|
readonly appliedFilters: readonly {
|
|
433
452
|
readonly key: string;
|
|
434
453
|
readonly label: string;
|
|
454
|
+
readonly value?: string;
|
|
435
455
|
}[];
|
|
436
456
|
readonly unusedFilterKeys: readonly string[];
|
|
437
457
|
readonly pageInfo: {
|
|
@@ -7180,4 +7200,4 @@ type RentalRentalsOutput = RentalGetRentalsOutput$1[number];
|
|
|
7180
7200
|
type RentalSearchInput = SearchSearchInput$1;
|
|
7181
7201
|
type RentalSearchOutput = SearchSearchOutput$1;
|
|
7182
7202
|
//#endregion
|
|
7183
|
-
export { AdditionalServiceLimitExceeded, ApiEnvelopeBase, ApiEnvelopeBaseSchema, type AvailabilityGetInitialAvailabilityInput, type AvailabilityGetInitialAvailabilityOutput, type AvailabilityGetStartDateSelectedAvailabilityInput, type AvailabilityGetStartDateSelectedAvailabilityOutput, type BackendKind, type BookingBookInput, type BookingBookOutput, BookingInput, BookingOutput, type BookingPaymentOption, CMSError, CalendarDay, CalendarDaySchema, CalendarResponse, CalendarResponseSchema, ContactInput, type ContactSubmitInput, type ContactSubmitOutput, type ContactSubmitValidationIssue, type ContactSubmitValidationIssueCode, CoreSDKError, CurrentMemberResponse, CurrentMemberResponseSchema, type
|
|
7203
|
+
export { AdditionalServiceLimitExceeded, ApiEnvelopeBase, ApiEnvelopeBaseSchema, type AvailabilityGetInitialAvailabilityInput, type AvailabilityGetInitialAvailabilityOutput, type AvailabilityGetStartDateSelectedAvailabilityInput, type AvailabilityGetStartDateSelectedAvailabilityOutput, type BackendKind, type BookingBookInput, type BookingBookOutput, BookingInput, BookingOutput, type BookingPaymentOption, CMSError, CalendarDay, CalendarDaySchema, CalendarResponse, CalendarResponseSchema, ContactInput, type ContactSubmitInput, type ContactSubmitOutput, type ContactSubmitValidationIssue, type ContactSubmitValidationIssueCode, CoreSDKError, CurrentMemberResponse, CurrentMemberResponseSchema, type CustomAttributeCatalog, type CustomAttributeCatalogDefinitionInput, type CustomAttributeCatalogInput, CustomAttributeCatalogSchema, type CustomAttributeCategoryKey, type CustomAttributeFilterCategoryKey, type CustomAttributeFilterDefinition, type CustomAttributeFilterExpression, type CustomAttributeFilterLabel, type CustomAttributeFilterNumericBounds, type CustomAttributeFilterOption, type CustomAttributeOverridesInput, type CustomAttributeRegistry, type CustomAttributeRegistrySnapshot, type CustomAttributeSelection, type CustomDataAttribute, CustomerUnitSummary, CustomerUnitSummarySchema, type DataAttribute, DefineDataAttributes, DocumentCollectionResponse, DocumentCollectionResponseSchema, DocumentResource, DocumentResourceResponse, DocumentResourceResponseSchema, DocumentResourceSchema, DocumentStatus, DocumentStatusSchema, DocumentStatusUpdateRequest, DocumentStatusUpdateRequestSchema, DocumentSummary, DocumentSummarySchema, DocumentType, DocumentTypeSchema, type DocumentsGetTermsAndPrivacyPolicyInput, type DocumentsGetTermsAndPrivacyPolicyOutput, ErgoAddress, ErgoAddressSchema, ErgoBank, ErgoBankSchema, ErgoBookRequest, ErgoBookRequestSchema, ErgoCommonFields, ErgoCommonFieldsSchema, ErgoCreatePreContractRequest, ErgoCreatePreContractRequestSchema, ErgoPerson, ErgoPersonSchema, ErgoPlanSearchRequest, ErgoPlanSearchRequestSchema, ErgoPolicyNumberRequest, ErgoPolicyNumberRequestSchema, ErgoReadPreContractRequest, ErgoReadPreContractRequestSchema, ErgoTripAndCustomerRequest, ErgoTripAndCustomerRequestSchema, FacilityListResponse, FacilityListResponseSchema, type FilterGetFiltersInput, type FilterGetFiltersOutput, type GeoLocation, type GuestQuote, type GuestQuoteInput, type GuestQuoteInsurance, type GuestQuoteResult, GuestQuoteSchema, type GuestQuoteSelectionResult, type GuestQuoteVoucher, type ImageData, InitialAvailabilityInput, InitialAvailabilityOutput, type InsuranceBookingOutput, type InsuranceCustomerInformationInput, type InsurancePaymentInformationInput, type InsurancePaymentOptionOutput, type InsurancePreContractOutput, InvalidAdditionalServiceQuantity, type KnownVofficeFacilityData, type KnownVofficeFacilityDataAttribute, type KnownVofficeFeedbackData, type KnownVofficeFeedbackDataAttribute, type KnownVofficeImageData, type KnownVofficeImageDataAttribute, type KnownVofficeOfferData, type KnownVofficeOfferDataAttribute, type KnownVofficePriceData, type KnownVofficePriceDataAttribute, type KnownVofficeRatingData, type KnownVofficeRatingDataAttribute, type KnownVofficeServiceData, type KnownVofficeServiceDataAttribute, type KnownVofficeTotalRatingData, type KnownVofficeTotalRatingDataAttribute, type KnownVofficeUnitData, type KnownVofficeUnitDataAttribute, type Locale, LocaleSchema, OnOfficeUnit, OnOfficeUnitCollectionResponse, OnOfficeUnitCollectionResponseSchema, OnOfficeUnitSchema, type ParsedJsonData, type ParsedVofficeFacilityData, type ParsedVofficeFeedbackData, type ParsedVofficeImageData, type ParsedVofficeOfferData, type ParsedVofficePriceData, type ParsedVofficeRatingData, type ParsedVofficeServiceData, type ParsedVofficeTotalRatingData, type ParsedVofficeUnitData, PaymentSchedule, PaymentScheduleItem, PaymentScheduleItemSchema, PaymentScheduleSchema, Quote, QuoteLine, QuoteLineSchema, QuotePricesPayload, QuotePricesPayloadSchema, QuotePricesResponse, QuotePricesResponseSchema, type QuoteQuoteInput, type QuoteQuoteOutput, QuoteSchema, QuoteService, QuoteServiceSchema, RawObjectResponse, RawObjectResponseSchema, RawVofficeObject, RawVofficeObjectSchema, RegionListResponse, RegionListResponseSchema, type RentalGetRentalsInput, type RentalGetRentalsOutput, type RentalHighlightPrioritizationKey, type RentalPropertyHighlightPrioritizationKey, RentalRentalsInput, RentalRentalsOutput, RentalSearchInput, RentalSearchOutput, type ResolvedCustomAttribute, RoomImage, RoomImageSchema, SearchPropertiesResponse, SearchPropertiesResponseSchema, type SearchSearchFieldOrderBy, SearchSearchFieldOrderBySchema, type SearchSearchFieldSort, SearchSearchFieldSortSchema, type SearchSearchInput, SearchSearchInputSchema, type SearchSearchOutput, SearchSearchOutputSchema, type SearchSearchPriceSort, SearchSearchPriceSortSchema, type SearchSearchRandomSort, SearchSearchRandomSortSchema, type SearchSearchRatingSort, SearchSearchRatingSortSchema, type SearchSearchSort, SearchSearchSortSchema, type SearchSortDirection, SearchSortDirectionSchema, type SelectableInsuranceOptionOutput, type SelectedInsuranceInformationInput, ServiceBeonData, ServiceBeonDataSchema, ServiceImage, ServiceImageSchema, ServiceLimit, ServiceLimitSchema, ServiceListResponse, ServiceListResponseSchema, SetupData, SetupDataSchema, SetupResponse, SetupResponseSchema, StartDateSelectedAvailabilityInput, StartDateSelectedAvailabilityOutput, type SubmittableBookingPaymentOption, Tile, TileCollectionResponse, TileCollectionResponseSchema, TileSchema, TileTag, TileTagSchema, type TranslationOverrides, TravelInsuranceBooking, TravelInsuranceBookingSchema, TravelInsuranceBookingStoreRequest, TravelInsuranceBookingStoreRequestSchema, UnitIdsResponse, UnitIdsResponseSchema, UnitListItem, UnitListItemSchema, UnitListResponse, UnitListResponseSchema, UnitOffer, UnitOfferSchema, UnitResponse, UnitResponseSchema, UnitServicePrice, UnitServicePriceSchema, UnknownAdditionalService, V0OpenApiClient, V0OpenApiClientError, type V0OpenApiClientOptions, type V0OpenApiOperationId, type V0OpenApiOperationRequest, type V0OpenApiOperationResponse, V1DecodedResponse, V1HttpMethod, V1OpenApiClient, V1OpenApiClientError, type V1OpenApiClientOptions, type components as V1OpenApiComponents, type V1OpenApiOperationId, type V1OpenApiOperationRequest, type V1OpenApiOperationResponse, type operations as V1OpenApiOperations, type paths as V1OpenApiPaths, V1OperationId, V1OperationRuntime, V1OperationSchema, V1SchemaDecodeError, V1_BASE_URL, V1_OPERATIONS, type V9OnlyCustomAttributeInput, type V9SearchSearchInput, type V9SearchSearchSort, VideoResponse, VideoResponseSchema, type VofficeFacilityDataAttribute, type VofficeFacilityDataAttributes, type VofficeFeedbackDataAttribute, type VofficeFeedbackDataAttributes, type VofficeImageDataAttribute, type VofficeImageDataAttributes, type VofficeOfferDataAttribute, type VofficeOfferDataAttributes, type VofficePriceDataAttribute, type VofficePriceDataAttributes, type VofficeRatingDataAttribute, type VofficeRatingDataAttributes, type VofficeServiceDataAttribute, type VofficeServiceDataAttributes, type VofficeTotalRatingDataAttribute, type VofficeTotalRatingDataAttributes, type VofficeUnitDataAttribute, type VofficeUnitDataAttributes, type WebsiteSDK, type WebsiteSDKConfig, type WebsiteSDKOptions, type WebsiteSDKSharedLive, type WebsiteSDKSharedStatic, type WebsiteSDKV10, type WebsiteSDKV10Live, type WebsiteSDKV10Static, type WebsiteSDKV9, type WebsiteSDKV9Live, addAdditionalServiceEffect, bookEffect, bookInsuranceEffect, clearAdditionalServicesEffect, createInsurancePreContractEffect, createWebsiteSDK, customDataAttribute, decodeV1OperationResponse, defineWebsiteSDKOptions as defineCMSSDKOptions, defineWebsiteSDKOptions, defineCustomAttributes, defineCustomAttributesFromUnknown, defineDataAttributes, defineVofficeFacilityDataAttributes, defineVofficeFeedbackDataAttributes, defineVofficeImageDataAttributes, defineVofficeOfferDataAttributes, defineVofficePriceDataAttributes, defineVofficeRatingDataAttributes, defineVofficeServiceDataAttributes, defineVofficeTotalRatingDataAttributes, defineVofficeUnitDataAttributes, fetchCustomAttributeCatalog, getFiltersEffect, getInitialAvailabilityEffect, getRentalsEffect, getStartDateSelectedAvailabilityEffect, getTermsAndPrivacyPolicyEffect, makeV0OpenApiClientFetchLive, makeV0OpenApiClientLive, makeV1OpenApiClientFetchLive, makeV1OpenApiClientLive, parseCustomAttributeCatalog, quoteEffect, removeAdditionalServiceEffect, searchEffect, selectCancellationPolicyEffect, selectInsuranceEffect, selectInsurancePaymentEffect, submitContactEffect, submitPaymentOption, submitPaymentOptionEffect, validateContactSubmitInput };
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as
|
|
2
|
-
import { AdditionalServiceLimitExceeded, CoreSDKError, CoreSDKError as CMSError, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, SearchSearchFieldOrderBySchema, SearchSearchFieldSortSchema, SearchSearchInputSchema, SearchSearchOutputSchema, SearchSearchPriceSortSchema, SearchSearchRandomSortSchema, SearchSearchRatingSortSchema, SearchSearchSortSchema, SearchSortDirectionSchema, UnknownAdditionalService, validateContactSubmitInput } from "@v-office/sdk-core";
|
|
1
|
+
import { $ as ServiceBeonDataSchema, A as ErgoBookRequestSchema, At as quoteEffect, B as OnOfficeUnitSchema, C as DocumentResourceSchema, Ct as clearAdditionalServicesEffect, D as DocumentTypeSchema, Dt as getRentalsEffect, E as DocumentSummarySchema, Et as getInitialAvailabilityEffect, F as ErgoPolicyNumberRequestSchema, Ft as selectInsurancePaymentEffect, G as QuotePricesResponseSchema, H as PaymentScheduleSchema, I as ErgoReadPreContractRequestSchema, It as submitContactEffect, J as RawObjectResponseSchema, K as QuoteSchema, L as ErgoTripAndCustomerRequestSchema, Lt as submitPaymentOption, M as ErgoCreatePreContractRequestSchema, Mt as searchEffect, N as ErgoPersonSchema, Nt as selectCancellationPolicyEffect, O as ErgoAddressSchema, Ot as getStartDateSelectedAvailabilityEffect, P as ErgoPlanSearchRequestSchema, Pt as selectInsuranceEffect, Q as SearchPropertiesResponseSchema, R as FacilityListResponseSchema, Rt as submitPaymentOptionEffect, S as DocumentResourceResponseSchema, St as bookInsuranceEffect, T as DocumentStatusUpdateRequestSchema, Tt as getFiltersEffect, U as QuoteLineSchema, V as PaymentScheduleItemSchema, W as QuotePricesPayloadSchema, X as RegionListResponseSchema, Y as RawVofficeObjectSchema, Z as RoomImageSchema, _ as CalendarDaySchema, _t as V1_OPERATIONS, at as TileCollectionResponseSchema, b as CustomerUnitSummarySchema, bt as addAdditionalServiceEffect, c as V0OpenApiClient, ct as TravelInsuranceBookingSchema, d as makeV0OpenApiClientLive, dt as UnitListItemSchema, et as ServiceImageSchema, f as V1OpenApiClient, ft as UnitListResponseSchema, g as ApiEnvelopeBaseSchema, gt as V1_BASE_URL, h as makeV1OpenApiClientLive, ht as UnitServicePriceSchema, it as SetupResponseSchema, j as ErgoCommonFieldsSchema, jt as removeAdditionalServiceEffect, k as ErgoBankSchema, kt as getTermsAndPrivacyPolicyEffect, l as V0OpenApiClientError, lt as TravelInsuranceBookingStoreRequestSchema, m as makeV1OpenApiClientFetchLive, mt as UnitResponseSchema, nt as ServiceListResponseSchema, ot as TileSchema, p as V1OpenApiClientError, pt as UnitOfferSchema, q as QuoteServiceSchema, rt as SetupDataSchema, st as TileTagSchema, t as createWebsiteSDK, tt as ServiceLimitSchema, u as makeV0OpenApiClientFetchLive, ut as UnitIdsResponseSchema, v as CalendarResponseSchema, vt as VideoResponseSchema, w as DocumentStatusSchema, wt as createInsurancePreContractEffect, x as DocumentCollectionResponseSchema, xt as bookEffect, y as CurrentMemberResponseSchema, yt as decodeV1OperationResponse, z as OnOfficeUnitCollectionResponseSchema, zt as defineWebsiteSDKOptions } from "./client-CYK_5Vk7.mjs";
|
|
2
|
+
import { AdditionalServiceLimitExceeded, CoreSDKError, CoreSDKError as CMSError, CustomAttributeCatalogSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, SearchSearchFieldOrderBySchema, SearchSearchFieldSortSchema, SearchSearchInputSchema, SearchSearchOutputSchema, SearchSearchPriceSortSchema, SearchSearchRandomSortSchema, SearchSearchRatingSortSchema, SearchSearchSortSchema, SearchSortDirectionSchema, UnknownAdditionalService, defineCustomAttributes, defineCustomAttributesFromUnknown, fetchCustomAttributeCatalog, parseCustomAttributeCatalog, validateContactSubmitInput } from "@v-office/sdk-core";
|
|
3
3
|
//#region codegen/v9/heuristic-generation/public-api.ts
|
|
4
4
|
const customDataAttribute = (name) => name;
|
|
5
5
|
const defineDataAttributes = () => (attributes) => attributes;
|
|
@@ -13,4 +13,4 @@ const defineVofficeOfferDataAttributes = defineDataAttributes();
|
|
|
13
13
|
const defineVofficeRatingDataAttributes = defineDataAttributes();
|
|
14
14
|
const defineVofficeTotalRatingDataAttributes = defineDataAttributes();
|
|
15
15
|
//#endregion
|
|
16
|
-
export { AdditionalServiceLimitExceeded, ApiEnvelopeBaseSchema, CMSError, CalendarDaySchema, CalendarResponseSchema, CoreSDKError, CurrentMemberResponseSchema, CustomerUnitSummarySchema, DocumentCollectionResponseSchema, DocumentResourceResponseSchema, DocumentResourceSchema, DocumentStatusSchema, DocumentStatusUpdateRequestSchema, DocumentSummarySchema, DocumentTypeSchema, ErgoAddressSchema, ErgoBankSchema, ErgoBookRequestSchema, ErgoCommonFieldsSchema, ErgoCreatePreContractRequestSchema, ErgoPersonSchema, ErgoPlanSearchRequestSchema, ErgoPolicyNumberRequestSchema, ErgoReadPreContractRequestSchema, ErgoTripAndCustomerRequestSchema, FacilityListResponseSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, OnOfficeUnitCollectionResponseSchema, OnOfficeUnitSchema, PaymentScheduleItemSchema, PaymentScheduleSchema, QuoteLineSchema, QuotePricesPayloadSchema, QuotePricesResponseSchema, QuoteSchema, QuoteServiceSchema, RawObjectResponseSchema, RawVofficeObjectSchema, RegionListResponseSchema, RoomImageSchema, SearchPropertiesResponseSchema, SearchSearchFieldOrderBySchema, SearchSearchFieldSortSchema, SearchSearchInputSchema, SearchSearchOutputSchema, SearchSearchPriceSortSchema, SearchSearchRandomSortSchema, SearchSearchRatingSortSchema, SearchSearchSortSchema, SearchSortDirectionSchema, ServiceBeonDataSchema, ServiceImageSchema, ServiceLimitSchema, ServiceListResponseSchema, SetupDataSchema, SetupResponseSchema, TileCollectionResponseSchema, TileSchema, TileTagSchema, TravelInsuranceBookingSchema, TravelInsuranceBookingStoreRequestSchema, UnitIdsResponseSchema, UnitListItemSchema, UnitListResponseSchema, UnitOfferSchema, UnitResponseSchema, UnitServicePriceSchema, UnknownAdditionalService, V0OpenApiClient, V0OpenApiClientError, V1OpenApiClient, V1OpenApiClientError, V1_BASE_URL, V1_OPERATIONS, VideoResponseSchema, addAdditionalServiceEffect, bookEffect, bookInsuranceEffect, clearAdditionalServicesEffect, createInsurancePreContractEffect, createWebsiteSDK, customDataAttribute, decodeV1OperationResponse, defineWebsiteSDKOptions as defineCMSSDKOptions, defineWebsiteSDKOptions, defineDataAttributes, defineVofficeFacilityDataAttributes, defineVofficeFeedbackDataAttributes, defineVofficeImageDataAttributes, defineVofficeOfferDataAttributes, defineVofficePriceDataAttributes, defineVofficeRatingDataAttributes, defineVofficeServiceDataAttributes, defineVofficeTotalRatingDataAttributes, defineVofficeUnitDataAttributes, getFiltersEffect, getInitialAvailabilityEffect, getRentalsEffect, getStartDateSelectedAvailabilityEffect, getTermsAndPrivacyPolicyEffect, makeV0OpenApiClientFetchLive, makeV0OpenApiClientLive, makeV1OpenApiClientFetchLive, makeV1OpenApiClientLive, quoteEffect, removeAdditionalServiceEffect, searchEffect, selectCancellationPolicyEffect, selectInsuranceEffect, selectInsurancePaymentEffect, submitContactEffect, submitPaymentOption, submitPaymentOptionEffect, validateContactSubmitInput };
|
|
16
|
+
export { AdditionalServiceLimitExceeded, ApiEnvelopeBaseSchema, CMSError, CalendarDaySchema, CalendarResponseSchema, CoreSDKError, CurrentMemberResponseSchema, CustomAttributeCatalogSchema, CustomerUnitSummarySchema, DocumentCollectionResponseSchema, DocumentResourceResponseSchema, DocumentResourceSchema, DocumentStatusSchema, DocumentStatusUpdateRequestSchema, DocumentSummarySchema, DocumentTypeSchema, ErgoAddressSchema, ErgoBankSchema, ErgoBookRequestSchema, ErgoCommonFieldsSchema, ErgoCreatePreContractRequestSchema, ErgoPersonSchema, ErgoPlanSearchRequestSchema, ErgoPolicyNumberRequestSchema, ErgoReadPreContractRequestSchema, ErgoTripAndCustomerRequestSchema, FacilityListResponseSchema, GuestQuoteSchema, InvalidAdditionalServiceQuantity, LocaleSchema, OnOfficeUnitCollectionResponseSchema, OnOfficeUnitSchema, PaymentScheduleItemSchema, PaymentScheduleSchema, QuoteLineSchema, QuotePricesPayloadSchema, QuotePricesResponseSchema, QuoteSchema, QuoteServiceSchema, RawObjectResponseSchema, RawVofficeObjectSchema, RegionListResponseSchema, RoomImageSchema, SearchPropertiesResponseSchema, SearchSearchFieldOrderBySchema, SearchSearchFieldSortSchema, SearchSearchInputSchema, SearchSearchOutputSchema, SearchSearchPriceSortSchema, SearchSearchRandomSortSchema, SearchSearchRatingSortSchema, SearchSearchSortSchema, SearchSortDirectionSchema, ServiceBeonDataSchema, ServiceImageSchema, ServiceLimitSchema, ServiceListResponseSchema, SetupDataSchema, SetupResponseSchema, TileCollectionResponseSchema, TileSchema, TileTagSchema, TravelInsuranceBookingSchema, TravelInsuranceBookingStoreRequestSchema, UnitIdsResponseSchema, UnitListItemSchema, UnitListResponseSchema, UnitOfferSchema, UnitResponseSchema, UnitServicePriceSchema, UnknownAdditionalService, V0OpenApiClient, V0OpenApiClientError, V1OpenApiClient, V1OpenApiClientError, V1_BASE_URL, V1_OPERATIONS, VideoResponseSchema, addAdditionalServiceEffect, bookEffect, bookInsuranceEffect, clearAdditionalServicesEffect, createInsurancePreContractEffect, createWebsiteSDK, customDataAttribute, decodeV1OperationResponse, defineWebsiteSDKOptions as defineCMSSDKOptions, defineWebsiteSDKOptions, defineCustomAttributes, defineCustomAttributesFromUnknown, defineDataAttributes, defineVofficeFacilityDataAttributes, defineVofficeFeedbackDataAttributes, defineVofficeImageDataAttributes, defineVofficeOfferDataAttributes, defineVofficePriceDataAttributes, defineVofficeRatingDataAttributes, defineVofficeServiceDataAttributes, defineVofficeTotalRatingDataAttributes, defineVofficeUnitDataAttributes, fetchCustomAttributeCatalog, getFiltersEffect, getInitialAvailabilityEffect, getRentalsEffect, getStartDateSelectedAvailabilityEffect, getTermsAndPrivacyPolicyEffect, makeV0OpenApiClientFetchLive, makeV0OpenApiClientLive, makeV1OpenApiClientFetchLive, makeV1OpenApiClientLive, parseCustomAttributeCatalog, quoteEffect, removeAdditionalServiceEffect, searchEffect, selectCancellationPolicyEffect, selectInsuranceEffect, selectInsurancePaymentEffect, submitContactEffect, submitPaymentOption, submitPaymentOptionEffect, validateContactSubmitInput };
|
|
@@ -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.
|
|
@@ -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.
|
|
@@ -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.
|