@adobe/alloy 2.21.0-beta.1 → 2.21.0-beta.11

package/LICENSE_BANNER

@@ -0,0 +1,9 @@
+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.

package/babel.config.cjs

@@ -0,0 +1,93 @@
+/*
+Copyright 2021 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.
+*/
+
+/*
+ * This file is used in 4 scenarios:
+ * 1. Building files specified in rollup.config.js
+ * 2. Building libEs5/ files when publishing to NPM
+ * 3. Building libEs6/ files when publishing to NPM
+ * 4. Testcafe compiling clientFunctions. Unfortunately, there is no configuration I've found
+ *    to tell Testcafe not to use this file.
+ *
+ * Environments:
+ * "rollup" - Used for rollup.config.js
+ * "npmEs5" - Used for building libEs5 files when publishing to NPM
+ * "npmEs6" - Used for building libEs6 files when publishing to NPM
+ */
+
+const targets = {
+  browsers: [
+    "last 2 Chrome versions",
+    "last 2 Firefox versions",
+    "last 2 Safari versions",
+    "last 2 Edge versions",
+    "Explorer >= 10",
+  ],
+};
+
+const transformTemplateLiteralsPlugin = [
+  "@babel/plugin-transform-template-literals",
+  {
+    loose: true,
+  },
+];
+const versionPlugin = [
+  "./scripts/helpers/versionBabelPlugin",
+  { cwd: __dirname },
+];
+
+const transformModulesCommonjsPlugin = [
+  "@babel/plugin-transform-modules-commonjs",
+  {
+    strict: true,
+    noInterop: true,
+  },
+];
+
+const npmIgnoreFiles = ["src/baseCode.js"];
+
+module.exports = {
+  env: {
+    rollup: {
+      presets: [
+        [
+          "@babel/preset-env",
+          {
+            modules: false,
+            targets,
+          },
+        ],
+      ],
+      plugins: [transformTemplateLiteralsPlugin, versionPlugin],
+    },
+    npmEs5: {
+      presets: [
+        [
+          "@babel/preset-env",
+          {
+            targets,
+          },
+        ],
+      ],
+      ignore: npmIgnoreFiles,
+      plugins: [
+        transformTemplateLiteralsPlugin,
+        versionPlugin,
+        transformModulesCommonjsPlugin,
+      ],
+    },
+    npmEs6: {
+      ignore: npmIgnoreFiles,
+      plugins: [versionPlugin],
+    },
+  },
+};

package/libEs5/components/ActivityCollector/attachClickActivityCollector.js

