@storepecker/storefront-core 2.3.5 → 2.4.0

package/dist/pixelEvents-Bo-VjAx8.d.ts

@@ -0,0 +1,371 @@
+import { b as Category$1, C as Cart } from './cart-y-7RPmnQ.js';
+import { C as CollectionResponse } from './collections-BDSVfRNo.js';
+import { O as Order } from './orders-L_8eIkUS.js';
+import { f as ProductDetail, d as Product } from './product-DJMdi4D4.js';
+
+interface PageProps {
+    nav_bar: NavBar;
+    store: string;
+    store_desc: string;
+    page_meta_data: PageMeta;
+    primary_color: string;
+    social_media: SocialMedia[];
+}
+type PageMeta = {
+    title: string;
+    description: string;
+    image: string;
+    url: string;
+    canonical_url: string;
+    appleTouchIcon: string;
+    twitter_card_size: string;
+    favIcon: string;
+};
+interface TemplateTheme {
+    primary: string;
+    secondary: string;
+}
+interface Logo {
+    url: string;
+    title: string;
+}
+interface NavElementOld {
+    title: string;
+    is_dropdown: boolean;
+    link?: string;
+    menuitems?: Menuitem[];
+}
+interface Menuitem {
+    id: number;
+    title: string;
+    link: string;
+    sub_categories?: SubCategory[];
+}
+interface SubCategory {
+    id: number;
+    title: string;
+    link: string;
+}
+interface SocialMedia {
+    type: string;
+    link: string;
+}
+interface PagePropsFull {
+    store: number;
+    theme: Theme;
+    privacy_policy: any;
+    terms_and_condition: any;
+    custom_css: string;
+    custom_js: string;
+    navbar: NavBar;
+    color_scheme: ColorScheme;
+    social_links: SocialLinks;
+    hero: Hero;
+    sections: Section[];
+    footer: Footer;
+    start_head_tag: string;
+    end_head_tag: string;
+    start_body_tag: string;
+    end_body_tag: string;
+    logo: string;
+    favicon: string;
+    store_name: string;
+    store_description: string;
+    social_image: string;
+    url: string;
+    categories: HeaderCategory[];
+    store_phone: string;
+    store_email: string;
+    store_address: string;
+    google_tag_manager_id?: string;
+}
+type PageHeaderProps = Pick<PagePropsFull, "navbar" | "logo" | "store_name" | "store_description" | "color_scheme" | "social_image" | "social_links" | "url" | "footer" | "categories" | "store_phone" | "store_email" | "store_address" | "start_head_tag" | "end_head_tag" | "start_body_tag" | "end_body_tag" | "google_tag_manager_id"> & {
+    currency_code: string;
+    currency_symbol: string;
+    is_cod_enabled: boolean;
+    cod_amount: number;
+    store_review_enabled: boolean;
+    product_review_enabled: boolean;
+    store_review_popup_delay: number;
+    store_review_popup_delay_unit: "hours" | "days" | "weeks" | "months" | "minutes" | "seconds";
+    popup_enabled: boolean;
+    popup_heading_text: string;
+    popup_message_text: string;
+    popup_thank_you_message: string;
+    public_checkout_enabled: boolean;
+    booking_success_message: string;
+    order_success_message: string;
+};
+type HomePageContents = Pick<PagePropsFull, "hero" | "sections">;
+interface Theme {
+    id: number;
+    name: string;
+    slug: string;
+    color_scheme: ColorScheme;
+    is_active: boolean;
+}
+interface ColorScheme {
+    primary: string;
+    secondary: string;
+    bodyBackground: string;
+    bodyBackground1: string;
+    bodyBackgroundSecondary: string;
+    bodyBackgroundDark: string;
+    borderBackground: string;
+    textPrimary: string;
+    textPrimaryLight: string;
+    textSecondary: string;
+    btnText: string;
+}
+interface RibbonMessage {
+    id: string;
+    message: string;
+    link: string;
+}
+interface RibbonBar {
+    type: "ribbon-bar";
+    messages: RibbonMessage[];
+    textColor: string;
+    id: string;
+    position: "top" | "bottom";
+    animation: string;
+    switchInterval: number;
+}
+interface NavBar {
+    wishlist: boolean;
+    cart: boolean;
+    navElements: NavElement[];
+}
+interface NavBar {
+    wishlist: boolean;
+    cart: boolean;
+    navElements: NavElement[];
+    ribbonbar: RibbonBar;
+    logoPosition: "left" | "center";
+}
+interface NavElement {
+    key: string;
+    title: string;
+    is_dropdown: boolean;
+    link?: string;
+    enabled?: boolean;
+    description: string;
+}
+interface NavElement {
+    key: string;
+    title: string;
+    is_dropdown: boolean;
+    link?: string;
+    enabled?: boolean;
+    description: string;
+}
+interface HeaderCategory {
+    id: number;
+    name: string;
+    link: string;
+    slug: string;
+    children?: HeaderCategory[];
+}
+interface SliderSettings {
+    id: string;
+    title: string;
+    description: string;
+    cta: string;
+    ctaLink: string;
+    bannerImage: string;
+    bannerImageMobile: string;
+    showContents?: boolean;
+}
+interface Hero {
+    title: string;
+    cta: string;
+    ctaLink: string;
+    heroImage: string;
+    description: string;
+    heroImageMobile: string;
+    showTitle: boolean;
+    showCTA: boolean;
+    bannerLink: string;
+    enableSlider: boolean;
+    sliderSettings: SliderSettings[];
+    switchInterval: number;
+    showHeroBanner: boolean;
+}
+type FilterType = "category" | "badge" | "title";
+type FilterOption = "select" | "equals" | "contain" | "startWith" | "endWith";
+type AvailableFilter = {
+    id: number;
+    label: string;
+    value: FilterType;
+    options: FilterOption[];
+};
+interface SectionFilters {
+    id: string;
+    type: FilterType;
+    label: string;
+    condition: FilterOption;
+    value: string | string[];
+}
+interface SectionFilters {
+    id: string;
+    type: FilterType;
+    label: string;
+    condition: FilterOption;
+    value: string | string[];
+}
+interface ProductCollection {
+    type: "product-collection";
+    title?: string;
+    filters?: SectionFilters[];
+    id: string;
+    row_count: number;
+}
+interface Category {
+    type: "categories";
+    title?: string;
+    id?: string;
+    categories?: Category$1.Root[];
+    selectedCategories?: string[];
+}
+interface Banner {
+    type: "banner";
+    title: string;
+    description?: string;
+    bannerImage: string;
+    ctaText?: string;
+    ctaLink?: string;
+    id: string;
+    bannerLink: string;
+    showContents: boolean;
+    mobileBannerImage: string;
+}
+interface SubCategorySection {
+    type: "sub-categories";
+    id: number;
+    title: string;
+    category?: Category$1.Root;
+}
+interface preFooterContent {
+    id: string;
+    image: string;
+    title: string;
+    description: string;
+}
+interface PreFooter {
+    type: "pre-footer";
+    id: string;
+    contents: preFooterContent[];
+}
+interface CategoryHighlights {
+    type: "category-highlights";
+    title?: string;
+    id?: string;
+    categories: Category$1.Root[];
+}
+interface StoreReview {
+    type: "store-review";
+    id: string;
+    title: string;
+    filter: string;
+    reviewsCount: number;
+    starColor: string;
+    autoPlayEnabled: boolean;
+}
+interface ProductHighlight {
+    type: "product-highlight";
+    id: string;
+    title: string;
+    productSlug: string;
+}
+interface ImageWithText {
+    type: "image-with-text";
+    id: string;
+    title: string;
+    content: string;
+    image: string;
+    showCta: boolean;
+    ctaText: string;
+    ctaLink: string;
+    imagePosition: 'left' | 'right';
+}
+interface Collections {
+    type: "collections";
+    id: string;
+    slug: string;
+    title?: string;
+    description?: string;
+    variants?: CollectionResponse[];
+}
+interface ValueHighlights {
+    type: "value-highlights";
+    id: string;
+    title: string;
+    description: string;
+    highlights: {
+        value: string;
+        label: string;
+        image: string;
+        social: null | string;
+    }[];
+}
+type SectionType = "product-collection" | "categories" | "banner" | "sub-categories" | "pre-footer" | "category-highlights" | "store-review" | "product-highlight" | "image-with-text" | "collections" | "value-highlights";
+type Section = ProductCollection | Category | Banner | PreFooter | StoreReview | CategoryHighlights | SubCategorySection | ProductHighlight | ImageWithText | Collections | ValueHighlights;
+interface Footer {
+    showSocialLinks: boolean;
+    showContactDetails: boolean;
+    showNameWithLogo: boolean;
+    showWhatsappBubble: boolean;
+    showMadeWithStorepecker: boolean;
+}
+interface SocialLinks {
+}
+interface LocationData {
+    country_code: string;
+    city: string;
+}
+
+declare global {
+    interface Window {
+        fbq: any;
+    }
+}
+declare const pixelEvents: {
+    /**
+     * Track when a user views a product
+     */
+    productView: (product: ProductDetail.Root) => void;
+    /**
+     * Track when a product is added to cart
+     */
+    addToCart: (product: Product.ProductList, quantity?: number) => void;
+    removeFromCart: (product: ProductDetail.Root) => void;
+    /**
+     * Track when a product is added to wishlist
+     */
+    addToWishlist: (product: Product.ProductList) => void;
+    /**
+     * Track when user initiates checkout
+     */
+    initiateCheckout: (orderSummary: Order.OrderSummary, paymentMethod: string) => void;
+    /**
+     * Track successful purchases
+     */
+    purchase: (orderSummary: Order.OrderSummary) => void;
+    /**
+     * Track search events
+     */
+    search: (searchTerm: string, resultCount: number) => void;
+    /**
+     * Track when a user views their cart
+     */
+    cartView: (cart: Cart.Root) => void;
+    /**
+     * Track when a user completes a checkout
+     */
+    checkoutCompleted: (orderSummary: Order.OrderSummary) => void;
+    addressInfoSubmitted: () => void;
+    checkoutStarted: (cart: Cart.Root) => void;
+    pageViewed: () => void;
+};
+
+export { type AvailableFilter as A, type Banner as B, type Category as C, pixelEvents as D, type preFooterContent as E, type FilterOption as F, type HeaderCategory as H, type ImageWithText as I, type LocationData as L, type Menuitem as M, type NavBar as N, type PageHeaderProps as P, type RibbonBar as R, type SectionFilters as S, type TemplateTheme as T, type ValueHighlights as V, type CategoryHighlights as a, type Collections as b, type ColorScheme as c, type FilterType as d, type Footer as e, type Hero as f, type HomePageContents as g, type Logo as h, type NavElement as i, type NavElementOld as j, type PageMeta as k, type PageProps as l, type PagePropsFull as m, type PreFooter as n, type ProductCollection as o, type ProductHighlight as p, type RibbonMessage as q, type Section as r, type SectionType as s, type SliderSettings as t, type SocialLinks as u, type SocialMedia as v, type StoreReview as w, type SubCategory as x, type SubCategorySection as y, type Theme as z };