govuk_publishing_components 32.1.0 → 35.0.0

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-form-tracker.js

@@ -0,0 +1,121 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  'use strict'
+
+  function Ga4FormTracker (module) {
+    this.module = module
+    this.trackingTrigger = 'data-ga4-form' // elements with this attribute get tracked
+    this.includeTextInputValues = this.module.hasAttribute('data-ga4-form-include-text')
+    this.redacted = false
+  }
+
+  Ga4FormTracker.prototype.init = function () {
+    var consentCookie = window.GOVUK.getConsentCookie()
+
+    if (consentCookie && consentCookie.settings) {
+      this.startModule()
+    } else {
+      this.startModule = this.startModule.bind(this)
+      window.addEventListener('cookie-consent', this.startModule)
+    }
+  }
+
+  // triggered by cookie-consent event, which happens when users consent to cookies
+  Ga4FormTracker.prototype.startModule = function () {
+    if (window.dataLayer) {
+      this.module.addEventListener('submit', this.trackFormSubmit.bind(this))
+    }
+  }
+
+  Ga4FormTracker.prototype.trackFormSubmit = function (event) {
+    var target = window.GOVUK.analyticsGa4.core.trackFunctions.findTrackingAttributes(event.target, this.trackingTrigger)
+    if (target) {
+      try {
+        var data = target.getAttribute(this.trackingTrigger)
+        data = JSON.parse(data)
+      } catch (e) {
+        // if there's a problem with the config, don't start the tracker
+        console.warn('GA4 configuration error: ' + e.message, window.location)
+        return
+      }
+
+      var formInputs = this.getFormInputs()
+      var formData = this.getInputValues(formInputs)
+      data.text = this.combineGivenAnswers(formData) || 'No answer given'
+
+      var schemas = new window.GOVUK.analyticsGa4.Schemas()
+      var schema = schemas.mergeProperties(data, 'event_data')
+      window.GOVUK.analyticsGa4.core.sendData(schema)
+    }
+  }
+
+  Ga4FormTracker.prototype.getFormInputs = function () {
+    var inputs = []
+    var labels = this.module.querySelectorAll('label')
+
+    for (var i = 0; i < labels.length; i++) {
+      var label = labels[i]
+      var labelFor = label.getAttribute('for')
+      var input = false
+      if (labelFor) {
+        input = this.module.querySelector('[id=' + labelFor + ']')
+      } else {
+        input = label.querySelector('input')
+      }
+      inputs.push({
+        input: input,
+        label: label
+      })
+    }
+    return inputs
+  }
+
+  Ga4FormTracker.prototype.getInputValues = function (inputs) {
+    for (var i = inputs.length - 1; i >= 0; i--) {
+      var input = inputs[i]
+      var elem = input.input
+      var labelText = input.label.innerText || input.label.textContent
+      var inputType = elem.getAttribute('type')
+      var inputNodename = elem.nodeName
+
+      if (inputType === 'checkbox' && elem.checked) {
+        input.answer = labelText
+      } else if (inputNodename === 'SELECT' && elem.options[elem.selectedIndex].value) {
+        input.answer = elem.options[elem.selectedIndex].text
+      } else if ((inputType === 'text' || inputType === 'search') && elem.value) {
+        if (this.includeTextInputValues) {
+          var PIIRemover = new window.GOVUK.analyticsGa4.PIIRemover()
+          input.answer = PIIRemover.stripPIIWithOverride(elem.value, true, true)
+        } else {
+          this.redacted = true
+        }
+      } else if (inputType === 'radio' && elem.checked) {
+        input.answer = labelText
+      } else {
+        // remove the input from those gathered as it has no value
+        inputs.splice(i, 1)
+      }
+    }
+    return inputs
+  }
+
+  Ga4FormTracker.prototype.combineGivenAnswers = function (data) {
+    var answers = []
+    for (var i = 0; i < data.length; i++) {
+      var answer = data[i].answer
+      if (answer) {
+        answers.push(answer)
+      }
+    }
+    if (this.redacted) {
+      answers.push('[REDACTED]')
+    }
+
+    answers = answers.join(',')
+    return answers
+  }
+
+  Modules.Ga4FormTracker = Ga4FormTracker
+})(window.GOVUK.Modules)

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

@@ -1,331 +1,112 @@
-// = require govuk/vendor/polyfills/Element/prototype/closest.js
+//= require ../vendor/polyfills/closest.js
 window.GOVUK = window.GOVUK || {}
