sfc-utils 1.4.203 → 1.4.204

package/components/helpers/utilfunctions.mjs

@@ -200,40 +200,33 @@ function trackEvent(
     event = "hnp_impression";
   }
 
+  const baseEvent = {
+    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)
+  };
+
   if (window.dataLayer) {
     // this is NOT an embed, so push to the dataLayer
     const urlHash = window.HDN.dataLayer?.visit?.urlHash;
 
     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?
+      ...baseEvent,
       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)
     });
   } else {
     // this IS an embed, so use this special logic
     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)
+      ...baseEvent,
       iframe_event: true,
     };
 

package/package.json

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

package/settings.js

@@ -32,8 +32,8 @@ let getSettings = function () {
   try {
     try {
       [storySettings] = require("../../src/data/story_settings.sheet.json");
-      // Uncomment line below and comment out line above if testing from example folder in utils
-      // [storySettings] = require("./example/src/data/story_settings.sheet.json")
+      // Uncomment line below and comment out line above if testing against a local story settings fixture
+      // [storySettings] = require("./src/data/story_settings.sheet.json")
 
       // If we got story_settings, try structuring the AUTHORS object
       let authorNames = [];

package/example/.prettierrc

@@ -1,5 +0,0 @@
-{
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "es5"
-}

package/example/README.md

@@ -1,8 +0,0 @@
-# {%= app_slug %}
-
-{%= github_desc %}
-
-View the live project: [{%= project_url %}]({%= project_url %})
-
-This project was built with the SFC Newsapp template. For instructions on how to use this template, refer to [the template README](https://github.com/sfchronicle/gatsby-newsapp))
-

package/example/gatsby-config.js

@@ -1,137 +0,0 @@
-// Add SFC utils
-const { getBrands3 } = require('../index')
-const { getSettings } = require('./tempsettings')
-const { DateTime } = require('luxon')
-
-let settings = getSettings()
-
-let marketKeyArray = [
-  { markets: ['SFC'], zone: 'America/Los_Angeles' },
-  {
-    markets: ['Houston', 'SanAntonio', 'Texcom', 'Austin','Dallas'],
-    zone: 'America/Chicago',
-  },
-  { markets: ['Albany', 'CT', 'Midcom'], zone: 'America/New_York' },
-]
-
-let currentZone
-// Find the current market in the array
-for (let region in marketKeyArray) {
-  let thisRegion = marketKeyArray[region]
-  if (thisRegion.markets.includes(settings.PROJECT.MARKET_KEY)) {
-    currentZone = thisRegion.zone
-  }
-}
-// If we don't have a match, that means we have an invalid market key
-if (!currentZone) {
-  console.error(
-    'Invalid or undefined MARKET_KEY! See the _key_explainer in project-config to see valid values.'
-  )
-  process.exit(1)
-}
-
-// Create computer pub and mod dates
-const dt = DateTime.fromFormat(settings.PROJECT.DATE, 'MMMM d, y h:mm a', {
-  zone: currentZone,
-})
-// Convert date to computer-readable time
-const computerPubDate = dt.toISO()
-settings.PROJECT.ISO_PUBDATE = computerPubDate
-
-// If MOD_DATE does not exist, set var to pubdate
-let computerModDate = ''
-if (
-  typeof settings.PROJECT.MOD_DATE !== 'undefined' &&
-  settings.PROJECT.MOD_DATE
-) {
-  const dt2 = DateTime.fromFormat(
-    settings.PROJECT.MOD_DATE,
-    'MMMM d, y h:mm a',
-    { zone: currentZone }
-  )
-  computerModDate = dt2.toISO()
-} else {
-  // Fallback to creation date
-  computerModDate = computerPubDate
-}
-settings.PROJECT.ISO_MODDATE = computerModDate
-
-//Set get the current env var
-const currentEnv = process.env.GATSBY_DEPLOY_ENV
-console.log('Current environment: ' + currentEnv)
-
-// Handle test prefix
-// TODO: Once we embrace the new URL, we can delete this check and hardcode /projects
-let projectsPrefix = ''
-if (settings.PROJECT.SUBFOLDER.toString().indexOf('projects/') === 0) {
-  projectsPrefix = '/projects'
-}
-// Set the path prefix for the given deploy (ignored for dev)
-let pathPrefix = '/projects/test-proj/' + settings.PROJECT.SLUG
-if (currentEnv === 'development') {
-  pathPrefix = '/'
-}
-if (currentEnv === 'app') {
-  pathPrefix = projectsPrefix + '/app/' + settings.PROJECT.SLUG
-}
-if (currentEnv === 'production') {
-  pathPrefix =
-    '/' +
-    settings.PROJECT.SUBFOLDER +
-    settings.PROJECT.OPT_SLASH +
-    settings.PROJECT.SLUG
-}
-
-let plugins = [
-  'gatsby-plugin-react-helmet',
-  'gatsby-transformer-json',
-  {
-    resolve: 'gatsby-plugin-less',
-    options: {
-      lessOptions: {
-        modifyVars: getBrands3(settings.PROJECT.MARKET_KEY).styles,
-      },
-    },
-  },
-  {
-    resolve: 'gatsby-plugin-html-attributes',
-    options: {
-      lang: 'en',
-    },
-  },
-  {
-    resolve: `gatsby-source-filesystem`,
-    options: {
-      name: `projectData`,
-      path: `${__dirname}/src/data/`,
-    },
-  },
-  {
-    resolve: 'gatsby-plugin-webpack-bundle-analyser-v2',
-    options: {
-      production: true,
-      disable: !process.env.ANALYZE_BUNDLE_SIZE,
-      generateStatsFile: true,
-      analyzerMode: 'static',
-    },
-  },
-  // this (optional) plugin enables Progressive Web App + Offline functionality
-  // To learn more, visit: https://gatsby.app/offline
-  // 'gatsby-plugin-offline',
-]
-
-// Enable preact for the prod build
-if (currentEnv !== 'development') {
-  plugins.push('gatsby-plugin-preact')
-}
-
-// TK builds get weird redirect loops with htaccess plugin, so don't use it
-if (settings.PROJECT.MARKET_KEY !== 'TK') {
-  plugins.push('gatsby-plugin-htaccess')
-}
-
-module.exports = {
-  siteMetadata: settings,
-  pathPrefix: pathPrefix,
-  plugins: plugins,
-}

package/example/gatsby-node.js

@@ -1,66 +0,0 @@
-/**
- * Implement Gatsby's Node APIs in this file.
- *
- * See: https://www.gatsbyjs.org/docs/node-apis/
- */
-
-var { requestImage } = require("./tasks/node-helpers");
-let topperData = require("./src/data/topper2_settings.sheet.json");
-
-// Import all the WCM photos you'd like to use in this project
-// NOTE: Leave this as an empty array if you aren't importing any WCM photos, but you won't be able to use the WCMImage component
-const wcmPhotos = ["20374215"]
-
-const addValidWcmId = (numStr, wcmPhotos) => {
-  let isNum = /^\d+$/.test(numStr.trim())
-  if (isNum && !wcmPhotos.includes(numStr.trim())) wcmPhotos.push((numStr.trim()));
-}
-
-// Add topper image(s) to wcmPhotos list
-if (topperData[0].Image) {
-  let numStr = (topperData[0].Image).toString();
-
-  if (numStr.includes(";")) {
-    let numList = numStr.split(";");
-    for (var num of numList) {
-      addValidWcmId(num, wcmPhotos);
-    }
-  } else {
-    addValidWcmId(numStr, wcmPhotos);
-  }
-}
-
-
-// Create nodes so GraphQL can access
-exports.sourceNodes = async ({
-  actions,
-  createNodeId,
-  createContentDigest,
-}) => {
-  const { createNode } = actions
-
-  // Request and push photo data into an array
-  const photoData = [];
-  wcmPhotos.forEach((url) => {
-    photoData.push(requestImage(url))
-  })
-
-  // Take the ratios/ids turn them into graphql nodes
-  await Promise.all(photoData).then((values) => {
-    values.forEach((photo) => {
-      const type = "wcmPhotos";
-      createNode({
-        photo,
-        id: createNodeId(`${type}${photo.wcmid}`),
-        parent: null,
-        children: [],
-        internal: {
-          contentDigest: createContentDigest(photo),
-          type,
-        },
-      })
-    })
-    return
-  })
-  return
-}