@adobe/alloy 2.28.0 → 2.28.1-beta.1

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

@@ -0,0 +1,28 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { setStyle } from "./dom/index.js";
+import { addPxIfMissing } from "./dom/util.js";
+export default (container, styles, decorateProposition) => {
+  const {
+    priority,
+    ...style
+  } = styles;
+  Object.keys(style).forEach(key => {
+    let value = style[key];
+    if (key === "width" || key === "height") {
+      value = addPxIfMissing(value);
+    }
+    setStyle(container, key, value, priority);
+  });
+  decorateProposition(container);
+};

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

@@ -0,0 +1,93 @@
+/*
+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, createNode } from "../../../utils/dom/index.js";
+import { SCRIPT } from "../../../constants/tagName.js";
+import { SRC } from "../../../constants/elementAttribute.js";
+import { getAttribute, getNonce } from "./dom/index.js";
+const getPromise = (url, script) => {
+  return new Promise((resolve, reject) => {
+    script.onload = () => {
+      resolve(script);
+    };
+    script.onerror = () => {
+      reject(new Error(`Failed to load script: ${url}`));
+    };
+  });
+};
+const loadScript = url => {
+  const script = document.createElement("script");
+  script.src = url;
+  script.async = true;
+  const promise = getPromise(url, script);
+  document.head.appendChild(script);
+  return promise;
+};
+export const is = (element, tagName) => !!element && element.tagName === tagName;
+const isInlineScript = element => is(element, SCRIPT) && !getAttribute(element, SRC);
+const isRemoteScript = element => is(element, SCRIPT) && getAttribute(element, SRC);
+export const getInlineScripts = fragment => {
+  const scripts = selectNodes(SCRIPT, fragment);
+  const result = [];
+  const {
+    length
+  } = scripts;
+  const nonce = getNonce();
+  const attributes = {
+    ...(nonce && {
+      nonce
+    })
+  };
+  for (let i = 0; i < length; i += 1) {
+    const element = scripts[i];
+    if (!isInlineScript(element)) {
+      continue;
+    }
+    const {
+      textContent
+    } = element;
+    if (!textContent) {
+      continue;
+    }
+    result.push(createNode(SCRIPT, attributes, {
+      textContent
+    }));
+  }
+  return result;
+};
+export const getRemoteScriptsUrls = fragment => {
+  const scripts = selectNodes(SCRIPT, fragment);
+  const result = [];
+  const {
+    length
+  } = scripts;
+  for (let i = 0; i < length; i += 1) {
+    const element = scripts[i];
+    if (!isRemoteScript(element)) {
+      continue;
+    }
+    const url = getAttribute(element, SRC);
+    if (!url) {
+      continue;
+    }
+    result.push(url);
+  }
+  return result;
+};
+export const executeInlineScripts = (parent, scripts) => {
+  scripts.forEach(script => {
+    parent.appendChild(script);
+    parent.removeChild(script);
+  });
+};
+export const executeRemoteScripts = urls => {
+  return Promise.all(urls.map(loadScript));
+};

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

@@ -0,0 +1,19 @@
+/*
+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 { setAttribute } from "./dom/index.js";
+export default (container, attributes, decorateProposition) => {
+  Object.keys(attributes).forEach(key => {
+    setAttribute(container, key, attributes[key]);
+  });
+  decorateProposition(container);
+};

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

@@ -0,0 +1,24 @@
+/*
+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 { removeNode } from "../../../utils/dom/index.js";
+import { getChildNodes } from "./dom/index.js";
+import appendHtml from "./appendHtml.js";
+const clear = container => {
+  // We want to remove ALL nodes, text, comments etc
+  const childNodes = getChildNodes(container);
+  childNodes.forEach(removeNode);
+};
+export default (container, html, decorateProposition) => {
+  clear(container);
+  return appendHtml(container, html, decorateProposition);
+};

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

@@ -0,0 +1,23 @@
+/*
+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 { setStyle } from "./dom/index.js";
+export default (container, styles, decorateProposition) => {
+  const {
+    priority,
+    ...style
+  } = styles;
+  Object.keys(style).forEach(key => {
+    setStyle(container, key, style[key], priority);
+  });
+  decorateProposition(container);
+};

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

@@ -0,0 +1,16 @@
+/*
+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.
+*/
+
+export default (container, text, decorateProposition) => {
+  decorateProposition(container);
+  container.textContent = text;
+};

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

