@adobe/alloy 2.14.0 → 2.15.0-alpha.1

package/libEs5/components/ActivityCollector/attachClickActivityCollector.js

@@ -5,7 +5,7 @@ exports.default = void 0;
 var _utils = require("../../utils");
 
 /*
-Copyright 2019 Adobe. All rights reserved.
+Copyright 2022 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy
 of the License at http://www.apache.org/licenses/LICENSE-2.0

package/libEs5/components/ActivityCollector/configValidators.js

@@ -17,6 +17,7 @@ governing permissions and limitations under the License.
 */
 var _default = {
   clickCollectionEnabled: (0, _validation.boolean)().default(true),
-  downloadLinkQualifier: (0, _validation.string)().regexp().default("\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$")
+  downloadLinkQualifier: (0, _validation.string)().regexp().default("\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"),
+  onBeforeLinkClickSend: (0, _validation.callback)()
 };
 exports.default = _default;

package/libEs5/components/ActivityCollector/createGetLinkDetails.js

@@ -0,0 +1,79 @@
+"use strict";
+
+exports.default = void 0;
+
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var _default = function _default(_ref) {
+  var window = _ref.window,
+      getLinkName = _ref.getLinkName,
+      getLinkRegion = _ref.getLinkRegion,
+      getAbsoluteUrlFromAnchorElement = _ref.getAbsoluteUrlFromAnchorElement,
+      findSupportedAnchorElement = _ref.findSupportedAnchorElement,
+      determineLinkType = _ref.determineLinkType;
+  return function (_ref2) {
+    var targetElement = _ref2.targetElement,
+        config = _ref2.config,
+        logger = _ref2.logger;
+    var anchorElement = findSupportedAnchorElement(targetElement);
+
+    if (!anchorElement) {
+      logger.info("This link click event is not triggered because the HTML element is not an anchor.");
+      return undefined;
+    }
+
+    var linkUrl = getAbsoluteUrlFromAnchorElement(window, anchorElement);
+
+    if (!linkUrl) {
+      logger.info("This link click event is not triggered because the HTML element doesn't have an URL.");
+      return undefined;
+    }
+
+    var linkType = determineLinkType(window, config, linkUrl, anchorElement);
+    var linkRegion = getLinkRegion(anchorElement);
+    var linkName = getLinkName(anchorElement);
+    var onBeforeLinkClickSend = config.onBeforeLinkClickSend;
+    var options = {
+      xdm: {
+        eventType: "web.webinteraction.linkClicks",
+        web: {
+          webInteraction: {
+            name: linkName,
+            region: linkRegion,
+            type: linkType,
+            URL: linkUrl,
+            linkClicks: {
+              value: 1
+            }
+          }
+        }
+      },
+      data: {},
+      clickedElement: targetElement
+    };
+
+    if (!onBeforeLinkClickSend) {
+      return options;
+    }
+
+    var shouldEventBeTracked = onBeforeLinkClickSend(options);
+
+    if (shouldEventBeTracked !== false) {
+      return options;
+    }
+
+    logger.info("This link click event is not triggered because it was canceled in onBeforeLinkClickSend.");
+    return undefined;
+  };
+};
+
+exports.default = _default;

package/libEs5/components/ActivityCollector/createLinkClick.js

@@ -2,10 +2,8 @@
 
 exports.default = void 0;
 
