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

package/libEs5/utils/filterObject.js

@@ -0,0 +1,57 @@
+"use strict";
+
+exports.default = void 0;
+
+var _isEmptyObject = require("./isEmptyObject");
+
+var _isNil = require("./isNil");
+
+var _isObject = require("./isObject");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+/**
+ * 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.
+ */
+var filterObject = function filterObject(obj, predicate) {
+  if ((0, _isNil.default)(obj) || !(0, _isObject.default)(obj)) {
+    return obj;
+  }
+
+  return Object.keys(obj).reduce(function (result, key) {
+    var value = obj[key];
+
+    if ((0, _isObject.default)(value)) {
+      // value is object, go deeper
+      var filteredValue = filterObject(value, predicate);
+
+      if ((0, _isEmptyObject.default)(filteredValue)) {
+        return result;
+      }
+
+      return _objectSpread(_objectSpread({}, result), {}, _defineProperty({}, key, filteredValue));
+    } // value is not an object, test predicate
+
+
+    if (predicate(value)) {
+      return _objectSpread(_objectSpread({}, result), {}, _defineProperty({}, key, value));
+    }
+
+    return result;
+  }, {});
+};
+
+var _default = filterObject;
+exports.default = _default;

package/libEs5/utils/index.js

@@ -78,6 +78,12 @@ Object.defineProperty(exports, "endsWith", {
     return _endsWith.default;
   }
 });
