sfc-utils 1.4.164 → 1.4.165

package/components/helpers/utilfunctions.mjs

@@ -1,6 +1,6 @@
 import { getBlueconic } from "../../blueconic";
 import { getBrands3 } from "../../brands3";
-import { appCheck, blendHDN } from "../../index";
+import { appCheck, blendHDN, getSettings } from "../../index";
 
 const currentEnv = process.env.GATSBY_DEPLOY_ENV;
 
@@ -195,4 +195,41 @@ function getFigureWidth(maxWidth) {
   }
 }
 
-export { debounce, appendLayoutScripts, formatHDN, getFigureWidth };
+function trackEvent(
+  eventType,
+  elementName = null,
+  elementContent = null,
+  elementText = null
+) {
+  const storySettings = getSettings();
+  // [systemSettings] = require("../../../../src/data/story_settings.sheet.json");
+  const systemSettings = require("../../../../src/data/system_settings.sheet.json");
+  const elementVariant = `${systemSettings.Repo}|${systemSettings.Project_Type}`;
+  const linkUrl = `${storySettings.PROJECT.SUBFOLDER}/${storySettings.PROJECT.SLUG}`;
+  const urlHash = window.HDN.dataLayer.visit.urlHash;
+
+  let event;
+  if (eventType === "Click") {
+    event = "hnp_click";
+  } else if (eventType === "Impression") {
+    event = "hnp_impression";
+  }
+
+  window.dataLayer.push({
+    event: event, //REQUIRED; Fixed value
+    element_name: elementName, //REQUIRED; One of a list of tags/types of elements on the page (e.g. Button, Map, Tooltip, ToggleButton, Dropdown). TO DO: create a consistent list of this
+    element_content: elementContent, //REQUIRED; One of a list of subtypes of element types (e.g. Button) on the page (e.g. Geocoder, Searchbar, Prev/Next). TO DO: create a consistent list of this, maybe
+    element_variant: elementVariant, //REQUIRED; Template type (e.g. custom-repo-name|gatsby) (top-list|plat)
+    element_text: elementText, //REQUIRED; What was the actual text or alt-text of the thing that was clicked (InnerHTML or id specific to that element)
+    component_type: null, //OPTIONAL; If BC components uses Storybook components: Organism or molecule from storybook (whatever the highest level component from storybook that the clicked on item belongs to)
+    component_subtype: null, //OPTIONAL; If BC components uses Storybook components: Variant of the component_type from storybook
+    component_detail: null, //OPTIONAL; If BC components uses Storybook components: WCM TITLE|Position|Atom from storybook. This pipe-delimited structure is required. When values are not available for a given position, leave the position blank so the order of information doesn't change. e.g. something|| or something||something_else
+    zone: null, // OPTIONAL; For WCM components. The WCM zone the component was displayed in.
+    link_url: linkUrl, //REQUIRED; What is the slug of the project?
+    url_hash: urlHash, // REQUIRED;
+    outbound: false, //REQUIRED; Boolean indicating whether the link that was clicked took the user to a different domain.
+    source_system: "devhub", //REQUIRED; What platform powered the element? One of cookie, blueconic, realm, castle, devhub, treg, legacy obits, sailthru, casper, wordpress, hnp-jwplayer, event_data_service (other options required discussion with BI/DE)
+  });
+}
+
+export { debounce, appendLayoutScripts, formatHDN, getFigureWidth, trackEvent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sfc-utils",
-  "version": "1.4.164",
+  "version": "1.4.165",
   "author": "ewagstaff <evanjwagstaff@gmail.com>",
   "dependencies": {
     "archieml": "^0.4.2",