-var _utils = require("./utils");
-
 /*
-Copyright 2019 Adobe. All rights reserved.
+Copyright 2022 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy
 of the License at http://www.apache.org/licenses/LICENSE-2.0
@@ -15,71 +13,31 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-var determineLinkType = function determineLinkType(window, config, linkUrl, clickedObj) {
-  var linkType = "other";
-
-  if ((0, _utils.isDownloadLink)(config.downloadLinkQualifier, linkUrl, clickedObj)) {
-    linkType = "download";
-  } else if ((0, _utils.isExitLink)(window, linkUrl)) {
-    linkType = "exit";
+var _default = function _default(_ref) {
+  var getLinkDetails = _ref.getLinkDetails,
+      config = _ref.config,
+      logger = _ref.logger;
+  var clickCollectionEnabled = config.clickCollectionEnabled;
+
+  if (!clickCollectionEnabled) {
+    return function () {
+      return undefined;
+    };
   }
 
-  return linkType;
-};
-
-var findSupportedAnchorElement = function findSupportedAnchorElement(targetElement) {
-  var node = targetElement;
-
-  while (node) {
-    if ((0, _utils.isSupportedAnchorElement)(node)) {
-      return node;
-    }
-
-    node = node.parentNode;
-  }
-
-  return null;
-};
-
-var _default = function _default(window, config) {
-  return function (event, targetElement) {
-    var clickCollectionEnabled = config.clickCollectionEnabled;
-
-    if (!clickCollectionEnabled) {
-      return;
-    } // Search parent elements for an anchor element
-    // TODO: Replace with generic DOM tool that can fetch configured properties
-
-
-    var anchorElement = findSupportedAnchorElement(targetElement);
-
-    if (!anchorElement) {
-      return;
-    }
-
-    var linkUrl = (0, _utils.getAbsoluteUrlFromAnchorElement)(window, anchorElement);
+  return function (_ref2) {
+    var targetElement = _ref2.targetElement,
+        event = _ref2.event;
+    var linkDetails = getLinkDetails({
+      targetElement: targetElement,
+      config: config,
+      logger: logger
+    });
 
-    if (!linkUrl) {
-      return;
+    if (linkDetails) {
+      event.mergeXdm(linkDetails.xdm);
+      event.setUserData(linkDetails.data);
     }
-
-    var linkType = determineLinkType(window, config, linkUrl, anchorElement); // TODO: Update link name from the clicked element context
-
-    var linkName = "Link Click";
-    event.documentMayUnload();
-    event.mergeXdm({
-      eventType: "web.webinteraction.linkClicks",
-      web: {
-        webInteraction: {
-          name: linkName,
-          type: linkType,
-          URL: linkUrl,
-          linkClicks: {
-            value: 1
-          }
-        }
-      }
-    });
   };
 };
 

package/libEs5/components/ActivityCollector/getLinkName.js

@@ -0,0 +1,158 @@
+"use strict";
+
+exports.default = void 0;
+
+var _utils = require("./utils");
+
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var unsupportedNodeNames = /^(SCRIPT|STYLE|LINK|CANVAS|NOSCRIPT|#COMMENT)$/i;
+/**
+ * Determines if a node qualifies as a supported link text node.
+ * @param {*} node Node to determine support for.
+ * @returns {boolean}
+ */
+
+var isSupportedTextNode = function isSupportedTextNode(node) {
+  if (node && node.nodeName) {
+    if (node.nodeName.match(unsupportedNodeNames)) {
+      return false;
+    }
+  }
+
+  return true;
+};
+/**
+ * Orders and returns specified node and its child nodes in arrays of supported
+ * and unsupported nodes.
+ * @param {*} node The node to extract supported and unsupported nodes from.
+ * @returns {{supportedNodes: Array, includesUnsupportedNodes: boolean}} Node support object.
+ */
+
+
+var extractSupportedNodes = function extractSupportedNodes(node) {
+  var supportedNodes = [];
+  var includesUnsupportedNodes = false;
+
+  if (isSupportedTextNode(node)) {
+    supportedNodes.push(node);
+
+    if (node.childNodes) {
+      var childNodes = Array.prototype.slice.call(node.childNodes);
+      childNodes.forEach(function (childNode) {
+        var nodes = extractSupportedNodes(childNode);
+        supportedNodes = supportedNodes.concat(nodes.supportedNodes);
+        includesUnsupportedNodes = includesUnsupportedNodes || nodes.includesUnsupportedNodes;
+      });
+    }
+  } else {
+    includesUnsupportedNodes = true;
+  }
+
+  return {
+    supportedNodes: supportedNodes,
+    includesUnsupportedNodes: includesUnsupportedNodes
+  };
+};
+/**
+ * Returns the value of a node attribute.
+ * @param {*} node The node holding the attribute.
+ * @param {string} attributeName The name of the attribute.
+ * @param {string} nodeName Optional node name constraint.
+ * @returns {string} Attribute value or undefined.
+ */
+
+
+var getNodeAttributeValue = function getNodeAttributeValue(node, attributeName, nodeName) {
+  var attributeValue;
+
+  if (!nodeName || nodeName === node.nodeName.toUpperCase()) {
+    attributeValue = node.getAttribute(attributeName);
+  }
+
+  return attributeValue;
+};
+/**
+ * Extracts the children supported nodes attributes map
+ * @param {*} nodes The nodes array holding the children nodes.
+ * The returned map contains the supported not empty children attributes values.
+ * */
+
+
+var getChildrenAttributes = function getChildrenAttributes(nodes) {
+  var attributes = {
+    texts: []
+  };
+  nodes.supportedNodes.forEach(function (supportedNode) {
+    if (supportedNode.getAttribute) {
+      if (!attributes.alt) {
+        attributes.alt = (0, _utils.truncateWhiteSpace)(supportedNode.getAttribute("alt"));
+      }
+
+      if (!attributes.title) {
+        attributes.title = (0, _utils.truncateWhiteSpace)(supportedNode.getAttribute("title"));
+      }
+
+      if (!attributes.inputValue) {
+        attributes.inputValue = (0, _utils.truncateWhiteSpace)(getNodeAttributeValue(supportedNode, "value", "INPUT"));
+      }
+
+      if (!attributes.imgSrc) {
+        attributes.imgSrc = (0, _utils.truncateWhiteSpace)(getNodeAttributeValue(supportedNode, "src", "IMG"));
+      }
+    }
+
+    if (supportedNode.nodeValue) {
+      attributes.texts.push(supportedNode.nodeValue);
+    }
+  });
+  return attributes;
+};
+/**
+ * Extracts a link-name from a given node.
+ *
+ * The returned link-name is set to one of the following (in order of priority):
+ *
+ * 1. Clicked node innerText
+ * 2. Clicked node textContent
+ * 3. Clicked node and its child nodes nodeValue appended together.
+ * 4. Clicked node alt attribute or node descendant alt attribute.
+ *    Whichever is found first.
+ * 5. Clicked node text attribute or node descendant text attribute.
+ *    Whichever is found first.
+ * 6. Clicked node INPUT descendant value attribute.
+ *    Whichever is found first.
+ * 7. Clicked node IMG descendant src attribute.
+ *    Whichever is found first.
+ *
+ * @param {*} node The node to find link text for.
+ * @returns {string} link-name or an empty string if not link-name is found.
+ */
+
+
+var _default = function _default(node) {
+  var nodeText = (0, _utils.truncateWhiteSpace)(node.innerText || node.textContent);
+  var nodes = extractSupportedNodes(node); // if contains unsupported nodes we want children node attributes
+
+  if (!nodeText || nodes.includesUnsupportedNodes) {
+    var attributesMap = getChildrenAttributes(nodes);
+    nodeText = (0, _utils.truncateWhiteSpace)(attributesMap.texts.join(""));
+
+    if (!nodeText) {
+      nodeText = attributesMap.alt || attributesMap.title || attributesMap.inputValue || attributesMap.imgSrc;
+    }
+  }
+
+  return nodeText || "";
+};
+
+exports.default = _default;

