react-broadcast-sync 1.2.1 → 1.4.0

package/src/types/types.ts

@@ -70,6 +70,11 @@ export interface ClearSentMessagesOptions extends ClearOptions {
   sync?: boolean;
 }
 
+export interface GetLatestMessageOptions {
+  source?: string;
+  type?: string;
+}
+
 /**
  * Actions and state provided by the broadcast channel hook
  */
@@ -83,6 +88,12 @@ export interface BroadcastActions {
   /** Array of sent messages */
   sentMessages: BroadcastMessage[];
 
+  /** Whether a ping operation is currently in progress */
+  isPingInProgress: boolean;
+
+  /** Function to ping the channel and get active sources */
+  ping: (timeoutMs?: number) => Promise<string[]>;
+
   /** Function to send a message */
   postMessage: (messageType: string, messageContent: any, options?: SendMessageOptions) => void;
 
@@ -92,8 +103,16 @@ export interface BroadcastActions {
   /** Function to clear sent messages */
   clearSentMessages: (options?: ClearSentMessagesOptions) => void;
 
+  /** Function to get the latest message by source and type */
+  getLatestMessage: (options?: GetLatestMessageOptions) => BroadcastMessage | null;
+
+  /** Explicitly close the broadcast channel and remove listeners */
+  closeChannel: () => void;
+
   /** Current error state */
   error: string | null;
 }
 
 export type ClearMessage = 'CLEAR_SENT_MESSAGES';
+
+export type InternalMessage = ClearMessage | 'PING' | 'PONG';

package/src/utils/debug.ts

@@ -40,6 +40,11 @@ export const debug = {
     duplicate: (messageId: string) => log('warn', 'Duplicate message ignored:', messageId),
     allSentCleared: () => log('info', 'All sent messages cleared'),
     allReceivedCleared: () => log('info', 'All received messages cleared'),
+    ignored: (messageType: string) =>
+      log('info', 'Message ignored due to type filter:', messageType),
+  },
+  ping: {
+    inProgress: () => log('warn', 'Ping already in progress. Skipping call.'),
   },
   cleanup: {
     started: () => log('info', 'Cleanup started'),

package/src/utils/messageUtils.ts

@@ -1,4 +1,4 @@
-import { ClearMessage } from '../types/types';
+import { InternalMessage } from '../types/types';
 
 const INTERNAL_PREFIX = '__INTERNAL__';
 const SECRET = 'react-broadcast-sync';
@@ -46,7 +46,7 @@ export const createMessage = (
 };
 
 export const getInternalMessageType = (
-  baseType: ClearMessage,
+  baseType: InternalMessage,
   channelName: string,
   namespace = ''
 ): string => {