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

package/libEs6/components/Personalization/constants/surface.js

@@ -1,16 +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.
-*/
-
-export const WEB = "web";
-export const WEBAPP = "webapp";
-export const SURFACE_TYPE_DELIMITER = "://";
-export const FRAGMENT_DELIMITER = "#";

package/libEs6/components/Personalization/createActionsProvider.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 createPreprocessors from "./createPreprocessors";
-import { assign } from "../../utils";
-export default (({
-  modules,
-  preprocessors = createPreprocessors(),
-  logger
-}) => {
-  const logActionError = (action, error) => {
-    if (logger.enabled) {
-      const details = JSON.stringify(action);
-      const {
-        message,
-        stack
-      } = error;
-      const errorMessage = `Failed to execute action ${details}. ${message} ${stack ? `\n ${stack}` : ""}`;
-      logger.warn(errorMessage);
-    }
-  };
-  const logActionCompleted = action => {
-    if (logger.enabled) {
-      const details = JSON.stringify(action);
-      logger.info(`Action ${details} executed.`);
-    }
-  };
-  const getExecuteAction = (schema, type) => {
-    if (!modules[schema] || !modules[schema][type]) {
-      return () => Promise.reject(new Error(`Action "${type}" not found for schema "${schema}"`));
-    }
-    return modules[schema][type];
-  };
-  const applyPreprocessors = action => {
-    const {
-      schema
-    } = action;
-    const preprocessorsList = preprocessors[schema];
-    if (!schema || !(preprocessorsList instanceof Array) || preprocessorsList.length === 0) {
-      return action;
-    }
-    return preprocessorsList.reduce((processed, fn) => assign(processed, fn(processed)), action);
-  };
-  const executeAction = action => {
-    const processedAction = applyPreprocessors(action);
-    const {
-      type,
-      schema
-    } = processedAction;
-    const execute = getExecuteAction(schema, type);
-    return execute(processedAction).then(result => {
-      logActionCompleted(processedAction);
-      return result;
-    }).catch(error => {
-      logActionError(processedAction, error);
-      throw error;
-    });
-  };
-  return {
-    executeAction
-  };
-});

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -1,103 +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 { isNonEmptyArray, isObject, defer } from "../../utils";
-import { DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP } from "../../constants/schema";
-import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
-const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP];
-export default (({
-  processPropositions,
-  createProposition,
-  renderedPropositions,
-  viewCache
-}) => {
-  const filterItemsPredicate = item => SUPPORTED_SCHEMAS.indexOf(item.schema) > -1;
-  const updatePropositionItems = ({
-    items,
-    metadataForScope
-  }) => {
-    return items.filter(filterItemsPredicate).map(item => {
-      if (item.schema !== HTML_CONTENT_ITEM) {
-        return {
-          ...item
-        };
-      }
-      if (isObject(metadataForScope)) {
-        return {
-          ...item,
-          data: {
-            ...item.data,
-            selector: metadataForScope.selector,
-            type: metadataForScope.actionType
-          }
-        };
-      }
-      return undefined;
-    }).filter(item => item);
-  };
-  const filterPropositionsPredicate = proposition => {
-    return !(proposition.scope === PAGE_WIDE_SCOPE && proposition.renderAttempted);
-  };
-  const preparePropositions = ({
-    propositions,
-    metadata
-  }) => {
-    return propositions.filter(filterPropositionsPredicate).map(proposition => {
-      if (isNonEmptyArray(proposition.items)) {
-        const {
-          id,
-          scope,
-          scopeDetails
-        } = proposition;
-        return {
-          id,
-          scope,
-          scopeDetails,
-          items: updatePropositionItems({
-            items: proposition.items,
-            metadataForScope: metadata[proposition.scope]
-          })
-        };
-      }
-      return proposition;
-    }).filter(proposition => isNonEmptyArray(proposition.items));
-  };
-  return ({
-    propositions = [],
-    metadata = {},
-    viewName
-  }) => {
-    // We need to immediately call concat so that subsequent sendEvent
-    // calls will wait for applyPropositions to complete before executing.
-    const renderedPropositionsDeferred = defer();
-    renderedPropositions.concat(renderedPropositionsDeferred.promise);
-    const propositionsToExecute = preparePropositions({
-      propositions,
-      metadata
-    }).map(proposition => createProposition(proposition));
-    return Promise.resolve().then(() => {
-      if (viewName) {
-        return viewCache.getView(viewName);
-      }
-      return [];
-    }).then(additionalPropositions => {
-      const {
-        render,
-        returnedPropositions
-      } = processPropositions([...propositionsToExecute, ...additionalPropositions]);
-      render().then(renderedPropositionsDeferred.resolve);
-      return {
-        propositions: returnedPropositions
-      };
-    });
-  };
-});