package/libEs5/components/ActivityCollector/getLinkRegion.js

@@ -0,0 +1,76 @@
+"use strict";
+
+exports.default = void 0;
+
+var _utils = require("./utils");
+
+var _utils2 = require("../../utils");
+
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var semanticElements = /^(HEADER|MAIN|FOOTER|NAV)$/i;
+
+var getAriaRegionLabel = function getAriaRegionLabel(node) {
+  var regionLabel;
+
+  if (node.role === "region" && (0, _utils2.isNonEmptyString)(node["aria-label"])) {
+    regionLabel = node["aria-label"];
+  }
+
+  return regionLabel;
+};
+
+var getSectionNodeName = function getSectionNodeName(node) {
+  var nodeName;
+
+  if (node && node.nodeName) {
+    if (node.nodeName.match(semanticElements)) {
+      nodeName = node.nodeName;
+    }
+  }
+
+  return nodeName;
+};
+/**
+ * Extracts a node link-region.
+ *
+ * The link-region is determined by traversing up the DOM
+ * looking for a region that is determined in order of priority:
+ *
+ * 1. element.id
+ * 2. Aria region label
+ * 3. Semantic element name
+ * 4. BODY (if no other link-region is found).
+ *
+ * @param {*} node The node to find link region for.
+ * @returns {string} link-region.
+ */
+
+
+var _default = function _default(node) {
+  var linkParentNode = node.parentNode;
+  var regionName;
+
+  while (linkParentNode) {
+    regionName = (0, _utils.truncateWhiteSpace)(linkParentNode.id || getAriaRegionLabel(linkParentNode) || getSectionNodeName(linkParentNode));
+
+    if (regionName) {
+      return regionName;
+    }
+
+    linkParentNode = linkParentNode.parentNode;
+  }
+
+  return "BODY";
+};
+
+exports.default = _default;

