@adobe/alloy 2.20.0 → 2.21.0-beta.0

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

@@ -11,15 +11,16 @@ governing permissions and limitations under the License.
 */
 
 import { SRC } from "../../../constants/elementAttribute.js";
-import { setAttribute, removeAttribute } from "./dom/index.js";
+import { removeAttribute, setAttribute } from "./dom/index.js";
 import { isImage, loadImage } from "./images.js";
-export default ((container, url) => {
+export default ((container, url, decorateProposition) => {
   if (!isImage(container)) {
     return;
   }
 
   // Start downloading the image
   loadImage(url);
+  decorateProposition(container);
 
   // Remove "src" so there is no flicker
   removeAttribute(container, SRC);

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

@@ -0,0 +1,59 @@
+/*
+Copyright 2024 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 { getAttribute, setAttribute } from "../dom-actions/dom/index.js";
+import { includes, noop } from "../../../utils/index.js";
+import { DOM_ACTION_CLICK } from "../dom-actions/initDomActionsModules.js";
+import { ALWAYS, DECORATED_ELEMENTS_ONLY } from "../../../constants/propositionInteractionType.js";
+export const INTERACT_ID_DATA_ATTRIBUTE = "data-aep-interact-id";
+export const CLICK_LABEL_DATA_ATTRIBUTE = "data-aep-click-label";
+export const CLICK_TOKEN_DATA_ATTRIBUTE = "data-aep-click-token";
+let lastInteractId = 0;
+const getInteractId = (propositionId, existingInteractId) => {
+  if (existingInteractId) {
+    return parseInt(existingInteractId, 10);
+  }
+
+  // eslint-disable-next-line no-plusplus
+  return ++lastInteractId;
+};
+const interactionTrackingSupported = (autoCollectPropositionInteractions, decisionProvider) => {
+  if (!autoCollectPropositionInteractions) {
+    return false;
+  }
+  if (!autoCollectPropositionInteractions[decisionProvider]) {
+    return false;
+  }
+  return includes([ALWAYS, DECORATED_ELEMENTS_ONLY], autoCollectPropositionInteractions[decisionProvider]);
+};
+const createDecorateProposition = (autoCollectPropositionInteractions, type, propositionId, itemId, trackingLabel, scopeType, notification, storeInteractionMeta) => {
+  const {
+    scopeDetails = {}
+  } = notification;
+  const {
+    decisionProvider
+  } = scopeDetails;
+  if (!interactionTrackingSupported(autoCollectPropositionInteractions, decisionProvider) && type !== DOM_ACTION_CLICK) {
+    return noop;
+  }
+  return element => {
+    if (!element.tagName) {
+      return;
+    }
+    const interactId = getInteractId(propositionId, getAttribute(element, INTERACT_ID_DATA_ATTRIBUTE));
+    storeInteractionMeta(propositionId, itemId, scopeType, notification, interactId);
+    setAttribute(element, INTERACT_ID_DATA_ATTRIBUTE, interactId);
+    if (trackingLabel && !getAttribute(element, CLICK_LABEL_DATA_ATTRIBUTE)) {
+      setAttribute(element, CLICK_LABEL_DATA_ATTRIBUTE, trackingLabel);
+    }
+  };
+};
+export default createDecorateProposition;

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

@@ -9,10 +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 createDecorateProposition from "./createDecorateProposition.js";
+import { DOM_ACTION_CLICK } from "../dom-actions/initDomActionsModules.js";
 export default (({
   modules,
   logger,
-  storeClickMetrics
+  storeInteractionMeta,
+  storeClickMeta,
+  autoCollectPropositionInteractions
 }) => item => {
   const {
     type,
@@ -25,7 +30,7 @@ export default (({
       includeInNotification: false
     };
   }
-  if (type === "click") {
+  if (type === DOM_ACTION_CLICK) {
     if (!selector) {
       logger.warn("Invalid DOM action data: missing selector.", item.getData());
       return {
@@ -33,7 +38,7 @@ export default (({
         includeInNotification: false
       };
     }
-    storeClickMetrics({
+    storeClickMeta({
       selector,
       meta: {
         ...item.getProposition().getNotification(),
@@ -53,8 +58,9 @@ export default (({
       includeInNotification: false
     };
   }
+  const decorateProposition = createDecorateProposition(autoCollectPropositionInteractions, type, item.getProposition().getId(), item.getId(), item.getTrackingLabel(), item.getProposition().getScopeType(), item.getProposition().getNotification(), storeInteractionMeta);
   return {
-    render: () => modules[type](item.getData()),
+    render: () => modules[type](item.getData(), decorateProposition),
     setRenderAttempted: true,
     includeInNotification: true
   };

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

@@ -9,9 +9,12 @@ 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 createDecorateProposition from "./createDecorateProposition.js";
 export default (({
   modules,
-  logger
+  logger,
+  storeInteractionMeta,
+  autoCollectPropositionInteractions
 }) => item => {
   const {
     type,
@@ -30,9 +33,10 @@ export default (({
       includeInNotification: false
     };
   }
+  const decorateProposition = createDecorateProposition(autoCollectPropositionInteractions, type, item.getProposition().getId(), item.getId(), item.getTrackingLabel(), item.getProposition().getScopeType(), item.getProposition().getNotification(), storeInteractionMeta);
   return {
     render: () => {
-      modules[type](item.getData());
+      return modules[type](item.getData(), decorateProposition);
     },
     setRenderAttempted: true,
     includeInNotification: true

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

@@ -107,7 +107,7 @@ export default (({
       const meta = atLeastOneWithNotification ? proposition.getNotification() : undefined;
       renderers.push(() => renderItems(itemRenderers, meta));
     } else if (atLeastOneWithNotification) {
-      renderers.push(() => proposition.getNotification());
+      renderers.push(() => Promise.resolve(proposition.getNotification()));
     }
     if (renderedItems.length > 0) {
       proposition.addToReturnValues(returnedPropositions, returnedDecisions, renderedItems, true);

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

@@ -11,24 +11,32 @@ governing permissions and limitations under the License.
 */
 
 import PAGE_WIDE_SCOPE from "../../../constants/pageWideScope.js";
-import { VIEW_SCOPE_TYPE, PAGE_SCOPE_TYPE, PROPOSITION_SCOPE_TYPE } from "../constants/scopeType.js";
+import { PAGE_SCOPE_TYPE, PROPOSITION_SCOPE_TYPE, VIEW_SCOPE_TYPE } from "../constants/scopeType.js";
 export default (({
   preprocess,
   isPageWideSurface
 }) => {
   const createItem = (item, proposition) => {
     const {
+      id,
       schema,
       data,
       characteristics: {
         trackingLabel
       } = {}
     } = item;
+    const schemaType = data ? data.type : undefined;
     const processedData = preprocess(data);
     return {
+      getId() {
+        return id;
+      },
       getSchema() {
         return schema;
       },
+      getSchemaType() {
+        return schemaType;
+      },
       getData() {
         return processedData;
       },
@@ -87,6 +95,9 @@ export default (({
           scopeDetails
         };
       },
+      getId() {
+        return id;
+      },
       toJSON() {
         return payload;
       },

package/libEs6/components/Personalization/index.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 { boolean, objectOf, string } from "../../utils/validation/index.js";
+import { anyOf, boolean, literal, objectOf, string } from "../../utils/validation/index.js";
 import createComponent from "./createComponent.js";
 import { initDomActionsModules } from "./dom-actions/index.js";
 import createCollect from "./createCollect.js";
@@ -23,6 +23,7 @@ import createOnClickHandler from "./createOnClickHandler.js";
 import createViewCacheManager from "./createViewCacheManager.js";
 import createViewChangeHandler from "./createViewChangeHandler.js";
 import createClickStorage from "./createClickStorage.js";
+import createInteractionStorage from "./createInteractionStorage.js";
 import createApplyPropositions from "./createApplyPropositions.js";
 import createGetPageLocation from "./createGetPageLocation.js";
 import createSetTargetMigration from "./createSetTargetMigration.js";
@@ -44,6 +45,9 @@ import initInAppMessageActionsModules from "./in-app-message-actions/initInAppMe
 import createRedirect from "./dom-actions/createRedirect.js";
 import createNotificationHandler from "./createNotificationHandler.js";
 import createHandleConsentFlicker from "./createHandleConsentFlicker.js";
+import collectInteractions from "./dom-actions/clicks/collectInteractions.js";
+import { ALWAYS, NEVER, PROPOSITION_INTERACTION_TYPES } from "../../constants/propositionInteractionType.js";
+import { ADOBE_JOURNEY_OPTIMIZER, ADOBE_TARGET } from "../../constants/decisionProvider.js";
 const createPersonalization = ({
   config,
   logger,
@@ -52,16 +56,21 @@ const createPersonalization = ({
 }) => {
   const {
     targetMigrationEnabled,
-    prehidingStyle
+    prehidingStyle,
+    autoCollectPropositionInteractions
   } = config;
   const collect = createCollect({
     eventManager,
     mergeDecisionsMeta
   });
   const {
-    getClickMetasBySelector,
+    storeInteractionMeta,
+    getInteractionMetas
+  } = createInteractionStorage();
+  const {
+    storeClickMeta,
     getClickSelectors,
-    storeClickMetrics
+    getClickMetas
   } = createClickStorage();
   const getPageLocation = createGetPageLocation({
     window
@@ -81,11 +90,15 @@ const createPersonalization = ({
     [schema.DOM_ACTION]: createProcessDomAction({
       modules: domActionsModules,
       logger,
-      storeClickMetrics
+      storeInteractionMeta,
+      storeClickMeta,
+      autoCollectPropositionInteractions
     }),
     [schema.HTML_CONTENT_ITEM]: createProcessHtmlContent({
       modules: domActionsModules,
-      logger
+      logger,
+      storeInteractionMeta,
+      autoCollectPropositionInteractions
     }),
     [schema.REDIRECT_ITEM]: createProcessRedirect({
       logger,
@@ -115,9 +128,12 @@ const createPersonalization = ({
   });
   const onClickHandler = createOnClickHandler({
     mergeDecisionsMeta,
+    collectInteractions,
     collectClicks,
+    getInteractionMetas,
+    getClickMetas,
     getClickSelectors,
-    getClickMetasBySelector
+    autoCollectPropositionInteractions
   });
   const viewChangeHandler = createViewChangeHandler({
     processPropositions,
@@ -160,8 +176,16 @@ const createPersonalization = ({
   });
 };
 createPersonalization.namespace = "Personalization";
+const interactionConfigOptions = PROPOSITION_INTERACTION_TYPES.map(propositionInteractionType => literal(propositionInteractionType));
 createPersonalization.configValidators = objectOf({
   prehidingStyle: string().nonEmpty(),
-  targetMigrationEnabled: boolean().default(false)
+  targetMigrationEnabled: boolean().default(false),
+  autoCollectPropositionInteractions: objectOf({
+    [ADOBE_JOURNEY_OPTIMIZER]: anyOf(interactionConfigOptions).default(ALWAYS),
+    [ADOBE_TARGET]: anyOf(interactionConfigOptions).default(NEVER)
+  }).default({
+    [ADOBE_JOURNEY_OPTIMIZER]: ALWAYS,
+    [ADOBE_TARGET]: NEVER
+  }).noUnknownFields()
 });
 export default createPersonalization;

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

@@ -0,0 +1,23 @@
+/*
+Copyright 2024 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 cleanMetas = metas => metas.map(meta => {
+  const {
+    trackingLabel,
+    scopeType,
+    ...rest
+  } = meta;
+  return rest;
+});
+export const dedupeMetas = metas => metas.filter((meta, index) => {
+  const stringifiedMeta = JSON.stringify(meta);
+  return index === metas.findIndex(innerMeta => JSON.stringify(innerMeta) === stringifiedMeta);
+});

package/libEs6/components/Personalization/validateApplyPropositionsOptions.js

@@ -18,7 +18,18 @@ export default (({
   options
 }) => {
   const applyPropositionsOptionsValidator = objectOf({
-    propositions: arrayOf(objectOf(anything())),
+    propositions: arrayOf(objectOf({
+      id: string().required(),
+      scope: string().required(),
+      scopeDetails: objectOf({
+        decisionProvider: string().required()
+      }).required(),
+      items: arrayOf(objectOf({
+        id: string().required(),
+        schema: string().required(),
+        data: anything().required()
+      })).nonEmpty().required()
+    }).required()).nonEmpty().required(),
     metadata: objectOf(anything()),
     viewName: string()
   }).required();

package/libEs6/constants/decisionProvider.js

@@ -9,4 +9,5 @@ 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 const ADOBE_JOURNEY_OPTIMIZER = "AJO";
+export const ADOBE_JOURNEY_OPTIMIZER = "AJO";
+export const ADOBE_TARGET = "TGT";

package/libEs6/constants/libraryVersion.js

@@ -13,4 +13,4 @@ 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
 
-export default "2.20.0";
+export default "2.21.0-beta.0";

package/libEs6/constants/propositionInteractionType.js

@@ -0,0 +1,15 @@
+/*
+Copyright 2024 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 ALWAYS = "always";
+export const NEVER = "never";
+export const DECORATED_ELEMENTS_ONLY = "decoratedElementsOnly";
+export const PROPOSITION_INTERACTION_TYPES = [ALWAYS, NEVER, DECORATED_ELEMENTS_ONLY];

package/libEs6/utils/dom/awaitSelector.js

@@ -34,14 +34,18 @@ export const canUseMutationObserver = win => {
 };
 export const awaitUsingMutationObserver = (win, doc, selector, timeout, selectFunc) => {
   return createPromise((resolve, reject) => {
+    let timer;
     const mutationObserver = new win[MUTATION_OBSERVER](() => {
       const nodes = selectFunc(selector);
       if (isNonEmptyArray(nodes)) {
         mutationObserver.disconnect();
+        if (timer) {
+          clearTimeout(timer);
+        }
         resolve(nodes);
       }
     });
-    setTimeout(() => {
+    timer = setTimeout(() => {
       mutationObserver.disconnect();
       reject(createError(selector));
     }, timeout);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.20.0",
+  "version": "2.21.0-beta.0",
   "description": "Adobe Experience Platform Web SDK",
   "type": "module",
   "main": "libEs5/index.js",
@@ -75,7 +75,7 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.20.0-beta.9",
+    "@adobe/alloy": "^2.20.0",
     "@babel/cli": "^7.24.5",
     "@babel/core": "^7.24.5",
     "@babel/eslint-parser": "^7.24.5",