@adobe/alloy 2.15.0-alpha.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/constants/libraryVersion.js

@@ -15,5 +15,5 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-var _default = "2.15.0-alpha.0";
+var _default = "2.15.0-alpha.1";
 exports.default = _default;

package/libEs5/core/buildAndValidateConfig.js

@@ -6,17 +6,12 @@ var _utils = require("../utils");
 
 var _validation = require("../utils/validation");
 
-/*
-Copyright 2019 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.
-*/
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 var CONFIG_DOC_URI = "https://adobe.ly/3sHh553";
 
 var buildSchema = function buildSchema(coreConfigValidators, componentCreators) {
@@ -38,21 +33,38 @@ var transformOptions = function transformOptions(schema, options) {
   }
 };
 
-var _default = function _default(_ref) {
-  var options = _ref.options,
-      componentCreators = _ref.componentCreators,
-      coreConfigValidators = _ref.coreConfigValidators,
-      createConfig = _ref.createConfig,
-      logger = _ref.logger,
-      setDebugEnabled = _ref.setDebugEnabled;
+var buildAllOnInstanceConfiguredExtraParams = function buildAllOnInstanceConfiguredExtraParams(config, logger, componentCreators) {
+  return componentCreators.reduce(function (memo, _ref) {
+    var buildOnInstanceConfiguredExtraParams = _ref.buildOnInstanceConfiguredExtraParams;
+
+    if (buildOnInstanceConfiguredExtraParams) {
+      (0, _utils.assign)(memo, buildOnInstanceConfiguredExtraParams({
+        config: config,
+        logger: logger
+      }));
+    }
+
+    return memo;
+  }, {});
+};
+
+var _default = function _default(_ref2) {
+  var options = _ref2.options,
+      componentCreators = _ref2.componentCreators,
+      coreConfigValidators = _ref2.coreConfigValidators,
+      createConfig = _ref2.createConfig,
+      logger = _ref2.logger,
+      setDebugEnabled = _ref2.setDebugEnabled;
   var schema = buildSchema(coreConfigValidators, componentCreators);
   var config = createConfig(transformOptions(schema, options));
   setDebugEnabled(config.debugEnabled, {
     fromConfig: true
-  });
-  logger.logOnInstanceConfigured({
+  }); // eslint-disable-next-line no-underscore-dangle
+
+  var extraParams = buildAllOnInstanceConfiguredExtraParams(config, logger, componentCreators);
+  logger.logOnInstanceConfigured(_objectSpread(_objectSpread({}, extraParams), {}, {
     config: config
-  });
+  }));
   return config;
 };
 

package/libEs5/core/componentCreators.js

@@ -33,6 +33,10 @@ 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.
 */
+// This is the only place where core is allowed to import from components.
+// This makes sure that each component could be removed without breaking the library
+
+/* eslint-disable import/no-restricted-paths */
 // TODO: Register the Components here statically for now. They might be registered differently.
 // TODO: Figure out how sub-components will be made available/registered
 var _default = [_DataCollector.default, _ActivityCollector.default, _Identity.default, _Audiences.default, _Personalization.default, _Context.default, _Privacy.default, _EventMerge.default, _LibraryInfo.default, _MachineLearning.default];

package/libEs6/components/ActivityCollector/attachClickActivityCollector.js

@@ -1,5 +1,5 @@
 /*
-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/libEs6/components/ActivityCollector/configValidators.js

@@ -9,8 +9,9 @@ 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.
 */
-import { string, boolean } from "../../utils/validation";
+import { string, boolean, callback } from "../../utils/validation";
 export default {
   clickCollectionEnabled: boolean().default(true),
-  downloadLinkQualifier: string().regexp().default("\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$")
+  downloadLinkQualifier: string().regexp().default("\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$"),
+  onBeforeLinkClickSend: callback()
 };

package/libEs6/components/ActivityCollector/createGetLinkDetails.js