package/libEs5/components/ActivityCollector/index.js

@@ -8,6 +8,14 @@ var _configValidators = require("./configValidators");
 
 var _createLinkClick = require("./createLinkClick");
 
+var _createGetLinkDetails = require("./createGetLinkDetails");
+
+var _getLinkName = require("./getLinkName");
+
+var _getLinkRegion = require("./getLinkRegion");
+
+var _utils = require("./utils");
+
 /*
 Copyright 2019 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -19,17 +27,30 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+var _getLinkDetails = (0, _createGetLinkDetails.default)({
+  window: window,
+  getLinkName: _getLinkName.default,
+  getLinkRegion: _getLinkRegion.default,
+  getAbsoluteUrlFromAnchorElement: _utils.getAbsoluteUrlFromAnchorElement,
+  findSupportedAnchorElement: _utils.findSupportedAnchorElement,
+  determineLinkType: _utils.determineLinkType
+});
+
 var createActivityCollector = function createActivityCollector(_ref) {
   var config = _ref.config,
       eventManager = _ref.eventManager,
-      handleError = _ref.handleError;
-  var linkClick = (0, _createLinkClick.default)(window, config);
+      handleError = _ref.handleError,
+      logger = _ref.logger;
+  var linkClick = (0, _createLinkClick.default)({
+    getLinkDetails: _getLinkDetails,
+    config: config,
+    logger: logger
+  });
   return {
     lifecycle: {
       onComponentsRegistered: function onComponentsRegistered(tools) {
         var lifecycle = tools.lifecycle;
         (0, _attachClickActivityCollector.default)({
-          config: config,
           eventManager: eventManager,
           lifecycle: lifecycle,
           handleError: handleError
@@ -38,7 +59,10 @@ var createActivityCollector = function createActivityCollector(_ref) {
       onClick: function onClick(_ref2) {
         var event = _ref2.event,
             clickedElement = _ref2.clickedElement;
-        linkClick(event, clickedElement);
+        linkClick({
+          targetElement: clickedElement,
+          event: event
+        });
       }
     }
   };
@@ -46,5 +70,20 @@ var createActivityCollector = function createActivityCollector(_ref) {
 
 createActivityCollector.namespace = "ActivityCollector";
 createActivityCollector.configValidators = _configValidators.default;
+
+createActivityCollector.buildOnInstanceConfiguredExtraParams = function (_ref3) {
+  var config = _ref3.config,
+      logger = _ref3.logger;
+  return {
+    getLinkDetails: function getLinkDetails(targetElement) {
+      return _getLinkDetails({
+        targetElement: targetElement,
+        config: config,
+        logger: logger
+      });
+    }
+  };
+};
+
 var _default = createActivityCollector;
 exports.default = _default;

package/libEs5/components/ActivityCollector/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 
-exports.urlStartsWithScheme = exports.isSupportedAnchorElement = exports.isExitLink = exports.isDownloadLink = exports.getAbsoluteUrlFromAnchorElement = void 0;
+exports.urlStartsWithScheme = exports.truncateWhiteSpace = exports.isSupportedAnchorElement = exports.isExitLink = exports.isEmptyString = exports.isDownloadLink = exports.getAbsoluteUrlFromAnchorElement = exports.findSupportedAnchorElement = exports.determineLinkType = void 0;
 
 /*
 Copyright 2019 Adobe. All rights reserved.
@@ -78,5 +78,55 @@ var isExitLink = function isExitLink(window, linkUrl) {
 
   return true;
 };
+/**
+ * Reduces repeated whitespace within a string. Whitespace surrounding the string
+ * is trimmed and any occurrence of whitespace within the string is replaced with
+ * a single space.
+ * @param {string} str String to be formatted.
+ * @returns {string} Formatted string.
+ */
 
