@adobe/alloy 2.20.0-alpha.1 → 2.20.0-beta.2

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

@@ -1,42 +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.
-*/
-export default (({
-  logger,
-  executeRedirect,
-  collect
-}) => item => {
-  const {
-    content
-  } = item.getData() || {};
-  if (!content) {
-    logger.warn("Invalid Redirect data", item.getData());
-    return {};
-  }
-  const render = () => {
-    return collect({
-      decisionsMeta: [item.getProposition().getNotification()],
-      documentMayUnload: true
-    }).then(() => {
-      return executeRedirect(content);
-      // Execute redirect will never resolve. If there are bottom of page events that are waiting
-      // for display notifications from this request, they will never run because this promise will
-      // not resolve. This is intentional because we don't want to run bottom of page events if
-      // there is a redirect.
-    });
-  };
-
-  return {
-    render,
-    setRenderAttempted: true,
-    onlyRenderThis: true
-  };
-});

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

@@ -1,110 +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 PAGE_WIDE_SCOPE from "../../../constants/pageWideScope";
-import { VIEW_SCOPE_TYPE, PAGE_SCOPE_TYPE, PROPOSITION_SCOPE_TYPE } from "../constants/scopeType";
-export default (({
-  preprocess,
-  isPageWideSurface
-}) => {
-  const createItem = (item, proposition) => {
-    const {
-      schema,
-      data,
-      characteristics: {
-        trackingLabel
-      } = {}
-    } = item;
-    const processedData = preprocess(data);
-    return {
-      getSchema() {
-        return schema;
-      },
-      getData() {
-        return processedData;
-      },
-      getProposition() {
-        return proposition;
-      },
-      getTrackingLabel() {
-        return trackingLabel;
-      },
-      getOriginalItem() {
-        return item;
-      },
-      toString() {
-        return JSON.stringify(item);
-      },
-      toJSON() {
-        return item;
-      }
-    };
-  };
-  return (payload, visibleInReturnedItems = true) => {
-    const {
-      id,
-      scope,
-      scopeDetails,
-      items = []
-    } = payload;
-    const {
-      characteristics: {
-        scopeType
-      } = {}
-    } = scopeDetails || {};
-    return {
-      getScope() {
-        if (!scope) {
-          return scope;
-        }
-        return scope;
-      },
-      getScopeType() {
-        if (scope === PAGE_WIDE_SCOPE || isPageWideSurface(scope)) {
-          return PAGE_SCOPE_TYPE;
-        }
-        if (scopeType === VIEW_SCOPE_TYPE) {
-          return VIEW_SCOPE_TYPE;
-        }
-        return PROPOSITION_SCOPE_TYPE;
-      },
-      getItems() {
-        return items.map(item => createItem(item, this));
-      },
-      getNotification() {
-        return {
-          id,
-          scope,
-          scopeDetails
-        };
-      },
-      toJSON() {
-        return payload;
-      },
-      addToReturnValues(propositions, decisions, includedItems, renderAttempted) {
-        if (visibleInReturnedItems) {
-          propositions.push({
-            ...payload,
-            items: includedItems.map(i => i.getOriginalItem()),
-            renderAttempted
-          });
-          if (!renderAttempted) {
-            decisions.push({
-              ...payload,
-              items: includedItems.map(i => i.getOriginalItem())
-            });
-          }
-        }
-      }
-    };
-  };
-});

package/libEs6/components/Personalization/handlers/processDefaultContent.js

@@ -1,17 +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.
-*/
-export default (() => {
-  return {
-    setRenderAttempted: true,
-    includeInNotification: true
-  };
-});

package/libEs6/components/Personalization/in-app-message-actions/actions/displayIframeContent.js

