iframe-pubsub 1.0.8 → 1.0.9

package/dist/index.d.mts

@@ -50,25 +50,6 @@ declare class Client {
      * @param payload The payload of the message.
      */
     sendMessage(to: string, payload: any): void;
-    /**
-     * Check if a client with the given ID exists in the PubSub system.
-     *
-     * @param clientId The ID of the client to check.
-     * @param maxRetries Maximum number of retries. Default is 3.
-     * @param retryInterval Interval between retries in milliseconds. Default is 1000ms.
-     * @returns A Promise that resolves to true if the client exists, false otherwise.
-     */
-    checkClientExists(clientId: string, maxRetries?: number, retryInterval?: number): Promise<boolean>;
-    /**
-     * Check if a client with the given ID exists in the PubSub system with retry mechanism.
-     * Will retry up to 3 times with 1 second delay between retries.
-     *
-     * @param clientId The ID of the client to check.
-     * @param retryCount The current retry count.
-     * @returns A Promise that resolves to true if the client exists, false otherwise.
-     * @private
-     */
-    private checkClientExistsWithRetry;
     private handleMessage;
 }
 
@@ -76,7 +57,6 @@ declare enum AIChatNameEnum {
     AI_CHAT_CLIENT_ID = "aichat",
     AI_CHAT_INTERNAL_COMM_TYPE = "pubsub",
     AI_CHAT_ON_RESIZE = "onResize",
-    SYNC_PARENT_INFO = "syncParentInfo",
     SET_PARENT_NAME = "setParentName",
     SET_USER_ID = "setUserId",
     SET_CUSTOM_HEADERS = "setCustomHeaders",
@@ -193,23 +173,25 @@ declare class PubSub {
      * @param pageId The ID of the page or component to unregister from.
      */
     unregister(pageId: string): void;
-    sendMessage(message: IMessage): void;
+    sendMessage(message: IMessage): Promise<void>;
     /**
      * Try to send a message to a client with retry logic.
      * Will retry up to 3 times with 1 second delay between retries.
+     * If client exists, will check if it's still available with PING/PONG.
      *
      * @param message The message to send.
      * @param retryCount The current retry count.
      */
     private trySendMessageWithRetry;
-    private handleMessage;
     /**
-     * Check if a client with the given ID exists in the PubSub system.
+     * Check if a client is pingable (still available).
      *
      * @param clientId The ID of the client to check.
-     * @returns True if the client exists, false otherwise.
+     * @param source The window object of the client.
+     * @returns A Promise that resolves to true if the client is pingable, false otherwise.
      */
-    isClientExists(clientId: string): boolean;
+    private checkClientPingable;
+    private handleMessage;
 }
 
 export { AIChatClient, AIChatNameEnum, Client, type IMessage, type IRegistrationMessage, type MessageCallback, PubSub };

package/dist/index.d.ts

@@ -50,25 +50,6 @@ declare class Client {
      * @param payload The payload of the message.
      */
     sendMessage(to: string, payload: any): void;
-    /**
-     * Check if a client with the given ID exists in the PubSub system.
-     *
-     * @param clientId The ID of the client to check.
-     * @param maxRetries Maximum number of retries. Default is 3.
-     * @param retryInterval Interval between retries in milliseconds. Default is 1000ms.
-     * @returns A Promise that resolves to true if the client exists, false otherwise.
-     */
-    checkClientExists(clientId: string, maxRetries?: number, retryInterval?: number): Promise<boolean>;
-    /**
-     * Check if a client with the given ID exists in the PubSub system with retry mechanism.
-     * Will retry up to 3 times with 1 second delay between retries.
-     *
-     * @param clientId The ID of the client to check.
-     * @param retryCount The current retry count.
-     * @returns A Promise that resolves to true if the client exists, false otherwise.
-     * @private
-     */
-    private checkClientExistsWithRetry;
     private handleMessage;
 }
 
@@ -76,7 +57,6 @@ declare enum AIChatNameEnum {
     AI_CHAT_CLIENT_ID = "aichat",
     AI_CHAT_INTERNAL_COMM_TYPE = "pubsub",
     AI_CHAT_ON_RESIZE = "onResize",
-    SYNC_PARENT_INFO = "syncParentInfo",
     SET_PARENT_NAME = "setParentName",
     SET_USER_ID = "setUserId",
     SET_CUSTOM_HEADERS = "setCustomHeaders",
@@ -193,23 +173,25 @@ declare class PubSub {
      * @param pageId The ID of the page or component to unregister from.
      */
     unregister(pageId: string): void;
-    sendMessage(message: IMessage): void;
+    sendMessage(message: IMessage): Promise<void>;
     /**
      * Try to send a message to a client with retry logic.
      * Will retry up to 3 times with 1 second delay between retries.
+     * If client exists, will check if it's still available with PING/PONG.
      *
      * @param message The message to send.
      * @param retryCount The current retry count.
      */
     private trySendMessageWithRetry;
-    private handleMessage;
     /**
-     * Check if a client with the given ID exists in the PubSub system.
+     * Check if a client is pingable (still available).
      *
      * @param clientId The ID of the client to check.
-     * @returns True if the client exists, false otherwise.
+     * @param source The window object of the client.
+     * @returns A Promise that resolves to true if the client is pingable, false otherwise.
      */
-    isClientExists(clientId: string): boolean;
+    private checkClientPingable;
+    private handleMessage;
 }
 
 export { AIChatClient, AIChatNameEnum, Client, type IMessage, type IRegistrationMessage, type MessageCallback, PubSub };

package/dist/index.js

@@ -69,33 +69,83 @@ var _PubSub = class _PubSub {
     if (this.mainCallback) {
       this.mainCallback(message);
     }
-    this.trySendMessageWithRetry(message, 0);
+    return this.trySendMessageWithRetry(message, 0);
   }
   /**
    * Try to send a message to a client with retry logic.
    * Will retry up to 3 times with 1 second delay between retries.
-   * 
+   * If client exists, will check if it's still available with PING/PONG.
+   *
    * @param message The message to send.
    * @param retryCount The current retry count.
    */
-  trySendMessageWithRetry(message, retryCount) {
+  async trySendMessageWithRetry(message, retryCount) {
     const subscriber = this.subscribers.get(message.to);
     if (subscriber) {
       if (subscriber.source) {
-        subscriber.source.postMessage(message, "*");
+        try {
+          const isPingable = await this.checkClientPingable(
+            message.to,
+            subscriber.source
+          );
+          if (isPingable) {
+            subscriber.source.postMessage(message, "*");
+            return;
+          } else {
+            this.subscribers.delete(message.to);
+          }
+        } catch (error) {
+          console.warn(`Failed to ping client ${message.to}:`, error);
+          this.subscribers.delete(message.to);
+        }
       } else {
         subscriber.callback(message);
+        return;
       }
-      return;
     }
-    if (retryCount < 10) {
-      setTimeout(() => {
-        this.trySendMessageWithRetry(message, retryCount + 1);
-      }, 1e3);
+    if (retryCount < 3) {
+      await new Promise((resolve) => setTimeout(resolve, 1e3));
+      return this.trySendMessageWithRetry(message, retryCount + 1);
     } else {
-      console.warn(`Failed to send message to client ${message.to} after 10 retries`);
+      console.warn(
+        `Failed to send message to client ${message.to} after 3 retries`
+      );
     }
   }
+  /**
+   * Check if a client is pingable (still available).
+   *
+   * @param clientId The ID of the client to check.
+   * @param source The window object of the client.
+   * @returns A Promise that resolves to true if the client is pingable, false otherwise.
+   */
+  checkClientPingable(clientId, source) {
+    return new Promise((resolve) => {
+      const pingId = `ping-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
+      const messageHandler = (event) => {
+        const data = event.data;
+        if (data && data.from === clientId && data.to === "pubsub" && data.payload?.type === "PONG" && data.payload.pingId === pingId) {
+          window.removeEventListener("message", messageHandler);
+          clearTimeout(timeoutId);
+          resolve(true);
+        }
+      };
+      window.addEventListener("message", messageHandler);
+      const pingMessage = {
+        from: "pubsub",
+        to: clientId,
+        payload: {
+          type: "PING",
+          pingId
+        }
+      };
+      source.postMessage(pingMessage, "*");
+      const timeoutId = setTimeout(() => {
+        window.removeEventListener("message", messageHandler);
+        resolve(false);
+      }, 1e3);
+    });
+  }
   async handleMessage(event) {
     const data = event.data;
     const source = event.source;
@@ -114,14 +164,6 @@ var _PubSub = class _PubSub {
       this.subscribers.delete(unregistration.pageId);
       return;
     }
-    if (data?.type === "CLIENT_EXISTS_CHECK") {
-      source.postMessage({
-        type: "CLIENT_EXISTS_RESPONSE",
-        requestId: data.requestId,
-        exists: this.subscribers.has(data.clientId)
-      }, "*");
-      return;
-    }
     if (!data || !data.from || !data.to) return;
     const message = data;
     if (this.mainCallback) {
@@ -135,15 +177,6 @@ var _PubSub = class _PubSub {
       await subscriber.callback(message);
     }
   }
-  /**
-   * Check if a client with the given ID exists in the PubSub system.
-   * 
-   * @param clientId The ID of the client to check.
-   * @returns True if the client exists, false otherwise.
-   */
-  isClientExists(clientId) {
-    return this.subscribers.has(clientId);
-  }
 };
 __publicField(_PubSub, "instance");
 var PubSub = _PubSub;
@@ -212,71 +245,6 @@ var Client = class {
       this.pubsub.sendMessage(message);
     }
   }
-  /**
-   * Check if a client with the given ID exists in the PubSub system.
-   * 
-   * @param clientId The ID of the client to check.
-   * @param maxRetries Maximum number of retries. Default is 3.
-   * @param retryInterval Interval between retries in milliseconds. Default is 1000ms.
-   * @returns A Promise that resolves to true if the client exists, false otherwise.
-   */
-  checkClientExists(clientId, maxRetries = 3, retryInterval = 1e3) {
-    return this.checkClientExistsWithRetry(clientId, 0, maxRetries, retryInterval);
-  }
-  /**
-   * Check if a client with the given ID exists in the PubSub system with retry mechanism.
-   * Will retry up to 3 times with 1 second delay between retries.
-   * 
-   * @param clientId The ID of the client to check.
-   * @param retryCount The current retry count.
-   * @returns A Promise that resolves to true if the client exists, false otherwise.
-   * @private
-   */
-  checkClientExistsWithRetry(clientId, retryCount, maxRetries, retryInterval) {
-    return new Promise((resolve) => {
-      if (this.isIframe) {
-        const requestId = `check-client-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
-        const messageHandler = (event) => {
-          const data = event.data;
-          if (data && data.type === "CLIENT_EXISTS_RESPONSE" && data.requestId === requestId) {
-            window.removeEventListener("message", messageHandler);
-            clearTimeout(removeHandlerTimeout);
-            if (data.exists) {
-              resolve(true);
-            } else if (retryCount < maxRetries - 1) {
-              setTimeout(() => {
-                this.checkClientExistsWithRetry(clientId, retryCount + 1, maxRetries, retryInterval).then((exists) => resolve(exists));
-              }, retryInterval);
-            } else {
-              resolve(false);
-            }
-          }
-        };
-        window.addEventListener("message", messageHandler);
-        window.parent.postMessage({
-          type: "CLIENT_EXISTS_CHECK",
-          clientId,
-          requestId,
-          from: this.pageId
-        }, "*");
-        const removeHandlerTimeout = setTimeout(() => {
-          window.removeEventListener("message", messageHandler);
-          resolve(false);
-        }, retryInterval + 1e3);
-      } else {
-        const exists = this.pubsub.isClientExists(clientId);
-        if (exists) {
-          resolve(true);
-        } else if (retryCount < maxRetries - 1) {
-          setTimeout(() => {
-            this.checkClientExistsWithRetry(clientId, retryCount + 1, maxRetries, retryInterval).then((exists2) => resolve(exists2));
-          }, retryInterval);
-        } else {
-          resolve(false);
-        }
-      }
-    });
-  }
   async handleMessage(event) {
     let message;
     if (event.data) {
@@ -286,6 +254,22 @@ var Client = class {
       message = event;
     }
     if (!message || !message.from || !message.to || message.to !== this.pageId) return;
+    if (message.payload?.type === "PING") {
+      const pongMsg = {
+        from: this.pageId,
+        to: message.from,
+        payload: {
+          type: "PONG",
+          pingId: message.payload.pingId
+        }
+      };
+      if (this.isIframe) {
+        window.parent.postMessage(pongMsg, "*");
+      } else {
+        this.pubsub.sendMessage(pongMsg);
+      }
+      return;
+    }
     if (this.callback) {
       try {
         await this.callback(message);
@@ -301,7 +285,6 @@ var AIChatNameEnum = /* @__PURE__ */ ((AIChatNameEnum2) => {
   AIChatNameEnum2["AI_CHAT_CLIENT_ID"] = "aichat";
   AIChatNameEnum2["AI_CHAT_INTERNAL_COMM_TYPE"] = "pubsub";
   AIChatNameEnum2["AI_CHAT_ON_RESIZE"] = "onResize";
-  AIChatNameEnum2["SYNC_PARENT_INFO"] = "syncParentInfo";
   AIChatNameEnum2["SET_PARENT_NAME"] = "setParentName";
   AIChatNameEnum2["SET_USER_ID"] = "setUserId";
   AIChatNameEnum2["SET_CUSTOM_HEADERS"] = "setCustomHeaders";

package/dist/index.mjs

@@ -42,33 +42,83 @@ var _PubSub = class _PubSub {
     if (this.mainCallback) {
       this.mainCallback(message);
     }
-    this.trySendMessageWithRetry(message, 0);
+    return this.trySendMessageWithRetry(message, 0);
   }
   /**
    * Try to send a message to a client with retry logic.
    * Will retry up to 3 times with 1 second delay between retries.
-   * 
+   * If client exists, will check if it's still available with PING/PONG.
+   *
    * @param message The message to send.
    * @param retryCount The current retry count.
    */
-  trySendMessageWithRetry(message, retryCount) {
+  async trySendMessageWithRetry(message, retryCount) {
     const subscriber = this.subscribers.get(message.to);
     if (subscriber) {
       if (subscriber.source) {
-        subscriber.source.postMessage(message, "*");
+        try {
+          const isPingable = await this.checkClientPingable(
+            message.to,
+            subscriber.source
+          );
+          if (isPingable) {
+            subscriber.source.postMessage(message, "*");
+            return;
+          } else {
+            this.subscribers.delete(message.to);
+          }
+        } catch (error) {
+          console.warn(`Failed to ping client ${message.to}:`, error);
+          this.subscribers.delete(message.to);
+        }
       } else {
         subscriber.callback(message);
+        return;
       }
-      return;
     }
-    if (retryCount < 10) {
-      setTimeout(() => {
-        this.trySendMessageWithRetry(message, retryCount + 1);
-      }, 1e3);
+    if (retryCount < 3) {
+      await new Promise((resolve) => setTimeout(resolve, 1e3));
+      return this.trySendMessageWithRetry(message, retryCount + 1);
     } else {
-      console.warn(`Failed to send message to client ${message.to} after 10 retries`);
+      console.warn(
+        `Failed to send message to client ${message.to} after 3 retries`
+      );
     }
   }
+  /**
+   * Check if a client is pingable (still available).
+   *
+   * @param clientId The ID of the client to check.
+   * @param source The window object of the client.
+   * @returns A Promise that resolves to true if the client is pingable, false otherwise.
+   */
+  checkClientPingable(clientId, source) {
+    return new Promise((resolve) => {
+      const pingId = `ping-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
+      const messageHandler = (event) => {
+        const data = event.data;
+        if (data && data.from === clientId && data.to === "pubsub" && data.payload?.type === "PONG" && data.payload.pingId === pingId) {
+          window.removeEventListener("message", messageHandler);
+          clearTimeout(timeoutId);
+          resolve(true);
+        }
+      };
+      window.addEventListener("message", messageHandler);
+      const pingMessage = {
+        from: "pubsub",
+        to: clientId,
+        payload: {
+          type: "PING",
+          pingId
+        }
+      };
+      source.postMessage(pingMessage, "*");
+      const timeoutId = setTimeout(() => {
+        window.removeEventListener("message", messageHandler);
+        resolve(false);
+      }, 1e3);
+    });
+  }
   async handleMessage(event) {
     const data = event.data;
     const source = event.source;
@@ -87,14 +137,6 @@ var _PubSub = class _PubSub {
       this.subscribers.delete(unregistration.pageId);
       return;
     }
-    if (data?.type === "CLIENT_EXISTS_CHECK") {
-      source.postMessage({
-        type: "CLIENT_EXISTS_RESPONSE",
-        requestId: data.requestId,
-        exists: this.subscribers.has(data.clientId)
-      }, "*");
-      return;
-    }
     if (!data || !data.from || !data.to) return;
     const message = data;
     if (this.mainCallback) {
@@ -108,15 +150,6 @@ var _PubSub = class _PubSub {
       await subscriber.callback(message);
     }
   }
-  /**
-   * Check if a client with the given ID exists in the PubSub system.
-   * 
-   * @param clientId The ID of the client to check.
-   * @returns True if the client exists, false otherwise.
-   */
-  isClientExists(clientId) {
-    return this.subscribers.has(clientId);
-  }
 };
 __publicField(_PubSub, "instance");
 var PubSub = _PubSub;
@@ -185,71 +218,6 @@ var Client = class {
       this.pubsub.sendMessage(message);
     }
   }
-  /**
-   * Check if a client with the given ID exists in the PubSub system.
-   * 
-   * @param clientId The ID of the client to check.
-   * @param maxRetries Maximum number of retries. Default is 3.
-   * @param retryInterval Interval between retries in milliseconds. Default is 1000ms.
-   * @returns A Promise that resolves to true if the client exists, false otherwise.
-   */
-  checkClientExists(clientId, maxRetries = 3, retryInterval = 1e3) {
-    return this.checkClientExistsWithRetry(clientId, 0, maxRetries, retryInterval);
-  }
-  /**
-   * Check if a client with the given ID exists in the PubSub system with retry mechanism.
-   * Will retry up to 3 times with 1 second delay between retries.
-   * 
-   * @param clientId The ID of the client to check.
-   * @param retryCount The current retry count.
-   * @returns A Promise that resolves to true if the client exists, false otherwise.
-   * @private
-   */
-  checkClientExistsWithRetry(clientId, retryCount, maxRetries, retryInterval) {
-    return new Promise((resolve) => {
-      if (this.isIframe) {
-        const requestId = `check-client-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
-        const messageHandler = (event) => {
-          const data = event.data;
-          if (data && data.type === "CLIENT_EXISTS_RESPONSE" && data.requestId === requestId) {
-            window.removeEventListener("message", messageHandler);
-            clearTimeout(removeHandlerTimeout);
-            if (data.exists) {
-              resolve(true);
-            } else if (retryCount < maxRetries - 1) {
-              setTimeout(() => {
-                this.checkClientExistsWithRetry(clientId, retryCount + 1, maxRetries, retryInterval).then((exists) => resolve(exists));
-              }, retryInterval);
-            } else {
-              resolve(false);
-            }
-          }
-        };
-        window.addEventListener("message", messageHandler);
-        window.parent.postMessage({
-          type: "CLIENT_EXISTS_CHECK",
-          clientId,
-          requestId,
-          from: this.pageId
-        }, "*");
-        const removeHandlerTimeout = setTimeout(() => {
-          window.removeEventListener("message", messageHandler);
-          resolve(false);
-        }, retryInterval + 1e3);
-      } else {
-        const exists = this.pubsub.isClientExists(clientId);
-        if (exists) {
-          resolve(true);
-        } else if (retryCount < maxRetries - 1) {
-          setTimeout(() => {
-            this.checkClientExistsWithRetry(clientId, retryCount + 1, maxRetries, retryInterval).then((exists2) => resolve(exists2));
-          }, retryInterval);
-        } else {
-          resolve(false);
-        }
-      }
-    });
-  }
   async handleMessage(event) {
     let message;
     if (event.data) {
@@ -259,6 +227,22 @@ var Client = class {
       message = event;
     }
     if (!message || !message.from || !message.to || message.to !== this.pageId) return;
+    if (message.payload?.type === "PING") {
+      const pongMsg = {
+        from: this.pageId,
+        to: message.from,
+        payload: {
+          type: "PONG",
+          pingId: message.payload.pingId
+        }
+      };
+      if (this.isIframe) {
+        window.parent.postMessage(pongMsg, "*");
+      } else {
+        this.pubsub.sendMessage(pongMsg);
+      }
+      return;
+    }
     if (this.callback) {
       try {
         await this.callback(message);
@@ -274,7 +258,6 @@ var AIChatNameEnum = /* @__PURE__ */ ((AIChatNameEnum2) => {
   AIChatNameEnum2["AI_CHAT_CLIENT_ID"] = "aichat";
   AIChatNameEnum2["AI_CHAT_INTERNAL_COMM_TYPE"] = "pubsub";
   AIChatNameEnum2["AI_CHAT_ON_RESIZE"] = "onResize";
-  AIChatNameEnum2["SYNC_PARENT_INFO"] = "syncParentInfo";
   AIChatNameEnum2["SET_PARENT_NAME"] = "setParentName";
   AIChatNameEnum2["SET_USER_ID"] = "setUserId";
   AIChatNameEnum2["SET_CUSTOM_HEADERS"] = "setCustomHeaders";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iframe-pubsub",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "A PubSub library for iframe communication.",
   "author": "Lap Tran",
   "license": "ISC",