iframe-pubsub 1.0.10 → 1.0.12

package/dist/index.d.mts

@@ -37,6 +37,12 @@ declare class Client {
      * Unregister the client from the pubsub.
      */
     unregister(): void;
+    /**
+     * Clean up the aichat registration if the iframe is removed.
+     *
+     * Note: aichat itself does not know the iframe is removed then we have to clean up from parent
+     */
+    cleanAIChat(): boolean;
     /**
      * Listen for messages from the parent page with a callback.
      *
@@ -50,6 +56,25 @@ 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;
 }
 
@@ -172,26 +197,24 @@ declare class PubSub {
      *
      * @param pageId The ID of the page or component to unregister from.
      */
-    unregister(pageId: string): void;
-    sendMessage(message: IMessage): Promise<void>;
+    unregister(pageId: string): boolean;
+    sendMessage(message: IMessage): 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 is pingable (still available).
+     * Check if a client with the given ID exists in the PubSub system.
      *
      * @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.
+     * @returns True if the client exists, false otherwise.
      */
-    private checkClientPingable;
-    private handleMessage;
+    isClientExists(clientId: string): boolean;
 }
 
 export { AIChatClient, AIChatNameEnum, Client, type IMessage, type IRegistrationMessage, type MessageCallback, PubSub };

package/dist/index.d.ts

@@ -37,6 +37,12 @@ declare class Client {
      * Unregister the client from the pubsub.
      */
     unregister(): void;
+    /**
+     * Clean up the aichat registration if the iframe is removed.
+     *
+     * Note: aichat itself does not know the iframe is removed then we have to clean up from parent
+     */
+    cleanAIChat(): boolean;
     /**
      * Listen for messages from the parent page with a callback.
      *
@@ -50,6 +56,25 @@ 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;
 }
 
@@ -172,26 +197,24 @@ declare class PubSub {
      *
      * @param pageId The ID of the page or component to unregister from.
      */
-    unregister(pageId: string): void;
-    sendMessage(message: IMessage): Promise<void>;
+    unregister(pageId: string): boolean;
+    sendMessage(message: IMessage): 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 is pingable (still available).
+     * Check if a client with the given ID exists in the PubSub system.
      *
      * @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.
+     * @returns True if the client exists, false otherwise.
      */
-    private checkClientPingable;
-    private handleMessage;
+    isClientExists(clientId: string): boolean;
 }
 
 export { AIChatClient, AIChatNameEnum, Client, type IMessage, type IRegistrationMessage, type MessageCallback, PubSub };

package/dist/index.js

