@behio/storefront-sdk 0.1.4 → 0.1.6

package/dist/react.d.ts

@@ -1,8 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
-import { BehioStorefront, ProductsQuery, PaginatedResponse, ProductListItem, ProductDetail, Category, ProductLabel, FilterField, Cart, CustomerProfile, RegisterInput, CustomerAddress, OrderListItem, OrderDetail, CheckoutInput, PageDetail, Page, ShopInfo } from './index.js';
-export { AddToCartInput, AuthTokens, BehioApiError, CartDiscount, CartItem, CategoryDetail, CheckoutAddress, FulfillmentStatus, LoginInput, MessageResponse, OrderItem, OrderStatus, PaymentStatus, ProductPrice, ProductVariant } from './index.js';
+import { BehioStorefront, ProductsQuery, PaginatedResponse, ProductListItem, ProductDetail, Category, CategoryDetail, ProductLabel, FilterField, Cart, CustomerProfile, RegisterInput, CustomerAddress, OrderListItem, OrderDetail, CheckoutInput, PageDetail, Page, ShopInfo } from './index.js';
+export { AddToCartInput, AuthTokens, BehioApiError, CartDiscount, CartItem, CheckoutAddress, FulfillmentStatus, LoginInput, MessageResponse, OrderItem, OrderStatus, PaymentStatus, ProductPrice, ProductVariant } from './index.js';
+import * as _tanstack_query_core from '@tanstack/query-core';
 
 interface StorageAdapter {
     get(key: string): string | null;
@@ -36,7 +37,51 @@ interface UseProductsOptions extends ProductsQuery {
     initialData?: PaginatedResponse<ProductListItem>;
     enabled?: boolean;
 }
-declare function useProducts(query?: UseProductsOptions): _tanstack_react_query.UseQueryResult<PaginatedResponse<ProductListItem>, Error>;
+/**
+ * Products hook with built-in pagination helpers.
+ *
+ * Supports both **paginated** (replace items per page) and **load more** (append items) patterns.
+ *
+ * @example
+ * ```tsx
+ * const { items, loadMore, hasMore, setPage, page, totalPages } = useProducts({ page: 1, limit: 30 });
+ *
+ * // Infinite scroll pattern
+ * <button onClick={loadMore} disabled={!hasMore}>Load more</button>
+ *
+ * // Traditional pagination
+ * <button onClick={() => setPage(2)}>Go to page 2</button>
+ * ```
+ */
+declare function useProducts(query?: UseProductsOptions): {
+    /** All items from all loaded pages (flat array) — for infinite scroll */
+    items: ProductListItem[];
+    /** Raw React Query data with all pages */
+    data: _tanstack_query_core.InfiniteData<PaginatedResponse<ProductListItem>, unknown>;
+    /** Last loaded page meta */
+    total: number;
+    totalPages: number;
+    currentPage: number;
+    limit: number;
+    /** Current page (manual pagination) */
+    page: number;
+    /** Change page (traditional pagination — replaces items) */
+    setPage: (newPage: number) => void;
+    /** Load next page (append to items — for infinite scroll / load more button) */
+    loadMore: () => Promise<void> | Promise<_tanstack_query_core.InfiniteQueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<ProductListItem>, unknown>, Error>>;
+    /** Fetch previous page */
+    loadPrevious: (options?: _tanstack_query_core.FetchPreviousPageOptions) => Promise<_tanstack_query_core.InfiniteQueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<ProductListItem>, unknown>, Error>>;
+    /** Can load more? */
+    hasMore: boolean;
+    hasPrevious: boolean;
+    isLoading: false;
+    isFetching: boolean;
+    isLoadingMore: boolean;
+    error: Error | null;
+    isError: boolean;
+    /** Force refetch all loaded pages */
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<ProductListItem>, unknown>, Error>>;
+};
 
 interface UseProductOptions {
     locale?: string;
@@ -46,9 +91,20 @@ interface UseProductOptions {
 }
 declare function useProduct(slug: string, options?: UseProductOptions): _tanstack_react_query.UseQueryResult<ProductDetail, Error>;
 
-declare function useCategories(locale?: string): _tanstack_react_query.UseQueryResult<Category[], Error>;
+interface UseCategoriesOptions {
+    enabled?: boolean;
+}
+declare function useCategories(locale?: string, options?: UseCategoriesOptions): _tanstack_react_query.UseQueryResult<Category[], Error>;
+interface UseCategoryOptions {
+    locale?: string;
+    enabled?: boolean;
+}
+declare function useCategory(slug: string, options?: UseCategoryOptions): _tanstack_react_query.UseQueryResult<CategoryDetail, Error>;
 
-declare function useLabels(locale?: string): _tanstack_react_query.UseQueryResult<ProductLabel[], Error>;
+interface UseLabelsOptions {
+    enabled?: boolean;
+}
+declare function useLabels(locale?: string, options?: UseLabelsOptions): _tanstack_react_query.UseQueryResult<ProductLabel[], Error>;
 
 interface UseFeaturedOptions {
     locale?: string;
@@ -58,7 +114,10 @@ interface UseFeaturedOptions {
 }
 declare function useFeatured(options?: UseFeaturedOptions): _tanstack_react_query.UseQueryResult<PaginatedResponse<ProductListItem>, Error>;
 
-declare function useFilters(): _tanstack_react_query.UseQueryResult<FilterField[], Error>;
+interface UseFiltersOptions {
+    enabled?: boolean;
+}
+declare function useFilters(options?: UseFiltersOptions): _tanstack_react_query.UseQueryResult<FilterField[], Error>;
 
 interface UseSearchOptions {
     page?: number;
@@ -68,7 +127,10 @@ interface UseSearchOptions {
 }
 declare function useSearch(query: string, options?: UseSearchOptions): _tanstack_react_query.UseQueryResult<PaginatedResponse<ProductListItem>, Error>;
 
-declare function useCart(): {
+interface UseCartOptions {
+    enabled?: boolean;
+}
+declare function useCart(options?: UseCartOptions): {
     cart: Cart | null;
     isLoading: boolean;
     error: Error | null;
@@ -88,7 +150,10 @@ declare function useCart(): {
     isRemoving: boolean;
 };
 
-declare function useCartCount(): number;
+interface UseCartCountOptions {
+    enabled?: boolean;
+}
+declare function useCartCount(options?: UseCartCountOptions): number;
 
 declare function useAuth(): {
     isLoggedIn: boolean;
@@ -106,7 +171,10 @@ declare function useAuth(): {
     registerError: Error | null;
 };
 
-declare function useCustomer(): {
+interface UseCustomerOptions {
+    enabled?: boolean;
+}
+declare function useCustomer(options?: UseCustomerOptions): {
     data: CustomerProfile | null;
     isLoading: boolean;
     error: Error | null;
@@ -114,7 +182,10 @@ declare function useCustomer(): {
     isUpdating: boolean;
 };
 
-declare function useAddresses(): {
+interface UseAddressesOptions {
+    enabled?: boolean;
+}
+declare function useAddresses(options?: UseAddressesOptions): {
     addresses: CustomerAddress[];
     isLoading: boolean;
     error: Error | null;
@@ -130,9 +201,41 @@ interface UseOrdersOptions {
     limit?: number;
     enabled?: boolean;
 }
-declare function useOrders(options?: UseOrdersOptions): _tanstack_react_query.UseQueryResult<PaginatedResponse<OrderListItem>, Error>;
+/**
+ * Orders hook with built-in pagination helpers.
+ *
+ * Supports both paginated (setPage) and load-more patterns.
+ *
+ * @example
+ * ```tsx
+ * const { items, loadMore, hasMore, isLoadingMore } = useOrders({ page: 1, limit: 20 });
+ * ```
+ */
+declare function useOrders(options?: UseOrdersOptions): {
+    items: OrderListItem[];
+    data: _tanstack_query_core.InfiniteData<PaginatedResponse<OrderListItem>, unknown> | undefined;
+    total: number;
+    totalPages: number;
+    currentPage: number;
+    limit: number;
+    page: number;
+    setPage: (newPage: number) => void;
+    loadMore: () => Promise<void> | Promise<_tanstack_query_core.InfiniteQueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<OrderListItem>, unknown>, Error>>;
+    loadPrevious: (options?: _tanstack_query_core.FetchPreviousPageOptions) => Promise<_tanstack_query_core.InfiniteQueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<OrderListItem>, unknown>, Error>>;
+    hasMore: boolean;
+    hasPrevious: boolean;
+    isLoading: boolean;
+    isFetching: boolean;
+    isLoadingMore: boolean;
+    error: Error | null;
+    isError: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<_tanstack_query_core.InfiniteData<PaginatedResponse<OrderListItem>, unknown>, Error>>;
+};
 
-declare function useOrder(orderNumber: string): {
+interface UseOrderOptions {
+    enabled?: boolean;
+}
+declare function useOrder(orderNumber: string, options?: UseOrderOptions): {
     data: OrderDetail | null;
     isLoading: boolean;
     error: Error | null;
@@ -148,10 +251,27 @@ declare function useCheckout(): {
     reset: () => void;
 };
 
-declare function usePages(locale?: string): _tanstack_react_query.UseQueryResult<Page[], Error>;
-declare function usePage(slug: string, locale?: string): _tanstack_react_query.UseQueryResult<PageDetail, Error>;
+interface UsePagesOptions {
+    enabled?: boolean;
+}
+declare function usePages(locale?: string, options?: UsePagesOptions): _tanstack_react_query.UseQueryResult<Page[], Error>;
+interface UsePageOptions {
+    enabled?: boolean;
+}
+declare function usePage(slug: string, locale?: string, options?: UsePageOptions): _tanstack_react_query.UseQueryResult<PageDetail, Error>;
 
-declare function useShopInfo(): _tanstack_react_query.UseQueryResult<ShopInfo, Error>;
+interface UseShopInfoOptions {
+    enabled?: boolean;
+}
+declare function useShopInfo(options?: UseShopInfoOptions): _tanstack_react_query.UseQueryResult<ShopInfo, Error>;
+
+/**
+ * Returns the raw BehioStorefront client instance.
+ *
+ * Useful for one-off fetches outside of React Query, listening to SDK events,
+ * or any advanced use case that needs direct access to the client.
+ */
+declare function useBehioClient(): BehioStorefront;
 
 /**
  * Format a price amount with currency using Intl.NumberFormat.
@@ -163,4 +283,4 @@ declare function useShopInfo(): _tanstack_react_query.UseQueryResult<ShopInfo, E
  */
 declare function formatPrice(amount: number, currency: string, locale?: string): string;
 
-export { BehioProvider, type BehioProviderProps, Cart, Category, CheckoutInput, CustomerAddress, CustomerProfile, FilterField, OrderDetail, OrderListItem, Page, PageDetail, PaginatedResponse, ProductDetail, ProductLabel, ProductListItem, ProductsQuery, RegisterInput, ShopInfo, type StorageAdapter, type UseFeaturedOptions, type UseOrdersOptions, type UseProductOptions, type UseProductsOptions, type UseSearchOptions, cookieStorage, createMemoryStorage, detectStorage, formatPrice, localStorageAdapter, memoryStorage, useAddresses, useAuth, useBehio, useCart, useCartCount, useCategories, useCheckout, useCustomer, useFeatured, useFilters, useLabels, useOrder, useOrders, usePage, usePages, useProduct, useProducts, useSearch, useShopInfo };
+export { BehioProvider, type BehioProviderProps, Cart, Category, CategoryDetail, CheckoutInput, CustomerAddress, CustomerProfile, FilterField, OrderDetail, OrderListItem, Page, PageDetail, PaginatedResponse, ProductDetail, ProductLabel, ProductListItem, ProductsQuery, RegisterInput, ShopInfo, type StorageAdapter, type UseAddressesOptions, type UseCartCountOptions, type UseCartOptions, type UseCategoriesOptions, type UseCategoryOptions, type UseCustomerOptions, type UseFeaturedOptions, type UseFiltersOptions, type UseLabelsOptions, type UseOrderOptions, type UseOrdersOptions, type UsePageOptions, type UsePagesOptions, type UseProductOptions, type UseProductsOptions, type UseSearchOptions, type UseShopInfoOptions, cookieStorage, createMemoryStorage, detectStorage, formatPrice, localStorageAdapter, memoryStorage, useAddresses, useAuth, useBehio, useBehioClient, useCart, useCartCount, useCategories, useCategory, useCheckout, useCustomer, useFeatured, useFilters, useLabels, useOrder, useOrders, usePage, usePages, useProduct, useProducts, useSearch, useShopInfo };