avada-crossapp-banner 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,413 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+/**
+ * App handle identifiers
+ */
+type AppHandle = 'cookieBar' | 'ageVerification' | 'accessibility' | 'orderLimit';
+/**
+ * App prefix for event tracking
+ */
+type AppPrefix = 'cb' | 'av' | 'ac' | 'ol';
+/**
+ * Banner event actions
+ */
+type BannerEventAction = 'display' | 'close' | 'access';
+/**
+ * Target storage type for display banner logic
+ */
+type TargetStorageType = 'next_day' | '7_days_after' | '30_days_after';
+/**
+ * API client function type
+ */
+type ApiClient = (url: string, options?: {
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    body?: Record<string, unknown>;
+}) => Promise<{
+    data?: Record<string, unknown>;
+    error?: unknown;
+}>;
+/**
+ * Store dispatch function type
+ */
+type StoreDispatch = (action: unknown) => void;
+/**
+ * CrossApp banner configuration
+ */
+interface CrossAppConfig {
+    /**
+     * App prefix for event tracking (e.g., 'cb', 'ol', 'ac')
+     */
+    appPrefix: AppPrefix;
+    /**
+     * API client function for making requests
+     */
+    apiClient: ApiClient;
+    /**
+     * Store dispatch function for state updates
+     */
+    storeDispatch?: StoreDispatch;
+    /**
+     * Custom close icon component
+     */
+    closeIcon?: ReactNode;
+    /**
+     * Banner event endpoint
+     * @default '/banner-event'
+     */
+    bannerEventEndpoint?: string;
+    /**
+     * Shop update endpoint
+     * @default '/shop'
+     */
+    shopUpdateEndpoint?: string;
+}
+/**
+ * App data for CrossApp banner
+ */
+interface CrossAppData {
+    /**
+     * App handle identifier
+     */
+    appHandle: AppHandle;
+    /**
+     * Translation key prefix for i18n
+     */
+    translationKey: string;
+    /**
+     * Target URL for the CTA button
+     */
+    targetUrl: string;
+    /**
+     * Whether to show the plan button
+     */
+    showPlanBtn?: boolean;
+    /**
+     * URL for the plan button
+     */
+    planUrl?: string;
+    /**
+     * Background color for the banner
+     */
+    bgColor?: string;
+    /**
+     * Whether the banner should be hidden
+     */
+    isHideBanner?: boolean;
+    /**
+     * Event prefix for tracking
+     */
+    eventPrefix?: string;
+    /**
+     * LocalStorage key for tracking close count
+     */
+    bannerCloseKey?: string;
+    /**
+     * Image URL for the app icon
+     */
+    imageUrl?: string;
+    /**
+     * Image alt text
+     */
+    imageAlt?: string;
+}
+/**
+ * CrossApp banner component props
+ */
+interface CrossAppBannerProps {
+    /**
+     * Configuration for the banner
+     */
+    config: CrossAppConfig;
+    /**
+     * App data for the banner
+     */
+    appData: CrossAppData;
+    /**
+     * Source page for tracking
+     */
+    sourcePage?: string;
+    /**
+     * Current shop data
+     */
+    shop?: Record<string, unknown>;
+    /**
+     * Callback when banner is closed
+     */
+    onClose?: () => void;
+    /**
+     * Callback when shop data needs to be updated
+     */
+    onShopUpdate?: (shopData: Record<string, unknown>) => void;
+}
+/**
+ * useDisplayBanner options
+ */
+interface UseDisplayBannerOptions {
+    /**
+     * Configuration for the banner
+     */
+    config: CrossAppConfig;
+    /**
+     * Storage key for tracking display state
+     */
+    storageKey: string;
+    /**
+     * Target storage type
+     * @default 'next_day'
+     */
+    targetDateType?: TargetStorageType;
+    /**
+     * Whether to check storage for display state
+     * @default true
+     */
+    checkStorage?: boolean;
+    /**
+     * Current shop data
+     */
+    shop?: Record<string, unknown>;
+    /**
+     * Callback when banner is closed
+     */
+    onClose?: () => void;
+}
+/**
+ * useDisplayBanner return type
+ */
+interface UseDisplayBannerReturn {
+    /**
+     * Whether the banner should be displayed
+     */
+    shouldDisplay: boolean;
+    /**
+     * Hide the banner
+     */
+    hideBanner: () => void;
+    /**
+     * Show the banner
+     */
+    showBanner: () => void;
+    /**
+     * Handle closing the banner with API call
+     */
+    handleCloseBanner: (data?: Record<string, unknown>) => Promise<void>;
+}
+/**
+ * CrossApp icon props
+ */
+interface CrossAppIconProps$1 {
+    /**
+     * App handle to render icon for
+     */
+    app: AppHandle;
+    /**
+     * Icon size
+     * @default 48
+     */
+    size?: number;
+}
+
+/**
+ * CrossApp Banner Component
+ *
+ * A reusable banner component for cross-promoting Avada apps.
+ * Supports configuration-based customization for different apps.
+ */
+declare function CrossAppBanner({ config, appData, sourcePage, shop, onClose, onShopUpdate, }: CrossAppBannerProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * CrossApp Banner Component with i18n support
+ *
+ * A reusable banner component for cross-promoting Avada apps.
+ * Uses @shopify/react-i18n for translations.
+ */
+declare function CrossAppBannerWithI18n({ config, appData, sourcePage, shop, onClose, onShopUpdate, }: CrossAppBannerProps): react_jsx_runtime.JSX.Element | null;
+
+interface DownloadIconProps {
+    width?: number;
+    height?: number;
+    fill?: string;
+}
+declare function DownloadIcon({ width, height, fill, }: DownloadIconProps): react_jsx_runtime.JSX.Element;
+
+interface CrossAppIconProps {
+    app: AppHandle;
+    size?: number;
+}
+/**
+ * CrossApp icon component that renders the appropriate icon based on app handle
+ */
+declare function CrossAppIcon({ app, size }: CrossAppIconProps): react_jsx_runtime.JSX.Element;
+
+interface UseDisplayBannerConfig {
+    /**
+     * Storage key for tracking display state
+     */
+    storageKey: string;
+    /**
+     * Shop key for tracking dismissed banners per shop
+     */
+    shopKey?: string;
+    /**
+     * Current shop data
+     */
+    shop?: {
+        dismissedBanners?: string[];
+        [key: string]: unknown;
+    };
+    /**
+     * Whether to check shop dismissed banners
+     * @default false
+     */
+    checkShop?: boolean;
+    /**
+     * Number of closes before permanently dismissing
+     * @default 3
+     */
+    disableCount?: number;
+    /**
+     * Target storage type for next display
+     * @default 'next_day'
+     */
+    targetDateType?: TargetStorageType;
+    /**
+     * API client function for making requests
+     */
+    apiClient?: (url: string, options?: {
+        method?: string;
+        body?: Record<string, unknown>;
+    }) => Promise<{
+        success?: boolean;
+        data?: Record<string, unknown>;
+    }>;
+    /**
+     * Endpoint for updating shop data
+     * @default '/shops?type=banner'
+     */
+    shopUpdateEndpoint?: string;
+    /**
+     * Callback when shop data is updated
+     */
+    onShopUpdate?: (shopData: Record<string, unknown>) => void;
+    /**
+     * Callback when banner is closed
+     */
+    onClose?: () => void;
+    /**
+     * Whether to check storage for display state
+     * @default true
+     */
+    checkStorage?: boolean;
+}
+/**
+ * Hook to manage banner display state with localStorage persistence
+ */
+declare function useDisplayBanner({ storageKey, shopKey, shop, checkShop, disableCount, targetDateType, apiClient, shopUpdateEndpoint, onShopUpdate, onClose, checkStorage, }: UseDisplayBannerConfig): UseDisplayBannerReturn;
+
+/**
+ * App handle constants
+ */
+declare const APP_HANDLES: {
+    readonly ORDER_LIMIT: AppHandle;
+    readonly ACCESSIBILITY: AppHandle;
+    readonly COOKIE_BAR: AppHandle;
+    readonly AGE_VERIFICATION: AppHandle;
+};
+/**
+ * App domains
+ */
+declare const APP_DOMAINS: {
+    readonly COOKIE_BAR: "cookie.avada.io";
+    readonly AGE_VERIFICATION: "age-verification-b0fa4.firebaseapp.com";
+    readonly ACCESSIBILITY: "accessibility.avada.io";
+};
+/**
+ * Shopify app handles
+ */
+declare const SHOPIFY_APP_HANDLES: {
+    readonly COOKIE_BAR: "avada-cookie-bar";
+    readonly AGE_VERIFICATION: "sun-age-verification-popup";
+    readonly ACCESSIBILITY: "avada-accessibility";
+};
+/**
+ * Shopify plans to exclude from cross-app promotion
+ */
+declare const EXCLUDED_SHOPIFY_PLANS: readonly ["partner_test", "affiliate", "staff", "frozen", "fraudulent", "cancelled", "paused"];
+/**
+ * Countries to exclude from cross-app promotion
+ */
+declare const EXCLUDED_COUNTRIES: readonly ["IN", "VN"];
+/**
+ * Target storage types for display banner
+ */
+declare const TARGET_STORAGE_TYPES: Record<string, TargetStorageType>;
+/**
+ * Get Shopify store name from domain
+ */
+declare function getShopifyName(domain: string): string;
+/**
+ * Check if shop should be excluded from cross-app promotion
+ */
+declare function shouldExcludeShop(shop: {
+    shopifyPlan?: string;
+    country?: string;
+    email?: string;
+}): boolean;
+/**
+ * Get Cookie Bar app data for cross-app promotion
+ */
+declare function getCookieBarAppData(shop: {
+    shopifyDomain: string;
+    cookieBarInstalled?: boolean;
+}, options?: {
+    showPlanBtn?: boolean;
+    eventPrefix?: string;
+}): CrossAppData;
+/**
+ * Get Age Verification app data for cross-app promotion
+ */
+declare function getAgeVerificationAppData(shop: {
+    shopifyDomain: string;
+    ageVerificationInstalled?: boolean;
+    hideVerificationBanner?: boolean;
+}, options?: {
+    eventPrefix?: string;
+    utmSource?: string;
+}): CrossAppData;
+/**
+ * Get Accessibility app data for cross-app promotion
+ */
+declare function getAccessibilityAppData(shop: {
+    shopifyDomain: string;
+    accessibilityInstalled?: boolean;
+}, options?: {
+    eventPrefix?: string;
+}): CrossAppData;
+/**
+ * Create cross-app config helper
+ */
+declare function createCrossAppConfig(config: {
+    appPrefix: 'cb' | 'av' | 'ac' | 'ol';
+    apiClient: (url: string, options?: {
+        method?: string;
+        body?: Record<string, unknown>;
+    }) => Promise<unknown>;
+    storeDispatch?: (action: unknown) => void;
+    closeIcon?: React.ReactNode;
+    bannerEventEndpoint?: string;
+    shopUpdateEndpoint?: string;
+}): {
+    appPrefix: "cb" | "av" | "ac" | "ol";
+    apiClient: (url: string, options?: {
+        method?: string;
+        body?: Record<string, unknown>;
+    }) => Promise<unknown>;
+    storeDispatch: ((action: unknown) => void) | undefined;
+    closeIcon: react.ReactNode;
+    bannerEventEndpoint: string;
+    shopUpdateEndpoint: string;
+};
+
+export { APP_DOMAINS, APP_HANDLES, CrossAppBanner, CrossAppBannerWithI18n, CrossAppIcon, DownloadIcon, EXCLUDED_COUNTRIES, EXCLUDED_SHOPIFY_PLANS, SHOPIFY_APP_HANDLES, TARGET_STORAGE_TYPES, createCrossAppConfig, CrossAppBanner as default, getAccessibilityAppData, getAgeVerificationAppData, getCookieBarAppData, getShopifyName, shouldExcludeShop, useDisplayBanner };
+export type { ApiClient, AppHandle, AppPrefix, BannerEventAction, CrossAppBannerProps, CrossAppConfig, CrossAppData, CrossAppIconProps$1 as CrossAppIconProps, StoreDispatch, TargetStorageType, UseDisplayBannerConfig, UseDisplayBannerOptions, UseDisplayBannerReturn };