@behio/storefront-sdk 0.1.10 → 0.2.0

package/dist/react.d.ts

@@ -1,8 +1,8 @@
 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, CategoryDetail, ProductLabel, FilterField, Cart, CustomerProfile, RegisterInput, CustomerAddress, OrderListItem, OrderDetail, CheckoutInput, PageDetail, Page, ShopInfo, ShopSeo, Bundle, CrossSellItem, ActivePromotion } from './index.js';
-export { AddToCartInput, AuthTokens, BehioApiError, BundleItem, CartDiscount, CartItem, 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, ShopSeo, Bundle, CrossSellItem, ActivePromotion, GiftCardBalance, WishlistItem, ProductReviewsResponse, SubmitReviewInput, ReturnRequest, SubmitReturnInput, CookieConsent, CookieConsentInput, QuoteRequest, SubmitQuoteInput } from './index.js';
+export { AddToCartInput, AuthTokens, BehioApiError, BundleItem, CartDiscount, CartItem, CheckoutAddress, FulfillmentStatus, LoginInput, MessageResponse, OrderItem, OrderStatus, PaymentStatus, ProductPrice, ProductReview, ProductVariant } from './index.js';
 import * as _tanstack_query_core from '@tanstack/query-core';
 
 interface StorageAdapter {
@@ -321,6 +321,469 @@ declare function useProductPromotions(productSlug: string | undefined, options?:
     items: ActivePromotion[];
 }, Error>;
 
+/**
+ * Check a gift card code — validates the code against the eshop and
+ * returns remaining balance + currency. Use on the cart page to show
+ * "Gift card GC-XXXX: 350 CZK remaining" before checkout.
+ *
+ * The hook is intentionally disabled when code is empty/undefined so
+ * it doesn't fire unnecessary requests. Pass the code only after the
+ * user finishes typing (debounce recommended).
+ */
+declare function useGiftCardBalance(code: string | undefined, options?: {
+    enabled?: boolean;
+}): _tanstack_react_query.UseQueryResult<GiftCardBalance, Error>;
+
+declare function useWishlist(options?: {
+    enabled?: boolean;
+}): {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: {
+        items: WishlistItem[];
+    };
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+} | {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: {
+        items: WishlistItem[];
+    };
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+} | {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+} | {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+} | {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+} | {
+    add: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    remove: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, string, unknown>;
+    isAdding: boolean;
+    isRemoving: boolean;
+    data: {
+        items: WishlistItem[];
+    };
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<{
+        items: WishlistItem[];
+    }, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<{
+        items: WishlistItem[];
+    }>;
+};
+declare function useIsInWishlist(productId: string | undefined): _tanstack_react_query.UseQueryResult<{
+    inWishlist: boolean;
+}, Error>;
+
+declare function useProductReviews(productId: string | undefined, options?: {
+    page?: number;
+    limit?: number;
+    enabled?: boolean;
+}): _tanstack_react_query.UseQueryResult<ProductReviewsResponse, Error>;
+declare function useSubmitReview(): _tanstack_react_query.UseMutationResult<{
+    id: string;
+}, Error, SubmitReviewInput, unknown>;
+
+declare function useSubmitReturn(): _tanstack_react_query.UseMutationResult<ReturnRequest, Error, SubmitReturnInput, unknown>;
+declare function useReturnStatus(returnId: string | undefined, email: string | undefined): _tanstack_react_query.UseQueryResult<ReturnRequest, Error>;
+
+declare function useCookieConsent(visitorId: string | undefined): {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: CookieConsent | null;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+} | {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: CookieConsent | null;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+} | {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+} | {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+} | {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+} | {
+    record: _tanstack_react_query.UseMutateAsyncFunction<CookieConsent, Error, CookieConsentInput, unknown>;
+    revoke: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+    }, Error, void, unknown>;
+    data: CookieConsent | null;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<CookieConsent | null, Error>>;
+    fetchStatus: _tanstack_query_core.FetchStatus;
+    promise: Promise<CookieConsent | null>;
+};
+
+declare function useSubmitQuote(): _tanstack_react_query.UseMutationResult<QuoteRequest, Error, SubmitQuoteInput, unknown>;
+declare function useQuoteStatus(quoteId: string | undefined): _tanstack_react_query.UseQueryResult<QuoteRequest, Error>;
+
 /**
  * Returns the raw BehioStorefront client instance.
  *
@@ -339,4 +802,4 @@ declare function useBehioClient(): BehioStorefront;
  */
 declare function formatPrice(amount: number, currency: string, locale?: string): string;
 
-export { ActivePromotion, BehioProvider, type BehioProviderProps, Bundle, Cart, Category, CategoryDetail, CheckoutInput, CrossSellItem, CustomerAddress, CustomerProfile, FilterField, OrderDetail, OrderListItem, Page, PageDetail, PaginatedResponse, ProductDetail, ProductLabel, ProductListItem, ProductsQuery, RegisterInput, ShopInfo, ShopSeo, 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, type UseShopSeoOptions, cookieStorage, createMemoryStorage, detectStorage, formatPrice, localStorageAdapter, memoryStorage, useAddresses, useAuth, useBehio, useBehioClient, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCheckout, useCrossSell, useCustomer, useFeatured, useFilters, useLabels, useOrder, useOrders, usePage, usePages, useProduct, useProductPromotions, useProducts, useSearch, useShopInfo, useShopSeo };
+export { ActivePromotion, BehioProvider, type BehioProviderProps, Bundle, Cart, Category, CategoryDetail, CheckoutInput, CookieConsent, CookieConsentInput, CrossSellItem, CustomerAddress, CustomerProfile, FilterField, GiftCardBalance, OrderDetail, OrderListItem, Page, PageDetail, PaginatedResponse, ProductDetail, ProductLabel, ProductListItem, ProductReviewsResponse, ProductsQuery, QuoteRequest, RegisterInput, ReturnRequest, ShopInfo, ShopSeo, type StorageAdapter, SubmitQuoteInput, SubmitReturnInput, SubmitReviewInput, 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, type UseShopSeoOptions, WishlistItem, cookieStorage, createMemoryStorage, detectStorage, formatPrice, localStorageAdapter, memoryStorage, useAddresses, useAuth, useBehio, useBehioClient, useBundle, useBundles, useCart, useCartCount, useCategories, useCategory, useCheckout, useCookieConsent, useCrossSell, useCustomer, useFeatured, useFilters, useGiftCardBalance, useIsInWishlist, useLabels, useOrder, useOrders, usePage, usePages, useProduct, useProductPromotions, useProductReviews, useProducts, useQuoteStatus, useReturnStatus, useSearch, useShopInfo, useShopSeo, useSubmitQuote, useSubmitReturn, useSubmitReview, useWishlist };