@mparticle/web-sdk - npm Package Compare versions

Comparing version 2.11.14 to 2.11.15

CHANGELOG.md

@@ -5,2 +5,6 @@ ## Releases
 
+#### 2.11.15 - 2020-06-30
+
+-   Feat - Add transactionAttributes to logProductAction method signature
+
 #### 2.11.14 - 2020-06-24
@@ -7,0 +11,0 @@

package.json

 {
     "name": "@mparticle/web-sdk",
-    "version": "2.11.14",
+    "version": "2.11.15",
     "description": "mParticle core SDK for web applications",
@@ -67,3 +67,3 @@ "license": "Apache-2.0",
         "@babel/preset-typescript": "^7.6.0",
-        "@mparticle/event-models": "^1.1.0-alpha.2",
+        "@mparticle/event-models": "^1.1.1",
         "@types/chai": "^4.2.3",
@@ -70,0 +70,0 @@ "@types/mocha": "^5.2.7",

src/constants.js

 var Constants = {
-    sdkVersion: '2.11.14',
+    sdkVersion: '2.11.15',
     sdkVendor: 'mparticle',
@@ -4,0 +4,0 @@ platform: 'web',

src/ecommerce.js

@@ -12,20 +12,26 @@ import Types from './types';
     ) {
-        if (transactionAttributes.Id) {
+        if (transactionAttributes.hasOwnProperty('Id')) {
             productAction.TransactionId = transactionAttributes.Id;
         }
-        if (transactionAttributes.Affiliation) {
+        if (transactionAttributes.hasOwnProperty('Affiliation')) {
             productAction.Affiliation = transactionAttributes.Affiliation;
         }
-        if (transactionAttributes.CouponCode) {
+        if (transactionAttributes.hasOwnProperty('CouponCode')) {
             productAction.CouponCode = transactionAttributes.CouponCode;
         }
-        if (transactionAttributes.Revenue) {
+        if (transactionAttributes.hasOwnProperty('Revenue')) {
             productAction.TotalAmount = transactionAttributes.Revenue;
         }
-        if (transactionAttributes.Shipping) {
+        if (transactionAttributes.hasOwnProperty('Shipping')) {
             productAction.ShippingAmount = transactionAttributes.Shipping;
         }
-        if (transactionAttributes.Tax) {
+        if (transactionAttributes.hasOwnProperty('Tax')) {
             productAction.TaxAmount = transactionAttributes.Tax;
         }
+        if (transactionAttributes.hasOwnProperty('Step')) {
+            productAction.CheckoutStep = transactionAttributes.Step;
+        }
+        if (transactionAttributes.hasOwnProperty('Option')) {
+            productAction.CheckoutOptions = transactionAttributes.Option;
+        }
     };
@@ -32,0 +38,0 @@

src/events.js

@@ -105,3 +105,3 @@ import Types from './types';
 
-    this.logCheckoutEvent = function(step, options, attrs, customFlags) {
+    this.logCheckoutEvent = function(step, option, attrs, customFlags) {
         var event = mpInstance._Ecommerce.createCommerceEventObject(
@@ -119,4 +119,4 @@ customFlags
                 CheckoutStep: step,
-                CheckoutOptions: options,
-                ProductList: event.ShoppingCart.ProductList,
+                CheckoutOptions: option,
+                ProductList: [],
             };
@@ -131,4 +131,5 @@
         product,
-        attrs,
-        customFlags
+        customAttrs,
+        customFlags,
+        transactionAttributes
     ) {
@@ -151,9 +152,5 @@ var event = mpInstance._Ecommerce.createCommerceEventObject(
 
-            if (
-                event.EventCategory ===
-                    Types.CommerceEventType.ProductPurchase ||
-                event.EventCategory === Types.CommerceEventType.ProductRefund
-            ) {
+            if (mpInstance._Helpers.isObject(transactionAttributes)) {
                 mpInstance._Ecommerce.convertTransactionAttributesToProductAction(
-                    attrs,
+                    transactionAttributes,
                     event.ProductAction
@@ -163,3 +160,3 @@ );
 
-            self.logCommerceEvent(event, attrs);
+            self.logCommerceEvent(event, customAttrs);
         }
@@ -166,0 +163,0 @@ };

src/mp-instance.js

@@ -734,7 +734,11 @@ //
          * @param {Number} step checkout step number
-         * @param {Object} options
+         * @param {String} option
          * @param {Object} attrs
          * @param {Object} [customFlags] Custom flags for the event
+         * @deprecated
          */
-        logCheckout: function(step, options, attrs, customFlags) {
+        logCheckout: function(step, option, attrs, customFlags) {
+            self.Logger.warning(
+                'mParticle.logCheckout is deprecated, please use mParticle.logProductAction instead'
+            );
             if (!self._Store.isInitialized) {
@@ -744,3 +748,3 @@ self.ready(function() {
                         step,
-                        options,
+                        option,
                         attrs,
@@ -753,3 +757,3 @@ customFlags
             self._SessionManager.resetSessionTimer();
-            self._Events.logCheckoutEvent(step, options, attrs, customFlags);
+            self._Events.logCheckoutEvent(step, option, attrs, customFlags);
         },
@@ -764,2 +768,3 @@ /**
          * @param {Object} [customFlags] Custom flags for the event
+         * @param {Object} [transactionAttributes] Transaction Attributes for the event
          */
@@ -770,3 +775,4 @@ logProductAction: function(
             attrs,
-            customFlags
+            customFlags,
+            transactionAttributes
         ) {
@@ -779,3 +785,4 @@ if (!self._Store.isInitialized) {
                         attrs,
-                        customFlags
+                        customFlags,
+                        transactionAttributes
                     );
@@ -790,3 +797,4 @@ });
                 attrs,
-                customFlags
+                customFlags,
+                transactionAttributes
             );
@@ -803,2 +811,3 @@ },
          * @param {Object} [customFlags] Custom flags for the event
+         * @deprecated
          */
@@ -812,2 +821,5 @@ logPurchase: function(
         ) {
+            self.Logger.warning(
+                'mParticle.logPurchase is deprecated, please use mParticle.logProductAction instead'
+            );
             if (!self._Store.isInitialized) {
@@ -892,2 +904,3 @@ self.ready(function() {
          * @param {Object} [customFlags] Custom flags for the event
+         * @deprecated
          */
@@ -901,2 +914,5 @@ logRefund: function(
         ) {
+            self.Logger.warning(
+                'mParticle.logRefund is deprecated, please use mParticle.logProductAction instead'
+            );
             if (!self._Store.isInitialized) {
@@ -903,0 +919,0 @@ self.ready(function() {

src/mparticle-instance-manager.js

@@ -248,3 +248,4 @@ import Polyfill from './polyfill';
             attrs,
-            customFlags
+            customFlags,
+            transactionAttributes
         ) {
@@ -255,3 +256,4 @@ self.getInstance().eCommerce.logProductAction(
                 attrs,
-                customFlags
+                customFlags,
+                transactionAttributes
             );
@@ -258,0 +260,0 @@ },

src/sdkToEventsApiConverter.ts

@@ -48,3 +48,5 @@ import {
         timestamp_unixtime_ms: new Date().getTime(),
-        environment: lastEvent.Debug ? 'development' : 'production',
+        environment: lastEvent.Debug
+            ? EventsApi.BatchEnvironmentEnum.development
+            : EventsApi.BatchEnvironmentEnum.production,
         events: uploadEvents,
@@ -58,3 +60,3 @@ mp_deviceid: lastEvent.DeviceId,
         device_info: {
-            platform: 'web',
+            platform: EventsApi.DeviceInformationPlatformEnum.web,
             screen_width: window.screen.width,
@@ -243,27 +245,27 @@ screen_height: window.screen.height,
     if (!actionType) {
-        return 'unknown';
+        return EventsApi.ProductActionActionEnum.unknown;
     }
     switch (actionType) {
         case SDKProductActionType.AddToCart:
-            return 'add_to_cart';
+            return EventsApi.ProductActionActionEnum.addToCart;
         case SDKProductActionType.AddToWishlist:
-            return 'add_to_wishlist';
+            return EventsApi.ProductActionActionEnum.addToWishlist;
         case SDKProductActionType.Checkout:
-            return 'checkout';
+            return EventsApi.ProductActionActionEnum.checkout;
         case SDKProductActionType.CheckoutOption:
-            return 'checkout_option';
+            return EventsApi.ProductActionActionEnum.checkoutOption;
         case SDKProductActionType.Click:
-            return 'click';
+            return EventsApi.ProductActionActionEnum.click;
         case SDKProductActionType.Purchase:
-            return 'purchase';
+            return EventsApi.ProductActionActionEnum.purchase;
         case SDKProductActionType.Refund:
-            return 'refund';
+            return EventsApi.ProductActionActionEnum.refund;
         case SDKProductActionType.RemoveFromCart:
-            return 'remove_from_cart';
+            return EventsApi.ProductActionActionEnum.removeFromCart;
         case SDKProductActionType.RemoveFromWishlist:
-            return 'remove_from_wish_list';
+            return EventsApi.ProductActionActionEnum.removeFromWishlist;
         case SDKProductActionType.ViewDetail:
-            return 'view_detail';
+            return EventsApi.ProductActionActionEnum.viewDetail;
         default:
-            return 'unknown';
+            return EventsApi.ProductActionActionEnum.unknown;
     }
@@ -404,3 +406,3 @@ }
     return {
-        event_type: 'commerce_event',
+        event_type: EventsApi.EventTypeEnum.commerceEvent,
         data: commerceEventData,
@@ -420,3 +422,3 @@ };
     return {
-        event_type: 'crash_report',
+        event_type: EventsApi.EventTypeEnum.crashReport,
         data: crashReportEventData,
@@ -433,3 +435,6 @@ };
     let astEventData: EventsApi.ApplicationStateTransitionEventData = {
-        application_transition_type: 'application_initialized',
+        application_transition_type:
+            EventsApi
+                .ApplicationStateTransitionEventDataApplicationTransitionTypeEnum
+                .applicationInitialized,
         is_first_run: sdkEvent.IsFirstRun,
@@ -440,3 +445,3 @@ is_upgrade: false,
     return {
-        event_type: 'application_state_transition',
+        event_type: EventsApi.EventTypeEnum.applicationStateTransition,
         data: astEventData,
@@ -459,3 +464,3 @@ };
     return {
-        event_type: 'session_end',
+        event_type: EventsApi.EventTypeEnum.sessionEnd,
         data: sessionEndEventData,
@@ -477,3 +482,3 @@ };
     return {
-        event_type: 'session_start',
+        event_type: EventsApi.EventTypeEnum.sessionStart,
         data: sessionStartEventData,
@@ -495,3 +500,3 @@ };
     return {
-        event_type: 'screen_view',
+        event_type: EventsApi.EventTypeEnum.screenView,
         data: screenViewEventData,
@@ -510,3 +515,3 @@ };
     return {
-        event_type: 'opt_out',
+        event_type: EventsApi.EventTypeEnum.optOut,
         data: optOutEventData,
@@ -529,3 +534,3 @@ };
     return {
-        event_type: 'custom_event',
+        event_type: EventsApi.EventTypeEnum.customEvent,
         data: customEventData,
@@ -542,46 +547,50 @@ };
         case Types.EventType.Other:
-            return 'other';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.other;
         case Types.EventType.Location:
-            return 'location';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.location;
         case Types.EventType.Navigation:
-            return 'navigation';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.navigation;
         case Types.EventType.Search:
-            return 'search';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.search;
         case Types.EventType.Social:
-            return 'social';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.social;
         case Types.EventType.Transaction:
-            return 'transaction';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.transaction;
         case Types.EventType.UserContent:
-            return 'user_content';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.userContent;
         case Types.EventType.UserPreference:
-            return 'user_preference';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.userPreference;
         case Types.CommerceEventType.ProductAddToCart:
-            return 'add_to_cart';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.addToCart;
         case Types.CommerceEventType.ProductAddToWishlist:
-            return 'add_to_wishlist';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.addToWishlist;
         case Types.CommerceEventType.ProductCheckout:
-            return 'checkout';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.checkout;
         case Types.CommerceEventType.ProductCheckoutOption:
-            return 'checkout_option';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum
+                .checkoutOption;
         case Types.CommerceEventType.ProductClick:
-            return 'click';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.click;
         case Types.CommerceEventType.ProductImpression:
-            return 'impression';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.impression;
         case Types.CommerceEventType.ProductPurchase:
-            return 'purchase';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.purchase;
         case Types.CommerceEventType.ProductRefund:
-            return 'refund';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.refund;
         case Types.CommerceEventType.ProductRemoveFromCart:
-            return 'remove_from_cart';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum
+                .removeFromCart;
         case Types.CommerceEventType.ProductRemoveFromWishlist:
-            return 'remove_from_wishlist';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum
+                .removeFromWishlist;
         case Types.CommerceEventType.ProductViewDetail:
-            return 'view_detail';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.viewDetail;
         case Types.CommerceEventType.PromotionClick:
-            return 'promotion_click';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum
+                .promotionClick;
         case Types.CommerceEventType.PromotionView:
-            return 'promotion_view';
+            return EventsApi.CommerceEventDataCustomEventTypeEnum.promotionView;
 
         default:
-            return 'unknown';
+            return EventsApi.CustomEventDataCustomEventTypeEnum.unknown;
     }
@@ -635,3 +644,3 @@ }
     return {
-        event_type: 'user_attribute_change',
+        event_type: EventsApi.EventTypeEnum.userAttributeChange,
         data: userAttributeChangeEvent,
@@ -671,5 +680,5 @@ };
     return {
-        event_type: 'user_identity_change',
+        event_type: EventsApi.EventTypeEnum.userIdentityChange,
         data: userIdentityChangeEvent,
     };
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1414508

increased by5.04%

Lines of code

26213

increased by4.76%

No dependency changes