@behio/storefront-sdk 2.29.0 → 2.30.0

package/dist/index.mjs

@@ -12,7 +12,7 @@ import {
   ok,
   publishCartSummary,
   toSdkError
-} from "./chunk-YDZ2OF4O.mjs";
+} from "./chunk-25UM2XCS.mjs";
 
 // src/react/utils/format-price.ts
 function formatPrice(amount, currency, locale, display) {
@@ -1203,12 +1203,157 @@ function formFieldErrors(err2) {
   }
   return out;
 }
+
+// src/react/storage.ts
+var localStorageAdapter = {
+  get(key) {
+    try {
+      return window.localStorage.getItem(key);
+    } catch {
+      return null;
+    }
+  },
+  set(key, value) {
+    try {
+      window.localStorage.setItem(key, value);
+    } catch {
+    }
+  },
+  remove(key) {
+    try {
+      window.localStorage.removeItem(key);
+    } catch {
+    }
+  }
+};
+function createMemoryStorage() {
+  const store = /* @__PURE__ */ new Map();
+  return {
+    get(key) {
+      return store.get(key) ?? null;
+    },
+    set(key, value) {
+      store.set(key, value);
+    },
+    remove(key) {
+      store.delete(key);
+    }
+  };
+}
+var memoryStorage = createMemoryStorage();
+
+// src/form-popup.ts
+function preferenceMemory() {
+  if (typeof window === "undefined") return /* @__PURE__ */ new Map();
+  const browser = window;
+  return browser.__behioFormPreferences ?? (browser.__behioFormPreferences = /* @__PURE__ */ new Map());
+}
+var memoryAdapter = { get: (k) => preferenceMemory().get(k) ?? null, set: (k, v) => {
+  preferenceMemory().set(k, v);
+}, remove: (k) => {
+  preferenceMemory().delete(k);
+} };
+var NEWSLETTER_REQUESTED_EVENT = "behio:newsletter-requested";
+var PREFIX = "behio:forms:";
+var VISIT_MS = 30 * 60 * 1e3;
+function sessionAdapter() {
+  return { get: (key) => {
+    try {
+      return sessionStorage.getItem(key) ?? memoryAdapter.get(key);
+    } catch {
+      return memoryAdapter.get(key);
+    }
+  }, set: (key, value) => {
+    memoryAdapter.set(key, value);
+    try {
+      sessionStorage.setItem(key, value);
+    } catch {
+    }
+  }, remove: (key) => {
+    memoryAdapter.remove(key);
+    try {
+      sessionStorage.removeItem(key);
+    } catch {
+    }
+  } };
+}
+function markNewsletterRequested() {
+  if (typeof window === "undefined") return;
+  memoryAdapter.set(PREFIX + "newsletter", "1");
+  localStorageAdapter.set(PREFIX + "newsletter", "1");
+  if (typeof window !== "undefined") window.dispatchEvent(new Event(NEWSLETTER_REQUESTED_EVENT));
+}
+function newsletterWasRequested() {
+  return memoryAdapter.get(PREFIX + "newsletter") === "1" || localStorageAdapter.get(PREFIX + "newsletter") === "1";
+}
+function matchesFormPath(rule, pathname) {
+  return rule.endsWith("*") ? pathname.startsWith(rule.slice(0, -1)) : pathname === rule;
+}
+function formPopupRouteAllowed(pathname, placement) {
+  if (/^\/(cart|checkout|account|order|newsletter|login|register|forgot-password|reset-password|verify-email|session)(\/|$)/.test(pathname)) return false;
+  return (!placement.includePaths.length || placement.includePaths.some((rule) => matchesFormPath(rule, pathname))) && !placement.excludePaths.some((rule) => matchesFormPath(rule, pathname));
+}
+var FormPopupClock = class {
+  constructor(elapsedMs = 0) {
+    this.since = null;
+    this.elapsedMs = Math.max(0, elapsedMs);
+  }
+  setVisible(visible, now) {
+    if (this.since !== null) this.elapsedMs += Math.max(0, now - this.since);
+    this.since = visible ? now : null;
+  }
+  elapsed(now) {
+    return this.elapsedMs + (this.since === null ? 0 : Math.max(0, now - this.since));
+  }
+};
+var FormPopupPreferences = class {
+  constructor(session = sessionAdapter(), persistent = localStorageAdapter, now = () => Date.now()) {
+    this.session = session;
+    this.persistent = persistent;
+    this.now = now;
+    this.shownInVisit = this.number("shown", this.session) > this.now() || this.number("shown", this.persistent) > this.now();
+  }
+  number(key, storage) {
+    const n = Number(storage.get(PREFIX + key));
+    return Number.isFinite(n) && n >= 0 ? n : 0;
+  }
+  visibleMs() {
+    return this.now() - this.number("activity", this.session) < VISIT_MS ? this.number("visible", this.session) : 0;
+  }
+  saveTime(visible) {
+    if (this.shownInVisit) {
+      const until = String(this.now() + VISIT_MS);
+      this.session.set(PREFIX + "shown", until);
+      this.persistent.set(PREFIX + "shown", until);
+    }
+    this.session.set(PREFIX + "visible", String(visible));
+    this.session.set(PREFIX + "activity", String(this.now()));
+  }
+  suppressed(slug, newsletter = false) {
+    return newsletter && newsletterWasRequested() || this.shownInVisit || this.number("shown", this.session) > this.now() || this.number("shown", this.persistent) > this.now() || this.number("dismissed:" + slug, this.persistent) > this.now() || this.number("dismissed:" + slug, this.session) > this.now();
+  }
+  shown() {
+    this.shownInVisit = true;
+    const until = String(this.now() + VISIT_MS);
+    this.session.set(PREFIX + "shown", until);
+    this.persistent.set(PREFIX + "shown", until);
+  }
+  dismiss(slug, days) {
+    const key = PREFIX + "dismissed:" + slug;
+    const until = String(this.now() + days * 864e5);
+    this.session.set(key, until);
+    this.persistent.set(key, until);
+  }
+};
 export {
   AddressTypes,
   BehioApiError,
   BehioNetworkError,
   BehioStorefront,
+  FormPopupClock,
+  FormPopupPreferences,
   FulfillmentStatuses,
+  NEWSLETTER_REQUESTED_EVENT,
   OrderStatuses,
   PaymentStatuses,
   ProductSort,
@@ -1222,10 +1367,14 @@ export {
   errorParams,
   findVariantByAttributes,
   formFieldErrors,
+  formPopupRouteAllowed,
   formatPrice,
   generateVisitorId,
   getStoredVisitorId,
   grantAnalyticsConsent,
+  markNewsletterRequested,
+  matchesFormPath,
+  newsletterWasRequested,
   ok,
   publishCartSummary,
   resolveVariantContent,

package/dist/next.d.mts

@@ -1,4 +1,4 @@
-import { q as BehioStorefrontConfig, B as BehioStorefront } from './client-CAPtdqzd.mjs';
+import { r as BehioStorefrontConfig, B as BehioStorefront } from './client-DtAz0rDJ.mjs';
 
 interface GetBehioOptions extends Partial<BehioStorefrontConfig> {
     /** Override the cart session cookie name (default: "behio_cart_session"). */

package/dist/next.d.ts

@@ -1,4 +1,4 @@
-import { q as BehioStorefrontConfig, B as BehioStorefront } from './client-CAPtdqzd.js';
+import { r as BehioStorefrontConfig, B as BehioStorefront } from './client-DtAz0rDJ.js';
 
 interface GetBehioOptions extends Partial<BehioStorefrontConfig> {
     /** Override the cart session cookie name (default: "behio_cart_session"). */

package/dist/next.js

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
 
-var _chunkSBPQZG4Yjs = require('./chunk-SBPQZG4Y.js');
+var _chunkOUPCGMSRjs = require('./chunk-OUPCGMSR.js');
 
 // src/next.ts
 var _headers = require('next/headers');
@@ -19,7 +19,7 @@ async function getBehio(options = {}) {
   const locale = _nullishCoalesce(options.locale, () => ( process.env.BEHIO_LOCALE));
   const currency = _nullishCoalesce(options.currency, () => ( process.env.BEHIO_CURRENCY));
   const cookieName = _nullishCoalesce(options.cartCookieName, () => ( CART_COOKIE_NAME));
-  const client = new (0, _chunkSBPQZG4Yjs.BehioStorefront)({
+  const client = new (0, _chunkOUPCGMSRjs.BehioStorefront)({
     apiKey,
     ...baseUrl ? { baseUrl } : {},
     ...locale ? { locale } : {},

package/dist/next.mjs

@@ -1,6 +1,6 @@
 import {
   BehioStorefront
-} from "./chunk-YDZ2OF4O.mjs";
+} from "./chunk-25UM2XCS.mjs";
 
 // src/next.ts
 import { cookies, headers } from "next/headers";

package/dist/react.d.mts

@@ -2553,7 +2553,35 @@ interface StorefrontFaqQuery {
     locale?: string;
 }
 /** Public definition of a form (`GET /forms/{slug}`). */
+interface StorefrontFormPlacement {
+    key: string;
+    mode: "inline" | "popup";
+    enabled: boolean;
+    delaySeconds: number;
+    dismissDays: number;
+    devices: "all" | "mobile" | "desktop";
+    /** Exact path or prefix ending in *. No regex. */
+    includePaths: string[];
+    excludePaths: string[];
+}
+interface StorefrontFormPresentation {
+    purpose: "general" | "newsletter";
+    content: {
+        eyebrow: string;
+        heading: string;
+        body: string;
+        imageUrl: string;
+        imageAlt: string;
+        dismissLabel: string;
+        backgroundColor: string;
+        accentColor: string;
+    };
+    placements: StorefrontFormPlacement[];
+}
 interface StorefrontForm {
+    /** Published content version. Requires the managed Forms API. */
+    revision: number;
+    presentation: StorefrontFormPresentation;
     slug: string;
     name: string;
     description: string | null;
@@ -2561,6 +2589,8 @@ interface StorefrontForm {
     settings: StorefrontFormSettings;
 }
 interface StorefrontFormSubmitInput {
+    revision?: number;
+    placement?: string;
     /** `{fieldKey: value}`; unknown keys are dropped server-side. */
     data: Record<string, unknown>;
     locale?: string;
@@ -2588,6 +2618,8 @@ interface StorefrontFormFile {
     type: string;
 }
 interface StorefrontFormSubmitResult {
+    confirmationRequired?: boolean;
+    alreadySubscribed?: boolean;
     ok: boolean;
     /** Id of the stored submission (null when the form does not store responses). */
     id: string | null;
@@ -4460,6 +4492,10 @@ declare class BookingsModule {
 declare class FormsModule {
     private client;
     constructor(client: BehioStorefront);
+    /** Only active, published placements. Internal delivery/CRM settings never leave the server. */
+    placements(): Promise<SdkResult<{
+        items: StorefrontForm[];
+    }>>;
     /** Public definition of one form (fields + settings). 404 for an unknown or inactive slug. */
     get(slug: string): Promise<SdkResult<StorefrontForm>>;
     /**
@@ -5554,6 +5590,15 @@ declare function useSiteFormSubmit(slug: string): {
     error: SdkError | null;
     reset: () => void;
 };
+/** SSR initial data avoids fetching first-render configuration in an effect. */
+declare function useFormPlacements(options?: {
+    initialData?: {
+        items: StorefrontForm[];
+    };
+    enabled?: boolean;
+}): _tanstack_react_query.UseQueryResult<NoInfer<{
+    items: StorefrontForm[];
+}>, Error>;
 
 interface UseBookingsOptions {
     enabled?: boolean;
@@ -6336,7 +6381,7 @@ declare function formatPrice(amount: number, currency: string, locale?: string,
  * Consent stays the script layer's job: this helper never loads anything, it
  * only talks to runtimes that already exist on the page.
  */
-type EcommerceEventName = "view_item" | "view_item_list" | "select_item" | "add_to_cart" | "remove_from_cart" | "view_cart" | "add_to_wishlist" | "view_promotion" | "select_promotion" | "begin_checkout" | "add_payment_info" | "add_shipping_info" | "search" | "generate_lead" | "purchase" | "variant_selected" | "newsletter_signup";
+type EcommerceEventName = "view_item" | "view_item_list" | "select_item" | "add_to_cart" | "remove_from_cart" | "view_cart" | "add_to_wishlist" | "view_promotion" | "select_promotion" | "begin_checkout" | "add_payment_info" | "add_shipping_info" | "search" | "generate_lead" | "purchase" | "variant_selected" | "newsletter_signup" | "newsletter_request" | "form_popup_view";
 type EcommerceItem = {
     item_id: string;
     item_name: string;
@@ -6424,4 +6469,19 @@ declare function revokeAnalyticsConsent(client: BehioStorefront): Promise<SdkRes
     success: boolean;
 }>>;
 
-export { type ActivePromotion, type AddToCartInput, type AnalyticsEventInput, type AuthTokens, BehioAnalyticsTracker, BehioApiError, BehioProvider, type BehioProviderProps, type Blog, type BlogPostDetail, type BlogPostListItem, type BlogPostsPage, type BlogPostsQuery, type BlogSettings, type BlogTag, type Booking, type BookingCategory, type BookingConfig, type BookingCreateInput, type BookingCreated, type BookingLocale, type BookingLocation, type BookingManageSlotsQuery, type BookingService, type BookingSlot, type BookingSlots, type BookingSlotsQuery, type BookingStaff, type BookingStatus, type Bundle, type BundleItem, type Cart, type CartDiscount, type CartItem, type Category, type CategoryDetail, type CheckoutAddress, type CheckoutInput, type CheckoutPaymentMethod, type CookieConsent, type CookieConsentInput, type CrossSellItem, CurrencySwitcher, type CurrencySwitcherProps, type CurrencySwitcherRenderProps, type CustomerAddress, type CustomerProfile, type EcommerceEventName, type EcommerceItem, type EcommercePayload, type Facet, type FacetRange, type FacetValue, type FacetsResponse, type FilterField, type FulfillmentStatus, type GiftCardBalance, type LoginInput, type MessageResponse, type OrderDetail, type OrderItem, type OrderListItem, type OrderStatus, type Page, type PageAttachment, type PageDetail, type PaginatedResponse, type PaymentInstrument, type PaymentStatus, type PaymentSwift, type PersonalOffer, type ProductDetail, type ProductLabel, type ProductListItem, type ProductParameter, type ProductParameterGroup, type ProductParametersResponse, type ProductPrice, type ProductReview, type ProductReviewsResponse, type ProductVariant, type ProductsQuery, type QuoteRequest, type RegisterInput, type ReturnRequest, RichText, type RichTextProps, type ShopInfo, type ShopSeo, type SiteFormField, type SiteFormFieldOption, type SiteFormFieldType, type StorageAdapter, type StorefrontForm, type StorefrontFormFieldError, type StorefrontFormFieldErrorCode, type StorefrontFormSettings, type StorefrontFormSubmitInput, type StorefrontFormSubmitResult, StorefrontScripts, type StorefrontScriptsProps, type SubmitQuoteInput, type SubmitReturnInput, type SubmitReviewInput, type SubmitWithdrawalInput, type UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, type UseBookingsOptions, type UseCartCountOptions, type UseCartOptions, type UseCategoriesOptions, type UseCategoryOptions, type UseCertificateVerificationOptions, type UseCollectionOptions, type UseCourseCertificatesOptions, type UseCourseOptions, type UseCoursesOptions, type UseCurrencyResult, type UseCustomerOptions, type UseFacetsOptions, type UseFaqOptions, type UseFeaturedOptions, type UseFiltersOptions, type UseLabelsOptions, type UseLessonCommentsOptions, type UseLessonNoteOptions, type UseLessonQuizOptions, type UseLessonTutorOptions, type UseLoyaltyOptions, type UseMenuOptions, type UseOrderOptions, type UseOrdersOptions, type UsePageOptions, type UsePagesOptions, type UsePaymentMethodsOptions, type UsePersonalOffersOptions, type UseProductOptions, type UseProductParametersOptions, type UseProductsOptions, type UseSearchOptions, type UseShippingMethodsOptions, type UseShippingQuoteOptions, type UseShopInfoOptions, type UseShopScriptsOptions, type UseShopSeoOptions, type UseSiteFormOptions, type UseSubscriptionsOptions, type UseVisitorMessagesOptions, type VisitorMessage, type WishlistItem, type WithdrawalAcknowledgement, type WithdrawalWindow, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBookingConfig, useBookingSlots, useBundle, useBundles, useCancelBooking, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCreateBooking, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useManagedBooking, useManagedBookingSlots, useMenu, useNewsletterConfirm, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useRescheduleBooking, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubmitWithdrawal, useSubscriptions, useVisitorMessages, useWishlist };
+type FormPopupOffer = {
+    form: StorefrontForm;
+    placement: StorefrontFormPlacement;
+};
+/** One host in the shared shell. Preview never mounts it; no subscription occurs on a timer. */
+declare function useFormPopup({ forms, locales, pathname }: {
+    forms: StorefrontForm[];
+    locales: string[];
+    pathname: string;
+}): {
+    active: FormPopupOffer | null;
+    dialog: react.RefObject<HTMLDialogElement | null>;
+    dismiss: () => void;
+};
+
+export { type ActivePromotion, type AddToCartInput, type AnalyticsEventInput, type AuthTokens, BehioAnalyticsTracker, BehioApiError, BehioProvider, type BehioProviderProps, type Blog, type BlogPostDetail, type BlogPostListItem, type BlogPostsPage, type BlogPostsQuery, type BlogSettings, type BlogTag, type Booking, type BookingCategory, type BookingConfig, type BookingCreateInput, type BookingCreated, type BookingLocale, type BookingLocation, type BookingManageSlotsQuery, type BookingService, type BookingSlot, type BookingSlots, type BookingSlotsQuery, type BookingStaff, type BookingStatus, type Bundle, type BundleItem, type Cart, type CartDiscount, type CartItem, type Category, type CategoryDetail, type CheckoutAddress, type CheckoutInput, type CheckoutPaymentMethod, type CookieConsent, type CookieConsentInput, type CrossSellItem, CurrencySwitcher, type CurrencySwitcherProps, type CurrencySwitcherRenderProps, type CustomerAddress, type CustomerProfile, type EcommerceEventName, type EcommerceItem, type EcommercePayload, type Facet, type FacetRange, type FacetValue, type FacetsResponse, type FilterField, type FormPopupOffer, type FulfillmentStatus, type GiftCardBalance, type LoginInput, type MessageResponse, type OrderDetail, type OrderItem, type OrderListItem, type OrderStatus, type Page, type PageAttachment, type PageDetail, type PaginatedResponse, type PaymentInstrument, type PaymentStatus, type PaymentSwift, type PersonalOffer, type ProductDetail, type ProductLabel, type ProductListItem, type ProductParameter, type ProductParameterGroup, type ProductParametersResponse, type ProductPrice, type ProductReview, type ProductReviewsResponse, type ProductVariant, type ProductsQuery, type QuoteRequest, type RegisterInput, type ReturnRequest, RichText, type RichTextProps, type ShopInfo, type ShopSeo, type SiteFormField, type SiteFormFieldOption, type SiteFormFieldType, type StorageAdapter, type StorefrontForm, type StorefrontFormFieldError, type StorefrontFormFieldErrorCode, type StorefrontFormSettings, type StorefrontFormSubmitInput, type StorefrontFormSubmitResult, StorefrontScripts, type StorefrontScriptsProps, type SubmitQuoteInput, type SubmitReturnInput, type SubmitReviewInput, type SubmitWithdrawalInput, type UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, type UseBookingsOptions, type UseCartCountOptions, type UseCartOptions, type UseCategoriesOptions, type UseCategoryOptions, type UseCertificateVerificationOptions, type UseCollectionOptions, type UseCourseCertificatesOptions, type UseCourseOptions, type UseCoursesOptions, type UseCurrencyResult, type UseCustomerOptions, type UseFacetsOptions, type UseFaqOptions, type UseFeaturedOptions, type UseFiltersOptions, type UseLabelsOptions, type UseLessonCommentsOptions, type UseLessonNoteOptions, type UseLessonQuizOptions, type UseLessonTutorOptions, type UseLoyaltyOptions, type UseMenuOptions, type UseOrderOptions, type UseOrdersOptions, type UsePageOptions, type UsePagesOptions, type UsePaymentMethodsOptions, type UsePersonalOffersOptions, type UseProductOptions, type UseProductParametersOptions, type UseProductsOptions, type UseSearchOptions, type UseShippingMethodsOptions, type UseShippingQuoteOptions, type UseShopInfoOptions, type UseShopScriptsOptions, type UseShopSeoOptions, type UseSiteFormOptions, type UseSubscriptionsOptions, type UseVisitorMessagesOptions, type VisitorMessage, type WishlistItem, type WithdrawalAcknowledgement, type WithdrawalWindow, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBookingConfig, useBookingSlots, useBundle, useBundles, useCancelBooking, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCreateBooking, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useFormPlacements, useFormPopup, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useManagedBooking, useManagedBookingSlots, useMenu, useNewsletterConfirm, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useRescheduleBooking, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubmitWithdrawal, useSubscriptions, useVisitorMessages, useWishlist };

package/dist/react.d.ts

@@ -2553,7 +2553,35 @@ interface StorefrontFaqQuery {
     locale?: string;
 }
 /** Public definition of a form (`GET /forms/{slug}`). */
+interface StorefrontFormPlacement {
+    key: string;
+    mode: "inline" | "popup";
+    enabled: boolean;
+    delaySeconds: number;
+    dismissDays: number;
+    devices: "all" | "mobile" | "desktop";
+    /** Exact path or prefix ending in *. No regex. */
+    includePaths: string[];
+    excludePaths: string[];
+}
+interface StorefrontFormPresentation {
+    purpose: "general" | "newsletter";
+    content: {
+        eyebrow: string;
+        heading: string;
+        body: string;
+        imageUrl: string;
+        imageAlt: string;
+        dismissLabel: string;
+        backgroundColor: string;
+        accentColor: string;
+    };
+    placements: StorefrontFormPlacement[];
+}
 interface StorefrontForm {
+    /** Published content version. Requires the managed Forms API. */
+    revision: number;
+    presentation: StorefrontFormPresentation;
     slug: string;
     name: string;
     description: string | null;
@@ -2561,6 +2589,8 @@ interface StorefrontForm {
     settings: StorefrontFormSettings;
 }
 interface StorefrontFormSubmitInput {
+    revision?: number;
+    placement?: string;
     /** `{fieldKey: value}`; unknown keys are dropped server-side. */
     data: Record<string, unknown>;
     locale?: string;
@@ -2588,6 +2618,8 @@ interface StorefrontFormFile {
     type: string;
 }
 interface StorefrontFormSubmitResult {
+    confirmationRequired?: boolean;
+    alreadySubscribed?: boolean;
     ok: boolean;
     /** Id of the stored submission (null when the form does not store responses). */
     id: string | null;
@@ -4460,6 +4492,10 @@ declare class BookingsModule {
 declare class FormsModule {
     private client;
     constructor(client: BehioStorefront);
+    /** Only active, published placements. Internal delivery/CRM settings never leave the server. */
+    placements(): Promise<SdkResult<{
+        items: StorefrontForm[];
+    }>>;
     /** Public definition of one form (fields + settings). 404 for an unknown or inactive slug. */
     get(slug: string): Promise<SdkResult<StorefrontForm>>;
     /**
@@ -5554,6 +5590,15 @@ declare function useSiteFormSubmit(slug: string): {
     error: SdkError | null;
     reset: () => void;
 };
+/** SSR initial data avoids fetching first-render configuration in an effect. */
+declare function useFormPlacements(options?: {
+    initialData?: {
+        items: StorefrontForm[];
+    };
+    enabled?: boolean;
+}): _tanstack_react_query.UseQueryResult<NoInfer<{
+    items: StorefrontForm[];
+}>, Error>;
 
 interface UseBookingsOptions {
     enabled?: boolean;
@@ -6336,7 +6381,7 @@ declare function formatPrice(amount: number, currency: string, locale?: string,
  * Consent stays the script layer's job: this helper never loads anything, it
  * only talks to runtimes that already exist on the page.
  */
-type EcommerceEventName = "view_item" | "view_item_list" | "select_item" | "add_to_cart" | "remove_from_cart" | "view_cart" | "add_to_wishlist" | "view_promotion" | "select_promotion" | "begin_checkout" | "add_payment_info" | "add_shipping_info" | "search" | "generate_lead" | "purchase" | "variant_selected" | "newsletter_signup";
+type EcommerceEventName = "view_item" | "view_item_list" | "select_item" | "add_to_cart" | "remove_from_cart" | "view_cart" | "add_to_wishlist" | "view_promotion" | "select_promotion" | "begin_checkout" | "add_payment_info" | "add_shipping_info" | "search" | "generate_lead" | "purchase" | "variant_selected" | "newsletter_signup" | "newsletter_request" | "form_popup_view";
 type EcommerceItem = {
     item_id: string;
     item_name: string;
@@ -6424,4 +6469,19 @@ declare function revokeAnalyticsConsent(client: BehioStorefront): Promise<SdkRes
     success: boolean;
 }>>;
 
-export { type ActivePromotion, type AddToCartInput, type AnalyticsEventInput, type AuthTokens, BehioAnalyticsTracker, BehioApiError, BehioProvider, type BehioProviderProps, type Blog, type BlogPostDetail, type BlogPostListItem, type BlogPostsPage, type BlogPostsQuery, type BlogSettings, type BlogTag, type Booking, type BookingCategory, type BookingConfig, type BookingCreateInput, type BookingCreated, type BookingLocale, type BookingLocation, type BookingManageSlotsQuery, type BookingService, type BookingSlot, type BookingSlots, type BookingSlotsQuery, type BookingStaff, type BookingStatus, type Bundle, type BundleItem, type Cart, type CartDiscount, type CartItem, type Category, type CategoryDetail, type CheckoutAddress, type CheckoutInput, type CheckoutPaymentMethod, type CookieConsent, type CookieConsentInput, type CrossSellItem, CurrencySwitcher, type CurrencySwitcherProps, type CurrencySwitcherRenderProps, type CustomerAddress, type CustomerProfile, type EcommerceEventName, type EcommerceItem, type EcommercePayload, type Facet, type FacetRange, type FacetValue, type FacetsResponse, type FilterField, type FulfillmentStatus, type GiftCardBalance, type LoginInput, type MessageResponse, type OrderDetail, type OrderItem, type OrderListItem, type OrderStatus, type Page, type PageAttachment, type PageDetail, type PaginatedResponse, type PaymentInstrument, type PaymentStatus, type PaymentSwift, type PersonalOffer, type ProductDetail, type ProductLabel, type ProductListItem, type ProductParameter, type ProductParameterGroup, type ProductParametersResponse, type ProductPrice, type ProductReview, type ProductReviewsResponse, type ProductVariant, type ProductsQuery, type QuoteRequest, type RegisterInput, type ReturnRequest, RichText, type RichTextProps, type ShopInfo, type ShopSeo, type SiteFormField, type SiteFormFieldOption, type SiteFormFieldType, type StorageAdapter, type StorefrontForm, type StorefrontFormFieldError, type StorefrontFormFieldErrorCode, type StorefrontFormSettings, type StorefrontFormSubmitInput, type StorefrontFormSubmitResult, StorefrontScripts, type StorefrontScriptsProps, type SubmitQuoteInput, type SubmitReturnInput, type SubmitReviewInput, type SubmitWithdrawalInput, type UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, type UseBookingsOptions, type UseCartCountOptions, type UseCartOptions, type UseCategoriesOptions, type UseCategoryOptions, type UseCertificateVerificationOptions, type UseCollectionOptions, type UseCourseCertificatesOptions, type UseCourseOptions, type UseCoursesOptions, type UseCurrencyResult, type UseCustomerOptions, type UseFacetsOptions, type UseFaqOptions, type UseFeaturedOptions, type UseFiltersOptions, type UseLabelsOptions, type UseLessonCommentsOptions, type UseLessonNoteOptions, type UseLessonQuizOptions, type UseLessonTutorOptions, type UseLoyaltyOptions, type UseMenuOptions, type UseOrderOptions, type UseOrdersOptions, type UsePageOptions, type UsePagesOptions, type UsePaymentMethodsOptions, type UsePersonalOffersOptions, type UseProductOptions, type UseProductParametersOptions, type UseProductsOptions, type UseSearchOptions, type UseShippingMethodsOptions, type UseShippingQuoteOptions, type UseShopInfoOptions, type UseShopScriptsOptions, type UseShopSeoOptions, type UseSiteFormOptions, type UseSubscriptionsOptions, type UseVisitorMessagesOptions, type VisitorMessage, type WishlistItem, type WithdrawalAcknowledgement, type WithdrawalWindow, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBookingConfig, useBookingSlots, useBundle, useBundles, useCancelBooking, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCreateBooking, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useManagedBooking, useManagedBookingSlots, useMenu, useNewsletterConfirm, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useRescheduleBooking, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubmitWithdrawal, useSubscriptions, useVisitorMessages, useWishlist };
+type FormPopupOffer = {
+    form: StorefrontForm;
+    placement: StorefrontFormPlacement;
+};
+/** One host in the shared shell. Preview never mounts it; no subscription occurs on a timer. */
+declare function useFormPopup({ forms, locales, pathname }: {
+    forms: StorefrontForm[];
+    locales: string[];
+    pathname: string;
+}): {
+    active: FormPopupOffer | null;
+    dialog: react.RefObject<HTMLDialogElement | null>;
+    dismiss: () => void;
+};
+
+export { type ActivePromotion, type AddToCartInput, type AnalyticsEventInput, type AuthTokens, BehioAnalyticsTracker, BehioApiError, BehioProvider, type BehioProviderProps, type Blog, type BlogPostDetail, type BlogPostListItem, type BlogPostsPage, type BlogPostsQuery, type BlogSettings, type BlogTag, type Booking, type BookingCategory, type BookingConfig, type BookingCreateInput, type BookingCreated, type BookingLocale, type BookingLocation, type BookingManageSlotsQuery, type BookingService, type BookingSlot, type BookingSlots, type BookingSlotsQuery, type BookingStaff, type BookingStatus, type Bundle, type BundleItem, type Cart, type CartDiscount, type CartItem, type Category, type CategoryDetail, type CheckoutAddress, type CheckoutInput, type CheckoutPaymentMethod, type CookieConsent, type CookieConsentInput, type CrossSellItem, CurrencySwitcher, type CurrencySwitcherProps, type CurrencySwitcherRenderProps, type CustomerAddress, type CustomerProfile, type EcommerceEventName, type EcommerceItem, type EcommercePayload, type Facet, type FacetRange, type FacetValue, type FacetsResponse, type FilterField, type FormPopupOffer, type FulfillmentStatus, type GiftCardBalance, type LoginInput, type MessageResponse, type OrderDetail, type OrderItem, type OrderListItem, type OrderStatus, type Page, type PageAttachment, type PageDetail, type PaginatedResponse, type PaymentInstrument, type PaymentStatus, type PaymentSwift, type PersonalOffer, type ProductDetail, type ProductLabel, type ProductListItem, type ProductParameter, type ProductParameterGroup, type ProductParametersResponse, type ProductPrice, type ProductReview, type ProductReviewsResponse, type ProductVariant, type ProductsQuery, type QuoteRequest, type RegisterInput, type ReturnRequest, RichText, type RichTextProps, type ShopInfo, type ShopSeo, type SiteFormField, type SiteFormFieldOption, type SiteFormFieldType, type StorageAdapter, type StorefrontForm, type StorefrontFormFieldError, type StorefrontFormFieldErrorCode, type StorefrontFormSettings, type StorefrontFormSubmitInput, type StorefrontFormSubmitResult, StorefrontScripts, type StorefrontScriptsProps, type SubmitQuoteInput, type SubmitReturnInput, type SubmitReviewInput, type SubmitWithdrawalInput, type UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, type UseBookingsOptions, type UseCartCountOptions, type UseCartOptions, type UseCategoriesOptions, type UseCategoryOptions, type UseCertificateVerificationOptions, type UseCollectionOptions, type UseCourseCertificatesOptions, type UseCourseOptions, type UseCoursesOptions, type UseCurrencyResult, type UseCustomerOptions, type UseFacetsOptions, type UseFaqOptions, type UseFeaturedOptions, type UseFiltersOptions, type UseLabelsOptions, type UseLessonCommentsOptions, type UseLessonNoteOptions, type UseLessonQuizOptions, type UseLessonTutorOptions, type UseLoyaltyOptions, type UseMenuOptions, type UseOrderOptions, type UseOrdersOptions, type UsePageOptions, type UsePagesOptions, type UsePaymentMethodsOptions, type UsePersonalOffersOptions, type UseProductOptions, type UseProductParametersOptions, type UseProductsOptions, type UseSearchOptions, type UseShippingMethodsOptions, type UseShippingQuoteOptions, type UseShopInfoOptions, type UseShopScriptsOptions, type UseShopSeoOptions, type UseSiteFormOptions, type UseSubscriptionsOptions, type UseVisitorMessagesOptions, type VisitorMessage, type WishlistItem, type WithdrawalAcknowledgement, type WithdrawalWindow, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBookingConfig, useBookingSlots, useBundle, useBundles, useCancelBooking, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCreateBooking, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useFormPlacements, useFormPopup, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useManagedBooking, useManagedBookingSlots, useMenu, useNewsletterConfirm, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useRescheduleBooking, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubmitWithdrawal, useSubscriptions, useVisitorMessages, useWishlist };