vue-matomo - npm Package Compare versions

Comparing version 3.12.0-4 to 3.12.0-5

demo/src/main.js

@@ -29,4 +29,16 @@ // The Vue build version to load with the `import` command
 
+  // Run Matomo without cookies
+  // Default: false
+  disableCookies: false,
+
+  // Enable the heartbeat timer (https://developer.matomo.org/guides/tracking-javascript-guide#accurately-measure-the-time-spent-on-each-page)
+  // Default: false
+  enableHeartBeatTimer: true,
+
+  // Set the heartbeat timer interval
+  // Default: 15
+  heartBeatTimerInterval: 5,
+
   // Changes the default .js and .php endpoint's filename
-  // Default: 'piwik'
+  // Default: 'matomo'
   trackerFileName: 'piwik',
@@ -33,0 +45,0 @@

dist/vue-matomo.js

@@ -1,1 +0,1 @@
-!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r();else if("function"==typeof define&&define.amd)define([],r);else{var t=r();for(var n in t)("object"==typeof exports?exports:e)[n]=t[n]}}(window,(function(){return function(e){var r={};function t(n){if(r[n])return r[n].exports;var o=r[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}return t.m=e,t.c=r,t.d=function(e,r,n){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:n})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(t.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var o in e)t.d(n,o,function(r){return e[r]}.bind(null,o));return n},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=0)}([function(e,r,t){"use strict";t.r(r),t.d(r,"default",(function(){return a}));var n={debug:!1,enableLinkTracking:!0,requireConsent:!1,trackInitialView:!0,trackerFileName:"matomo",trackerUrl:void 0,userId:void 0};function o(e,r){var t=window.Piwik.getAsyncTracker();if(e.prototype.$piwik=t,e.prototype.$matomo=t,r.trackInitialView&&t.trackPageView(),r.router){var n=function(e){var r=window.location,t="/";e.router.options.base&&(t=e.router.options.base.replace(/^[\/]/,"").replace(/[\/]+$/,""),t="/".concat(t));var n=r.protocol;":"!==n.slice(-1)&&(n+=":");var o="hash"===e.router.mode?"/#":"";return n+"//"+r.host+t+o}(r);r.router.afterEach((function(e,o){var a=n+e.fullPath;e.meta.analyticsIgnore?r.debug&&console.debug("[vue-matomo] Ignoring "+a):(r.debug&&console.debug("[vue-matomo] Tracking "+a),t.setCustomUrl(a),t.trackPageView())}))}}function a(e){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},t=Object.assign({},n,r),a=t.host,i=t.siteId,c=t.trackerFileName,u=t.trackerUrl,d="".concat(a,"/").concat(c,".js"),s=u||"".concat(a,"/").concat(c,".php");window._paq=window._paq||[],t.requireConsent&&window._paq.push(["requireConsent"]),t.userId&&window._paq.push(["setUserId",t.userId]),t.enableLinkTracking&&window._paq.push(["enableLinkTracking"]),window._paq.push(["setTrackerUrl",s]),window._paq.push(["setSiteId",i]),function(e){var r=new Promise((function(r,t){var n=document.createElement("script");n.async=!0,n.defer=!0,n.src=e,(document.head||document.getElementsByTagName("head")[0]).appendChild(n),n.onload=r,n.onerror=t}));return r.catch((function(e){var r="[vue-matomo] An error occurred trying to load "+e.target.src+". If the file exists you may have an ad- or trackingblocker enabled.";console.error(r)})),r}(d).then((function(){return o(e,t)}))}}])}));
+!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r();else if("function"==typeof define&&define.amd)define([],r);else{var t=r();for(var n in t)("object"==typeof exports?exports:e)[n]=t[n]}}(window,(function(){return function(e){var r={};function t(n){if(r[n])return r[n].exports;var o=r[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}return t.m=e,t.c=r,t.d=function(e,r,n){t.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:n})},t.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.t=function(e,r){if(1&r&&(e=t(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(t.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var o in e)t.d(n,o,function(r){return e[r]}.bind(null,o));return n},t.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(r,"a",r),r},t.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},t.p="",t(t.s=0)}([function(e,r,t){"use strict";t.r(r),t.d(r,"default",(function(){return a}));var n={debug:!1,disableCookies:!1,enableHeartBeatTimer:!1,enableLinkTracking:!0,heartBeatTimerInterval:15,requireConsent:!1,trackInitialView:!0,trackerFileName:"matomo",trackerUrl:void 0,userId:void 0};function o(e,r){var t=window.Piwik.getAsyncTracker();if(e.prototype.$piwik=t,e.prototype.$matomo=t,r.trackInitialView&&t.trackPageView(),r.router){var n=function(e){var r=window.location,t="/";e.router.options.base&&(t=e.router.options.base.replace(/^[\/]/,"").replace(/[\/]+$/,""),t="/".concat(t));var n=r.protocol;":"!==n.slice(-1)&&(n+=":");var o="hash"===e.router.mode?"/#":"";return n+"//"+r.host+t+o}(r);r.router.afterEach((function(e,o){var a=n+e.fullPath;e.meta.analyticsIgnore?r.debug&&console.debug("[vue-matomo] Ignoring "+a):(r.debug&&console.debug("[vue-matomo] Tracking "+a),t.setCustomUrl(a),t.trackPageView())}))}}function a(e){var r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},t=Object.assign({},n,r),a=t.host,i=t.siteId,u=t.trackerFileName,c=t.trackerUrl,s="".concat(a,"/").concat(u,".js"),l=c||"".concat(a,"/").concat(u,".php");window._paq=window._paq||[],t.requireConsent&&window._paq.push(["requireConsent"]),t.userId&&window._paq.push(["setUserId",t.userId]),t.enableLinkTracking&&window._paq.push(["enableLinkTracking"]),t.disableCookies&&window._paq.push(["disableCookies"]),t.enableHeartBeatTimer&&window._paq.push(["enableHeartBeatTimer",t.heartBeatTimerInterval]),window._paq.push(["setTrackerUrl",l]),window._paq.push(["setSiteId",i]),function(e){var r=new Promise((function(r,t){var n=document.createElement("script");n.async=!0,n.defer=!0,n.src=e,(document.head||document.getElementsByTagName("head")[0]).appendChild(n),n.onload=r,n.onerror=t}));return r.catch((function(e){var r="[vue-matomo] An error occurred trying to load "+e.target.src+". If the file exists you may have an ad- or trackingblocker enabled.";console.error(r)})),r}(s).then((function(){return o(e,t)}))}}])}));

