@koredev/kore-web-sdk 11.18.0-rc.f92a18a → 11.19.0-rc.b432c67

package/dist/plugins/proactiveWebCampaign/proactiveWebCampaign.d.ts

@@ -24,6 +24,8 @@ declare class ProactiveWebCampaignPlugin {
     static readonly MAX_FLATTEN_DEPTH = 10;
     private static readonly ACTIVE_CAMPAIGN_SELECTOR;
     private static readonly CHAT_CONTAINER_SELECTOR;
+    private static readonly MAX_API_RETRIES;
+    private static readonly RETRY_DELAY_MS;
     isPendingSendAPIEvent: boolean;
     coolDownTime: number;
     cooldownState: {
@@ -31,9 +33,6 @@ declare class ProactiveWebCampaignPlugin {
         startTime: number;
         expiryTime: number;
     };
-    isVisitorAlreadyChatting: boolean;
-    private chatSessionInfo;
-    private static readonly CHAT_SESSION_STORAGE_KEY;
     constructor(config: any);
     /**
      * Generates a unique browser session ID for the campaign trigger session
@@ -132,7 +131,6 @@ declare class ProactiveWebCampaignPlugin {
      * @param campaigns - Array of campaign data
      */
     extractCustomColumns(campaigns: any[]): void;
-    sendPWCStartEvent(): void;
     installPWCTemplates(): void;
     /**
      * Creates targeted timers for timeSpent conditions instead of polling every second
@@ -237,7 +235,12 @@ declare class ProactiveWebCampaignPlugin {
      * @returns true if the recent journey matches the required sequence, false otherwise
      */
     isJourneyValid(pageVisitArray: any, websiteArray: any): boolean;
-    checkEngagementHours(engHours: any): boolean;
+    /**
+     * Checks if the current time is within the engagement hours specified in engStrategy
+     * @param engStrategy - Engagement strategy object with engagement hours settings
+     * @returns {boolean} - Returns true if current time is within engagement hours, false otherwise
+     */
+    checkEngagementHours(engStrategy: any): boolean;
     createTimeSpentObjs(): void;
     getLocationDetails(): void;
     /**
@@ -281,11 +284,48 @@ declare class ProactiveWebCampaignPlugin {
      * @returns Location name or null if not found
      */
     findLocationByType(response: any[], targetType: string): string | null;
-    sendApiEvent(payload: string, route: string, campInstanceId?: string): Promise<void>;
+    /**
+     * Sends API event with retry logic
+     * @param payload - Event payload
+     * @param route - API route
+     * @param retryCount - Number of retries remaining (default: MAX_API_RETRIES)
+     * @returns Promise with API response
+     */
+    sendApiEvent(payload: any, route: string, retryCount?: number): Promise<any>;
+    /**
+     * Determines if an HTTP status code should trigger a retry
+     * Retries: 429 (Rate Limit), 5xx (Server Errors)
+     * Does NOT retry: 4xx (Client Errors, except 429)
+     * @param statusCode - HTTP status code
+     * @returns Boolean indicating if retry should happen
+     */
+    private shouldRetryStatusCode;
+    /**
+     * Initializes PWC campaigns by calling the pwe_verify API
+     */
+    initializePWCCampaigns(): Promise<void>;
+    /**
+     * Restores PWC state from sessionStorage for multi-page apps
+     * Called when pwe_data exists but in-memory state is lost (page navigation)
+     * Reconstructs campInfo from stored data to avoid redundant API calls
+     * @returns Boolean indicating if restoration was successful
+     */
+    restorePWCStateFromStorage(): boolean;
+    /**
+     * Handles the pwe_verify API response
+     * Processes campaign configuration and initializes PWC system
+     * @param responseData - API response data
+     */
+    handlePweVerifyResponse(responseData: any): Promise<void>;
+    /**
+     * Handles the pwe_event API response and renders campaign templates
+     * @param responseData - API response data
+     */
+    handlePweEventResponse(responseData: any): void;
     /**
      * Constructs the pwe_data object based on the new campaign structure
      * Extracts custom column configurations and initializes custom data
-     * @param campaignData - Campaign data received from socket
+     * @param campaignData - Campaign data received from API
      * @returns Constructed pwe_data object
      */
     constructPweData(campaignData: any): any;
@@ -331,7 +371,7 @@ declare class ProactiveWebCampaignPlugin {
     setupHoverListenerForCondition(condition: any, campInstanceId: string, group: any, groupIndex: number, conditionIndex: number, type: string): void;
     /**
      * Constructs rules/exclusions structure with proper grouping and condition tracking
-     * Reads 'globalType' from socket message but stores as 'groupType' internally
+     * Reads 'globalType' from API response but stores as 'groupType' internally
      * @param rulesConfig - Rules or exclusions configuration
      * @returns Structured rules object
      */
@@ -342,6 +382,12 @@ declare class ProactiveWebCampaignPlugin {
      * @returns Object with conditions grouped by column
      */
     groupConditionsByColumn(conditions: any[]): any;
+    /**
+     * Reconstructs RAW rules format from PROCESSED format stored in pwe_data
+     * @param processedRules - Processed rules structure from pwe_data.expected
+     * @returns RAW rules structure matching original API format
+     */
+    reconstructRawRulesFromProcessed(processedRules: any): any;
     /**
      * Checks if a campaign has a specific condition type configured in RULES
      * @param campaign - Campaign object
@@ -580,11 +626,11 @@ declare class ProactiveWebCampaignPlugin {
      */
     updateSatisfactionFlags(campInstanceId: string): void;
     /**
-     * Triggers campaign event using existing API logic
+     * Triggers campaign event using API and handles response
      * @param campInstanceId - Campaign instance ID
      * @param campId - Campaign ID
      */
-    triggerCampaignEvent(campInstanceId: string, campId: string): void;
+    triggerCampaignEvent(campInstanceId: string, campId: string, campaignData: any): Promise<void>;
     /**
      * Checks if any campaign template is active
      * @returns Boolean indicating if any campaign template is active
@@ -621,22 +667,11 @@ declare class ProactiveWebCampaignPlugin {
      * Only called during page load/refresh - has error handling fallback
      */
     restoreCooldownState(): void;
-    /**
-     * Initialize chat session state from sessionStorage
-     */
-    initializeChatSessionState(): void;
     /**
      * Check if chat window is currently open
      * Note: When minimize class is present, chat window is actually OPEN
      * @returns true if chat window is open, false if closed/minimized
      */
     isChatWindowOpen(): boolean;
-    /**
-     * Update chat session state based on received events
-     * Handles Session_Start, Session_End, and Bot_Active events
-     * @param eventType - Type of event received
-     * @param data - Event data
-     */
-    updateChatSessionState(eventType: 'Session_Start' | 'Session_End' | 'Bot_Active', data: any): void;
 }
 export default ProactiveWebCampaignPlugin;