-window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {}
-window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analyticsModules || {};
+window.GOVUK.Modules = window.GOVUK.Modules || {};
 
-(function (analyticsModules) {
+(function (Modules) {
   'use strict'
 
-  var Ga4LinkTracker = {
-    init: function (config) {
-      if (window.dataLayer) {
-        config = config || {}
-        this.internalDomains = config.internalDomains || []
-        this.internalDomains.push(this.getHostname())
-        this.appendDomainsWithoutWWW(this.internalDomains)
-        this.internalDownloadPaths = config.internalDownloadPaths || ['/government/uploads/']
-        this.dedicatedDownloadDomains = config.dedicatedDownloadDomains || ['assets.publishing.service.gov.uk']
-        this.appendDomainsWithoutWWW(this.dedicatedDownloadDomains)
-        this.handleClick = this.handleClick.bind(this)
-        this.handleMousedown = this.handleMousedown.bind(this)
+  function Ga4LinkTracker (module) {
+    this.module = module
+    this.trackingTrigger = 'data-ga4-link' // elements with this attribute get tracked
+    this.trackLinksOnly = this.module.hasAttribute('data-ga4-track-links-only')
+    this.limitToElementClass = this.module.getAttribute('data-ga4-limit-to-element-class')
+  }
 
-        if (!config.disableListeners) {
-          document.querySelector('body').addEventListener('click', this.handleClick)
-          document.querySelector('body').addEventListener('contextmenu', this.handleClick)
-          document.querySelector('body').addEventListener('mousedown', this.handleMousedown)
-        }
-      }
-    },
+  Ga4LinkTracker.prototype.init = function () {
+    var consentCookie = window.GOVUK.getConsentCookie()
 
-    stopTracking: function () {
-      document.querySelector('body').removeEventListener('click', this.handleClick)
-      document.querySelector('body').removeEventListener('contextmenu', this.handleClick)
-      document.querySelector('body').removeEventListener('mousedown', this.handleMousedown)
-    },
+    if (consentCookie && consentCookie.settings) {
+      this.startModule()
+    } else {
+      this.startModule = this.startModule.bind(this)
+      window.addEventListener('cookie-consent', this.startModule)
+    }
+  }
 
-    handleClick: function (event) {
-      var element = event.target
+  // triggered by cookie-consent event, which happens when users consent to cookies
+  Ga4LinkTracker.prototype.startModule = function () {
+    if (window.dataLayer) {
+      this.handleClick = this.handleClick.bind(this)
+      this.handleMousedown = this.handleMousedown.bind(this)
 
-      if (element.tagName !== 'A') {
-        element = element.closest('a')
-      }
+      this.module.addEventListener('click', this.handleClick)
+      this.module.addEventListener('contextmenu', this.handleClick)
+      this.module.addEventListener('mousedown', this.handleMousedown)
 
-      if (!element) {
-        return
+      if (this.module.hasAttribute('data-ga4-set-indexes')) {
+        window.GOVUK.analyticsGa4.core.trackFunctions.setIndexes(this.module)
       }
+    }
+  }
 
-      var href = element.getAttribute('href')
-
-      if (!href) {
-        return
-      }
-      var clickData = {}
-      var linkAttributes = element.getAttribute('data-ga4-link')
-      if (linkAttributes) {
-        clickData = JSON.parse(linkAttributes)
-
-        /* Since external links can't be determined in the template, we use populated-via-js as a signal
-        for our JavaScript to determine this value. */
-        if (clickData.external === 'populated-via-js' && clickData.url) {
-          clickData.external = this.isExternalLink(clickData.url) ? 'true' : 'false'
-        }
-
-        if (clickData.method === 'populated-via-js') {
-          clickData.method = this.getClickType(event)
-        }
-
-        if (clickData.index) {
-          clickData.index = parseInt(clickData.index)
-        }
-
-        if (clickData.index_total) {
-          clickData.index_total = parseInt(clickData.index_total)
-        }
-      } else if (this.isMailToLink(href)) {
-        clickData.event_name = 'navigation'
-        clickData.type = 'email'
-        clickData.external = 'true'
-        clickData.url = href
-        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
-        clickData.method = this.getClickType(event)
-      } else if (this.isDownloadLink(href)) {
-        clickData.event_name = 'file_download'
-        clickData.type = this.isPreviewLink(href) ? 'preview' : 'generic download'
-        clickData.external = this.isExternalLink(href) ? 'true' : 'false'
-        clickData.url = href
-        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
-        clickData.method = this.getClickType(event)
-      } else if (this.isExternalLink(href)) {
-        clickData.event_name = 'navigation'
-        clickData.type = 'generic link'
-        clickData.external = 'true'
-        clickData.url = href
-        clickData.text = this.removeLinesAndExtraSpaces(element.textContent)
-        clickData.method = this.getClickType(event)
+  Ga4LinkTracker.prototype.handleClick = function (event) {
+    var target = event.target
+    if (!this.trackLinksOnly) {
+      this.trackClick(event)
+    } else if (this.trackLinksOnly && target.closest('a')) {
+      if (!this.limitToElementClass) {
+        this.trackClick(event)
+      } else if (target.closest('.' + this.limitToElementClass)) {
+        this.trackClick(event)
       }
+    }
+  }
 
-      if (Object.keys(clickData).length > 0) {
-        if (clickData.url) {
-          clickData.url = this.removeCrossDomainParams(clickData.url)
-          clickData.link_domain = this.populateLinkDomain(clickData.url)
-          clickData.link_path_parts = this.populateLinkPathParts(clickData.url)
-        }
-
-        var schema = new window.GOVUK.analyticsGa4.Schemas().eventSchema()
-        schema.event = 'event_data'
-
-        // get attributes from the clickData object to send to GA
-        // only allow it if it already exists in the schema
-        for (var property in clickData) {
-          if (property in schema.event_data) {
-            schema.event_data[property] = clickData[property]
-          }
-        }
+  Ga4LinkTracker.prototype.handleMousedown = function (event) {
+    // 1 = middle mouse button
+    if (event.button === 1) {
+      this.handleClick(event)
+    }
+  }
 
-        window.GOVUK.analyticsGa4.core.sendData(schema)
-      }
-    },
+  Ga4LinkTracker.prototype.trackClick = function (event) {
+    var element = event.target
+    var PIIRemover = new window.GOVUK.analyticsGa4.PIIRemover()
 
-    populateLinkPathParts: function (href) {
-      var path = ''
-      if (this.hrefIsRelative(href) || this.isMailToLink(href)) {
-        path = href
-      } else {
-        // This regex matches a protocol and domain name at the start of a string such as https://www.gov.uk, http://gov.uk, //gov.uk
-        path = href.replace(/^(http:||https:)?(\/\/)([^\/]*)/, '') // eslint-disable-line no-useless-escape
-      }
+    // don't track this link if it's already being tracked by the ecommerce tracker
+    if (element.closest('[data-ga4-ecommerce-path]')) {
+      return
+    }
 
-      if (path === '/' || path.length === 0) {
+    var target = window.GOVUK.analyticsGa4.core.trackFunctions.findTrackingAttributes(event.target, this.trackingTrigger)
+    if (target) {
+      try {
+        var data = target.getAttribute(this.trackingTrigger)
+        data = JSON.parse(data)
+      } catch (e) {
+        // if there's a problem with the config, don't start the tracker
+        console.error('GA4 configuration error: ' + e.message, window.location)
         return
       }
 
-      /*
-      This will create an object with 5 keys that are indexes ("1", "2", etc.)
-      The values will be each part of the link path split every 100 characters, or undefined.
-      For example: {"1": "/hello/world/etc...", "2": "/more/path/text...", "3": undefined, "4": undefined, "5": undefined}
-      Undefined values are needed to override the persistent object in GTM so that any values from old pushes are overwritten.
-      */
-      var parts = path.match(/.{1,100}/g)
-      var obj = {}
-      for (var i = 0; i < 5; i++) {
-        obj[(i + 1).toString()] = parts[i]
-      }
-      return obj
-    },
-
-    populateLinkDomain: function (href) {
-      // We always want mailto links to have an undefined link_domain
-      if (this.isMailToLink(href)) {
-        return undefined
-      }
+      var text = data.text || event.target.textContent
+      data.text = window.GOVUK.analyticsGa4.core.trackFunctions.removeLinesAndExtraSpaces(text)
+      var url = data.url || this.findLink(event.target).getAttribute('href')
+      data.url = window.GOVUK.analyticsGa4.core.trackFunctions.removeCrossDomainParams(PIIRemover.stripPII(url))
+      data.link_domain = window.GOVUK.analyticsGa4.core.trackFunctions.populateLinkDomain(data.url)
+      data.link_path_parts = window.GOVUK.analyticsGa4.core.trackFunctions.populateLinkPathParts(data.url)
+      data.method = window.GOVUK.analyticsGa4.core.trackFunctions.getClickType(event)
+      data.external = window.GOVUK.analyticsGa4.core.trackFunctions.isExternalLink(data.url) ? 'true' : 'false'
+      data.index = event.target.getAttribute('data-ga4-index') ? parseInt(event.target.getAttribute('data-ga4-index')) : data.index || undefined
+      data.index = window.GOVUK.analyticsGa4.core.trackFunctions.createIndexObject(data.index)
 
-      if (this.hrefIsRelative(href)) {
-        return this.getProtocol() + '//' + this.getHostname()
-      } else {
-        // This regex matches a protocol and domain name at the start of a string such as https://www.gov.uk, http://gov.uk, //gov.uk
-        var domainRegex = /^(http:||https:)?(\/\/)([^\/]*)/ // eslint-disable-line no-useless-escape
-        var domain = domainRegex.exec(href)[0]
-        return domain
+      if (data.type === 'smart answer' && data.action === 'change response') {
+        data.section = PIIRemover.stripPIIWithOverride(data.section, true, true)
       }
-    },
-
-    appendDomainsWithoutWWW: function (domainsArrays) {
-      // Add domains with www. removed, in case site hrefs are marked up without www. included.
-      for (var i = 0; i < domainsArrays.length; i++) {
-        var domain = domainsArrays[i]
-        if (this.stringStartsWith(domain, 'www.')) {
-          var domainWithoutWww = domain.replace('www.', '')
-          domainsArrays.push(domainWithoutWww)
-        }
-      }
-    },
-
-    removeLinesAndExtraSpaces: function (text) {
-      text = text.trim()
-      text = text.replace(/(\r\n|\n|\r)/gm, ' ') // Replace line breaks with 1 space
-      text = text.replace(/\s+/g, ' ') // Replace instances of 2+ spaces with 1 space
-      return text
-    },
 
-    getClickType: function (event) {
-      switch (event.type) {
-        case 'click':
-          if (event.ctrlKey) {
-            return 'ctrl click'
-          } else if (event.metaKey) {
-            return 'command/win click'
-          } else if (event.shiftKey) {
-            return 'shift click'
-          } else {
-            return 'primary click'
-          }
-        case 'mousedown':
-          return 'middle click'
-        case 'contextmenu':
-          return 'secondary click'
-      }
-    },
-
-    handleMousedown: function (event) {
-      // 1 = middle mouse button
-      if (event.button === 1) {
-        this.handleClick(event)
-      }
-    },
-
-    isMailToLink: function (href) {
-      return href.substring(0, 7) === 'mailto:'
-    },
-
-    isDownloadLink: function (href) {
-      if (this.isInternalLink(href) && this.hrefPointsToDownloadPath(href)) {
-        return true
-      }
-
-      var result = false
-      for (var i = 0; i < this.dedicatedDownloadDomains.length; i++) {
-        var downloadDomain = this.dedicatedDownloadDomains[i]
-        if (this.hrefPointsToDomain(href, downloadDomain)) {
-          result = true
-        }
-      }
-      return result
-    },
-
-    isInternalLink: function (href) {
-      if (this.hrefIsRelative(href) || this.hrefIsAnchor(href)) {
-        return true
-      }
-      var result = false
-      for (var i = 0; i < this.internalDomains.length; i++) {
-        var internalDomain = this.internalDomains[i]
-        if (this.hrefPointsToDomain(href, internalDomain)) {
-          result = true
-        }
-      }
-      return result
-    },
-
-    isExternalLink: function (href) {
-      return !this.isInternalLink(href)
-    },
-
-    isPreviewLink: function (href) {
-      /*  Regex looks for:
-      1. The file extension period (the character '.')
-      2. any alphanumeric characters (so we can match any file type such as jpg, pdf, mp4.)
-      3. the presence of '/preview'.
-      For example, .csv/preview or .mp4/preview will be matched.
-      Regex is used over JS string methods as this should work with anchor links, query string parameters and files that may have 'preview' in their name.
-      */
-      var previewRegex = /\.\w+\/preview/i
-      return previewRegex.test(href)
-    },
-
-    hrefPointsToDomain: function (href, domain) {
-      /* Add a trailing slash to prevent an edge case such
-      as the href www.gov.uk.domain.co.uk being detected as an internal link,
-      if we were checking for 'www.gov.uk' instead of 'www.gov.uk/' */
-      if (domain.substring(domain.length) !== '/') {
-        domain = domain + '/'
-      }
-
-      /* If the href doesn't end in a slash, we add one.
-      This fixes an edge case where the <a href> is exactly `https://www.gov.uk`
-      but these checks would only look for `https://www.gov.uk/` */
-      if (href.substring(href.length) !== '/') {
-        href = href + '/'
-      }
-      var httpDomain = 'http://' + domain
-      var httpsDomain = 'https://' + domain
-      var schemaRelativeDomain = '//' + domain
-      return this.stringStartsWith(href, domain) ||
-      this.stringStartsWith(href, httpDomain) ||
-      this.stringStartsWith(href, httpsDomain) ||
-      this.stringStartsWith(href, schemaRelativeDomain)
-    },
-
-    hrefPointsToDownloadPath: function (href) {
-      var result = false
-      for (var i = 0; i < this.internalDownloadPaths.length; i++) {
-        var internalDownloadPath = this.internalDownloadPaths[i]
-        if (href.indexOf(internalDownloadPath) !== -1) {
-          result = true
-        }
-      }
-      return result
-    },
-
-    stringStartsWith: function (string, stringToFind) {
-      return string.substring(0, stringToFind.length) === stringToFind
-    },
-
-    stringEndsWith: function (string, stringToFind) {
-      return string.substring(string.length - stringToFind.length, string.length) === stringToFind
-    },
-
-    hrefIsRelative: function (href) {
-      // Checks that a link is relative, but is not a protocol relative url
-      return href[0] === '/' && href[1] !== '/'
-    },
-
-    hrefIsAnchor: function (href) {
-      return href[0] === '#'
-    },
-
-    getHostname: function () {
-      return window.location.hostname
-    },
-
-    getProtocol: function () {
-      return window.location.protocol
-    },
-
-    removeCrossDomainParams: function (href) {
-      if (href.indexOf('_ga') !== -1 || href.indexOf('_gl') !== -1) {
-        // _ga & _gl are values needed for cross domain tracking, but we don't want them included in our click tracking.
-        href = href.replaceAll(/_g[al]=([^&]*)/g, '')
+      var schemas = new window.GOVUK.analyticsGa4.Schemas()
+      var schema = schemas.mergeProperties(data, 'event_data')
+      window.GOVUK.analyticsGa4.core.sendData(schema)
+    }
+  }
 
-        // The following code cleans up inconsistencies such as gov.uk/&&, gov.uk/?&hello=world, gov.uk/?, and gov.uk/&.
-        href = href.replaceAll(/(&&)+/g, '&')
-        href = href.replace('?&', '?')
-        if (this.stringEndsWith(href, '?') || this.stringEndsWith(href, '&')) {
-          href = href.substring(0, href.length - 1)
-        }
-      }
-      return href
+  Ga4LinkTracker.prototype.findLink = function (target) {
+    if (target.tagName === 'A') {
+      return target
+    } else {
+      return target.closest('a')
     }
   }
 
-  analyticsModules.Ga4LinkTracker = Ga4LinkTracker
-})(window.GOVUK.analyticsGa4.analyticsModules)
+  Modules.Ga4LinkTracker = Ga4LinkTracker
+})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-page-views.js

@@ -27,12 +27,12 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
             schema_name: this.getMetaContent('schema-name'),
             content_id: this.getMetaContent('content-id'),
 
-            section: this.getMetaContent('section'),
-            taxon_slug: this.getMetaContent('taxon-slug'),
-            taxon_id: this.getMetaContent('taxon-id'),
-            themes: this.getMetaContent('themes'),
-            taxon_slugs: this.getMetaContent('taxon-slugs'),
-            taxon_ids: this.getMetaContent('taxon-ids'),
+            browse_topic: this.getMetaContent('section'),
+            taxonomy_level1: this.getMetaContent('themes'),
+            taxonomy_main: this.getMetaContent('taxon-slug'),
+            taxonomy_main_id: this.getMetaContent('taxon-id'),
+            taxonomy_all: this.splitLongMetaContent('taxon-slugs'),
+            taxonomy_all_ids: this.splitLongMetaContent('taxon-ids'),
 
             language: this.getLanguage(),
             history: this.getHistory(),
@@ -106,6 +106,13 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       return (withdrawn === 'withdrawn') ? 'true' : 'false'
     },
 
+    splitLongMetaContent: function (metatag) {
+      var tag = this.getMetaContent(metatag)
+      if (tag) {
+        return window.GOVUK.analyticsGa4.core.trackFunctions.splitStringIntoParts(tag)
+      }
+    },
+
     // return only the date from given timestamps of the form
     // 2022-03-28T19:11:00.000+00:00
     stripTimeFrom: function (value) {

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-schemas.js

@@ -23,11 +23,41 @@
         external: this.undefined,
         method: this.undefined,
         link_domain: this.undefined,
-        link_path_parts: this.undefined
+        link_path_parts: this.undefined,
+        tool_name: this.undefined
       }
     }
   }
 
+  Schemas.prototype.ecommerceSchema = function () {
+    return {
+      event: this.undefined,
+      search_results: {
+        event_name: this.undefined,
+        term: this.undefined,
+        sort: this.undefined,
+        results: this.undefined,
+        ecommerce: {
+          items: []
+        }
+      },
+      event_data: this.undefined
+    }
+  }
+
+  // get attributes from the data attribute to send to GA
+  // only allow it if it already exists in the schema
+  Schemas.prototype.mergeProperties = function (data, eventAttribute) {
+    var schema = this.eventSchema()
+    schema.event = eventAttribute
+    for (var property in data) {
+      if (property in schema.event_data) {
+        schema.event_data[property] = data[property]
+      }
+    }
+    return schema
+  }
+
   GOVUK.analyticsGa4 = GOVUK.analyticsGa4 || {}
   GOVUK.analyticsGa4.Schemas = Schemas
 

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-smart-answer-results-tracker.js

@@ -0,0 +1,57 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {}
+window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
+
+(function (Modules) {
+  'use strict'
+
+  function Ga4SmartAnswerResultsTracker (module) {
+    this.module = module
+  }
+
+  Ga4SmartAnswerResultsTracker.prototype.init = function () {
+    var consentCookie = window.GOVUK.getConsentCookie()
+
+    if (consentCookie && consentCookie.settings) {
+      this.startModule()
+    } else {
+      this.startModule = this.startModule.bind(this)
+      window.addEventListener('cookie-consent', this.startModule)
+    }
+  }
+
+  // triggered by cookie-consent event, which happens when users consent to cookies
+  Ga4SmartAnswerResultsTracker.prototype.startModule = function () {
+    // only run this code if the dataLayer exists and an element with a data-ga4-ecommerce-path
+    // attribute exists as this indicates that ecommerce tracking is required
+    if (window.dataLayer && this.module.querySelector('[data-ga4-ecommerce-path]')) {
+      this.trackResults()
+      this.module.addEventListener('click', this.handleClick.bind(this))
+    }
+  }
+
+  Ga4SmartAnswerResultsTracker.prototype.trackResults = function () {
+    var ecommerceSchema = window.GOVUK.analyticsGa4.core.ecommerceHelperFunctions.populateEcommerceSchema({
+      element: this.module,
+      resultsId: 'ga4-ecommerce-result-count'
+    })
+
+    window.GOVUK.analyticsGa4.core.ecommerceHelperFunctions.clearEcommerceObject()
+    window.GOVUK.analyticsGa4.core.sendData(ecommerceSchema)
+  }
+
+  Ga4SmartAnswerResultsTracker.prototype.handleClick = function (event) {
+    if (event.target.getAttribute('data-ga4-ecommerce-path')) {
+      var ecommerceSchema = window.GOVUK.analyticsGa4.core.ecommerceHelperFunctions.populateEcommerceSchema({
+        element: this.module,
+        resultsId: 'ga4-ecommerce-result-count',
+        event: event
+      })
+
+      window.GOVUK.analyticsGa4.core.ecommerceHelperFunctions.clearEcommerceObject()
+      window.GOVUK.analyticsGa4.core.sendData(ecommerceSchema)
+    }
+  }
+
+  Modules.Ga4SmartAnswerResultsTracker = Ga4SmartAnswerResultsTracker
+})(window.GOVUK.Modules)