@v-office/website-headless 0.1.0 → 0.1.1

package/dist/index.d.mts

@@ -1101,9 +1101,10 @@ interface SearchResultItem {
   name: string;
   /** `address.city`, verbatim (empty when the feed omits it). */
   location: string;
-  /** Internal detail link, derived from the name (URL generation), with the
-   *  user's booking context (dates + party size) appended as a query so the
-   *  search selection carries into the rental page. */
+  /** Internal detail link — `rentalsPath` (see `runLiveSearch`) + the slug
+   *  derived from the name (URL generation), with the user's booking context
+   *  (dates + party size) appended as a query so the search selection carries
+   *  into the rental page. */
   href: string;
   images: SearchImage[];
   /** Parsed out of the SDK highlights; 0 when the highlight is absent. */
@@ -1219,6 +1220,16 @@ interface SearchPayload {
   /** `pageInfo.hasNextPage`, verbatim. */
   hasNextPage: boolean;
 }
+interface LiveSearchOptions {
+  /** Path of the site's rental detail pages, prefixed to every result `href`
+   *  before the slug (e.g. `/de/unterkuenfte`). A trailing slash is tolerated.
+   *  Default: `DEFAULT_RENTALS_PATH`. */
+  rentalsPath?: string | undefined;
+}
+/** The rental detail pages' path when the caller names none — the site
+ *  starter's German route. A site whose pages live elsewhere (a locale prefix,
+ *  another segment) passes its own `rentalsPath` to `runLiveSearch`. */
+declare const DEFAULT_RENTALS_PATH = "/unterkuenfte";
 /**
  * Run a live search for the given URL query string (e.g.
  * `window.location.search`). Builds the SDK query from the picker params,
@@ -1229,8 +1240,14 @@ interface SearchPayload {
  * Pass `cursor` (the previous page's `pageInfo.nextCursor`, treated as
  * opaque) to fetch the next page. The returned `cursor`/`hasNextPage` are
  * the SDK's `pageInfo` straight through, so the caller can keep paging.
+ *
+ * `options.rentalsPath` is the path the site serves its rental detail pages
+ * under — the part of every result `href` before the slug. Routing is the
+ * site's decision (a locale prefix like `/de/unterkuenfte`, another segment),
+ * so it arrives as an option the way `SearchBar.action` and `Quote.checkoutPath`
+ * do; `locale` never implies it. Defaults to `DEFAULT_RENTALS_PATH`.
  */
-declare function runLiveSearch(sdk: VofficeSdk, searchString: string, locale: Locale, cursor?: string | null): Promise<SearchPayload>;
+declare function runLiveSearch(sdk: VofficeSdk, searchString: string, locale: Locale, cursor?: string | null, options?: LiveSearchOptions): Promise<SearchPayload>;
 //#endregion
 //#region src/sort.d.ts
 /** URL param. A client-side scope like `property`/`region`, NOT an SDK query
@@ -1337,4 +1354,4 @@ declare function scopeToRegions<T extends {
   id: string;
 }>(items: readonly T[], active: readonly string[], regionsByRentalId: (id: string) => readonly string[] | undefined): T[];
 //#endregion
-export { ActiveFilter, AlternativePeriod, BOOKING_SNAPSHOT_KEY, BUTTON_SOLUTION_PATTERN, BookingConfirmation, BookingContactForm, BookingSnapshot, BookingSnapshotGuests, CHECKOUT_CONTEXT_KEY, CHECKOUT_PARTS, CHECKOUT_RETURN_PATH, CHECKOUT_STRUCTURE, CheckoutContext, type CheckoutFlow, type CheckoutFlowActions, type CheckoutFlowApi, type CheckoutFlowMessages, type CheckoutFlowOptions, type CheckoutFlowState, type CheckoutIssue, type CheckoutPart, type CheckoutPhase, type CountryGroupsLike, DEFAULT_SORT, EndAvailability, FilterDef, FilterType, HUB_ENDPOINTS, InitialAvailability, type InsuranceDocsState, InsurancePaymentLink, Listener, type Locale, MULTI_RATE_CODES, NIGHT_RANGE_ENABLED, NIGHT_RANGE_KEYS, NO_INSURANCE_DOCS, NightRange, PETS_COUNT_PARAM, PETS_PARAM, PaymentLine, PaymentScheduleView, PolicyBranch, PriceQuote, QuoteAddonService, QuoteCancellationPolicy, QuoteInsurance, QuoteInsuranceOption, QuoteLine, QuoteOccupancy, QuotePolicyRule, QuoteResult, QuoteSelectionResult, QuoteUnavailableCode, QuoteView, QuoteVoucher, REGION_PARAM, SORT_OPTIONS, SORT_PARAM, STAGES, SdkConfig, SearchImage, SearchPayload, SearchResultItem, SnapshotImage, SortOption, SortValue, Stage, type Stay, Store, type StructureViolation, Unsubscribe, VALIDATED_FIELDS, VOFFICE_ENDPOINTS, type ValidationMessages, WebsiteSdk, WritableStore, activeFiltersFromQuery, activeRegions, activeSort, adaptGuestQuote, addQuoteService, assertCheckoutStructure, clearQuoteServices, createCheckoutFlow, createSdk, createStore, describeSdkError, detectCountry, emailError, fetchEndAvailability, fetchInitialAvailability, fetchQuote, fieldError, freeCancellationUntil, fullRefundRule, insuranceDocsPending, insuranceIdToReapply, insuranceProductKey, isBooleanFilterActive, isPricedQuery, isRateConfigurationFault, isSortAvailable, isSubmittableOption, isoDate, logSdkFailure, nightlyPrice, normalizePhone, occupancyOf, parseGermanParam, parseNightRange, parseParam, payWithOption, petsCountInQuery, phoneError, policyFreeCancellationUntil, postalcodeError, pricePolicyBranches, removeQuoteService, resolveSdkSort, runLiveSearch, saveBookingSnapshot, saveCheckoutContext, scopeToRegions, sdkConfigFor, selectQuoteInsurance, selectQuotePolicy, selectableInsuranceOptions, selectedInsuranceOption, shownInsuranceResources, stabilizeCardOrder, stayKeyOf, stayParams, streetWarning, submitBooking, tidyPrice };
+export { ActiveFilter, AlternativePeriod, BOOKING_SNAPSHOT_KEY, BUTTON_SOLUTION_PATTERN, BookingConfirmation, BookingContactForm, BookingSnapshot, BookingSnapshotGuests, CHECKOUT_CONTEXT_KEY, CHECKOUT_PARTS, CHECKOUT_RETURN_PATH, CHECKOUT_STRUCTURE, CheckoutContext, type CheckoutFlow, type CheckoutFlowActions, type CheckoutFlowApi, type CheckoutFlowMessages, type CheckoutFlowOptions, type CheckoutFlowState, type CheckoutIssue, type CheckoutPart, type CheckoutPhase, type CountryGroupsLike, DEFAULT_RENTALS_PATH, DEFAULT_SORT, EndAvailability, FilterDef, FilterType, HUB_ENDPOINTS, InitialAvailability, type InsuranceDocsState, InsurancePaymentLink, Listener, LiveSearchOptions, type Locale, MULTI_RATE_CODES, NIGHT_RANGE_ENABLED, NIGHT_RANGE_KEYS, NO_INSURANCE_DOCS, NightRange, PETS_COUNT_PARAM, PETS_PARAM, PaymentLine, PaymentScheduleView, PolicyBranch, PriceQuote, QuoteAddonService, QuoteCancellationPolicy, QuoteInsurance, QuoteInsuranceOption, QuoteLine, QuoteOccupancy, QuotePolicyRule, QuoteResult, QuoteSelectionResult, QuoteUnavailableCode, QuoteView, QuoteVoucher, REGION_PARAM, SORT_OPTIONS, SORT_PARAM, STAGES, SdkConfig, SearchImage, SearchPayload, SearchResultItem, SnapshotImage, SortOption, SortValue, Stage, type Stay, Store, type StructureViolation, Unsubscribe, VALIDATED_FIELDS, VOFFICE_ENDPOINTS, type ValidationMessages, WebsiteSdk, WritableStore, activeFiltersFromQuery, activeRegions, activeSort, adaptGuestQuote, addQuoteService, assertCheckoutStructure, clearQuoteServices, createCheckoutFlow, createSdk, createStore, describeSdkError, detectCountry, emailError, fetchEndAvailability, fetchInitialAvailability, fetchQuote, fieldError, freeCancellationUntil, fullRefundRule, insuranceDocsPending, insuranceIdToReapply, insuranceProductKey, isBooleanFilterActive, isPricedQuery, isRateConfigurationFault, isSortAvailable, isSubmittableOption, isoDate, logSdkFailure, nightlyPrice, normalizePhone, occupancyOf, parseGermanParam, parseNightRange, parseParam, payWithOption, petsCountInQuery, phoneError, policyFreeCancellationUntil, postalcodeError, pricePolicyBranches, removeQuoteService, resolveSdkSort, runLiveSearch, saveBookingSnapshot, saveCheckoutContext, scopeToRegions, sdkConfigFor, selectQuoteInsurance, selectQuotePolicy, selectableInsuranceOptions, selectedInsuranceOption, shownInsuranceResources, stabilizeCardOrder, stayKeyOf, stayParams, streetWarning, submitBooking, tidyPrice };

package/dist/index.mjs

@@ -1889,14 +1889,18 @@ function buildHandover(params, dates) {
 	const suffix = out.toString();
 	return suffix ? `?${suffix}` : "";
 }
-function mapBase(item) {
+/** The rental detail pages' path when the caller names none — the site
+*  starter's German route. A site whose pages live elsewhere (a locale prefix,
+*  another segment) passes its own `rentalsPath` to `runLiveSearch`. */
+const DEFAULT_RENTALS_PATH = "/unterkuenfte";
+function mapBase(item, rentalsPath) {
 	const name = item.nameOrLabel.trim();
 	const highlights = item.highlights ?? [];
 	return {
 		id: item.id,
 		name,
 		location: item.address?.city?.trim() ?? "",
-		href: `/unterkuenfte/${slugify(name)}`,
+		href: `${rentalsPath.replace(/\/+$/, "")}/${slugify(name)}`,
 		images: (item.images ?? []).map((img) => ({
 			src: img.src,
 			srcset: img.srcset?.trim() || void 0,
@@ -1946,11 +1950,11 @@ function mapDiscount(discount) {
 		})
 	};
 }
-function mapItem(item, params, locale) {
+function mapItem(item, params, locale, rentalsPath) {
 	const scopeType = typeof item.scope === "string" ? item.scope : item.scope?.type;
 	const alternativePeriodLabel = formatPeriodLabel(item.alternativePeriod ?? (typeof item.scope === "object" ? item.scope.alternativePeriod : void 0), locale);
 	const isAlternativePeriod = alternativePeriodLabel != null || scopeType === "alternativePeriod" || scopeType === "alternative-period";
-	const base = mapBase(item);
+	const base = mapBase(item, rentalsPath);
 	return {
 		...base,
 		href: `${base.href}${buildHandover(params)}`,
@@ -1967,8 +1971,8 @@ function mapItem(item, params, locale) {
 *  label come from the first candidate period (the SDK returns them best-first,
 *  `boost`-ordered). Always flagged as an alternative so the card shows the
 *  period pill instead of treating it as an exact total. */
-function mapAlternativeEntry(entry, params, locale) {
-	const base = mapBase(entry.item);
+function mapAlternativeEntry(entry, params, locale, rentalsPath) {
+	const base = mapBase(entry.item, rentalsPath);
 	const periods = (entry.alternativePeriods ?? []).flatMap((candidate) => {
 		const label = formatPeriodLabel({
 			start: candidate.start,
@@ -2016,8 +2020,15 @@ function mapAlternativeEntry(entry, params, locale) {
 * Pass `cursor` (the previous page's `pageInfo.nextCursor`, treated as
 * opaque) to fetch the next page. The returned `cursor`/`hasNextPage` are
 * the SDK's `pageInfo` straight through, so the caller can keep paging.
+*
+* `options.rentalsPath` is the path the site serves its rental detail pages
+* under — the part of every result `href` before the slug. Routing is the
+* site's decision (a locale prefix like `/de/unterkuenfte`, another segment),
+* so it arrives as an option the way `SearchBar.action` and `Quote.checkoutPath`
+* do; `locale` never implies it. Defaults to `DEFAULT_RENTALS_PATH`.
 */
-async function runLiveSearch(sdk, searchString, locale, cursor) {
+async function runLiveSearch(sdk, searchString, locale, cursor, options = {}) {
+	const rentalsPath = options.rentalsPath ?? "/unterkuenfte";
 	const params = new URLSearchParams(searchString);
 	const nights = computeNights(params);
 	const sort = resolveSdkSort(searchString);
@@ -2030,9 +2041,9 @@ async function runLiveSearch(sdk, searchString, locale, cursor) {
 			...sort ? { sort } : {},
 			...cursor ? { cursor } : {}
 		});
-		const exact = result.items.map((item) => mapItem(item, params, locale));
+		const exact = result.items.map((item) => mapItem(item, params, locale, rentalsPath));
 		const exactIds = new Set(exact.map((item) => item.id));
-		const alternatives = (result.alternatives ?? []).filter((entry) => entry?.item?.id && !exactIds.has(entry.item.id)).map((entry) => mapAlternativeEntry(entry, params, locale));
+		const alternatives = (result.alternatives ?? []).filter((entry) => entry?.item?.id && !exactIds.has(entry.item.id)).map((entry) => mapAlternativeEntry(entry, params, locale, rentalsPath));
 		const items = exact.concat(alternatives);
 		return {
 			items,
@@ -2082,4 +2093,4 @@ function scopeToRegions(items, active, regionsByRentalId) {
 	return items.filter((item) => regionsByRentalId(item.id)?.some((r) => active.includes(r)));
 }
 //#endregion
-export { BOOKING_SNAPSHOT_KEY, BUTTON_SOLUTION_PATTERN, CHECKOUT_CONTEXT_KEY, CHECKOUT_PARTS, CHECKOUT_RETURN_PATH, CHECKOUT_STRUCTURE, DEFAULT_SORT, HUB_ENDPOINTS, MULTI_RATE_CODES, NIGHT_RANGE_ENABLED, NIGHT_RANGE_KEYS, NO_INSURANCE_DOCS, PETS_COUNT_PARAM, PETS_PARAM, REGION_PARAM, SORT_OPTIONS, SORT_PARAM, STAGES, VALIDATED_FIELDS, VOFFICE_ENDPOINTS, activeFiltersFromQuery, activeRegions, activeSort, adaptGuestQuote, addQuoteService, assertCheckoutStructure, clearQuoteServices, createCheckoutFlow, createSdk, createStore, describeSdkError, detectCountry, emailError, fetchEndAvailability, fetchInitialAvailability, fetchQuote, fieldError, freeCancellationUntil, fullRefundRule, insuranceDocsPending, insuranceIdToReapply, insuranceProductKey, isBooleanFilterActive, isPricedQuery, isRateConfigurationFault, isSortAvailable, isSubmittableOption, isoDate, logSdkFailure, nightlyPrice, normalizePhone, occupancyOf, parseGermanParam, parseNightRange, parseParam, payWithOption, petsCountInQuery, phoneError, policyFreeCancellationUntil, postalcodeError, pricePolicyBranches, removeQuoteService, resolveSdkSort, runLiveSearch, saveBookingSnapshot, saveCheckoutContext, scopeToRegions, sdkConfigFor, selectQuoteInsurance, selectQuotePolicy, selectableInsuranceOptions, selectedInsuranceOption, shownInsuranceResources, stabilizeCardOrder, stayKeyOf, stayParams, streetWarning, submitBooking, tidyPrice };
+export { BOOKING_SNAPSHOT_KEY, BUTTON_SOLUTION_PATTERN, CHECKOUT_CONTEXT_KEY, CHECKOUT_PARTS, CHECKOUT_RETURN_PATH, CHECKOUT_STRUCTURE, DEFAULT_RENTALS_PATH, DEFAULT_SORT, HUB_ENDPOINTS, MULTI_RATE_CODES, NIGHT_RANGE_ENABLED, NIGHT_RANGE_KEYS, NO_INSURANCE_DOCS, PETS_COUNT_PARAM, PETS_PARAM, REGION_PARAM, SORT_OPTIONS, SORT_PARAM, STAGES, VALIDATED_FIELDS, VOFFICE_ENDPOINTS, activeFiltersFromQuery, activeRegions, activeSort, adaptGuestQuote, addQuoteService, assertCheckoutStructure, clearQuoteServices, createCheckoutFlow, createSdk, createStore, describeSdkError, detectCountry, emailError, fetchEndAvailability, fetchInitialAvailability, fetchQuote, fieldError, freeCancellationUntil, fullRefundRule, insuranceDocsPending, insuranceIdToReapply, insuranceProductKey, isBooleanFilterActive, isPricedQuery, isRateConfigurationFault, isSortAvailable, isSubmittableOption, isoDate, logSdkFailure, nightlyPrice, normalizePhone, occupancyOf, parseGermanParam, parseNightRange, parseParam, payWithOption, petsCountInQuery, phoneError, policyFreeCancellationUntil, postalcodeError, pricePolicyBranches, removeQuoteService, resolveSdkSort, runLiveSearch, saveBookingSnapshot, saveCheckoutContext, scopeToRegions, sdkConfigFor, selectQuoteInsurance, selectQuotePolicy, selectableInsuranceOptions, selectedInsuranceOption, shownInsuranceResources, stabilizeCardOrder, stayKeyOf, stayParams, streetWarning, submitBooking, tidyPrice };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@v-office/website-headless",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Framework-free behavior layer for v-office websites, never UI: the checkout flow as a subscribable store (createCheckoutFlow), validation and insurance rules, the checkout's structural requirements, the live search, availability and quote runners over a caller-owned SDK, and progressive-enhancement engines for server-rendered markup",
   "files": [
     "dist",