@adobe/alloy 2.18.0 → 2.19.0-beta.1

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -9,7 +9,8 @@ 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";
@@ -25,27 +26,23 @@ export default (({
     clickedElement
   }) => {
     const selectors = getClickSelectors();
-
     if (isNonEmptyArray(selectors)) {
       const {
         decisionsMeta,
         eventLabel
       } = collectClicks(clickedElement, selectors, getClickMetasBySelector);
-
       if (isNonEmptyArray(decisionsMeta)) {
         const xdm = {
           eventType: INTERACT
         };
         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()
             }
           };
         }
-
         event.mergeXdm(xdm);
         mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.INTERACT, eventLabel);
       }

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

@@ -9,34 +9,30 @@ 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 { includes, isNonEmptyString, isNonEmptyArray } from "../../utils";
 import { buildPageSurface, normalizeSurfaces } from "./utils/surfaceUtils";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
 import { DEFAULT_CONTENT_ITEM, DOM_ACTION, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM } from "./constants/schema";
-
 const addPageWideScope = scopes => {
   if (!includes(scopes, PAGE_WIDE_SCOPE)) {
     scopes.push(PAGE_WIDE_SCOPE);
   }
 };
-
 const addPageSurface = (surfaces, getPageLocation) => {
   const pageSurface = buildPageSurface(getPageLocation);
-
   if (!includes(surfaces, pageSurface)) {
     surfaces.push(pageSurface);
   }
 };
-
 const dedupe = array => array.filter((item, pos) => array.indexOf(item) === pos);
-
 export default (({
   getPageLocation,
   renderDecisions,
   decisionScopes,
   personalization,
   event,
-  viewCache,
+  isCacheInitialized,
   logger
 }) => {
   const viewName = event.getViewName();
@@ -44,61 +40,52 @@ export default (({
     isRenderDecisions() {
       return renderDecisions;
     },
-
+    isSendDisplayNotifications() {
+      return !!personalization.sendDisplayNotifications;
+    },
+    shouldAddPendingDisplayNotifications() {
+      return !!personalization.includePendingDisplayNotifications;
+    },
     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.isCacheInitialized()) {
         addPageWideScope(scopes);
         addPageSurface(eventSurfaces, getPageLocation);
       }
-
       const schemas = [DEFAULT_CONTENT_ITEM, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM];
-
       if (includes(scopes, PAGE_WIDE_SCOPE)) {
         schemas.push(DOM_ACTION);
       }
-
       return {
         schemas,
         decisionScopes: dedupe(scopes),
         surfaces: dedupe(eventSurfaces)
       };
     },
-
     isCacheInitialized() {
-      return viewCache.isInitialized();
+      return isCacheInitialized;
     },
-
     shouldFetchData() {
       return this.hasScopes() || this.hasSurfaces() || !this.isCacheInitialized();
     },
-
     shouldUseCachedData() {
       return this.hasViewName() && this.isCacheInitialized();
     }
-
   };
 });

package/libEs6/components/Personalization/createSetTargetMigration.js

@@ -9,6 +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 { noop } from "../../utils";
 export default (({
   targetMigrationEnabled
@@ -22,6 +23,5 @@ export default (({
       });
     };
   }
-
   return noop;
 });

package/libEs6/components/Personalization/createViewCacheManager.js

