@shopgate/tracking-core 7.30.0-alpha.7 → 7.30.0-alpha.8

package/plugins/trackers/Unified.js

@@ -1,11 +1,44 @@
-function _typeof(obj){if(typeof Symbol==="function"&&typeof Symbol.iterator==="symbol"){_typeof=function _typeof(obj){return typeof obj;};}else{_typeof=function _typeof(obj){return obj&&typeof Symbol==="function"&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj;};}return _typeof(obj);}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,descriptor.key,descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);return Constructor;}function _callSuper(_this,derived,args){function isNativeReflectConstruct(){if(typeof Reflect==="undefined"||!Reflect.construct)return false;if(Reflect.construct.sham)return false;if(typeof Proxy==="function")return true;try{return!Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){}));}catch(e){return false;}}derived=_getPrototypeOf(derived);return _possibleConstructorReturn(_this,isNativeReflectConstruct()?Reflect.construct(derived,args||[],_getPrototypeOf(_this).constructor):derived.apply(_this,args));}function _possibleConstructorReturn(self,call){if(call&&(_typeof(call)==="object"||typeof call==="function")){return call;}return _assertThisInitialized(self);}function _assertThisInitialized(self){if(self===void 0){throw new ReferenceError("this hasn't been initialised - super() hasn't been called");}return self;}function _getPrototypeOf(o){_getPrototypeOf=Object.setPrototypeOf?Object.getPrototypeOf:function _getPrototypeOf(o){return o.__proto__||Object.getPrototypeOf(o);};return _getPrototypeOf(o);}function _inherits(subClass,superClass){if(typeof superClass!=="function"&&superClass!==null){throw new TypeError("Super expression must either be null or a function");}subClass.prototype=Object.create(superClass&&superClass.prototype,{constructor:{value:subClass,writable:true,configurable:true}});if(superClass)_setPrototypeOf(subClass,superClass);}function _setPrototypeOf(o,p){_setPrototypeOf=Object.setPrototypeOf||function _setPrototypeOf(o,p){o.__proto__=p;return o;};return _setPrototypeOf(o,p);}import{sendDataRequest}from"../../helpers/helper";import BasePlugin from"../Base";/**
+import { sendDataRequest } from "../../helpers/helper";
+import BasePlugin from "../Base";
+
+/**
  * Tracking Plugin for our unified tracking system
- */var Unified=/*#__PURE__*/function(_BasePlugin){/**
+ */
+class Unified extends BasePlugin {
+  /**
    * @param {Object} [options] configuration
-   */function Unified(){var _this2;var options=arguments.length>0&&arguments[0]!==undefined?arguments[0]:{};_classCallCheck(this,Unified);var trackerName=options.trackerName||'unified';// Invoke the parent constructor
-_this2=_callSuper(this,Unified,[trackerName,options]);_this2.register.viewContent(function(data){return data;});_this2.register.setCampaignWithUrl(function(data){return data;});_this2.register.purchase(function(data){return data;});_this2.register.addToCart(function(data){return data;});_this2.register.initiatedCheckout(function(data){return data;});_this2.register.completedRegistration(function(data){return data;});_this2.register.addToWishlist(function(data){return data;});_this2.register.search(function(data){return data;});_this2.register.addedPaymentInfo(function(data){return data;});_this2.trackingCore.register.removeTracker(function(){// Send request to server to remove the tracker
-sendDataRequest('remove_unified_trackers');},{trackerName:_this2.trackerName,options:_this2.options});_this2.trackingCore.register.addTracker(function(){// Send request to server to add the tracker again
-sendDataRequest('add_unified_trackers');},{trackerName:_this2.trackerName,options:_this2.options});return _this2;}/**
+   */
+  constructor(options = {}) {
+    const trackerName = options.trackerName || 'unified';
+
+    // Invoke the parent constructor
+    super(trackerName, options);
+    this.register.viewContent(data => data);
+    this.register.setCampaignWithUrl(data => data);
+    this.register.purchase(data => data);
+    this.register.addToCart(data => data);
+    this.register.initiatedCheckout(data => data);
+    this.register.completedRegistration(data => data);
+    this.register.addToWishlist(data => data);
+    this.register.search(data => data);
+    this.register.addedPaymentInfo(data => data);
+    this.trackingCore.register.removeTracker(() => {
+      // Send request to server to remove the tracker
+      sendDataRequest('remove_unified_trackers');
+    }, {
+      trackerName: this.trackerName,
+      options: this.options
+    });
+    this.trackingCore.register.addTracker(() => {
+      // Send request to server to add the tracker again
+      sendDataRequest('add_unified_trackers');
+    }, {
+      trackerName: this.trackerName,
+      options: this.options
+    });
+  }
+
+  /**
    * Helper function to register a plugin for a specific event. Overwrites the parent function with
    * special logic for the blacklist system.
    *
@@ -13,8 +46,31 @@ sendDataRequest('add_unified_trackers');},{trackerName:_this2.trackerName,option
    * @param {Function} callback Callback from the plugin, to modify the data
    * @returns {RemoveListener} Function to remove the listener
    * @private
-   */_inherits(Unified,_BasePlugin);return _createClass(Unified,[{key:"registerHelper",value:function registerHelper(eventName,callback){var _this3=this;// Register the tracking event of the plugin at the core
-return this.trackingCore.register[eventName](function(data,scope,blacklist,state){if(typeof _this3.appHandler[eventName]!=='function'){console.warn("this.appHandler[".concat(eventName,"] is not a function"));return;}// Convert the tracking data into the unified format
-var unifiedData=BasePlugin.formatData(eventName,data);// Invoke the event callback of the plugin to enable it to extend the data
-var finalData=callback(unifiedData,data,scope,state);// Send command to the app via the appHandler
-_this3.appHandler[eventName](finalData,{blacklist:true,trackers:blacklist});},{trackerName:this.trackerName,options:this.options});}}]);}(BasePlugin);window.SgUnifiedTracking=Unified;export default Unified;
+   */
+  registerHelper(eventName, callback) {
+    // Register the tracking event of the plugin at the core
+    return this.trackingCore.register[eventName]((data, scope, blacklist, state) => {
+      if (typeof this.appHandler[eventName] !== 'function') {
+        console.warn(`this.appHandler[${eventName}] is not a function`);
+        return;
+      }
+
+      // Convert the tracking data into the unified format
+      const unifiedData = BasePlugin.formatData(eventName, data);
+
+      // Invoke the event callback of the plugin to enable it to extend the data
+      const finalData = callback(unifiedData, data, scope, state);
+
+      // Send command to the app via the appHandler
+      this.appHandler[eventName](finalData, {
+        blacklist: true,
+        trackers: blacklist
+      });
+    }, {
+      trackerName: this.trackerName,
+      options: this.options
+    });
+  }
+}
+window.SgUnifiedTracking = Unified;
+export default Unified;

