Fix Typos in Events, Add Tracking Event (#12)

Author: sdashner

CHANGELOG.md

@@ -10,6 +10,11 @@ and this project adheres to
 
 ### TBA
 
+## [v3.0.0] - 2022-11-08
+
+- Update event names to match existing wording
+- Create tracking event on VendorClient
+
 ## [v2.0.0] - 2022-11-08
 
 - Renamed thumbnailUri to thumbnailUrl

package.json

@@ -1,6 +1,6 @@
 {
   "name": "postmessage-communicator",
-  "version": "2.0.0",
+  "version": "3.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",

src/classes/ClientCommunicator.ts

@@ -2,7 +2,7 @@ import {Communicator} from './Communicator';
 
 export enum ClientEvent {
   LoginWithToken = 'LoginWithToken',
-  RefreshWithToken = 'RefreshToken',
+  RefreshWithToken = 'RefreshWithToken',
 }
 
 interface InitPayload {

src/classes/VendorCommunicator.ts

@@ -5,9 +5,10 @@ export enum VendorEvent {
   AppInitialized = 'AppInitialized',
   ContactDesigner = 'ContactDesigner',
   DirtyStateChanged = 'DirtyStateChanged',
-  IframeLoaded = 'IframeLoaded',
-  ProjectSaved = 'ProjectSaved',
+  iFrameLoaded = 'iFrameLoaded',
   ProjectDeleted = 'ProjectDeleted',
+  ProjectSaved = 'ProjectSaved',
+  TrackingEvent = 'TrackingEvent',
   TokenRefreshRequested = 'TokenRefreshRequested',
   UnauthorizedToken = 'UnauthorizedToken',
 }
@@ -31,6 +32,11 @@ interface EventPayload {
   bom?: any;
 }
 
+interface TrackingEvent {
+  actionName: string;
+  actionData: Record<string, unknown>;
+}
+
 export class VendorCommunicator extends Communicator {
   constructor(origin: string) {
     super(origin);
@@ -55,7 +61,7 @@ export class VendorCommunicator extends Communicator {
   }
 
   iframeLoaded(): void {
-    this.post({type: VendorEvent.IframeLoaded});
+    this.post({type: VendorEvent.iFrameLoaded});
   }
 
   projectSaved(): void {
@@ -66,6 +72,10 @@ export class VendorCommunicator extends Communicator {
     this.post({type: VendorEvent.ProjectDeleted});
   }
 
+  trackEvent(payload: TrackingEvent): void {
+    this.post({type: VendorEvent.TrackingEvent, payload});
+  }
+
   tokenRefreshRequested(): void {
     this.post({type: VendorEvent.TokenRefreshRequested});
   }