@weldsuite/helpdesk-widget-sdk 1.0.15 → 1.0.17

package/dist/index.d.ts

@@ -27,41 +27,6 @@ interface PositionConfig {
     left?: string;
     top?: string;
 }
-/**
- * Customization configuration
- */
-interface CustomizationConfig {
-    primaryColor?: string;
-    accentColor?: string;
-    backgroundColor?: string;
-    textColor?: string;
-    fontFamily?: string;
-    fontSize?: string;
-    borderRadius?: string;
-}
-/**
- * Feature flags
- */
-interface FeatureConfig {
-    attachments?: boolean;
-    reactions?: boolean;
-    typing?: boolean;
-    readReceipts?: boolean;
-    offlineMode?: boolean;
-    fileUpload?: boolean;
-    imageUpload?: boolean;
-    voiceMessages?: boolean;
-    videoMessages?: boolean;
-}
-/**
- * Mobile configuration
- */
-interface MobileConfig {
-    fullScreen?: boolean;
-    scrollLock?: boolean;
-    keyboardHandling?: 'auto' | 'manual';
-    safeAreaInsets?: boolean;
-}
 /**
  * Iframe configuration
  */
@@ -154,15 +119,13 @@ interface SecurityConfig {
  */
 interface WeldConfig {
     widgetId: string;
+    testMode?: boolean;
     api?: Partial<ApiConfig>;
     iframes?: Partial<IframeConfig>;
     position?: {
         launcher?: PositionConfig;
         widget?: PositionConfig;
     };
-    customization?: CustomizationConfig;
-    features?: FeatureConfig;
-    mobile?: MobileConfig;
     auth?: AuthConfig;
     locale?: LocaleConfig;
     logging?: LogConfig;
@@ -182,11 +145,9 @@ interface WeldConfig {
  */
 interface ResolvedConfig {
     widgetId: string;
+    testMode?: boolean;
     api: ApiConfig;
     iframes: IframeConfig;
-    customization: CustomizationConfig;
-    features: FeatureConfig;
-    mobile: MobileConfig;
     auth: AuthConfig;
     locale: LocaleConfig;
     logging: LogConfig;
@@ -499,11 +460,16 @@ declare class WeldSDK {
     private readyResolve;
     private boundHandleLauncherClick;
     private subscriptionIds;
+    private pageTrackingCleanup;
     constructor(config: WeldConfig);
     /**
      * Handle launcher click messages from iframe
      */
     private handleLauncherClickMessage;
+    /**
+     * Show fullscreen image lightbox on the parent page
+     */
+    private showImageLightbox;
     /**
      * Initialize the SDK and render widget
      */
@@ -528,6 +494,22 @@ declare class WeldSDK {
      * Check if SDK is ready
      */
     isReady(): boolean;
+    /**
+     * Update callbacks on an existing instance (used by singleton reuse)
+     */
+    updateCallbacks(config: Partial<WeldConfig>): void;
+    /**
+     * Persist open/closed state to sessionStorage
+     */
+    private persistOpenState;
+    /**
+     * Clear persisted state from sessionStorage
+     */
+    private clearPersistedState;
+    /**
+     * Check if widget was previously open (from sessionStorage)
+     */
+    private wasOpen;
     /**
      * Open the widget
      */
@@ -683,19 +665,39 @@ declare class WeldSDK {
      * Disable debug mode
      */
     disableDebug(): void;
+    /**
+     * Send a page change message to the widget iframe
+     */
+    private sendPageChange;
+    /**
+     * Start tracking page URL changes (SPA navigations + popstate)
+     */
+    private startPageTracking;
     /**
      * Ensure SDK is ready before operation
      */
     private ensureReady;
+    /**
+     * Detach from the current component lifecycle without destroying the widget.
+     * Use this as a React useEffect cleanup — the widget stays alive across navigations.
+     */
+    detach(): void;
     /**
      * Destroy SDK and cleanup
      */
     destroy(): void;
 }
 /**
- * Create and initialize WeldSDK instance
+ * Create and initialize WeldSDK instance.
+ * Uses singleton pattern — if an instance for the same widgetId already exists
+ * and is not destroyed, updates callbacks and returns the existing instance.
  */
 declare function createWeldSDK(config: WeldConfig): Promise<WeldSDK>;
+/**
+ * Explicitly destroy a WeldSDK instance by widgetId.
+ * Use this for logout or when you need to fully remove the widget.
+ */
+declare function destroyWeldSDK(widgetId: string): void;
 
 /**
  * Weld SDK - Iframe Manager
@@ -741,6 +743,7 @@ declare class IframeManager {
     private boundHandleResize;
     private boundHandleOrientationChange;
     private boundHandleVisualViewportResize;
+    private eventListenersBound;
     constructor(config: ResolvedConfig);
     /**
      * Initialize all containers and iframes
@@ -749,6 +752,7 @@ declare class IframeManager {
     init(messageBroker?: MessageBrokerInterface): Promise<void>;
     /**
      * Create root container structure
+     * Reuses existing container if it has the same widgetId (singleton behavior)
      */
     private createRootContainer;
     /**
@@ -768,7 +772,7 @@ declare class IframeManager {
      */
     private createWidgetIframe;
     /**
-     * Create backdrop iframe
+     * Create backdrop iframe — disabled, widget stays non-modal so users can interact with the page
      */
     private createBackdropIframe;
     /**
@@ -883,6 +887,7 @@ declare enum MessageType {
     AUTH_TOKEN_UPDATE = "weld:auth:token:update",
     EVENT_TRACK = "weld:event:track",
     ERROR_REPORT = "weld:error:report",
+    PAGE_CHANGE = "weld:page:change",
     API_SUCCESS = "weld:api:success",
     API_ERROR = "weld:api:error"
 }
@@ -964,16 +969,6 @@ interface ConfigUpdatePayload {
             right: string;
         };
     };
-    customization?: {
-        primaryColor?: string;
-        accentColor?: string;
-        fontFamily?: string;
-    };
-    features?: {
-        attachments?: boolean;
-        reactions?: boolean;
-        typing?: boolean;
-    };
 }
 /**
  * Theme update payload
@@ -1012,6 +1007,14 @@ interface EventPayload {
     properties?: Record<string, any>;
     timestamp: number;
 }
+/**
+ * Page change payload
+ */
+interface PageChangePayload {
+    url: string;
+    title: string;
+    timestamp: number;
+}
 /**
  * Type guards
  */
@@ -1038,10 +1041,11 @@ type ThemeUpdateMessage = PayloadMessage<ThemeUpdatePayload>;
 type AuthMessage = PayloadMessage<AuthPayload>;
 type ErrorMessage = PayloadMessage<ErrorPayload>;
 type EventMessage = PayloadMessage<EventPayload>;
+type PageChangeMessage = PayloadMessage<PageChangePayload>;
 /**
  * Union type for all messages
  */
-type WeldMessage = BaseMessage | ReadyMessage | StateUpdateMessage | WidgetStateMessage | LauncherStateMessage | BackdropStateMessage | MessageDataMessage | ConfigUpdateMessage | ThemeUpdateMessage | AuthMessage | ErrorMessage | EventMessage;
+type WeldMessage = BaseMessage | ReadyMessage | StateUpdateMessage | WidgetStateMessage | LauncherStateMessage | BackdropStateMessage | MessageDataMessage | ConfigUpdateMessage | ThemeUpdateMessage | AuthMessage | ErrorMessage | EventMessage | PageChangeMessage;
 
 /**
  * Weld SDK - Logger Utility
@@ -1535,5 +1539,5 @@ declare function isValidFileSize(file: File, maxSizeBytes: number): boolean;
  */
 declare function formatFileSize(bytes: number): string;
 
-export { ConnectionStatus, DEFAULT_CONFIG, WeldSDK as HelpdeskWidget, IframeManager, IframeType, LogLevel, Logger, MessageBroker, MessageOrigin, MessageStatus, MessageType, RateLimiter, SecurityManager, StateCoordinator, TokenValidator, WeldSDK, WidgetView, WidgetVisibility, createInitialState, createMessage, createWeldSDK, deepClone, deepMerge, WeldSDK as default, defaultLogger, formatFileSize, getStateValue, hasRequiredProperties, createWeldSDK as initHelpdeskWidget, isBaseMessage, isInRange, isPayloadMessage, isPlainObject, isValidApiKey, isValidArrayLength, isValidColor, isValidEmail, isValidFileSize, isValidFileType, isValidLength, isValidMessageText, isValidUrl, isValidWorkspaceId, resolveConfig, sanitizeHtml, sanitizeInput, setStateValue, validateConfig };
-export type { ApiConfig, Attachment, AuthConfig, AuthPayload, BackdropState, BackdropStatePayload, BaseMessage, ConfigUpdatePayload, ConversationState, CustomizationConfig, DeviceInfo, DeviceType, ErrorPayload, EventPayload, FeatureConfig, WeldConfig as HelpdeskWidgetConfig, IframeConfig, LauncherState, LauncherStatePayload, LocaleConfig, LogConfig, Message, MessageDataPayload, MobileConfig, MobileState, NetworkState, Participant, PayloadMessage, PerformanceConfig, PositionConfig, Reaction, ResolvedConfig, SecurityConfig, StateAction, StateListener, StateSubscription, StateUpdatePayload, ThemeUpdatePayload, UIState, UserState, WeldConfig, WeldMessage, WeldState, WidgetEvent, WidgetEventHandler, WidgetEventType, WidgetState, WidgetStatePayload };
+export { ConnectionStatus, DEFAULT_CONFIG, WeldSDK as HelpdeskWidget, IframeManager, IframeType, LogLevel, Logger, MessageBroker, MessageOrigin, MessageStatus, MessageType, RateLimiter, SecurityManager, StateCoordinator, TokenValidator, WeldSDK, WidgetView, WidgetVisibility, createInitialState, createMessage, createWeldSDK, deepClone, deepMerge, WeldSDK as default, defaultLogger, destroyWeldSDK as destroyHelpdeskWidget, destroyWeldSDK, formatFileSize, getStateValue, hasRequiredProperties, createWeldSDK as initHelpdeskWidget, isBaseMessage, isInRange, isPayloadMessage, isPlainObject, isValidApiKey, isValidArrayLength, isValidColor, isValidEmail, isValidFileSize, isValidFileType, isValidLength, isValidMessageText, isValidUrl, isValidWorkspaceId, resolveConfig, sanitizeHtml, sanitizeInput, setStateValue, validateConfig };
+export type { ApiConfig, Attachment, AuthConfig, AuthPayload, BackdropState, BackdropStatePayload, BaseMessage, ConfigUpdatePayload, ConversationState, DeviceInfo, DeviceType, ErrorPayload, EventPayload, WeldConfig as HelpdeskWidgetConfig, IframeConfig, LauncherState, LauncherStatePayload, LocaleConfig, LogConfig, Message, MessageDataPayload, MobileState, NetworkState, Participant, PayloadMessage, PerformanceConfig, PositionConfig, Reaction, ResolvedConfig, SecurityConfig, StateAction, StateListener, StateSubscription, StateUpdatePayload, ThemeUpdatePayload, UIState, UserState, WeldConfig, WeldMessage, WeldState, WidgetEvent, WidgetEventHandler, WidgetEventType, WidgetState, WidgetStatePayload };