@@ -0,0 +1,30 @@
+/*
+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 { SRC } from "../../../constants/elementAttribute.js";
+import { removeAttribute, setAttribute } from "./dom/index.js";
+import { isImage, loadImage } from "./images.js";
+export default (container, url, decorateProposition) => {
+  if (!isImage(container)) {
+    return;
+  }
+
+  // Start downloading the image
+  loadImage(url);
+  decorateProposition(container);
+
+  // Remove "src" so there is no flicker
+  removeAttribute(container, SRC);
+
+  // Replace the image "src"
+  setAttribute(container, SRC, url);
+};

package/libEs6/components/Personalization/flicker/index.js

@@ -0,0 +1,96 @@
+/*
+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 { createNode, appendNode, removeNode } from "../../../utils/dom/index.js";
+import { STYLE } from "../../../constants/tagName.js";
+import { getElementById, getNonce } from "../dom-actions/dom/index.js";
+const PREHIDING_ID = "alloy-prehiding";
+const HIDING_STYLE_DEFINITION = "{ visibility: hidden }";
+
+// Using global is OK since we have a single DOM
+// so storing nodes even for multiple Alloy instances is fine
+const styleNodes = {};
+export const hideElements = prehidingSelector => {
+  // if we have different events with the same
+  // prehiding selector we don't want to recreate
+  // the style tag
+  if (styleNodes[prehidingSelector]) {
+    return;
+  }
+  const nonce = getNonce();
+  const attrs = {
+    ...(nonce && {
+      nonce
+    })
+  };
+  const props = {
+    textContent: `${prehidingSelector} ${HIDING_STYLE_DEFINITION}`
+  };
+  const node = createNode(STYLE, attrs, props);
+  appendNode(document.head, node);
+  styleNodes[prehidingSelector] = node;
+};
+export const showElements = prehidingSelector => {
+  const node = styleNodes[prehidingSelector];
+  if (node) {
+    removeNode(node);
+    delete styleNodes[prehidingSelector];
+  }
+};
+export const createHideContainers = logger => {
+  return prehidingStyle => {
+    if (!prehidingStyle) {
+      return;
+    }
+
+    // If containers prehiding style has been added
+    // by customer's prehiding snippet we don't
+    // want to add the same node
+    const node = getElementById(PREHIDING_ID);
+    if (node) {
+      return;
+    }
+    const nonce = getNonce();
+    const attrs = {
+      id: PREHIDING_ID,
+      ...(nonce && {
+        nonce
+      })
+    };
+    const props = {
+      textContent: prehidingStyle
+    };
+    const styleNode = createNode(STYLE, attrs, props);
+    logger.logOnContentHiding({
+      status: "hide-containers",
+      message: "Prehiding style applied to hide containers.",
+      logLevel: "info"
+    });
+    appendNode(document.head, styleNode);
+  };
+};
+export const createShowContainers = logger => {
+  return () => {
+    // If containers prehiding style exists
+    // we will remove it
+    const node = getElementById(PREHIDING_ID);
+    if (!node) {
+      return;
+    }
+    logger.logOnContentHiding({
+      status: "show-containers",
+      message: "Prehiding style removed to show containers.",
+      logLevel: "info"
+    });
+    removeNode(node);
+  };
+};

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

@@ -0,0 +1,57 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+import { getAttribute, setAttribute } from "../dom-actions/dom/index.js";
+import { noop } from "../../../utils/index.js";
+import { DOM_ACTION_CLICK } from "../dom-actions/initDomActionsModules.js";
+import { ALWAYS, DECORATED_ELEMENTS_ONLY } from "../../../constants/propositionInteractionType.js";
+export const INTERACT_ID_DATA_ATTRIBUTE = "data-aep-interact-id";
+export const CLICK_LABEL_DATA_ATTRIBUTE = "data-aep-click-label";
+export const CLICK_TOKEN_DATA_ATTRIBUTE = "data-aep-click-token";
+let lastInteractId = 0;
+const getInteractId = (propositionId, existingInteractId) => {
+  if (existingInteractId) {
+    return parseInt(existingInteractId, 10);
+  }
+  return ++lastInteractId;
+};
+const interactionTrackingSupported = (autoCollectPropositionInteractions, decisionProvider) => {
+  if (!autoCollectPropositionInteractions) {
+    return false;
+  }
+  if (!autoCollectPropositionInteractions[decisionProvider]) {
+    return false;
+  }
+  return [ALWAYS, DECORATED_ELEMENTS_ONLY].includes(autoCollectPropositionInteractions[decisionProvider]);
+};
+const createDecorateProposition = (autoCollectPropositionInteractions, type, propositionId, itemId, trackingLabel, scopeType, notification, storeInteractionMeta) => {
+  const {
+    scopeDetails = {}
+  } = notification;
+  const {
+    decisionProvider
+  } = scopeDetails;
+  if (!interactionTrackingSupported(autoCollectPropositionInteractions, decisionProvider) && type !== DOM_ACTION_CLICK) {
+    return noop;
+  }
+  return element => {
+    if (!element.tagName) {
+      return;
+    }
+    const interactId = getInteractId(propositionId, getAttribute(element, INTERACT_ID_DATA_ATTRIBUTE));
+    storeInteractionMeta(propositionId, itemId, scopeType, notification, interactId);
+    setAttribute(element, INTERACT_ID_DATA_ATTRIBUTE, interactId);
+    if (trackingLabel && !getAttribute(element, CLICK_LABEL_DATA_ATTRIBUTE)) {
+      setAttribute(element, CLICK_LABEL_DATA_ATTRIBUTE, trackingLabel);
+    }
+  };
+};
+export default createDecorateProposition;

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

@@ -0,0 +1,69 @@
+/*
+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 createDecorateProposition from "./createDecorateProposition.js";
+import createRenderStatusHandler from "./createRenderStatusHandler.js";
+import { DOM_ACTION_CLICK } from "../dom-actions/initDomActionsModules.js";
+export default ({
+  modules,
+  logger,
+  storeInteractionMeta,
+  storeClickMeta,
+  autoCollectPropositionInteractions
+}) => item => {
+  const {
+    type,
+    selector
+  } = item.getData() || {};
+  if (!type) {
+    logger.warn("Invalid DOM action data: missing type.", item.getData());
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
+  }
+  if (type === DOM_ACTION_CLICK) {
+    if (!selector) {
+      logger.warn("Invalid DOM action data: missing selector.", item.getData());
+      return {
+        setRenderAttempted: false,
+        includeInNotification: false
+      };
+    }
+    storeClickMeta({
+      selector,
+      meta: {
+        ...item.getProposition().getNotification(),
+        trackingLabel: item.getTrackingLabel(),
+        scopeType: item.getProposition().getScopeType()
+      }
+    });
+    return {
+      setRenderAttempted: true,
+      includeInNotification: false
+    };
+  }
+  if (!modules[type]) {
+    logger.warn("Invalid DOM action data: unknown type.", item.getData());
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
+  }
+  const renderStatusHandler = createRenderStatusHandler(item.getProposition().getScopeType(), item.getId());
+  const decorateProposition = createDecorateProposition(autoCollectPropositionInteractions, type, item.getProposition().getId(), item.getId(), item.getTrackingLabel(), item.getProposition().getScopeType(), item.getProposition().getNotification(), storeInteractionMeta);
+  return {
+    render: () => modules[type](item.getData(), decorateProposition, renderStatusHandler),
+    setRenderAttempted: true,
+    includeInNotification: true
+  };
+};

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

@@ -0,0 +1,46 @@
+/*
+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 createDecorateProposition from "./createDecorateProposition.js";
+import createRenderStatusHandler from "./createRenderStatusHandler.js";
+export default ({
+  modules,
+  logger,
+  storeInteractionMeta,
+  autoCollectPropositionInteractions
+}) => item => {
+  const {
+    type,
+    selector
+  } = item.getData() || {};
+  if (!selector || !type) {
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
+  }
+  if (!modules[type]) {
+    logger.warn("Invalid HTML content data", item.getData());
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
+  }
+  const decorateProposition = createDecorateProposition(autoCollectPropositionInteractions, type, item.getProposition().getId(), item.getId(), item.getTrackingLabel(), item.getProposition().getScopeType(), item.getProposition().getNotification(), storeInteractionMeta);
+  const renderStatusHandler = createRenderStatusHandler(item.getProposition().getScopeType(), item.getId());
+  return {
+    render: () => {
+      return modules[type](item.getData(), decorateProposition, renderStatusHandler);
+    },
+    setRenderAttempted: true,
+    includeInNotification: true
+  };
+};

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

@@ -0,0 +1,79 @@
+/*
+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 { APPLICATION_JSON } from "../../../constants/contentType.js";
+const DEFAULT_CONTENT = "defaultContent";
+const expectedProps = ["content", "contentType"];
+const expectedContentProps = ["mobileParameters", "webParameters", "html"];
+const isValidInAppMessage = (data, logger) => {
+  for (let i = 0; i < expectedProps.length; i += 1) {
+    const prop = expectedProps[i];
+    if (!Object.prototype.hasOwnProperty.call(data, prop)) {
+      logger.warn(`Invalid in-app message data: missing property '${prop}'.`, data);
+      return false;
+    }
+  }
+  const {
+    content,
+    contentType
+  } = data;
+  if (contentType === APPLICATION_JSON) {
+    for (let i = 0; i < expectedContentProps.length; i += 1) {
+      const prop = expectedContentProps[i];
+      if (!Object.prototype.hasOwnProperty.call(content, prop)) {
+        logger.warn(`Invalid in-app message data.content: missing property '${prop}'.`, data);
+        return false;
+      }
+    }
+  }
+  return true;
+};
+export default ({
+  modules,
+  logger
+}) => {
+  return item => {
+    const data = item.getData();
+    const proposition = item.getProposition();
+    const meta = {
+      ...proposition.getNotification()
+    };
+    const shouldSuppressDisplay = proposition.shouldSuppressDisplay();
+    if (!data) {
+      logger.warn("Invalid in-app message data: undefined.", data);
+      return {};
+    }
+    const {
+      type = DEFAULT_CONTENT
+    } = data;
+    if (!modules[type]) {
+      logger.warn("Invalid in-app message data: unknown type.", data);
+      return {};
+    }
+    if (!isValidInAppMessage(data, logger)) {
+      return {};
+    }
+    if (!meta) {
+      logger.warn("Invalid in-app message meta: undefined.", meta);
+      return {};
+    }
+    return {
+      render: () => {
+        return shouldSuppressDisplay ? null : modules[type]({
+          ...data,
+          meta
+        });
+      },
+      setRenderAttempted: true,
+      includeInNotification: true
+    };
+  };
+};