@behio/storefront-sdk 2.16.0 → 2.17.0

package/dist/react.d.mts

@@ -2381,6 +2381,43 @@ interface StorefrontFormSettings {
     /** When true, `consent: true` is required for the submit to pass. */
     requireConsent?: boolean;
 }
+/** Field types of a data collection. */
+type StorefrontCollectionFieldType = "text" | "longtext" | "number" | "boolean" | "date" | "url" | "image" | "email" | "select" | "tags";
+/** One field of a data collection; item values live under `data[key]`. */
+interface StorefrontCollectionField {
+    key: string;
+    type: StorefrontCollectionFieldType;
+    label: string;
+    required: boolean;
+    help?: string;
+    /** Choices for `select`, suggestions for `tags`. */
+    options?: string[];
+}
+/** One published item of a data collection. */
+interface StorefrontCollectionItem {
+    id: string;
+    /** Detail address, unique in the collection; null when the item has none. */
+    slug: string | null;
+    /** `{fieldKey: value}`: text, number, boolean, `YYYY-MM-DD` date, URL, string[] for tags. */
+    data: Record<string, unknown>;
+    createdAt: number;
+    updatedAt: number;
+}
+/** A public data collection (`GET /collections/{slug}`). */
+interface StorefrontCollection {
+    slug: string;
+    name: string;
+    description: string | null;
+    fields: StorefrontCollectionField[];
+    items: StorefrontCollectionItem[];
+    /** Number of published items (for paging). */
+    total: number;
+}
+interface StorefrontCollectionQuery {
+    /** 1 to 200, default 100. */
+    limit?: number;
+    offset?: number;
+}
 /** Public definition of a form (`GET /forms/{slug}`). */
 interface StorefrontForm {
     slug: string;
@@ -3267,6 +3304,7 @@ declare class BehioStorefront {
     readonly pages: PagesModule;
     readonly blog: BlogModule;
     readonly forms: FormsModule;
+    readonly collections: CollectionsModule;
     readonly wishlist: WishlistModule;
     readonly reviews: ReviewsModule;
     readonly returns: ReturnsModule;
@@ -3974,6 +4012,29 @@ declare class BlogModule {
     /** One published post with sanitised HTML content and related posts. */
     post(handle: string, slug: string, locale?: string): Promise<SdkResult<BlogPostDetail>>;
 }
+/**
+ * Data collections: structured content the owner edits in Behio (team,
+ * references, price list, FAQ, listings) and the site reads at runtime, so
+ * no site needs its own database. Only public collections and published
+ * items are returned. Cached by Behio and invalidated on every admin change.
+ * Works with website keys that have no e-shop attached.
+ */
+declare class CollectionsModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /**
+     * One collection with its published items in the owner's order.
+     * `limit` 1 to 200 (default 100), `offset` for paging; `total` is the
+     * number of published items. 404 `be.collections.collectionNotFound` for an
+     * unknown or private slug.
+     */
+    get(slug: string, query?: StorefrontCollectionQuery): Promise<SdkResult<StorefrontCollection>>;
+    /**
+     * One published item by its slug or id (detail page). 404
+     * `be.collections.itemNotFound` for a draft or unknown item.
+     */
+    item(slug: string, itemSlugOrId: string): Promise<SdkResult<StorefrontCollectionItem>>;
+}
 /**
  * Merchant-defined forms (contact, demand, registration to an event...).
  * The definition is public and cacheable; a submit is validated server-side
@@ -5009,6 +5070,14 @@ interface UseBlogPostOptions {
 /** One published post (sanitised HTML content + related posts). */
 declare function useBlogPost(handle: string, slug: string, locale?: string, options?: UseBlogPostOptions): _tanstack_react_query.UseQueryResult<NoInfer<BlogPostDetail>, Error>;
 
+interface UseCollectionOptions {
+    enabled?: boolean;
+}
+/** A public data collection with its published items (team, references, FAQ...). */
+declare function useCollection(slug: string, query?: StorefrontCollectionQuery, options?: UseCollectionOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontCollection>, Error>;
+/** 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 UseSiteFormOptions {
     enabled?: boolean;
 }
@@ -5842,4 +5911,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 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, 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 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, 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 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, 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 };

package/dist/react.d.ts

@@ -2381,6 +2381,43 @@ interface StorefrontFormSettings {
     /** When true, `consent: true` is required for the submit to pass. */
     requireConsent?: boolean;
 }
+/** Field types of a data collection. */
+type StorefrontCollectionFieldType = "text" | "longtext" | "number" | "boolean" | "date" | "url" | "image" | "email" | "select" | "tags";
+/** One field of a data collection; item values live under `data[key]`. */
+interface StorefrontCollectionField {
+    key: string;
+    type: StorefrontCollectionFieldType;
+    label: string;
+    required: boolean;
+    help?: string;
+    /** Choices for `select`, suggestions for `tags`. */
+    options?: string[];
+}
+/** One published item of a data collection. */
+interface StorefrontCollectionItem {
+    id: string;
+    /** Detail address, unique in the collection; null when the item has none. */
+    slug: string | null;
+    /** `{fieldKey: value}`: text, number, boolean, `YYYY-MM-DD` date, URL, string[] for tags. */
+    data: Record<string, unknown>;
+    createdAt: number;
+    updatedAt: number;
+}
+/** A public data collection (`GET /collections/{slug}`). */
+interface StorefrontCollection {
+    slug: string;
+    name: string;
+    description: string | null;
+    fields: StorefrontCollectionField[];
+    items: StorefrontCollectionItem[];
+    /** Number of published items (for paging). */
+    total: number;
+}
+interface StorefrontCollectionQuery {
+    /** 1 to 200, default 100. */
+    limit?: number;
+    offset?: number;
+}
 /** Public definition of a form (`GET /forms/{slug}`). */
 interface StorefrontForm {
     slug: string;
@@ -3267,6 +3304,7 @@ declare class BehioStorefront {
     readonly pages: PagesModule;
     readonly blog: BlogModule;
     readonly forms: FormsModule;
+    readonly collections: CollectionsModule;
     readonly wishlist: WishlistModule;
     readonly reviews: ReviewsModule;
     readonly returns: ReturnsModule;
@@ -3974,6 +4012,29 @@ declare class BlogModule {
     /** One published post with sanitised HTML content and related posts. */
     post(handle: string, slug: string, locale?: string): Promise<SdkResult<BlogPostDetail>>;
 }
+/**
+ * Data collections: structured content the owner edits in Behio (team,
+ * references, price list, FAQ, listings) and the site reads at runtime, so
+ * no site needs its own database. Only public collections and published
+ * items are returned. Cached by Behio and invalidated on every admin change.
+ * Works with website keys that have no e-shop attached.
+ */
+declare class CollectionsModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /**
+     * One collection with its published items in the owner's order.
+     * `limit` 1 to 200 (default 100), `offset` for paging; `total` is the
+     * number of published items. 404 `be.collections.collectionNotFound` for an
+     * unknown or private slug.
+     */
+    get(slug: string, query?: StorefrontCollectionQuery): Promise<SdkResult<StorefrontCollection>>;
+    /**
+     * One published item by its slug or id (detail page). 404
+     * `be.collections.itemNotFound` for a draft or unknown item.
+     */
+    item(slug: string, itemSlugOrId: string): Promise<SdkResult<StorefrontCollectionItem>>;
+}
 /**
  * Merchant-defined forms (contact, demand, registration to an event...).
  * The definition is public and cacheable; a submit is validated server-side
@@ -5009,6 +5070,14 @@ interface UseBlogPostOptions {
 /** One published post (sanitised HTML content + related posts). */
 declare function useBlogPost(handle: string, slug: string, locale?: string, options?: UseBlogPostOptions): _tanstack_react_query.UseQueryResult<NoInfer<BlogPostDetail>, Error>;
 
+interface UseCollectionOptions {
+    enabled?: boolean;
+}
+/** A public data collection with its published items (team, references, FAQ...). */
+declare function useCollection(slug: string, query?: StorefrontCollectionQuery, options?: UseCollectionOptions): _tanstack_react_query.UseQueryResult<NoInfer<StorefrontCollection>, Error>;
+/** 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 UseSiteFormOptions {
     enabled?: boolean;
 }
@@ -5842,4 +5911,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 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, 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 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, 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 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, 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 };

package/dist/react.js

@@ -54,6 +54,8 @@ __export(react_exports, {
   useCertificateVerification: () => useCertificateVerification,
   useCheckout: () => useCheckout,
   useCheckoutPreview: () => useCheckoutPreview,
+  useCollection: () => useCollection,
+  useCollectionItem: () => useCollectionItem,
   useCookieConsent: () => useCookieConsent,
   useCourse: () => useCourse,
   useCourseCertificates: () => useCourseCertificates,
@@ -281,6 +283,7 @@ var BehioStorefront = class {
     this.pages = new PagesModule(this);
     this.blog = new BlogModule(this);
     this.forms = new FormsModule(this);
+    this.collections = new CollectionsModule(this);
     this.wishlist = new WishlistModule(this);
     this.reviews = new ReviewsModule(this);
     this.returns = new ReturnsModule(this);
@@ -1909,6 +1912,34 @@ var BlogModule = class {
     });
   }
 };
+var CollectionsModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * One collection with its published items in the owner's order.
+   * `limit` 1 to 200 (default 100), `offset` for paging; `total` is the
+   * number of published items. 404 `be.collections.collectionNotFound` for an
+   * unknown or private slug.
+   */
+  async get(slug, query) {
+    return this.client.request(
+      "GET",
+      `/collections/${encodeURIComponent(slug)}`,
+      { query: { limit: query?.limit, offset: query?.offset } }
+    );
+  }
+  /**
+   * One published item by its slug or id (detail page). 404
+   * `be.collections.itemNotFound` for a draft or unknown item.
+   */
+  async item(slug, itemSlugOrId) {
+    return this.client.request(
+      "GET",
+      `/collections/${encodeURIComponent(slug)}/items/${encodeURIComponent(itemSlugOrId)}`
+    );
+  }
+};
 var FormsModule = class {
   constructor(client) {
     this.client = client;
@@ -4065,9 +4096,28 @@ function useBlogPost(handle, slug, locale, options) {
   });
 }
 
+// src/react/hooks/use-collection.ts
+var import_react_query37 = require("@tanstack/react-query");
+function useCollection(slug, query, options) {
+  const { client } = useBehio();
+  return (0, import_react_query37.useQuery)({
+    queryKey: ["behio", "collection", slug, query?.limit, query?.offset],
+    queryFn: () => unwrap(client.collections.get(slug, query)),
+    enabled: options?.enabled !== false && !!slug
+  });
+}
+function useCollectionItem(slug, itemSlugOrId, options) {
+  const { client } = useBehio();
+  return (0, import_react_query37.useQuery)({
+    queryKey: ["behio", "collection", slug, "item", itemSlugOrId],
+    queryFn: () => unwrap(client.collections.item(slug, itemSlugOrId)),
+    enabled: options?.enabled !== false && !!slug && !!itemSlugOrId
+  });
+}
+
 // src/react/hooks/use-site-form.ts
 var import_react17 = require("react");
-var import_react_query37 = require("@tanstack/react-query");
+var import_react_query38 = require("@tanstack/react-query");
 
 // src/errors.ts
 function bodyOf(err) {
@@ -4118,7 +4168,7 @@ function formFieldErrors(err) {
 // src/react/hooks/use-site-form.ts
 function useSiteForm(slug, options) {
   const { client } = useBehio();
-  return (0, import_react_query37.useQuery)({
+  return (0, import_react_query38.useQuery)({
     queryKey: ["behio", "form", slug],
     queryFn: () => unwrap(client.forms.get(slug)),
     enabled: options?.enabled !== false && !!slug
@@ -4126,7 +4176,7 @@ function useSiteForm(slug, options) {
 }
 function useSiteFormSubmit(slug) {
   const { client } = useBehio();
-  const mutation = (0, import_react_query37.useMutation)({
+  const mutation = (0, import_react_query38.useMutation)({
     mutationFn: (input) => unwrap(client.forms.submit(slug, input))
   });
   const sdkError = mutation.error instanceof UnwrappedError ? mutation.error.sdkError : null;
@@ -4162,10 +4212,10 @@ function useSiteFormSubmit(slug) {
 }
 
 // src/react/hooks/use-shop-info.ts
-var import_react_query38 = require("@tanstack/react-query");
+var import_react_query39 = require("@tanstack/react-query");
 function useShopInfo(options) {
   const { client } = useBehio();
-  return (0, import_react_query38.useQuery)({
+  return (0, import_react_query39.useQuery)({
     queryKey: ["behio", "shop-info"],
     queryFn: () => unwrap(client.getShopInfo()),
     enabled: options?.enabled !== false
@@ -4173,10 +4223,10 @@ function useShopInfo(options) {
 }
 
 // src/react/hooks/use-shop-scripts.ts
-var import_react_query39 = require("@tanstack/react-query");
+var import_react_query40 = require("@tanstack/react-query");
 function useShopScripts(options) {
   const { client } = useBehio();
-  return (0, import_react_query39.useQuery)({
+  return (0, import_react_query40.useQuery)({
     queryKey: ["behio", "shop-scripts"],
     queryFn: () => unwrap(client.getShopScripts()),
     enabled: options?.enabled !== false,
@@ -4185,11 +4235,11 @@ function useShopScripts(options) {
 }
 
 // src/react/hooks/use-shop-seo.ts
-var import_react_query40 = require("@tanstack/react-query");
+var import_react_query41 = require("@tanstack/react-query");
 function useShopSeo(options) {
   const { client } = useBehio();
   const { locale, initialData, enabled = true } = options ?? {};
-  return (0, import_react_query40.useQuery)({
+  return (0, import_react_query41.useQuery)({
     queryKey: ["behio", "shop-seo", locale ?? "_default"],
     queryFn: () => unwrap(client.getShopSeo(locale)),
     initialData,
@@ -4252,20 +4302,20 @@ function CurrencySwitcher({
 var import_react18 = require("react");
 
 // src/react/hooks/use-consent.ts
-var import_react_query41 = require("@tanstack/react-query");
+var import_react_query42 = require("@tanstack/react-query");
 function useCookieConsent(visitorId) {
   const { client } = useBehio();
-  const qc = (0, import_react_query41.useQueryClient)();
-  const query = (0, import_react_query41.useQuery)({
+  const qc = (0, import_react_query42.useQueryClient)();
+  const query = (0, import_react_query42.useQuery)({
     queryKey: ["behio", "consent", visitorId],
     queryFn: () => unwrap(client.consent.get(visitorId)),
     enabled: Boolean(visitorId)
   });
-  const recordMutation = (0, import_react_query41.useMutation)({
+  const recordMutation = (0, import_react_query42.useMutation)({
     mutationFn: (input) => unwrap(client.consent.record(input)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "consent"] })
   });
-  const revokeMutation = (0, import_react_query41.useMutation)({
+  const revokeMutation = (0, import_react_query42.useMutation)({
     mutationFn: () => unwrap(client.consent.revoke(visitorId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "consent"] })
   });
@@ -4634,11 +4684,11 @@ function utmFromSearch(search) {
 }
 
 // src/react/hooks/use-bundles.ts
-var import_react_query42 = require("@tanstack/react-query");
+var import_react_query43 = 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_query42.useQuery)({
+  return (0, import_react_query43.useQuery)({
     queryKey: ["behio", "bundles", query],
     queryFn: () => unwrap(client.catalog.getBundles(query)),
     enabled: sessionRestored && (options?.enabled ?? true),
@@ -4648,7 +4698,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_query42.useQuery)({
+  return (0, import_react_query43.useQuery)({
     queryKey: ["behio", "bundle", slug, query],
     queryFn: () => unwrap(client.catalog.getBundle(slug, query)),
     enabled: sessionRestored && Boolean(slug) && (options?.enabled ?? true),
@@ -4657,10 +4707,10 @@ function useBundle(slug, options) {
 }
 
 // src/react/hooks/use-product-group.ts
-var import_react_query43 = require("@tanstack/react-query");
+var import_react_query44 = require("@tanstack/react-query");
 function useProductGroup(slug, options) {
   const { client } = useBehio();
-  return (0, import_react_query43.useQuery)({
+  return (0, import_react_query44.useQuery)({
     queryKey: ["behio", "product-group", slug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getProductGroup(slug, {
@@ -4674,10 +4724,10 @@ function useProductGroup(slug, options) {
 }
 
 // src/react/hooks/use-cross-sell.ts
-var import_react_query44 = require("@tanstack/react-query");
+var import_react_query45 = require("@tanstack/react-query");
 function useCrossSell(productSlug, options) {
   const { client } = useBehio();
-  return (0, import_react_query44.useQuery)({
+  return (0, import_react_query45.useQuery)({
     queryKey: ["behio", "cross-sell", productSlug, options?.locale, options?.currency],
     queryFn: () => unwrap(
       client.catalog.getCrossSell(productSlug, {
@@ -4691,10 +4741,10 @@ function useCrossSell(productSlug, options) {
 }
 
 // src/react/hooks/use-product-promotions.ts
-var import_react_query45 = require("@tanstack/react-query");
+var import_react_query46 = require("@tanstack/react-query");
 function useProductPromotions(productSlug, options) {
   const { client } = useBehio();
-  return (0, import_react_query45.useQuery)({
+  return (0, import_react_query46.useQuery)({
     queryKey: ["behio", "product-promotions", productSlug],
     queryFn: () => unwrap(client.catalog.getProductPromotions(productSlug)),
     enabled: Boolean(productSlug) && (options?.enabled ?? true),
@@ -4703,11 +4753,11 @@ function useProductPromotions(productSlug, options) {
 }
 
 // src/react/hooks/use-gift-card.ts
-var import_react_query46 = require("@tanstack/react-query");
+var import_react_query47 = require("@tanstack/react-query");
 function useGiftCardBalance(code, options) {
   const { client } = useBehio();
   const trimmed = code?.trim();
-  return (0, import_react_query46.useQuery)({
+  return (0, import_react_query47.useQuery)({
     queryKey: ["behio", "gift-card-balance", trimmed],
     queryFn: () => unwrap(client.catalog.checkGiftCard(trimmed)),
     enabled: Boolean(trimmed && trimmed.length >= 6) && (options?.enabled ?? true)
@@ -4715,20 +4765,20 @@ function useGiftCardBalance(code, options) {
 }
 
 // src/react/hooks/use-wishlist.ts
-var import_react_query47 = require("@tanstack/react-query");
+var import_react_query48 = require("@tanstack/react-query");
 function useWishlist(options) {
   const { client } = useBehio();
-  const qc = (0, import_react_query47.useQueryClient)();
-  const query = (0, import_react_query47.useQuery)({
+  const qc = (0, import_react_query48.useQueryClient)();
+  const query = (0, import_react_query48.useQuery)({
     queryKey: ["behio", "wishlist"],
     queryFn: () => unwrap(client.wishlist.get()),
     enabled: options?.enabled ?? true
   });
-  const addMutation = (0, import_react_query47.useMutation)({
+  const addMutation = (0, import_react_query48.useMutation)({
     mutationFn: (productId) => unwrap(client.wishlist.add(productId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "wishlist"] })
   });
-  const removeMutation = (0, import_react_query47.useMutation)({
+  const removeMutation = (0, import_react_query48.useMutation)({
     mutationFn: (productId) => unwrap(client.wishlist.remove(productId)),
     onSuccess: () => qc.invalidateQueries({ queryKey: ["behio", "wishlist"] })
   });
@@ -4742,7 +4792,7 @@ function useWishlist(options) {
 }
 function useIsInWishlist(productId) {
   const { client } = useBehio();
-  return (0, import_react_query47.useQuery)({
+  return (0, import_react_query48.useQuery)({
     queryKey: ["behio", "wishlist-check", productId],
     queryFn: () => unwrap(client.wishlist.isInWishlist(productId)),
     enabled: Boolean(productId)
@@ -4750,10 +4800,10 @@ function useIsInWishlist(productId) {
 }
 
 // src/react/hooks/use-reviews.ts
-var import_react_query48 = require("@tanstack/react-query");
+var import_react_query49 = require("@tanstack/react-query");
 function useProductReviews(productId, options) {
   const { client } = useBehio();
-  return (0, import_react_query48.useQuery)({
+  return (0, import_react_query49.useQuery)({
     queryKey: ["behio", "reviews", productId, options?.page ?? 1, options?.limit ?? 20],
     queryFn: () => unwrap(client.reviews.getProductReviews(productId, options?.page, options?.limit)),
     initialData: options?.initialData,
@@ -4763,30 +4813,30 @@ function useProductReviews(productId, options) {
 }
 function useSubmitReview() {
   const { client } = useBehio();
-  const qc = (0, import_react_query48.useQueryClient)();
-  return (0, import_react_query48.useMutation)({
+  const qc = (0, import_react_query49.useQueryClient)();
+  return (0, import_react_query49.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_query49 = require("@tanstack/react-query");
+var import_react_query50 = require("@tanstack/react-query");
 function useLookupReturnableOrder() {
   const { client } = useBehio();
-  return (0, import_react_query49.useMutation)({
+  return (0, import_react_query50.useMutation)({
     mutationFn: ({ orderNumber, email }) => unwrap(client.returns.lookupOrder(orderNumber, email))
   });
 }
 function useSubmitReturn() {
   const { client } = useBehio();
-  return (0, import_react_query49.useMutation)({
+  return (0, import_react_query50.useMutation)({
     mutationFn: (input) => unwrap(client.returns.submit(input))
   });
 }
 function useReturnStatus(returnId, email) {
   const { client } = useBehio();
-  return (0, import_react_query49.useQuery)({
+  return (0, import_react_query50.useQuery)({
     queryKey: ["behio", "return-status", returnId],
     queryFn: () => unwrap(client.returns.getStatus(returnId, email)),
     enabled: Boolean(returnId && email)
@@ -4794,16 +4844,16 @@ function useReturnStatus(returnId, email) {
 }
 
 // src/react/hooks/use-quotes.ts
-var import_react_query50 = require("@tanstack/react-query");
+var import_react_query51 = require("@tanstack/react-query");
 function useSubmitQuote() {
   const { client } = useBehio();
-  return (0, import_react_query50.useMutation)({
+  return (0, import_react_query51.useMutation)({
     mutationFn: (input) => unwrap(client.quotes.submit(input))
   });
 }
 function useQuoteStatus(quoteId, email) {
   const { client } = useBehio();
-  return (0, import_react_query50.useQuery)({
+  return (0, import_react_query51.useQuery)({
     queryKey: ["behio", "quote-status", quoteId],
     queryFn: () => unwrap(client.quotes.getStatus(quoteId, email)),
     enabled: Boolean(quoteId && email)
@@ -4811,10 +4861,10 @@ function useQuoteStatus(quoteId, email) {
 }
 
 // src/react/hooks/use-back-in-stock.ts
-var import_react_query51 = require("@tanstack/react-query");
+var import_react_query52 = require("@tanstack/react-query");
 function useNotifyWhenAvailable() {
   const { client } = useBehio();
-  return (0, import_react_query51.useMutation)({
+  return (0, import_react_query52.useMutation)({
     mutationFn: ({ productId, email }) => unwrap(client.catalog.notifyWhenAvailable(productId, email))
   });
 }
@@ -4971,6 +5021,8 @@ async function revokeAnalyticsConsent(client) {
   useCertificateVerification,
   useCheckout,
   useCheckoutPreview,
+  useCollection,
+  useCollectionItem,
   useCookieConsent,
   useCourse,
   useCourseCertificates,