@@ -1,291 +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 { getNonce } from "../../dom-actions/dom";
-import { parseAnchor, removeElementById } from "../utils";
-import { TEXT_HTML } from "../../../../constants/contentType";
-import { assign, includes, isNonEmptyString, values } from "../../../../utils";
-import { createNode } from "../../../../utils/dom";
-import { objectOf } from "../../../../utils/validation";
-import { PropositionEventType } from "../../../../constants/propositionEventType";
-import { EVENT_TYPE_TRUE, INTERACT } from "../../../../constants/eventType";
-import createRedirect from "../../dom-actions/createRedirect";
-const MESSAGING_CONTAINER_ID = "alloy-messaging-container";
-const OVERLAY_CONTAINER_ID = "alloy-overlay-container";
-const IFRAME_ID = "alloy-content-iframe";
-const dismissMessage = () => [MESSAGING_CONTAINER_ID, OVERLAY_CONTAINER_ID].forEach(removeElementById);
-export const createIframeClickHandler = (interact, navigateToUrl = createRedirect(window)) => {
-  return event => {
-    event.preventDefault();
-    event.stopImmediatePropagation();
-    const {
-      target
-    } = event;
-    const anchor = target.tagName.toLowerCase() === "a" ? target : target.closest("a");
-    if (!anchor) {
-      return;
-    }
-    const {
-      action,
-      interaction,
-      link,
-      label,
-      uuid
-    } = parseAnchor(anchor);
-    interact(action, {
-      label,
-      id: interaction,
-      uuid,
-      link
-    });
-    if (action === "dismiss") {
-      dismissMessage();
-    }
-    if (isNonEmptyString(link) && link.length > 0) {
-      navigateToUrl(link, true);
-    }
-  };
-};
-export const createIframe = (htmlContent, clickHandler) => {
-  const parser = new DOMParser();
-  const htmlDocument = parser.parseFromString(htmlContent, TEXT_HTML);
-  const scriptTag = htmlDocument.querySelector("script");
-  if (scriptTag) {
-    scriptTag.setAttribute("nonce", getNonce());
-  }
-  const element = createNode("iframe", {
-    src: URL.createObjectURL(new Blob([htmlDocument.documentElement.outerHTML], {
-      type: "text/html"
-    })),
-    id: IFRAME_ID
-  });
-  element.addEventListener("load", () => {
-    const {
-      addEventListener
-    } = element.contentDocument || element.contentWindow.document;
-    addEventListener("click", clickHandler);
-  });
-  return element;
-};
-const renderMessage = (iframe, webParameters, container, overlay) => {
-  [{
-    id: OVERLAY_CONTAINER_ID,
-    element: overlay
-  }, {
-    id: MESSAGING_CONTAINER_ID,
-    element: container
-  }, {
-    id: IFRAME_ID,
-    element: iframe
-  }].forEach(({
-    id,
-    element
-  }) => {
-    const {
-      style = {},
-      params = {}
-    } = webParameters[id];
-    assign(element.style, style);
-    const {
-      parentElement = "body",
-      insertionMethod = "appendChild",
-      enabled = true
-    } = params;
-    const parent = document.querySelector(parentElement);
-    if (enabled && parent && typeof parent[insertionMethod] === "function") {
-      parent[insertionMethod](element);
-    }
-  });
-};
-export const buildStyleFromMobileParameters = mobileParameters => {
-  const {
-    verticalAlign,
-    width,
-    horizontalAlign,
-    backdropColor,
-    height,
-    cornerRadius,
-    horizontalInset,
-    verticalInset,
-    uiTakeover = false
-  } = mobileParameters;
-  const style = {
-    width: width ? `${width}%` : "100%",
-    backgroundColor: backdropColor || "rgba(0, 0, 0, 0.5)",
-    borderRadius: cornerRadius ? `${cornerRadius}px` : "0px",
-    border: "none",
-    position: uiTakeover ? "fixed" : "relative",
-    overflow: "hidden"
-  };
-  if (horizontalAlign === "left") {
-    style.left = horizontalInset ? `${horizontalInset}%` : "0";
-  } else if (horizontalAlign === "right") {
-    style.right = horizontalInset ? `${horizontalInset}%` : "0";
-  } else if (horizontalAlign === "center") {
-    style.left = "50%";
-    style.transform = "translateX(-50%)";
-  }
-  if (verticalAlign === "top") {
-    style.top = verticalInset ? `${verticalInset}%` : "0";
-  } else if (verticalAlign === "bottom") {
-    style.position = "fixed";
-    style.bottom = verticalInset ? `${verticalInset}%` : "0";
-  } else if (verticalAlign === "center") {
-    style.top = "50%";
-    style.transform = `${horizontalAlign === "center" ? `${style.transform} ` : ""}translateY(-50%)`;
-    style.display = "flex";
-    style.alignItems = "center";
-    style.justifyContent = "center";
-  }
-  if (height) {
-    style.height = `${height}vh`;
-  } else {
-    style.height = "100%";
-  }
-  return style;
-};
-export const mobileOverlay = mobileParameters => {
-  const {
-    backdropOpacity,
-    backdropColor
-  } = mobileParameters;
-  const opacity = backdropOpacity || 0.5;
-  const color = backdropColor || "#FFFFFF";
-  const style = {
-    position: "fixed",
-    top: "0",
-    left: "0",
-    width: "100%",
-    height: "100%",
-    background: "transparent",
-    opacity,
-    backgroundColor: color
-  };
-  return style;
-};
-const REQUIRED_PARAMS = ["enabled", "parentElement", "insertionMethod"];
-const isValidWebParameters = webParameters => {
-  if (!webParameters) {
-    return false;
-  }
-  const ids = Object.keys(webParameters);
-  if (!includes(ids, MESSAGING_CONTAINER_ID)) {
-    return false;
-  }
-  if (!includes(ids, OVERLAY_CONTAINER_ID)) {
-    return false;
-  }
-  const valuesArray = values(webParameters);
-  for (let i = 0; i < valuesArray.length; i += 1) {
-    if (!objectOf(valuesArray[i], "style")) {
-      return false;
-    }
-    if (!objectOf(valuesArray[i], "params")) {
-      return false;
-    }
-    for (let j = 0; j < REQUIRED_PARAMS.length; j += 1) {
-      if (!objectOf(valuesArray[i].params, REQUIRED_PARAMS[j])) {
-        return false;
-      }
-    }
-  }
-  return true;
-};
-const generateWebParameters = mobileParameters => {
-  if (!mobileParameters) {
-    return undefined;
-  }
-  const {
-    uiTakeover = false
-  } = mobileParameters;
-  return {
-    [IFRAME_ID]: {
-      style: {
-        border: "none",
-        width: "100%",
-        height: "100%"
-      },
-      params: {
-        enabled: true,
-        parentElement: "#alloy-messaging-container",
-        insertionMethod: "appendChild"
-      }
-    },
-    [MESSAGING_CONTAINER_ID]: {
-      style: buildStyleFromMobileParameters(mobileParameters),
-      params: {
-        enabled: true,
-        parentElement: "body",
-        insertionMethod: "appendChild"
-      }
-    },
-    [OVERLAY_CONTAINER_ID]: {
-      style: mobileOverlay(mobileParameters),
-      params: {
-        enabled: uiTakeover === true,
-        parentElement: "body",
-        insertionMethod: "appendChild"
-      }
-    }
-  };
-};
-export const displayHTMLContentInIframe = (settings = {}, interact) => {
-  dismissMessage();
-  const {
-    content,
-    contentType,
-    mobileParameters
-  } = settings;
-  let {
-    webParameters
-  } = settings;
-  if (contentType !== TEXT_HTML) {
-    return;
-  }
-  const container = createNode("div", {
-    id: MESSAGING_CONTAINER_ID
-  });
-  const iframe = createIframe(content, createIframeClickHandler(interact));
-  const overlay = createNode("div", {
-    id: OVERLAY_CONTAINER_ID
-  });
-  if (!isValidWebParameters(webParameters)) {
-    webParameters = generateWebParameters(mobileParameters);
-  }
-  if (!webParameters) {
-    return;
-  }
-  renderMessage(iframe, webParameters, container, overlay);
-};
-export default ((settings, collect) => {
-  return new Promise(resolve => {
-    const {
-      meta
-    } = settings;
-    displayHTMLContentInIframe(settings, (action, propositionAction) => {
-      const propositionEventTypes = {};
-      propositionEventTypes[PropositionEventType.INTERACT] = EVENT_TYPE_TRUE;
-      if (Object.values(PropositionEventType).indexOf(action) !== -1) {
-        propositionEventTypes[action] = EVENT_TYPE_TRUE;
-      }
-      collect({
-        decisionsMeta: [meta],
-        propositionAction,
-        eventType: INTERACT,
-        propositionEventTypes: Object.keys(propositionEventTypes)
-      });
-    });
-    resolve({
-      meta
-    });
-  });
-});

