@adobe/alloy 2.27.0 → 2.28.0-beta.0

package/libEs6/components/Personalization/createNotificationHandler.js

@@ -1,45 +0,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.
-*/
-import { defer } from "../../utils/index.js";
-import { SUPPRESS } from "../../constants/eventType.js";
-import isNonEmptyArray from "../../utils/isNonEmptyArray.js";
-export default (collect, renderedPropositions) => {
-  return (isRenderDecisions, isSendDisplayEvent, viewName) => {
-    if (!isRenderDecisions) {
-      // If we aren't rendering anything, then we don't need to sendDisplayEvents.
-      return () => undefined;
-    }
-    if (!isSendDisplayEvent) {
-      const renderedPropositionsDeferred = defer();
-      renderedPropositions.concat(renderedPropositionsDeferred.promise);
-      return renderedPropositionsDeferred.resolve;
-    }
-    return (decisionsMetaDisplay = [], decisionsMetaSuppressed = []) => {
-      if (isNonEmptyArray(decisionsMetaDisplay)) {
-        collect({
-          decisionsMeta: decisionsMetaDisplay,
-          viewName
-        });
-      }
-      if (isNonEmptyArray(decisionsMetaSuppressed)) {
-        collect({
-          decisionsMeta: decisionsMetaSuppressed,
-          eventType: SUPPRESS,
-          propositionAction: {
-            reason: "Conflict"
-          },
-          viewName
-        });
-      }
-    };
-  };
-};

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -1,79 +0,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.
-*/
-
-import { isNonEmptyArray } from "../../utils/index.js";
-import { INTERACT } from "../../constants/eventType.js";
-import { PropositionEventType } from "../../constants/propositionEventType.js";
-const createPropositionAction = (clickLabel, clickToken) => {
-  if (!clickToken && !clickLabel) {
-    return undefined;
-  }
-  const propositionAction = {};
-  if (clickLabel) {
-    propositionAction.label = clickLabel;
-  }
-  if (clickToken) {
-    propositionAction.tokens = [clickToken];
-  }
-  return propositionAction;
-};
-export 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 (isNonEmptyArray(decisionsMeta)) {
-      const xdm = {
-        eventType: INTERACT
-      };
-      if (viewName) {
-        xdm.web = {
-          webPageDetails: {
-            viewName
-          }
-        };
-      }
-      event.mergeXdm(xdm);
-      mergeDecisionsMeta(event, decisionsMeta, [PropositionEventType.INTERACT], createPropositionAction(propositionActionLabel, propositionActionToken));
-    }
-  };
-};

package/libEs6/components/Personalization/createOnDecisionHandler.js

@@ -1,70 +0,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.
-*/
-
-import { MESSAGE_IN_APP } from "../../constants/schema.js";
-
-// 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 === MESSAGE_IN_APP)) {
-      return false;
-    }
-    count += 1;
-    return count > 1;
-  };
-};
-export 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
-    });
-  };
-};

package/libEs6/components/Personalization/createPersonalizationDetails.js

@@ -1,94 +0,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.
-*/
-
-import { isNonEmptyString, isNonEmptyArray } from "../../utils/index.js";
-import { buildPageSurface, normalizeSurfaces } from "./utils/surfaceUtils.js";
-import PAGE_WIDE_SCOPE from "../../constants/pageWideScope.js";
-import { DEFAULT_CONTENT_ITEM, DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP, JSON_CONTENT_ITEM, REDIRECT_ITEM, RULESET_ITEM, MESSAGE_CONTENT_CARD } from "../../constants/schema.js";
-const addPageWideScope = scopes => {
-  if (!scopes.includes(PAGE_WIDE_SCOPE)) {
-    scopes.push(PAGE_WIDE_SCOPE);
-  }
-};
-const addPageSurface = (surfaces, getPageLocation) => {
-  const pageSurface = buildPageSurface(getPageLocation);
-  if (!surfaces.includes(pageSurface)) {
-    surfaces.push(pageSurface);
-  }
-};
-const dedupe = array => array.filter((item, pos) => array.indexOf(item) === pos);
-export 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 || isNonEmptyArray(personalization.decisionScopes);
-    },
-    hasSurfaces() {
-      return isNonEmptyArray(personalization.surfaces);
-    },
-    hasViewName() {
-      return isNonEmptyString(viewName);
-    },
-    createQueryDetails() {
-      const scopes = [...decisionScopes];
-      if (isNonEmptyArray(personalization.decisionScopes)) {
-        scopes.push(...personalization.decisionScopes);
-      }
-      const eventSurfaces = normalizeSurfaces(personalization.surfaces, getPageLocation, logger);
-      if (this.shouldRequestDefaultPersonalization()) {
-        addPageWideScope(scopes);
-        addPageSurface(eventSurfaces, getPageLocation);
-      }
-      const schemas = [DEFAULT_CONTENT_ITEM, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM, RULESET_ITEM, MESSAGE_IN_APP, MESSAGE_CONTENT_CARD];
-      if (scopes.includes(PAGE_WIDE_SCOPE)) {
-        schemas.push(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;
-    }
-  };
-};