@@ -63,91 +63,39 @@ var _PubSub = class _PubSub {
    * @param pageId The ID of the page or component to unregister from.
    */
   unregister(pageId) {
-    this.subscribers.delete(pageId);
+    return this.subscribers.delete(pageId);
   }
   sendMessage(message) {
     if (this.mainCallback) {
       this.mainCallback(message);
     }
-    return this.trySendMessageWithRetry(message, 0);
+    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.
    */
-  async trySendMessageWithRetry(message, retryCount) {
+  trySendMessageWithRetry(message, retryCount) {
     const subscriber = this.subscribers.get(message.to);
     if (subscriber) {
       if (subscriber.source) {
-        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);
-        }
+        subscriber.source.postMessage(message, "*");
       } else {
         subscriber.callback(message);
-        return;
       }
+      return;
     }
-    if (retryCount < 3) {
-      await new Promise((resolve) => setTimeout(resolve, 1e3));
-      return this.trySendMessageWithRetry(message, retryCount + 1);
+    if (retryCount < 10) {
+      setTimeout(() => {
+        this.trySendMessageWithRetry(message, retryCount + 1);
+      }, 1e3);
     } else {
-      console.warn(
-        `Failed to send message to client ${message.to} after 3 retries`
-      );
+      console.warn(`Failed to send message to client ${message.to} after 10 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) {
-          console.info("Received pong from client:", clientId, data);
-          window.removeEventListener("message", messageHandler);
-          clearTimeout(timeoutId);
-          resolve(true);
-        }
-      };
-      window.addEventListener("message", messageHandler);
-      const pingMessage = {
-        from: "pubsub",
-        to: clientId,
-        payload: {
-          type: "PING",
-          pingId
-        }
-      };
-      console.info("Sending ping to client:", clientId, pingMessage);
-      source.postMessage(pingMessage, "*");
-      const timeoutId = setTimeout(() => {
-        window.removeEventListener("message", messageHandler);
-        resolve(false);
-      }, 1e3);
-    });
-  }
   async handleMessage(event) {
     const data = event.data;
     const source = event.source;
@@ -166,9 +114,35 @@ 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;
-    this.sendMessage(message);
+    if (this.mainCallback) {
+      await this.mainCallback(message);
+    }
+    const subscriber = this.subscribers.get(message.to);
+    if (!subscriber) return;
+    if (subscriber.source) {
+      subscriber.source.postMessage(message, "*");
+    } else {
+      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");
@@ -212,12 +186,25 @@ var Client = class {
       this.pubsub.unregister(this.pageId);
     }
   }
+  /**
+   * Clean up the aichat registration if the iframe is removed.
+   * 
+   * Note: aichat itself does not know the iframe is removed then we have to clean up from parent
+   */
+  cleanAIChat() {
+    if (this.isIframe) {
+      throw new Error("You are not allowed to clean up aichat from iframe.");
+    }
+    window.removeEventListener("message", this.handleMessage.bind(this));
+    return this.pubsub.unregister("aichat" /* AI_CHAT_CLIENT_ID */);
+  }
   /**
    * Listen for messages from the parent page with a callback.
    * 
    * @param callback The callback function to register.
    */
   onMessage(callback) {
+    console.info("Register new onMessage callback for", this.pageId, callback);
     this.callback = callback;
   }
   /**
@@ -238,6 +225,71 @@ 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) {
@@ -247,22 +299,6 @@ 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);

package/dist/index.mjs

@@ -36,91 +36,39 @@ var _PubSub = class _PubSub {
    * @param pageId The ID of the page or component to unregister from.
    */
   unregister(pageId) {
-    this.subscribers.delete(pageId);
+    return this.subscribers.delete(pageId);
   }
   sendMessage(message) {
     if (this.mainCallback) {
       this.mainCallback(message);
     }
-    return this.trySendMessageWithRetry(message, 0);
+    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.
    */
-  async trySendMessageWithRetry(message, retryCount) {
+  trySendMessageWithRetry(message, retryCount) {
     const subscriber = this.subscribers.get(message.to);
     if (subscriber) {
       if (subscriber.source) {
-        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);
-        }
+        subscriber.source.postMessage(message, "*");
       } else {
         subscriber.callback(message);
-        return;
       }
+      return;
     }
-    if (retryCount < 3) {
-      await new Promise((resolve) => setTimeout(resolve, 1e3));
-      return this.trySendMessageWithRetry(message, retryCount + 1);
+    if (retryCount < 10) {
+      setTimeout(() => {
+        this.trySendMessageWithRetry(message, retryCount + 1);
+      }, 1e3);
     } else {
-      console.warn(
-        `Failed to send message to client ${message.to} after 3 retries`
-      );
+      console.warn(`Failed to send message to client ${message.to} after 10 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) {
-          console.info("Received pong from client:", clientId, data);
-          window.removeEventListener("message", messageHandler);
-          clearTimeout(timeoutId);
-          resolve(true);
-        }
-      };
-      window.addEventListener("message", messageHandler);
-      const pingMessage = {
-        from: "pubsub",
-        to: clientId,
-        payload: {
-          type: "PING",
-          pingId
-        }
-      };
-      console.info("Sending ping to client:", clientId, pingMessage);
-      source.postMessage(pingMessage, "*");
-      const timeoutId = setTimeout(() => {
-        window.removeEventListener("message", messageHandler);
-        resolve(false);
-      }, 1e3);
-    });
-  }
   async handleMessage(event) {
     const data = event.data;
     const source = event.source;
@@ -139,9 +87,35 @@ 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;
-    this.sendMessage(message);
+    if (this.mainCallback) {
+      await this.mainCallback(message);
+    }
+    const subscriber = this.subscribers.get(message.to);
+    if (!subscriber) return;
+    if (subscriber.source) {
+      subscriber.source.postMessage(message, "*");
+    } else {
+      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");
@@ -185,12 +159,25 @@ var Client = class {
       this.pubsub.unregister(this.pageId);
     }
   }
+  /**
+   * Clean up the aichat registration if the iframe is removed.
+   * 
+   * Note: aichat itself does not know the iframe is removed then we have to clean up from parent
+   */
+  cleanAIChat() {
+    if (this.isIframe) {
+      throw new Error("You are not allowed to clean up aichat from iframe.");
+    }
+    window.removeEventListener("message", this.handleMessage.bind(this));
+    return this.pubsub.unregister("aichat" /* AI_CHAT_CLIENT_ID */);
+  }
   /**
    * Listen for messages from the parent page with a callback.
    * 
    * @param callback The callback function to register.
    */
   onMessage(callback) {
+    console.info("Register new onMessage callback for", this.pageId, callback);
     this.callback = callback;
   }
   /**
@@ -211,6 +198,71 @@ 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) {
@@ -220,22 +272,6 @@ 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);

package/package.json

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