feat: add docs/tests

Author: afeiship

README.md

@@ -15,9 +15,17 @@ yarn add @jswork/message-bridge
 ```js
 import messageBridge from '@jswork/message-bridge';
 
-messageBridge(1024);
-
-// [1000, 0, 20, 4]
+// Register a handler for incoming messages
+messageBridge.registerHandler('message:in', (data, responseCallback) => {
+  console.log('Received data:', data);
+  // Send response back
+  responseCallback({ status: 'success' });
+});
+
+// Send a message and handle the response
+messageBridge.callHandler('message:out', { type: 'request', payload: 'Hello!' }, (response) => {
+  console.log('Got response:', response);
+});
 ```
 
 ## license

__tests__/index.spec.ts

@@ -1,18 +1,40 @@
-import fn from '../src/index.js';
+import { Encoder } from '../src/index';
 
-describe('Normal test cases', () => {
-  test('number is equal 0/10/100/1000/10000', () => {
-    expect(fn(0)).toEqual([0]);
-    expect(fn(10)).toEqual([10, 0]);
-    expect(fn(30)).toEqual([30, 0]);
-    expect(fn(40)).toEqual([40, 0]);
-    expect(fn(50)).toEqual([50, 0]);
-    expect(fn(60)).toEqual([60, 0]);
-    expect(fn(70)).toEqual([70, 0]);
-    expect(fn(80)).toEqual([80, 0]);
-    expect(fn(90)).toEqual([90, 0]);
-    expect(fn(100)).toEqual([100, 0, 0]);
-    expect(fn(1000)).toEqual([1000, 0, 0, 0]);
-    expect(fn(10000)).toEqual([10000, 0, 0, 0, 0]);
+describe('Encoder', () => {
+  describe('encode', () => {
+    test('should encode string correctly', () => {
+      expect(Encoder.encode('hello')).toBe('aGVsbG8=');
+    });
+
+    test('should encode object correctly', () => {
+      const obj = { name: 'test', value: 123 };
+      expect(Encoder.encode(obj)).toBe('eyJuYW1lIjoidGVzdCIsInZhbHVlIjoxMjN9');
+    });
+
+    test('should encode array correctly', () => {
+      const arr = [1, 'test', true];
+      expect(Encoder.encode(arr)).toBe('WzEsInRlc3QiLHRydWVd');
+    });
+  });
+
+  describe('decode', () => {
+    test('should decode string correctly', () => {
+      expect(Encoder.decode('aGVsbG8=')).toBe('hello');
+    });
+
+    test('should decode JSON object correctly', () => {
+      const encoded = 'eyJuYW1lIjoidGVzdCIsInZhbHVlIjoxMjN9';
+      expect(Encoder.decode(encoded)).toEqual({ name: 'test', value: 123 });
+    });
+
+    test('should decode JSON array correctly', () => {
+      const encoded = 'WzEsInRlc3QiLHRydWVd';
+      expect(Encoder.decode(encoded)).toEqual([1, 'test', true]);
+    });
+
+    test('should return decoded string when JSON parse fails', () => {
+      const encoded = 'aGVsbG8=';
+      expect(Encoder.decode(encoded)).toBe('hello');
+    });
   });
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jswork/message-bridge",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Web/h5/mp bridge for web/mp.",
   "type": "module",
   "npmClient": "pnpm",

src/index.ts

@@ -12,9 +12,24 @@ export interface HandlerCleanup {
   destroy: () => void;
 }
 
+export class Encoder {
+  public static encode = (obj: any) => {
+    if (typeof obj === 'string') return Base64.encode(obj);
+    return Base64.encode(JSON.stringify(obj));
+  };
+
+  public static decode = (str: string) => {
+    const decoded = Base64.decode(str);
+    try {
+      return JSON.parse(decoded);
+    } catch (e) {
+      return decoded;
+    }
+  };
+}
+
 const callHandler = (inName: string, inPayload: any, inOptions: CallHandlerOptions = {}) => {
-  const _payload = typeof inPayload === 'string' ? inPayload : JSON.stringify(inPayload);
-  const payload = Base64.encode(_payload);
+  const payload = Encoder.encode(inPayload);
   const defaultContext = typeof window !== 'undefined' ? window : ({} as any);
   const options = { ...inOptions, context: defaultContext };
   options.context.postMessage({ name: inName, payload });
@@ -31,14 +46,7 @@ const registerHandler = (
     const { name, payload } = event.data;
     if (name === inName) {
       const decodedPayload = Base64.decode(payload);
-      let data: string | null = null;
-
-      try {
-        data = JSON.parse(decodedPayload);
-      } catch (e) {
-        data = decodedPayload;
-      }
-
+      const data = Encoder.decode(decodedPayload);
       inHandler(data, (response) => {
         const responseName = `${inName}:response`;
         callHandler(responseName, response, options);