@adobe-commerce/event-bus 1.0.0 → 1.0.1-beta1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe-commerce/event-bus",
-  "version": "1.0.0",
+  "version": "1.0.1-beta1",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "An event bus for storefront packages to communicate in the browser",
   "engines": {

package/src/index.ts

@@ -32,12 +32,28 @@ export class events {
 
   static _lastEvent: { [key: string]: { payload: any } } = {};
 
+  /**
+   * Returns a scoped event key.
+   * @param scope - The scope to get the event from.
+   * @returns - The scoped event key.
+   */
+  static _getScopedEvent(scope?: string) {
+    return <K extends keyof Events>(event: K): K => {
+        return (scope ? `${scope}/${event}` : event) as K;
+    };
+  }
+
   /**
    * Returns the last payload of the event.
    * @param event – The event to get the last payload from.
+   * @param options - Optional configuration for the event.
    * @returns – The last payload of the event.
    */
-  static lastPayload(event: string) {
+  static lastPayload<K extends keyof Events>(event: K, options?: { scope?: string }) {
+    if (options?.scope) {
+      event = this._getScopedEvent(options?.scope)(event);
+    }
+
     return this._lastEvent[event]?.payload;
   }
 
@@ -50,7 +66,7 @@ export class events {
   static on<K extends keyof Events>(
     event: K,
     handler: (payload: Events[K]) => void,
-    options?: { eager?: boolean }
+    options?: { eager?: boolean, scope?: string }
   ) {
     if (typeof BroadcastChannel === 'undefined') {
       return;
@@ -58,6 +74,11 @@ export class events {
 
     const subscriber = new BroadcastChannel('ElsieSDK/EventBus');
 
+    // if scope is provided, get the scoped event key
+    if (options?.scope) {
+      event = this._getScopedEvent(options?.scope)(event);
+    }
+
     if (options?.eager) {
       const lastEvent = this._lastEvent[event];
 
@@ -91,15 +112,21 @@ export class events {
    * Emits an event.
    * @param event - The event to emit.
    * @param payload - The event payload.
+   * @param options - Optional configuration for the event.
    */
 
-  static emit<K extends keyof Events>(event: K, payload: Events[K]) {
+  static emit<K extends keyof Events>(event: K, payload: Events[K], options?: { scope?: string }) {
     if (typeof BroadcastChannel === 'undefined') {
       return;
     }
 
     const publisher = new BroadcastChannel('ElsieSDK/EventBus');
 
+    // if scope is provided, get the scoped event key
+    if (options?.scope) {
+      event = this._getScopedEvent(options?.scope)(event);
+    }
+
     publisher.postMessage({ event, identifier: this._identifier, payload });
 
     this._lastEvent[event] = {