govuk_publishing_components 21.68.1 → 23.2.1

data/app/assets/javascripts/govuk_publishing_components/analytics/external-link-tracker.js

@@ -0,0 +1,56 @@
+;(function (global) {
+  'use strict'
+
+  var $ = global.jQuery
+  var GOVUK = global.GOVUK || {}
+
+  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
+  GOVUK.analyticsPlugins.externalLinkTracker = function (options) {
+    options = options || {}
+    var externalLinkUploadCustomDimension = options.externalLinkUploadCustomDimension
+    var currentHost = GOVUK.analyticsPlugins.externalLinkTracker.getHostname()
+    var externalLinkSelector = 'a[href^="http"]:not(a[href*="' + currentHost + '"])'
+
+    $('body').on('click', externalLinkSelector, trackClickEvent)
+
+    function trackClickEvent (evt) {
+      var $link = getLinkFromEvent(evt)
+      var options = { transport: 'beacon' }
+      var href = $link.attr('href')
+      var linkText = $.trim($link.text())
+
+      if (linkText) {
+        options.label = linkText
+      }
+
+      if (externalLinkUploadCustomDimension !== undefined) {
+        // This custom dimension will be used to duplicate the url information
+        // that we normally send in an "event action". This will be used to join
+        // up with a scheduled custom upload called "External Link Status".
+        // We can only join uploads on custom dimensions, not on `event actions`
+        // where we normally add the url info.
+        var externalLinkToJoinUploadOn = href
+
+        GOVUK.analytics.setDimension(externalLinkUploadCustomDimension, externalLinkToJoinUploadOn)
+      }
+
+      GOVUK.analytics.trackEvent('External Link Clicked', href, options)
+    }
+
+    function getLinkFromEvent (evt) {
+      var $target = $(evt.target)
+
+      if (!$target.is('a')) {
+        $target = $target.parents('a')
+      }
+
+      return $target
+    }
+  }
+
+  GOVUK.analyticsPlugins.externalLinkTracker.getHostname = function () {
+    return global.location.hostname
+  }
+
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/javascripts/govuk_publishing_components/analytics/google-analytics-universal-tracker.js

@@ -0,0 +1,198 @@
+;(function (global) {
+  'use strict'
+
+  var $ = global.jQuery
+  var GOVUK = global.GOVUK || {}
+  var pii
+
+  var GoogleAnalyticsUniversalTracker = function (trackingId, fieldsObject) {
+    pii = new GOVUK.Pii()
+
+    function configureProfile () {
+      // https://developers.google.com/analytics/devguides/collection/analyticsjs/command-queue-reference#create
+      sendToGa('create', trackingId, fieldsObject)
+    }
+
+    function anonymizeIp () {
+      // https://developers.google.com/analytics/devguides/collection/analyticsjs/advanced#anonymizeip
+      sendToGa('set', 'anonymizeIp', true)
+    }
+
+    function disableAdFeatures () {
+      // https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#allowAdFeatures
+      sendToGa('set', 'allowAdFeatures', false)
+    }
+
+    function stripTitlePII () {
+      sendToGa('set', 'title', pii.stripPII(document.title))
+    }
+
+    function stripLocationPII () {
+      sendToGa('set', 'location', pii.stripPII(window.location.href))
+    }
+
+    // Support legacy cookieDomain param
+    if (typeof fieldsObject === 'string') {
+      fieldsObject = { cookieDomain: fieldsObject }
+    }
+
+    configureProfile()
+    anonymizeIp()
+    disableAdFeatures()
+    stripTitlePII()
+    stripLocationPII()
+  }
+
+  GoogleAnalyticsUniversalTracker.load = function () {
+    /* eslint-disable */
+    (function (i, s, o, g, r, a, m) { i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
+      (i[r].q = i[r].q || []).push(arguments) }, i[r].l = 1 * new Date(); a = s.createElement(o),
+                             m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
+    })(global, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga')
+    /* eslint-enable */
+  }
+
+  // https://developers.google.com/analytics/devguides/collection/analyticsjs/pages
+  GoogleAnalyticsUniversalTracker.prototype.trackPageview = function (path, title, options) {
+    var pageviewObject
+    var trackerName = ''
+
+    if (typeof path === 'string') {
+      pageviewObject = { page: path }
+    }
+
+    if (typeof title === 'string') {
+      pageviewObject = pageviewObject || {}
+      pageviewObject.title = title
+    }
+
+    // Set an options object for the pageview (e.g. transport, sessionControl)
+    // https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#transport
+    if (typeof options === 'object') {
+      pageviewObject = $.extend(pageviewObject || {}, options)
+
+      // trackerName is optional
+      if (typeof options.trackerName === 'string') {
+        trackerName = options.trackerName + '.'
+        delete options.trackerName
+      }
+    }
+
+    if (!$.isEmptyObject(pageviewObject)) {
+      sendToGa(trackerName + 'send', 'pageview', pageviewObject)
+    } else {
+      sendToGa(trackerName + 'send', 'pageview')
+    }
+  }
+
+  // https://developers.google.com/analytics/devguides/collection/analyticsjs/events
+  GoogleAnalyticsUniversalTracker.prototype.trackEvent = function (category, action, options) {
+    options = options || {}
+    var value
+    var trackerName = ''
+    var evt = {
+      hitType: 'event',
+      eventCategory: category,
+      eventAction: action
+    }
+
+    // Label is optional
+    if (typeof options.label === 'string') {
+      evt.eventLabel = options.label
+      delete options.label
+    }
+
+    // Value is optional, but when used must be an
+    // integer, otherwise the event will be invalid
+    // and not logged
+    if (options.value || options.value === 0) {
+      value = parseInt(options.value, 10)
+      if (typeof value === 'number' && !isNaN(value)) {
+        options.eventValue = value
+      }
+      delete options.value
+    }
+
+    // trackerName is optional
+    if (typeof options.trackerName === 'string') {
+      trackerName = options.trackerName + '.'
+      delete options.trackerName
+    }
+
+    // Prevents an event from affecting bounce rate
+    // https://developers.google.com/analytics/devguides/collection/analyticsjs/events#implementation
+    if (options.nonInteraction) {
+      options.nonInteraction = 1
+    }
+
+    if (typeof options === 'object') {
+      $.extend(evt, options)
+    }
+
+    sendToGa(trackerName + 'send', evt)
+  }
+
+  /*
+    https://developers.google.com/analytics/devguides/collection/analyticsjs/social-interactions
+    network – The network on which the action occurs (e.g. Facebook, Twitter)
+    action – The type of action that happens (e.g. Like, Send, Tweet)
+    target – Specifies the target of a social interaction.
+             This value is typically a URL but can be any text.
+  */
+  GoogleAnalyticsUniversalTracker.prototype.trackSocial = function (network, action, target, options) {
+    var trackingOptions = {
+      hitType: 'social',
+      socialNetwork: network,
+      socialAction: action,
+      socialTarget: target
+    }
+
+    $.extend(trackingOptions, options)
+
+    sendToGa('send', trackingOptions)
+  }
+
+  /*
+   https://developers.google.com/analytics/devguides/collection/analyticsjs/cross-domain
+   trackerId    - the UA account code to track the domain against
+   name         - name for the tracker
+   domain       - the domain to track (must be an array of strings)
+   sendPageView - optional argument which controls the legacy behaviour of sending a pageview
+                  on creation of the linked domain.
+  */
+  GoogleAnalyticsUniversalTracker.prototype.addLinkedTrackerDomain = function (trackerId, name, domain, sendPageView) {
+    sendToGa('create',
+      trackerId,
+      'auto',
+      { name: name })
+    // Load the plugin.
+    sendToGa(name + '.require', 'linker')
+
+    // Define which domains to autoLink.
+    sendToGa(name + '.linker:autoLink', domain)
+
+    sendToGa(name + '.set', 'anonymizeIp', true)
+    sendToGa(name + '.set', 'allowAdFeatures', false)
+    sendToGa(name + '.set', 'title', pii.stripPII(document.title))
+    sendToGa(name + '.set', 'location', pii.stripPII(window.location.href))
+
+    if (typeof sendPageView === 'undefined' || sendPageView === true) {
+      sendToGa(name + '.send', 'pageview')
+    }
+  }
+
+  // https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets
+  GoogleAnalyticsUniversalTracker.prototype.setDimension = function (index, value) {
+    sendToGa('set', 'dimension' + index, String(value))
+  }
+
+  function sendToGa () {
+    if (typeof global.ga === 'function') {
+      global.ga.apply(global, arguments)
+    }
+  }
+
+  GOVUK.GoogleAnalyticsUniversalTracker = GoogleAnalyticsUniversalTracker
+
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/javascripts/govuk_publishing_components/analytics/init.js

@@ -0,0 +1,48 @@
+var analyticsInit = function (gaProperty, gaPropertyCrossDomain, linkedDomains) {
+  'use strict'
+
+  var consentCookie = window.GOVUK.getConsentCookie()
+
+  var dummyAnalytics = {
+    addLinkedTrackerDomain: function () {},
+    setDimension: function () {},
+    setOptionsForNextPageView: function () {},
+    trackEvent: function () {},
+    trackPageview: function () {},
+    trackShare: function () {}
+  }
+
+  // Disable analytics by default
+  // This will be reversed below, if the consent cookie says usage cookies are allowed
+  var disabler = 'ga-disable-' + gaProperty
+  window[disabler] = true
+
+  if (consentCookie && consentCookie.usage) {
+    window[disabler] = false
+
+    // Load Google Analytics libraries
+    window.GOVUK.StaticAnalytics.load()
+
+    // Use document.domain in dev, preview and staging so that tracking works
+    // Otherwise explicitly set the domain as www.gov.uk (and not gov.uk).
+    var cookieDomain = (document.domain === 'www.gov.uk') ? '.www.gov.uk' : document.domain
+
+    // Configure profiles, setup custom vars, track initial pageview
+    var analytics = new window.GOVUK.StaticAnalytics({
+      universalId: gaProperty,
+      cookieDomain: cookieDomain,
+      allowLinker: true
+    })
+
+    // Make interface public for virtual pageviews and events
+    window.GOVUK.analytics = analytics
+
+    if (linkedDomains && linkedDomains.length > 0) {
+      window.GOVUK.analytics.addLinkedTrackerDomain(gaPropertyCrossDomain, 'govuk', linkedDomains)
+    }
+  } else {
+    window.GOVUK.analytics = dummyAnalytics
+  }
+}
+
+window.GOVUK.analyticsInit = analyticsInit

data/app/assets/javascripts/govuk_publishing_components/analytics/mailto-link-tracker.js

@@ -0,0 +1,38 @@
+;(function (global) {
+  'use strict'
+
+  var $ = global.jQuery
+  var GOVUK = global.GOVUK || {}
+
+  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
+  GOVUK.analyticsPlugins.mailtoLinkTracker = function () {
+    var mailtoLinkSelector = 'a[href^="mailto:"]'
+
+    $('body').on('click', mailtoLinkSelector, trackClickEvent)
+
+    function trackClickEvent (evt) {
+      var $link = getLinkFromEvent(evt)
+      var options = { transport: 'beacon' }
+      var href = $link.attr('href')
+      var linkText = $.trim($link.text())
+
+      if (linkText) {
+        options.label = linkText
+      }
+
+      GOVUK.analytics.trackEvent('Mailto Link Clicked', href, options)
+    }
+
+    function getLinkFromEvent (evt) {
+      var $target = $(evt.target)
+
+      if (!$target.is('a')) {
+        $target = $target.parents('a')
+      }
+
+      return $target
+    }
+  }
+
+  global.GOVUK = GOVUK
+})(window)

data/app/assets/javascripts/govuk_publishing_components/analytics/page-content.js

@@ -0,0 +1,129 @@
+/* global GOVUK, $ */
+
+(function () {
+  'use strict'
+  window.GOVUK = window.GOVUK || {}
+  var PageContent = function () { }
+
+  PageContent.getNumberOfSections = function () {
+    switch (true) {
+      case isNavigationGridPage():
+        return 1 + $('.parent-topic-contents').length
+      case isNavigationAccordionPage():
+        return $('[data-track-count="accordionSection"]').length
+      case isDocumentCollectionPage():
+        return $('.document-collection .group-title').length
+      case isMainstreamBrowsePage():
+        return $('#subsection ul:visible').length || $('#section ul').length
+      case isTopicPage():
+        return $('.topics-page nav.index-list').length
+      case isPolicyAreaPage():
+        return $('.topic section h1.label').length
+      case isFinderPage():
+      case isWhitehallFinderPage():
+      case isNavigationLeafPage():
+        // The default in finders should be one, so it's comparable with A-Z
+        // lists in other navigation pages. Request made by performance
+        // analysts.
+        return 1
+      default:
+        // It's a content page, not a "finding" page
+        var sidebarSections = $('[data-track-count="sidebarRelatedItemSection"]').length
+        var sidebarTaxons = $('[data-track-count="sidebarTaxonSection"]').length
+
+        return sidebarSections || sidebarTaxons
+    }
+  }
+
+  PageContent.getNumberOfLinks = function () {
+    switch (true) {
+      case isNavigationGridPage():
+        return $('a[data-track-category="navGridLinkClicked"]').length +
+          $('a[data-track-category="navGridLeafLinkClicked"]').length
+      case isNavigationAccordionPage():
+        return $('a[data-track-category="navAccordionLinkClicked"]').length
+      case isNavigationLeafPage():
+        return $('a[data-track-category="navLeafLinkClicked"]').length
+      case isDocumentCollectionPage():
+        return $('.document-collection .group-document-list li a').length
+      case isMainstreamBrowsePage():
+        return $('#subsection ul a:visible').length ||
+          $('#section ul a').length
+      case isTopicPage():
+        return $('.topics-page .index-list ul a').length ||
+          $('.topics-page .topics ul a').length
+      case isPolicyAreaPage():
+        return $('section.document-block a').length +
+          $('section .collection-list h2 a').length
+      case isWhitehallFinderPage():
+        return $('.document-list .document-row h3 a').length
+      case isFinderPage():
+        return $('.finder-frontend-content li.document a').length
+      default:
+        // It's a content page, not a "finding" page, count related links
+        return $('a[data-track-category="relatedLinkClicked"]').length
+    }
+  }
+
+  function getRenderingApplication () {
+    return $('meta[name="govuk:rendering-application"]').attr('content')
+  };
+
+  function getFormat () {
+    return $('meta[name="govuk:format"]').attr('content')
+  };
+
+  function getNavigationPageType () {
+    return $('meta[name="govuk:navigation-page-type"]').attr('content')
+  };
+
+  function isNavigationGridPage () {
+    return getRenderingApplication() === 'collections' &&
+      getFormat() === 'taxon' &&
+      getNavigationPageType() === 'grid'
+  };
+
+  function isNavigationAccordionPage () {
+    return getRenderingApplication() === 'collections' &&
+      getFormat() === 'taxon' &&
+      getNavigationPageType() === 'accordion'
+  };
+
+  function isNavigationLeafPage () {
+    return getRenderingApplication() === 'collections' &&
+      getFormat() === 'taxon' &&
+      getNavigationPageType() === 'leaf'
+  };
+
+  function isMainstreamBrowsePage () {
+    return getRenderingApplication() === 'collections' &&
+      getFormat() === 'mainstream_browse_page'
+  };
+
+  function isTopicPage () {
+    return getRenderingApplication() === 'collections' &&
+      getFormat() === 'topic'
+  };
+
+  function isPolicyAreaPage () {
+    return getRenderingApplication() === 'whitehall' &&
+      getFormat() === 'placeholder_policy_area'
+  };
+
+  function isDocumentCollectionPage () {
+    return getRenderingApplication() === 'government-frontend' &&
+      getFormat() === 'document_collection'
+  };
+
+  function isFinderPage () {
+    return getRenderingApplication() === 'finder-frontend' &&
+      getFormat() === 'finder'
+  };
+
+  function isWhitehallFinderPage () {
+    return getRenderingApplication() === 'whitehall' &&
+      getFormat() === 'finder'
+  };
+
+  GOVUK.PageContent = PageContent
+})()