@adobe/alloy 2.14.0 → 2.15.0-alpha.1

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/components/Audiences/injectProcessDestinations.js

@@ -49,11 +49,9 @@ export default (({
     return Promise.all(urlDestinations.map(urlDestination => {
       return fireReferrerHideableImage(urlDestination.spec).then(() => {
         logger.info(createResultLogMessage(urlDestination, true));
-      }).catch(() => {
-        // We intentionally do not throw an error if destinations fail. We
+      }).catch(() => {// 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(noop);
   };

package/libEs6/components/Personalization/createClickStorage.js

@@ -14,7 +14,8 @@ const metasToArray = metas => {
     return {
       id: key,
       scope: metas[key].scope,
-      scopeDetails: metas[key].scopeDetails
+      scopeDetails: metas[key].scopeDetails,
+      trackingLabel: metas[key].trackingLabel
     };
   });
 };
@@ -29,7 +30,8 @@ export default (() => {
 
     clickStorage[value.selector][value.meta.id] = {
       scope: value.meta.scope,
-      scopeDetails: value.meta.scopeDetails
+      scopeDetails: value.meta.scopeDetails,
+      trackingLabel: value.meta.trackingLabel
     };
   };
 

package/libEs6/components/Personalization/createExecuteDecisions.js

@@ -14,8 +14,12 @@ const DEFAULT_ACTION_TYPE = "defaultContent";
 
 const identity = item => item;
 
+const getItemMeta = (item, decisionMeta) => item.characteristics && item.characteristics.trackingLabel ? assign({
+  trackingLabel: item.characteristics.trackingLabel
+}, decisionMeta) : decisionMeta;
+
 const buildActions = decision => {
-  const meta = {
+  const decisionMeta = {
     id: decision.id,
     scope: decision.scope,
     scopeDetails: decision.scopeDetails
@@ -23,7 +27,7 @@ const buildActions = decision => {
   return decision.items.map(item => assign({
     type: DEFAULT_ACTION_TYPE
   }, item.data, {
-    meta
+    meta: getItemMeta(item, decisionMeta)
   }));
 };
 

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -27,7 +27,10 @@ export default (({
     const selectors = getClickSelectors();
 
     if (isNonEmptyArray(selectors)) {
-      const decisionsMeta = collectClicks(clickedElement, selectors, getClickMetasBySelector);
+      const {
+        decisionsMeta,
+        eventLabel
+      } = collectClicks(clickedElement, selectors, getClickMetasBySelector);
 
       if (isNonEmptyArray(decisionsMeta)) {
         const xdm = {
@@ -44,7 +47,7 @@ export default (({
         }
 
         event.mergeXdm(xdm);
-        mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.INTERACT);
+        mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.INTERACT, eventLabel);
       }
     }
   };

package/libEs6/components/Personalization/dom-actions/clicks/collectClicks.js

@@ -16,28 +16,72 @@ const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) =>
     documentElement
   } = document;
   let element = clickedElement;
+  let i = 0;
 
   while (element && element !== documentElement) {
     if (matchesSelectorWithEq(selector, element)) {
-      return getClickMetasBySelector(selector);
+      const matchedMetas = getClickMetasBySelector(selector);
+      const foundMetaWithLabel = matchedMetas.find(meta => meta.trackingLabel);
+
+      if (foundMetaWithLabel) {
+        return {
+          metas: matchedMetas,
+          label: foundMetaWithLabel.trackingLabel,
+          weight: i
+        };
+      }
+
+      return {
+        metas: matchedMetas
+      };
     }
 
     element = element.parentNode;
+    i += 1;
   }
 
-  return null;
+  return {
+    metas: null
+  };
 };
 
+const cleanMetas = metas => metas.map(meta => {
+  delete meta.trackingLabel;
+  return meta;
+});
+
+const dedupMetas = metas => metas.filter((meta, index) => {
+  const stringifiedMeta = JSON.stringify(meta);
+  return index === metas.findIndex(innerMeta => JSON.stringify(innerMeta) === stringifiedMeta);
+});
+
 export default ((clickedElement, selectors, getClickMetasBySelector) => {
   const result = [];
+  let resultLabel = "";
+  let resultLabelWeight = Number.MAX_SAFE_INTEGER;
+  /* eslint-disable no-continue */
 
   for (let i = 0; i < selectors.length; i += 1) {
-    const metas = getMetasIfMatches(clickedElement, selectors[i], getClickMetasBySelector);
+    const {
+      metas,
+      label,
+      weight
+    } = getMetasIfMatches(clickedElement, selectors[i], getClickMetasBySelector);
 
-    if (metas) {
-      result.push(...metas);
+    if (!metas) {
+      continue;
     }
+
+    if (label && weight <= resultLabelWeight) {
+      resultLabel = label;
+      resultLabelWeight = weight;
+    }
+
+    result.push(...cleanMetas(metas));
   }
 
-  return result;
+  return {
+    decisionsMeta: dedupMetas(result),
+    eventLabel: resultLabel
+  };
 });

package/libEs6/components/Personalization/event.js

@@ -10,8 +10,10 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 const EVENT_TYPE_TRUE = 1;
-export const mergeDecisionsMeta = (event, decisionsMeta, eventType) => {
-  event.mergeXdm({
+/* eslint-disable no-underscore-dangle */
+
+export const mergeDecisionsMeta = (event, decisionsMeta, eventType, eventLabel = "") => {
+  const xdm = {
     _experience: {
       decisioning: {
         propositions: decisionsMeta,
@@ -20,7 +22,15 @@ export const mergeDecisionsMeta = (event, decisionsMeta, eventType) => {
         }
       }
     }
-  });
+  };
+
+  if (eventLabel) {
+    xdm._experience.decisioning.propositionAction = {
+      label: eventLabel
+    };
+  }
+
+  event.mergeXdm(xdm);
 };
 export const mergeQuery = (event, details) => {
   event.mergeQuery({

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.14.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.14.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-beta.1",
+    "@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",
@@ -118,7 +118,7 @@
     "rollup-plugin-terser": "^7.0.2",
     "semver": "^7.3.7",
     "start-server-and-test": "^1.10.6",
-    "testcafe": "^2.2.0",
+    "testcafe": "^2.3.1",
     "testcafe-browser-provider-saucelabs": "^1.9.0",
     "testcafe-reporter-junit": "^3.0.2",
     "url-exists-nodejs": "^0.1.0",