@adobe/alloy 2.18.0-beta.3 → 2.19.0-beta.0

package/libEs5/components/Personalization/index.js

@@ -10,8 +10,6 @@ var _domActions = require("./dom-actions");
 
 var _createCollect = require("./createCollect");
 
-var _createExecuteDecisions = require("./createExecuteDecisions");
-
 var _flicker = require("./flicker");
 
 var _createFetchDataHandler = require("./createFetchDataHandler");
@@ -28,36 +26,45 @@ var _createViewCacheManager = require("./createViewCacheManager");
 
 var _createViewChangeHandler = require("./createViewChangeHandler");
 
-var _groupDecisions = require("./groupDecisions");
+var _createClickStorage2 = require("./createClickStorage");
 
-var _createOnResponseHandler = require("./createOnResponseHandler");
+var _createApplyPropositions = require("./createApplyPropositions");
 
-var _createClickStorage2 = require("./createClickStorage");
+var _createGetPageLocation = require("./createGetPageLocation");
 
-var _createRedirectHandler = require("./createRedirectHandler");
+var _createSetTargetMigration = require("./createSetTargetMigration");
 
-var _createAutoRenderingHandler = require("./createAutoRenderingHandler");
+var _remapCustomCodeOffers = require("./dom-actions/remapCustomCodeOffers");
 
-var _createNonRenderingHandler = require("./createNonRenderingHandler");
+var _remapHeadOffers = require("./dom-actions/remapHeadOffers");
 
-var _createApplyPropositions = require("./createApplyPropositions");
+var _createPreprocess = require("./dom-actions/createPreprocess");
 
-var _createGetPageLocation = require("./createGetPageLocation");
+var _injectCreateProposition = require("./handlers/injectCreateProposition");
 
