Update event payloads (#14)

Co-authored-by: Ian White <iwhite2@wayfair.com>
wayfair-incubator · Jan 4, 2023 · 5623f1e · 5623f1e
1 parent 3de404c
commit 5623f1e
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,10 @@ and this project adheres to
 
 ### TBA
 
+## [v5.0.0] - 2021-01-04
+
+- Updated event types and payloads in Vendor Communicator
+
 ## [v4.1.0] - 2022-12-23
 
 - Added Continue to Cart Event to the Vendor Communicator

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "postmessage-communicator",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "[![Release](https://img.shields.io/github/v/release/wayfair-incubator/oss-template?display_name=tag)](CHANGELOG.md) [![Lint](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/wayfair-incubator/oss-template/actions/workflows/lint.yml) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md) [![Maintainer](https://img.shields.io/badge/Maintainer-Wayfair-7F187F)](https://wayfair.github.io)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/src/classes/ClientCommunicator.ts b/src/classes/ClientCommunicator.ts
@@ -25,6 +25,6 @@ export class ClientCommunicator extends Communicator {
     this.post({type: ClientEvent.RefreshWithToken, payload: token});
   }
   addToCartStatus(payload: AddToCartStatusPayload): void {
-    this.post({type: ClientEvent.AddToCartStatus, payload})
+    this.post({type: ClientEvent.AddToCartStatus, payload});
   }
 }
diff --git a/src/classes/VendorCommunicator.ts b/src/classes/VendorCommunicator.ts
@@ -1,41 +1,75 @@
 import {Communicator} from './Communicator';
 
 export enum VendorEvent {
-  AddToCart = 'AddToCart',
   AppInitialized = 'AppInitialized',
-  ContactDesigner = 'ContactDesigner',
-  DirtyStateChanged = 'DirtyStateChanged',
   iFrameLoaded = 'iFrameLoaded',
-  ProjectDeleted = 'ProjectDeleted',
+  iFrameRedirect = 'iFrameRedirect',
+  DirtyStateChanged = 'DirtyStateChanged',
   ProjectSaved = 'ProjectSaved',
-  TrackingEvent = 'TrackingEvent',
+  ProjectDeleted = 'ProjectDeleted',
+  ContactDesigner = 'ContactDesigner',
+  AddToCart = 'AddToCart',
+  ContinueToCart = 'ContinueToCart',
   TokenRefreshRequested = 'TokenRefreshRequested',
   UnauthorizedToken = 'UnauthorizedToken',
-  ContinueToCart = 'ContinueToCart',
+  TrackingEvent = 'TrackingEvent',
 }
 
-interface Metadata {
-  source?: string;
+interface CommonPayload {
+  message?: string;
+  token: string;
+  customerId: string;
+}
+
+interface CommonMetadata {
   title: string;
   brand: string;
   style: string;
   color: string;
-  thumbnailUrl: string;
+  price: number;
+  retailPrice?: number;
+  thumbnailUrl?: string;
+  [key: string]: string | number | undefined;
+}
+
+interface CabinetsMetadata extends CommonMetadata {
+  source?: string;
   area?: number;
-  price?: number;
 }
 
-interface EventPayload {
+interface SnapshotPayload<M extends CommonMetadata> extends CommonPayload {
   schema: string;
-  token: string;
-  customerId: string;
   projectId: string;
   versionId: string;
-  metadata: Metadata;
-  bom?: any;
+  metadata: M;
+  bom: string;
 }
 
-interface TrackingEvent {
+interface ProjectSavedPayload extends CommonPayload {
+  projectId: string;
+  versionId?: string;
+}
+
+interface ProjectDeletedPayload extends CommonPayload {
+  projectId: string;
+}
+
+interface DirtyStateChangedPayload extends CommonPayload {
+  projectId: string;
+  isDirty: boolean;
+}
+
+// TODO: (IW) This is pretty vendor-specific, should be typed to vendor apps
+interface iFrameRedirectPayload extends CommonPayload {
+  app: string;
+  key?: string | number;
+}
+
+interface TokenRefreshRequestedPayload extends CommonPayload {
+  requestId: string;
+}
+
+interface TrackingEventPayload {
   actionName: string;
   actionData: Record<string, unknown>;
 }
@@ -47,47 +81,51 @@ export class VendorCommunicator extends Communicator {
     this.origin = origin;
   }
 
-  addToCart(payload: EventPayload): void {
-    this.post({type: VendorEvent.AddToCart, payload});
+  appInitialized(message: string): void {
+    this.post({type: VendorEvent.AppInitialized, payload: message});
   }
 
-  appInitialized(): void {
-    this.post({type: VendorEvent.AddToCart});
+  iframeLoaded(message: string): void {
+    this.post({type: VendorEvent.iFrameLoaded, payload: message});
   }
 
-  contactDesigner(payload: EventPayload): void {
-    this.post({type: VendorEvent.ContactDesigner, payload});
+  iframeRedirect(payload: iFrameRedirectPayload): void {
+    this.post({type: VendorEvent.iFrameRedirect, payload});
+  }
+
+  dirtyStateChanged(payload: DirtyStateChangedPayload): void {
+    this.post({type: VendorEvent.DirtyStateChanged, payload});
   }
 
-  dirtyStateChanged(): void {
-    this.post({type: VendorEvent.DirtyStateChanged});
+  projectSaved(payload: ProjectSavedPayload): void {
+    this.post({type: VendorEvent.ProjectSaved, payload});
   }
 
-  iframeLoaded(): void {
-    this.post({type: VendorEvent.iFrameLoaded});
+  projectDeleted(payload: ProjectDeletedPayload): void {
+    this.post({type: VendorEvent.ProjectDeleted, payload});
   }
 
-  projectSaved(): void {
-    this.post({type: VendorEvent.ProjectSaved});
+  contactDesigner(payload: SnapshotPayload<CabinetsMetadata>): void {
+    this.post({type: VendorEvent.ContactDesigner, payload});
   }
 
-  projectDeleted(): void {
-    this.post({type: VendorEvent.ProjectDeleted});
+  addToCart(payload: SnapshotPayload<CabinetsMetadata>): void {
+    this.post({type: VendorEvent.AddToCart, payload});
   }
 
-  trackEvent(payload: TrackingEvent): void {
-    this.post({type: VendorEvent.TrackingEvent, payload});
+  continueToCart(payload: SnapshotPayload<CabinetsMetadata>): void {
+    this.post({type: VendorEvent.ContinueToCart, payload});
   }
 
-  tokenRefreshRequested(): void {
-    this.post({type: VendorEvent.TokenRefreshRequested});
+  tokenRefreshRequested(payload: TokenRefreshRequestedPayload): void {
+    this.post({type: VendorEvent.TokenRefreshRequested, payload});
   }
 
   unauthorizedToken(error: string): void {
     this.post({type: VendorEvent.UnauthorizedToken, payload: error});
   }
 
-  continueToCart(payload: EventPayload): void {
-    this.post({type: VendorEvent.ContinueToCart, payload})
+  trackEvent(payload: TrackingEventPayload): void {
+    this.post({type: VendorEvent.TrackingEvent, payload});
   }
 }