package/typedef.js

@@ -1,13 +1,17 @@
 /**
  * Data definitions of the multiple tracking events
- */ /**
+ */
+
+/**
  * Data definition for a pageview event within the unified tracking system
  * @typedef {Object} UnifiedPageview
  * @property {string} type The type of the current page. Something like "Product" or "Checkout"
  * @property {string} id A unique identifier for the current page, like an item number or page title
  * @property {string} name A name to easier distinguish this item in the tracking tool
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for a search event within the unified tracking system
  * @typedef {Object} UnifiedSearch
  * @property {string} [query] The query string that has been used for the string
@@ -15,7 +19,9 @@
  * @property {string} [type] The type of the content that has been searched
  * @property {number} [hits] Amount of hits, the search brought
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for a purchase event within the unified tracking system
  * @typedef {Object} UnifiedPurchase
  * @property {string} id A unique ID representing the transaction.
@@ -34,7 +40,9 @@
  * @property {string} [type] Type of checkout
  * @property {boolean} [success] Whether the Purchase was successful, or not
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for a custom event within the unified tracking system
  * @typedef {Object} UnifiedCustomEvent
  * @property {string} eventCategory The event category
@@ -42,24 +50,32 @@
  * @property {string} [eventLabel] The event label
  * @property {number} [eventValue] The event value
  * @property {boolean} [nonInteraction] If the event was triggered by a user interaction
- */ /**
+ */
+
+/**
  * Data definition for an addToCart event within the unified tracking system
  * @typedef {Object} UnifiedAddToCart
  * @property {UnifiedAddToCartItem[]} items Array of unified items
  * @property {string} position Position where the add to cart took place
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for an addToWishlist event within the unified tracking system
  * @typedef {Object} UnifiedAddToWishlist
  * @property {UnifiedAddToWishlistItem[]} items Array of unified wishlist items
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for an addedPaymentInfo event within the unified tracking system
  * @typedef {Object} UnifiedPaymentInfo
  * @property {bool} success If it was success or not
  * @property {string} name Name of the payment method
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for an InitiatedCheckout event within the unified tracking system
  * @typedef {Object} UnifiedInitiatedCheckout
  * @property {number} valueNet The net value of the items in the cart
@@ -69,9 +85,13 @@
  * @property {boolean} [paymentInfoAvailable] Whether the paymentInfo is available
  * @property {string} [currency] The currency code as ISO 4217 string.
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definitions of item data for the multiple tracking events
- */ /**
+ */
+
+/**
  * Data definition for a purchase item within the unified tracking system
  * @typedef {Object} UnifiedPurchaseItem
  * @property {string} type The type of the item, eg "product"
@@ -84,7 +104,9 @@
  * @property {number} [quantity] The quantity of the product. If not set, the value is set to 1
  * @property {string} [categoryId] The unique identifier of the category the product belongs
  * @property {string} [categoryName] Human readable name of the category the product belongs
- */ /**
+ */
+
+/**
  * Data definition for an addToCart item within the unified tracking system
  * @typedef {Object} UnifiedAddToCartItem
  * @property {string} type The type of the item, eg "product"
@@ -98,13 +120,17 @@
  * @property {string} [categoryName] Human readable name of the category the product belongs
  * @property {string} [brand] The brand of the product
  * @property {string} [couponCode] Position where the add to cart took place
- */ /**
+ */
+
+/**
  * Data definition for a completedRegistration within the unified tracking system
  * @typedef {Object} UnifiedCompletedRegistration
  * @property {string} registrationMethod The type of the registration
  *  (default_account, guest_account, facebook, 'connect_register')
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * Data definition for an addToWishlist item within the unified tracking system
  * @typedef {Object} UnifiedAddToWishlistItem
  * @property {number} priceNet The net price of the product
@@ -116,7 +142,9 @@
  * @property {string} type The type of the item, eg "product"
  * @property {string} name The name of the item
  * @property {string} [brand] The brand of the product
- */ /**
+ */
+
+/**
  * Data definition for an search event within the unified tracking system
  * @typedef {Object} UnifiedSearched
  * @property {string} [query] The query string that has been used for the search
@@ -124,12 +152,18 @@
  * @property {string} [type] The type of the content that has been searched
  * @property {number} [hits] Amount of hits, the search brought.
  * @property {UnifiedRestrictions} [restrictions] Restrictions for the command
- */ /**
+ */
+
+/**
  * @typedef {Object} RemoveListener
  * @property {Function} remove Function to remove the listener for a tracking event
- */ /**
+ */
+
+/**
  * Additional definitions of data for the multiple tracking events
- */ /**
+ */
+
+/**
  * Restrictions for a unified tracking command
  * @typedef {Object} UnifiedRestrictions
  * @property {boolean} blacklist If set to TRUE, this event is not sent to the trackers named