yt-uikit 0.8.18-freebie-milestone.0 → 0.8.18

package/dist/esm/types/components/BundleBlock/Bundle.d.ts

@@ -1,396 +1,396 @@
-import React from "react";
-import "./bundle.scss";
-interface ShopifyCurrency {
-    rate: number;
-    active: string;
-}
-declare global {
-    interface Window {
-        Shopify?: {
-            currency?: ShopifyCurrency;
-        };
-    }
-}
-type ProductImage = {
-    url: string;
-    height: number;
-    width: number;
-    altText?: string;
-};
-type ProductFeaturedMedia = {
-    alt: string;
-    preview: {
-        image: {
-            url: string;
-            height?: number;
-            width?: number;
-            altText: string;
-        };
-    };
-};
-type ProductOption = {
-    id: string;
-    name: string;
-    values: string[];
-};
-type CollectionNode = {
-    node: {
-        id: string;
-        title: string;
-        handle: string;
-    };
-};
-export type VariantNode = {
-    node: {
-        id: string;
-        price: string;
-        compareAtPrice: string;
-        title: string;
-        displayName: string;
-        image: ProductImage;
-        availableForSale: boolean;
-        inventoryQuantity: number;
-        inventoryItem?: {
-            tracked?: boolean;
-        };
-        inventoryPolicy?: "deny" | "continue";
-    };
-};
-type SelectedVariantDetails = {
-    id: string;
-    price: string;
-    compareAtPrice: string;
-    title: string;
-    displayName: string;
-    image: ProductImage;
-    availableForSale: boolean;
-    inventoryQuantity: number;
-};
-export type VariantOptions = {
-    shop: string;
-    options: {
-        name: string;
-        type: "text" | "image" | "color";
-        values: {
-            name: string;
-            value: string;
-        }[];
-    }[];
-    createdAt: string;
-    updatedAt: string;
-};
-export type ProductDetails = {
-    id: string;
-    title: string;
-    handle: string;
-    featuredMedia: ProductFeaturedMedia;
-    status: "active" | "archived" | "draft" | "";
-    options: ProductOption[];
-    onlineStoreUrl: string;
-    tracksInventory?: boolean;
-    collections: {
-        edges: CollectionNode[];
-    };
-    variants: {
-        edges: VariantNode[];
-    };
-    shop: string;
-    metafield?: {
-        key: string;
-        namespace: string;
-        ownerType: string;
-        value: string;
-        id: string;
-        jsonValue: string[];
-        type: string;
-    };
-    descriptionHtml: string;
-    media: {
-        edges: {
-            node: {
-                alt: string;
-                preview: {
-                    image: {
-                        altText: string;
-                        width?: number;
-                        height?: number;
-                        url: string;
-                    };
-                };
-                image: {
-                    altText: string;
-                    height: number;
-                    width: number;
-                    url: string;
-                };
-            };
-        }[];
-    };
-    selectedVariant?: SelectedVariantDetails;
-    rating?: {
-        averageRating: number;
-        ratingCount: number;
-    };
-};
-export type ProductData = {
-    productId: string;
-    variantIds: string[];
-    productDetails: ProductDetails;
-};
-type GeneralStyle = {
-    primaryColor: string;
-    primaryContrastColor: string;
-    secondaryColor: string;
-    secondaryContrastColor: string;
-    imageAspectRatio: string;
-    ctaBackgroundColor: string;
-    ctaTextColor: string;
-    ctaBorderColor: string;
-    ctaShadowType: string;
-    ctaPadding: string;
-    ctaWidth: string;
-    ctaBorderRadius: string;
-    ctaHoverBackgroundColor: string;
-    ctaHoverTextColor: string;
-    customizeHoverState: boolean;
-    checkoutPartner: string;
-    redirectToPDP: boolean;
-    restrictCOD: boolean;
-    trackInventory: boolean;
-    showOutOfStockProducts: boolean;
-    outOfStockLabel: string;
-    disabledButtonColor: string;
-    storeCurrency: string;
-    currencySymbol: string;
-    discountPrefix: string;
-    discountSuffix: string;
-    addOrderTags: boolean;
-    addOrderNotes: boolean;
-    variantTitleSuffix: boolean;
-    titleLength: string;
-    showDecimalsInBundlePricing?: boolean;
-};
-type VolumeStyle = {
-    addtoCartMethod: string;
-    titleFontSize: string;
-    subtitleFontSize: string;
-    titleBackgroundColor: string;
-    titleTextColor: string;
-    verticalMargin: string;
-    sectionBackgroundColor: string;
-    cardStyle: string;
-    discountBadgeVisibility: string;
-    allowVariantSelection: string;
-    variantSelectorType: string;
-    ctaTitle: string;
-    bundleRedirection: string;
-};
-type ComboStyle = {
-    productTitleFontSize: string;
-    productDescriptionFontSize: string;
-    descriptionTextColor: string;
-    titleTextColor: string;
-    verticalMargin: string;
-    infoAlignment: string;
-    ctaTitle: string;
-    bundleRedirection: string;
-    embedContentVisibility: boolean;
-    mixAndMatchCardStyle: string;
-    mixAndMatchVariantTypeSelector: string;
-    comboCardStyle: string;
-    comboVariantTypeSelector: string;
-    selectedEmbedContentVisibilityOptions: string[];
-    subProductsSectionVisibility: boolean;
-    subProductsImageVisibility: boolean;
-    subProductsProductTitleVisibility: boolean;
-    subProductsProductPriceVisibility: boolean;
-};
-type ByobStyle = {
-    titleFontSize: string;
-    subtitleFontSize: string;
-    titleBackgroundColor: string;
-    titleTextColor: string;
-    productTitleFontSize: string;
-    sectionBackgroundColor: string;
-    lazyLoadWidget: string;
-    listingsGap: string;
-    footerMargin: string;
-    borderRadius: string;
-    borderColor: string;
-    cardBackgroundColor: string;
-    shadowType: string;
-    addToBundleCTAText: string;
-    checkoutCTAText: string;
-    variantSelectorType: string;
-    primaryVariant: string;
-    productsPriceVisibility: boolean;
-    compareAtPriceVisibility: boolean;
-    selectedProductsVisibility: boolean;
-    bundleRedirection: string;
-    enableConfetti: boolean;
-    selectedItemVisibility: boolean;
-    productTiersVisibility: boolean;
-    tierNavigation: boolean;
-    enableProductCategories: boolean;
-    productCardCategoryVisibility: string;
-    categoryFilterOnPage: string;
-};
-type FixedStyle = {
-    titleFontSize: string;
-    subtitleFontSize: string;
-    titleBackgroundColor: string;
-    titleTextColor: string;
-    verticalMargin: string;
-    sectionBackgroundColor: string;
-    borderRadius: string;
-    borderColor: string;
-    cardBackgroundColor: string;
-    shadowType: string;
-    infoAlignment: string;
-    ctaTitle: string;
-    bundleRedirection: string;
-    cardLayoutStyle: string;
-    variantSelectorType: string;
-    productsPriceVisibility: boolean;
-    compareAtPriceVisibility: boolean;
-};
-export type Customizations = {
-    shop?: string;
-    general: GeneralStyle;
-    byob: ByobStyle;
-    fixedBundle: FixedStyle;
-    volumeBundle: VolumeStyle;
-    comboBundle: ComboStyle;
-    createdAt?: string;
-    updatedAt?: string;
-};
-export type ProductTier = {
-    tier: number;
-    title: string;
-    minimumQuantity: number;
-    isFixed?: boolean;
-    isFreebieTier?: boolean;
-    products: {
-        productId: string;
-        variantIds: string[];
-    }[];
-};
-export type BundlePayload = {
-    showIndividualProductSelector: boolean;
-    title?: string;
-    subtitle?: string;
-    products: ProductData[];
-    percentageOff?: number;
-    dealAmount?: number;
-    amountOff?: number;
-    type: "fixed" | "builder" | "volume" | "mixAndMatch" | "" | "combo" | "collection";
-    minimumQuantity: number;
-    showProductDetailsInTracker: boolean;
-    coverImageUrl?: string;
-    mobileCoverImageUrl?: string;
-    titleSectionTextColor?: string;
-    titleSectionBackgroundColor?: string;
-    dealTextColor?: string;
-    showBorder?: boolean;
-    hideProductDetails?: boolean;
-    cornerRadiusType?: "medium" | "high" | "";
-    primaryBackgroundColorCta?: string;
-    enableProgressBar?: boolean;
-    enableSortAndFilter?: boolean;
-    disableQuantitySelector?: boolean;
-    disableInventoryTracking?: boolean;
-    alignFixedBundleContent?: "left" | "right" | "center" | "";
-    imageAspectType?: "portrait" | "square" | "";
-    backgroundColorFixedBundleDiv?: string;
-    canCustomizeFixedBundle?: boolean;
-    primaryTextColorCta?: string;
-    showVariants?: boolean;
-    discountType?: string;
-    showCta?: boolean;
-    productCardBadgeText?: string;
-    coverImageVerticalMargin?: string;
-    builderTiers?: {
-        type: string;
-        offerTier?: {
-            tier: number;
-            minimumQuantity: number;
-            discountValue: number;
-        }[];
-        productTier?: ProductTier[];
-    };
-    volumeTiers?: {
-        isDefault: unknown;
-        tier: number;
-        minimumQuantity: number;
-        title: string;
-        subtitle: string;
-        badgeTitle: string;
-        discountValue: number;
-        imageUrl?: string;
-    }[];
-    mixAndMatchTiers?: {
-        tier: number;
-        title: string;
-        products: {
-            productId: string;
-            variantIds: string[];
-        }[];
-    }[];
-    customizations: Customizations;
-    variantOptions?: VariantOptions;
-    storeCurrencyCode?: string;
-    customStoreDetails?: {
-        [key: string]: any;
-    };
-    customProductsQuantity?: number | null;
-    reviewRatingType?: "none" | "ratingOnly" | "ratingAndReviewCount";
-    appName?: string;
-    pageHeader?: {
-        title?: string;
-        description?: string;
-        customizePadding?: string;
-    };
-};
-export type BundleProps = {
-    bundle: BundlePayload;
-    addToCartFunction?: (selectedItemsSubtotal: number, variantIds?: string[], finalBundlePrice?: number, variantIdPriceMap?: {
-        variantId: string;
-        price: number;
-    }[]) => Promise<void>;
-    addCustomBundleToCart?: (e: any) => Promise<void>;
-    selectedItems?: {
-        variantId: string;
-        product: ProductDetails;
-        quantity: number;
-    }[];
-    setSelectedItems?: React.Dispatch<React.SetStateAction<{
-        variantId: string;
-        product: ProductDetails;
-        quantity: number;
-    }[]>>;
-    bundleAddToCartLoading?: boolean;
-    handleRemoveItem?: (variantId: string) => void;
-    selectedItemsQuantity?: number;
-    renderingOnPage?: boolean;
-    bundleSubtotal?: {
-        price: number;
-        compareAtPrice: number;
-    };
-    bundleHeaderBackgroundColor?: string;
-    currentProductId?: string;
-};
-export declare const currencyPrice: (price: number | string | undefined) => string | undefined;
-export declare const getCurrencySymbol: (genSymbol: string, storeCurrencyCode?: string) => string;
-export declare const optimiseImage: (url: string, width?: number) => string;
-export declare const handleAddToBundle: (variantId: string, product: ProductDetails, quantity: number, selectedItems: {
-    variantId: string;
-    product: ProductDetails;
-    quantity: number;
-}[], setSelectedItems: React.Dispatch<React.SetStateAction<{
-    variantId: string;
-    product: ProductDetails;
-    quantity: number;
-    isFree?: boolean | undefined;
-}[]>>, isFreebie?: boolean) => void;
-declare const Bundle: React.FC<BundleProps>;
-export default Bundle;
+import React from "react";
+import "./bundle.scss";
+interface ShopifyCurrency {
+    rate: number;
+    active: string;
+}
+declare global {
+    interface Window {
+        Shopify?: {
+            currency?: ShopifyCurrency;
+        };
+    }
+}
+type ProductImage = {
+    url: string;
+    height: number;
+    width: number;
+    altText?: string;
+};
+type ProductFeaturedMedia = {
+    alt: string;
+    preview: {
+        image: {
+            url: string;
+            height?: number;
+            width?: number;
+            altText: string;
+        };
+    };
+};
+type ProductOption = {
+    id: string;
+    name: string;
+    values: string[];
+};
+type CollectionNode = {
+    node: {
+        id: string;
+        title: string;
+        handle: string;
+    };
+};
+export type VariantNode = {
+    node: {
+        id: string;
+        price: string;
+        compareAtPrice: string;
+        title: string;
+        displayName: string;
+        image: ProductImage;
+        availableForSale: boolean;
+        inventoryQuantity: number;
+        inventoryItem?: {
+            tracked?: boolean;
+        };
+        inventoryPolicy?: "deny" | "continue";
+    };
+};
+type SelectedVariantDetails = {
+    id: string;
+    price: string;
+    compareAtPrice: string;
+    title: string;
+    displayName: string;
+    image: ProductImage;
+    availableForSale: boolean;
+    inventoryQuantity: number;
+};
+export type VariantOptions = {
+    shop: string;
+    options: {
+        name: string;
+        type: "text" | "image" | "color";
+        values: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+    createdAt: string;
+    updatedAt: string;
+};
+export type ProductDetails = {
+    id: string;
+    title: string;
+    handle: string;
+    featuredMedia: ProductFeaturedMedia;
+    status: "active" | "archived" | "draft" | "";
+    options: ProductOption[];
+    onlineStoreUrl: string;
+    tracksInventory?: boolean;
+    collections: {
+        edges: CollectionNode[];
+    };
+    variants: {
+        edges: VariantNode[];
+    };
+    shop: string;
+    metafield?: {
+        key: string;
+        namespace: string;
+        ownerType: string;
+        value: string;
+        id: string;
+        jsonValue: string[];
+        type: string;
+    };
+    descriptionHtml: string;
+    media: {
+        edges: {
+            node: {
+                alt: string;
+                preview: {
+                    image: {
+                        altText: string;
+                        width?: number;
+                        height?: number;
+                        url: string;
+                    };
+                };
+                image: {
+                    altText: string;
+                    height: number;
+                    width: number;
+                    url: string;
+                };
+            };
+        }[];
+    };
+    selectedVariant?: SelectedVariantDetails;
+    rating?: {
+        averageRating: number;
+        ratingCount: number;
+    };
+};
+export type ProductData = {
+    productId: string;
+    variantIds: string[];
+    productDetails: ProductDetails;
+};
+type GeneralStyle = {
+    primaryColor: string;
+    primaryContrastColor: string;
+    secondaryColor: string;
+    secondaryContrastColor: string;
+    imageAspectRatio: string;
+    ctaBackgroundColor: string;
+    ctaTextColor: string;
+    ctaBorderColor: string;
+    ctaShadowType: string;
+    ctaPadding: string;
+    ctaWidth: string;
+    ctaBorderRadius: string;
+    ctaHoverBackgroundColor: string;
+    ctaHoverTextColor: string;
+    customizeHoverState: boolean;
+    checkoutPartner: string;
+    redirectToPDP: boolean;
+    restrictCOD: boolean;
+    trackInventory: boolean;
+    showOutOfStockProducts: boolean;
+    outOfStockLabel: string;
+    disabledButtonColor: string;
+    storeCurrency: string;
+    currencySymbol: string;
+    discountPrefix: string;
+    discountSuffix: string;
+    addOrderTags: boolean;
+    addOrderNotes: boolean;
+    variantTitleSuffix: boolean;
+    titleLength: string;
+    showDecimalsInBundlePricing?: boolean;
+};
+type VolumeStyle = {
+    addtoCartMethod: string;
+    titleFontSize: string;
+    subtitleFontSize: string;
+    titleBackgroundColor: string;
+    titleTextColor: string;
+    verticalMargin: string;
+    sectionBackgroundColor: string;
+    cardStyle: string;
+    discountBadgeVisibility: string;
+    allowVariantSelection: string;
+    variantSelectorType: string;
+    ctaTitle: string;
+    bundleRedirection: string;
+};
+type ComboStyle = {
+    productTitleFontSize: string;
+    productDescriptionFontSize: string;
+    descriptionTextColor: string;
+    titleTextColor: string;
+    verticalMargin: string;
+    infoAlignment: string;
+    ctaTitle: string;
+    bundleRedirection: string;
+    embedContentVisibility: boolean;
+    mixAndMatchCardStyle: string;
+    mixAndMatchVariantTypeSelector: string;
+    comboCardStyle: string;
+    comboVariantTypeSelector: string;
+    selectedEmbedContentVisibilityOptions: string[];
+    subProductsSectionVisibility: boolean;
+    subProductsImageVisibility: boolean;
+    subProductsProductTitleVisibility: boolean;
+    subProductsProductPriceVisibility: boolean;
+};
+type ByobStyle = {
+    titleFontSize: string;
+    subtitleFontSize: string;
+    titleBackgroundColor: string;
+    titleTextColor: string;
+    productTitleFontSize: string;
+    sectionBackgroundColor: string;
+    lazyLoadWidget: string;
+    listingsGap: string;
+    footerMargin: string;
+    borderRadius: string;
+    borderColor: string;
+    cardBackgroundColor: string;
+    shadowType: string;
+    addToBundleCTAText: string;
+    checkoutCTAText: string;
+    variantSelectorType: string;
+    primaryVariant: string;
+    productsPriceVisibility: boolean;
+    compareAtPriceVisibility: boolean;
+    selectedProductsVisibility: boolean;
+    bundleRedirection: string;
+    enableConfetti: boolean;
+    selectedItemVisibility: boolean;
+    productTiersVisibility: boolean;
+    tierNavigation: boolean;
+    enableProductCategories: boolean;
+    productCardCategoryVisibility: string;
+    categoryFilterOnPage: string;
+};
+type FixedStyle = {
+    titleFontSize: string;
+    subtitleFontSize: string;
+    titleBackgroundColor: string;
+    titleTextColor: string;
+    verticalMargin: string;
+    sectionBackgroundColor: string;
+    borderRadius: string;
+    borderColor: string;
+    cardBackgroundColor: string;
+    shadowType: string;
+    infoAlignment: string;
+    ctaTitle: string;
+    bundleRedirection: string;
+    cardLayoutStyle: string;
+    variantSelectorType: string;
+    productsPriceVisibility: boolean;
+    compareAtPriceVisibility: boolean;
+};
+export type Customizations = {
+    shop?: string;
+    general: GeneralStyle;
+    byob: ByobStyle;
+    fixedBundle: FixedStyle;
+    volumeBundle: VolumeStyle;
+    comboBundle: ComboStyle;
+    createdAt?: string;
+    updatedAt?: string;
+};
+export type ProductTier = {
+    tier: number;
+    title: string;
+    minimumQuantity: number;
+    isFixed?: boolean;
+    isFreebieTier?: boolean;
+    products: {
+        productId: string;
+        variantIds: string[];
+    }[];
+};
+export type BundlePayload = {
+    showIndividualProductSelector: boolean;
+    title?: string;
+    subtitle?: string;
+    products: ProductData[];
+    percentageOff?: number;
+    dealAmount?: number;
+    amountOff?: number;
+    type: "fixed" | "builder" | "volume" | "mixAndMatch" | "" | "combo" | "collection";
+    minimumQuantity: number;
+    showProductDetailsInTracker: boolean;
+    coverImageUrl?: string;
+    mobileCoverImageUrl?: string;
+    titleSectionTextColor?: string;
+    titleSectionBackgroundColor?: string;
+    dealTextColor?: string;
+    showBorder?: boolean;
+    hideProductDetails?: boolean;
+    cornerRadiusType?: "medium" | "high" | "";
+    primaryBackgroundColorCta?: string;
+    enableProgressBar?: boolean;
+    enableSortAndFilter?: boolean;
+    disableQuantitySelector?: boolean;
+    disableInventoryTracking?: boolean;
+    alignFixedBundleContent?: "left" | "right" | "center" | "";
+    imageAspectType?: "portrait" | "square" | "";
+    backgroundColorFixedBundleDiv?: string;
+    canCustomizeFixedBundle?: boolean;
+    primaryTextColorCta?: string;
+    showVariants?: boolean;
+    discountType?: string;
+    showCta?: boolean;
+    productCardBadgeText?: string;
+    coverImageVerticalMargin?: string;
+    builderTiers?: {
+        type: string;
+        offerTier?: {
+            tier: number;
+            minimumQuantity: number;
+            discountValue: number;
+        }[];
+        productTier?: ProductTier[];
+    };
+    volumeTiers?: {
+        isDefault: unknown;
+        tier: number;
+        minimumQuantity: number;
+        title: string;
+        subtitle: string;
+        badgeTitle: string;
+        discountValue: number;
+        imageUrl?: string;
+    }[];
+    mixAndMatchTiers?: {
+        tier: number;
+        title: string;
+        products: {
+            productId: string;
+            variantIds: string[];
+        }[];
+    }[];
+    customizations: Customizations;
+    variantOptions?: VariantOptions;
+    storeCurrencyCode?: string;
+    customStoreDetails?: {
+        [key: string]: any;
+    };
+    customProductsQuantity?: number | null;
+    reviewRatingType?: "none" | "ratingOnly" | "ratingAndReviewCount";
+    appName?: string;
+    pageHeader?: {
+        title?: string;
+        description?: string;
+        customizePadding?: string;
+    };
+};
+export type BundleProps = {
+    bundle: BundlePayload;
+    addToCartFunction?: (selectedItemsSubtotal: number, variantIds?: string[], finalBundlePrice?: number, variantIdPriceMap?: {
+        variantId: string;
+        price: number;
+    }[]) => Promise<void>;
+    addCustomBundleToCart?: (e: any) => Promise<void>;
+    selectedItems?: {
+        variantId: string;
+        product: ProductDetails;
+        quantity: number;
+    }[];
+    setSelectedItems?: React.Dispatch<React.SetStateAction<{
+        variantId: string;
+        product: ProductDetails;
+        quantity: number;
+    }[]>>;
+    bundleAddToCartLoading?: boolean;
+    handleRemoveItem?: (variantId: string) => void;
+    selectedItemsQuantity?: number;
+    renderingOnPage?: boolean;
+    bundleSubtotal?: {
+        price: number;
+        compareAtPrice: number;
+    };
+    bundleHeaderBackgroundColor?: string;
+    currentProductId?: string;
+};
+export declare const currencyPrice: (price: number | string | undefined) => string | undefined;
+export declare const getCurrencySymbol: (genSymbol: string, storeCurrencyCode?: string) => string;
+export declare const optimiseImage: (url: string, width?: number) => string;
+export declare const handleAddToBundle: (variantId: string, product: ProductDetails, quantity: number, selectedItems: {
+    variantId: string;
+    product: ProductDetails;
+    quantity: number;
+}[], setSelectedItems: React.Dispatch<React.SetStateAction<{
+    variantId: string;
+    product: ProductDetails;
+    quantity: number;
+    isFree?: boolean | undefined;
+}[]>>, isFreebie?: boolean) => void;
+declare const Bundle: React.FC<BundleProps>;
+export default Bundle;