package/libEs6/components/Personalization/in-app-message-actions/initInAppMessageActionsModules.js

@@ -1,17 +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 displayIframeContent from "./actions/displayIframeContent";
-export default (collect => {
-  return {
-    defaultContent: settings => displayIframeContent(settings, collect)
-  };
-});

package/libEs6/components/Personalization/in-app-message-actions/utils.js

@@ -1,49 +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 { isNonEmptyArray, queryString, startsWith } from "../../../utils";
-import { removeNode, selectNodes } from "../../../utils/dom";
-export const removeElementById = id => {
-  const element = selectNodes(`#${id}`, document);
-  if (element && element.length > 0) {
-    removeNode(element[0]);
-  }
-};
-export const parseAnchor = anchor => {
-  const nothing = {};
-  if (!anchor || anchor.tagName.toLowerCase() !== "a") {
-    return nothing;
-  }
-  const {
-    href
-  } = anchor;
-  if (!href || !startsWith(href, "adbinapp://")) {
-    return nothing;
-  }
-  const hrefParts = href.split("?");
-  const action = hrefParts[0].split("://")[1];
-  const label = anchor.innerText;
-  const uuid = anchor.getAttribute("data-uuid") || "";
-  let interaction;
-  let link;
-  if (isNonEmptyArray(hrefParts)) {
-    const queryParams = queryString.parse(hrefParts[1]);
-    interaction = queryParams.interaction || "";
-    link = decodeURIComponent(queryParams.link || "");
-  }
-  return {
-    action,
-    interaction,
-    link,
-    label,
-    uuid
-  };
-};