@@ -19,6 +19,10 @@ var createClickHandler = function createClickHandler(_ref) {
     lifecycle = _ref.lifecycle,
     handleError = _ref.handleError;
   return function (clickEvent) {
+    // Ignore repropagated clicks from AppMeasurement
+    if (clickEvent.s_fe) {
+      return Promise.resolve();
+    }
     // TODO: Consider safeguarding from the same object being clicked multiple times in rapid succession?
     var clickedElement = clickEvent.target;
     var event = eventManager.createEvent();

package/libEs5/components/ActivityCollector/configValidators.js

@@ -17,6 +17,21 @@ governing permissions and limitations under the License.
 var downloadLinkQualifier = exports.downloadLinkQualifier = (0, _index.string)().regexp().default("\\.(exe|zip|wav|mp3|mov|mpg|avi|wmv|pdf|doc|docx|xls|xlsx|ppt|pptx)$");
 var _default = exports.default = (0, _index.objectOf)({
   clickCollectionEnabled: (0, _index.boolean)().default(true),
-  onBeforeLinkClickSend: (0, _index.callback)(),
-  downloadLinkQualifier: downloadLinkQualifier
+  clickCollection: (0, _index.objectOf)({
+    internalLinkEnabled: (0, _index.boolean)().default(true),
+    externalLinkEnabled: (0, _index.boolean)().default(true),
+    downloadLinkEnabled: (0, _index.boolean)().default(true),
+    // TODO: Consider moving downloadLinkQualifier here.
+    sessionStorageEnabled: (0, _index.boolean)().default(false),
+    eventGroupingEnabled: (0, _index.boolean)().default(false),
+    filterClickProperties: (0, _index.callback)()
+  }).default({
+    internalLinkEnabled: true,
+    externalLinkEnabled: true,
+    downloadLinkEnabled: true,
+    sessionStorageEnabled: false,
+    eventGroupingEnabled: false
+  }),
+  downloadLinkQualifier: downloadLinkQualifier,
+  onBeforeLinkClickSend: (0, _index.callback)().deprecated('The field "onBeforeLinkClickSend" has been deprecated. Use "clickCollection.filterClickDetails" instead.')
 });

package/libEs5/components/ActivityCollector/createClickActivityStorage.js

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.default = void 0;
+var _sessionDataKeys = require("../../constants/sessionDataKeys.js");
+/*
+Copyright 2024 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 = exports.default = function _default(_ref) {
+  var storage = _ref.storage;
+  return {
+    save: function save(data) {
+      var jsonData = JSON.stringify(data);
+      storage.setItem(_sessionDataKeys.CLICK_ACTIVITY_DATA, jsonData);
+    },
+    load: function load() {
+      var jsonData = null;
+      var data = storage.getItem(_sessionDataKeys.CLICK_ACTIVITY_DATA);
+      if (data) {
+        jsonData = JSON.parse(data);
+      }
+      return jsonData;
+    },
+    remove: function remove() {
+      storage.removeItem(_sessionDataKeys.CLICK_ACTIVITY_DATA);
+    }
+  };
+};

package/libEs5/components/ActivityCollector/createClickedElementProperties.js

@@ -0,0 +1,215 @@
+"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 buildXdmFromClickedElementProperties = function buildXdmFromClickedElementProperties(props) {
+  return {
+    eventType: "web.webinteraction.linkClicks",
+    web: {
+      webInteraction: {
+        name: props.linkName,
+        region: props.linkRegion,
+        type: props.linkType,
+        URL: props.linkUrl,
+        linkClicks: {
+          value: 1
+        }
+      }
+    }
+  };
+};
+var buildDataFromClickedElementProperties = function buildDataFromClickedElementProperties(props) {
+  return {
+    __adobe: {
+      analytics: {
+        c: {
+          a: {
+            activitymap: {
+              page: props.pageName,
+              link: props.linkName,
+              region: props.linkRegion,
+              pageIDType: props.pageIDType
+            }
+          }
+        }
+      }
+    }
+  };
+};
+var populateClickedElementPropertiesFromOptions = function populateClickedElementPropertiesFromOptions(options, props) {
+  var xdm = options.xdm,
+    data = options.data,
+    clickedElement = options.clickedElement;
+  props.clickedElement = clickedElement;
+  if (xdm && xdm.web && xdm.web.webInteraction) {
+    var _xdm$web$webInteracti = xdm.web.webInteraction,
+      name = _xdm$web$webInteracti.name,
+      region = _xdm$web$webInteracti.region,
+      type = _xdm$web$webInteracti.type,
+      URL = _xdm$web$webInteracti.URL;
+    props.linkName = name;
+    props.linkRegion = region;
+    props.linkType = type;
+    props.linkUrl = URL;
+  }
+  // DATA has priority over XDM
+  /* eslint no-underscore-dangle: 0 */
+  if (data && data.__adobe && data.__adobe.analytics) {
+    var c = data.__adobe.analytics.c;
+    if (c && c.a && c.a.activitymap) {
+      // Set the properties if they exists
+      var _c$a$activitymap = c.a.activitymap,
+        page = _c$a$activitymap.page,
+        link = _c$a$activitymap.link,
+        _region = _c$a$activitymap.region,
+        pageIDType = _c$a$activitymap.pageIDType;
+      props.pageName = page || props.pageName;
+      props.linkName = link || props.linkName;
+      props.linkRegion = _region || props.linkRegion;
+      if (pageIDType !== undefined) {
+        props.pageIDType = pageIDType;
+      }
+    }
+  }
+};
+var _default = exports.default = function _default() {
+  var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    properties = _ref.properties,
+    logger = _ref.logger;
+  var props = properties || {};
+  var clickedElementProperties = {
+    get pageName() {
+      return props.pageName;
+    },
+    set pageName(value) {
+      props.pageName = value;
+    },
+    get linkName() {
+      return props.linkName;
+    },
+    set linkName(value) {
+      props.linkName = value;
+    },
+    get linkRegion() {
+      return props.linkRegion;
+    },
+    set linkRegion(value) {
+      props.linkRegion = value;
+    },
+    get linkType() {
+      return props.linkType;
+    },
+    set linkType(value) {
+      props.linkType = value;
+    },
+    get linkUrl() {
+      return props.linkUrl;
+    },
+    set linkUrl(value) {
+      props.linkUrl = value;
+    },
+    get pageIDType() {
+      return props.pageIDType;
+    },
+    set pageIDType(value) {
+      props.pageIDType = value;
+    },
+    get clickedElement() {
+      return props.clickedElement;
+    },
+    set clickedElement(value) {
+      props.clickedElement = value;
+    },
+    get properties() {
+      return {
+        pageName: props.pageName,
+        linkName: props.linkName,
+        linkRegion: props.linkRegion,
+        linkType: props.linkType,
+        linkUrl: props.linkUrl,
+        pageIDType: props.pageIDType
+      };
+    },
+    isValidLink: function isValidLink() {
+      return !!props.linkUrl && !!props.linkType && !!props.linkName && !!props.linkRegion;
+    },
+    isInternalLink: function isInternalLink() {
+      return this.isValidLink() && props.linkType === "other";
+    },
+    isValidActivityMapData: function isValidActivityMapData() {
+      return !!props.pageName && !!props.linkName && !!props.linkRegion && props.pageIDType !== undefined;
+    },
+    get xdm() {
+      if (props.filteredXdm) {
+        return props.filteredXdm;
+      }
+      return buildXdmFromClickedElementProperties(this);
+    },
+    get data() {
+      if (props.filteredData) {
+        return props.filteredData;
+      }
+      return buildDataFromClickedElementProperties(this);
+    },
+    applyPropertyFilter: function applyPropertyFilter(filter) {
+      if (filter && filter(props) === false) {
+        if (logger) {
+          logger.info("Clicked element properties were rejected by filter function: " + JSON.stringify(this.properties, null, 2));
+        }
+        props = {};
+      }
+    },
+    applyOptionsFilter: function applyOptionsFilter(filter) {
+      var opts = this.options;
+      if (opts && opts.clickedElement && (opts.xdm || opts.data)) {
+        // Properties are rejected if filter is explicitly false.
+        if (filter && filter(opts) === false) {
+          if (logger) {
+            logger.info("Clicked element properties were rejected by filter function: " + JSON.stringify(this.properties, null, 2));
+          }
+          this.options = undefined;
+          return;
+        }
+        this.options = opts;
+        // This is just to ensure that any fields outside clicked element properties
+        // set by the user filter persists.
+        props.filteredXdm = opts.xdm;
+        props.filteredData = opts.data;
+      }
+    },
+    get options() {
+      var opts = {};
+      if (this.isValidLink()) {
+        opts.xdm = this.xdm;
+      }
+      if (this.isValidActivityMapData()) {
+        opts.data = this.data;
+      }
+      if (this.clickedElement) {
+        opts.clickedElement = this.clickedElement;
+      }
+      if (!opts.xdm && !opts.data) {
+        return undefined;
+      }
+      return opts;
+    },
+    set options(value) {
+      props = {};
+      if (value) {
+        populateClickedElementPropertiesFromOptions(value, props);
+      }
+    }
+  };
+  return clickedElementProperties;
+};

package/libEs5/components/ActivityCollector/createGetClickedElementProperties.js

@@ -0,0 +1,64 @@
+"use strict";
+
+exports.default = void 0;
+var _createClickedElementProperties = require("./createClickedElementProperties.js");
+/*
+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 = exports.default = function _default(_ref) {
+  var window = _ref.window,
+    getLinkName = _ref.getLinkName,
+    getLinkRegion = _ref.getLinkRegion,
+    getAbsoluteUrlFromAnchorElement = _ref.getAbsoluteUrlFromAnchorElement,
+    findClickableElement = _ref.findClickableElement,
+    determineLinkType = _ref.determineLinkType;
+  return function (_ref2) {
+    var clickedElement = _ref2.clickedElement,
+      config = _ref2.config,
+      logger = _ref2.logger,
+      clickActivityStorage = _ref2.clickActivityStorage;
+    var optionsFilter = config.onBeforeLinkClickSend,
+      clickCollection = config.clickCollection;
+    var propertyFilter = clickCollection.filterClickDetails;
+    var elementProperties = (0, _createClickedElementProperties.default)({
+      logger: logger
+    });
+    if (clickedElement) {
+      var clickableElement = findClickableElement(clickedElement);
+      if (clickableElement) {
+        elementProperties.clickedElement = clickedElement;
+        elementProperties.linkUrl = getAbsoluteUrlFromAnchorElement(window, clickableElement);
+        elementProperties.linkType = determineLinkType(window, config, elementProperties.linkUrl, clickableElement);
+        elementProperties.linkRegion = getLinkRegion(clickableElement);
+        elementProperties.linkName = getLinkName(clickableElement);
+        elementProperties.pageIDType = 0;
+        elementProperties.pageName = window.location.href;
+        // Check if we have a page-name stored from an earlier page view event
+        var storedLinkData = clickActivityStorage.load();
+        if (storedLinkData && storedLinkData.pageName) {
+          elementProperties.pageName = storedLinkData.pageName;
+          // Perhaps pageIDType should be established after customer filter is applied
+          // Like if pageName starts with "http" then pageIDType = 0
+          elementProperties.pageIDType = 1;
+        }
+        // If defined, run user provided filter function
+        if (propertyFilter) {
+          // clickCollection.filterClickDetails
+          elementProperties.applyPropertyFilter(propertyFilter);
+        } else if (optionsFilter) {
+          // onBeforeLinkClickSend
+          elementProperties.applyOptionsFilter(optionsFilter);
+        }
+      }
+    }
+    return elementProperties;
+  };
+};

package/libEs5/components/ActivityCollector/createInjectClickedElementProperties.js

@@ -0,0 +1,70 @@
+"use strict";
+
+exports.default = void 0;
+var _activityMapExtensionEnabled = require("./utils/activityMapExtensionEnabled.js");
+var _isDifferentDomains = require("./utils/isDifferentDomains.js");
+/*
+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 isDissallowedLinkType = function isDissallowedLinkType(clickCollection, linkType) {
+  return linkType && (linkType === "download" && !clickCollection.downloadLinkEnabled || linkType === "exit" && !clickCollection.externalLinkEnabled || linkType === "other" && !clickCollection.internalLinkEnabled);
+};
+var _default = exports.default = function _default(_ref) {
+  var config = _ref.config,
+    logger = _ref.logger,
+    getClickedElementProperties = _ref.getClickedElementProperties,
+    clickActivityStorage = _ref.clickActivityStorage;
+  var clickCollectionEnabled = config.clickCollectionEnabled,
+    clickCollection = config.clickCollection;
+  if (!clickCollectionEnabled) {
+    return function () {
+      return undefined;
+    };
+  }
+  return function (_ref2) {
+    var event = _ref2.event,
+      clickedElement = _ref2.clickedElement;
+    var elementProperties = getClickedElementProperties({
+      clickActivityStorage: clickActivityStorage,
+      clickedElement: clickedElement,
+      config: config,
+      logger: logger
+    });
+    var linkType = elementProperties.linkType;
+    // Avoid clicks to be collected for the ActivityMap interface
+    if ((0, _activityMapExtensionEnabled.default)()) {
+      return;
+    }
+    if (elementProperties.isValidLink() && isDissallowedLinkType(clickCollection, linkType)) {
+      logger.info("Cancelling link click event due to clickCollection." + linkType + "LinkEnabled = false.");
+    } else if (
+    // Determine if element properties should be sent with event now, or be saved
+    // and grouped with a future page view event.
+    // Event grouping is not supported for the deprecated onBeforeLinkClickSend callback
+    // because only click properties is saved and not XDM and DATA (which could have been modified).
+    // However, if the filterClickDetails callback is available we group events because it takes
+    // priority over onBeforeLinkClickSend and only supports processing click properties.
+    elementProperties.isInternalLink() && clickCollection.eventGroupingEnabled && (!config.onBeforeLinkClickSend || clickCollection.filterClickDetails) && !(0, _isDifferentDomains.default)(window.location.hostname, elementProperties.linkUrl)) {
+      clickActivityStorage.save(elementProperties.properties);
+    } else if (elementProperties.isValidLink()) {
+      // Event will be sent
+      event.mergeXdm(elementProperties.xdm);
+      event.setUserData(elementProperties.data);
+      clickActivityStorage.save({
+        pageName: elementProperties.pageName,
+        pageIDType: elementProperties.pageIDType
+      });
+    } else if (elementProperties.isValidActivityMapData()) {
+      clickActivityStorage.save(elementProperties.properties);
+    }
+  };
+};

package/libEs5/components/ActivityCollector/createRecallAndInjectClickedElementProperties.js

@@ -0,0 +1,46 @@
+"use strict";
+
+exports.default = void 0;
+var _createClickedElementProperties = require("./createClickedElementProperties.js");
+var _activityMapExtensionEnabled = require("./utils/activityMapExtensionEnabled.js");
+/*
+Copyright 2024 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 = exports.default = function _default(_ref) {
+  var clickActivityStorage = _ref.clickActivityStorage;
+  return function (event) {
+    // Avoid clicks to be collected for the ActivityMap interface
+    if ((0, _activityMapExtensionEnabled.default)()) {
+      return;
+    }
+    var properties = clickActivityStorage.load();
+    var elementProperties = (0, _createClickedElementProperties.default)({
+      properties: properties
+    });
+    if (elementProperties.isValidLink() || elementProperties.isValidActivityMapData()) {
+      if (elementProperties.isValidLink()) {
+        var xdm = elementProperties.xdm;
+        // Have to delete the eventType not to override the page view
+        delete xdm.eventType;
+        event.mergeXdm(xdm);
+      }
+      if (elementProperties.isValidActivityMapData()) {
+        event.setUserData(elementProperties.data);
+      }
+      // NOTE: We can't clear out all the storage here because we might still need to
+      // keep a page-name for multiple link-clicks (e.g. downloads) on the same page.
+      clickActivityStorage.save({
+        pageName: elementProperties.pageName,
+        pageIDType: elementProperties.pageIDType
+      });
+    }
+  };
+};

package/libEs5/components/ActivityCollector/{createLinkClick.js → createStorePageViewProperties.js}

@@ -2,7 +2,7 @@
 
 exports.default = void 0;
 /*
-Copyright 2022 Adobe. All rights reserved.
+Copyright 2024 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
@@ -13,26 +13,11 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 var _default = exports.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 function (_ref2) {
-    var targetElement = _ref2.targetElement,
-      event = _ref2.event;
-    var linkDetails = getLinkDetails({
-      targetElement: targetElement,
-      config: config,
-      logger: logger
+  var clickActivityStorage = _ref.clickActivityStorage;
+  return function (event) {
+    clickActivityStorage.save({
+      pageName: event.getContent().xdm.web.webPageDetails.name,
+      pageIDType: 1 // 1 = name, 0 = URL
     });
-    if (linkDetails) {
-      event.mergeXdm(linkDetails.xdm);
-      event.setUserData(linkDetails.data);
-    }
   };
 };