@behio/storefront-sdk 2.20.0 → 2.22.0

package/dist/react.d.mts

@@ -2257,6 +2257,8 @@ interface Page {
     updatedAt?: number;
 }
 interface PageDetail {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     slug: string;
     title: string;
     /**
@@ -2298,6 +2300,8 @@ interface BlogSettings {
 }
 /** One blog (a group of posts). A site can have several: news, recipes, stories. */
 interface Blog {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     /** URL segment: /blog/{handle} */
     handle: string;
     name: string;
@@ -2332,6 +2336,8 @@ interface BlogPostsPage {
     tags: BlogTag[];
 }
 interface BlogPostDetail {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     slug: string;
     blogHandle: string;
     blogName: string;
@@ -2454,6 +2460,42 @@ interface StorefrontCollectionQuery {
     limit?: number;
     offset?: number;
 }
+/** One visible question of an FAQ group. */
+interface StorefrontFaqItem {
+    id: string;
+    question: string;
+    /** Cleaned HTML of the answer (paragraphs, emphasis, links, lists). */
+    answer: string;
+}
+/** An FAQ group in the list (`GET /faq`). */
+interface StorefrontFaqGroupSummary {
+    id: string;
+    /** Stable identifier the owner sets in the admin (use it in code). */
+    slug: string;
+    name: string;
+    description: string | null;
+    /** Number of visible questions. */
+    itemCount: number;
+}
+/** FAQ groups of the site in the admin order (`GET /faq`). */
+interface StorefrontFaqGroups {
+    items: StorefrontFaqGroupSummary[];
+    /** Language the texts are in (the requested one when the site offers it, else the main language). */
+    locale: string;
+}
+/** One FAQ group with its visible questions in the admin order (`GET /faq/{group}`). */
+interface StorefrontFaqGroup {
+    id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    locale: string;
+    items: StorefrontFaqItem[];
+}
+interface StorefrontFaqQuery {
+    /** Language of the texts; defaults to the client locale, then the main language of the site. */
+    locale?: string;
+}
 /** Public definition of a form (`GET /forms/{slug}`). */
 interface StorefrontForm {
     slug: string;
@@ -3341,6 +3383,7 @@ declare class BehioStorefront {
     readonly blog: BlogModule;
     readonly forms: FormsModule;
     readonly collections: CollectionsModule;
+    readonly faq: FaqModule;
     readonly wishlist: WishlistModule;
     readonly reviews: ReviewsModule;
     readonly returns: ReturnsModule;
@@ -4071,6 +4114,29 @@ declare class CollectionsModule {
      */
     item(slug: string, itemSlugOrId: string): Promise<SdkResult<StorefrontCollectionItem>>;
 }
+/**
+ * Frequently asked questions: groups of questions and answers the owner
+ * writes in the Behio admin (FAQ module) in every language of the site.
+ * Only visible questions are returned, in the admin order, in the requested
+ * language (a missing translation falls back to the main language of the
+ * site). Answers are cleaned HTML (paragraphs, emphasis, links, lists).
+ * Cached by Behio and invalidated on every admin change. Works with website
+ * keys that have no e-shop attached.
+ *
+ * Tip: render the questions with `FAQPage` structured data (JSON-LD) so
+ * search engines and AI assistants recognise them as answers.
+ */
+declare class FaqModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** FAQ groups of the site in the admin order with the number of visible questions. */
+    list(query?: StorefrontFaqQuery): Promise<SdkResult<StorefrontFaqGroups>>;
+    /**
+     * One group by its slug or id with its visible questions. 404
+     * `be.faq.groupNotFound` for an unknown group.
+     */
+    get(group: string, query?: StorefrontFaqQuery): Promise<SdkResult<StorefrontFaqGroup>>;
+}
 /**
  * Merchant-defined forms (contact, demand, registration to an event...).
  * The definition is public and cacheable; a submit is validated server-side
@@ -5114,6 +5180,14 @@ declare function useCollection(slug: string, query?: StorefrontCollectionQuery,
 /** One published collection item by slug or id (detail page). */
 declare function useCollectionItem(slug: string, itemSlugOrId: string, options?: UseCollectionOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontCollectionItem>, Error>;
 
+interface UseFaqOptions {
+    enabled?: boolean;
+}
+/** FAQ groups of the site with the number of visible questions. */
+declare function useFaqGroups(query?: StorefrontFaqQuery, options?: UseFaqOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontFaqGroups>, Error>;
+/** One FAQ group (slug or id) with its visible questions in the admin order. */
+declare function useFaqGroup(group: string, query?: StorefrontFaqQuery, options?: UseFaqOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontFaqGroup>, Error>;
+
 interface UseSiteFormOptions {
     enabled?: boolean;
 }
@@ -5983,4 +6057,4 @@ 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 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 UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, 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 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, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCrossSell, useCurrency, useCustomer, useFacets, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useMenu, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubscriptions, useVisitorMessages, useWishlist };
+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 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 UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, 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, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useMenu, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubscriptions, useVisitorMessages, useWishlist };

package/dist/react.d.ts

@@ -2257,6 +2257,8 @@ interface Page {
     updatedAt?: number;
 }
 interface PageDetail {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     slug: string;
     title: string;
     /**
@@ -2298,6 +2300,8 @@ interface BlogSettings {
 }
 /** One blog (a group of posts). A site can have several: news, recipes, stories. */
 interface Blog {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     /** URL segment: /blog/{handle} */
     handle: string;
     name: string;
@@ -2332,6 +2336,8 @@ interface BlogPostsPage {
     tags: BlogTag[];
 }
 interface BlogPostDetail {
+    /** Stable public content identifier for template assignment. */
+    id: string;
     slug: string;
     blogHandle: string;
     blogName: string;
@@ -2454,6 +2460,42 @@ interface StorefrontCollectionQuery {
     limit?: number;
     offset?: number;
 }
+/** One visible question of an FAQ group. */
+interface StorefrontFaqItem {
+    id: string;
+    question: string;
+    /** Cleaned HTML of the answer (paragraphs, emphasis, links, lists). */
+    answer: string;
+}
+/** An FAQ group in the list (`GET /faq`). */
+interface StorefrontFaqGroupSummary {
+    id: string;
+    /** Stable identifier the owner sets in the admin (use it in code). */
+    slug: string;
+    name: string;
+    description: string | null;
+    /** Number of visible questions. */
+    itemCount: number;
+}
+/** FAQ groups of the site in the admin order (`GET /faq`). */
+interface StorefrontFaqGroups {
+    items: StorefrontFaqGroupSummary[];
+    /** Language the texts are in (the requested one when the site offers it, else the main language). */
+    locale: string;
+}
+/** One FAQ group with its visible questions in the admin order (`GET /faq/{group}`). */
+interface StorefrontFaqGroup {
+    id: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    locale: string;
+    items: StorefrontFaqItem[];
+}
+interface StorefrontFaqQuery {
+    /** Language of the texts; defaults to the client locale, then the main language of the site. */
+    locale?: string;
+}
 /** Public definition of a form (`GET /forms/{slug}`). */
 interface StorefrontForm {
     slug: string;
@@ -3341,6 +3383,7 @@ declare class BehioStorefront {
     readonly blog: BlogModule;
     readonly forms: FormsModule;
     readonly collections: CollectionsModule;
+    readonly faq: FaqModule;
     readonly wishlist: WishlistModule;
     readonly reviews: ReviewsModule;
     readonly returns: ReturnsModule;
@@ -4071,6 +4114,29 @@ declare class CollectionsModule {
      */
     item(slug: string, itemSlugOrId: string): Promise<SdkResult<StorefrontCollectionItem>>;
 }
+/**
+ * Frequently asked questions: groups of questions and answers the owner
+ * writes in the Behio admin (FAQ module) in every language of the site.
+ * Only visible questions are returned, in the admin order, in the requested
+ * language (a missing translation falls back to the main language of the
+ * site). Answers are cleaned HTML (paragraphs, emphasis, links, lists).
+ * Cached by Behio and invalidated on every admin change. Works with website
+ * keys that have no e-shop attached.
+ *
+ * Tip: render the questions with `FAQPage` structured data (JSON-LD) so
+ * search engines and AI assistants recognise them as answers.
+ */
+declare class FaqModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** FAQ groups of the site in the admin order with the number of visible questions. */
+    list(query?: StorefrontFaqQuery): Promise<SdkResult<StorefrontFaqGroups>>;
+    /**
+     * One group by its slug or id with its visible questions. 404
+     * `be.faq.groupNotFound` for an unknown group.
+     */
+    get(group: string, query?: StorefrontFaqQuery): Promise<SdkResult<StorefrontFaqGroup>>;
+}
 /**
  * Merchant-defined forms (contact, demand, registration to an event...).
  * The definition is public and cacheable; a submit is validated server-side
@@ -5114,6 +5180,14 @@ declare function useCollection(slug: string, query?: StorefrontCollectionQuery,
 /** One published collection item by slug or id (detail page). */
 declare function useCollectionItem(slug: string, itemSlugOrId: string, options?: UseCollectionOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontCollectionItem>, Error>;
 
+interface UseFaqOptions {
+    enabled?: boolean;
+}
+/** FAQ groups of the site with the number of visible questions. */
+declare function useFaqGroups(query?: StorefrontFaqQuery, options?: UseFaqOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontFaqGroups>, Error>;
+/** One FAQ group (slug or id) with its visible questions in the admin order. */
+declare function useFaqGroup(group: string, query?: StorefrontFaqQuery, options?: UseFaqOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontFaqGroup>, Error>;
+
 interface UseSiteFormOptions {
     enabled?: boolean;
 }
@@ -5983,4 +6057,4 @@ 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 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 UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, 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 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, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCrossSell, useCurrency, useCustomer, useFacets, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useMenu, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubscriptions, useVisitorMessages, useWishlist };
+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 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 UseAddressAutocompleteOptions, type UseAddressAutocompleteReturn, type UseAddressesOptions, type UseBlogPostOptions, type UseBlogPostsOptions, type UseBlogsOptions, 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, cookieStorage, createMemoryStorage, detectStorage, formatPrice, generateVisitorId, getStoredVisitorId, grantAnalyticsConsent, localStorageAdapter, memoryStorage, revokeAnalyticsConsent, trackEcommerceEvent, useAddressAutocomplete, useAddresses, useAnalyticsEvents, useAuth, useBehio, useBehioClient, useBlogPost, useBlogPosts, useBlogs, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCertificateVerification, useCheckout, useCheckoutPreview, useCollection, useCollectionItem, useCookieConsent, useCourse, useCourseCertificates, useCourses, useCrossSell, useCurrency, useCustomer, useFacets, useFaqGroup, useFaqGroups, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useLessonComments, useLessonNote, useLessonQuiz, useLessonTutor, useLookupReturnableOrder, useLoyalty, useMenu, useNewsletterSubscribe, useNewsletterUnsubscribe, useNotifyWhenAvailable, useOrder, useOrderAccess, useOrders, usePage, usePages, usePaymentMethods, usePersonalOffers, usePickupPoints, useProduct, useProductGroup, useProductParameters, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useReturnStatus, useSearch, useShippingMethods, useShippingQuote, useShopInfo, useShopScripts, useShopSeo, useSiteForm, useSiteFormSubmit, useSubmitQuote, useSubmitReturn, useSubmitReview, useSubscriptions, useVisitorMessages, useWishlist };

package/dist/react.js

@@ -65,6 +65,8 @@ __export(react_exports, {
   useCurrency: () => useCurrency,
   useCustomer: () => useCustomer,
   useFacets: () => useFacets,
+  useFaqGroup: () => useFaqGroup,
+  useFaqGroups: () => useFaqGroups,
   useFeatured: () => useFeatured,
   useFilters: () => useFilters,
   useGiftCardBalance: () => useGiftCardBalance,
@@ -285,6 +287,7 @@ var BehioStorefront = class {
     this.blog = new BlogModule(this);
     this.forms = new FormsModule(this);
     this.collections = new CollectionsModule(this);
+    this.faq = new FaqModule(this);
     this.wishlist = new WishlistModule(this);
     this.reviews = new ReviewsModule(this);
     this.returns = new ReturnsModule(this);
@@ -1941,6 +1944,26 @@ var CollectionsModule = class {
     );
   }
 };
+var FaqModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** FAQ groups of the site in the admin order with the number of visible questions. */
+  async list(query) {
+    return this.client.request("GET", "/faq", {
+      query: { locale: query?.locale }
+    });
+  }
+  /**
+   * One group by its slug or id with its visible questions. 404
+   * `be.faq.groupNotFound` for an unknown group.
+   */
+  async get(group, query) {
+    return this.client.request("GET", `/faq/${encodeURIComponent(group)}`, {
+      query: { locale: query?.locale }
+    });
+  }
+};
 var FormsModule = class {
   constructor(client) {
     this.client = client;
@@ -4116,9 +4139,28 @@ function useCollectionItem(slug, itemSlugOrId, options) {
   });
 }
 
+// src/react/hooks/use-faq.ts
+var import_react_query38 = require("@tanstack/react-query");
+function useFaqGroups(query, options) {
+  const { client } = useBehio();
+  return (0, import_react_query38.useQuery)({
+    queryKey: ["behio", "faq", query?.locale],
+    queryFn: () => unwrap(client.faq.list(query)),
+    enabled: options?.enabled !== false
+  });
+}
+function useFaqGroup(group, query, options) {
+  const { client } = useBehio();
+  return (0, import_react_query38.useQuery)({
+    queryKey: ["behio", "faq", group, query?.locale],
+    queryFn: () => unwrap(client.faq.get(group, query)),
+    enabled: options?.enabled !== false && !!group
+  });
+}
+
 // src/react/hooks/use-site-form.ts
 var import_react17 = require("react");
-var import_react_query38 = require("@tanstack/react-query");
+var import_react_query39 = require("@tanstack/react-query");
 
 // src/errors.ts
 function bodyOf(err) {
@@ -4169,7 +4211,7 @@ function formFieldErrors(err) {
 // src/react/hooks/use-site-form.ts
 function useSiteForm(slug, options) {
   const { client } = useBehio();
-  return (0, import_react_query38.useQuery)({
+  return (0, import_react_query39.useQuery)({
     queryKey: ["behio", "form", slug],
     queryFn: () => unwrap(client.forms.get(slug)),
     enabled: options?.enabled !== false && !!slug
@@ -4177,7 +4219,7 @@ function useSiteForm(slug, options) {
 }
 function useSiteFormSubmit(slug) {
   const { client } = useBehio();
-  const mutation = (0, import_react_query38.useMutation)({
+  const mutation = (0, import_react_query39.useMutation)({
     mutationFn: (input) => unwrap(client.forms.submit(slug, input))
   });
   const sdkError = mutation.error instanceof UnwrappedError ? mutation.error.sdkError : null;
@@ -4213,10 +4255,10 @@ function useSiteFormSubmit(slug) {
 }
 
 // src/react/hooks/use-shop-info.ts
-var import_react_query39 = require("@tanstack/react-query");
+var import_react_query40 = require("@tanstack/react-query");
 function useShopInfo(options) {
   const { client } = useBehio();
-  return (0, import_react_query39.useQuery)({
+  return (0, import_react_query40.useQuery)({
     queryKey: ["behio", "shop-info"],
     queryFn: () => unwrap(client.getShopInfo()),
     enabled: options?.enabled !== false
@@ -4224,10 +4266,10 @@ function useShopInfo(options) {
 }
 
 // src/react/hooks/use-shop-scripts.ts
-var import_react_query40 = require("@tanstack/react-query");
+var import_react_query41 = require("@tanstack/react-query");
 function useShopScripts(options) {
   const { client } = useBehio();
-  return (0, import_react_query40.useQuery)({
+  return (0, import_react_query41.useQuery)({
     queryKey: ["behio", "shop-scripts"],
     queryFn: () => unwrap(client.getShopScripts()),
     enabled: options?.enabled !== false,
@@ -4236,11 +4278,11 @@ function useShopScripts(options) {
 }
 
 // src/react/hooks/use-shop-seo.ts
-var import_react_query41 = require("@tanstack/react-query");
+var import_react_query42 = require("@tanstack/react-query");
 function useShopSeo(options) {
   const { client } = useBehio();
   const { locale, initialData, enabled = true } = options ?? {};
-  return (0, import_react_query41.useQuery)({
+  return (0, import_react_query42.useQuery)({
     queryKey: ["behio", "shop-seo", locale ?? "_default"],
     queryFn: () => unwrap(client.getShopSeo(locale)),
     initialData,
@@ -4303,20 +4345,20 @@ function CurrencySwitcher({
 var import_react18 = require("react");
 
 // src/react/hooks/use-consent.ts
-var import_react_query42 = require("@tanstack/react-query");
+var import_react_query43 = require("@tanstack/react-query");
 function useCookieConsent(visitorId) {
   const { client } = useBehio();
-  const qc = (0, import_react_query42.useQueryClient)();
-  const query = (0, import_react_query42.useQuery)({
+  const qc = (0, import_react_query43.useQueryClient)();
+  const query = (0, import_react_query43.useQuery)({
     queryKey: ["behio", "consent", visitorId],
     queryFn: () => unwrap(client.consent.get(visitorId)),
     enabled: Boolean(visitorId)
   });
-  const recordMutation = (0, import_react_query42.useMutation)({
+  const recordMutation = (0, import_react_query43.useMutation)({
     mutationFn: (input) => unwrap(client.consent.record(input)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "consent"] })
   });
-  const revokeMutation = (0, import_react_query42.useMutation)({
+  const revokeMutation = (0, import_react_query43.useMutation)({
     mutationFn: () => unwrap(client.consent.revoke(visitorId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "consent"] })
   });
@@ -4695,11 +4737,11 @@ function RichText({ html, className, as = "div" }) {
 }
 
 // src/react/hooks/use-bundles.ts
-var import_react_query43 = require("@tanstack/react-query");
+var import_react_query44 = require("@tanstack/react-query");
 function useBundles(options) {
   const { client, sessionRestored } = useBehio();
   const query = { locale: options?.locale ?? client.getLocale(), currency: options?.currency ?? client.getCurrency(), country: options?.country ?? client.getCountry() };
-  return (0, import_react_query43.useQuery)({
+  return (0, import_react_query44.useQuery)({
     queryKey: ["behio", "bundles", query],
     queryFn: () => unwrap(client.catalog.getBundles(query)),
     enabled: sessionRestored && (options?.enabled ?? true),
@@ -4709,7 +4751,7 @@ function useBundles(options) {
 function useBundle(slug, options) {
   const { client, sessionRestored } = useBehio();
   const query = { locale: options?.locale ?? client.getLocale(), currency: options?.currency ?? client.getCurrency(), country: options?.country ?? client.getCountry() };
-  return (0, import_react_query43.useQuery)({
+  return (0, import_react_query44.useQuery)({
     queryKey: ["behio", "bundle", slug, query],
     queryFn: () => unwrap(client.catalog.getBundle(slug, query)),
     enabled: sessionRestored && Boolean(slug) && (options?.enabled ?? true),
@@ -4718,10 +4760,10 @@ function useBundle(slug, options) {
 }
 
 // src/react/hooks/use-product-group.ts
-var import_react_query44 = require("@tanstack/react-query");
+var import_react_query45 = require("@tanstack/react-query");
 function useProductGroup(slug, options) {
   const { client } = useBehio();
-  return (0, import_react_query44.useQuery)({
+  return (0, import_react_query45.useQuery)({
     queryKey: ["behio", "product-group", slug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getProductGroup(slug, {
@@ -4735,10 +4777,10 @@ function useProductGroup(slug, options) {
 }
 
 // src/react/hooks/use-cross-sell.ts
-var import_react_query45 = require("@tanstack/react-query");
+var import_react_query46 = require("@tanstack/react-query");
 function useCrossSell(productSlug, options) {
   const { client } = useBehio();
-  return (0, import_react_query45.useQuery)({
+  return (0, import_react_query46.useQuery)({
     queryKey: ["behio", "cross-sell", productSlug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getCrossSell(productSlug, {
@@ -4752,10 +4794,10 @@ function useCrossSell(productSlug, options) {
 }
 
 // src/react/hooks/use-product-promotions.ts
-var import_react_query46 = require("@tanstack/react-query");
+var import_react_query47 = require("@tanstack/react-query");
 function useProductPromotions(productSlug, options) {
   const { client } = useBehio();
-  return (0, import_react_query46.useQuery)({
+  return (0, import_react_query47.useQuery)({
     queryKey: ["behio", "product-promotions", productSlug],
     queryFn: () => unwrap(client.catalog.getProductPromotions(productSlug)),
     enabled: Boolean(productSlug) && (options?.enabled ?? true),
@@ -4764,11 +4806,11 @@ function useProductPromotions(productSlug, options) {
 }
 
 // src/react/hooks/use-gift-card.ts
-var import_react_query47 = require("@tanstack/react-query");
+var import_react_query48 = require("@tanstack/react-query");
 function useGiftCardBalance(code, options) {
   const { client } = useBehio();
   const trimmed = code?.trim();
-  return (0, import_react_query47.useQuery)({
+  return (0, import_react_query48.useQuery)({
     queryKey: ["behio", "gift-card-balance", trimmed],
     queryFn: () => unwrap(client.catalog.checkGiftCard(trimmed)),
     enabled: Boolean(trimmed && trimmed.length >= 6) && (options?.enabled ?? true)
@@ -4776,20 +4818,20 @@ function useGiftCardBalance(code, options) {
 }
 
 // src/react/hooks/use-wishlist.ts
-var import_react_query48 = require("@tanstack/react-query");
+var import_react_query49 = require("@tanstack/react-query");
 function useWishlist(options) {
   const { client } = useBehio();
-  const qc = (0, import_react_query48.useQueryClient)();
-  const query = (0, import_react_query48.useQuery)({
+  const qc = (0, import_react_query49.useQueryClient)();
+  const query = (0, import_react_query49.useQuery)({
     queryKey: ["behio", "wishlist"],
     queryFn: () => unwrap(client.wishlist.get()),
     enabled: options?.enabled ?? true
   });
-  const addMutation = (0, import_react_query48.useMutation)({
+  const addMutation = (0, import_react_query49.useMutation)({
     mutationFn: (productId) => unwrap(client.wishlist.add(productId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "wishlist"] })
   });
-  const removeMutation = (0, import_react_query48.useMutation)({
+  const removeMutation = (0, import_react_query49.useMutation)({
     mutationFn: (productId) => unwrap(client.wishlist.remove(productId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "wishlist"] })
   });
@@ -4803,7 +4845,7 @@ function useWishlist(options) {
 }
 function useIsInWishlist(productId) {
   const { client } = useBehio();
-  return (0, import_react_query48.useQuery)({
+  return (0, import_react_query49.useQuery)({
     queryKey: ["behio", "wishlist-check", productId],
     queryFn: () => unwrap(client.wishlist.isInWishlist(productId)),
     enabled: Boolean(productId)
@@ -4811,10 +4853,10 @@ function useIsInWishlist(productId) {
 }
 
 // src/react/hooks/use-reviews.ts
-var import_react_query49 = require("@tanstack/react-query");
+var import_react_query50 = require("@tanstack/react-query");
 function useProductReviews(productId, options) {
   const { client } = useBehio();
-  return (0, import_react_query49.useQuery)({
+  return (0, import_react_query50.useQuery)({
     queryKey: ["behio", "reviews", productId, options?.page ?? 1, options?.limit ?? 20],
     queryFn: () => unwrap(client.reviews.getProductReviews(productId, options?.page, options?.limit)),
     initialData: options?.initialData,
@@ -4824,30 +4866,30 @@ function useProductReviews(productId, options) {
 }
 function useSubmitReview() {
   const { client } = useBehio();
-  const qc = (0, import_react_query49.useQueryClient)();
-  return (0, import_react_query49.useMutation)({
+  const qc = (0, import_react_query50.useQueryClient)();
+  return (0, import_react_query50.useMutation)({
     mutationFn: (input) => unwrap(client.reviews.submit(input)),
     onSuccess: (_, input) => qc.invalidateQueries({ queryKey: ["behio", "reviews", input.productId] })
   });
 }
 
 // src/react/hooks/use-returns.ts
-var import_react_query50 = require("@tanstack/react-query");
+var import_react_query51 = require("@tanstack/react-query");
 function useLookupReturnableOrder() {
   const { client } = useBehio();
-  return (0, import_react_query50.useMutation)({
+  return (0, import_react_query51.useMutation)({
     mutationFn: ({ orderNumber, email }) => unwrap(client.returns.lookupOrder(orderNumber, email))
   });
 }
 function useSubmitReturn() {
   const { client } = useBehio();
-  return (0, import_react_query50.useMutation)({
+  return (0, import_react_query51.useMutation)({
     mutationFn: (input) => unwrap(client.returns.submit(input))
   });
 }
 function useReturnStatus(returnId, email) {
   const { client } = useBehio();
-  return (0, import_react_query50.useQuery)({
+  return (0, import_react_query51.useQuery)({
     queryKey: ["behio", "return-status", returnId],
     queryFn: () => unwrap(client.returns.getStatus(returnId, email)),
     enabled: Boolean(returnId && email)
@@ -4855,16 +4897,16 @@ function useReturnStatus(returnId, email) {
 }
 
 // src/react/hooks/use-quotes.ts
-var import_react_query51 = require("@tanstack/react-query");
+var import_react_query52 = require("@tanstack/react-query");
 function useSubmitQuote() {
   const { client } = useBehio();
-  return (0, import_react_query51.useMutation)({
+  return (0, import_react_query52.useMutation)({
     mutationFn: (input) => unwrap(client.quotes.submit(input))
   });
 }
 function useQuoteStatus(quoteId, email) {
   const { client } = useBehio();
-  return (0, import_react_query51.useQuery)({
+  return (0, import_react_query52.useQuery)({
     queryKey: ["behio", "quote-status", quoteId],
     queryFn: () => unwrap(client.quotes.getStatus(quoteId, email)),
     enabled: Boolean(quoteId && email)
@@ -4872,10 +4914,10 @@ function useQuoteStatus(quoteId, email) {
 }
 
 // src/react/hooks/use-back-in-stock.ts
-var import_react_query52 = require("@tanstack/react-query");
+var import_react_query53 = require("@tanstack/react-query");
 function useNotifyWhenAvailable() {
   const { client } = useBehio();
-  return (0, import_react_query52.useMutation)({
+  return (0, import_react_query53.useMutation)({
     mutationFn: ({ productId, email }) => unwrap(client.catalog.notifyWhenAvailable(productId, email))
   });
 }
@@ -5043,6 +5085,8 @@ async function revokeAnalyticsConsent(client) {
   useCurrency,
   useCustomer,
   useFacets,
+  useFaqGroup,
+  useFaqGroups,
   useFeatured,
   useFilters,
   useGiftCardBalance,