-var _createSetTargetMigration = require("./createSetTargetMigration");
+var _createAsyncArray = require("./utils/createAsyncArray");
+
+var _createPendingNotificationsHandler = require("./createPendingNotificationsHandler");
+
+var schema = require("./constants/schema");
+
+var _processDefaultContent = require("./handlers/processDefaultContent");
+
+var _surfaceUtils = require("./utils/surfaceUtils");
+
+var _createProcessDomAction = require("./handlers/createProcessDomAction");
+
+var _createProcessHtmlContent = require("./handlers/createProcessHtmlContent");
+
+var _createProcessRedirect = require("./handlers/createProcessRedirect");
+
+var _createProcessPropositions = require("./handlers/createProcessPropositions");
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-/*
-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.
-*/
 var createPersonalization = function createPersonalization(_ref) {
+  var _schemaProcessors;
+
   var config = _ref.config,
       logger = _ref.logger,
       eventManager = _ref.eventManager;
@@ -76,43 +83,47 @@ var createPersonalization = function createPersonalization(_ref) {
   var getPageLocation = (0, _createGetPageLocation.default)({
     window: window
   });
-  var viewCache = (0, _createViewCacheManager.default)();
-  var modules = (0, _domActions.initDomActionsModules)(storeClickMetrics);
-  var executeDecisions = (0, _createExecuteDecisions.default)({
+  var modules = (0, _domActions.initDomActionsModules)();
+  var preprocess = (0, _createPreprocess.default)([_remapHeadOffers.default, _remapCustomCodeOffers.default]);
+  var createProposition = (0, _injectCreateProposition.default)({
+    preprocess: preprocess,
+    isPageWideSurface: _surfaceUtils.isPageWideSurface
+  });
+  var viewCache = (0, _createViewCacheManager.default)({
+    createProposition: createProposition
+  });
+  var schemaProcessors = (_schemaProcessors = {}, _defineProperty(_schemaProcessors, schema.DEFAULT_CONTENT_ITEM, _processDefaultContent.default), _defineProperty(_schemaProcessors, schema.DOM_ACTION, (0, _createProcessDomAction.default)({
     modules: modules,
     logger: logger,
-    executeActions: _domActions.executeActions
-  });
-  var handleRedirectDecisions = (0, _createRedirectHandler.default)({
-    collect: collect,
-    window: window,
+    storeClickMetrics: storeClickMetrics
+  })), _defineProperty(_schemaProcessors, schema.HTML_CONTENT_ITEM, (0, _createProcessHtmlContent.default)({
+    modules: modules,
+    logger: logger
+  })), _defineProperty(_schemaProcessors, schema.REDIRECT_ITEM, (0, _createProcessRedirect.default)({
     logger: logger,
-    showContainers: _flicker.showContainers
-  });
-  var autoRenderingHandler = (0, _createAutoRenderingHandler.default)({
-    viewCache: viewCache,
-    executeDecisions: executeDecisions,
-    showContainers: _flicker.showContainers,
+    executeRedirect: function executeRedirect(url) {
+      return window.location.replace(url);
+    },
     collect: collect
+  })), _schemaProcessors);
+  var processPropositions = (0, _createProcessPropositions.default)({
+    schemaProcessors: schemaProcessors,
+    logger: logger
   });
-  var applyPropositions = (0, _createApplyPropositions.default)({
-    executeDecisions: executeDecisions
-  });
-  var nonRenderingHandler = (0, _createNonRenderingHandler.default)({
-    viewCache: viewCache
-  });
-  var responseHandler = (0, _createOnResponseHandler.default)({
-    autoRenderingHandler: autoRenderingHandler,
-    nonRenderingHandler: nonRenderingHandler,
-    groupDecisions: _groupDecisions.default,
-    handleRedirectDecisions: handleRedirectDecisions,
-    showContainers: _flicker.showContainers
+  var pendingDisplayNotifications = (0, _createAsyncArray.default)();
+  var pendingNotificationsHandler = (0, _createPendingNotificationsHandler.default)({
+    pendingDisplayNotifications: pendingDisplayNotifications,
+    mergeDecisionsMeta: _event.mergeDecisionsMeta
   });
   var fetchDataHandler = (0, _createFetchDataHandler.default)({
     prehidingStyle: prehidingStyle,
-    responseHandler: responseHandler,
+    showContainers: _flicker.showContainers,
     hideContainers: _flicker.hideContainers,
-    mergeQuery: _event.mergeQuery
+    mergeQuery: _event.mergeQuery,
+    collect: collect,
+    processPropositions: processPropositions,
+    createProposition: createProposition,
+    pendingDisplayNotifications: pendingDisplayNotifications
   });
   var onClickHandler = (0, _createOnClickHandler.default)({
     mergeDecisionsMeta: _event.mergeDecisionsMeta,
@@ -122,8 +133,13 @@ var createPersonalization = function createPersonalization(_ref) {
   });
   var viewChangeHandler = (0, _createViewChangeHandler.default)({
     mergeDecisionsMeta: _event.mergeDecisionsMeta,
-    collect: collect,
-    executeDecisions: executeDecisions,
+    processPropositions: processPropositions,
+    viewCache: viewCache
+  });
+  var applyPropositions = (0, _createApplyPropositions.default)({
+    processPropositions: processPropositions,
+    createProposition: createProposition,
+    pendingDisplayNotifications: pendingDisplayNotifications,
     viewCache: viewCache
   });
   var setTargetMigration = (0, _createSetTargetMigration.default)({
@@ -140,7 +156,8 @@ var createPersonalization = function createPersonalization(_ref) {
     viewCache: viewCache,
     showContainers: _flicker.showContainers,
     applyPropositions: applyPropositions,
-    setTargetMigration: setTargetMigration
+    setTargetMigration: setTargetMigration,
+    pendingNotificationsHandler: pendingNotificationsHandler
   });
 };
 

package/libEs5/components/Personalization/utils/createAsyncArray.js

@@ -0,0 +1,42 @@
+"use strict";
+
+exports.default = void 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.
+*/
+var _default = function _default() {
+  var latest = Promise.resolve([]);
+  return {
+    concat: function concat(promise) {
+      latest = latest.then(function (existingPropositions) {
+        return promise.then(function (newPropositions) {
+          return existingPropositions.concat(newPropositions);
+        }).catch(function () {
+          return existingPropositions;
+        });
+      });
+    },
+
+    /**
+     * Clears the saved propositions, waiting until the next propositions are resolved and available.
+     *
+     * @returns {Promise<Array>} A promise that resolves to the latest propositions.
+     */
+    clear: function clear() {
+      var oldLatest = latest;
+      latest = Promise.resolve([]);
+      return oldLatest;
+    }
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/validateApplyPropositionsOptions.js

@@ -24,8 +24,9 @@ var _default = function _default(_ref) {
   var logger = _ref.logger,
       options = _ref.options;
   var applyPropositionsOptionsValidator = (0, _validation.objectOf)({
-    propositions: (0, _validation.arrayOf)((0, _validation.objectOf)((0, _validation.anything)())).nonEmpty(),
-    metadata: (0, _validation.objectOf)((0, _validation.anything)())
+    propositions: (0, _validation.arrayOf)((0, _validation.objectOf)((0, _validation.anything)())),
+    metadata: (0, _validation.objectOf)((0, _validation.anything)()),
+    viewName: (0, _validation.string)()
   }).required();
 
   try {

package/libEs5/constants/libraryVersion.js

@@ -15,5 +15,5 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-var _default = "2.18.0-beta.3";
+var _default = "2.19.0-beta.0";
 exports.default = _default;

package/libEs5/core/createEvent.js

@@ -4,17 +4,26 @@ exports.default = void 0;
 
 var _utils = require("../utils");
 
-/*
-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.
-*/
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var getXdmPropositions = function getXdmPropositions(xdm) {
+  return xdm && // eslint-disable-next-line no-underscore-dangle
+  xdm._experience && // eslint-disable-next-line no-underscore-dangle
+  xdm._experience.decisioning && // eslint-disable-next-line no-underscore-dangle
+  (0, _utils.isNonEmptyArray)(xdm._experience.decisioning.propositions) ? // eslint-disable-next-line no-underscore-dangle
+  xdm._experience.decisioning.propositions : [];
+};
+
 var _default = function _default() {
   var content = {};
   var userXdm;
@@ -73,8 +82,17 @@ var _default = function _default() {
         return;
       }
 
+      var newPropositions = (0, _utils.deduplicateArray)([].concat(_toConsumableArray(getXdmPropositions(userXdm)), _toConsumableArray(getXdmPropositions(content.xdm))), function (a, b) {
+        return a === b || a.id && b.id && a.id === b.id && a.scope && b.scope && a.scope === b.scope;
+      });
+
       if (userXdm) {
-        event.mergeXdm(userXdm);
+        this.mergeXdm(userXdm);
+      }
+
+      if (newPropositions.length > 0) {
+        // eslint-disable-next-line no-underscore-dangle
+        content.xdm._experience.decisioning.propositions = newPropositions;
       }
 
       if (userData) {
@@ -117,7 +135,7 @@ var _default = function _default() {
       return shouldSendEvent;
     },
     getViewName: function getViewName() {
-      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails) {
+      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails || !userXdm.web.webPageDetails.viewName) {
         return undefined;
       }
 

package/libEs5/core/createEventManager.js

@@ -123,7 +123,8 @@ var _default = function _default(_ref) {
           _options$responseBody = options.responseBody,
           responseBody = _options$responseBody === void 0 ? {
         handle: []
-      } : _options$responseBody;
+      } : _options$responseBody,
+          personalization = options.personalization;
       var payload = createDataCollectionRequestPayload();
       var request = createDataCollectionRequest({
         payload: payload
@@ -133,7 +134,7 @@ var _default = function _default(_ref) {
         event: event,
         renderDecisions: renderDecisions,
         decisionScopes: [_pageWideScope.default],
-        personalization: {},
+        personalization: personalization,
         onResponse: onResponseCallbackAggregator.add,
         onRequestFailure: _utils.noop
       }).then(function () {

package/libEs5/{components/Personalization/utils/composePersonalizationResultingObject.js → utils/deduplicateArray.js}

@@ -2,8 +2,6 @@
 
 exports.default = void 0;
 
-var _addRenderAttemptedToDecisions = require("./addRenderAttemptedToDecisions");
-
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -15,21 +13,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.
 */
-var _default = function _default() {
-  var decisions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  var renderDecisions = arguments.length > 1 ? arguments[1] : undefined;
-  var resultingObject = {
-    propositions: (0, _addRenderAttemptedToDecisions.default)({
-      decisions: decisions,
-      renderAttempted: renderDecisions
-    })
-  };
+var REFERENCE_EQUALITY = function REFERENCE_EQUALITY(a, b) {
+  return a === b;
+};
 
-  if (!renderDecisions) {
-    resultingObject.decisions = decisions;
+var findIndex = function findIndex(array, item, isEqual) {
+  for (var i = 0; i < array.length; i += 1) {
+    if (isEqual(array[i], item)) {
+      return i;
+    }
   }
 
-  return resultingObject;
+  return -1;
+};
+
+var _default = function _default(array) {
+  var isEqual = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : REFERENCE_EQUALITY;
+  return array.filter(function (item, index) {
+    return findIndex(array, item, isEqual) === index;
+  });
 };
 
 exports.default = _default;

package/libEs5/utils/index.js

@@ -60,6 +60,12 @@ Object.defineProperty(exports, "createTaskQueue", {
     return _createTaskQueue.default;
   }
 });
+Object.defineProperty(exports, "deduplicateArray", {
+  enumerable: true,
+  get: function get() {
+    return _deduplicateArray.default;
+  }
+});
 Object.defineProperty(exports, "deepAssign", {
   enumerable: true,
   get: function get() {
@@ -353,6 +359,8 @@ var _crc = require("./crc32");
 
 var _defer = require("./defer");
 
+var _deduplicateArray = require("./deduplicateArray");
+
 var _deepAssign = require("./deepAssign");
 
 var _endsWith = require("./endsWith");

package/libEs6/components/DataCollector/index.js

@@ -101,13 +101,15 @@ const createDataCollector = ({
             responseHeaders = {},
             responseBody = {
               handle: []
-            }
+            },
+            personalization
           } = options;
           const event = eventManager.createEvent();
           return eventManager.applyResponse(event, {
             renderDecisions,
             responseHeaders,
-            responseBody
+            responseBody,
+            personalization
           });
         }
       }

package/libEs6/components/DataCollector/validateApplyResponse.js

@@ -21,7 +21,12 @@ export default (({
         type: string().required(),
         payload: anything().required()
       })).required()
-    }).required()
+    }).required(),
+    personalization: objectOf({
+      sendDisplayNotifications: boolean().default(true)
+    }).default({
+      sendDisplayNotifications: true
+    })
   }).noUnknownFields();
   return validator(options);
 });

package/libEs6/components/DataCollector/validateUserEventOptions.js

@@ -32,7 +32,11 @@ export default (({
     decisionScopes: arrayOf(string()).uniqueItems(),
     personalization: objectOf({
       decisionScopes: arrayOf(string()).uniqueItems(),
-      surfaces: arrayOf(string()).uniqueItems()
+      surfaces: arrayOf(string()).uniqueItems(),
+      sendDisplayNotifications: boolean().default(true),
+      includePendingDisplayNotifications: boolean().default(false)
+    }).default({
+      sendDisplayNotifications: true
     }),
     datasetId: string(),
     mergeId: string(),

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -9,14 +9,15 @@ 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, isObject } from "../../utils";
 import { DOM_ACTION, HTML_CONTENT_ITEM } from "./constants/schema";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
-import { EMPTY_PROPOSITIONS } from "./validateApplyPropositionsOptions";
-export const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
+const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
 export default (({
-  executeDecisions
+  processPropositions,
+  createProposition,
+  pendingDisplayNotifications,
+  viewCache
 }) => {
   const filterItemsPredicate = item => SUPPORTED_SCHEMAS.indexOf(item.schema) > -1;
 
@@ -73,30 +74,30 @@ export default (({
     }).filter(proposition => isNonEmptyArray(proposition.items));
   };
 
-  const applyPropositions = ({
-    propositions,
-    metadata
+  return ({
+    propositions = [],
+    metadata = {},
+    viewName
   }) => {
     const propositionsToExecute = preparePropositions({
       propositions,
       metadata
-    });
-    return executeDecisions(propositionsToExecute).then(() => {
-      return composePersonalizationResultingObject(propositionsToExecute, true);
-    });
-  };
-
-  return ({
-    propositions,
-    metadata = {}
-  }) => {
-    if (isNonEmptyArray(propositions)) {
-      return applyPropositions({
-        propositions,
-        metadata
-      });
-    }
+    }).map(proposition => createProposition(proposition));
+    return Promise.resolve().then(() => {
+      if (viewName) {
+        return viewCache.getView(viewName);
+      }
 
-    return Promise.resolve(EMPTY_PROPOSITIONS);
+      return [];
+    }).then(additionalPropositions => {
+      const {
+        render,
+        returnedPropositions
+      } = processPropositions([...propositionsToExecute, ...additionalPropositions]);
+      pendingDisplayNotifications.concat(render());
+      return {
+        propositions: returnedPropositions
+      };
+    });
   };
 });

package/libEs6/components/Personalization/createComponent.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 { noop, defer } from "../../utils";
+import { noop } from "../../utils";
 import createPersonalizationDetails from "./createPersonalizationDetails";
 import { AUTHORING_ENABLED } from "./constants/loggerMessage";
 import validateApplyPropositionsOptions from "./validateApplyPropositionsOptions";
@@ -24,7 +24,8 @@ export default (({
   viewCache,
   showContainers,
   applyPropositions,
-  setTargetMigration
+  setTargetMigration,
+  pendingNotificationsHandler
 }) => {
   return {
     lifecycle: {
@@ -55,7 +56,7 @@ export default (({
           mergeQuery(event, {
             enabled: false
           });
-          return;
+          return Promise.resolve();
         }
 
         const personalizationDetails = createPersonalizationDetails({
@@ -64,32 +65,39 @@ export default (({
           decisionScopes,
           personalization,
           event,
-          viewCache,
+          isCacheInitialized: viewCache.isInitialized(),
           logger
         });
+        const handlerPromises = [];
+
+        if (personalizationDetails.shouldAddPendingDisplayNotifications()) {
+          handlerPromises.push(pendingNotificationsHandler({
+            event
+          }));
+        }
 
         if (personalizationDetails.shouldFetchData()) {
-          const decisionsDeferred = defer();
-          viewCache.storeViews(decisionsDeferred.promise);
-          onRequestFailure(() => decisionsDeferred.reject());
+          const cacheUpdate = viewCache.createCacheUpdate(personalizationDetails.getViewName());
+          onRequestFailure(() => cacheUpdate.cancel());
           fetchDataHandler({
-            decisionsDeferred,
+            cacheUpdate,
             personalizationDetails,
             event,
             onResponse
           });
-          return;
-        }
-
-        if (personalizationDetails.shouldUseCachedData()) {
+        } else if (personalizationDetails.shouldUseCachedData()) {
           // eslint-disable-next-line consistent-return
-          return viewChangeHandler({
+          handlerPromises.push(viewChangeHandler({
             personalizationDetails,
             event,
             onResponse,
             onRequestFailure
-          });
-        }
+          }));
+        } // We can wait for personalization to be applied and for
+        // the fetch data request to complete in parallel.
+
+
+        return Promise.all(handlerPromises);
       },
 
       onClick({