Add Vendor-Continue to Cart and Client-AddToCartStatus events (#16)

Co-authored-by: Utsav Beri <uberi@wayfair.com>

Author: utsavberi

CHANGELOG.md

@@ -10,6 +10,11 @@ and this project adheres to
 
 ### TBA
 
+## [v4.1.0] - 2022-12-23
+
+- Added Continue to Cart Event to the Vendor Communicator
+- Added Add To Cart Status Event to the Client Communicator
+
 ## [v4.0.0] - 2022-11-23
 
 - Update Metadata shape to add source and price

README.md

@@ -105,6 +105,19 @@ no parameters
 
 no parameters
 
+### `continueToCart`
+
+| Parameter Name | Required | Description            | Type   | Default   |
+| -------------- | -------- | ---------------------- | ------ | --------- |
+| customerUid    | yes      | customer identifier    | string |           |
+| projectId      | yes      | project identifier     | string |           |
+| projectVersion | no       | project version        | string |           |
+| brand          | yes      | brand description      | string |           |
+| style          | yes      | style description      | string |           |
+| color          | yes      | color                  | string |           |
+| url            | yes      | thumbnail image url    | string |           |
+| bom            | yes      | bill of materials      | string |           |
+
 ## Client Communicator API
 
 ### `init`
@@ -120,6 +133,15 @@ no parameters
 | -------------- | -------- | ------------------------------------- | ------ | ------- |
 | token          | yes      | JWT token with initialization payload | string |         |
 
+### `addToCartStatus`
+
+| Parameter Name    | Required | Description                                              | Type   | Default |
+| ----------------- | -------- | -------------------------------------------------------- | ------ | ------- |
+| success           | yes      | flag indicating if the add to cart event succeded or not | boolean|         |
+| message           | yes      | status message                                           | string |         |
+| projectId         | yes      | project id                                               | string |         |
+| versionId         | yes      | project version                                          | string |         |
+
 ## Roadmap
 
 See the

package.json

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

@@ -3,18 +3,28 @@ import {Communicator} from './Communicator';
 export enum ClientEvent {
   LoginWithToken = 'LoginWithToken',
   RefreshWithToken = 'RefreshWithToken',
+  AddToCartStatus = 'AddToCartStatus',
 }
 
 interface InitPayload {
   token: string;
   landingExperience: string;
 }
 
+interface AddToCartStatusPayload {
+  success: boolean;
+  message: string;
+  projectId: string;
+  versionId: string;
+}
 export class ClientCommunicator extends Communicator {
   init(payload: InitPayload): void {
     this.post({type: ClientEvent.LoginWithToken, payload});
   }
   refreshWithToken(token: string): void {
     this.post({type: ClientEvent.RefreshWithToken, payload: token});
   }
+  addToCartStatus(payload: AddToCartStatusPayload): void {
+    this.post({type: ClientEvent.AddToCartStatus, payload})
+  }
 }

src/classes/VendorCommunicator.ts

@@ -11,6 +11,7 @@ export enum VendorEvent {
   TrackingEvent = 'TrackingEvent',
   TokenRefreshRequested = 'TokenRefreshRequested',
   UnauthorizedToken = 'UnauthorizedToken',
+  ContinueToCart = 'ContinueToCart',
 }
 
 interface Metadata {
@@ -85,4 +86,8 @@ export class VendorCommunicator extends Communicator {
   unauthorizedToken(error: string): void {
     this.post({type: VendorEvent.UnauthorizedToken, payload: error});
   }
+
+  continueToCart(payload: EventPayload): void {
+    this.post({type: VendorEvent.ContinueToCart, payload})
+  }
 }