package.json

 {
   "name": "vue-matomo",
-  "version": "3.12.0-4",
+  "version": "3.12.0-5",
   "description": "Link your Piwik/Matomo installation",
@@ -5,0 +5,0 @@ "author": "Dennis Ruhe <[e-mail]>",

README.md

@@ -5,3 +5,3 @@ # VueMatomo
 [![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)
-[![Build Status](https://travis-ci.org/AmazingDreams/vue-matomo.svg?branch=master)](https://travis-ci.org/AmazingDreams/vue-matomo)
+[![npm](https://img.shields.io/npm/dw/vue-matomo.svg)](https://www.npmjs.com/package/vue-matomo)
 
@@ -41,4 +41,4 @@ Link your Piwik/Matomo installation
   // Changes the default .js and .php endpoint's filename
-  // Default: 'piwik'
-  trackerFileName: 'piwik',
+  // Default: 'matomo'
+  trackerFileName: 'matomo',
 
@@ -65,6 +65,18 @@ // Overrides the autogenerated tracker endpoint entirely
 
+  // Run Matomo without cookies
+  // Default: false
+  disableCookies: false,
+
+  // Enable the heartbeat timer (https://developer.matomo.org/guides/tracking-javascript-guide#accurately-measure-the-time-spent-on-each-page)
+  // Default: false
+  enableHeartBeatTimer: true,
+
+  // Set the heartbeat timer interval
+  // Default: 15
+  heartBeatTimerInterval: 15,
+
   // Whether or not to log debug information
   // Default: false
   debug: false,
-  
+
   // UserID passed to Matomo (see https://developer.matomo.org/guides/tracking-javascript-guide#user-id)
@@ -87,5 +99,17 @@ // Default: undefined
 
+#### Note on async loading
+
+This plugin loads the `matomo.js` asynchronously, which means it is possible that `$matomo` is not (yet) loaded. Furthermore anti-tracking plugins on browsers might block `matomo.js` entirely. You should always guard your calls to `$matomo`, or use `window._paq.push`:
+
+```js
+this.$matomo && this.$matomo.trackPageView()
+
+// Or...
+
+window._paq.push(['trackPageView'])
+```
+
 ### Nuxt
 
-Nuxt can work by creating a plugin that will load VueMatomo with SSR disabled. Note how the router is passed:
+Nuxt can work by creating a plugin that will load VueMatomo with SSR disabled. Note how the router is passed in the second snippet:
 
@@ -100,5 +124,3 @@ ```js
 }
-```
 
-```js
 // plugins/vue-matomo.js
@@ -128,3 +150,3 @@
   meta: {
-  analyticsIgnore: true
+    analyticsIgnore: true
   }
@@ -131,0 +153,0 @@ }

src/index.js

@@ -5,3 +5,6 @@ import { buildBaseUrl } from './utils'
   debug: false,
+  disableCookies: false,
+  enableHeartBeatTimer: false,
   enableLinkTracking: true,
+  heartBeatTimerInterval: 15,
   requireConsent: false,
@@ -94,2 +97,10 @@ trackInitialView: true,
 
+  if (options.disableCookies) {
+    window._paq.push(['disableCookies'])
+  }
+
+  if (options.enableHeartBeatTimer) {
+    window._paq.push(['enableHeartBeatTimer', options.heartBeatTimerInterval])
+  }
+
   window._paq.push(['setTrackerUrl', trackerEndpoint])
@@ -96,0 +107,0 @@ window._paq.push(['setSiteId', siteId])

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

833137

increased by0.19%

Lines of code

24934

increased by0.07%

Number of lines in readme file

185

increased by13.5%

No dependency changes