react-broadcast-sync 1.0.0 → 1.1.0

package/src/tests/useBroadcastChannel.test.tsx

@@ -28,7 +28,7 @@ class MockBroadcastChannel {
 }
 
 const waitForChannel = async () => {
-  return new Promise<void>((resolve) => {
+  return new Promise<void>(resolve => {
     const checkChannel = () => {
       if (mockChannels.length > 0) {
         resolve();
@@ -73,7 +73,7 @@ describe('useBroadcastChannel', () => {
       type: 'greeting',
       message: { text: 'hi' },
       source: 'another-tab',
-      timestamp: Date.now()
+      timestamp: Date.now(),
     };
 
     act(() => {
@@ -108,7 +108,7 @@ describe('useBroadcastChannel', () => {
       type: 'greeting',
       message: 'hi',
       source: 'external',
-      timestamp: Date.now()
+      timestamp: Date.now(),
     };
 
     act(() => {
@@ -135,14 +135,14 @@ describe('useBroadcastChannel', () => {
         type: 'a',
         message: 'a',
         source: 'x',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
       channel.simulateMessage({
         id: '2',
         type: 'b',
         message: 'b',
         source: 'x',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -158,7 +158,7 @@ describe('useBroadcastChannel', () => {
   it('clears sent message', async () => {
     const { result } = renderHook(() => useBroadcastChannel('test-channel'));
     await waitForChannel();
-    
+
     act(() => {
       result.current.postMessage('test-type', { key: 'value' });
     });
@@ -177,7 +177,7 @@ describe('useBroadcastChannel', () => {
     jest.useFakeTimers();
 
     const original = global.BroadcastChannel;
-    // @ts-ignore
+    // @ts-expect-error - Testing invalid input
     delete global.BroadcastChannel;
 
     const { result } = renderHook(() => useBroadcastChannel('test-channel'));
@@ -200,7 +200,9 @@ describe('useBroadcastChannel', () => {
 
     const { result } = renderHook(() => useBroadcastChannel('unsupported-channel'));
 
-    expect(result.current.error).toBe('BroadcastChannel is not supported in this browser. Please check browser compatibility.');
+    expect(result.current.error).toBe(
+      'BroadcastChannel is not supported in this browser. Please check browser compatibility.'
+    );
     global.BroadcastChannel = original;
   });
 
@@ -227,7 +229,7 @@ describe('useBroadcastChannel', () => {
       message: 'expired',
       source: 'another-tab',
       timestamp: Date.now() - 1000000,
-      expirationDate: Date.now() - 1000000
+      expirationDate: Date.now() - 1000000,
     };
 
     act(() => {
@@ -238,7 +240,9 @@ describe('useBroadcastChannel', () => {
   });
 
   it('handles duplicate messages within TTL', async () => {
-    const { result } = renderHook(() => useBroadcastChannel('test-channel', { deduplicationTTL: 5000 }));
+    const { result } = renderHook(() =>
+      useBroadcastChannel('test-channel', { deduplicationTTL: 5000 })
+    );
     await waitForChannel();
     const channel = mockChannels[0];
 
@@ -247,7 +251,7 @@ describe('useBroadcastChannel', () => {
       type: 'test',
       message: 'duplicate',
       source: 'another-tab',
-      timestamp: Date.now()
+      timestamp: Date.now(),
     };
 
     act(() => {
@@ -269,7 +273,7 @@ describe('useBroadcastChannel', () => {
         type: 'test',
         message: 'will be cleared',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -278,9 +282,10 @@ describe('useBroadcastChannel', () => {
     act(() => {
       channel.simulateMessage({
         id: 'to-clear',
-        type: '__INTERNAL__:CLEAR_MESSAGE:' + btoa('react-broadcast-sync:CLEAR_MESSAGE:test-channel-'),
+        type:
+          '__INTERNAL__:CLEAR_MESSAGE:' + btoa('react-broadcast-sync:CLEAR_MESSAGE:test-channel-'),
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -298,14 +303,14 @@ describe('useBroadcastChannel', () => {
         type: 'test1',
         message: 'first',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
       channel.simulateMessage({
         id: 'msg2',
         type: 'test2',
         message: 'second',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -313,10 +318,14 @@ describe('useBroadcastChannel', () => {
 
     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__: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-'),
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -325,7 +334,9 @@ describe('useBroadcastChannel', () => {
 
   it('performs cleanup of expired messages', async () => {
     jest.useFakeTimers();
-    const { result } = renderHook(() => useBroadcastChannel('test-channel', { cleaningInterval: 1000 }));
+    const { result } = renderHook(() =>
+      useBroadcastChannel('test-channel', { cleaningInterval: 1000 })
+    );
     await waitForChannel();
     const channel = mockChannels[0];
 
@@ -336,7 +347,7 @@ describe('useBroadcastChannel', () => {
         message: 'expired',
         source: 'another-tab',
         timestamp: Date.now() - 1000000,
-        expirationDate: Date.now() - 1000000
+        expirationDate: Date.now() - 1000000,
       });
     });
 
@@ -349,7 +360,7 @@ describe('useBroadcastChannel', () => {
   });
 
   it('handles registered types filtering', async () => {
-    const { result } = renderHook(() => 
+    const { result } = renderHook(() =>
       useBroadcastChannel('test-channel', { registeredTypes: ['allowed-type'] })
     );
     await waitForChannel();
@@ -361,7 +372,7 @@ describe('useBroadcastChannel', () => {
         type: 'unregistered-type',
         message: 'test',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -373,7 +384,7 @@ describe('useBroadcastChannel', () => {
         type: 'allowed-type',
         message: 'test',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -381,7 +392,7 @@ describe('useBroadcastChannel', () => {
   });
 
   it('handles keepLatestMessage option', async () => {
-    const { result } = renderHook(() => 
+    const { result } = renderHook(() =>
       useBroadcastChannel('test-channel', { keepLatestMessage: true })
     );
     await waitForChannel();
@@ -393,14 +404,14 @@ describe('useBroadcastChannel', () => {
         type: 'test',
         message: 'first',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
       channel.simulateMessage({
         id: 'msg2',
         type: 'test',
         message: 'second',
         source: 'another-tab',
-        timestamp: Date.now()
+        timestamp: Date.now(),
       });
     });
 
@@ -410,10 +421,10 @@ describe('useBroadcastChannel', () => {
 
   it('handles cleanup debounce', async () => {
     jest.useFakeTimers();
-    const { result } = renderHook(() => 
-      useBroadcastChannel('test-channel', { 
+    const { result } = renderHook(() =>
+      useBroadcastChannel('test-channel', {
         cleaningInterval: 1000,
-        cleanupDebounceMs: 500
+        cleanupDebounceMs: 500,
       })
     );
     await waitForChannel();
@@ -426,7 +437,7 @@ describe('useBroadcastChannel', () => {
         message: 'expired',
         source: 'another-tab',
         timestamp: Date.now() - 1000000,
-        expirationDate: Date.now() - 1000000
+        expirationDate: Date.now() - 1000000,
       });
     });
 
@@ -463,7 +474,9 @@ describe('useBroadcastChannel', () => {
 
     const badMessage: any = {};
     Object.defineProperty(badMessage, 'id', {
-      get() { throw new Error('fail'); }
+      get() {
+        throw new Error('fail');
+      },
     });
     badMessage.type = 'test';
     badMessage.source = 'z';
@@ -484,7 +497,9 @@ describe('useBroadcastChannel', () => {
 
     const { result } = renderHook(() => useBroadcastChannel('test-channel'));
 
-    expect(result.current.error).toBe('BroadcastChannel is not supported in this browser. Please check browser compatibility.');
+    expect(result.current.error).toBe(
+      'BroadcastChannel is not supported in this browser. Please check browser compatibility.'
+    );
 
     global.BroadcastChannel = originalBroadcastChannel;
   });

package/src/types/types.ts

@@ -4,16 +4,16 @@
 export interface BroadcastOptions {
   /** Custom source name for this instance */
   sourceName?: string;
-  
+
   /** Interval in milliseconds for cleaning expired messages (default: 1000) */
   cleaningInterval?: number;
-  
+
   /** If true, only the latest message is kept */
   keepLatestMessage?: boolean;
-  
+
   /** Array of allowed message types */
   registeredTypes?: string[];
-  
+
   /** Channel namespace for isolation */
   namespace?: string;
 
@@ -30,7 +30,7 @@ export interface BroadcastOptions {
 export interface SendMessageOptions {
   /** Message expiration duration in milliseconds */
   expirationDuration?: number;
-  
+
   /** Specific expiration timestamp */
   expirationDate?: number;
 }
@@ -41,19 +41,19 @@ export interface SendMessageOptions {
 export interface BroadcastMessage {
   /** Unique message identifier */
   id: string;
-  
+
   /** Message type for categorization */
   type: string;
-  
+
   /** Message content */
   message: any;
-  
+
   /** Creation timestamp */
   timestamp: number;
-  
+
   /** Source identifier */
   source: string;
-  
+
   /** Optional expiration timestamp */
   expirationDate?: number;
 }
@@ -64,29 +64,25 @@ export interface BroadcastMessage {
 export interface BroadcastActions {
   /** The resolved channel name including namespace */
   channelName: string;
-  
+
   /** Array of received messages */
   messages: BroadcastMessage[];
-  
+
   /** Array of sent messages */
   sentMessages: BroadcastMessage[];
-  
+
   /** Function to send a message */
-  postMessage: (
-    messageType: string,
-    messageContent: any,
-    options?: SendMessageOptions
-  ) => void;
-  
+  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 a specific sent message */
   clearSentMessage: (id: string) => void;
-  
+
   /** Current error state */
   error: string | null;
-}
+}

package/src/utils/debug.ts

@@ -44,4 +44,4 @@ export const debug = {
     completed: (removedCount: number) => log('info', 'Cleanup completed:', { removedCount }),
   },
   error: (error: string) => log('error', 'Error:', error),
-}; 
+};

package/src/utils/messageUtils.ts

@@ -37,28 +37,30 @@ export const createMessage = (
     message: content,
     timestamp,
     source,
-    expirationDate: options.expirationDate ?? 
+    expirationDate:
+      options.expirationDate ??
       (options.expirationDuration ? timestamp + options.expirationDuration : undefined),
   };
 };
 
-
 export const getInternalMessageType = (
-    baseType: 'CLEAR_MESSAGE' | 'CLEAR_ALL_MESSAGES',
-    channelName: string,
-    namespace = ''
-  ): string => {
-    const fullChannel = `${channelName}-${namespace}`;
-    const input = `${SECRET}:${baseType}:${fullChannel}`;
-    const hash = btoa(input); // optional: use sha256 if added
-    return `${INTERNAL_PREFIX}:${baseType}:${hash}`;
-  };
+  baseType: 'CLEAR_MESSAGE' | 'CLEAR_ALL_MESSAGES',
+  channelName: string,
+  namespace = ''
+): string => {
+  const fullChannel = `${channelName}-${namespace}`;
+  const input = `${SECRET}:${baseType}:${fullChannel}`;
+  const hash = btoa(input); // optional: use sha256 if added
+  return `${INTERNAL_PREFIX}:${baseType}:${hash}`;
+};
 
 export const isInternalType = (type: string): boolean => {
-    return type.startsWith(`${INTERNAL_PREFIX}:`);
+  return type.startsWith(`${INTERNAL_PREFIX}:`);
 };
 
-export const isValidInternalClearMessage = (message: any): message is { id: string, type: string, source: string } => {
+export const isValidInternalClearMessage = (
+  message: any
+): message is { id: string; type: string; source: string } => {
   return (
     message &&
     typeof message === 'object' &&
@@ -67,7 +69,7 @@ export const isValidInternalClearMessage = (message: any): message is { id: stri
     typeof message.type === 'string' &&
     isInternalType(message.type)
   );
-}
+};
 
 export const debounce = <T extends (...args: any[]) => any>(
   fn: T,
@@ -78,23 +80,18 @@ export const debounce = <T extends (...args: any[]) => any>(
 } => {
   let timeoutId: ReturnType<typeof setTimeout> | null = null;
   let lastArgs: Parameters<T> | null = null;
-  let lastThis: any = null;
   let result: ReturnType<T> | undefined;
 
-  const debounced = function(this: any, ...args: Parameters<T>) {
+  const debounced = (...args: Parameters<T>) => {
     lastArgs = args;
-    lastThis = this;
-
     if (timeoutId !== null) {
       clearTimeout(timeoutId);
     }
-
     timeoutId = setTimeout(() => {
       timeoutId = null;
       if (lastArgs !== null) {
-        result = fn.apply(lastThis, lastArgs);
+        result = fn(...lastArgs);
         lastArgs = null;
-        lastThis = null;
       }
     }, wait);
   };
@@ -104,7 +101,6 @@ export const debounce = <T extends (...args: any[]) => any>(
       clearTimeout(timeoutId);
       timeoutId = null;
       lastArgs = null;
-      lastThis = null;
     }
   };
 
@@ -113,9 +109,8 @@ export const debounce = <T extends (...args: any[]) => any>(
       clearTimeout(timeoutId);
       timeoutId = null;
       if (lastArgs !== null) {
-        result = fn.apply(lastThis, lastArgs);
+        result = fn(...lastArgs);
         lastArgs = null;
-        lastThis = null;
       }
     }
     return result;

package/dist/useBroadcastChannel.d.ts

@@ -1,3 +0,0 @@
-import { BroadcastActions, BroadcastOptions } from './types/types';
-export declare const useBroadcastChannel: (channelName: string, options?: BroadcastOptions) => BroadcastActions;
-export default useBroadcastChannel;