+Object.defineProperty(exports, "filterObject", {
+  enumerable: true,
+  get: function get() {
+    return _filterObject.default;
+  }
+});
 Object.defineProperty(exports, "find", {
   enumerable: true,
   get: function get() {
@@ -234,6 +240,12 @@ Object.defineProperty(exports, "padStart", {
     return _padStart.default;
   }
 });
+Object.defineProperty(exports, "prepareConfigOverridesForEdge", {
+  enumerable: true,
+  get: function get() {
+    return _prepareConfigOverridesForEdge.default;
+  }
+});
 Object.defineProperty(exports, "queryString", {
   enumerable: true,
   get: function get() {
@@ -300,6 +312,12 @@ Object.defineProperty(exports, "uuid", {
     return _uuid.default;
   }
 });
+Object.defineProperty(exports, "validateConfigOverride", {
+  enumerable: true,
+  get: function get() {
+    return _validateConfigOverride.default;
+  }
+});
 Object.defineProperty(exports, "validateIdentityMap", {
   enumerable: true,
   get: function get() {
@@ -345,6 +363,8 @@ var _fireImage = require("./fireImage");
 
 var _injectFireReferrerHideableImage = require("./injectFireReferrerHideableImage");
 
+var _filterObject = require("./filterObject");
+
 var _flatMap = require("./flatMap");
 
 var _getApexDomain = require("./getApexDomain");
@@ -391,6 +411,8 @@ var _noop = require("./noop");
 
 var _padStart = require("./padStart");
 
+var _prepareConfigOverridesForEdge = require("./prepareConfigOverridesForEdge");
+
 var _querystring = require("./querystring");
 
 var _sanitizeOrgIdForCookieName = require("./sanitizeOrgIdForCookieName");
@@ -415,4 +437,6 @@ var _updateErrorMessage = require("./updateErrorMessage");
 
 var _validateIdentityMap = require("./validateIdentityMap");
 
+var _validateConfigOverride = require("./validateConfigOverride");
+
 var _values = require("./values");

package/libEs5/utils/prepareConfigOverridesForEdge.js

@@ -0,0 +1,61 @@
+"use strict";
+
+exports.default = void 0;
+
+var _isNil = require("./isNil");
+
+var _filterObject = require("./filterObject");
+
+var _isEmptyObject = require("./isEmptyObject");
+
+var _isNonEmptyArray = require("./isNonEmptyArray");
+
+var _isNonEmptyString = require("./isNonEmptyString");
+
+var _isNumber = require("./isNumber");
+
+var _isBoolean = require("./isBoolean");
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+// 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
+var _default = function _default(configuration) {
+  if ((0, _isNil.default)(configuration) || _typeof(configuration) !== "object") {
+    return null;
+  } // remove entries that are empty strings or arrays
+
+
+  var configOverrides = (0, _filterObject.default)(configuration, function (value) {
+    if ((0, _isNil.default)(value)) {
+      return false;
+    }
+
+    if ((0, _isBoolean.default)(value)) {
+      return true;
+    }
+
+    if ((0, _isNumber.default)(value)) {
+      return true;
+    }
+
+    if ((0, _isNonEmptyString.default)(value)) {
+      return true;
+    }
+
+    if ((0, _isNonEmptyArray.default)(value)) {
+      return true;
+    }
+
+    return false;
+  });
+
+  if ((0, _isEmptyObject.default)(configOverrides)) {
+    return null;
+  }
+
+  return configOverrides;
+};
+
+exports.default = _default;

package/libEs5/utils/request/createGetAssuranceValidationTokenParams.js

@@ -0,0 +1,54 @@
+"use strict";
+
+exports.default = void 0;
+
+var _index = require("../index");
+
+/*
+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.
+*/
+var ASSURANCE_VALIDATION_SESSION_URL_PARAM = "adb_validation_sessionid";
+var ASSURANCE_VALIDATION_NAMESPACE = "validation.";
+var CLIENT_ID = "clientId";
+
+var getOrCreateAssuranceClientId = function getOrCreateAssuranceClientId(storage) {
+  var clientId = storage.persistent.getItem(CLIENT_ID);
+
+  if (!clientId) {
+    clientId = (0, _index.uuid)();
+    storage.persistent.setItem(CLIENT_ID, clientId);
+  }
+
+  return clientId;
+};
+
+var _default = function _default(_ref) {
+  var window = _ref.window,
+      createNamespacedStorage = _ref.createNamespacedStorage;
+  var storage = createNamespacedStorage(ASSURANCE_VALIDATION_NAMESPACE);
+  return function () {
+    var parsedQuery = _index.queryString.parse(window.location.search);
+
+    var validationSessionId = parsedQuery[ASSURANCE_VALIDATION_SESSION_URL_PARAM];
+
+    if (!validationSessionId) {
+      return "";
+    }
+
+    var clientId = getOrCreateAssuranceClientId(storage);
+    var validationToken = validationSessionId + "|" + clientId;
+    return "&" + _index.queryString.stringify({
+      adobeAepValidationToken: validationToken
+    });
+  };
+};
+
+exports.default = _default;

package/libEs5/utils/request/createRequestPayload.js

@@ -21,10 +21,16 @@ var _default = function _default(options) {
   var content = options.content,
       addIdentity = options.addIdentity,
       hasIdentity = options.hasIdentity;
+
+  var _mergeConfigOverride = (0, _.createMerger)(content, "meta.configOverrides");
+
   return {
     mergeMeta: (0, _.createMerger)(content, "meta"),
     mergeState: (0, _.createMerger)(content, "meta.state"),
     mergeQuery: (0, _.createMerger)(content, "query"),
+    mergeConfigOverride: function mergeConfigOverride(updates) {
+      return _mergeConfigOverride((0, _.prepareConfigOverridesForEdge)(updates));
+    },
     addIdentity: addIdentity,
     hasIdentity: hasIdentity,
     toJSON: function toJSON() {

package/libEs5/utils/request/index.js

@@ -18,6 +18,12 @@ Object.defineProperty(exports, "createDataCollectionRequestPayload", {
     return _createDataCollectionRequestPayload.default;
   }
 });
+Object.defineProperty(exports, "createGetAssuranceValidationTokenParams", {
+  enumerable: true,
+  get: function get() {
+    return _createGetAssuranceValidationTokenParams.default;
+  }
+});
 Object.defineProperty(exports, "createHasIdentity", {
   enumerable: true,
   get: function get() {
@@ -47,4 +53,6 @@ var _createHasIdentity = require("./createHasIdentity");
 
 var _createRequest = require("./createRequest");
 
-var _createRequestPayload = require("./createRequestPayload");
+var _createRequestPayload = require("./createRequestPayload");
+
+var _createGetAssuranceValidationTokenParams = require("./createGetAssuranceValidationTokenParams");

package/libEs5/utils/toInteger.js

@@ -2,6 +2,10 @@
 
 exports.default = void 0;
 
+var _isNumber = require("./isNumber");
+
+var _isString = require("./isString");
+
 /*
 Copyright 2022 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -16,11 +20,19 @@ governing permissions and limitations under the License.
 
 /*
  * coerce `value` to a number or return `defaultValue` if it cannot be.
+ *
+ * The coersion is attempted if value is a number or string.
  */
 var _default = function _default(value, defaultValue) {
-  var n = Math.round(Number(value)); // eslint-disable-next-line no-restricted-globals
+  if ((0, _isNumber.default)(value) || (0, _isString.default)(value)) {
+    var n = Math.round(Number(value)); // eslint-disable-next-line no-restricted-globals
+
+    if (!isNaN(n)) {
+      return n;
+    }
+  }
 
-  return isNaN(n) ? defaultValue : n;
+  return defaultValue;
 };
 
 exports.default = _default;

package/libEs5/utils/validateConfigOverride.js

@@ -0,0 +1,20 @@
+"use strict";
+
+exports.default = void 0;
+
+var _validation = require("./validation");
+
+/*
+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.
+*/
+var _default = (0, _validation.objectOf)({});
+
+exports.default = _default;

package/libEs6/components/Context/injectDevice.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 { deepAssign } from "../../utils";
+import { deepAssign, isFunction, toInteger } from "../../utils";
 
 const getScreenOrientationViaProperty = window => {
   const {
@@ -36,12 +36,14 @@ const getScreenOrientationViaProperty = window => {
 };
 
 const getScreenOrientationViaMediaQuery = window => {
-  if (window.matchMedia("(orientation: portrait)").matches) {
-    return "portrait";
-  }
+  if (isFunction(window.matchMedia)) {
+    if (window.matchMedia("(orientation: portrait)").matches) {
+      return "portrait";
+    }
 
-  if (window.matchMedia("(orientation: landscape)").matches) {
-    return "landscape";
+    if (window.matchMedia("(orientation: landscape)").matches) {
+      return "landscape";
+    }
   }
 
   return null;
@@ -55,18 +57,29 @@ export default (window => {
         height
       }
     } = window;
-    const device = {
-      screenHeight: height,
-      screenWidth: width
-    };
+    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;
     }
 
-    deepAssign(xdm, {
-      device
-    });
+    if (Object.keys(device).length > 0) {
+      deepAssign(xdm, {
+        device
+      });
+    }
   };
 });

package/libEs6/components/Context/injectEnvironment.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 { deepAssign, isNumber } from "../../utils";
+import { deepAssign, toInteger } from "../../utils";
 export default (window => {
   return xdm => {
     const {
@@ -23,14 +23,21 @@ export default (window => {
     const environment = {
       type: "browser"
     };
+    const viewportWidth = toInteger(clientWidth);
 
-    if (isNumber(clientWidth) && clientWidth >= 0 && isNumber(clientHeight) && clientHeight >= 0) {
+    if (viewportWidth >= 0) {
       environment.browserDetails = {
-        viewportWidth: Math.round(clientWidth),
-        viewportHeight: Math.round(clientHeight)
+        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

@@ -23,11 +23,13 @@ export default (navigator => {
 
   return (xdm, logger) => {
     try {
-      return navigator.userAgentData.getHighEntropyValues(highEntropyUserAgentHints).then(hints => {
+      return navigator.userAgentData.getHighEntropyValues(highEntropyUserAgentHints.map(hint => hint[0])).then(hints => {
         const userAgentClientHints = {};
-        highEntropyUserAgentHints.forEach(hint => {
-          if (Object.prototype.hasOwnProperty.call(hints, hint)) {
-            userAgentClientHints[hint] = hints[hint];
+        highEntropyUserAgentHints.forEach(([hintName, hintType]) => {
+          if (Object.prototype.hasOwnProperty.call(hints, hintName) &&
+          /* eslint-disable-next-line valid-typeof */
+          typeof hints[hintName] === hintType) {
+            userAgentClientHints[hintName] = hints[hintName];
           }
         });
         deepAssign(xdm, {

package/libEs6/components/Context/injectPlaceContext.js

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

package/libEs6/components/DataCollector/index.js

@@ -11,9 +11,11 @@ governing permissions and limitations under the License.
 */
 import validateUserEventOptions from "./validateUserEventOptions";
 import validateApplyResponse from "./validateApplyResponse";
+import { deepAssign } from "../../utils";
 
 const createDataCollector = ({
-  eventManager
+  eventManager,
+  logger
 }) => {
   return {
     commands: {
@@ -35,7 +37,8 @@ const createDataCollector = ({
             decisionScopes = [],
             // Note: this option will soon be deprecated, please use personalization.decisionScopes instead
             personalization = {},
-            datasetId
+            datasetId,
+            edgeConfigOverrides
           } = options;
           const event = eventManager.createEvent();
 
@@ -58,19 +61,31 @@ const createDataCollector = ({
             });
           }
 
+          const sendEventOptions = {
+            renderDecisions,
+            decisionScopes,
+            personalization
+          };
+
+          if (edgeConfigOverrides) {
+            sendEventOptions.edgeConfigOverrides = edgeConfigOverrides;
+          }
+
           if (datasetId) {
-            event.mergeMeta({
-              collect: {
-                datasetId
+            logger.warn("The 'datasetId' option has been deprecated. Please use 'edgeConfigOverrides.experience_platform.datasets.event' instead.");
+            sendEventOptions.edgeConfigOverrides = edgeConfigOverrides || {};
+            deepAssign(sendEventOptions.edgeConfigOverrides, {
+              com_adobe_experience_platform: {
+                datasets: {
+                  event: {
+                    datasetId
+                  }
+                }
               }
             });
           }
 
-          return eventManager.sendEvent(event, {
-            renderDecisions,
-            decisionScopes,
-            personalization
-          });
+          return eventManager.sendEvent(event, sendEventOptions);
         }
       },
       applyResponse: {

package/libEs6/components/DataCollector/validateUserEventOptions.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 { string, objectOf, boolean, arrayOf } from "../../utils/validation";
-import { validateIdentityMap } from "../../utils";
+import { validateConfigOverride, validateIdentityMap } from "../../utils";
 /**
  * Verifies user provided event options.
  * @param {*} options The user event options to validate
@@ -35,7 +35,8 @@ export default (({
       surfaces: arrayOf(string()).uniqueItems()
     }),
     datasetId: string(),
-    mergeId: string()
+    mergeId: string(),
+    edgeConfigOverrides: validateConfigOverride
   }).required().noUnknownFields();
   return eventOptionsValidator(options);
 });

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";
 /**
  * Verifies user provided event options.
@@ -17,5 +18,6 @@ import { objectOf, string } from "../../../utils/validation";
  */
 
 export default objectOf({
-  url: string().required().nonEmpty()
+  url: string().required().nonEmpty(),
+  edgeConfigOverrides: validateConfigOverride
 }).required().noUnknownFields();

package/libEs6/components/Identity/createComponent.js

@@ -57,7 +57,7 @@ export default (({
         optionsValidator: getIdentityOptionsValidator,
         run: options => {
           return consent.awaitConsent().then(() => {
-            return ecid ? undefined : getIdentity(options.namespaces);
+            return ecid ? undefined : getIdentity(options);
           }).then(() => {
             return {
               identity: {
@@ -72,7 +72,7 @@ export default (({
         optionsValidator: appendIdentityToUrlOptionsValidator,
         run: options => {
           return consent.withConsent().then(() => {
-            return ecid ? undefined : getIdentity(options.namespaces);
+            return ecid ? undefined : getIdentity(options);
           }).then(() => {
             return {
               url: appendIdentityToUrl(ecid, options.url)

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

@@ -12,11 +12,18 @@ governing permissions and limitations under the License.
 export default (({
   sendEdgeNetworkRequest,
   createIdentityRequestPayload,
-  createIdentityRequest
+  createIdentityRequest,
+  globalConfigOverrides
 }) => {
-  return namespaces => {
+  return ({
+    namespaces,
+    edgeConfigOverrides: localConfigOverrides
+  } = {}) => {
     const payload = createIdentityRequestPayload(namespaces);
-    const request = createIdentityRequest(payload);
+    const request = createIdentityRequest(payload); // merge the configurations, but give preference to the command-local configs
+
+    payload.mergeConfigOverride(globalConfigOverrides);
+    payload.mergeConfigOverride(localConfigOverrides);
     return sendEdgeNetworkRequest({
       request
     });

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";
 /**
  * Verifies user provided event options.
@@ -16,14 +17,9 @@ import { objectOf, literal, arrayOf } from "../../../utils/validation";
  * @returns {*} Validated options
  */
 
-export default (options => {
-  const getIdentityOptionsValidator = objectOf({
-    namespaces: arrayOf(literal("ECID")).nonEmpty().uniqueItems()
-  }).noUnknownFields();
-  getIdentityOptionsValidator(options); // Return default options for now
-  // To-Do: Accept namespace from given options
-
-  return {
-    namespaces: ["ECID"]
-  };
+export default objectOf({
+  namespaces: arrayOf(literal("ECID")).nonEmpty().uniqueItems().default(["ECID"]),
+  edgeConfigOverrides: validateConfigOverride
+}).noUnknownFields().default({
+  namespaces: ["ECID"]
 });