package/libEs6/components/Personalization/createClickStorage.js

@@ -1,58 +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.
-*/
-
-const metasToArray = metas => {
-  return Object.keys(metas).map(key => {
-    return {
-      id: key,
-      ...metas[key]
-    };
-  });
-};
-export default (() => {
-  const clickStorage = {};
-  const storeClickMetrics = ({
-    selector,
-    meta: {
-      id,
-      scope,
-      scopeDetails,
-      trackingLabel,
-      scopeType
-    }
-  }) => {
-    if (!clickStorage[selector]) {
-      clickStorage[selector] = {};
-    }
-    clickStorage[selector][id] = {
-      scope,
-      scopeDetails,
-      trackingLabel,
-      scopeType
-    };
-  };
-  const getClickSelectors = () => {
-    return Object.keys(clickStorage);
-  };
-  const getClickMetasBySelector = selector => {
-    const metas = clickStorage[selector];
-    if (!metas) {
-      return {};
-    }
-    return metasToArray(clickStorage[selector]);
-  };
-  return {
-    storeClickMetrics,
-    getClickSelectors,
-    getClickMetasBySelector
-  };
-});

package/libEs6/components/Personalization/createCollect.js

@@ -1,48 +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 { DISPLAY } from "../../constants/eventType";
-import { getPropositionEventType } from "../../constants/propositionEventType";
-import { isNonEmptyArray } from "../../utils";
-export default (({
-  eventManager,
-  mergeDecisionsMeta
-}) => {
-  // Called when a decision is auto-rendered for the __view__ scope or a SPA view(display and empty display notification)
-  return ({
-    decisionsMeta = [],
-    propositionAction,
-    documentMayUnload = false,
-    eventType = DISPLAY,
-    propositionEventTypes = [getPropositionEventType(eventType)],
-    viewName
-  }) => {
-    const event = eventManager.createEvent();
-    const data = {
-      eventType
-    };
-    if (viewName) {
-      data.web = {
-        webPageDetails: {
-          viewName
-        }
-      };
-    }
-    if (isNonEmptyArray(decisionsMeta)) {
-      mergeDecisionsMeta(event, decisionsMeta, propositionEventTypes, propositionAction);
-    }
-    event.mergeXdm(data);
-    if (documentMayUnload) {
-      event.documentMayUnload();
-    }
-    return eventManager.sendEvent(event);
-  };
-});

package/libEs6/components/Personalization/createComponent.js