package/libEs6/components/Personalization/createSetTargetMigration.js

@@ -1,27 +0,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.
-*/
-
-import { noop } from "../../utils/index.js";
-export default ({
-  targetMigrationEnabled
-}) => {
-  if (targetMigrationEnabled) {
-    return request => {
-      request.getPayload().mergeMeta({
-        target: {
-          migration: true
-        }
-      });
-    };
-  }
-  return noop;
-};

package/libEs6/components/Personalization/createViewCacheManager.js

@@ -1,84 +0,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.
-*/
-
-import { groupBy } from "../../utils/index.js";
-import defer from "../../utils/defer.js";
-import { DEFAULT_CONTENT_ITEM } from "../../constants/schema.js";
-import { VIEW_SCOPE_TYPE } from "./constants/scopeType.js";
-export 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: VIEW_SCOPE_TYPE
-        }
-      },
-      items: [{
-        schema: DEFAULT_CONTENT_ITEM
-      }]
-    }, false);
-    return [emptyViewProposition];
-  };
-
-  // This should be called before making the request to experience edge.
-  const createCacheUpdate = viewName => {
-    const updateCacheDeferred = defer();
-    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 = 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
-  };
-};

package/libEs6/components/Personalization/createViewChangeHandler.js

@@ -1,57 +0,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.
-*/
-
-export 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 [];
-    });
-  };
-};

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

@@ -1,85 +0,0 @@
-/*
-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.
-*/
-
-import { awaitSelector } from "../../../utils/dom/index.js";
-import { hideElements, showElements } from "../flicker/index.js";
-import { selectNodesWithEq } from "./dom/index.js";
-export { default as setText } from "./setText.js";
-export { default as setHtml } from "./setHtml.js";
-export { default as appendHtml } from "./appendHtml.js";
-export { default as prependHtml } from "./prependHtml.js";
-export { default as replaceHtml } from "./replaceHtml.js";
-export { default as insertHtmlBefore } from "./insertHtmlBefore.js";
-export { default as insertHtmlAfter } from "./insertHtmlAfter.js";
-export { default as setStyles } from "./setStyles.js";
-export { default as setAttributes } from "./setAttributes.js";
-export { default as swapImage } from "./swapImage.js";
-export { default as rearrangeChildren } from "./rearrangeChildren.js";
-
-/**
- * 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.
- */
-export 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;
-    hideElements(prehidingSelector);
-    try {
-      const containers = await awaitSelector(containerSelector, selectNodesWithEq);
-      renderContent({
-        containers,
-        content,
-        decorateProposition,
-        renderFunc,
-        renderStatusHandler
-      });
-    } finally {
-      showElements(prehidingSelector);
-    }
-  };
-};

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

@@ -1,36 +0,0 @@
-/*
-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.
-*/
-
-import { selectNodes } from "../../../utils/dom/index.js";
-import { STYLE } from "../../../constants/tagName.js";
-import { SRC } from "../../../constants/elementAttribute.js";
-import { getAttribute, getNonce } from "./dom/index.js";
-const is = (element, tagName) => element.tagName === tagName;
-const isInlineStyleElement = element => is(element, STYLE) && !getAttribute(element, SRC);
-export default fragment => {
-  const styleNodes = selectNodes(STYLE, fragment);
-  const {
-    length
-  } = styleNodes;
-  const nonce = getNonce();
-  if (!nonce) {
-    return;
-  }
-  /* eslint-disable no-continue */
-  for (let i = 0; i < length; i += 1) {
-    const element = styleNodes[i];
-    if (!isInlineStyleElement(element)) {
-      continue;
-    }
-    element.nonce = nonce;
-  }
-};

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

@@ -1,31 +0,0 @@
-/*
-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.
-*/
-
-import { appendNode } from "../../../utils/dom/index.js";
-import { createFragment, getChildNodes } from "./dom/index.js";
-import { loadImages } from "./images.js";
-import addNonceToInlineStyleElements from "./addNonceToInlineStyleElements.js";
-import { executeInlineScripts, executeRemoteScripts, getInlineScripts, getRemoteScriptsUrls } from "./scripts.js";
-export default (container, html, decorateProposition) => {
-  const fragment = createFragment(html);
-  addNonceToInlineStyleElements(fragment);
-  const elements = getChildNodes(fragment);
-  const scripts = getInlineScripts(fragment);
-  const scriptsUrls = getRemoteScriptsUrls(fragment);
-  loadImages(fragment);
-  elements.forEach(element => {
-    appendNode(container, element);
-  });
-  decorateProposition(container);
-  executeInlineScripts(container, scripts);
-  return executeRemoteScripts(scriptsUrls);
-};