react-broadcast-sync 1.1.4 → 1.2.1

package/src/tests/useBroadcastChannel.test.tsx

@@ -1,5 +1,6 @@
 import { renderHook, act } from '@testing-library/react';
 import { useBroadcastChannel } from '../hooks/useBroadcastChannel';
+import { getInternalMessageType } from '../utils/messageUtils';
 
 let mockChannels: any[] = [];
 
@@ -118,7 +119,7 @@ describe('useBroadcastChannel', () => {
     expect(result.current.messages.length).toBe(1);
 
     act(() => {
-      result.current.clearMessage('123');
+      result.current.clearReceivedMessages({ ids: ['123'] });
     });
 
     expect(result.current.messages.length).toBe(0);
@@ -149,7 +150,7 @@ describe('useBroadcastChannel', () => {
     expect(result.current.messages.length).toBe(2);
 
     act(() => {
-      result.current.clearAllMessages();
+      result.current.clearReceivedMessages();
     });
 
     expect(result.current.messages.length).toBe(0);
@@ -167,7 +168,7 @@ describe('useBroadcastChannel', () => {
     expect(result.current.sentMessages.length).toBe(1);
 
     act(() => {
-      result.current.clearSentMessage(sentId);
+      result.current.clearSentMessages({ ids: [sentId] });
     });
 
     expect(result.current.sentMessages.length).toBe(0);
@@ -262,7 +263,7 @@ describe('useBroadcastChannel', () => {
     expect(result.current.messages.length).toBe(1);
   });
 
-  it('handles internal clear message from other source', async () => {
+  it('handles internal clear message (single id) from other source', async () => {
     const { result } = renderHook(() => useBroadcastChannel('test-channel'));
     await waitForChannel();
     const channel = mockChannels[0];
@@ -279,11 +280,12 @@ describe('useBroadcastChannel', () => {
 
     expect(result.current.messages.length).toBe(1);
 
+    const internalType = getInternalMessageType('CLEAR_SENT_MESSAGES', 'test-channel');
     act(() => {
       channel.simulateMessage({
-        id: 'to-clear',
-        type:
-          '__INTERNAL__:CLEAR_MESSAGE:' + btoa('react-broadcast-sync:CLEAR_MESSAGE:test-channel-'),
+        id: 'internal-1',
+        type: internalType,
+        message: { ids: ['to-clear'], types: [] },
         source: 'another-tab',
         timestamp: Date.now(),
       });
@@ -292,7 +294,7 @@ describe('useBroadcastChannel', () => {
     expect(result.current.messages.length).toBe(0);
   });
 
-  it('handles internal clear all messages from other source', async () => {
+  it('handles internal clear all messages (wildcard) from other source', async () => {
     const { result } = renderHook(() => useBroadcastChannel('test-channel'));
     await waitForChannel();
     const channel = mockChannels[0];
@@ -316,14 +318,12 @@ describe('useBroadcastChannel', () => {
 
     expect(result.current.messages.length).toBe(2);
 
+    const internalTypeAll = getInternalMessageType('CLEAR_SENT_MESSAGES', 'test-channel');
     act(() => {
       channel.simulateMessage({
-        id:
-          '__INTERNAL__:CLEAR_ALL_MESSAGES:' +
-          btoa('react-broadcast-sync:CLEAR_ALL_MESSAGES:test-channel-'),
-        type:
-          '__INTERNAL__:CLEAR_ALL_MESSAGES:' +
-          btoa('react-broadcast-sync:CLEAR_ALL_MESSAGES:test-channel-'),
+        id: 'internal-2',
+        type: internalTypeAll,
+        message: { ids: [], types: [] },
         source: 'another-tab',
         timestamp: Date.now(),
       });

package/src/types/types.ts

@@ -57,6 +57,18 @@ export interface BroadcastMessage {
   /** Optional expiration timestamp */
   expirationDate?: number;
 }
+export interface ClearOptions {
+  ids?: string[];
+  types?: string[];
+}
+
+export interface ClearReceivedMessagesOptions extends ClearOptions {
+  sources?: string[];
+}
+
+export interface ClearSentMessagesOptions extends ClearOptions {
+  sync?: boolean;
+}
 
 /**
  * Actions and state provided by the broadcast channel hook
@@ -74,15 +86,14 @@ export interface BroadcastActions {
   /** Function to send a message */
   postMessage: (messageType: string, messageContent: any, options?: SendMessageOptions) => void;
 
-  /** Function to clear a specific message */
-  clearMessage: (id: string) => void;
-
-  /** Function to clear all messages */
-  clearAllMessages: () => void;
+  /** Function to clear received messages */
+  clearReceivedMessages: (options?: ClearReceivedMessagesOptions) => void;
 
-  /** Function to clear a specific sent message */
-  clearSentMessage: (id: string) => void;
+  /** Function to clear sent messages */
+  clearSentMessages: (options?: ClearSentMessagesOptions) => void;
 
   /** Current error state */
   error: string | null;
 }
+
+export type ClearMessage = 'CLEAR_SENT_MESSAGES';

package/src/utils/debug.ts

@@ -29,8 +29,8 @@ const log = (level: LogLevel, message: string, data?: any) => {
 
 export const debug = {
   channel: {
-    created: (channelName: string) => log('info', 'Channel created:', channelName),
-    closed: (channelName: string) => log('info', 'Channel closed:', channelName),
+    created: (name: string) => log('info', 'Channel created:', name),
+    closed: (name: string) => log('info', 'Channel closed:', name),
   },
   message: {
     sent: (message: any) => log('info', 'Message sent:', message),
@@ -38,6 +38,8 @@ export const debug = {
     cleared: (messageId: string) => log('info', 'Message cleared:', messageId),
     expired: (messageId: string) => log('info', 'Message expired:', messageId),
     duplicate: (messageId: string) => log('warn', 'Duplicate message ignored:', messageId),
+    allSentCleared: () => log('info', 'All sent messages cleared'),
+    allReceivedCleared: () => log('info', 'All received messages cleared'),
   },
   cleanup: {
     started: () => log('info', 'Cleanup started'),

package/src/utils/messageUtils.ts

@@ -1,3 +1,5 @@
+import { ClearMessage } from '../types/types';
+
 const INTERNAL_PREFIX = '__INTERNAL__';
 const SECRET = 'react-broadcast-sync';
 
@@ -44,7 +46,7 @@ export const createMessage = (
 };
 
 export const getInternalMessageType = (
-  baseType: 'CLEAR_MESSAGE' | 'CLEAR_ALL_MESSAGES',
+  baseType: ClearMessage,
   channelName: string,
   namespace = ''
 ): string => {
@@ -58,16 +60,13 @@ export const isInternalType = (type: string): boolean => {
   return type.startsWith(`${INTERNAL_PREFIX}:`);
 };
 
-export const isValidInternalClearMessage = (
-  message: any
-): message is { id: string; type: string; source: string } => {
+export const isValidInternalClearMessage = (message: any): boolean => {
   return (
     message &&
     typeof message === 'object' &&
-    typeof message.id === 'string' &&
-    typeof message.source === 'string' &&
     typeof message.type === 'string' &&
-    isInternalType(message.type)
+    isInternalType(message.type) &&
+    typeof message.source === 'string'
   );
 };