package/libEs6/components/Personalization/index.js

@@ -1,159 +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 { boolean, objectOf, string } from "../../utils/validation";
-import createComponent from "./createComponent";
-import { initDomActionsModules } from "./dom-actions";
-import createCollect from "./createCollect";
-import { hideContainers, showContainers } from "./flicker";
-import createFetchDataHandler from "./createFetchDataHandler";
-import collectClicks from "./dom-actions/clicks/collectClicks";
-import isAuthoringModeEnabled from "./utils/isAuthoringModeEnabled";
-import { mergeDecisionsMeta, mergeQuery } from "./event";
-import createOnClickHandler from "./createOnClickHandler";
-import createViewCacheManager from "./createViewCacheManager";
-import createViewChangeHandler from "./createViewChangeHandler";
-import createClickStorage from "./createClickStorage";
-import createApplyPropositions from "./createApplyPropositions";
-import createGetPageLocation from "./createGetPageLocation";
-import createSetTargetMigration from "./createSetTargetMigration";
-import remapCustomCodeOffers from "./dom-actions/remapCustomCodeOffers";
-import remapHeadOffers from "./dom-actions/remapHeadOffers";
-import createPreprocess from "./dom-actions/createPreprocess";
-import injectCreateProposition from "./handlers/injectCreateProposition";
-import createAsyncArray from "./utils/createAsyncArray";
-import * as schema from "../../constants/schema";
-import processDefaultContent from "./handlers/processDefaultContent";
-import { isPageWideSurface } from "./utils/surfaceUtils";
-import createProcessDomAction from "./handlers/createProcessDomAction";
-import createProcessHtmlContent from "./handlers/createProcessHtmlContent";
-import createProcessRedirect from "./handlers/createProcessRedirect";
-import createProcessPropositions from "./handlers/createProcessPropositions";
-import createOnDecisionHandler from "./createOnDecisionHandler";
-import createProcessInAppMessage from "./handlers/createProcessInAppMessage";
-import initInAppMessageActionsModules from "./in-app-message-actions/initInAppMessageActionsModules";
-import createRedirect from "./dom-actions/createRedirect";
-import createNotificationHandler from "./createNotificationHandler";
-const createPersonalization = ({
-  config,
-  logger,
-  eventManager
-}) => {
-  const {
-    targetMigrationEnabled,
-    prehidingStyle
-  } = config;
-  const collect = createCollect({
-    eventManager,
-    mergeDecisionsMeta
-  });
-  const {
-    getClickMetasBySelector,
-    getClickSelectors,
-    storeClickMetrics
-  } = createClickStorage();
-  const getPageLocation = createGetPageLocation({
-    window
-  });
-  const domActionsModules = initDomActionsModules();
-  const preprocess = createPreprocess([remapHeadOffers, remapCustomCodeOffers]);
-  const createProposition = injectCreateProposition({
-    preprocess,
-    isPageWideSurface
-  });
-  const viewCache = createViewCacheManager({
-    createProposition
-  });
-  const executeRedirect = createRedirect(window);
-  const schemaProcessors = {
-    [schema.DEFAULT_CONTENT_ITEM]: processDefaultContent,
-    [schema.DOM_ACTION]: createProcessDomAction({
-      modules: domActionsModules,
-      logger,
-      storeClickMetrics
-    }),
-    [schema.HTML_CONTENT_ITEM]: createProcessHtmlContent({
-      modules: domActionsModules,
-      logger
-    }),
-    [schema.REDIRECT_ITEM]: createProcessRedirect({
-      logger,
-      executeRedirect,
-      collect
-    }),
-    [schema.MESSAGE_IN_APP]: createProcessInAppMessage({
-      modules: initInAppMessageActionsModules(collect),
-      logger
-    })
-  };
-  const processPropositions = createProcessPropositions({
-    schemaProcessors,
-    logger
-  });
-  const renderedPropositions = createAsyncArray();
-  const notificationHandler = createNotificationHandler(collect, renderedPropositions);
-  const fetchDataHandler = createFetchDataHandler({
-    prehidingStyle,
-    showContainers,
-    hideContainers,
-    mergeQuery,
-    processPropositions,
-    createProposition,
-    notificationHandler
-  });
-  const onClickHandler = createOnClickHandler({
-    mergeDecisionsMeta,
-    collectClicks,
-    getClickSelectors,
-    getClickMetasBySelector
-  });
-  const viewChangeHandler = createViewChangeHandler({
-    processPropositions,
-    viewCache
-  });
-  const applyPropositions = createApplyPropositions({
-    processPropositions,
-    createProposition,
-    renderedPropositions,
-    viewCache
-  });
-  const setTargetMigration = createSetTargetMigration({
-    targetMigrationEnabled
-  });
-  const onDecisionHandler = createOnDecisionHandler({
-    processPropositions,
-    createProposition,
-    notificationHandler
-  });
-  return createComponent({
-    getPageLocation,
-    logger,
-    fetchDataHandler,
-    viewChangeHandler,
-    onClickHandler,
-    isAuthoringModeEnabled,
-    mergeQuery,
-    viewCache,
-    showContainers,
-    applyPropositions,
-    setTargetMigration,
-    mergeDecisionsMeta,
-    renderedPropositions,
-    onDecisionHandler
-  });
-};
-createPersonalization.namespace = "Personalization";
-createPersonalization.configValidators = objectOf({
-  prehidingStyle: string().nonEmpty(),
-  targetMigrationEnabled: boolean().default(false)
-});
-export default createPersonalization;