@adobe/alloy 2.12.0 → 2.13.0-beta.0

package/libEs6/components/DataCollector/index.js

@@ -10,6 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import validateUserEventOptions from "./validateUserEventOptions";
+import validateApplyResponse from "./validateApplyResponse";
 
 const createDataCollector = ({
   eventManager
@@ -68,6 +69,29 @@ const createDataCollector = ({
             decisionScopes
           });
         }
+      },
+      applyResponse: {
+        documentationUri: "",
+        optionsValidator: options => {
+          return validateApplyResponse({
+            options
+          });
+        },
+        run: options => {
+          const {
+            renderDecisions = false,
+            responseHeaders = {},
+            responseBody = {
+              handle: []
+            }
+          } = options;
+          const event = eventManager.createEvent();
+          return eventManager.applyResponse(event, {
+            renderDecisions,
+            responseHeaders,
+            responseBody
+          });
+        }
       }
     }
   };

package/libEs6/components/DataCollector/validateApplyResponse.js

@@ -0,0 +1,16 @@
+import { anything, arrayOf, boolean, mapOfValues, objectOf, string } from "../../utils/validation";
+export default (({
+  options
+}) => {
+  const validator = objectOf({
+    renderDecisions: boolean(),
+    responseHeaders: mapOfValues(string().required()),
+    responseBody: objectOf({
+      handle: arrayOf(objectOf({
+        type: string().required(),
+        payload: anything().required()
+      })).required()
+    }).required()
+  }).noUnknownFields();
+  return validator(options);
+});

package/libEs6/components/DataCollector/validateUserEventOptions.js

@@ -27,9 +27,11 @@ export default (({
       identityMap: validateIdentityMap
     }),
     data: objectOf({}),
+    documentUnloading: boolean(),
     renderDecisions: boolean(),
-    decisionScopes: arrayOf(string()),
-    datasetId: string()
-  }).required();
+    decisionScopes: arrayOf(string()).uniqueItems(),
+    datasetId: string(),
+    mergeId: string()
+  }).required().noUnknownFields();
   return eventOptionsValidator(options);
 });

package/libEs6/components/Identity/getIdentity/getIdentityOptionsValidator.js