@@ -9,39 +9,65 @@ 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 defer from "../../utils/defer";
-export default (() => {
-  let viewStorage;
-  const viewStorageDeferred = defer();
 
-  const storeViews = decisionsPromise => {
-    decisionsPromise.then(decisions => {
-      if (viewStorage === undefined) {
-        viewStorage = {};
-      }
+import { assign, groupBy } from "../../utils";
+import defer from "../../utils/defer";
+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];
+  };
 
-      assign(viewStorage, decisions);
-      viewStorageDeferred.resolve();
-    }).catch(() => {
-      if (viewStorage === undefined) {
-        viewStorage = {};
+  // 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 [];
+      },
+      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,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.
 */
-import composePersonalizationResultingObject from "./utils/composePersonalizationResultingObject";
-import { isNonEmptyArray } from "../../utils";
+
 import { PropositionEventType } from "./constants/propositionEventType";
 export default (({
   mergeDecisionsMeta,
-  collect,
-  executeDecisions,
+  processPropositions,
   viewCache
 }) => {
   return ({
@@ -23,34 +21,32 @@ export default (({
     event,
     onResponse
   }) => {
+    let returnedPropositions;
+    let returnedDecisions;
     const viewName = personalizationDetails.getViewName();
-    return viewCache.getView(viewName).then(viewDecisions => {
+    onResponse(() => {
+      return {
+        propositions: returnedPropositions,
+        decisions: returnedDecisions
+      };
+    });
+    return viewCache.getView(viewName).then(propositions => {
+      let render;
       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(() => {
-            collect({
-              decisionsMeta: [],
-              viewName
-            });
-            return composePersonalizationResultingObject(viewDecisions, true);
-          });
-        });
+        ({
+          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

@@ -9,6 +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 { awaitSelector } from "../../../utils/dom";
 import { hideElements, showElements } from "../flicker";
 import { selectNodesWithEq } from "./dom";
@@ -23,36 +24,26 @@ 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));
   return Promise.all(executions);
 };
-
 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/addNonceToInlineStyleElements.js

@@ -9,35 +9,28 @@ 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 { selectNodes } from "../../../utils/dom";
 import { STYLE } from "../../../constants/tagName";
 import { SRC } from "../../../constants/elementAttribute";
 import { getAttribute, getNonce } from "./dom";
-
 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

@@ -9,6 +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 { appendNode } from "../../../utils/dom";
 import { createFragment, getChildNodes } from "./dom";
 import { loadImages } from "./images";

package/libEs6/components/Personalization/dom-actions/clicks/collectClicks.js

@@ -9,20 +9,18 @@ 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 matchesSelectorWithEq from "../dom/matchesSelectorWithEq";
 
+import matchesSelectorWithEq from "../dom/matchesSelectorWithEq";
 const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) => {
   const {
     documentElement
   } = document;
   let element = clickedElement;
   let i = 0;
-
   while (element && element !== documentElement) {
     if (matchesSelectorWithEq(selector, element)) {
       const matchedMetas = getClickMetasBySelector(selector);
       const foundMetaWithLabel = matchedMetas.find(meta => meta.trackingLabel);
-
       if (foundMetaWithLabel) {
         return {
           metas: matchedMetas,
@@ -30,56 +28,46 @@ const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) =>
           weight: i
         };
       }
-
       return {
         metas: matchedMetas
       };
     }
-
     element = element.parentNode;
     i += 1;
   }
-
   return {
     metas: null
   };
 };
-
 const cleanMetas = metas => metas.map(meta => {
   delete meta.trackingLabel;
   return meta;
 });
-
 const dedupMetas = metas => metas.filter((meta, index) => {
   const stringifiedMeta = JSON.stringify(meta);
   return index === metas.findIndex(innerMeta => JSON.stringify(innerMeta) === stringifiedMeta);
 });
-
 export default ((clickedElement, selectors, getClickMetasBySelector) => {
   const result = [];
   let resultLabel = "";
   let resultLabelWeight = Number.MAX_SAFE_INTEGER;
-  /* eslint-disable no-continue */
 
+  /* eslint-disable no-continue */
   for (let i = 0; i < selectors.length; i += 1) {
     const {
       metas,
       label,
       weight
     } = getMetasIfMatches(clickedElement, selectors[i], getClickMetasBySelector);
-
     if (!metas) {
       continue;
     }
-
     if (label && weight <= resultLabelWeight) {
       resultLabel = label;
       resultLabelWeight = weight;
     }
-
     result.push(...cleanMetas(metas));
   }
-
   return {
     decisionsMeta: dedupMetas(result),
     eventLabel: resultLabel

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,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.
 */
-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/dom/createFragment.js

@@ -9,6 +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 { createNode } from "../../../../utils/dom";
 import { DIV } from "../../../../constants/tagName";
 export default (content => {

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

@@ -9,6 +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.
 */
+
 export default ((element, name) => {
   return element.getAttribute(name);
 });

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

@@ -9,15 +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.
 */
+
 import { toArray } from "../../../../utils";
 export default (element => {
   const {
     childNodes
   } = element;
-
   if (childNodes) {
     return toArray(childNodes);
   }
-
   return [];
 });

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

@@ -9,15 +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.
 */
+
 import { toArray } from "../../../../utils";
 export default (element => {
   const {
     children
   } = element;
-
   if (children) {
     return toArray(children);
   }
-
   return [];
 });

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

@@ -9,6 +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.
 */
+
 export default (element => {
   return element.firstElementChild;
 });

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

@@ -9,6 +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.
 */
+
 export default (element => {
   return element.nextElementSibling;
 });

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

@@ -9,24 +9,25 @@ 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.
 */
+
 let nonce;
+
 /**
  * Returns the nonce if available.
  * @param {Node} [context=document] defaults to document
  * @returns {(String|undefined)} the nonce or undefined if not available
  */
-
 export default ((context = document) => {
   if (nonce === undefined) {
-    const n = context.querySelector("[nonce]"); // NOTE: We're keeping n.getAttribute("nonce") until it is safe to remove:
+    const n = context.querySelector("[nonce]");
+    // NOTE: We're keeping n.getAttribute("nonce") until it is safe to remove:
     //   ref: https://github.com/whatwg/html/issues/2369#issuecomment-280853946
-
     nonce = n && (n.nonce || n.getAttribute("nonce"));
   }
-
   return nonce;
-}); // This function is only used for testing and removed when library is built (tree-shaking)
+});
 
+// This function is only used for testing and removed when library is built (tree-shaking)
 export const testResetCachedNonce = () => {
   nonce = undefined;
 };