@schoolpalm/message-bridge 0.1.0 → 1.1.0

package/package.json

@@ -1,17 +1,34 @@
 {
   "name": "@schoolpalm/message-bridge",
-  "version": "0.1.0",
+  "version": "1.1.0",
   "description": "TypeScript SDK for message-based communication between SchoolPalm host and vendor modules.",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "AUTHORS"
+  ],
+
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
     "lint": "eslint 'src/**/*.{ts,tsx}' --fix",
     "prepublishOnly": "npm run build",
-  "test": "vitest",
-  "test:watch": "vitest --watch"
+    "test": "vitest",
+    "test:watch": "vitest --watch"
   },
+
   "keywords": [
     "schoolpalm",
     "vue",
@@ -19,11 +36,11 @@
     "module",
     "iframe",
     "postMessage",
-    "Unnovate Brains",
     "typescript"
   ],
   "author": "Hassan Mugabo",
   "license": "MIT",
+
   "devDependencies": {
     "@types/jsdom": "^27.0.0",
     "@typescript-eslint/eslint-plugin": "^6.5.1",

package/TODO.md

@@ -1,13 +0,0 @@
-# TODO: Project Documentation and Enhancement
-
-## Tasks
-- [x] Enhance README.md with detailed documentation
-- [x] Add doc comments to src/index.ts
-- [x] Add doc comments to src/bridgeBase.ts
-- [x] Add doc comments to src/hostBridge.ts
-- [x] Add doc comments to src/moduleBridge.ts
-- [x] Add doc comments to src/messageTypes.ts
-- [x] Add doc comments to src/payloadSchemas.ts
-- [x] Add doc comments to src/__tests__/bridge.test.ts
-- [x] Create AUTHORS file for npm package
-- [x] Verify LICENSE and package.json setup

package/dist/__tests__/bridge.test.d.ts

@@ -1,6 +0,0 @@
-/**
- * @fileoverview Test suite for the MessageBridge SDK.
- * @module @schoolpalm/message-bridge/__tests__/bridge.test
- */
-export {};
-//# sourceMappingURL=bridge.test.d.ts.map

package/dist/__tests__/bridge.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bridge.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/bridge.test.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/__tests__/bridge.test.js

@@ -1,84 +0,0 @@
-/**
- * @fileoverview Test suite for the MessageBridge SDK.
- * @module @schoolpalm/message-bridge/__tests__/bridge.test
- */
-import { describe, it, expect, beforeEach, vi } from 'vitest';
-import { HostBridge, ModuleBridge, MessageType } from '../index';
-/**
- * Test suite for the MessageBridge SDK.
- *
- * This suite tests the core functionality of both HostBridge and ModuleBridge
- * classes, including message sending, receiving, and event handling.
- */
-describe('MessageBridge SDK', () => {
-    let iframeMock;
-    beforeEach(() => {
-        // Simulate an iframe with contentWindow
-        iframeMock = {
-            contentWindow: {
-                postMessage: vi.fn()
-            }
-        };
-        // Mock parent window for ModuleBridge
-        vi.stubGlobal('parent', {
-            postMessage: vi.fn()
-        });
-    });
-    // -----------------------
-    // HostBridge Tests
-    // -----------------------
-    /**
-     * Test that HostBridge sends module-start messages correctly.
-     */
-    it('HostBridge sends module-start correctly', () => {
-        const hostBridge = new HostBridge(iframeMock);
-        hostBridge.sendModuleStart({ route: '/users', context: {}, timestamp: Date.now() });
-        expect(iframeMock.contentWindow.postMessage).toHaveBeenCalledTimes(1);
-        const callArg = iframeMock.contentWindow.postMessage.mock.calls[0][0];
-        expect(callArg.type).toBe(MessageType.MODULE_START);
-        expect(callArg.payload.route).toBe('/users');
-    });
-    /**
-     * Test that HostBridge can register listeners and receive messages.
-     */
-    it('HostBridge can register and receive messages', () => {
-        const hostBridge = new HostBridge(iframeMock);
-        const callback = vi.fn();
-        hostBridge.on(MessageType.UI_UPDATE, callback);
-        // Simulate incoming postMessage from iframe
-        const event = new MessageEvent('message', {
-            data: {
-                type: MessageType.UI_UPDATE,
-                payload: { title: 'Test', breadcrumb: ['Home'] }
-            }
-        });
-        window.dispatchEvent(event);
-        expect(callback).toHaveBeenCalledTimes(1);
-        expect(callback.mock.calls[0][0].title).toBe('Test');
-    });
-    // -----------------------
-    // ModuleBridge Tests
-    // -----------------------
-    /**
-     * Test that ModuleBridge sends handshake messages correctly.
-     */
-    it('ModuleBridge sends handshake correctly', () => {
-        const moduleBridge = new ModuleBridge();
-        moduleBridge.sendHandshake({ version: '0.1.0', timestamp: Date.now() });
-        expect(window.parent.postMessage).toHaveBeenCalledTimes(1);
-        const callArg = window.parent.postMessage.mock.calls[0][0];
-        expect(callArg.type).toBe(MessageType.HANDSHAKE_READY);
-        expect(callArg.payload.version).toBe('0.1.0');
-    });
-    /**
-     * Test that ModuleBridge sends UI update messages.
-     */
-    it('ModuleBridge sends UI update', () => {
-        const moduleBridge = new ModuleBridge();
-        moduleBridge.sendUIUpdate({ title: 'Users', breadcrumb: ['Home', 'Users'] });
-        const callArg = window.parent.postMessage.mock.calls[0][0];
-        expect(callArg.type).toBe(MessageType.UI_UPDATE);
-        expect(callArg.payload.breadcrumb.length).toBe(2);
-    });
-});
-//# sourceMappingURL=bridge.test.js.map

package/dist/__tests__/bridge.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bridge.test.js","sourceRoot":"","sources":["../../src/__tests__/bridge.test.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEjE;;;;;GAKG;AACH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,IAAI,UAAe,CAAC;IAEpB,UAAU,CAAC,GAAG,EAAE;QACd,wCAAwC;QACxC,UAAU,GAAG;YACX,aAAa,EAAE;gBACb,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE;aACrB;SACF,CAAC;QAEF,sCAAsC;QACtC,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YACtB,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,0BAA0B;IAC1B,mBAAmB;IACnB,0BAA0B;IAE1B;;OAEG;IACH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAC9C,UAAU,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAEpF,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH;;OAEG;IACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE/C,4CAA4C;QAC5C,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,SAAS,EAAE;YACxC,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,CAAC,SAAS;gBAC3B,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE;aACjD;SACF,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAE5B,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,0BAA0B;IAC1B,qBAAqB;IACrB,0BAA0B;IAE1B;;OAEG;IACH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,YAAY,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAExE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAI,MAAM,CAAC,MAAM,CAAC,WAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QACvD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH;;OAEG;IACH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACxC,YAAY,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAE7E,MAAM,OAAO,GAAI,MAAM,CAAC,MAAM,CAAC,WAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/__tests__/bridge.test.ts

@@ -1,100 +0,0 @@
-/**
- * @fileoverview Test suite for the MessageBridge SDK.
- * @module @schoolpalm/message-bridge/__tests__/bridge.test
- */
-
-import { describe, it, expect, beforeEach, vi } from 'vitest';
-import { HostBridge, ModuleBridge, MessageType } from '../index';
-
-/**
- * Test suite for the MessageBridge SDK.
- *
- * This suite tests the core functionality of both HostBridge and ModuleBridge
- * classes, including message sending, receiving, and event handling.
- */
-describe('MessageBridge SDK', () => {
-  let iframeMock: any;
-
-  beforeEach(() => {
-    // Simulate an iframe with contentWindow
-    iframeMock = {
-      contentWindow: {
-        postMessage: vi.fn()
-      }
-    };
-
-    // Mock parent window for ModuleBridge
-    vi.stubGlobal('parent', {
-      postMessage: vi.fn()
-    });
-  });
-
-  // -----------------------
-  // HostBridge Tests
-  // -----------------------
-
-  /**
-   * Test that HostBridge sends module-start messages correctly.
-   */
-  it('HostBridge sends module-start correctly', () => {
-    const hostBridge = new HostBridge(iframeMock);
-    hostBridge.sendModuleStart({ route: '/users', context: {}, timestamp: Date.now() });
-
-    expect(iframeMock.contentWindow.postMessage).toHaveBeenCalledTimes(1);
-    const callArg = iframeMock.contentWindow.postMessage.mock.calls[0][0];
-    expect(callArg.type).toBe(MessageType.MODULE_START);
-    expect(callArg.payload.route).toBe('/users');
-  });
-
-  /**
-   * Test that HostBridge can register listeners and receive messages.
-   */
-  it('HostBridge can register and receive messages', () => {
-    const hostBridge = new HostBridge(iframeMock);
-
-    const callback = vi.fn();
-    hostBridge.on(MessageType.UI_UPDATE, callback);
-
-    // Simulate incoming postMessage from iframe
-    const event = new MessageEvent('message', {
-      data: {
-        type: MessageType.UI_UPDATE,
-        payload: { title: 'Test', breadcrumb: ['Home'] }
-      }
-    });
-
-    window.dispatchEvent(event);
-
-    expect(callback).toHaveBeenCalledTimes(1);
-    expect(callback.mock.calls[0][0].title).toBe('Test');
-  });
-
-  // -----------------------
-  // ModuleBridge Tests
-  // -----------------------
-
-  /**
-   * Test that ModuleBridge sends handshake messages correctly.
-   */
-  it('ModuleBridge sends handshake correctly', () => {
-    const moduleBridge = new ModuleBridge();
-    moduleBridge.sendHandshake({ version: '0.1.0', timestamp: Date.now() });
-
-    expect(window.parent.postMessage).toHaveBeenCalledTimes(1);
-    const callArg = (window.parent.postMessage as any).mock.calls[0][0];
-    expect(callArg.type).toBe(MessageType.HANDSHAKE_READY);
-    expect(callArg.payload.version).toBe('0.1.0');
-  });
-
-  /**
-   * Test that ModuleBridge sends UI update messages.
-   */
-  it('ModuleBridge sends UI update', () => {
-    const moduleBridge = new ModuleBridge();
-    moduleBridge.sendUIUpdate({ title: 'Users', breadcrumb: ['Home', 'Users'] });
-
-    const callArg = (window.parent.postMessage as any).mock.calls[0][0];
-    expect(callArg.type).toBe(MessageType.UI_UPDATE);
-    expect(callArg.payload.breadcrumb.length).toBe(2);
-  });
-});

package/src/bridgeBase.ts

@@ -1,93 +0,0 @@
-/**
- * @fileoverview Base bridge class for message-based communication.
- * @module @schoolpalm/message-bridge/bridgeBase
- */
-
-// src/bridgeBase.ts
-import { MessageType } from './messageTypes';
-import { MessagePayload } from './payloadSchemas';
-
-/**
- * Type definition for message handler functions.
- * @template T - The type of message payload this handler accepts.
- */
-type MessageHandler<T extends MessagePayload> = (payload: T) => void;
-
-/**
- * Base class for Host and Module bridges.
- *
- * This abstract base class provides the core functionality for message-based
- * communication between windows using the postMessage API. It handles sending
- * messages, registering listeners, and managing event listeners.
- *
- * @example
- * ```typescript
- * class CustomBridge extends BridgeBase {
- *   constructor(targetWindow: Window) {
- *     super(targetWindow, 'https://example.com');
- *   }
- *
- *   // Add custom methods here
- * }
- * ```
- */
-export class BridgeBase {
-  /** The target window to send messages to. */
-  protected targetWindow: Window;
-  /** The origin to restrict messages to. */
-  protected targetOrigin: string;
-  /** Map of message type to array of handler functions. */
-  private listeners: Map<MessageType, MessageHandler<any>[]> = new Map();
-
-  /**
-   * Creates a new BridgeBase instance.
-   * @param targetWindow - The window to send messages to.
-   * @param targetOrigin - The origin to restrict messages to (default: '*').
-   */
-  constructor(targetWindow: Window, targetOrigin: string = '*') {
-    this.targetWindow = targetWindow;
-    this.targetOrigin = targetOrigin;
-    window.addEventListener('message', this._handleMessage.bind(this));
-  }
-
-  /**
-   * Sends a message to the target window.
-   * @template T - The type of the message payload.
-   * @param type - The message type to send.
-   * @param payload - The payload data to send.
-   */
-  send<T extends MessagePayload>(type: MessageType, payload: T) {
-    this.targetWindow.postMessage({ type, payload }, this.targetOrigin);
-  }
-
-  /**
-   * Registers a listener for a specific message type.
-   * @template T - The type of the message payload.
-   * @param type - The message type to listen for.
-   * @param callback - The function to call when a message of this type is received.
-   */
-  on<T extends MessagePayload>(type: MessageType, callback: MessageHandler<T>) {
-    if (!this.listeners.has(type)) this.listeners.set(type, []);
-    this.listeners.get(type)?.push(callback);
-  }
-
-  /**
-   * Internal message handler for incoming postMessage events.
-   * @private
-   * @param event - The message event received.
-   */
-  private _handleMessage(event: MessageEvent) {
-    const { type, payload } = event.data || {};
-    if (!type || !this.listeners.has(type)) return;
-    this.listeners.get(type)?.forEach(cb => cb(payload));
-  }
-
-  /**
-   * Cleans up event listeners and resources.
-   * Call this method when the bridge is no longer needed.
-   */
-  destroy() {
-    window.removeEventListener('message', this._handleMessage.bind(this));
-    this.listeners.clear();
-  }
-}

package/src/hostBridge.ts

@@ -1,63 +0,0 @@
-/**
- * @fileoverview Host-side bridge for communication with embedded modules.
- * @module @schoolpalm/message-bridge/hostBridge
- */
-
-// src/hostBridge.ts
-import { BridgeBase } from './bridgeBase';
-import { MessageType } from './messageTypes';
-import { ModuleStartPayload } from './payloadSchemas';
-
-/**
- * Host-side bridge for communication with embedded modules.
- *
- * This class extends BridgeBase to provide host-specific functionality for
- * communicating with modules embedded in iframes. It handles initialization
- * and termination of modules.
- *
- * @example
- * ```typescript
- * const iframe = document.getElementById('module-iframe') as HTMLIFrameElement;
- * const hostBridge = new HostBridge(iframe, 'https://module.example.com');
- *
- * // Start a module
- * hostBridge.sendModuleStart({
- *   route: '/dashboard',
- *   context: { userId: 123 },
- *   timestamp: Date.now()
- * });
- *
- * // Listen for UI updates from the module
- * hostBridge.on(MessageType.UI_UPDATE, (payload) => {
- *   console.log('UI Update:', payload);
- * });
- * ```
- */
-export class HostBridge extends BridgeBase {
-  /**
-   * Creates a new HostBridge instance.
-   * @param iframe - The iframe element containing the module.
-   * @param targetOrigin - The origin to restrict messages to (default: '*').
-   */
-  constructor(iframe: HTMLIFrameElement, targetOrigin: string = '*') {
-    super(iframe.contentWindow!, targetOrigin);
-  }
-
-  /**
-   * Sends a module-start message to the embedded module.
-   * This initializes the module with the provided route and context.
-   * @param payload - The module start payload containing route, context, and timestamp.
-   */
-  sendModuleStart(payload: ModuleStartPayload) {
-    this.send(MessageType.MODULE_START, payload);
-  }
-
-  /**
-   * Sends a module-exit message to the embedded module.
-   * This signals the module to clean up and terminate.
-   * @param reason - Optional reason for the module exit.
-   */
-  sendModuleExit(reason?: string) {
-    this.send(MessageType.MODULE_EXIT, { reason });
-  }
-}

package/src/index.ts

@@ -1,20 +0,0 @@
-/**
- * @packageDocumentation
- * @module @schoolpalm/message-bridge
- *
- * TypeScript SDK for message-based communication between SchoolPalm host and vendor modules.
- *
- * This module exports the main classes and types for establishing communication
- * between a host application and embedded modules using the postMessage API.
- *
- * @example
- * ```typescript
- * import { HostBridge, ModuleBridge, MessageType } from '@schoolpalm/message-bridge';
- * ```
- */
-
-export { BridgeBase } from './bridgeBase';
-export { HostBridge } from './hostBridge';
-export { ModuleBridge } from './moduleBridge';
-export { MessageType } from './messageTypes';
-export * from './payloadSchemas';

package/src/messageTypes.ts

@@ -1,40 +0,0 @@
-/**
- * @fileoverview Message type definitions for bridge communication.
- * @module @schoolpalm/message-bridge/messageTypes
- */
-
-// src/messageTypes.ts
-
-/**
- * Enumeration of all allowed message types for Host ↔ Module communication.
- *
- * These message types define the protocol for communication between the host
- * application and embedded modules. Each type indicates the direction and
- * purpose of the message.
- *
- * @example
- * ```typescript
- * import { MessageType } from '@schoolpalm/message-bridge';
- *
- * // Listen for UI updates from modules
- * bridge.on(MessageType.UI_UPDATE, (payload) => {
- *   console.log('UI updated:', payload);
- * });
- * ```
- */
-export enum MessageType {
-  /** Module → Host: Indicates the module is ready for communication. */
-  HANDSHAKE_READY = 'handshake:ready',
-  /** Host → Module: Signals the module to start with provided context. */
-  MODULE_START = 'module:start',
-  /** Module → Host: Updates the host UI (title, breadcrumb, theme). */
-  UI_UPDATE = 'ui:update',
-  /** Module → Host: Requests data from the host. */
-  DATA_REQUEST = 'data:request',
-  /** Host → Module: Responds to a data request. */
-  DATA_RESPONSE = 'data:response',
-  /** Module → Host: Reports an error to the host. */
-  ERROR = 'error',
-  /** Host → Module: Signals the module to exit and clean up. */
-  MODULE_EXIT = 'module:exit'
-}

package/src/moduleBridge.ts

@@ -1,79 +0,0 @@
-/**
- * @fileoverview Module-side bridge for communication with the host application.
- * @module @schoolpalm/message-bridge/moduleBridge
- */
-
-// src/moduleBridge.ts
-import { BridgeBase } from './bridgeBase';
-import { MessageType } from './messageTypes';
-import {
-  HandshakeReadyPayload,
-  UIUpdatePayload,
-  ErrorPayload
-} from './payloadSchemas';
-
-/**
- * Module-side bridge for communication with the host application.
- *
- * This class extends BridgeBase to provide module-specific functionality for
- * communicating with the parent host application. It handles handshake,
- * UI updates, and error reporting from the embedded module.
- *
- * @example
- * ```typescript
- * const moduleBridge = new ModuleBridge('https://host.example.com');
- *
- * // Send handshake when module is ready
- * moduleBridge.sendHandshake({
- *   version: '1.0.0',
- *   timestamp: Date.now()
- * });
- *
- * // Update UI in the host
- * moduleBridge.sendUIUpdate({
- *   title: 'Dashboard',
- *   breadcrumb: ['Home', 'Dashboard'],
- *   theme: 'dark'
- * });
- *
- * // Listen for module start from host
- * moduleBridge.on(MessageType.MODULE_START, (payload) => {
- *   console.log('Module started:', payload.route);
- * });
- * ```
- */
-export class ModuleBridge extends BridgeBase {
-  /**
-   * Creates a new ModuleBridge instance.
-   * @param targetOrigin - The origin to restrict messages to (default: '*').
-   */
-  constructor(targetOrigin: string = '*') {
-    super(window.parent, targetOrigin);
-  }
-
-  /**
-   * Notifies the host application that the module is ready.
-   * This should be called after the module has initialized.
-   * @param payload - The handshake payload containing version and timestamp.
-   */
-  sendHandshake(payload: HandshakeReadyPayload) {
-    this.send(MessageType.HANDSHAKE_READY, payload);
-  }
-
-  /**
-   * Notifies the host application of UI updates.
-   * This includes changes to title, breadcrumb, and theme.
-   * @param payload - The UI update payload.
-   */
-  sendUIUpdate(payload: UIUpdatePayload) {
-    this.send(MessageType.UI_UPDATE, payload);
-  }
-
-  /**
-   * Notifies the host application of an error.
-   * @param payload - The error payload containing error details.
-   */
-  sendError(payload: ErrorPayload) {
-    this.send(MessageType.ERROR, payload);
-  }
-}

package/src/payloadSchemas.ts

@@ -1,115 +0,0 @@
-/**
- * @fileoverview Payload schema definitions for message-based communication.
- * @module @schoolpalm/message-bridge/payloadSchemas
- */
-
-// src/payloadSchemas.ts
-import { MessageType } from './messageTypes';
-
-/**
- * Payload interfaces for each message type in the bridge communication protocol.
- *
- * These interfaces define the structure of data exchanged between host applications
- * and embedded modules. Each payload corresponds to a specific message type and
- * contains the necessary information for that communication scenario.
- */
-
-/**
- * Payload for handshake ready message.
- * Sent by modules to indicate they are ready for communication.
- */
-export interface HandshakeReadyPayload {
-  /** Version of the module or SDK */
-  version: string;
-  /** Timestamp when the handshake was initiated */
-  timestamp: number;
-}
-
-/**
- * Payload for module start message.
- * Sent by host to initialize a module with context.
- */
-export interface ModuleStartPayload {
-  /** Route or path to navigate to in the module */
-  route: string;
-  /** Context data passed to the module (user info, permissions, etc.) */
-  context: Record<string, any>;
-  /** Timestamp when the module start was requested */
-  timestamp: number;
-}
-
-/**
- * Payload for UI update message.
- * Sent by modules to update the host application's UI.
- */
-export interface UIUpdatePayload {
-  /** Title to display in the host UI */
-  title: string;
-  /** Breadcrumb navigation path */
-  breadcrumb: string[];
-  /** Optional theme to apply to the host UI */
-  theme?: string;
-}
-
-/**
- * Payload for data request message.
- * Sent by modules to request data from the host.
- */
-export interface DataRequestPayload {
-  /** Unique identifier for tracking the request */
-  requestId: string;
-  /** Action or endpoint to request data from */
-  action: string;
-  /** Optional payload data for the request */
-  payload?: Record<string, any>;
-}
-
-/**
- * Payload for data response message.
- * Sent by host in response to data requests.
- */
-export interface DataResponsePayload {
-  /** Unique identifier matching the original request */
-  requestId: string;
-  /** Status of the response */
-  status: 'success' | 'error';
-  /** Response data (present on success) */
-  payload?: any;
-}
-
-/**
- * Payload for error message.
- * Sent by modules to report errors to the host.
- */
-export interface ErrorPayload {
-  /** Error code for categorization */
-  code: string;
-  /** Human-readable error message */
-  message: string;
-  /** Optional additional error details */
-  details?: any;
-}
-
-/**
- * Payload for module exit message.
- * Sent by host to signal module termination.
- */
-export interface ModuleExitPayload {
-  /** Optional reason for the module exit */
-  reason?: string;
-}
-
-/**
- * Union type representing all possible message payloads.
- *
- * This type is used internally for type safety when handling messages
- * of any type in the bridge classes.
- */
-export type MessagePayload =
-  | HandshakeReadyPayload
-  | ModuleStartPayload
-  | UIUpdatePayload
-  | DataRequestPayload
-  | DataResponsePayload
-  | ErrorPayload
-  | ModuleExitPayload;

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "outDir": "dist",
-    "rootDir": "src",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    environment: 'jsdom', 
-    globals: true,   
-  },
-});