@adobe/alloy 2.18.0 → 2.19.0-beta.0

package/{libEs6/components/Personalization/utils/composePersonalizationResultingObject.js → libEs5/components/Personalization/dom-actions/createPreprocess.js}

@@ -1,3 +1,9 @@
+"use strict";
+
+exports.default = void 0;
+
+var _utils = require("../../../utils");
+
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -9,18 +15,16 @@ 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 addRenderAttemptedToDecisions from "./addRenderAttemptedToDecisions";
-export default ((decisions = [], renderDecisions) => {
-  const resultingObject = {
-    propositions: addRenderAttemptedToDecisions({
-      decisions,
-      renderAttempted: renderDecisions
-    })
-  };
+var _default = function _default(preprocessors) {
+  return function (action) {
+    if (!action) {
+      return action;
+    }
 
-  if (!renderDecisions) {
-    resultingObject.decisions = decisions;
-  }
+    return preprocessors.reduce(function (processed, fn) {
+      return (0, _utils.assign)(processed, fn(processed));
+    }, action);
+  };
+};
 
-  return resultingObject;
-});
+exports.default = _default;

package/libEs5/components/Personalization/dom-actions/index.js

@@ -1,11 +1,5 @@
 "use strict";
 
-Object.defineProperty(exports, "executeActions", {
-  enumerable: true,
-  get: function get() {
-    return _executeActions.default;
-  }
-});
 Object.defineProperty(exports, "initDomActionsModules", {
   enumerable: true,
   get: function get() {
@@ -13,6 +7,4 @@ Object.defineProperty(exports, "initDomActionsModules", {
   }
 });
 
-var _initDomActionsModules = require("./initDomActionsModules");
-
-var _executeActions = require("./executeActions");
+var _initDomActionsModules = require("./initDomActionsModules");

package/libEs5/components/Personalization/dom-actions/initDomActionsModules.js

@@ -17,7 +17,7 @@ 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 _default = function _default(store) {
+var _default = function _default() {
   return {
     setHtml: (0, _action.createAction)(_action.setHtml),
     customCode: (0, _action.createAction)(_action.prependHtml),
@@ -33,15 +33,7 @@ var _default = function _default(store) {
     insertBefore: (0, _action.createAction)(_action.insertHtmlBefore),
     replaceHtml: (0, _action.createAction)(_action.replaceHtml),
     prependHtml: (0, _action.createAction)(_action.prependHtml),
-    appendHtml: (0, _action.createAction)(_action.appendHtml),
-    click: function click(settings) {
-      return (0, _action.click)(settings, store);
-    },
-    defaultContent: function defaultContent(settings) {
-      return Promise.resolve({
-        meta: settings.meta
-      });
-    }
+    appendHtml: (0, _action.createAction)(_action.appendHtml)
   };
 };
 

package/libEs5/components/Personalization/dom-actions/remapHeadOffers.js

@@ -51,6 +51,10 @@ var _default = function _default(action) {
     return result;
   }
 
+  if (selector == null) {
+    return result;
+  }
+
   var container = (0, _dom2.selectNodesWithEq)(selector);
 
   if (!(0, _scripts.is)(container[0], _tagName.HEAD)) {

package/libEs5/components/Personalization/handlers/createProcessDomAction.js

@@ -0,0 +1,61 @@
+"use strict";
+
+exports.default = void 0;
+
+/*
+Copyright 2023 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 modules = _ref.modules,
+      logger = _ref.logger,
+      storeClickMetrics = _ref.storeClickMetrics;
+  return function (item) {
+    var _ref2 = item.getData() || {},
+        type = _ref2.type,
+        selector = _ref2.selector;
+
+    if (!type) {
+      logger.warn("Invalid DOM action data: missing type.", item.getData());
+      return {};
+    }
+
+    if (type === "click") {
+      if (!selector) {
+        logger.warn("Invalid DOM action data: missing selector.", item.getData());
+        return {};
+      }
+
+      storeClickMetrics({
+        selector: selector,
+        meta: item.getMeta()
+      });
+      return {
+        setRenderAttempted: true,
+        includeInNotification: false
+      };
+    }
+
+    if (!modules[type]) {
+      logger.warn("Invalid DOM action data: unknown type.", item.getData());
+      return {};
+    }
+
+    return {
+      render: function render() {
+        return modules[type](item.getData());
+      },
+      setRenderAttempted: true,
+      includeInNotification: true
+    };
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/handlers/createProcessHtmlContent.js

@@ -0,0 +1,43 @@
+"use strict";
+
+exports.default = void 0;
+
+/*
+Copyright 2023 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 modules = _ref.modules,
+      logger = _ref.logger;
+  return function (item) {
+    var _ref2 = item.getData() || {},
+        type = _ref2.type,
+        selector = _ref2.selector;
+
+    if (!selector || !type) {
+      return {};
+    }
+
+    if (!modules[type]) {
+      logger.warn("Invalid HTML content data", item.getData());
+      return {};
+    }
+
+    return {
+      render: function render() {
+        modules[type](item.getData());
+      },
+      setRenderAttempted: true,
+      includeInNotification: true
+    };
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/handlers/createProcessPropositions.js

@@ -0,0 +1,240 @@
+"use strict";
+
+exports.default = void 0;
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+/*
+Copyright 2023 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 schemaProcessors = _ref.schemaProcessors,
+      logger = _ref.logger;
+
+  var wrapRenderWithLogging = function wrapRenderWithLogging(render, item) {
+    return function () {
+      return Promise.resolve().then(render).then(function () {
+        if (logger.enabled) {
+          logger.info("Action " + item.toString() + " executed.");
+        }
+
+        return true;
+      }).catch(function (error) {
+        if (logger.enabled) {
+          var message = error.message,
+              stack = error.stack;
+          var errorMessage = "Failed to execute action " + item.toString() + ". " + message + " " + stack;
+          logger.error(errorMessage);
+        }
+
+        return false;
+      });
+    };
+  };
+
+  var renderItems = function renderItems(renderers, meta) {
+    return Promise.all(renderers.map(function (renderer) {
+      return renderer();
+    })).then(function (successes) {
+      // as long as at least one renderer succeeds, we want to add the notification
+      // to the display notifications
+      if (!successes.includes(true)) {
+        return undefined;
+      }
+
+      return meta;
+    });
+  };
+
+  var processItem = function processItem(item) {
+    var processor = schemaProcessors[item.getSchema()];
+
+    if (!processor) {
+      return {};
+    }
+
+    return processor(item);
+  };
+
+  var processItems = function processItems(_ref2) {
+    var existingRenderers = _ref2.renderers,
+        existingReturnedPropositions = _ref2.returnedPropositions,
+        existingReturnedDecisions = _ref2.returnedDecisions,
+        items = _ref2.items,
+        proposition = _ref2.proposition;
+
+    var renderers = _toConsumableArray(existingRenderers);
+
+    var returnedPropositions = _toConsumableArray(existingReturnedPropositions);
+
+    var returnedDecisions = _toConsumableArray(existingReturnedDecisions);
+
+    var renderedItems = [];
+    var nonRenderedItems = [];
+    var itemRenderers = [];
+    var atLeastOneWithNotification = false;
+    var render;
+    var setRenderAttempted;
+    var includeInNotification;
+    var onlyRenderThis = false;
+    var i = 0;
+    var item;
+
+    while (items.length > i) {
+      item = items[i];
+
+      var _processItem = processItem(item);
+
+      render = _processItem.render;
+      setRenderAttempted = _processItem.setRenderAttempted;
+      includeInNotification = _processItem.includeInNotification;
+      onlyRenderThis = _processItem.onlyRenderThis;
+
+      if (onlyRenderThis) {
+        returnedPropositions = [];
+        returnedDecisions = [];
+
+        if (setRenderAttempted) {
+          renderedItems = [item];
+          nonRenderedItems = [];
+        } else {
+          renderedItems = [];
+          nonRenderedItems = [item];
+        }
+
+        renderers = [];
+        itemRenderers = [render];
+        atLeastOneWithNotification = includeInNotification;
+        break;
+      }
+
+      if (render) {
+        itemRenderers.push(wrapRenderWithLogging(render, item));
+      }
+
+      if (includeInNotification) {
+        atLeastOneWithNotification = true;
+      }
+
+      if (setRenderAttempted) {
+        renderedItems.push(item);
+      } else {
+        nonRenderedItems.push(item);
+      }
+
+      i += 1;
+    }
+
+    if (itemRenderers.length > 0) {
+      var meta = atLeastOneWithNotification ? proposition.getNotification() : undefined;
+      renderers.push(function () {
+        return renderItems(itemRenderers, meta);
+      });
+    } else if (atLeastOneWithNotification) {
+      renderers.push(function () {
+        return proposition.getNotification();
+      });
+    }
+
+    if (renderedItems.length > 0) {
+      proposition.addToReturnValues(returnedPropositions, returnedDecisions, renderedItems, true);
+    }
+
+    if (nonRenderedItems.length > 0) {
+      proposition.addToReturnValues(returnedPropositions, returnedDecisions, nonRenderedItems, false);
+    }
+
+    return {
+      renderers: renderers,
+      returnedPropositions: returnedPropositions,
+      returnedDecisions: returnedDecisions,
+      onlyRenderThis: onlyRenderThis
+    };
+  };
+
+  return function (renderPropositions) {
+    var nonRenderPropositions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+    var renderers = [];
+    var returnedPropositions = [];
+    var returnedDecisions = [];
+    var onlyRenderThis;
+    var i = 0;
+    var proposition;
+    var items;
+
+    while (renderPropositions.length > i) {
+      proposition = renderPropositions[i];
+      items = proposition.getItems();
+
+      var _processItems = processItems({
+        renderers: renderers,
+        returnedPropositions: returnedPropositions,
+        returnedDecisions: returnedDecisions,
+        items: items,
+        proposition: proposition
+      });
+
+      renderers = _processItems.renderers;
+      returnedPropositions = _processItems.returnedPropositions;
+      returnedDecisions = _processItems.returnedDecisions;
+      onlyRenderThis = _processItems.onlyRenderThis;
+
+      if (onlyRenderThis) {
+        break;
+      }
+
+      i += 1;
+    }
+
+    if (onlyRenderThis) {
+      // if onlyRenderThis is true, that means returnedPropositions and returnedDecisions
+      // only contains the proposition that triggered only rendering this. We need to
+      // add the other propositions to the returnedPropositions and returnedDecisions.
+      renderPropositions.forEach(function (p, index) {
+        if (index !== i) {
+          p.addToReturnValues(returnedPropositions, returnedDecisions, p.getItems(), false);
+        }
+      });
+    }
+
+    nonRenderPropositions.forEach(function (p) {
+      p.addToReturnValues(returnedPropositions, returnedDecisions, p.getItems(), false);
+    });
+
+    var render = function render() {
+      return Promise.all(renderers.map(function (renderer) {
+        return renderer();
+      })).then(function (metas) {
+        return metas.filter(function (meta) {
+          return meta;
+        });
+      });
+    };
+
+    return {
+      returnedPropositions: returnedPropositions,
+      returnedDecisions: returnedDecisions,
+      render: render
+    };
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/handlers/createProcessRedirect.js

@@ -0,0 +1,45 @@
+"use strict";
+
+exports.default = void 0;
+
+/*
+Copyright 2023 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 logger = _ref.logger,
+      executeRedirect = _ref.executeRedirect,
+      collect = _ref.collect;
+  return function (item) {
+    var _ref2 = item.getData() || {},
+        content = _ref2.content;
+
+    if (!content) {
+      logger.warn("Invalid Redirect data", item.getData());
+      return {};
+    }
+
+    var render = function render() {
+      return collect({
+        decisionsMeta: [item.getMeta()]
+      }).then(function () {
+        executeRedirect(content); // We've already sent the display notification, so don't return anything
+      });
+    };
+
+    return {
+      render: render,
+      setRenderAttempted: true,
+      onlyRenderThis: true
+    };
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/handlers/injectCreateProposition.js

@@ -0,0 +1,124 @@
+"use strict";
+
+exports.default = void 0;
+
+var _pageWideScope = require("../../../constants/pageWideScope");
+
+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 _default = function _default(_ref) {
+  var preprocess = _ref.preprocess,
+      isPageWideSurface = _ref.isPageWideSurface;
+
+  var createItem = function createItem(item, meta) {
+    var schema = item.schema,
+        data = item.data,
+        _item$characteristics = item.characteristics;
+    _item$characteristics = _item$characteristics === void 0 ? {} : _item$characteristics;
+    var trackingLabel = _item$characteristics.trackingLabel;
+    var processedData = preprocess(data);
+
+    if (trackingLabel) {
+      meta.trackingLabel = trackingLabel;
+    }
+
+    return {
+      getSchema: function getSchema() {
+        return schema;
+      },
+      getData: function getData() {
+        return processedData;
+      },
+      getMeta: function getMeta() {
+        return meta;
+      },
+      getOriginalItem: function getOriginalItem() {
+        return item;
+      },
+      toString: function toString() {
+        return JSON.stringify(item);
+      },
+      toJSON: function toJSON() {
+        return item;
+      }
+    };
+  };
+
+  return function (payload) {
+    var visibleInReturnedItems = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+    var id = payload.id,
+        scope = payload.scope,
+        scopeDetails = payload.scopeDetails,
+        _payload$items = payload.items,
+        items = _payload$items === void 0 ? [] : _payload$items;
+
+    var _ref2 = scopeDetails || {},
+        _ref2$characteristics = _ref2.characteristics;
+
+    _ref2$characteristics = _ref2$characteristics === void 0 ? {} : _ref2$characteristics;
+    var scopeType = _ref2$characteristics.scopeType;
+    return {
+      getScope: function getScope() {
+        if (!scope) {
+          return scope;
+        }
+
+        return scope;
+      },
+      getScopeType: function getScopeType() {
+        if (scope === _pageWideScope.default || isPageWideSurface(scope)) {
+          return "page";
+        }
+
+        if (scopeType === "view") {
+          return "view";
+        }
+
+        return "proposition";
+      },
+      getItems: function getItems() {
+        return items.map(function (item) {
+          return createItem(item, {
+            id: id,
+            scope: scope,
+            scopeDetails: scopeDetails
+          });
+        });
+      },
+      getNotification: function getNotification() {
+        return {
+          id: id,
+          scope: scope,
+          scopeDetails: scopeDetails
+        };
+      },
+      toJSON: function toJSON() {
+        return payload;
+      },
+      addToReturnValues: function addToReturnValues(propositions, decisions, includedItems, renderAttempted) {
+        if (visibleInReturnedItems) {
+          propositions.push(_objectSpread(_objectSpread({}, payload), {}, {
+            items: includedItems.map(function (i) {
+              return i.getOriginalItem();
+            }),
+            renderAttempted: renderAttempted
+          }));
+
+          if (!renderAttempted) {
+            decisions.push(_objectSpread(_objectSpread({}, payload), {}, {
+              items: includedItems.map(function (i) {
+                return i.getOriginalItem();
+              })
+            }));
+          }
+        }
+      }
+    };
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/{dom-actions/clicks/index.js → handlers/processDefaultContent.js}

@@ -2,10 +2,8 @@
 
 exports.default = void 0;
 
-var _collectClicks = require("./collectClicks");
-
 /*
-Copyright 2019 Adobe. All rights reserved.
+Copyright 2023 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,5 +13,11 @@ 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 _default = _collectClicks.default;
+var _default = function _default() {
+  return {
+    setRenderAttempted: true,
+    includeInNotification: true
+  };
+};
+
 exports.default = _default;