@adobe/alloy 2.23.0 → 2.24.0-beta.1

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

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 
 import { setStyle } from "./dom/index.js";
-export default ((container, styles, decorateProposition) => {
+export default (container, styles, decorateProposition) => {
   const {
     priority,
     ...style
@@ -20,4 +20,4 @@ export default ((container, styles, decorateProposition) => {
     setStyle(container, key, style[key], priority);
   });
   decorateProposition(container);
-});
+};

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

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-export default ((container, text, decorateProposition) => {
+export default (container, text, decorateProposition) => {
   decorateProposition(container);
   container.textContent = text;
-});
+};

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

@@ -13,7 +13,7 @@ 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) => {
+export default (container, url, decorateProposition) => {
   if (!isImage(container)) {
     return;
   }
@@ -27,4 +27,4 @@ export default ((container, url, decorateProposition) => {
 
   // Replace the image "src"
   setAttribute(container, SRC, url);
-});
+};

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

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 
 import createDecorateProposition from "./createDecorateProposition.js";
 import { DOM_ACTION_CLICK } from "../dom-actions/initDomActionsModules.js";
-export default (({
+export default ({
   modules,
   logger,
   storeInteractionMeta,
@@ -64,4 +64,4 @@ export default (({
     setRenderAttempted: true,
     includeInNotification: true
   };
-});
+};

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

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import createDecorateProposition from "./createDecorateProposition.js";
-export default (({
+export default ({
   modules,
   logger,
   storeInteractionMeta,
@@ -41,4 +41,4 @@ export default (({
     setRenderAttempted: true,
     includeInNotification: true
   };
-});
+};

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

@@ -36,15 +36,17 @@ const isValidInAppMessage = (data, logger) => {
   }
   return true;
 };
-export default (({
+export default ({
   modules,
   logger
 }) => {
   return item => {
     const data = item.getData();
+    const proposition = item.getProposition();
     const meta = {
-      ...item.getProposition().getNotification()
+      ...proposition.getNotification()
     };
+    const shouldSuppressDisplay = proposition.shouldSuppressDisplay();
     if (!data) {
       logger.warn("Invalid in-app message data: undefined.", data);
       return {};
@@ -65,7 +67,7 @@ export default (({
     }
     return {
       render: () => {
-        return modules[type]({
+        return shouldSuppressDisplay ? null : modules[type]({
           ...data,
           meta
         });
@@ -74,4 +76,4 @@ export default (({
       includeInNotification: true
     };
   };
-});
+};

package/libEs6/components/Personalization/handlers/createProcessPropositions.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 { groupBy } from "../../../utils/index.js";
-export default (({
+import { groupBy, isNonEmptyArray } from "../../../utils/index.js";
+export default ({
   schemaProcessors,
   logger
 }) => {
@@ -20,7 +20,7 @@ export default (({
       if (logger.enabled) {
         logger.info(`Action ${item.toString()} executed.`);
       }
-      return true;
+      return item.toJSON();
     }).catch(error => {
       const {
         message,
@@ -37,16 +37,20 @@ export default (({
         message: warning,
         logLevel: "warn"
       });
-      return false;
+      return undefined;
     });
   };
-  const renderItems = (renderers, meta) => Promise.all(renderers.map(renderer => renderer())).then(successes => {
+  const renderItems = (renderers, meta) => Promise.all(renderers.map(renderer => renderer())).then(results => {
+    const successes = results.filter(result => result);
     // as long as at least one renderer succeeds, we want to add the notification
     // to the display notifications
-    if (!successes.includes(true)) {
-      return undefined;
+    if (meta && isNonEmptyArray(successes)) {
+      return {
+        ...meta,
+        items: successes
+      };
     }
-    return meta;
+    return undefined;
   });
   const processItem = item => {
     const processor = schemaProcessors[item.getSchema()];
@@ -173,16 +177,30 @@ export default (({
     });
     const render = () => {
       return Promise.all(renderers.map(renderer => renderer())).then(metas => {
-        const renderedPropositions = metas.filter(meta => meta);
-        const propsByScope = groupBy(renderedPropositions, p => p.scope);
-        logger.logOnContentRendering({
-          status: "rendering-succeeded",
-          detail: {
-            ...propsByScope
-          },
-          message: `Scopes: ${JSON.stringify(propsByScope)} successfully executed.`,
-          logLevel: "info"
+        const propositions = metas.filter(meta => meta);
+        const renderedPropositions = propositions.map(prop => {
+          const {
+            id,
+            scope,
+            scopeDetails
+          } = prop;
+          return {
+            id,
+            scope,
+            scopeDetails
+          };
         });
+        if (isNonEmptyArray(propositions)) {
+          const propsByScope = groupBy(propositions, p => p.scope);
+          logger.logOnContentRendering({
+            status: "rendering-succeeded",
+            detail: {
+              ...propsByScope
+            },
+            message: `Scopes: ${JSON.stringify(propsByScope)} successfully executed.`,
+            logLevel: "info"
+          });
+        }
         return renderedPropositions;
       });
     };
@@ -192,4 +210,4 @@ export default (({
       render
     };
   };
-});
+};

package/libEs6/components/Personalization/handlers/createProcessRedirect.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.
 */
-export default (({
+export default ({
   logger,
   executeRedirect,
   collect
@@ -47,4 +47,4 @@ export default (({
     setRenderAttempted: true,
     onlyRenderThis: true
   };
-});
+};

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

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 
 import PAGE_WIDE_SCOPE from "../../../constants/pageWideScope.js";
 import { PAGE_SCOPE_TYPE, PROPOSITION_SCOPE_TYPE, VIEW_SCOPE_TYPE } from "../constants/scopeType.js";
-export default (({
+export default ({
   preprocess,
   isPageWideSurface
 }) => {
@@ -57,7 +57,7 @@ export default (({
       }
     };
   };
-  return (payload, visibleInReturnedItems = true) => {
+  return (payload, visibleInReturnedItems = true, shouldSuppressDisplay = false) => {
     const {
       id,
       scope,
@@ -98,6 +98,9 @@ export default (({
       toJSON() {
         return payload;
       },
+      shouldSuppressDisplay() {
+        return shouldSuppressDisplay;
+      },
       addToReturnValues(propositions, decisions, includedItems, renderAttempted) {
         if (visibleInReturnedItems) {
           propositions.push({
@@ -115,4 +118,4 @@ export default (({
       }
     };
   };
-});
+};

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

@@ -9,9 +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 (() => {
+import noop from "../../../utils/noop.js";
+export default () => {
   return {
+    render: noop,
     setRenderAttempted: true,
     includeInNotification: true
   };
-});
+};

package/libEs6/components/Personalization/in-app-message-actions/actions/displayIframeContent.js

@@ -271,7 +271,7 @@ export const displayHTMLContentInIframe = (settings = {}, interact) => {
   }
   renderMessage(iframe, webParameters, container, overlay);
 };
-export default ((settings, collect) => {
+export default (settings, collect) => {
   return new Promise(resolve => {
     const {
       meta
@@ -293,4 +293,4 @@ export default ((settings, collect) => {
       meta
     });
   });
-});
+};

package/libEs6/components/Personalization/in-app-message-actions/initInAppMessageActionsModules.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 displayIframeContent from "./actions/displayIframeContent.js";
-export default (collect => {
+export default collect => {
   return {
     defaultContent: settings => displayIframeContent(settings, collect)
   };
-});
+};

package/libEs6/components/Personalization/utils/addRenderAttemptedToDecisions.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-export default (({
+export default ({
   decisions,
   renderAttempted
 }) => {
@@ -18,4 +18,4 @@ export default (({
     renderAttempted,
     ...decision
   }));
-});
+};

package/libEs6/components/Personalization/utils/createAsyncArray.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.
 */
-export default (() => {
+export default () => {
   let latest = Promise.resolve([]);
   return {
     concat(promise) {
@@ -32,4 +32,4 @@ export default (() => {
       return oldLatest;
     }
   };
-});
+};

package/libEs6/components/Personalization/utils/isAuthoringModeEnabled.js

@@ -10,6 +10,6 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-export default ((doc = document) => {
+export default (doc = document) => {
   return doc.location.href.indexOf("adobe_authoring_enabled") !== -1;
-});
+};

package/libEs6/components/Personalization/validateApplyPropositionsOptions.js

@@ -13,7 +13,7 @@ import { anything, objectOf, arrayOf, string } from "../../utils/validation/inde
 export const EMPTY_PROPOSITIONS = {
   propositions: []
 };
-export default (({
+export default ({
   logger,
   options
 }) => {
@@ -27,7 +27,7 @@ export default (({
       items: arrayOf(objectOf({
         id: string().required(),
         schema: string().required(),
-        data: anything().required()
+        data: objectOf(anything())
       })).nonEmpty().required()
     }).required()).nonEmpty().required(),
     metadata: objectOf(anything()),
@@ -39,4 +39,4 @@ export default (({
     logger.warn("Invalid options for applyPropositions. No propositions will be applied.", e);
     return EMPTY_PROPOSITIONS;
   }
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/consequenceAdapters/inAppMessageConsequenceAdapter.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 import { MESSAGE_IN_APP } from "../../../constants/schema.js";
 import { TEXT_HTML } from "../../../constants/contentType.js";
-export default ((id, type, detail) => {
+export default (id, type, detail) => {
   const {
     html,
     mobileParameters
@@ -27,4 +27,4 @@ export default ((id, type, detail) => {
     },
     id
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/consequenceAdapters/schemaTypeConsequenceAdapter.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-export default ((id, type, detail) => {
+export default (id, type, detail) => {
   const {
     schema,
     data,
@@ -21,4 +21,4 @@ export default ((id, type, detail) => {
     data,
     id: detailId || id
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createApplyResponse.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.
 */
-export default (lifecycle => {
+export default lifecycle => {
   return ({
     renderDecisions = false,
     propositions = [],
@@ -28,4 +28,4 @@ export default (lifecycle => {
       propositions
     };
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createConsequenceAdapter.js

@@ -17,7 +17,7 @@ const adapters = {
   [CJM_IN_APP_MESSAGE_TYPE]: inAppMessageConsequenceAdapter,
   [SCHEMA]: schemaTypeConsequenceAdapter
 };
-export default (() => {
+export default () => {
   return consequence => {
     const {
       id,
@@ -26,4 +26,4 @@ export default (() => {
     } = consequence;
     return typeof adapters[type] === "function" ? adapters[type](id, type, detail) : detail;
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createContextProvider.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 import parseUrl from "../../utils/parseUrl.js";
 import flattenObject from "../../utils/flattenObject.js";
 import libraryVersion from "../../constants/libraryVersion.js";
-export default (({
+export default ({
   eventRegistry,
   window,
   getBrowser
@@ -92,4 +92,4 @@ export default (({
   return {
     getContext
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createDecisionHistory.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import { PropositionEventType } from "../../constants/propositionEventType.js";
-export default (({
+export default ({
   eventRegistry
 }) => {
   const recordQualified = id => {
@@ -22,4 +22,4 @@ export default (({
   return {
     recordQualified
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createDecisionProvider.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 import createEvaluableRulesetPayload from "./createEvaluableRulesetPayload.js";
 import createDecisionHistory from "./createDecisionHistory.js";
 import { getActivityId } from "./utils.js";
-export default (({
+export default ({
   eventRegistry
 }) => {
   const payloadsBasedOnActivityId = {};
@@ -29,7 +29,14 @@ export default (({
       payloadsBasedOnActivityId[activityId] = evaluableRulesetPayload;
     }
   };
-  const evaluate = (context = {}) => Object.values(payloadsBasedOnActivityId).map(payload => payload.evaluate(context)).filter(payload => payload.items.length > 0);
+  const evaluate = (context = {}) => {
+    const sortedPayloadsBasedOnActivityId = Object.values(payloadsBasedOnActivityId).sort(({
+      rank: rankA
+    }, {
+      rank: rankB
+    }) => rankA - rankB);
+    return sortedPayloadsBasedOnActivityId.map(payload => payload.evaluate(context)).filter(payload => payload.items.length > 0);
+  };
   const addPayloads = personalizationPayloads => {
     personalizationPayloads.forEach(addPayload);
   };
@@ -38,4 +45,4 @@ export default (({
     addPayloads,
     evaluate
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createEvaluableRulesetPayload.js

@@ -33,7 +33,7 @@ const isRulesetItem = item => {
     return false;
   }
 };
-export default ((payload, eventRegistry, decisionHistory) => {
+export default (payload, eventRegistry, decisionHistory) => {
   const consequenceAdapter = createConsequenceAdapter();
   const activityId = getActivityId(payload);
   const items = [];
@@ -73,7 +73,8 @@ export default ((payload, eventRegistry, decisionHistory) => {
     payload.items.filter(isRulesetItem).forEach(addItem);
   }
   return {
+    rank: payload?.scopeDetails?.rank || Infinity,
     evaluate,
     isEvaluable: items.length > 0
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createEvaluateRulesetsCommand.js

@@ -21,7 +21,7 @@ const validateOptions = ({
   }).noUnknownFields();
   return validator(options);
 };
-export default (({
+export default ({
   contextProvider,
   decisionProvider
 }) => {
@@ -42,4 +42,4 @@ export default (({
     optionsValidator,
     run
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createEventRegistry.js

@@ -28,7 +28,7 @@ export const createEventPruner = (limit = MAX_EVENT_RECORDS, retentionPeriod = R
     return pruned;
   };
 };
-export default (({
+export default ({
   storage
 }) => {
   let currentStorage = storage;
@@ -117,4 +117,4 @@ export default (({
     toJSON: () => events,
     setStorage
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createOnResponseHandler.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 import { PERSONALIZATION_DECISIONS_HANDLE } from "../../constants/handle.js";
 import flattenObject from "../../utils/flattenObject.js";
-export default (({
+export default ({
   renderDecisions,
   decisionProvider,
   applyResponse,
@@ -42,4 +42,4 @@ export default (({
       personalization
     });
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/createSubscribeRulesetItems.js

@@ -34,7 +34,7 @@ const getAnalyticsDetail = proposition => {
     scopeDetails
   };
 };
-export default (({
+export default ({
   collect
 }) => {
   let emitPropositions = () => undefined;
@@ -126,4 +126,4 @@ export default (({
       run
     }
   };
-});
+};

package/libEs6/components/{DecisioningEngine → RulesEngine}/index.js

@@ -22,7 +22,7 @@ import { clearLocalStorage, createInMemoryStorage } from "./utils.js";
 import { objectOf, boolean } from "../../utils/validation/index.js";
 import createCollect from "../../utils/createCollect.js";
 import { mergeDecisionsMeta } from "../../utils/event.js";
-const createDecisioningEngine = ({
+const createRulesEngine = ({
   config,
   eventManager,
   createNamespacedStorage,
@@ -139,8 +139,8 @@ const createDecisioningEngine = ({
     }
   };
 };
-createDecisioningEngine.namespace = "DecisioningEngine";
-createDecisioningEngine.configValidators = objectOf({
+createRulesEngine.namespace = "RulesEngine";
+createRulesEngine.configValidators = objectOf({
   personalizationStorageEnabled: boolean().default(false)
 });
-export default createDecisioningEngine;
+export default createRulesEngine;

package/libEs6/components/StreamingMedia/createMediaEventManager.js

@@ -13,7 +13,7 @@ import MediaEvents from "./constants/eventTypes.js";
 import createMediaRequest from "./createMediaRequest.js";
 import { toInteger } from "../../utils/index.js";
 import { createDataCollectionRequestPayload } from "../../utils/request/index.js";
-export default (({
+export default ({
   config,
   eventManager,
   consent,
@@ -93,11 +93,14 @@ export default (({
     },
     trackMediaSession({
       event,
-      mediaOptions
+      mediaOptions,
+      edgeConfigOverrides
     }) {
-      return eventManager.sendEvent(event, {
-        mediaOptions
-      });
+      const sendEventOptions = {
+        mediaOptions,
+        edgeConfigOverrides
+      };
+      return eventManager.sendEvent(event, sendEventOptions);
     },
     trackMediaEvent({
       event,
@@ -119,4 +122,4 @@ export default (({
       });
     }
   };
-});
+};

package/libEs6/components/StreamingMedia/createMediaRequest.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 
 import { createRequest } from "../../utils/request/index.js";
-export default (({
+export default ({
   mediaRequestPayload,
   action
 }) => {
@@ -25,4 +25,4 @@ export default (({
       return false;
     }
   });
-});
+};

package/libEs6/components/StreamingMedia/createMediaResponseHandler.js

@@ -13,7 +13,7 @@ import isBlankString from "../../utils/isBlankString.js";
 import MediaEvents from "./constants/eventTypes.js";
 import { isNonEmptyArray } from "../../utils/index.js";
 import PlaybackState from "./constants/playbackState.js";
-export default (({
+export default ({
   mediaSessionCacheManager,
   config,
   trackMediaEvent
@@ -55,4 +55,4 @@ export default (({
     }
     return {};
   };
-});
+};

package/libEs6/components/StreamingMedia/createMediaSessionCacheManager.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 
 import PlaybackState from "./constants/playbackState.js";
-export default (() => {
+export default () => {
   let mediaSessionCache;
   const getSession = playerId => {
     return mediaSessionCache[playerId] || {};
@@ -56,4 +56,4 @@ export default (() => {
     stopPing,
     savePing
   };
-});
+};