@@ -18,7 +18,7 @@ import { objectOf, literal, arrayOf } from "../../../utils/validation";
 
 export default (options => {
   const getIdentityOptionsValidator = objectOf({
-    namespaces: arrayOf(literal("ECID")).nonEmpty()
+    namespaces: arrayOf(literal("ECID")).nonEmpty().uniqueItems()
   }).noUnknownFields();
   getIdentityOptionsValidator(options); // Return default options for now
   // To-Do: Accept namespace from given options

package/libEs6/components/Personalization/constants/propositionEventType.js

@@ -0,0 +1,15 @@
+/*
+Copyright 2022 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 PropositionEventType = {
+  DISPLAY: "display",
+  INTERACT: "interact"
+};

package/libEs6/components/Personalization/createCollect.js

@@ -10,6 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 import { DISPLAY } from "./constants/eventType";
+import { PropositionEventType } from "./constants/propositionEventType";
 import { isNonEmptyArray } from "../../utils";
 export default (({
   eventManager,
@@ -35,7 +36,7 @@ export default (({
     }
 
     if (isNonEmptyArray(decisionsMeta)) {
-      mergeDecisionsMeta(event, decisionsMeta);
+      mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
     }
 
     event.mergeXdm(data);

package/libEs6/components/Personalization/createComponent.js

@@ -22,10 +22,18 @@ export default (({
   mergeQuery,
   viewCache,
   showContainers,
-  applyPropositions
+  applyPropositions,
+  setTargetMigration
 }) => {
   return {
     lifecycle: {
+      onBeforeRequest({
+        request
+      }) {
+        setTargetMigration(request);
+        return Promise.resolve();
+      },
+
       onBeforeEvent({
         event,
         renderDecisions,

package/libEs6/components/Personalization/createFetchDataHandler.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 (({
-  config,
+  prehidingStyle,
   responseHandler,
   hideContainers,
   mergeQuery
@@ -21,10 +21,6 @@ export default (({
     event,
     onResponse
   }) => {
-    const {
-      prehidingStyle
-    } = config;
-
     if (personalizationDetails.isRenderDecisions()) {
       hideContainers(prehidingStyle);
     }

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -11,6 +11,7 @@ governing permissions and limitations under the License.
 */
 import { isNonEmptyArray } from "../../utils";
 import { INTERACT } from "./constants/eventType";
+import { PropositionEventType } from "./constants/propositionEventType";
 import PAGE_WIDE_SCOPE from "./constants/scope";
 export default (({
   mergeDecisionsMeta,
@@ -43,7 +44,7 @@ export default (({
         }
 
         event.mergeXdm(xdm);
-        mergeDecisionsMeta(event, decisionsMeta);
+        mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.INTERACT);
       }
     }
   };

package/libEs6/components/Personalization/createSetTargetMigration.js

@@ -0,0 +1,27 @@
+/*
+Copyright 2022 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 { noop } from "../../utils";
+export default (({
+  targetMigrationEnabled
+}) => {
+  if (targetMigrationEnabled) {
+    return request => {
+      request.getPayload().mergeMeta({
+        target: {
+          migration: true
+        }
+      });
+    };
+  }
+
+  return noop;
+});

package/libEs6/components/Personalization/createViewChangeHandler.js

@@ -11,6 +11,7 @@ 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,
@@ -28,7 +29,7 @@ export default (({
         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);
+            mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
             onResponse(() => {
               return composePersonalizationResultingObject(viewDecisions, true);
             });

package/libEs6/components/Personalization/event.js

@@ -9,11 +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.
 */
-export const mergeDecisionsMeta = (event, decisionsMeta) => {
+const EVENT_TYPE_TRUE = 1;
+export const mergeDecisionsMeta = (event, decisionsMeta, eventType) => {
   event.mergeXdm({
     _experience: {
       decisioning: {
-        propositions: decisionsMeta
+        propositions: decisionsMeta,
+        propositionEventType: {
+          [eventType]: EVENT_TYPE_TRUE
+        }
       }
     }
   });

package/libEs6/components/Personalization/index.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 { string } from "../../utils/validation";
+import { string, boolean } from "../../utils/validation";
 import createComponent from "./createComponent";
 import { initDomActionsModules, executeActions } from "./dom-actions";
 import createCollect from "./createCollect";
@@ -29,12 +29,17 @@ import createRedirectHandler from "./createRedirectHandler";
 import createAutorenderingHandler from "./createAutoRenderingHandler";
 import createNonRenderingHandler from "./createNonRenderingHandler";
 import createApplyPropositions from "./createApplyPropositions";
+import createSetTargetMigration from "./createSetTargetMigration";
 
 const createPersonalization = ({
   config,
   logger,
   eventManager
 }) => {
+  const {
+    targetMigrationEnabled,
+    prehidingStyle
+  } = config;
   const collect = createCollect({
     eventManager,
     mergeDecisionsMeta
@@ -77,7 +82,7 @@ const createPersonalization = ({
     showContainers
   });
   const fetchDataHandler = createFetchDataHandler({
-    config,
+    prehidingStyle,
     responseHandler,
     hideContainers,
     mergeQuery
@@ -94,6 +99,9 @@ const createPersonalization = ({
     executeDecisions,
     viewCache
   });
+  const setTargetMigration = createSetTargetMigration({
+    targetMigrationEnabled
+  });
   return createComponent({
     logger,
     fetchDataHandler,
@@ -103,12 +111,14 @@ const createPersonalization = ({
     mergeQuery,
     viewCache,
     showContainers,
-    applyPropositions
+    applyPropositions,
+    setTargetMigration
   });
 };
 
 createPersonalization.namespace = "Personalization";
 createPersonalization.configValidators = {
-  prehidingStyle: string().nonEmpty()
+  prehidingStyle: string().nonEmpty(),
+  targetMigrationEnabled: boolean().default(false)
 };
 export default createPersonalization;

package/libEs6/constants/cookieNameKey.js

@@ -11,4 +11,5 @@ governing permissions and limitations under the License.
 */
 export const IDENTITY = "identity";
 export const CONSENT = "consent";
-export const CLUSTER = "cluster";
+export const CLUSTER = "cluster";
+export const MBOX = "mbox";

package/libEs6/constants/highEntropyUserAgentClientHints.js

@@ -0,0 +1,12 @@
+/*
+Copyright 2022 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 ["architecture", "bitness", "model", "platformVersion", "wow64"];

package/libEs6/constants/legacyCookies.js

@@ -0,0 +1,14 @@
+/*
+Copyright 2022 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 MBOX_EDGE_CLUSTER = "mboxEdgeCluster";
+export const AT_QA_MODE = "at_qa_mode";
+export const MBOX = "mbox";

package/libEs6/constants/libraryVersion.js

@@ -11,4 +11,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.12.0";
+export default "2.13.0-beta.0";

package/libEs6/core/createCookieTransfer.js

@@ -9,11 +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 { endsWith, isNamespacedCookieName } from "../utils";
+import { endsWith } from "../utils";
 const STATE_STORE_HANDLE_TYPE = "state:store";
 export default (({
   cookieJar,
-  orgId,
+  shouldTransferCookie,
   apexDomain,
   dateProvider
 }) => {
@@ -34,14 +34,7 @@ export default (({
 
       if (!isEndpointFirstParty) {
         const cookies = cookieJar.get();
-        const entries = Object.keys(cookies).filter(name => {
-          // We have a contract with the server that we will pass
-          // all cookies whose names are namespaced according to the
-          // logic in isNamespacedCookieName as well as any legacy
-          // cookie names (so that the server can handle migrating
-          // identities on websites previously using Visitor.js)
-          return isNamespacedCookieName(orgId, name);
-        }).map(qualifyingCookieName => {
+        const entries = Object.keys(cookies).filter(shouldTransferCookie).map(qualifyingCookieName => {
           return {
             key: qualifyingCookieName,
             value: cookies[qualifyingCookieName]

package/libEs6/core/createEventManager.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 { createCallbackAggregator } from "../utils";
+import { createCallbackAggregator, noop } from "../utils";
 const EVENT_CANCELLATION_MESSAGE = "Event was canceled because the onBeforeEventSend callback returned false.";
 export default (({
   config,
@@ -19,7 +19,8 @@ export default (({
   createEvent,
   createDataCollectionRequestPayload,
   createDataCollectionRequest,
-  sendEdgeNetworkRequest
+  sendEdgeNetworkRequest,
+  applyResponse
 }) => {
   const {
     onBeforeEventSend
@@ -36,6 +37,7 @@ export default (({
      * @param {Object} [options]
      * @param {boolean} [options.renderDecisions=false]
      * @param {Array} [options.decisionScopes]
+     * @param {Object} [options.serverState]
      * This will be passed to components
      * so they can take appropriate action.
      * @returns {*}
@@ -91,6 +93,34 @@ export default (({
           runOnRequestFailureCallbacks: onRequestFailureCallbackAggregator.call
         });
       });
+    },
+
+    applyResponse(event, options = {}) {
+      const {
+        renderDecisions = false,
+        responseHeaders = {},
+        responseBody = {
+          handle: []
+        }
+      } = options;
+      const payload = createDataCollectionRequestPayload();
+      const request = createDataCollectionRequest(payload);
+      const onResponseCallbackAggregator = createCallbackAggregator();
+      return lifecycle.onBeforeEvent({
+        event,
+        renderDecisions,
+        decisionScopes: [],
+        onResponse: onResponseCallbackAggregator.add,
+        onRequestFailure: noop
+      }).then(() => {
+        payload.addEvent(event);
+        return applyResponse({
+          request,
+          responseHeaders,
+          responseBody,
+          runOnResponseCallbacks: onResponseCallbackAggregator.call
+        });
+      });
     }
 
   };

package/libEs6/core/edgeNetwork/handleRequestFailure.js

@@ -0,0 +1,14 @@
+export default (onRequestFailureCallbackAggregator => {
+  return error => {
+    // Regardless of whether the network call failed, an unexpected status
+    // code was returned, or the response body was malformed, we want to call
+    // the onRequestFailure callbacks, but still throw the exception.
+    const throwError = () => {
+      throw error;
+    };
+
+    return onRequestFailureCallbackAggregator.call({
+      error
+    }).then(throwError, throwError);
+  };
+});

package/libEs6/core/edgeNetwork/injectApplyResponse.js

@@ -0,0 +1,48 @@
+import { createCallbackAggregator, noop } from "../../utils";
+import mergeLifecycleResponses from "./mergeLifecycleResponses";
+import handleRequestFailure from "./handleRequestFailure";
+const HTTP_STATUS_OK = 200;
+export default (({
+  cookieTransfer,
+  lifecycle,
+  createResponse,
+  processWarningsAndErrors
+}) => {
+  return ({
+    request,
+    responseHeaders,
+    responseBody,
+    runOnResponseCallbacks = noop,
+    runOnRequestFailureCallbacks = noop
+  }) => {
+    const onResponseCallbackAggregator = createCallbackAggregator();
+    onResponseCallbackAggregator.add(lifecycle.onResponse);
+    onResponseCallbackAggregator.add(runOnResponseCallbacks);
+    const onRequestFailureCallbackAggregator = createCallbackAggregator();
+    onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
+    onRequestFailureCallbackAggregator.add(runOnRequestFailureCallbacks);
+
+    const getHeader = key => responseHeaders[key];
+
+    return lifecycle.onBeforeRequest({
+      request,
+      onResponse: onResponseCallbackAggregator.add,
+      onRequestFailure: onRequestFailureCallbackAggregator.add
+    }).then(() => processWarningsAndErrors({
+      statusCode: HTTP_STATUS_OK,
+      getHeader,
+      body: JSON.stringify(responseBody),
+      parsedBody: responseBody
+    })).catch(handleRequestFailure(onRequestFailureCallbackAggregator)).then(() => {
+      const response = createResponse({
+        content: responseBody,
+        getHeader
+      }); // This will clobber any cookies set via HTTP from the server.  So care should be given to remove any state:store handles if that is not desirable
+
+      cookieTransfer.responseToCookies(response);
+      return onResponseCallbackAggregator.call({
+        response
+      }).then(mergeLifecycleResponses);
+    });
+  };
+});

package/libEs6/core/edgeNetwork/injectGetLocationHint.js

@@ -11,10 +11,26 @@ governing permissions and limitations under the License.
 */
 import { getNamespacedCookieName } from "../../utils";
 import { CLUSTER } from "../../constants/cookieNameKey";
+import { MBOX_EDGE_CLUSTER } from "../../constants/legacyCookies";
 export default (({
   orgId,
   cookieJar
 }) => {
   const clusterCookieName = getNamespacedCookieName(orgId, CLUSTER);
-  return () => cookieJar.get(clusterCookieName);
+
+  const fromClusterCookie = () => cookieJar.get(clusterCookieName);
+
+  const fromTarget = () => {
+    const mboxEdgeCluster = cookieJar.get(MBOX_EDGE_CLUSTER);
+
+    if (mboxEdgeCluster) {
+      return `t${mboxEdgeCluster}`;
+    }
+
+    return undefined;
+  };
+
+  return () => {
+    return fromClusterCookie() || fromTarget();
+  };
 });

package/libEs6/core/edgeNetwork/injectSendEdgeNetworkRequest.js

@@ -11,7 +11,9 @@ governing permissions and limitations under the License.
 */
 import { ID_THIRD_PARTY as ID_THIRD_PARTY_DOMAIN } from "../../constants/domain";
 import apiVersion from "../../constants/apiVersion";
-import { createCallbackAggregator, noop, assign } from "../../utils";
+import { createCallbackAggregator, noop } from "../../utils";
+import mergeLifecycleResponses from "./mergeLifecycleResponses";
+import handleRequestFailure from "./handleRequestFailure";
 export default (({
   config,
   lifecycle,
@@ -61,18 +63,7 @@ export default (({
     }).then(networkResponse => {
       processWarningsAndErrors(networkResponse);
       return networkResponse;
-    }).catch(error => {
-      // Regardless of whether the network call failed, an unexpected status
-      // code was returned, or the response body was malformed, we want to call
-      // the onRequestFailure callbacks, but still throw the exception.
-      const throwError = () => {
-        throw error;
-      };
-
-      return onRequestFailureCallbackAggregator.call({
-        error
-      }).then(throwError, throwError);
-    }).then(({
+    }).catch(handleRequestFailure(onRequestFailureCallbackAggregator)).then(({
       parsedBody,
       getHeader
     }) => {
@@ -89,14 +80,7 @@ export default (({
 
       return onResponseCallbackAggregator.call({
         response
-      }).then(returnValues => {
-        // Merges all returned objects from all `onResponse` callbacks into
-        // a single object that can later be returned to the customer.
-        const lifecycleOnResponseReturnValues = returnValues.shift() || [];
-        const consumerOnResponseReturnValues = returnValues.shift() || [];
-        const lifecycleOnBeforeRequestReturnValues = returnValues;
-        return assign({}, ...lifecycleOnResponseReturnValues, ...consumerOnResponseReturnValues, ...lifecycleOnBeforeRequestReturnValues);
-      });
+      }).then(mergeLifecycleResponses);
     });
   };
 });

package/libEs6/core/edgeNetwork/mergeLifecycleResponses.js

@@ -0,0 +1,9 @@
+import { assign } from "../../utils";
+export default (returnValues => {
+  // Merges all returned objects from all `onResponse` callbacks into
+  // a single object that can later be returned to the customer.
+  const lifecycleOnResponseReturnValues = returnValues.shift() || [];
+  const consumerOnResponseReturnValues = returnValues.shift() || [];
+  const lifecycleOnBeforeRequestReturnValues = returnValues;
+  return assign({}, ...lifecycleOnResponseReturnValues, ...consumerOnResponseReturnValues, ...lifecycleOnBeforeRequestReturnValues);
+});

package/libEs6/core/index.js

@@ -34,12 +34,14 @@ import injectSendBeaconRequest from "./network/requestMethods/injectSendBeaconRe
 import createLogger from "./createLogger";
 import createEventManager from "./createEventManager";
 import createCookieTransfer from "./createCookieTransfer";
+import injectShouldTransferCookie from "./injectShouldTransferCookie";
 import { createDataCollectionRequest, createDataCollectionRequestPayload } from "../utils/request";
 import injectSendEdgeNetworkRequest from "./edgeNetwork/injectSendEdgeNetworkRequest";
 import injectProcessWarningsAndErrors from "./edgeNetwork/injectProcessWarningsAndErrors";
 import injectGetLocationHint from "./edgeNetwork/injectGetLocationHint";
 import isRequestRetryable from "./network/isRequestRetryable";
 import getRequestRetryDelay from "./network/getRequestRetryDelay";
+import injectApplyResponse from "./edgeNetwork/injectApplyResponse";
 const createNamespacedStorage = injectStorage(window);
 const {
   console,
@@ -91,11 +93,16 @@ export const createExecuteCommand = ({
       setDebugEnabled
     });
     const {
-      orgId
+      orgId,
+      targetMigrationEnabled
     } = config;
+    const shouldTransferCookie = injectShouldTransferCookie({
+      orgId,
+      targetMigrationEnabled
+    });
     const cookieTransfer = createCookieTransfer({
       cookieJar: loggingCookieJar,
-      orgId,
+      shouldTransferCookie,
       apexDomain,
       dateProvider: () => new Date()
     });
@@ -135,6 +142,12 @@ export const createExecuteCommand = ({
       processWarningsAndErrors,
       getLocationHint
     });
+    const applyResponse = injectApplyResponse({
+      lifecycle,
+      cookieTransfer,
+      createResponse,
+      processWarningsAndErrors
+    });
     const generalConsentState = createConsentStateMachine({
       logger
     });
@@ -150,7 +163,8 @@ export const createExecuteCommand = ({
       createEvent,
       createDataCollectionRequestPayload,
       createDataCollectionRequest,
-      sendEdgeNetworkRequest
+      sendEdgeNetworkRequest,
+      applyResponse
     });
     return initializeComponents({
       componentCreators,