@kasuvia/sdk 0.0.2 → 0.0.5

package/dist/hooks/index.d.ts

@@ -0,0 +1,430 @@
+import React, { ReactNode } from 'react';
+import { d as CartResponse, c as CartItem, z as Product, S as SdkConfig, F as FindOrderParams, V as SupportedLang, q as Currency, u as ListParams, e as CmsEntry, o as CreateCmsEntryParams, Y as UpdateCmsEntryParams, L as ListCmsEntriesParams } from '../index-CzVMyUs4.js';
+import { C as Country, d as State } from '../sdk-context-BuarJbeb.js';
+export { S as SdkContextValue, b as SdkProvider, c as SdkProviderProps, r as resolveHookArgs, u as useSdkContext } from '../sdk-context-BuarJbeb.js';
+import { UseQueryResult } from '@tanstack/react-query';
+
+/**
+ * Cart Hook & Context Provider
+ *
+ * React Query hooks for cart operations with unified drawer state sharing.
+ * config and accessToken are optional — if omitted, they are read from SdkContext.
+ */
+
+interface UseCartReturn {
+    cart: CartResponse | undefined;
+    items: CartItem[];
+    count: number;
+    isOpen: boolean;
+    setOpen: (open: boolean) => void;
+    isLoading: boolean;
+    error: Error | null;
+    addToCart: (item: {
+        product_id: string;
+        product_slug: string;
+        product_name: string;
+        image?: string;
+        variant_id?: string;
+        variant_attributes?: string;
+        unit_price: number;
+        quantity: number;
+        custom_measurements?: string;
+        is_bespoke: boolean;
+    }) => void;
+    updateCartItem: (variables: {
+        itemId: string;
+        quantity: number;
+    }) => void;
+    removeFromCart: (itemId: string) => void;
+    clearCart: () => void;
+    clear: () => void;
+    mergeGuestCart: (guestSessionId: string) => void;
+    addItem: (product: Product, variantId?: string, quantity?: number, customMeasurements?: Record<string, string>) => void;
+    updateQty: (itemId: string, quantity: number) => void;
+    removeItem: (itemId: string) => void;
+    subtotal: number;
+    productTypeMismatch: {
+        message: string;
+        existing_type: string;
+        new_type: string;
+    } | null;
+    handleClearCartAndAdd: () => void;
+    handleKeepCurrentCart: () => void;
+}
+interface CartContextValue {
+    isOpen: boolean;
+    setOpen: (open: boolean) => void;
+}
+declare const CartCtx: React.Context<CartContextValue | null> | null;
+declare function CartProvider({ children }: {
+    children: ReactNode;
+}): string | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.FunctionComponentElement<React.ProviderProps<CartContextValue | null>> | null | undefined;
+declare function useCart(config?: SdkConfig, accessToken?: string | null): UseCartReturn;
+
+declare function useOrders(arg1?: SdkConfig | {
+    page?: number;
+    pageSize?: number;
+}, arg2?: string | null, arg3?: {
+    page?: number;
+    pageSize?: number;
+}): any;
+declare function useOrdersList(arg1?: any, arg2?: any, arg3?: any): any;
+declare function useFindOrder(arg1?: SdkConfig | string | FindOrderParams, arg2?: FindOrderParams): any;
+declare function useOrder(arg1?: SdkConfig | string | FindOrderParams, arg2?: FindOrderParams): any;
+declare function useOrderTracking(arg1?: SdkConfig | string, arg2?: string, arg3?: string): any;
+declare function useCreateOrder(config?: SdkConfig, accessToken?: string | null): any;
+declare function useCancelOrder(config?: SdkConfig, accessToken?: string | null): any;
+
+declare function useAuthUser(config?: SdkConfig, accessToken?: string): any;
+declare function useLogin(config?: SdkConfig): any;
+declare function useRegister(config?: SdkConfig): any;
+declare function useUpdateProfile(config?: SdkConfig, accessToken?: string | null): any;
+declare function useLogout(config?: SdkConfig, refreshToken?: string): any;
+
+declare function getCountries(config: SdkConfig): Promise<Country[]>;
+declare function useCountries(config?: SdkConfig): any;
+
+declare function getStates(config: SdkConfig, countryIso: string): Promise<State[]>;
+declare function useStates(countryIso: string, config?: SdkConfig): any;
+
+declare function getSupportedLanguagesList(config: SdkConfig): Promise<SupportedLang[]>;
+declare function useSupportedLanguages(config?: SdkConfig): UseQueryResult<SupportedLang[], Error>;
+
+declare function getSupportedCurrenciesList(config: SdkConfig): Promise<Currency[]>;
+declare function useCurrencies(config?: SdkConfig): any;
+
+/**
+ * Get bespoke availability for a product
+ */
+declare function useBespokeAvailability(product_id: string, config?: SdkConfig): any;
+
+declare const collectionKeys: {
+    all: readonly ["core", "collections"];
+    list: (params?: ListParams) => readonly ["core", "collections", "list", ListParams];
+    slug: (slug: string) => readonly ["core", "collections", "slug", string];
+};
+/**
+ * Hook to fetch paginated collections for the storefront.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useStorefrontCollections(params?: ListParams): any;
+/**
+ * Hook to fetch a single collection by slug for the storefront.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useStorefrontCollection(slug: string): any;
+
+declare const productKeys: {
+    all: readonly ["products"];
+    list: (params?: ListParams) => readonly ["products", "list", ListParams | undefined];
+    detail: (slug: string) => readonly ["products", "detail", string];
+    recommended: (params?: ListParams) => readonly ["products", "recommended", ListParams | undefined];
+    latest: (params?: ListParams) => readonly ["products", "latest", ListParams | undefined];
+    popular: (params?: ListParams) => readonly ["products", "popular", ListParams | undefined];
+    featured: (params?: ListParams) => readonly ["products", "featured", ListParams | undefined];
+    new: (params?: ListParams) => readonly ["products", "new", ListParams | undefined];
+    onSale: (params?: ListParams) => readonly ["products", "onSale", ListParams | undefined];
+    lowStock: (params?: ListParams) => readonly ["products", "lowStock", ListParams | undefined];
+};
+/**
+ * Hook for fetching latest products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useLatestProducts(params?: ListParams): any;
+/**
+ * Hook for fetching popular products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function usePopularProducts(params?: ListParams): any;
+/**
+ * Hook for fetching featured products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useFeaturedProducts(params?: ListParams): any;
+/**
+ * Hook for fetching new products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useNewProducts(params?: ListParams): any;
+/**
+ * Hook for fetching products currently on sale.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useOnSaleProducts(params?: ListParams): any;
+/**
+ * Hook for fetching products with low stock.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useLowStockProducts(params?: ListParams): any;
+/**
+ * Hook for fetching all active storefront products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useStorefrontProducts(params?: ListParams): any;
+/**
+ * Hook for fetching a single product by slug.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useProduct(slug: string): any;
+/**
+ * Hook for fetching recommended products.
+ * Fetches from Next.js API route to avoid exposing backend URLs.
+ */
+declare function useRecommendedProducts(params?: ListParams): any;
+
+declare const wishlistKeys: {
+    all: readonly ["wishlist"];
+    list: () => readonly ["wishlist", "list"];
+    check: (productId: string) => readonly ["wishlist", "check", string];
+};
+declare function useWishlist(arg1?: SdkConfig | {
+    page?: number;
+    pageSize?: number;
+}, arg2?: string | null, arg3?: {
+    page?: number;
+    pageSize?: number;
+}): any;
+declare function useCheckInWishlist(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useAddToWishlist(config?: SdkConfig, accessToken?: string | null): any;
+declare function useRemoveFromWishlist(config?: SdkConfig, accessToken?: string | null): any;
+declare function useRemoveProductFromWishlist(config?: SdkConfig, accessToken?: string | null): any;
+
+declare function useAvailableSlots(arg1?: SdkConfig | string, arg2?: string, arg3?: string, arg4?: string): any;
+declare function useBookAppointment(config?: SdkConfig, accessToken?: string | null): any;
+declare function useAppointments(config?: SdkConfig, accessToken?: string | null): any;
+declare function useAppointment(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useCancelAppointment(config?: SdkConfig, accessToken?: string | null): any;
+declare function useDeliverables(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useApproveDeliverable(config?: SdkConfig, accessToken?: string | null, order_id?: string, deliverable_id?: string): any;
+declare function useRequestRevision(config?: SdkConfig, accessToken?: string | null, order_id?: string, deliverable_id?: string): any;
+
+declare function useConsultations(config?: SdkConfig, accessToken?: string | null): any;
+declare function useConsultation(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useCreateConsultation(config?: SdkConfig, accessToken?: string | null): any;
+declare function useSendMessage(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useAcceptQuote(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+declare function useRejectQuote(arg1?: SdkConfig | string, arg2?: string | null, arg3?: string): any;
+
+interface ConsultationMessageData {
+    event: string;
+    data: {
+        consultation_id: string;
+        message_id: string;
+        sender_id: string;
+        sender_role: string;
+        message: string;
+        attachments?: Array<{
+            url: string;
+            type: string;
+            name: string;
+        }>;
+        created_at: string;
+    };
+}
+interface ConsultationQuoteData {
+    event: string;
+    data: {
+        consultation_id: string;
+        quote_amount: number;
+        deposit_amount?: number;
+        merchant_notes?: string;
+        updated_at: string;
+    };
+}
+interface ConsultationStatusData {
+    event: string;
+    data: {
+        consultation_id: string;
+        status: string;
+        updated_at: string;
+    };
+}
+interface UseConsultationStreamOptions {
+    config: SdkConfig;
+    consultationId: string;
+    onMessage?: (data: ConsultationMessageData) => void;
+    onQuote?: (data: ConsultationQuoteData) => void;
+    onStatusChange?: (data: ConsultationStatusData) => void;
+    onError?: (error: Error) => void;
+}
+declare function useConsultationStream({ config, consultationId, onMessage, onQuote, onStatusChange, onError, }: UseConsultationStreamOptions): {
+    isConnected: boolean;
+    lastEvent: any;
+};
+
+interface PaymentSuccessData {
+    event: string;
+    data: {
+        transaction_id: string;
+        order_id: string;
+        amount: number;
+        currency: string;
+        status: string;
+    };
+}
+interface DigitalReadyData {
+    event: string;
+    data: {
+        order_id: string;
+        business_id: string;
+        customer_id: string;
+        download_links: Array<{
+            item_id: string;
+            product_name: string;
+            url: string;
+            token: string;
+            expires_at: string;
+            max_downloads: number;
+        }>;
+        fulfilled_at: string;
+    };
+}
+interface BespokeUpdateData {
+    event: string;
+    data: {
+        order_id: string;
+        business_id: string;
+        update_type: string;
+        message: string;
+        stage?: string;
+        updated_at: string;
+    };
+}
+interface ConsultationUpdateData {
+    event: string;
+    data: {
+        consultation_id: string;
+        business_id: string;
+        customer_id: string;
+        status: string;
+        message?: string;
+        updated_at: string;
+    };
+}
+interface ServiceBookingUpdateData {
+    event: string;
+    data: {
+        booking_id: string;
+        order_id: string;
+        business_id: string;
+        customer_id: string;
+        status: string;
+        appointment_date?: string;
+        updated_at: string;
+    };
+}
+interface UseOrderStreamOptions {
+    config?: SdkConfig;
+    orderId: string;
+    onPaymentComplete?: (data: PaymentSuccessData) => void;
+    onDigitalReady?: (data: DigitalReadyData) => void;
+    onBespokeUpdate?: (data: BespokeUpdateData) => void;
+    onConsultationUpdate?: (data: ConsultationUpdateData) => void;
+    onServiceBookingUpdate?: (data: ServiceBookingUpdateData) => void;
+    onError?: (error: Error) => void;
+}
+declare function useOrderStream({ config: explicitConfig, orderId, onPaymentComplete, onDigitalReady, onBespokeUpdate, onConsultationUpdate, onServiceBookingUpdate, onError }: UseOrderStreamOptions): null;
+
+declare function useIsMounted(): boolean;
+
+declare function useIsMobile(): boolean;
+
+interface GoogleTranslateOptions {
+    pageLanguage: string;
+    includedLanguages?: string;
+    autoDisplay?: boolean;
+    layout?: number;
+}
+interface GoogleTranslateElement {
+    new (options: GoogleTranslateOptions, elementId: string): void;
+}
+interface GoogleNamespace {
+    translate?: {
+        TranslateElement: GoogleTranslateElement;
+    };
+}
+declare global {
+    interface Window {
+        googleTranslateElementInit?: () => void;
+        google?: GoogleNamespace;
+    }
+}
+declare function useGoogleTranslate(configOrLang?: SdkConfig | string, appLang?: string): {
+    isLoaded: boolean;
+};
+
+/**
+ * Hook for creating a Dedicated Virtual Account (DVA)
+ * Optional config and accessToken — read from SdkContext if omitted.
+ */
+declare function useCreateDVA(config?: SdkConfig, accessToken?: string | null): any;
+/**
+ * Hook for initiating card payment
+ * Optional config and accessToken — read from SdkContext if omitted.
+ */
+declare function useInitiatePayment(config?: SdkConfig, accessToken?: string | null): any;
+/**
+ * Hook for verifying a transaction
+ * Optional config — read from SdkContext if omitted.
+ */
+declare function useVerifyTransaction(config?: SdkConfig): any;
+/**
+ * Hook for getting transaction status
+ * Optional config — read from SdkContext if omitted.
+ */
+declare function useTransactionStatus(arg1?: SdkConfig | string, arg2?: string | boolean, arg3?: boolean): any;
+/**
+ * Hook for checking transaction status with automatic polling
+ * Optional config — read from SdkContext if omitted.
+ */
+declare function usePollTransactionStatus(arg1?: SdkConfig | string, arg2?: string | boolean, arg3?: boolean): any;
+
+interface UseCmsEntriesReturn {
+    entries: CmsEntry[];
+    total: number;
+    page: number;
+    page_size: number;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to list CMS entries for a specific model.
+ * Signature can be:
+ *   useCmsEntries(config, modelSlug, params)
+ *   useCmsEntries(modelSlug, params)
+ */
+declare function useCmsEntries(configOrModelSlug: SdkConfig | string, modelSlugOrParams?: string | ListCmsEntriesParams, maybeParams?: ListCmsEntriesParams): UseCmsEntriesReturn;
+interface UseCmsEntryReturn {
+    entry: CmsEntry | undefined;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+/**
+ * Hook to get a single CMS entry by ID.
+ * Signature can be:
+ *   useCmsEntry(config, modelSlug, entryId)
+ *   useCmsEntry(modelSlug, entryId)
+ */
+declare function useCmsEntry(configOrModelSlug: SdkConfig | string, modelSlugOrEntryId: string, maybeEntryId?: string): UseCmsEntryReturn;
+interface UseCreateCmsEntryReturn {
+    createEntry: (params: CreateCmsEntryParams) => void;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useCreateCmsEntry(config?: SdkConfig, accessToken?: string | null, modelSlug?: string): UseCreateCmsEntryReturn;
+interface UseUpdateCmsEntryReturn {
+    updateEntry: (entryId: string, params: UpdateCmsEntryParams) => void;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useUpdateCmsEntry(config?: SdkConfig, accessToken?: string | null, modelSlug?: string): UseUpdateCmsEntryReturn;
+interface UseDeleteCmsEntryReturn {
+    deleteEntry: (entryId: string) => void;
+    isLoading: boolean;
+    error: Error | null;
+}
+declare function useDeleteCmsEntry(config?: SdkConfig, accessToken?: string | null, modelSlug?: string): UseDeleteCmsEntryReturn;
+
+export { type CartContextValue, CartCtx, CartProvider, type UseCartReturn, type UseCmsEntriesReturn, type UseCmsEntryReturn, type UseCreateCmsEntryReturn, type UseDeleteCmsEntryReturn, type UseOrderStreamOptions, type UseUpdateCmsEntryReturn, collectionKeys, getCountries, getStates, getSupportedCurrenciesList, getSupportedLanguagesList, productKeys, useAcceptQuote, useAddToWishlist, useAppointment, useAppointments, useApproveDeliverable, useAuthUser, useAvailableSlots, useBespokeAvailability, useBookAppointment, useCancelAppointment, useCancelOrder, useCart, useCheckInWishlist, useCmsEntries, useCmsEntry, useConsultation, useConsultationStream, useConsultations, useCountries, useCreateCmsEntry, useCreateConsultation, useCreateDVA, useCreateOrder, useCurrencies, useDeleteCmsEntry, useDeliverables, useFeaturedProducts, useFindOrder, useGoogleTranslate, useInitiatePayment, useIsMobile, useIsMounted, useLatestProducts, useLogin, useLogout, useLowStockProducts, useNewProducts, useOnSaleProducts, useOrder, useOrderStream, useOrderTracking, useOrders, useOrdersList, usePollTransactionStatus, usePopularProducts, useProduct, useRecommendedProducts, useRegister, useRejectQuote, useRemoveFromWishlist, useRemoveProductFromWishlist, useRequestRevision, useSendMessage, useStates, useStorefrontCollection, useStorefrontCollections, useStorefrontProducts, useSupportedLanguages, useTransactionStatus, useUpdateCmsEntry, useUpdateProfile, useVerifyTransaction, useWishlist, wishlistKeys };