Address PR Comments

Author: alexs-mparticle

src/ecommerce.interfaces.ts

@@ -120,11 +120,45 @@ export interface SDKECommerceAPI extends IECommerceShared {
     ): void;
 }
 
+interface ExtractedActionAttributes {
+    "Affiliation"?: string;
+    "Coupon Code"?: string;
+    "Total Amount"?: number;
+    "Shipping Amount"?: string;
+    "Tax Amount"?: string;
+    "Checkout Option"?: string;
+    "Checkout Step"?: number;
+    "Transaction ID"?: string;
+}
+interface ExtractedProductAttributes {
+    "Coupon Code"?: string;
+    "Brand"?: string;
+    "Category"?: string;
+    "Name"?: string;
+    "Id"?: string;
+    "Item Price"?: string;
+    "Quantity"?: string;
+    "Position"?: number;
+    "Variant"?: string;
+    "Total Product Amount": string;
+}
+interface ExtractedPromotionAttributes {
+    "Id"?: string;
+    "Creative"?: string;
+    "Name"?: string;
+    "Position"?: number;
+}
+interface ExtractedTransactionId {
+    "Transaction ID"?: string;
+}
+
 // Used for the private `_Ecommerce` namespace
 export interface IECommerce extends IECommerceShared {
     buildProductList(event: SDKEvent, product: Product | Product[]): Product[];
     convertProductActionToEventType(
         productActionType: valueof<typeof ProductActionType>
+
+        // https://go.mparticle.com/work/SQDSDKS-4801
     ): typeof CommerceEventType | typeof EventType | null;
     convertPromotionActionToEventType(
         promotionActionType: valueof<typeof PromotionActionType>
@@ -141,19 +175,19 @@ export interface IECommerce extends IECommerceShared {
     expandProductImpression(commerceEvent: CommerceEvent): SDKEvent[];
     expandPromotionAction(commerceEvent: CommerceEvent): SDKEvent[];
     extractActionAttributes(
-        attributes: Record<string, string | number>,
+        attributes: ExtractedActionAttributes,
         productAction: ProductAction
     ): void;
     extractProductAttributes(
-        attributes: Record<string, string | number>,
+        attributes: ExtractedProductAttributes,
         product: Product
     ): void;
     extractPromotionAttributes(
-        attributes: Record<string, string | number>,
+        attributes: ExtractedPromotionAttributes,
         promotion: Promotion
     ): void;
     extractTransactionId(
-        attributes: Record<string, string | number>,
+        attributes: ExtractedTransactionId;
         productAction: ProductAction
     ): void;
     generateExpandedEcommerceName(eventName: string, plusOne: boolean): string;

src/ecommerce.js

@@ -5,6 +5,8 @@ var Messages = Constants.Messages;
 
 export default function Ecommerce(mpInstance) {
     var self = this;
+
+    // https://go.mparticle.com/work/SQDSDKS-4801
     this.convertTransactionAttributesToProductAction = function(
         transactionAttributes,
         productAction
@@ -103,8 +105,11 @@ export default function Ecommerce(mpInstance) {
                 return Types.CommerceEventType.ProductRemoveFromCart;
             case Types.ProductActionType.RemoveFromWishlist:
                 return Types.CommerceEventType.ProductRemoveFromWishlist;
+
+            // https://go.mparticle.com/work/SQDSDKS-4801
             case Types.ProductActionType.Unknown:
                 return Types.EventType.Unknown;
+
             case Types.ProductActionType.ViewDetail:
                 return Types.CommerceEventType.ProductViewDetail;
             default:
@@ -139,6 +144,7 @@ export default function Ecommerce(mpInstance) {
         );
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-4801
     this.extractProductAttributes = function(attributes, product) {
         if (product.CouponCode) {
             attributes['Coupon Code'] = product.CouponCode;
@@ -170,12 +176,14 @@ export default function Ecommerce(mpInstance) {
         attributes['Total Product Amount'] = product.TotalAmount || 0;
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-4801
     this.extractTransactionId = function(attributes, productAction) {
         if (productAction.TransactionId) {
             attributes['Transaction Id'] = productAction.TransactionId;
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-4801
     this.extractActionAttributes = function(attributes, productAction) {
         self.extractTransactionId(attributes, productAction);
 
@@ -208,6 +216,7 @@ export default function Ecommerce(mpInstance) {
         }
     };
 
+    // https://go.mparticle.com/work/SQDSDKS-4801
     this.extractPromotionAttributes = function(attributes, promotion) {
         if (promotion.Id) {
             attributes['Id'] = promotion.Id;