@adobe/alloy 2.18.0 → 2.19.0-beta.0

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2020 Adobe. All rights reserved.
+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
@@ -9,14 +9,20 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+import { defer, groupBy } from "../../utils";
+const DECISIONS_HANDLE = "personalization:decisions";
 export default (({
   prehidingStyle,
-  responseHandler,
+  showContainers,
   hideContainers,
-  mergeQuery
+  mergeQuery,
+  collect,
+  processPropositions,
+  createProposition,
+  pendingDisplayNotifications
 }) => {
   return ({
-    decisionsDeferred,
+    cacheUpdate,
     personalizationDetails,
     event,
     onResponse
@@ -26,12 +32,62 @@ export default (({
     }
 
     mergeQuery(event, personalizationDetails.createQueryDetails());
+    let handleNotifications;
+
+    if (personalizationDetails.isSendDisplayNotifications()) {
+      handleNotifications = decisionsMeta => {
+        if (decisionsMeta.length > 0) {
+          collect({
+            decisionsMeta,
+            viewName: personalizationDetails.getViewName()
+          });
+        }
+      };
+    } else {
+      const displayNotificationsDeferred = defer();
+      pendingDisplayNotifications.concat(displayNotificationsDeferred.promise);
+      handleNotifications = displayNotificationsDeferred.resolve;
+    }
+
     onResponse(({
       response
-    }) => responseHandler({
-      decisionsDeferred,
-      personalizationDetails,
-      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(decisionsMeta => {
+          showContainers();
+          handleNotifications(decisionsMeta);
+        }).catch(e => {
+          showContainers();
+          throw e;
+        });
+      } else {
+        ({
+          returnedPropositions,
+          returnedDecisions
+        } = processPropositions([], [...pagePropositions, ...currentViewPropositions, ...nonRenderedPropositions]));
+      }
+
+      return {
+        propositions: returnedPropositions,
+        decisions: returnedDecisions
+      };
+    });
   };
 });

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -9,7 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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 { isNonEmptyArray, isNonEmptyString } from "../../utils";
 import { INTERACT } from "./constants/eventType";
 import { PropositionEventType } from "./constants/propositionEventType";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
@@ -38,10 +38,10 @@ export default (({
         };
         const scope = decisionsMeta[0].scope;
 
-        if (scope !== PAGE_WIDE_SCOPE) {
+        if (isNonEmptyString(scope) && scope !== PAGE_WIDE_SCOPE) {
           xdm.web = {
             webPageDetails: {
-              viewName: scope
+              viewName: scope.toLowerCase()
             }
           };
         }

package/{libEs5/components/Personalization/dom-actions/click.js → libEs6/components/Personalization/createPendingNotificationsHandler.js}

@@ -1,9 +1,5 @@
-"use strict";
-
-exports.default = void 0;
-
 /*
-Copyright 2019 Adobe. All rights reserved.
+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
@@ -13,14 +9,14 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-var _default = function _default(settings, store) {
-  var selector = settings.selector,
-      meta = settings.meta;
-  store({
-    selector: selector,
-    meta: meta
+import { PropositionEventType } from "./constants/propositionEventType";
+export default (({
+  pendingDisplayNotifications,
+  mergeDecisionsMeta
+}) => ({
+  event
+}) => {
+  return pendingDisplayNotifications.clear().then(decisionsMeta => {
+    mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
   });
-  return Promise.resolve();
-};
-
-exports.default = _default;
+});

package/libEs6/components/Personalization/createPersonalizationDetails.js

@@ -36,7 +36,7 @@ export default (({
   decisionScopes,
   personalization,
   event,
-  viewCache,
+  isCacheInitialized,
   logger
 }) => {
   const viewName = event.getViewName();
@@ -45,6 +45,14 @@ export default (({
       return renderDecisions;
     },
 
+    isSendDisplayNotifications() {
+      return !!personalization.sendDisplayNotifications;
+    },
+
+    shouldAddPendingDisplayNotifications() {
+      return !!personalization.includePendingDisplayNotifications;
+    },
+
     getViewName() {
       return viewName;
     },
@@ -89,7 +97,7 @@ export default (({
     },
 
     isCacheInitialized() {
-      return viewCache.isInitialized();
+      return isCacheInitialized;
     },
 
     shouldFetchData() {

package/libEs6/components/Personalization/createViewCacheManager.js

@@ -9,39 +9,74 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { assign } from "../../utils";
+import { assign, groupBy } from "../../utils";
 import defer from "../../utils/defer";
-export default (() => {
-  let viewStorage;
-  const viewStorageDeferred = defer();
-
-  const storeViews = decisionsPromise => {
-    decisionsPromise.then(decisions => {
-      if (viewStorage === undefined) {
-        viewStorage = {};
-      }
+import { DEFAULT_CONTENT_ITEM } from "./constants/schema";
+export default (({
+  createProposition
+}) => {
+  const viewStorage = {};
+  let cacheUpdateCreatedAtLeastOnce = false;
+  let previousUpdateCacheComplete = Promise.resolve();
+
+  const getViewPropositions = (currentViewStorage, viewName) => {
+    const viewPropositions = currentViewStorage[viewName.toLowerCase()];
+
+    if (viewPropositions && viewPropositions.length > 0) {
+      return viewPropositions;
+    }
+
+    const emptyViewProposition = createProposition({
+      scope: viewName,
+      scopeDetails: {
+        characteristics: {
+          scopeType: "view"
+        }
+      },
+      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;
+    previousUpdateCacheComplete = previousUpdateCacheComplete.then(() => updateCacheDeferred.promise).then(newViewStorage => {
+      assign(viewStorage, newViewStorage);
+    }).catch(() => {});
+    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 [];
+      },
 
-      assign(viewStorage, decisions);
-      viewStorageDeferred.resolve();
-    }).catch(() => {
-      if (viewStorage === undefined) {
-        viewStorage = {};
+      cancel() {
+        updateCacheDeferred.reject();
       }
 
-      viewStorageDeferred.resolve();
-    });
+    };
   };
 
   const getView = viewName => {
-    return viewStorageDeferred.promise.then(() => viewStorage[viewName] || []);
+    return previousUpdateCacheComplete.then(() => getViewPropositions(viewStorage, viewName));
   };
 
   const isInitialized = () => {
-    return !(viewStorage === undefined);
+    return cacheUpdateCreatedAtLeastOnce;
   };
 
   return {
-    storeViews,
+    createCacheUpdate,
     getView,
     isInitialized
   };

package/libEs6/components/Personalization/createViewChangeHandler.js

@@ -9,13 +9,10 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import composePersonalizationResultingObject from "./utils/composePersonalizationResultingObject";
-import { isNonEmptyArray } from "../../utils";
 import { PropositionEventType } from "./constants/propositionEventType";
 export default (({
   mergeDecisionsMeta,
-  collect,
-  executeDecisions,
+  processPropositions,
   viewCache
 }) => {
   return ({
@@ -23,34 +20,34 @@ export default (({
     event,
     onResponse
   }) => {
+    let returnedPropositions;
+    let returnedDecisions;
     const viewName = personalizationDetails.getViewName();
-    return viewCache.getView(viewName).then(viewDecisions => {
-      if (personalizationDetails.isRenderDecisions()) {
-        return executeDecisions(viewDecisions).then(decisionsMeta => {
-          // if there are decisions to be rendered we render them and attach the result in experience.decisions.propositions
-          if (isNonEmptyArray(decisionsMeta)) {
-            mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
-            onResponse(() => {
-              return composePersonalizationResultingObject(viewDecisions, true);
-            });
-            return;
-          } // if there are no decisions in cache for this view, we will send a empty notification
-
+    onResponse(() => {
+      return {
+        propositions: returnedPropositions,
+        decisions: returnedDecisions
+      };
+    });
+    return viewCache.getView(viewName).then(propositions => {
+      let render;
 
-          onResponse(() => {
-            collect({
-              decisionsMeta: [],
-              viewName
-            });
-            return composePersonalizationResultingObject(viewDecisions, true);
-          });
-        });
+      if (personalizationDetails.isRenderDecisions()) {
+        ({
+          render,
+          returnedPropositions,
+          returnedDecisions
+        } = processPropositions(propositions));
+        return render();
       }
 
-      onResponse(() => {
-        return composePersonalizationResultingObject(viewDecisions, false);
-      });
-      return {};
+      ({
+        returnedPropositions,
+        returnedDecisions
+      } = processPropositions([], propositions));
+      return [];
+    }).then(decisionsMeta => {
+      mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
     });
   };
 });

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

@@ -23,7 +23,6 @@ export { default as setStyles } from "./setStyles";
 export { default as setAttributes } from "./setAttributes";
 export { default as swapImage } from "./swapImage";
 export { default as rearrangeChildren } from "./rearrangeChildren";
-export { default as click } from "./click";
 
 const renderContent = (elements, content, renderFunc) => {
   const executions = elements.map(element => renderFunc(element, content));
@@ -31,28 +30,21 @@ const renderContent = (elements, content, renderFunc) => {
 };
 
 export const createAction = renderFunc => {
-  return settings => {
+  return itemData => {
     const {
       selector,
       prehidingSelector,
-      content,
-      meta
-    } = settings;
+      content
+    } = itemData;
     hideElements(prehidingSelector);
     return awaitSelector(selector, selectNodesWithEq).then(elements => renderContent(elements, content, renderFunc)).then(() => {
       // if everything is OK, show elements
       showElements(prehidingSelector);
-      return {
-        meta
-      };
     }, error => {
       // in case of awaiting timing or error, we need to remove the style tag
       // hence showing the pre-hidden elements
       showElements(prehidingSelector);
-      return {
-        meta,
-        error
-      };
+      throw error;
     });
   };
 };

package/libEs6/components/Personalization/dom-actions/{click.js → createPreprocess.js}

@@ -1,5 +1,5 @@
 /*
-Copyright 2019 Adobe. All rights reserved.
+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
@@ -9,14 +9,11 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-export default ((settings, store) => {
-  const {
-    selector,
-    meta
-  } = settings;
-  store({
-    selector,
-    meta
-  });
-  return Promise.resolve();
+import { assign } from "../../../utils";
+export default (preprocessors => action => {
+  if (!action) {
+    return action;
+  }
+
+  return preprocessors.reduce((processed, fn) => assign(processed, fn(processed)), action);
 });

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

@@ -9,5 +9,4 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-export { default as initDomActionsModules } from "./initDomActionsModules";
-export { default as executeActions } from "./executeActions";
+export { default as initDomActionsModules } from "./initDomActionsModules";

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

@@ -10,8 +10,8 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import { removeNode } from "../../../utils/dom";
-import { createAction, setHtml, setText, setAttributes, swapImage, setStyles, rearrangeChildren, replaceHtml, appendHtml, prependHtml, insertHtmlAfter, insertHtmlBefore, click } from "./action";
-export default (store => {
+import { createAction, setHtml, setText, setAttributes, swapImage, setStyles, rearrangeChildren, replaceHtml, appendHtml, prependHtml, insertHtmlAfter, insertHtmlBefore } from "./action";
+export default (() => {
   return {
     setHtml: createAction(setHtml),
     customCode: createAction(prependHtml),
@@ -27,10 +27,6 @@ export default (store => {
     insertBefore: createAction(insertHtmlBefore),
     replaceHtml: createAction(replaceHtml),
     prependHtml: createAction(prependHtml),
-    appendHtml: createAction(appendHtml),
-    click: settings => click(settings, store),
-    defaultContent: settings => Promise.resolve({
-      meta: settings.meta
-    })
+    appendHtml: createAction(appendHtml)
   };
 });

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

@@ -41,6 +41,10 @@ export default (action => {
     return result;
   }
 
+  if (selector == null) {
+    return result;
+  }
+
   const container = selectNodesWithEq(selector);
 
   if (!is(container[0], HEAD)) {

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

@@ -0,0 +1,53 @@
+/*
+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 (({
+  modules,
+  logger,
+  storeClickMetrics
+}) => item => {
+  const {
+    type,
+    selector
+  } = item.getData() || {};
+
+  if (!type) {
+    logger.warn("Invalid DOM action data: missing type.", item.getData());
+    return {};
+  }
+
+  if (type === "click") {
+    if (!selector) {
+      logger.warn("Invalid DOM action data: missing selector.", item.getData());
+      return {};
+    }
+
+    storeClickMetrics({
+      selector,
+      meta: item.getMeta()
+    });
+    return {
+      setRenderAttempted: true,
+      includeInNotification: false
+    };
+  }
+
+  if (!modules[type]) {
+    logger.warn("Invalid DOM action data: unknown type.", item.getData());
+    return {};
+  }
+
+  return {
+    render: () => modules[type](item.getData()),
+    setRenderAttempted: true,
+    includeInNotification: true
+  };
+});

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

@@ -0,0 +1,37 @@
+/*
+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 (({
+  modules,
+  logger
+}) => item => {
+  const {
+    type,
+    selector
+  } = item.getData() || {};
+
+  if (!selector || !type) {
+    return {};
+  }
+
+  if (!modules[type]) {
+    logger.warn("Invalid HTML content data", item.getData());
+    return {};
+  }
+
+  return {
+    render: () => {
+      modules[type](item.getData());
+    },
+    setRenderAttempted: true,
+    includeInNotification: true
+  };
+});