@adobe/alloy 2.28.0 → 2.28.1-beta.0

package/libEs5/components/Personalization/createOnClickHandler.js

@@ -0,0 +1,83 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _eventType = require("../../constants/eventType.js");
+var _propositionEventType = require("../../constants/propositionEventType.js");
+/*
+Copyright 2020 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.
+*/
+
+const createPropositionAction = (clickLabel, clickToken) => {
+  if (!clickToken && !clickLabel) {
+    return undefined;
+  }
+  const propositionAction = {};
+  if (clickLabel) {
+    propositionAction.label = clickLabel;
+  }
+  if (clickToken) {
+    propositionAction.tokens = [clickToken];
+  }
+  return propositionAction;
+};
+var _default = ({
+  mergeDecisionsMeta,
+  collectInteractions,
+  collectClicks,
+  getInteractionMetas,
+  getClickMetas,
+  getClickSelectors,
+  autoCollectPropositionInteractions
+}) => {
+  // Called when an element qualifying for conversion within an offer is clicked.
+  return ({
+    event,
+    clickedElement
+  }) => {
+    const decisionsMeta = [];
+    let propositionActionLabel;
+    let propositionActionToken;
+    let viewName;
+    [collectInteractions(clickedElement, getInteractionMetas, autoCollectPropositionInteractions), collectClicks(clickedElement, getClickSelectors(), getClickMetas)].forEach(({
+      decisionsMeta: curDecisionsMeta,
+      propositionActionLabel: curPropositionActionLabel,
+      propositionActionToken: curPropositionActionToken,
+      viewName: curViewName
+    }) => {
+      Array.prototype.push.apply(decisionsMeta, curDecisionsMeta);
+      if (!propositionActionLabel && curPropositionActionLabel) {
+        propositionActionLabel = curPropositionActionLabel;
+      }
+      if (!propositionActionToken && curPropositionActionToken) {
+        propositionActionToken = curPropositionActionToken;
+      }
+      if (!viewName && curViewName) {
+        viewName = curViewName;
+      }
+    });
+    if ((0, _index.isNonEmptyArray)(decisionsMeta)) {
+      const xdm = {
+        eventType: _eventType.INTERACT
+      };
+      if (viewName) {
+        xdm.web = {
+          webPageDetails: {
+            viewName
+          }
+        };
+      }
+      event.mergeXdm(xdm);
+      mergeDecisionsMeta(event, decisionsMeta, [_propositionEventType.PropositionEventType.INTERACT], createPropositionAction(propositionActionLabel, propositionActionToken));
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Personalization/createOnDecisionHandler.js

@@ -0,0 +1,73 @@
+"use strict";
+
+exports.default = void 0;
+var _schema = require("../../constants/schema.js");
+/*
+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.
+*/
+
+// When multiple In-App messages propositions are returned, we need to show only one
+// of them (the one with lowest rank). This function keep track of the number of
+// times it was called. It returns false for the first proposition that contains
+// In-App messages items, true afterwards.
+const createShouldSuppressDisplay = () => {
+  let count = 0;
+  return proposition => {
+    const {
+      items = []
+    } = proposition;
+    if (!items.some(item => item.schema === _schema.MESSAGE_IN_APP)) {
+      return false;
+    }
+    count += 1;
+    return count > 1;
+  };
+};
+var _default = ({
+  processPropositions,
+  createProposition,
+  notificationHandler
+}) => {
+  return ({
+    renderDecisions,
+    propositions,
+    event,
+    personalization = {}
+  }) => {
+    if (!renderDecisions) {
+      return Promise.resolve();
+    }
+    const {
+      sendDisplayEvent = true
+    } = personalization;
+    const viewName = event ? event.getViewName() : undefined;
+    const shouldSuppressDisplay = createShouldSuppressDisplay();
+    const propositionsToExecute = propositions.map(proposition => createProposition(proposition, true, shouldSuppressDisplay(proposition)));
+    const {
+      render,
+      returnedPropositions
+    } = processPropositions(propositionsToExecute);
+    const handleNotifications = notificationHandler(renderDecisions, sendDisplayEvent, viewName);
+    const propositionsById = propositionsToExecute.reduce((tot, proposition) => {
+      tot[proposition.getId()] = proposition;
+      return tot;
+    }, {});
+    render().then(decisionsMeta => {
+      const decisionsMetaDisplay = decisionsMeta.filter(meta => !propositionsById[meta.id].shouldSuppressDisplay());
+      const decisionsMetaSuppressed = decisionsMeta.filter(meta => propositionsById[meta.id].shouldSuppressDisplay());
+      handleNotifications(decisionsMetaDisplay, decisionsMetaSuppressed);
+    });
+    return Promise.resolve({
+      propositions: returnedPropositions
+    });
+  };
+};
+exports.default = _default;

package/libEs5/components/Personalization/createPersonalizationDetails.js

@@ -0,0 +1,98 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _surfaceUtils = require("./utils/surfaceUtils.js");
+var _pageWideScope = require("../../constants/pageWideScope.js");
+var _schema = require("../../constants/schema.js");
+/*
+Copyright 2020 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.
+*/
+
+const addPageWideScope = scopes => {
+  if (!scopes.includes(_pageWideScope.default)) {
+    scopes.push(_pageWideScope.default);
+  }
+};
+const addPageSurface = (surfaces, getPageLocation) => {
+  const pageSurface = (0, _surfaceUtils.buildPageSurface)(getPageLocation);
+  if (!surfaces.includes(pageSurface)) {
+    surfaces.push(pageSurface);
+  }
+};
+const dedupe = array => array.filter((item, pos) => array.indexOf(item) === pos);
+var _default = ({
+  getPageLocation,
+  renderDecisions,
+  decisionScopes,
+  personalization,
+  event,
+  isCacheInitialized,
+  logger
+}) => {
+  const viewName = event.getViewName();
+  return {
+    isRenderDecisions() {
+      return renderDecisions;
+    },
+    isSendDisplayEvent() {
+      return !!personalization.sendDisplayEvent;
+    },
+    shouldIncludeRenderedPropositions() {
+      return !!personalization.includeRenderedPropositions;
+    },
+    getViewName() {
+      return viewName;
+    },
+    hasScopes() {
+      return decisionScopes.length > 0 || (0, _index.isNonEmptyArray)(personalization.decisionScopes);
+    },
+    hasSurfaces() {
+      return (0, _index.isNonEmptyArray)(personalization.surfaces);
+    },
+    hasViewName() {
+      return (0, _index.isNonEmptyString)(viewName);
+    },
+    createQueryDetails() {
+      const scopes = [...decisionScopes];
+      if ((0, _index.isNonEmptyArray)(personalization.decisionScopes)) {
+        scopes.push(...personalization.decisionScopes);
+      }
+      const eventSurfaces = (0, _surfaceUtils.normalizeSurfaces)(personalization.surfaces, getPageLocation, logger);
+      if (this.shouldRequestDefaultPersonalization()) {
+        addPageWideScope(scopes);
+        addPageSurface(eventSurfaces, getPageLocation);
+      }
+      const schemas = [_schema.DEFAULT_CONTENT_ITEM, _schema.HTML_CONTENT_ITEM, _schema.JSON_CONTENT_ITEM, _schema.REDIRECT_ITEM, _schema.RULESET_ITEM, _schema.MESSAGE_IN_APP, _schema.MESSAGE_CONTENT_CARD];
+      if (scopes.includes(_pageWideScope.default)) {
+        schemas.push(_schema.DOM_ACTION);
+      }
+      return {
+        schemas,
+        decisionScopes: dedupe(scopes),
+        surfaces: dedupe(eventSurfaces)
+      };
+    },
+    isCacheInitialized() {
+      return isCacheInitialized;
+    },
+    shouldFetchData() {
+      return this.hasScopes() || this.hasSurfaces() || this.shouldRequestDefaultPersonalization();
+    },
+    shouldUseCachedData() {
+      return this.hasViewName() && !this.shouldFetchData();
+    },
+    shouldRequestDefaultPersonalization() {
+      return personalization.defaultPersonalizationEnabled || !this.isCacheInitialized() && personalization.defaultPersonalizationEnabled !== false;
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Personalization/createSetTargetMigration.js

@@ -0,0 +1,30 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.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 = ({
+  targetMigrationEnabled
+}) => {
+  if (targetMigrationEnabled) {
+    return request => {
+      request.getPayload().mergeMeta({
+        target: {
+          migration: true
+        }
+      });
+    };
+  }
+  return _index.noop;
+};
+exports.default = _default;

package/libEs5/components/Personalization/createViewCacheManager.js

@@ -0,0 +1,87 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _defer = require("../../utils/defer.js");
+var _schema = require("../../constants/schema.js");
+var _scopeType = require("./constants/scopeType.js");
+/*
+Copyright 2020 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 = ({
+  createProposition
+}) => {
+  let cacheUpdateCreatedAtLeastOnce = false;
+  let viewStoragePromise = Promise.resolve({});
+  const getViewPropositions = (viewStorage, viewName) => {
+    const viewPropositions = viewStorage[viewName.toLowerCase()];
+    if (viewPropositions && viewPropositions.length > 0) {
+      return viewPropositions;
+    }
+    const emptyViewProposition = createProposition({
+      scope: viewName,
+      scopeDetails: {
+        characteristics: {
+          scopeType: _scopeType.VIEW_SCOPE_TYPE
+        }
+      },
+      items: [{
+        schema: _schema.DEFAULT_CONTENT_ITEM
+      }]
+    }, false);
+    return [emptyViewProposition];
+  };
+
+  // This should be called before making the request to experience edge.
+  const createCacheUpdate = viewName => {
+    const updateCacheDeferred = (0, _defer.default)();
+    cacheUpdateCreatedAtLeastOnce = true;
+
+    // Additional updates will merge the new view propositions with the old.
+    // i.e. if there are new "cart" view propositions they will overwrite the
+    // old "cart" view propositions, but if there are no new "cart" view
+    // propositions the old "cart" view propositions will remain.
+    viewStoragePromise = viewStoragePromise.then(oldViewStorage => {
+      return updateCacheDeferred.promise.then(newViewStorage => {
+        return {
+          ...oldViewStorage,
+          ...newViewStorage
+        };
+      }).catch(() => oldViewStorage);
+    });
+    return {
+      update(viewPropositions) {
+        const viewPropositionsWithScope = viewPropositions.filter(proposition => proposition.getScope());
+        const newViewStorage = (0, _index.groupBy)(viewPropositionsWithScope, proposition => proposition.getScope().toLowerCase());
+        updateCacheDeferred.resolve(newViewStorage);
+        if (viewName) {
+          return getViewPropositions(newViewStorage, viewName);
+        }
+        return [];
+      },
+      cancel() {
+        updateCacheDeferred.reject();
+      }
+    };
+  };
+  const getView = viewName => {
+    return viewStoragePromise.then(viewStorage => getViewPropositions(viewStorage, viewName));
+  };
+  const isInitialized = () => {
+    return cacheUpdateCreatedAtLeastOnce;
+  };
+  return {
+    createCacheUpdate,
+    getView,
+    isInitialized
+  };
+};
+exports.default = _default;

package/libEs5/components/Personalization/createViewChangeHandler.js

@@ -0,0 +1,60 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2020 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 = ({
+  processPropositions,
+  viewCache,
+  logger
+}) => {
+  return ({
+    personalizationDetails,
+    onResponse
+  }) => {
+    let returnedPropositions;
+    let returnedDecisions;
+    const viewName = personalizationDetails.getViewName();
+    onResponse(() => {
+      return {
+        propositions: returnedPropositions,
+        decisions: returnedDecisions
+      };
+    });
+    return viewCache.getView(viewName).then(propositions => {
+      let render;
+      if (personalizationDetails.isRenderDecisions()) {
+        ({
+          render,
+          returnedPropositions,
+          returnedDecisions
+        } = processPropositions(propositions));
+        logger.logOnContentRendering({
+          status: "rendering-started",
+          message: "Started rendering propositions for view scope - " + viewName + ".",
+          logLevel: "info",
+          detail: {
+            scope: viewName,
+            propositions: propositions.map(proposition => proposition.toJSON())
+          }
+        });
+        return render();
+      }
+      ({
+        returnedPropositions,
+        returnedDecisions
+      } = processPropositions([], propositions));
+      return [];
+    });
+  };
+};
+exports.default = _default;

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

@@ -0,0 +1,154 @@
+"use strict";
+
+Object.defineProperty(exports, "appendHtml", {
+  enumerable: true,
+  get: function () {
+    return _appendHtml.default;
+  }
+});
+exports.createAction = void 0;
+Object.defineProperty(exports, "insertHtmlAfter", {
+  enumerable: true,
+  get: function () {
+    return _insertHtmlAfter.default;
+  }
+});
+Object.defineProperty(exports, "insertHtmlBefore", {
+  enumerable: true,
+  get: function () {
+    return _insertHtmlBefore.default;
+  }
+});
+Object.defineProperty(exports, "prependHtml", {
+  enumerable: true,
+  get: function () {
+    return _prependHtml.default;
+  }
+});
+Object.defineProperty(exports, "rearrangeChildren", {
+  enumerable: true,
+  get: function () {
+    return _rearrangeChildren.default;
+  }
+});
+Object.defineProperty(exports, "replaceHtml", {
+  enumerable: true,
+  get: function () {
+    return _replaceHtml.default;
+  }
+});
+Object.defineProperty(exports, "setAttributes", {
+  enumerable: true,
+  get: function () {
+    return _setAttributes.default;
+  }
+});
+Object.defineProperty(exports, "setHtml", {
+  enumerable: true,
+  get: function () {
+    return _setHtml.default;
+  }
+});
+Object.defineProperty(exports, "setStyles", {
+  enumerable: true,
+  get: function () {
+    return _setStyles.default;
+  }
+});
+Object.defineProperty(exports, "setText", {
+  enumerable: true,
+  get: function () {
+    return _setText.default;
+  }
+});
+Object.defineProperty(exports, "swapImage", {
+  enumerable: true,
+  get: function () {
+    return _swapImage.default;
+  }
+});
+var _index = require("../../../utils/dom/index.js");
+var _index2 = require("../flicker/index.js");
+var _index3 = require("./dom/index.js");
+var _setText = require("./setText.js");
+var _setHtml = require("./setHtml.js");
+var _appendHtml = require("./appendHtml.js");
+var _prependHtml = require("./prependHtml.js");
+var _replaceHtml = require("./replaceHtml.js");
+var _insertHtmlBefore = require("./insertHtmlBefore.js");
+var _insertHtmlAfter = require("./insertHtmlAfter.js");
+var _setStyles = require("./setStyles.js");
+var _setAttributes = require("./setAttributes.js");
+var _swapImage = require("./swapImage.js");
+var _rearrangeChildren = require("./rearrangeChildren.js");
+/*
+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.
+*/
+
+/**
+ * Renders content into a container element.
+ *
+ * @param {Object} params
+ * @param {Element[]} params.containers
+ * @param {string} params.content
+ * @param {(element: Element) => void} params.decorateProposition
+ * @param {(container: Element, content: string, decorateProposition: (element: Element) => void) => Promise<void>} params.renderFunc
+ * @returns {Promise<void>} A promise that resolves when the content is rendered.
+ */
+const renderContent = ({
+  containers,
+  content,
+  decorateProposition,
+  renderFunc,
+  renderStatusHandler
+}) => {
+  const executions = containers.filter(renderStatusHandler.shouldRender).map(async container => {
+    await renderFunc(container, content, decorateProposition);
+    renderStatusHandler.markAsRendered(container);
+  });
+  return Promise.all(executions);
+};
+
+/**
+ * Creates an action function that renders content into a container element.
+ *
+ * @param {Function} renderFunc - The function that performs the rendering.
+ */
+const createAction = renderFunc => {
+  /**
+   * Renders content into a container element.
+   *
+   * @param {{ selector: string, prehidingSelector: string, content: string }} itemData - The item data containing the container selector and prehiding selector.
+   * @param {(element: Element) => void} createDecorateProposition
+   * @param {{ shouldRender: (element: Element) => boolean, markAsRendered: (element: Element) => void }} renderStatusHandler
+   */
+  return async (itemData, decorateProposition, renderStatusHandler) => {
+    const {
+      selector: containerSelector,
+      prehidingSelector,
+      content
+    } = itemData;
+    (0, _index2.hideElements)(prehidingSelector);
+    try {
+      const containers = await (0, _index.awaitSelector)(containerSelector, _index3.selectNodesWithEq);
+      renderContent({
+        containers,
+        content,
+        decorateProposition,
+        renderFunc,
+        renderStatusHandler
+      });
+    } finally {
+      (0, _index2.showElements)(prehidingSelector);
+    }
+  };
+};
+exports.createAction = createAction;

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

@@ -0,0 +1,39 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../../utils/dom/index.js");
+var _tagName = require("../../../constants/tagName.js");
+var _elementAttribute = require("../../../constants/elementAttribute.js");
+var _index2 = require("./dom/index.js");
+/*
+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.
+*/
+
+const is = (element, tagName) => element.tagName === tagName;
+const isInlineStyleElement = element => is(element, _tagName.STYLE) && !(0, _index2.getAttribute)(element, _elementAttribute.SRC);
+var _default = fragment => {
+  const styleNodes = (0, _index.selectNodes)(_tagName.STYLE, fragment);
+  const {
+    length
+  } = styleNodes;
+  const nonce = (0, _index2.getNonce)();
+  if (!nonce) {
+    return;
+  }
+  for (let i = 0; i < length; i += 1) {
+    const element = styleNodes[i];
+    if (!isInlineStyleElement(element)) {
+      continue;
+    }
+    element.nonce = nonce;
+  }
+};
+exports.default = _default;

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

@@ -0,0 +1,34 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../../utils/dom/index.js");
+var _index2 = require("./dom/index.js");
+var _images = require("./images.js");
+var _addNonceToInlineStyleElements = require("./addNonceToInlineStyleElements.js");
+var _scripts = require("./scripts.js");
+/*
+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.
+*/
+var _default = (container, html, decorateProposition) => {
+  const fragment = (0, _index2.createFragment)(html);
+  (0, _addNonceToInlineStyleElements.default)(fragment);
+  const elements = (0, _index2.getChildNodes)(fragment);
+  const scripts = (0, _scripts.getInlineScripts)(fragment);
+  const scriptsUrls = (0, _scripts.getRemoteScriptsUrls)(fragment);
+  (0, _images.loadImages)(fragment);
+  elements.forEach(element => {
+    (0, _index.appendNode)(container, element);
+  });
+  decorateProposition(container);
+  (0, _scripts.executeInlineScripts)(container, scripts);
+  return (0, _scripts.executeRemoteScripts)(scriptsUrls);
+};
+exports.default = _default;