-exports.isExitLink = isExitLink;
+
+exports.isExitLink = isExitLink;
+
+var truncateWhiteSpace = function truncateWhiteSpace(str) {
+  return str && str.replace(/\s+/g, " ").trim();
+};
+
+exports.truncateWhiteSpace = truncateWhiteSpace;
+
+var isEmptyString = function isEmptyString(str) {
+  return !str || str.length === 0;
+};
+
+exports.isEmptyString = isEmptyString;
+
+var determineLinkType = function determineLinkType(window, config, linkUrl, clickedObj) {
+  var linkType = "other";
+
+  if (isDownloadLink(config.downloadLinkQualifier, linkUrl, clickedObj)) {
+    linkType = "download";
+  } else if (isExitLink(window, linkUrl)) {
+    linkType = "exit";
+  }
+
+  return linkType;
+};
+
+exports.determineLinkType = determineLinkType;
+
+var findSupportedAnchorElement = function findSupportedAnchorElement(targetElement) {
+  var node = targetElement;
+
+  while (node) {
+    if (isSupportedAnchorElement(node)) {
+      return node;
+    }
+
+    node = node.parentNode;
+  }
+
+  return null;
+};
+
+exports.findSupportedAnchorElement = findSupportedAnchorElement;

package/libEs5/components/Audiences/injectProcessDestinations.js

@@ -48,11 +48,9 @@ var _default = function _default(_ref) {
     return Promise.all(urlDestinations.map(function (urlDestination) {
       return fireReferrerHideableImage(urlDestination.spec).then(function () {
         logger.info(createResultLogMessage(urlDestination, true));
-      }).catch(function () {
-        // We intentionally do not throw an error if destinations fail. We
+      }).catch(function () {// We intentionally do not throw an error if destinations fail. We
         // consider it a non-critical failure and therefore do not want it to
         // reject the promise handed back to the customer.
-        logger.error(createResultLogMessage(urlDestination, false));
       });
     })).then(_utils.noop);
   };

package/libEs5/components/Personalization/createClickStorage.js

@@ -18,7 +18,8 @@ var metasToArray = function metasToArray(metas) {
     return {
       id: key,
       scope: metas[key].scope,
-      scopeDetails: metas[key].scopeDetails
+      scopeDetails: metas[key].scopeDetails,
+      trackingLabel: metas[key].trackingLabel
     };
   });
 };
@@ -33,7 +34,8 @@ var _default = function _default() {
 
     clickStorage[value.selector][value.meta.id] = {
       scope: value.meta.scope,
-      scopeDetails: value.meta.scopeDetails
+      scopeDetails: value.meta.scopeDetails,
+      trackingLabel: value.meta.trackingLabel
     };
   };
 

package/libEs5/components/Personalization/createExecuteDecisions.js

@@ -21,8 +21,14 @@ var identity = function identity(item) {
   return item;
 };
 
+var getItemMeta = function getItemMeta(item, decisionMeta) {
+  return item.characteristics && item.characteristics.trackingLabel ? (0, _utils.assign)({
+    trackingLabel: item.characteristics.trackingLabel
+  }, decisionMeta) : decisionMeta;
+};
+
 var buildActions = function buildActions(decision) {
-  var meta = {
+  var decisionMeta = {
     id: decision.id,
     scope: decision.scope,
     scopeDetails: decision.scopeDetails
@@ -31,7 +37,7 @@ var buildActions = function buildActions(decision) {
     return (0, _utils.assign)({
       type: DEFAULT_ACTION_TYPE
     }, item.data, {
-      meta: meta
+      meta: getItemMeta(item, decisionMeta)
     });
   });
 };

package/libEs5/components/Personalization/createOnClickHandler.js

@@ -33,7 +33,9 @@ var _default = function _default(_ref) {
     var selectors = getClickSelectors();
 
     if ((0, _utils.isNonEmptyArray)(selectors)) {
-      var decisionsMeta = collectClicks(clickedElement, selectors, getClickMetasBySelector);
+      var _collectClicks = collectClicks(clickedElement, selectors, getClickMetasBySelector),
+          decisionsMeta = _collectClicks.decisionsMeta,
+          eventLabel = _collectClicks.eventLabel;
 
       if ((0, _utils.isNonEmptyArray)(decisionsMeta)) {
         var xdm = {
@@ -50,7 +52,7 @@ var _default = function _default(_ref) {
         }
 
         event.mergeXdm(xdm);
-        mergeDecisionsMeta(event, decisionsMeta, _propositionEventType.PropositionEventType.INTERACT);
+        mergeDecisionsMeta(event, decisionsMeta, _propositionEventType.PropositionEventType.INTERACT, eventLabel);
       }
     }
   };