@@ -0,0 +1,77 @@
+/*
+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.
+*/
+export default (({
+  window,
+  getLinkName,
+  getLinkRegion,
+  getAbsoluteUrlFromAnchorElement,
+  findSupportedAnchorElement,
+  determineLinkType
+}) => {
+  return ({
+    targetElement,
+    config,
+    logger
+  }) => {
+    const anchorElement = findSupportedAnchorElement(targetElement);
+
+    if (!anchorElement) {
+      logger.info("This link click event is not triggered because the HTML element is not an anchor.");
+      return undefined;
+    }
+
+    const 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;
+    }
+
+    const linkType = determineLinkType(window, config, linkUrl, anchorElement);
+    const linkRegion = getLinkRegion(anchorElement);
+    const linkName = getLinkName(anchorElement);
+    const {
+      onBeforeLinkClickSend
+    } = config;
+    const 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;
+    }
+
+    const 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;
+  };
+});

package/libEs6/components/ActivityCollector/createLinkClick.js

@@ -1,5 +1,5 @@
 /*
-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
@@ -9,72 +9,32 @@ 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.
 */
-import { getAbsoluteUrlFromAnchorElement, isSupportedAnchorElement, isDownloadLink, isExitLink } from "./utils";
-
-const determineLinkType = (window, config, linkUrl, clickedObj) => {
-  let linkType = "other";
-
-  if (isDownloadLink(config.downloadLinkQualifier, linkUrl, clickedObj)) {
-    linkType = "download";
-  } else if (isExitLink(window, linkUrl)) {
-    linkType = "exit";
-  }
-
-  return linkType;
-};
-
-const findSupportedAnchorElement = targetElement => {
-  let node = targetElement;
-
-  while (node) {
-    if (isSupportedAnchorElement(node)) {
-      return node;
-    }
-
-    node = node.parentNode;
+export default (({
+  getLinkDetails,
+  config,
+  logger
+}) => {
+  const {
+    clickCollectionEnabled
+  } = config;
+
+  if (!clickCollectionEnabled) {
+    return () => undefined;
   }
 
-  return null;
-};
-
-export default ((window, config) => {
-  return (event, targetElement) => {
-    const clickCollectionEnabled = config.clickCollectionEnabled;
-
-    if (!clickCollectionEnabled) {
-      return;
-    } // Search parent elements for an anchor element
-    // TODO: Replace with generic DOM tool that can fetch configured properties
-
-
-    const anchorElement = findSupportedAnchorElement(targetElement);
-
-    if (!anchorElement) {
-      return;
-    }
-
-    const linkUrl = getAbsoluteUrlFromAnchorElement(window, anchorElement);
+  return ({
+    targetElement,
+    event
+  }) => {
+    const linkDetails = getLinkDetails({
+      targetElement,
+      config,
+      logger
+    });
 
-    if (!linkUrl) {
-      return;
+    if (linkDetails) {
+      event.mergeXdm(linkDetails.xdm);
+      event.setUserData(linkDetails.data);
     }
-
-    const linkType = determineLinkType(window, config, linkUrl, anchorElement); // TODO: Update link name from the clicked element context
-
-    const linkName = "Link Click";
-    event.documentMayUnload();
-    event.mergeXdm({
-      eventType: "web.webinteraction.linkClicks",
-      web: {
-        webInteraction: {
-          name: linkName,
-          type: linkType,
-          URL: linkUrl,
-          linkClicks: {
-            value: 1
-          }
-        }
-      }
-    });
   };
 });

package/libEs6/components/ActivityCollector/getLinkName.js

@@ -0,0 +1,151 @@
+/*
+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.
+*/
+import { truncateWhiteSpace } from "./utils";
+const 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}
+ */
+
+const 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.
+ */
+
+
+const extractSupportedNodes = node => {
+  let supportedNodes = [];
+  let includesUnsupportedNodes = false;
+
+  if (isSupportedTextNode(node)) {
+    supportedNodes.push(node);
+
+    if (node.childNodes) {
+      const childNodes = Array.prototype.slice.call(node.childNodes);
+      childNodes.forEach(childNode => {
+        const nodes = extractSupportedNodes(childNode);
+        supportedNodes = supportedNodes.concat(nodes.supportedNodes);
+        includesUnsupportedNodes = includesUnsupportedNodes || nodes.includesUnsupportedNodes;
+      });
+    }
+  } else {
+    includesUnsupportedNodes = true;
+  }
+
+  return {
+    supportedNodes,
+    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.
+ */
+
+
+const getNodeAttributeValue = (node, attributeName, nodeName) => {
+  let 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.
+ * */
+
+
+const getChildrenAttributes = nodes => {
+  const attributes = {
+    texts: []
+  };
+  nodes.supportedNodes.forEach(supportedNode => {
+    if (supportedNode.getAttribute) {
+      if (!attributes.alt) {
+        attributes.alt = truncateWhiteSpace(supportedNode.getAttribute("alt"));
+      }
+
+      if (!attributes.title) {
+        attributes.title = truncateWhiteSpace(supportedNode.getAttribute("title"));
+      }
+
+      if (!attributes.inputValue) {
+        attributes.inputValue = truncateWhiteSpace(getNodeAttributeValue(supportedNode, "value", "INPUT"));
+      }
+
+      if (!attributes.imgSrc) {
+        attributes.imgSrc = 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.
+ */
+
+
+export default (node => {
+  let nodeText = truncateWhiteSpace(node.innerText || node.textContent);
+  const nodes = extractSupportedNodes(node); // if contains unsupported nodes we want children node attributes
+
+  if (!nodeText || nodes.includesUnsupportedNodes) {
+    const attributesMap = getChildrenAttributes(nodes);
+    nodeText = truncateWhiteSpace(attributesMap.texts.join(""));
+
+    if (!nodeText) {
+      nodeText = attributesMap.alt || attributesMap.title || attributesMap.inputValue || attributesMap.imgSrc;
+    }
+  }
+
+  return nodeText || "";
+});

package/libEs6/components/ActivityCollector/getLinkRegion.js

@@ -0,0 +1,68 @@
+/*
+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.
+*/
+import { truncateWhiteSpace } from "./utils";
+import { isNonEmptyString } from "../../utils";
+const semanticElements = /^(HEADER|MAIN|FOOTER|NAV)$/i;
+
+const getAriaRegionLabel = node => {
+  let regionLabel;
+
+  if (node.role === "region" && isNonEmptyString(node["aria-label"])) {
+    regionLabel = node["aria-label"];
+  }
+
+  return regionLabel;
+};
+
+const getSectionNodeName = node => {
+  let 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.
+ */
+
+
+export default (node => {
+  let linkParentNode = node.parentNode;
+  let regionName;
+
+  while (linkParentNode) {
+    regionName = truncateWhiteSpace(linkParentNode.id || getAriaRegionLabel(linkParentNode) || getSectionNodeName(linkParentNode));
+
+    if (regionName) {
+      return regionName;
+    }
+
+    linkParentNode = linkParentNode.parentNode;
+  }
+
+  return "BODY";
+});

package/libEs6/components/ActivityCollector/index.js

@@ -12,13 +12,30 @@ governing permissions and limitations under the License.
 import attachClickActivityCollector from "./attachClickActivityCollector";
 import configValidators from "./configValidators";
 import createLinkClick from "./createLinkClick";
+import createGetLinkDetails from "./createGetLinkDetails";
+import getLinkName from "./getLinkName";
+import getLinkRegion from "./getLinkRegion";
+import { determineLinkType, findSupportedAnchorElement, getAbsoluteUrlFromAnchorElement } from "./utils";
+const getLinkDetails = createGetLinkDetails({
+  window,
+  getLinkName,
+  getLinkRegion,
+  getAbsoluteUrlFromAnchorElement,
+  findSupportedAnchorElement,
+  determineLinkType
+});
 
 const createActivityCollector = ({
   config,
   eventManager,
-  handleError
+  handleError,
+  logger
 }) => {
-  const linkClick = createLinkClick(window, config);
+  const linkClick = createLinkClick({
+    getLinkDetails,
+    config,
+    logger
+  });
   return {
     lifecycle: {
       onComponentsRegistered(tools) {
@@ -26,7 +43,6 @@ const createActivityCollector = ({
           lifecycle
         } = tools;
         attachClickActivityCollector({
-          config,
           eventManager,
           lifecycle,
           handleError
@@ -37,7 +53,10 @@ const createActivityCollector = ({
         event,
         clickedElement
       }) {
-        linkClick(event, clickedElement);
+        linkClick({
+          targetElement: clickedElement,
+          event
+        });
       }
 
     }
@@ -46,4 +65,20 @@ const createActivityCollector = ({
 
 createActivityCollector.namespace = "ActivityCollector";
 createActivityCollector.configValidators = configValidators;
+
+createActivityCollector.buildOnInstanceConfiguredExtraParams = ({
+  config,
+  logger
+}) => {
+  return {
+    getLinkDetails: targetElement => {
+      return getLinkDetails({
+        targetElement,
+        config,
+        logger
+      });
+    }
+  };
+};
+
 export default createActivityCollector;

package/libEs6/components/ActivityCollector/utils.js

@@ -68,5 +68,47 @@ const 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.
+ */
 
-export { urlStartsWithScheme, getAbsoluteUrlFromAnchorElement, isSupportedAnchorElement, isDownloadLink, isExitLink };
+
+const truncateWhiteSpace = str => {
+  return str && str.replace(/\s+/g, " ").trim();
+};
+
+const isEmptyString = str => {
+  return !str || str.length === 0;
+};
+
+const determineLinkType = (window, config, linkUrl, clickedObj) => {
+  let linkType = "other";
+
+  if (isDownloadLink(config.downloadLinkQualifier, linkUrl, clickedObj)) {
+    linkType = "download";
+  } else if (isExitLink(window, linkUrl)) {
+    linkType = "exit";
+  }
+
+  return linkType;
+};
+
+const findSupportedAnchorElement = targetElement => {
+  let node = targetElement;
+
+  while (node) {
+    if (isSupportedAnchorElement(node)) {
+      return node;
+    }
+
+    node = node.parentNode;
+  }
+
+  return null;
+};
+
+export { urlStartsWithScheme, getAbsoluteUrlFromAnchorElement, isSupportedAnchorElement, isDownloadLink, isEmptyString, isExitLink, truncateWhiteSpace, findSupportedAnchorElement, determineLinkType };

package/libEs6/constants/libraryVersion.js

@@ -11,4 +11,4 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-export default "2.15.0-alpha.0";
+export default "2.15.0-alpha.1";

package/libEs6/core/buildAndValidateConfig.js

@@ -34,6 +34,21 @@ const transformOptions = (schema, options) => {
   }
 };
 
+const buildAllOnInstanceConfiguredExtraParams = (config, logger, componentCreators) => {
+  return componentCreators.reduce((memo, {
+    buildOnInstanceConfiguredExtraParams
+  }) => {
+    if (buildOnInstanceConfiguredExtraParams) {
+      assign(memo, buildOnInstanceConfiguredExtraParams({
+        config,
+        logger
+      }));
+    }
+
+    return memo;
+  }, {});
+};
+
 export default (({
   options,
   componentCreators,
@@ -46,8 +61,10 @@ export default (({
   const config = createConfig(transformOptions(schema, options));
   setDebugEnabled(config.debugEnabled, {
     fromConfig: true
-  });
-  logger.logOnInstanceConfigured({
+  }); // eslint-disable-next-line no-underscore-dangle
+
+  const extraParams = buildAllOnInstanceConfiguredExtraParams(config, logger, componentCreators);
+  logger.logOnInstanceConfigured({ ...extraParams,
     config
   });
   return config;

package/libEs6/core/componentCreators.js

@@ -9,6 +9,10 @@ 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.
 */
+// This is the only place where core is allowed to import from components.
+// This makes sure that each component could be removed without breaking the library
+
+/* eslint-disable import/no-restricted-paths */
 import createDataCollector from "../components/DataCollector";
 import createActivityCollector from "../components/ActivityCollector";
 import createIdentity from "../components/Identity";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.15.0-alpha.0",
+  "version": "2.15.0-alpha.1",
   "description": "Adobe Experience Platform Web SDK",
   "main": "libEs5/index.js",
   "module": "libEs6/index.js",
@@ -64,7 +64,7 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.14.0",
+    "@adobe/alloy": "^2.15.0-alpha.0",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",