@adobe/alloy 2.18.0 → 2.19.0-beta.1

package/libEs6/components/Context/injectDevice.js

@@ -9,46 +9,37 @@ 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 { deepAssign, isFunction, toInteger } from "../../utils";
 
+import { deepAssign, isFunction, toInteger } from "../../utils";
 const getScreenOrientationViaProperty = window => {
   const {
     screen: {
       orientation
     }
   } = window;
-
   if (orientation == null || orientation.type == null) {
     return null;
   }
-
   const parts = orientation.type.split("-");
-
   if (parts.length === 0) {
     return null;
   }
-
   if (parts[0] !== "portrait" && parts[0] !== "landscape") {
     return null;
   }
-
   return parts[0];
 };
-
 const getScreenOrientationViaMediaQuery = window => {
   if (isFunction(window.matchMedia)) {
     if (window.matchMedia("(orientation: portrait)").matches) {
       return "portrait";
     }
-
     if (window.matchMedia("(orientation: landscape)").matches) {
       return "landscape";
     }
   }
-
   return null;
 };
-
 export default (window => {
   return xdm => {
     const {
@@ -59,23 +50,17 @@ export default (window => {
     } = window;
     const device = {};
     const screenHeight = toInteger(height);
-
     if (screenHeight >= 0) {
       device.screenHeight = screenHeight;
     }
-
     const screenWidth = toInteger(width);
-
     if (screenWidth >= 0) {
       device.screenWidth = screenWidth;
     }
-
     const orientation = getScreenOrientationViaProperty(window) || getScreenOrientationViaMediaQuery(window);
-
     if (orientation) {
       device.screenOrientation = orientation;
     }
-
     if (Object.keys(device).length > 0) {
       deepAssign(xdm, {
         device

package/libEs6/components/Context/injectEnvironment.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 { deepAssign, toInteger } from "../../utils";
 export default (window => {
   return xdm => {
@@ -24,20 +25,16 @@ export default (window => {
       type: "browser"
     };
     const viewportWidth = toInteger(clientWidth);
-
     if (viewportWidth >= 0) {
       environment.browserDetails = {
         viewportWidth
       };
     }
-
     const viewportHeight = toInteger(clientHeight);
-
     if (viewportHeight >= 0) {
       environment.browserDetails = environment.browserDetails || {};
       environment.browserDetails.viewportHeight = viewportHeight;
     }
-
     deepAssign(xdm, {
       environment
     });

package/libEs6/components/Context/injectHighEntropyUserAgentHints.js

@@ -9,25 +9,22 @@ 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 { deepAssign, noop } from "../../utils";
 import highEntropyUserAgentHints from "../../constants/highEntropyUserAgentClientHints";
-
 const browserSupportsUserAgentClientHints = navigator => {
   return typeof navigator.userAgentData !== "undefined";
 };
-
 export default (navigator => {
   if (!browserSupportsUserAgentClientHints(navigator)) {
     return noop;
   }
-
   return (xdm, logger) => {
     try {
       return navigator.userAgentData.getHighEntropyValues(highEntropyUserAgentHints.map(hint => hint[0])).then(hints => {
         const userAgentClientHints = {};
         highEntropyUserAgentHints.forEach(([hintName, hintType]) => {
-          if (Object.prototype.hasOwnProperty.call(hints, hintName) &&
-          /* eslint-disable-next-line valid-typeof */
+          if (Object.prototype.hasOwnProperty.call(hints, hintName) && /* eslint-disable-next-line valid-typeof */
           typeof hints[hintName] === hintType) {
             userAgentClientHints[hintName] = hints[hintName];
           }

package/libEs6/components/Context/injectPlaceContext.js

@@ -15,16 +15,13 @@ export default (dateProvider => {
     const date = dateProvider();
     const placeContext = {};
     const localTimezoneOffset = toInteger(date.getTimezoneOffset());
-
     if (localTimezoneOffset !== undefined) {
       placeContext.localTimezoneOffset = localTimezoneOffset;
-    } // make sure the timezone offset only uses two digits
-
-
+    }
+    // make sure the timezone offset only uses two digits
     if (localTimezoneOffset === undefined || Math.abs(localTimezoneOffset) < 6000) {
       placeContext.localTime = toISOStringLocal(date);
     }
-
     deepAssign(xdm, {
       placeContext
     });

package/libEs6/components/Context/injectTimestamp.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 { deepAssign } from "../../utils";
 export default (dateProvider => {
   return xdm => {

package/libEs6/components/Context/injectWeb.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 { deepAssign } from "../../utils";
 export default (window => {
   return xdm => {

package/libEs6/components/DataCollector/index.js

@@ -9,10 +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.
 */
+
 import validateUserEventOptions from "./validateUserEventOptions";
 import validateApplyResponse from "./validateApplyResponse";
 import { deepAssign } from "../../utils";
-
 const createDataCollector = ({
   eventManager,
   logger
@@ -41,36 +41,29 @@ const createDataCollector = ({
             edgeConfigOverrides
           } = options;
           const event = eventManager.createEvent();
-
           if (documentUnloading) {
             event.documentMayUnload();
           }
-
           event.setUserXdm(xdm);
           event.setUserData(data);
-
           if (type) {
             event.mergeXdm({
               eventType: type
             });
           }
-
           if (mergeId) {
             event.mergeXdm({
               eventMergeId: mergeId
             });
           }
-
           const sendEventOptions = {
             renderDecisions,
             decisionScopes,
             personalization
           };
-
           if (edgeConfigOverrides) {
             sendEventOptions.edgeConfigOverrides = edgeConfigOverrides;
           }
-
           if (datasetId) {
             logger.warn("The 'datasetId' option has been deprecated. Please use 'edgeConfigOverrides.com_adobe_experience_platform.datasets.event.datasetId' instead.");
             sendEventOptions.edgeConfigOverrides = edgeConfigOverrides || {};
@@ -84,7 +77,6 @@ const createDataCollector = ({
               }
             });
           }
-
           return eventManager.sendEvent(event, sendEventOptions);
         }
       },
@@ -101,19 +93,20 @@ const createDataCollector = ({
             responseHeaders = {},
             responseBody = {
               handle: []
-            }
+            },
+            personalization
           } = options;
           const event = eventManager.createEvent();
           return eventManager.applyResponse(event, {
             renderDecisions,
             responseHeaders,
-            responseBody
+            responseBody,
+            personalization
           });
         }
       }
     }
   };
 };
-
 createDataCollector.namespace = "DataCollector";
 export default createDataCollector;

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

@@ -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 { string, objectOf, boolean, arrayOf } from "../../utils/validation";
 import { validateConfigOverride, validateIdentityMap } from "../../utils";
 /**
@@ -16,7 +17,6 @@ import { validateConfigOverride, validateIdentityMap } from "../../utils";
  * @param {*} options The user event options to validate
  * @returns {*} Validated options
  */
-
 export default (({
   options
 }) => {
@@ -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/EventMerge/createComponent.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 (({
   createEventMergeId
 }) => {

package/libEs6/components/EventMerge/createEventMergeId.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 { uuid } from "../../utils";
 export default (() => {
   return {

package/libEs6/components/EventMerge/index.js

@@ -9,14 +9,13 @@ 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 createEventMergeId from "./createEventMergeId";
 import createComponent from "./createComponent";
-
 const createEventMerge = () => {
   return createComponent({
     createEventMergeId
   });
 };
-
 createEventMerge.namespace = "EventMerge";
 export default createEventMerge;

package/libEs6/components/Identity/addEcidQueryToPayload.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 ecidNamespace from "../../constants/ecidNamespace";
 export default (payload => {
   payload.mergeQuery({

package/libEs6/components/Identity/addEcidToPayload.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 ecidNamespace from "../../constants/ecidNamespace";
 export default ((payload, ecid) => {
   payload.addIdentity(ecidNamespace, {

package/libEs6/components/Identity/appendIdentityToUrl/appendIdentityToUrlOptionsValidator.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 { validateConfigOverride } from "../../../utils";
 import { objectOf, string } from "../../../utils/validation";
 /**
@@ -16,7 +17,6 @@ import { objectOf, string } from "../../../utils/validation";
  * @param {*} options The user event options to validate
  * @returns {*} Validated options
  */
-
 export default objectOf({
   url: string().required().nonEmpty(),
   edgeConfigOverrides: validateConfigOverride

package/libEs6/components/Identity/appendIdentityToUrl/injectAppendIdentityToUrl.js

@@ -10,19 +10,15 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 const URL_REGEX = /^([^?#]*)(\??[^#]*)(#?.*)$/;
-
 const getSeparator = queryString => {
   if (queryString === "") {
     return "?";
   }
-
   if (queryString === "?") {
     return "";
   }
-
   return "&";
 };
-
 export default (({
   dateProvider,
   orgId

package/libEs6/components/Identity/configValidators.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 { boolean, objectOf } from "../../utils/validation";
 const configValidators = objectOf({
   thirdPartyCookiesEnabled: boolean().default(true),

package/libEs6/components/Identity/constants/authState.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 const AMBIGUOUS = "ambiguous";
 export const AUTHENTICATED = "authenticated";
 export const LOGGED_OUT = "loggedOut";

package/libEs6/components/Identity/constants/defaultIdSyncTtlMinutes.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 default 10080; // 7 days

package/libEs6/components/Identity/createComponent.js

@@ -43,25 +43,23 @@ export default (({
           onRequestFailure
         });
       },
-
       onResponse({
         response
       }) {
         if (!ecid) {
-          ecid = getEcidFromResponse(response); // Only data collection calls will have an ECID in the response.
-          // https://jira.corp.adobe.com/browse/EXEG-1234
+          ecid = getEcidFromResponse(response);
 
+          // Only data collection calls will have an ECID in the response.
+          // https://jira.corp.adobe.com/browse/EXEG-1234
           if (ecid) {
             setLegacyEcid(ecid);
           }
-        } // For sendBeacon requests, getEdge() will return {}, so we are using assign here
+        }
+        // For sendBeacon requests, getEdge() will return {}, so we are using assign here
         // so that sendBeacon requests don't override the edge info from before.
-
-
         edge = assign(edge, response.getEdge());
         return handleResponseForIdSyncs(response);
       }
-
     },
     commands: {
       getIdentity: {

package/libEs6/components/Identity/createLegacyIdentity.js

@@ -25,40 +25,31 @@ export default (({
     orgId
   } = config;
   const amcvCookieName = `AMCV_${orgId}`;
-
   const getEcidFromLegacyCookies = () => {
     let ecid = null;
     const secidCookieName = "s_ecid";
     const legacyEcidCookieValue = cookieJar.get(secidCookieName) || cookieJar.get(amcvCookieName);
-
     if (legacyEcidCookieValue) {
       const reg = /(^|\|)MCMID\|(\d+)($|\|)/;
       const matches = legacyEcidCookieValue.match(reg);
-
       if (matches) {
         // Destructuring arrays breaks in IE
         ecid = matches[2];
       }
     }
-
     return ecid;
   };
-
   return {
     getEcid() {
       if (idMigrationEnabled) {
         const ecid = getEcidFromLegacyCookies();
-
         if (ecid) {
           return Promise.resolve(ecid);
         }
-
         return getEcidFromVisitor();
       }
-
       return Promise.resolve();
     },
-
     setEcid(ecid) {
       if (idMigrationEnabled && getEcidFromLegacyCookies() !== ecid) {
         const extraOptions = isPageSsl ? {
@@ -74,6 +65,5 @@ export default (({
         });
       }
     }
-
   };
 });

package/libEs6/components/Identity/getEcidFromResponse.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 { find } from "../../utils";
 import ecidNamespace from "../../constants/ecidNamespace";
 export default (response => {

package/libEs6/components/Identity/getIdentity/createGetIdentity.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 { createRequestParams } from "../../../utils/request";
 export default (({
   sendEdgeNetworkRequest,

package/libEs6/components/Identity/getIdentity/createIdentityRequest.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 { createRequest } from "../../../utils/request";
 export default (({
   payload,
@@ -17,14 +18,11 @@ export default (({
   return createRequest({
     payload,
     datastreamIdOverride,
-
     getAction() {
       return "identity/acquire";
     },
-
     getUseSendBeacon() {
       return false;
     }
-
   });
 });

package/libEs6/components/Identity/getIdentity/createIdentityRequestPayload.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 { createAddIdentity, createHasIdentity, createRequestPayload } from "../../../utils/request";
 export default (namespaces => {
   const content = {

package/libEs6/components/Identity/getIdentity/getIdentityOptionsValidator.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 { validateConfigOverride } from "../../../utils";
 import { objectOf, literal, arrayOf } from "../../../utils/validation";
 /**
@@ -16,7 +17,6 @@ import { objectOf, literal, arrayOf } from "../../../utils/validation";
  * @param {*} options The user event options to validate
  * @returns {*} Validated options
  */
-
 export default objectOf({
   namespaces: arrayOf(literal("ECID")).nonEmpty().uniqueItems().default(["ECID"]),
   edgeConfigOverrides: validateConfigOverride

package/libEs6/components/Identity/index.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 { areThirdPartyCookiesSupportedByDefault, injectDoesIdentityCookieExist, createLoggingCookieJar, cookieJar } from "../../utils";
 import injectProcessIdSyncs from "./injectProcessIdSyncs";
 import configValidators from "./configValidators";
@@ -29,7 +30,6 @@ import createGetIdentity from "./getIdentity/createGetIdentity";
 import createIdentityRequest from "./getIdentity/createIdentityRequest";
 import createIdentityRequestPayload from "./getIdentity/createIdentityRequestPayload";
 import injectAppendIdentityToUrl from "./appendIdentityToUrl/injectAppendIdentityToUrl";
-
 const createIdentity = ({
   config,
   logger,
@@ -119,7 +119,6 @@ const createIdentity = ({
     config
   });
 };
-
 createIdentity.namespace = "Identity";
 createIdentity.configValidators = configValidators;
 export default createIdentity;

package/libEs6/components/Identity/injectAddLegacyEcidToPayload.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 ecidNamespace from "../../constants/ecidNamespace";
 export default (({
   getLegacyEcid,
@@ -20,7 +21,6 @@ export default (({
       // the user specified it in the identity map
       return Promise.resolve();
     }
-
     return getLegacyEcid().then(ecidToMigrate => {
       if (ecidToMigrate) {
         addEcidToPayload(payload, ecidToMigrate);

package/libEs6/components/Identity/injectAddQueryStringIdentityToPayload.js

@@ -11,6 +11,7 @@ governing permissions and limitations under the License.
 */
 // Example: adobe_mc=TS%3D1641432103%7CMCMID%3D77094828402023918047117570965393734545%7CMCORGID%3DFAF554945B90342F0A495E2C%40AdobeOrg
 // Decoded: adobe_mc=TS=1641432103|MCMID=77094828402023918047117570965393734545|MCORGID=FAF554945B90342F0A495E2C@AdobeOrg
+
 import { queryString } from "../../utils";
 import queryStringIdentityParam from "../../constants/queryStringIdentityParam";
 import ecidNamespace from "../../constants/ecidNamespace";
@@ -26,25 +27,22 @@ export default (({
     // don't overwrite a user provided ecid identity
     return;
   }
-
   const parsedQueryString = queryString.parse(locationSearch);
   const queryStringValue = parsedQueryString[queryStringIdentityParam];
-
   if (queryStringValue === undefined) {
     return;
   }
-
   const properties = queryStringValue.split("|").reduce((memo, keyValue) => {
     const [key, value] = keyValue.split("=");
     memo[key] = value;
     return memo;
-  }, {}); // We are using MCMID and MCORGID to be compatible with Visitor.
-
+  }, {});
+  // We are using MCMID and MCORGID to be compatible with Visitor.
   const ts = parseInt(properties.TS, 10);
   const mcmid = properties.MCMID;
   const mcorgid = decodeURIComponent(properties.MCORGID);
-
-  if ( // When TS is not specified or not a number, the following inequality returns false.
+  if (
+  // When TS is not specified or not a number, the following inequality returns false.
   // All inequalities with NaN variables are false.
   dateProvider().getTime() / 1000 <= ts + LINK_TTL_SECONDS && mcorgid === orgId && mcmid) {
     logger.info(`Found valid ECID identity ${mcmid} from the adobe_mc query string parameter.`);

package/libEs6/components/Identity/injectAwaitIdentityCookie.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 (({
   doesIdentityCookieExist,
   orgId
@@ -29,13 +30,15 @@ export default (({
         } else {
           // This logic assumes that the code setting the cookie is working as expected and that
           // the cookie was missing from the response.
-          const noIdentityCookieError = new Error(`An identity was not set properly. Please verify that the org ID ${orgId} configured in Alloy matches the org ID specified in the edge configuration.`); // Rejecting the promise will reject commands that were queued
+          const noIdentityCookieError = new Error(`An identity was not set properly. Please verify that the org ID ${orgId} configured in Alloy matches the org ID specified in the edge configuration.`);
+
+          // Rejecting the promise will reject commands that were queued
           // by the Identity component while waiting on the response to
           // the initial request.
+          reject(noIdentityCookieError);
 
-          reject(noIdentityCookieError); // Throwing an error will reject the event command that initiated
+          // Throwing an error will reject the event command that initiated
           // the request.
-
           throw noIdentityCookieError;
         }
       });