@selwise/widget 0.0.1

package/dist/npm/esm/datalayer/index.d.ts

@@ -0,0 +1,212 @@
+/**
+ * Data Layer Manager for Selwise Client Widget
+ * Provides GTM-style data layer functionality with window.selwiseLayer
+ */
+import type { SelwiseDataLayer, DataLayerConfig, CookieConsentConfig, TrackingModulesConfig, ConsentState } from './types';
+import type { SelwiseGlobalApi } from '../types/global-api';
+declare global {
+    interface Window {
+        selwiseLayer?: SelwiseDataLayer[];
+        Selwise?: SelwiseGlobalApi;
+    }
+}
+interface TrackerLike {
+    track(name: string, args?: {
+        entityType?: string;
+        entityId?: string;
+        metadata?: Record<string, any>;
+    }): void;
+    identify(userId: string, metadata?: Record<string, any>): void;
+    getSessionId(): string;
+    getVisitorId(): string;
+}
+interface DataLayerManagerOptions {
+    enabled?: boolean;
+    variableName?: string;
+    pageDetection?: 'auto' | 'manual' | 'patterns';
+    autoPageTracking?: boolean;
+    cartAbandonmentTimeout?: number;
+    pageTypePatterns?: Record<string, RegExp | string>;
+    debugMode?: boolean;
+    cookieConsent?: CookieConsentConfig;
+    trackingModules?: TrackingModulesConfig;
+    bufferSize?: number;
+    flushInterval?: number;
+    reverseEventMapping?: Record<string, string>;
+    externalDataLayerName?: string;
+}
+export declare class DataLayerManager {
+    private tracker;
+    private siteKey;
+    private apiUrl;
+    private config;
+    private isInitialized;
+    private isDestroyed;
+    private observer;
+    private debounceTimer;
+    private lastProcessedIndex;
+    private originalPush;
+    private lastPageUrl;
+    private lastPageTitle;
+    private dataLayerName;
+    private cookieConsent;
+    private consentState;
+    private consentTimeoutTimer;
+    private lastConsentValue;
+    private trackingModules;
+    private eventBuffer;
+    private flushTimer;
+    private pageTracker?;
+    private productTracker?;
+    private basketTracker?;
+    private checkoutTracker?;
+    private userTracker?;
+    private searchTracker?;
+    private cartAssociationTracker?;
+    private externalListener?;
+    constructor(tracker: TrackerLike, siteKey: string, apiUrl: string, options?: DataLayerManagerOptions);
+    private normalizeTrackingModules;
+    private normalizePageTypePatterns;
+    private isModuleEnabled;
+    private shouldAutoTrackPageViews;
+    private shouldObservePageChanges;
+    /**
+     * Initialize the data layer
+     */
+    init(): void;
+    /**
+     * Initialize the data layer array with configured variable name
+     */
+    private initializeDataLayer;
+    /**
+     * Get the data layer array
+     */
+    private getDataLayer;
+    /**
+     * Setup Array.prototype.push interception to catch data layer pushes
+     */
+    private setupPushInterception;
+    /**
+     * Setup MutationObserver for SPA navigation detection
+     */
+    private setupObserver;
+    /**
+     * Handle History API changes (SPA navigation)
+     */
+    private onHistoryChange;
+    /**
+     * Check if page has changed and track new page view
+     */
+    private checkPageChange;
+    /**
+     * Initialize all sub-tracker modules based on tracking modules config
+     */
+    private initializeSubTrackers;
+    /**
+     * Track the initial page view on load
+     */
+    private trackInitialPageView;
+    /**
+     * Check for abandoned cart on session start
+     */
+    private checkCartAbandonment;
+    private runAutomaticModuleTracking;
+    /**
+     * Initialize external data layer listener for listening to site's existing dataLayer
+     */
+    private initExternalListener;
+    /**
+     * Schedule processing of the data layer
+     */
+    private scheduleProcess;
+    /**
+     * Process all new events in the data layer
+     */
+    private processLayer;
+    private enqueueEvent;
+    private flushEventBuffer;
+    /**
+     * Check if cookie consent is given
+     * Enhanced with granular consent support (Phase 8)
+     */
+    private hasConsent;
+    /**
+     * Initialize cookie consent tracking with timeout and change detection (Phase 8)
+     */
+    private initConsentTracking;
+    /**
+     * Setup consent change detection using polling (Phase 8)
+     */
+    private setupConsentChangeDetection;
+    /**
+     * Update consent state from window variable (Phase 8)
+     */
+    private updateConsentFromWindow;
+    /**
+     * Load stored consent from localStorage (Phase 8)
+     */
+    private loadStoredConsent;
+    /**
+     * Load consent state from storage or window (Phase 8)
+     */
+    private loadConsentState;
+    /**
+     * Handle consent change event (Phase 8)
+     */
+    private onConsentChange;
+    /**
+     * Call user-defined consent change callback (Phase 8)
+     */
+    private callConsentChangeCallback;
+    /**
+     * Get current consent state (public API for Phase 8)
+     */
+    getConsentState(): ConsentState | null;
+    /**
+     * Grant consent programmatically (public API for Phase 8)
+     */
+    grantConsent(categories?: Partial<ConsentState>): void;
+    /**
+     * Revoke consent programmatically (public API for Phase 8)
+     */
+    revokeConsent(categories?: (keyof ConsentState)[]): void;
+    /**
+     * Process a single data layer event
+     */
+    private processEvent;
+    /**
+     * Track a custom event
+     */
+    private trackCustomEvent;
+    /**
+     * Expose public API methods to window.Selwise
+     */
+    private exposePublicApi;
+    /**
+     * Update configuration dynamically
+     */
+    updateConfig(options: Partial<DataLayerManagerOptions>): void;
+    /**
+     * Get current configuration
+     */
+    getConfig(): DataLayerConfig;
+    /**
+     * Get data layer state (last N events)
+     */
+    getLayerState(maxEvents?: number): SelwiseDataLayer[];
+    /**
+     * Manually push an event to the data layer
+     */
+    push(data: SelwiseDataLayer): void;
+    /**
+     * Log messages in debug mode or test mode
+     */
+    private log;
+    /**
+     * Cleanup and destroy the data layer manager
+     */
+    destroy(): void;
+}
+export type { SelwiseDataLayer, DataLayerConfig, CookieConsentConfig, TrackingModulesConfig, TrackingModuleConfig, PageDetectionMode, ConsentState, StoredConsent, } from './types';
+export { ConsentCategory } from './types';
+export * from './constants';