@@ -1,129 +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 { noop, flatMap, isNonEmptyArray } from "../../utils";
-import createPersonalizationDetails from "./createPersonalizationDetails";
-import { AUTHORING_ENABLED } from "./constants/loggerMessage";
-import { PropositionEventType } from "../../constants/propositionEventType";
-import validateApplyPropositionsOptions from "./validateApplyPropositionsOptions";
-export default (({
-  getPageLocation,
-  logger,
-  fetchDataHandler,
-  viewChangeHandler,
-  onClickHandler,
-  isAuthoringModeEnabled,
-  mergeQuery,
-  viewCache,
-  showContainers,
-  applyPropositions,
-  setTargetMigration,
-  mergeDecisionsMeta,
-  renderedPropositions,
-  onDecisionHandler
-}) => {
-  return {
-    lifecycle: {
-      onDecision: onDecisionHandler,
-      onBeforeRequest({
-        request
-      }) {
-        setTargetMigration(request);
-        return Promise.resolve();
-      },
-      onBeforeEvent({
-        event,
-        renderDecisions,
-        decisionScopes = [],
-        personalization = {},
-        onResponse = noop,
-        onRequestFailure = noop
-      }) {
-        // Include propositions on all responses, overridden with data as needed
-        onResponse(() => ({
-          propositions: []
-        }));
-        onRequestFailure(() => showContainers());
-        if (isAuthoringModeEnabled()) {
-          logger.warn(AUTHORING_ENABLED);
-
-          // If we are in authoring mode we disable personalization
-          mergeQuery(event, {
-            enabled: false
-          });
-          return Promise.resolve();
-        }
-        const personalizationDetails = createPersonalizationDetails({
-          getPageLocation,
-          renderDecisions,
-          decisionScopes,
-          personalization,
-          event,
-          isCacheInitialized: viewCache.isInitialized(),
-          logger
-        });
-        const decisionsMetaPromises = [];
-        if (personalizationDetails.shouldIncludeRenderedPropositions()) {
-          decisionsMetaPromises.push(renderedPropositions.clear());
-        }
-        if (personalizationDetails.shouldFetchData()) {
-          const cacheUpdate = viewCache.createCacheUpdate(personalizationDetails.getViewName());
-          onRequestFailure(() => cacheUpdate.cancel());
-          fetchDataHandler({
-            cacheUpdate,
-            personalizationDetails,
-            event,
-            onResponse
-          });
-        } else if (personalizationDetails.shouldUseCachedData()) {
-          // eslint-disable-next-line consistent-return
-          decisionsMetaPromises.push(viewChangeHandler({
-            personalizationDetails,
-            event,
-            onResponse,
-            onRequestFailure
-          }));
-        }
-
-        // This promise.all waits for both the pending display notifications to be resolved
-        // (i.e. the top of page call to finish rendering) and the view change handler to
-        // finish rendering anything for this view.
-        return Promise.all(decisionsMetaPromises).then(decisionsMetas => {
-          // We only want to call mergeDecisionsMeta once, but we can get the propositions
-          // from two places: the pending display notifications and the view change handler.
-          const decisionsMeta = flatMap(decisionsMetas, dms => dms);
-          if (isNonEmptyArray(decisionsMeta)) {
-            mergeDecisionsMeta(event, decisionsMeta, [PropositionEventType.DISPLAY]);
-          }
-        });
-      },
-      onClick({
-        event,
-        clickedElement
-      }) {
-        onClickHandler({
-          event,
-          clickedElement
-        });
-      }
-    },
-    commands: {
-      applyPropositions: {
-        optionsValidator: options => validateApplyPropositionsOptions({
-          logger,
-          options
-        }),
-        run: applyPropositions
-      }
-    }
-  };
-});

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -1,74 +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 { groupBy } from "../../utils";
-const DECISIONS_HANDLE = "personalization:decisions";
-export default (({
-  prehidingStyle,
-  showContainers,
-  hideContainers,
-  mergeQuery,
-  processPropositions,
-  createProposition,
-  notificationHandler
-}) => {
-  return ({
-    cacheUpdate,
-    personalizationDetails,
-    event,
-    onResponse
-  }) => {
-    if (personalizationDetails.isRenderDecisions()) {
-      hideContainers(prehidingStyle);
-    } else {
-      showContainers();
-    }
-    mergeQuery(event, personalizationDetails.createQueryDetails());
-    const handleNotifications = notificationHandler(personalizationDetails.isSendDisplayEvent(), personalizationDetails.getViewName());
-    onResponse(({
-      response
-    }) => {
-      const handles = response.getPayloadsByType(DECISIONS_HANDLE);
-      const propositions = handles.map(handle => createProposition(handle));
-      const {
-        page: pagePropositions = [],
-        view: viewPropositions = [],
-        proposition: nonRenderedPropositions = []
-      } = groupBy(propositions, p => p.getScopeType());
-      const currentViewPropositions = cacheUpdate.update(viewPropositions);
-      let render;
-      let returnedPropositions;
-      let returnedDecisions;
-      if (personalizationDetails.isRenderDecisions()) {
-        ({
-          render,
-          returnedPropositions,
-          returnedDecisions
-        } = processPropositions([...pagePropositions, ...currentViewPropositions], nonRenderedPropositions));
-        render().then(handleNotifications);
-
-        // Render could take a long time especially if one of the renders
-        // is waiting for html to appear on the page. We show the containers
-        // immediately, and whatever renders quickly will not have flicker.
-        showContainers();
-      } else {
-        ({
-          returnedPropositions,
-          returnedDecisions
-        } = processPropositions([], [...pagePropositions, ...currentViewPropositions, ...nonRenderedPropositions]));
-      }
-      return {
-        propositions: returnedPropositions,
-        decisions: returnedDecisions
-      };
-    });
-  };
-});

