react-shopping-cart-kit 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,449 @@
+import { Component } from 'react';
+import { default as default_2 } from 'react';
+import { ErrorInfo } from 'react';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PersistOptions } from 'zustand/middleware';
+import { ReactNode } from 'react';
+import { StoreApi } from 'zustand';
+import { UseBoundStore } from 'zustand';
+
+export declare interface BaseProduct {
+    id: string | number;
+    name: string;
+    price: number;
+    image?: string;
+    quantity?: number;
+}
+
+export declare const calculateDiscount: (subtotal: number, discount: Discount | null) => number;
+
+export declare const calculateSubtotal: <T extends BaseProduct>(items: CartItem<T>[]) => number;
+
+export declare const calculateTax: (subtotal: number, discount: number, taxRate: number) => number;
+
+export declare const calculateTotal: (subtotal: number, discount: number, tax: number) => number;
+
+export declare const calculateTotalItems: <T extends BaseProduct>(items: CartItem<T>[]) => number;
+
+export declare interface CartActions<T extends BaseProduct = BaseProduct> {
+    addItem: (product: T) => void;
+    removeItem: (id: string | number) => void;
+    updateItemQuantity: (id: string | number, quantity: number) => void;
+    clearCart: () => void;
+    applyDiscount: (code: string, amount: number, type?: 'percentage' | 'fixed') => void;
+    removeDiscount: () => void;
+    applyVoucher: (voucher: Voucher) => void;
+    removeVoucher: () => void;
+    validateVoucher: (code: string) => Voucher | null;
+    getActiveDiscounts: () => DiscountRule[];
+    getActiveVouchers: () => Voucher[];
+}
+
+export declare const CartButton: ({ className, iconClassName, badgeClassName, onClick, showBadge, badgePosition, }: CartButtonProps) => JSX_2.Element;
+
+export declare interface CartButtonProps {
+    className?: string;
+    iconClassName?: string;
+    badgeClassName?: string;
+    onClick?: () => void;
+    showBadge?: boolean;
+    badgePosition?: 'top-right' | 'top-left';
+}
+
+export declare interface CartConfig {
+    storageKey?: string;
+    currency?: string;
+    taxRate?: number;
+    showTax?: boolean;
+    showDiscount?: boolean;
+    showShipping?: boolean;
+    showCurrencySelector?: boolean;
+    availableCurrencies?: Currency[];
+    shippingMethods?: ShippingMethod[];
+    discountCodes?: DiscountCode[];
+}
+
+export declare const CartDrawer: ({ className, overlayClassName, contentClassName, position, closeOnOverlayClick, showCheckoutButton, checkoutButtonText, onCheckout, }: CartDrawerProps) => JSX_2.Element | null;
+
+export declare interface CartDrawerProps {
+    className?: string;
+    overlayClassName?: string;
+    contentClassName?: string;
+    position?: 'right' | 'left' | 'center' | 'start' | 'end';
+    closeOnOverlayClick?: boolean;
+    showCheckoutButton?: boolean;
+    checkoutButtonText?: string;
+    onCheckout?: () => void;
+}
+
+export declare type CartItem<T extends BaseProduct = BaseProduct> = T & {
+    quantity: number;
+};
+
+export declare const CartItemComponent: default_2.MemoExoticComponent<({ item, className, showRemoveButton, imageClassName, onRemove, }: CartItemProps) => JSX_2.Element>;
+
+export declare interface CartItemProps {
+    item: CartItem;
+    className?: string;
+    showRemoveButton?: boolean;
+    imageClassName?: string;
+    onRemove?: (item: CartItem) => void;
+}
+
+export declare const CartItems: ({ className, emptyMessage, showRemoveButton, }: CartItemsProps) => JSX_2.Element;
+
+export declare interface CartItemsProps {
+    className?: string;
+    emptyMessage?: string;
+    showRemoveButton?: boolean;
+}
+
+export declare const CartProvider: ({ children, config, language, taxRate, shippingMethods, }: CartProviderProps) => JSX_2.Element;
+
+export declare interface CartProviderProps {
+    children: ReactNode;
+    config?: CartConfig;
+    language?: string;
+    taxRate?: number;
+    shippingMethods?: ShippingMethod[];
+}
+
+export declare interface CartState<T extends BaseProduct = BaseProduct> {
+    items: CartItem<T>[];
+    totalItems: number;
+    subtotal: number;
+    tax: number;
+    discount: Discount | null;
+    voucher: Voucher | null;
+    appliedRules: DiscountRule[];
+    total: number;
+}
+
+export declare const CartSummary: ({ className, showTax, showDiscount, }: CartSummaryProps) => JSX_2.Element;
+
+export declare interface CartSummaryProps {
+    className?: string;
+    showTax?: boolean;
+    showDiscount?: boolean;
+}
+
+export declare const CheckoutButton: ({ className, disabled, loading, onClick, children, }: CheckoutButtonProps) => JSX_2.Element;
+
+export declare interface CheckoutButtonProps {
+    className?: string;
+    disabled?: boolean;
+    loading?: boolean;
+    onClick?: () => void;
+    children?: React.ReactNode;
+}
+
+export declare const createCartStore: <T extends BaseProduct = BaseProduct>(config?: CartConfig) => UseBoundStore<Omit<StoreApi<StoreState<T>>, "persist"> & {
+persist: {
+setOptions: (options: Partial<PersistOptions<StoreState<T>, {
+items: CartItem<T>[];
+discount: Discount | null;
+voucher: Voucher | null;
+selectedShippingMethod: string;
+selectedCurrency: string;
+}>>) => void;
+clearStorage: () => void;
+rehydrate: () => Promise<void> | void;
+hasHydrated: () => boolean;
+onHydrate: (fn: (state: StoreState<T>) => void) => () => void;
+onFinishHydration: (fn: (state: StoreState<T>) => void) => () => void;
+getOptions: () => Partial<PersistOptions<StoreState<T>, {
+items: CartItem<T>[];
+discount: Discount | null;
+voucher: Voucher | null;
+selectedShippingMethod: string;
+selectedCurrency: string;
+}>>;
+};
+}>;
+
+export declare interface Currency {
+    code: string;
+    symbol: string;
+    name: string;
+    conversionRate: number;
+    decimalPlaces: number;
+    thousandsSeparator: string;
+    decimalSeparator: string;
+    symbolOnLeft?: boolean;
+}
+
+export declare const CurrencySelector: ({ className, showCurrencyName, compact, }: CurrencySelectorProps) => JSX_2.Element | null;
+
+export declare interface CurrencySelectorProps {
+    className?: string;
+    showCurrencyName?: boolean;
+    compact?: boolean;
+}
+
+export declare interface Discount {
+    code: string;
+    amount: number;
+    type: 'percentage' | 'fixed';
+    description?: string;
+    expiryDate?: Date;
+    minimumOrderValue?: number;
+    applicableProducts?: string[];
+    usageLimit?: number;
+    usageCount?: number;
+}
+
+export declare interface DiscountCode {
+    code: string;
+    amount: number;
+    type: 'percentage' | 'fixed';
+    description?: string;
+    expiryDate?: Date;
+    minimumOrderValue?: number;
+    usageLimit?: number;
+}
+
+export declare interface DiscountRule {
+    id: string;
+    name: string;
+    type: 'percentage' | 'fixed' | 'bogo' | 'bundle';
+    value: number;
+    conditions?: {
+        minimumOrderValue?: number;
+        applicableProducts?: string[];
+        excludedProducts?: string[];
+        maximumDiscount?: number;
+        expiryDate?: Date;
+        usageLimit?: number;
+        usageCount?: number;
+    };
+    isActive?: boolean;
+    priority?: number;
+}
+
+export declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | boolean | Iterable<ReactNode> | JSX_2.Element | null | undefined;
+}
+
+declare interface ErrorBoundaryProps {
+    children: ReactNode;
+    fallback?: ReactNode;
+    onError?: (error: Error, errorInfo: ErrorInfo) => void;
+}
+
+declare interface ErrorBoundaryState {
+    hasError: boolean;
+    error: Error | null;
+}
+
+export declare interface ShippingMethod {
+    id: string;
+    name: string;
+    description: string;
+    cost: number;
+    estimatedDays: string;
+    isDefault?: boolean;
+}
+
+declare interface StoreState<T extends BaseProduct = BaseProduct> {
+    items: CartItem<T>[];
+    discount: Discount | null;
+    voucher: Voucher | null;
+    selectedShippingMethod: string;
+    selectedCurrency: string;
+    isDrawerOpen: boolean;
+    config: CartConfig;
+    addItem: (product: T) => void;
+    removeItem: (id: string | number) => void;
+    updateItemQuantity: (id: string | number, quantity: number) => void;
+    clearCart: () => void;
+    applyDiscount: (code: string) => void;
+    removeDiscount: () => void;
+    applyVoucher: (voucher: Voucher) => void;
+    removeVoucher: () => void;
+    validateVoucher: (code: string, currentSubtotal?: number) => Voucher | null;
+    getActiveDiscounts: () => Discount[];
+    getActiveVouchers: () => Voucher[];
+    setIsDrawerOpen: (open: boolean) => void;
+    setConfig: (config: Partial<CartConfig>) => void;
+    setSelectedShippingMethod: (methodId: string) => void;
+    setSelectedCurrency: (currencyCode: string) => void;
+    validateDiscountCode: (code: string, currentSubtotal?: number) => DiscountCode | null;
+    getCurrentCurrency: () => Currency | null;
+    convertAmount: (amount: number) => number;
+    formatCurrency: (amount: number) => string;
+}
+
+export declare const supportedLanguages: {
+    code: string;
+    name: string;
+    dir: string;
+}[];
+
+export declare interface Translation {
+    cart: {
+        title: string;
+        empty: string;
+        addItem: string;
+        removeItem: string;
+        updateQuantity: string;
+        clearCart: string;
+        subtotal: string;
+        tax: string;
+        discount: string;
+        voucher: string;
+        total: string;
+        checkout: string;
+        applyVoucher: string;
+        removeVoucher: string;
+        invalidVoucher: string;
+        voucherApplied: string;
+        minimumOrderValue: string;
+        expiredVoucher: string;
+        usageLimitExceeded: string;
+        discountCode: string;
+        enterDiscountCode: string;
+        shippingMethod: string;
+        standardShipping: string;
+        expressShipping: string;
+        freeShipping: string;
+        item: string;
+        items: string;
+        addItemsToStart: string;
+        clear: string;
+        sortByName: string;
+        sortByPrice: string;
+        sortByQuantity: string;
+        paymentMethod: string;
+        hide: string;
+        change: string;
+        processing: string;
+        remove: string;
+    };
+    product: {
+        addToCart: string;
+        outOfStock: string;
+        inStock: string;
+        price: string;
+        quantity: string;
+        saveForLater: string;
+        save: string;
+        edit: string;
+        remove: string;
+    };
+    ui: {
+        loading: string;
+        error: string;
+        success: string;
+        close: string;
+        open: string;
+        save: string;
+        edit: string;
+        remove: string;
+        apply: string;
+        cancel: string;
+        continue: string;
+        search: string;
+        filter: string;
+        sort: string;
+        currency: string;
+        selectRequestedCurrency: string;
+    };
+    currencies: {
+        USD: string;
+        EUR: string;
+        GBP: string;
+        JOD: string;
+        AED: string;
+        SAR: string;
+        CAD: string;
+        AUD: string;
+        JPY: string;
+        [key: string]: string;
+    };
+}
+
+declare interface TranslationContextType {
+    language: string;
+    setLanguage: (language: string) => void;
+    t: ReturnType<typeof useTranslation>;
+    direction: 'ltr' | 'rtl';
+}
+
+export declare const TranslationProvider: ({ children, defaultLanguage, language: languageProp }: TranslationProviderProps) => default_2.FunctionComponentElement<default_2.ProviderProps<TranslationContextType | undefined>>;
+
+declare interface TranslationProviderProps {
+    children: ReactNode;
+    defaultLanguage?: string;
+    language?: string;
+}
+
+export declare const useLanguageSwitcher: () => {
+    currentLanguage: string;
+    switchLanguage: (newLanguage: string) => void;
+    supportedLanguages: {
+        code: string;
+        name: string;
+        dir: string;
+    }[];
+};
+
+export declare const useShoppingCart: <T extends BaseProduct = BaseProduct>() => UseShoppingCartReturn<T>;
+
+declare interface UseShoppingCartReturn<T extends BaseProduct = BaseProduct> {
+    items: CartItem<T>[];
+    totalItems: number;
+    subtotal: number;
+    tax: number;
+    discount: Discount | null;
+    discountAmount: number;
+    voucher: Voucher | null;
+    total: number;
+    isDrawerOpen: boolean;
+    config: CartConfig;
+    selectedShippingMethod: string;
+    shippingMethods: ShippingMethod[];
+    shippingCost: number;
+    selectedCurrency: string;
+    availableCurrencies: Currency[];
+    currentCurrency: Currency | null;
+    addItem: (product: T) => void;
+    removeItem: (id: string | number) => void;
+    updateItemQuantity: (id: string | number, quantity: number) => void;
+    clearCart: () => void;
+    applyDiscount: (code: string) => void;
+    removeDiscount: () => void;
+    applyVoucher: (voucher: Voucher) => void;
+    removeVoucher: () => void;
+    validateVoucher: (code: string) => Voucher | null;
+    getActiveDiscounts: () => Discount[];
+    getActiveVouchers: () => Voucher[];
+    setIsDrawerOpen: (open: boolean) => void;
+    setSelectedShippingMethod: (methodId: string) => void;
+    setSelectedCurrency: (currencyCode: string) => void;
+    validateDiscountCode: (code: string) => DiscountCode | null;
+    getCurrentCurrency: () => Currency | null;
+    convertAmount: (amount: number) => number;
+    formatCurrency: (amount: number) => string;
+}
+
+export declare const useTranslation: (language?: string) => Translation;
+
+export declare const useTranslationContext: () => TranslationContextType;
+
+export declare interface Voucher {
+    code: string;
+    amount: number;
+    type: 'percentage' | 'fixed';
+    description?: string;
+    expiryDate?: Date;
+    minimumOrderValue?: number;
+    applicableProducts?: string[];
+    usageLimit?: number;
+    usageCount?: number;
+    isValid?: boolean;
+}
+
+export { }