@adobe/alloy 2.14.0-alpha.2 → 2.14.0-alpha.20

package/libEs6/components/Identity/index.js

@@ -40,7 +40,8 @@ const createIdentity = ({
 }) => {
   const {
     orgId,
-    thirdPartyCookiesEnabled
+    thirdPartyCookiesEnabled,
+    edgeConfigOverrides: globalConfigOverrides
   } = config;
   const getEcidFromVisitor = injectGetEcidFromVisitor({
     logger,
@@ -64,7 +65,8 @@ const createIdentity = ({
   const getIdentity = createGetIdentity({
     sendEdgeNetworkRequest,
     createIdentityRequestPayload,
-    createIdentityRequest
+    createIdentityRequest,
+    globalConfigOverrides
   });
   const setDomainForInitialIdentityPayload = injectSetDomainForInitialIdentityPayload({
     thirdPartyCookiesEnabled,
@@ -100,7 +102,8 @@ const createIdentity = ({
   });
   const appendIdentityToUrl = injectAppendIdentityToUrl({
     dateProvider: () => new Date(),
-    orgId
+    orgId,
+    globalConfigOverrides
   });
   return createComponent({
     addEcidQueryToPayload,
@@ -112,7 +115,8 @@ const createIdentity = ({
     getIdentity,
     consent,
     appendIdentityToUrl,
-    logger
+    logger,
+    config
   });
 };
 

package/libEs6/components/Identity/visitorService/injectGetEcidFromVisitor.js

@@ -15,8 +15,9 @@ export default (({
   orgId,
   awaitVisitorOptIn
 }) => {
-  const Visitor = getVisitor(window);
   return () => {
+    const Visitor = getVisitor(window);
+
     if (Visitor) {
       // Need to explicitly wait for optIn because visitor will call callback
       // with invalid values prior to optIn being approved

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

@@ -9,7 +9,9 @@ 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 preprocess from "./remapHeadOffers";
+import remapHeadOffers from "./remapHeadOffers";
+import { assign } from "../../../utils";
+import remapCustomCodeOffers from "./remapCustomCodeOffers";
 
 const logActionError = (logger, action, error) => {
   if (logger.enabled) {
@@ -42,6 +44,10 @@ const executeAction = (logger, modules, type, args) => {
   return execute(...args);
 };
 
+const PREPROCESSORS = [remapHeadOffers, remapCustomCodeOffers];
+
+const preprocess = action => PREPROCESSORS.reduce((processed, fn) => assign(processed, fn(processed)), action);
+
 export default ((actions, modules, logger) => {
   const actionPromises = actions.map(action => {
     const processedAction = preprocess(action);

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

@@ -0,0 +1,37 @@
+/*
+Copyright 2021 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.
+*/
+
+/*
+ * Preprocess customCode actions before rendering, so that offer selectors are remapped appropriately for
+ * target offers, to align with the way it works in at.js.
+ */
+import { assign } from "../../../utils";
+const ACTION_CUSTOM_CODE = "customCode";
+const TARGET_BODY_SELECTOR = "BODY > *:eq(0)";
+export default (action => {
+  const {
+    selector,
+    type
+  } = action;
+
+  if (type !== ACTION_CUSTOM_CODE) {
+    return action;
+  }
+
+  if (selector !== TARGET_BODY_SELECTOR) {
+    return action;
+  }
+
+  return assign({}, action, {
+    selector: "BODY"
+  });
+});

package/libEs6/components/Privacy/createComponent.js

@@ -57,7 +57,8 @@ export default (({
         optionsValidator: validateSetConsentOptions,
         run: ({
           consent: consentOptions,
-          identityMap
+          identityMap,
+          edgeConfigOverrides
         }) => {
           consent.suspend();
           const consentHashes = consentHashStore.lookup(consentOptions);
@@ -65,7 +66,8 @@ export default (({
             if (consentHashes.isNew()) {
               return sendSetConsentRequest({
                 consentOptions,
-                identityMap
+                identityMap,
+                edgeConfigOverrides
               });
             }
 

package/libEs6/components/Privacy/index.js

@@ -38,7 +38,8 @@ const createPrivacy = ({
   const sendSetConsentRequest = injectSendSetConsentRequest({
     createConsentRequestPayload,
     createConsentRequest,
-    sendEdgeNetworkRequest
+    sendEdgeNetworkRequest,
+    edgeConfigOverrides: config.edgeConfigOverrides
   });
   const storage = createNamespacedStorage(`${sanitizeOrgIdForCookieName(orgId)}.consentHashes.`);
   const consentHashStore = createConsentHashStore({

package/libEs6/components/Privacy/injectSendSetConsentRequest.js

@@ -13,13 +13,17 @@ import { isObject } from "../../utils";
 export default (({
   createConsentRequestPayload,
   createConsentRequest,
-  sendEdgeNetworkRequest
+  sendEdgeNetworkRequest,
+  edgeConfigOverrides: globalConfigOverrides
 }) => ({
   consentOptions,
-  identityMap
+  identityMap,
+  edgeConfigOverrides: localConfigOverrides
 }) => {
   const payload = createConsentRequestPayload();
   payload.setConsent(consentOptions);
+  payload.mergeConfigOverride(globalConfigOverrides);
+  payload.mergeConfigOverride(localConfigOverrides);
 
   if (isObject(identityMap)) {
     Object.keys(identityMap).forEach(key => {

package/libEs6/components/Privacy/validateSetConsentOptions.js

@@ -1,6 +1,7 @@
 import { objectOf, anything, arrayOf } from "../../utils/validation";
-import { validateIdentityMap } from "../../utils";
+import { validateIdentityMap, validateConfigOverride } from "../../utils";
 export default objectOf({
   consent: arrayOf(anything()).required().nonEmpty(),
-  identityMap: validateIdentityMap
+  identityMap: validateIdentityMap,
+  edgeConfigOverrides: validateConfigOverride
 }).noUnknownFields().required();

package/libEs6/constants/highEntropyUserAgentClientHints.js

@@ -9,4 +9,4 @@ 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 ["architecture", "bitness", "model", "platformVersion", "wow64"];
+export default [["architecture", "string"], ["bitness", "string"], ["model", "string"], ["platformVersion", "string"], ["wow64", "boolean"]];

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.14.0-alpha.2";
+export default "2.14.0-alpha.20";

package/libEs6/core/config/createCoreConfigs.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, string, callback, enumOf } from "../../utils/validation";
-import { noop } from "../../utils";
+import { noop, validateConfigOverride } from "../../utils";
 import { EDGE as EDGE_DOMAIN } from "../../constants/domain";
 import EDGE_BASE_PATH from "../../constants/edgeBasePath";
 import { IN, OUT, PENDING } from "../../constants/consentStatus";
@@ -21,5 +21,6 @@ export default (() => ({
   edgeDomain: string().domain().default(EDGE_DOMAIN),
   edgeBasePath: string().nonEmpty().default(EDGE_BASE_PATH),
   orgId: string().unique().required(),
-  onBeforeEventSend: callback().default(noop)
+  onBeforeEventSend: callback().default(noop),
+  edgeConfigOverrides: validateConfigOverride
 }));

package/libEs6/core/createEventManager.js

@@ -24,7 +24,8 @@ export default (({
   applyResponse
 }) => {
   const {
-    onBeforeEventSend
+    onBeforeEventSend,
+    edgeConfigOverrides: globalConfigOverrides
   } = config;
   return {
     createEvent,
@@ -49,12 +50,15 @@ export default (({
       const {
         renderDecisions = false,
         decisionScopes,
+        edgeConfigOverrides: localConfigOverrides,
         personalization
       } = options;
       const payload = createDataCollectionRequestPayload();
       const request = createDataCollectionRequest(payload);
       const onResponseCallbackAggregator = createCallbackAggregator();
       const onRequestFailureCallbackAggregator = createCallbackAggregator();
+      payload.mergeConfigOverride(globalConfigOverrides);
+      payload.mergeConfigOverride(localConfigOverrides);
       return lifecycle.onBeforeEvent({
         event,
         renderDecisions,

package/libEs6/core/edgeNetwork/injectSendEdgeNetworkRequest.js

@@ -21,7 +21,8 @@ export default (({
   sendNetworkRequest,
   createResponse,
   processWarningsAndErrors,
-  getLocationHint
+  getLocationHint,
+  getAssuranceValidationTokenParams
 }) => {
   const {
     edgeDomain,
@@ -52,7 +53,7 @@ export default (({
       const endpointDomain = request.getUseIdThirdPartyDomain() ? ID_THIRD_PARTY_DOMAIN : edgeDomain;
       const locationHint = getLocationHint();
       const edgeBasePathWithLocationHint = locationHint ? `${edgeBasePath}/${locationHint}` : edgeBasePath;
-      const url = `https://${endpointDomain}/${edgeBasePathWithLocationHint}/${apiVersion}/${request.getAction()}?configId=${edgeConfigId}&requestId=${request.getId()}`;
+      const url = `https://${endpointDomain}/${edgeBasePathWithLocationHint}/${apiVersion}/${request.getAction()}?configId=${edgeConfigId}&requestId=${request.getId()}${getAssuranceValidationTokenParams()}`;
       cookieTransfer.cookiesToPayload(request.getPayload(), endpointDomain);
       return sendNetworkRequest({
         requestId: request.getId(),

package/libEs6/core/index.js

@@ -35,7 +35,7 @@ import createLogger from "./createLogger";
 import createEventManager from "./createEventManager";
 import createCookieTransfer from "./createCookieTransfer";
 import injectShouldTransferCookie from "./injectShouldTransferCookie";
-import { createDataCollectionRequest, createDataCollectionRequestPayload } from "../utils/request";
+import { createDataCollectionRequest, createDataCollectionRequestPayload, createGetAssuranceValidationTokenParams } from "../utils/request";
 import injectSendEdgeNetworkRequest from "./edgeNetwork/injectSendEdgeNetworkRequest";
 import injectProcessWarningsAndErrors from "./edgeNetwork/injectProcessWarningsAndErrors";
 import injectGetLocationHint from "./edgeNetwork/injectGetLocationHint";
@@ -61,6 +61,10 @@ const sendFetchRequest = isFunction(fetch) ? injectSendFetchRequest({
   XMLHttpRequest
 });
 const fireReferrerHideableImage = injectFireReferrerHideableImage();
+const getAssuranceValidationTokenParams = createGetAssuranceValidationTokenParams({
+  window,
+  createNamespacedStorage
+});
 export const createExecuteCommand = ({
   instanceName,
   logController: {
@@ -140,7 +144,8 @@ export const createExecuteCommand = ({
       sendNetworkRequest,
       createResponse,
       processWarningsAndErrors,
-      getLocationHint
+      getLocationHint,
+      getAssuranceValidationTokenParams
     });
     const applyResponse = injectApplyResponse({
       lifecycle,

package/libEs6/core/network/requestMethods/injectSendFetchRequest.js

@@ -21,7 +21,7 @@ export default (({
       headers: {
         "Content-Type": "text/plain; charset=UTF-8"
       },
-      referrer: "client",
+      referrerPolicy: "no-referrer-when-downgrade",
       body
     }).then(response => {
       return response.text().then(responseBody => ({

package/libEs6/utils/filterObject.js

@@ -0,0 +1,59 @@
+/*
+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 isEmptyObject from "./isEmptyObject";
+import isNil from "./isNil";
+import isObject from "./isObject";
+/**
+ * Given an object and a function that takes a value and returns a predicate, filter out
+ * all non-object deeply nested values that do not pass the predicate.
+ *
+ * Example: filterObject({ a: 2, b: { c: 6 } }, (val) => val > 5) returns { b { c: 6 } }
+ *
+ * @param {*} obj
+ * @param {* => boolean} predicate a function that takes a value and return a boolean,
+ * representing if it should be included in the result object or not.
+ * @returns A copy of the original object with the values that fail the predicate, filtered out.
+ */
+
+const filterObject = (obj, predicate) => {
+  if (isNil(obj) || !isObject(obj)) {
+    return obj;
+  }
+
+  return Object.keys(obj).reduce((result, key) => {
+    const value = obj[key];
+
+    if (isObject(value)) {
+      // value is object, go deeper
+      const filteredValue = filterObject(value, predicate);
+
+      if (isEmptyObject(filteredValue)) {
+        return result;
+      }
+
+      return { ...result,
+        [key]: filteredValue
+      };
+    } // value is not an object, test predicate
+
+
+    if (predicate(value)) {
+      return { ...result,
+        [key]: value
+      };
+    }
+
+    return result;
+  }, {});
+};
+
+export default filterObject;

package/libEs6/utils/index.js

@@ -26,6 +26,7 @@ export { default as endsWith } from "./endsWith";
 export { default as find } from "./find";
 export { default as fireImage } from "./fireImage";
 export { default as injectFireReferrerHideableImage } from "./injectFireReferrerHideableImage";
+export { default as filterObject } from "./filterObject";
 export { default as flatMap } from "./flatMap";
 export { default as getApexDomain } from "./getApexDomain";
 export { default as getLastArrayItems } from "./getLastArrayItems";
@@ -49,6 +50,7 @@ export { default as isString } from "./isString";
 export { default as memoize } from "./memoize";
 export { default as noop } from "./noop";
 export { default as padStart } from "./padStart";
+export { default as prepareConfigOverridesForEdge } from "./prepareConfigOverridesForEdge";
 export { default as queryString } from "./querystring";
 export { default as sanitizeOrgIdForCookieName } from "./sanitizeOrgIdForCookieName";
 export { default as stackError } from "./stackError";
@@ -61,4 +63,5 @@ export { default as toISOStringLocal } from "./toISOStringLocal";
 export { default as uuid } from "./uuid";
 export { default as updateErrorMessage } from "./updateErrorMessage";
 export { default as validateIdentityMap } from "./validateIdentityMap";
+export { default as validateConfigOverride } from "./validateConfigOverride";
 export { default as values } from "./values";

package/libEs6/utils/prepareConfigOverridesForEdge.js

@@ -0,0 +1,57 @@
+/*
+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 isNil from "./isNil";
+import filterObject from "./filterObject";
+import isEmptyObject from "./isEmptyObject";
+import isNonEmptyArray from "./isNonEmptyArray";
+import isNonEmptyString from "./isNonEmptyString";
+import isNumber from "./isNumber";
+import isBoolean from "./isBoolean"; // We want to avoid mapping between specific keys because we want Konductor
+// to be able to add overrides in the future without us needing to make
+// any changes to the Web SDK
+
+export default (configuration => {
+  if (isNil(configuration) || typeof configuration !== "object") {
+    return null;
+  } // remove entries that are empty strings or arrays
+
+
+  const configOverrides = filterObject(configuration, value => {
+    if (isNil(value)) {
+      return false;
+    }
+
+    if (isBoolean(value)) {
+      return true;
+    }
+
+    if (isNumber(value)) {
+      return true;
+    }
+
+    if (isNonEmptyString(value)) {
+      return true;
+    }
+
+    if (isNonEmptyArray(value)) {
+      return true;
+    }
+
+    return false;
+  });
+
+  if (isEmptyObject(configOverrides)) {
+    return null;
+  }
+
+  return configOverrides;
+});

package/libEs6/utils/request/createGetAssuranceValidationTokenParams.js

@@ -0,0 +1,47 @@
+/*
+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 { uuid, queryString } from "../index";
+const ASSURANCE_VALIDATION_SESSION_URL_PARAM = "adb_validation_sessionid";
+const ASSURANCE_VALIDATION_NAMESPACE = "validation.";
+const CLIENT_ID = "clientId";
+
+const getOrCreateAssuranceClientId = storage => {
+  let clientId = storage.persistent.getItem(CLIENT_ID);
+
+  if (!clientId) {
+    clientId = uuid();
+    storage.persistent.setItem(CLIENT_ID, clientId);
+  }
+
+  return clientId;
+};
+
+export default (({
+  window,
+  createNamespacedStorage
+}) => {
+  const storage = createNamespacedStorage(ASSURANCE_VALIDATION_NAMESPACE);
+  return () => {
+    const parsedQuery = queryString.parse(window.location.search);
+    const validationSessionId = parsedQuery[ASSURANCE_VALIDATION_SESSION_URL_PARAM];
+
+    if (!validationSessionId) {
+      return "";
+    }
+
+    const clientId = getOrCreateAssuranceClientId(storage);
+    const validationToken = `${validationSessionId}|${clientId}`;
+    return `&${queryString.stringify({
+      adobeAepValidationToken: validationToken
+    })}`;
+  };
+});

package/libEs6/utils/request/createRequestPayload.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 { createMerger } from ".."; // This provides the base functionality that all types of
+import { createMerger, prepareConfigOverridesForEdge } from ".."; // This provides the base functionality that all types of
 // request payloads share.
 
 export default (options => {
@@ -18,10 +18,12 @@ export default (options => {
     addIdentity,
     hasIdentity
   } = options;
+  const mergeConfigOverride = createMerger(content, "meta.configOverrides");
   return {
     mergeMeta: createMerger(content, "meta"),
     mergeState: createMerger(content, "meta.state"),
     mergeQuery: createMerger(content, "query"),
+    mergeConfigOverride: updates => mergeConfigOverride(prepareConfigOverridesForEdge(updates)),
     addIdentity,
     hasIdentity,
 

package/libEs6/utils/request/index.js

@@ -14,4 +14,5 @@ export { default as createDataCollectionRequest } from "./createDataCollectionRe
 export { default as createDataCollectionRequestPayload } from "./createDataCollectionRequestPayload";
 export { default as createHasIdentity } from "./createHasIdentity";
 export { default as createRequest } from "./createRequest";
-export { default as createRequestPayload } from "./createRequestPayload";
+export { default as createRequestPayload } from "./createRequestPayload";
+export { default as createGetAssuranceValidationTokenParams } from "./createGetAssuranceValidationTokenParams";

package/libEs6/utils/toInteger.js

@@ -9,12 +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 isNumber from "./isNumber";
+import isString from "./isString";
 /*
  * coerce `value` to a number or return `defaultValue` if it cannot be.
+ *
+ * The coersion is attempted if value is a number or string.
  */
+
 export default ((value, defaultValue) => {
-  const n = Math.round(Number(value)); // eslint-disable-next-line no-restricted-globals
+  if (isNumber(value) || isString(value)) {
+    const n = Math.round(Number(value)); // eslint-disable-next-line no-restricted-globals
+
+    if (!isNaN(n)) {
+      return n;
+    }
+  }
 
-  return isNaN(n) ? defaultValue : n;
+  return defaultValue;
 });

package/libEs6/utils/validateConfigOverride.js

@@ -0,0 +1,13 @@
+/*
+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 { objectOf } from "./validation";
+export default objectOf({});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.14.0-alpha.2",
+  "version": "2.14.0-alpha.20",
   "description": "Adobe Experience Platform Web SDK",
   "main": "libEs5/index.js",
   "module": "libEs6/index.js",
@@ -64,7 +64,7 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.14.0-alpha.1",
+    "@adobe/alloy": "^2.14.0-alpha.19",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",
@@ -95,6 +95,7 @@
     "karma-jasmine": "^2.0.1",
     "karma-jasmine-html-reporter": "^1.4.2",
     "karma-jasmine-matchers": "^4.0.1",
+    "karma-junit-reporter": "^2.0.1",
     "karma-rollup-preprocessor": "^7.0.5",
     "karma-safari-launcher": "^1.0.0",
     "karma-sauce-launcher": "^4.3.6",
@@ -117,9 +118,9 @@
     "rollup-plugin-terser": "^7.0.2",
     "semver": "^7.3.7",
     "start-server-and-test": "^1.10.6",
-    "testcafe": "^1.19.0",
-    "testcafe-browser-provider-saucelabs": "^1.8.3",
-    "testcafe-reporter-json": "^2.2.0",
+    "testcafe": "^2.2.0",
+    "testcafe-browser-provider-saucelabs": "^1.9.0",
+    "testcafe-reporter-junit": "^3.0.2",
     "url-exists-nodejs": "^0.1.0",
     "url-parse": "^1.4.7",
     "yargs": "^16.2.0"