package/libEs6/components/Personalization/createGetPageLocation.js

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

package/libEs6/components/Personalization/createNotificationHandler.js

@@ -1,29 +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";
-export default ((collect, renderedPropositions) => {
-  return (sendDisplayEvent, viewName) => {
-    if (!sendDisplayEvent) {
-      const renderedPropositionsDeferred = defer();
-      renderedPropositions.concat(renderedPropositionsDeferred.promise);
-      return renderedPropositionsDeferred.resolve;
-    }
-    return decisionsMeta => {
-      if (decisionsMeta.length > 0) {
-        collect({
-          decisionsMeta,
-          viewName
-        });
-      }
-    };
-  };
-});

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -1,52 +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";
-import { INTERACT } from "../../constants/eventType";
-import { PropositionEventType } from "../../constants/propositionEventType";
-export default (({
-  mergeDecisionsMeta,
-  collectClicks,
-  getClickSelectors,
-  getClickMetasBySelector
-}) => {
-  // Called when an element qualifying for conversion within an offer is clicked.
-  return ({
-    event,
-    clickedElement
-  }) => {
-    const selectors = getClickSelectors();
-    if (isNonEmptyArray(selectors)) {
-      const {
-        decisionsMeta,
-        eventLabel,
-        viewName
-      } = collectClicks(clickedElement, selectors, getClickMetasBySelector);
-      if (isNonEmptyArray(decisionsMeta)) {
-        const xdm = {
-          eventType: INTERACT
-        };
-        if (viewName) {
-          xdm.web = {
-            webPageDetails: {
-              viewName
-            }
-          };
-        }
-        event.mergeXdm(xdm);
-        mergeDecisionsMeta(event, decisionsMeta, [PropositionEventType.INTERACT], eventLabel ? {
-          label: eventLabel
-        } : undefined);
-      }
-    }
-  };
-});

package/libEs6/components/Personalization/createOnDecisionHandler.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 (({
-  processPropositions,
-  createProposition,
-  notificationHandler
-}) => {
-  return ({
-    renderDecisions,
-    propositions,
-    event,
-    personalization = {}
-  }) => {
-    if (!renderDecisions) {
-      return Promise.resolve();
-    }
-    const {
-      sendDisplayEvent = true
-    } = personalization;
-    const viewName = event ? event.getViewName() : undefined;
-    const propositionsToExecute = propositions.map(proposition => createProposition(proposition, true));
-    const {
-      render,
-      returnedPropositions
-    } = processPropositions(propositionsToExecute);
-    const handleNotifications = notificationHandler(sendDisplayEvent, viewName);
-    render().then(handleNotifications);
-    return Promise.resolve({
-      propositions: returnedPropositions
-    });
-  };
-});