sfc-utils 1.4.165 → 1.4.167

package/components/helpers/utilfunctions.mjs

@@ -1,6 +1,7 @@
 import { getBlueconic } from "../../blueconic";
 import { getBrands3 } from "../../brands3";
 import { appCheck, blendHDN, getSettings } from "../../index";
+import systemSettings from "../../../../src/data/system_settings.sheet.json";
 
 const currentEnv = process.env.GATSBY_DEPLOY_ENV;
 
@@ -202,9 +203,8 @@ function trackEvent(
   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 systemSettingsObj = systemSettings[0];
+  const elementVariant = `${systemSettingsObj.Repo}|${systemSettingsObj.Project_Type}`;
   const linkUrl = `${storySettings.PROJECT.SUBFOLDER}/${storySettings.PROJECT.SLUG}`;
   const urlHash = window.HDN.dataLayer.visit.urlHash;
 
@@ -232,4 +232,53 @@ function trackEvent(
   });
 }
 
-export { debounce, appendLayoutScripts, formatHDN, getFigureWidth, trackEvent };
+const trackEmbedEvent = (
+  eventType,
+  elementName = null,
+  elementContent = null,
+  elementText = null
+) => {
+  const storySettings = getSettings();
+  const systemSettingsObj = systemSettings[0];
+  const elementVariant = `${systemSettingsObj.Repo}|${systemSettingsObj.Project_Type}`;
+  const linkUrl = `${storySettings.Year}/${storySettings.Slug}`;
+
+  let event;
+  if (eventType === "Click") {
+    event = "hnp_click";
+  } else if (eventType === "Impression") {
+    event = "hnp_impression";
+  }
+
+  var embed_event = {
+    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?
+    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)
+    iframe_event: true,
+  };
+
+  if (typeof window !== "undefined") {
+    window.parent.postMessage(embed_event, "*"); // Sends event to parent page
+  }
+
+  //TO TEST: I think this needs to go directly into the iframe embed code?
+  //window.addEventListener("message", (message) => {if (message.data.iframe_event) {var event = message.data;dataLayer.push(event);}});
+};
+
+export {
+  debounce,
+  appendLayoutScripts,
+  formatHDN,
+  getFigureWidth,
+  trackEvent,
+  trackEmbedEvent,
+};

package/package.json

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