@adobe/alloy 2.15.0-alpha.1 → 2.16.0-alpha.0

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/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/stringToBoolean.js

@@ -1,3 +1,14 @@
+/*
+Copyright 2023 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 isString from "./isString";
 export default (str => {
   return isString(str) && str.toLowerCase() === "true";

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.15.0-alpha.1",
+  "version": "2.16.0-alpha.0",
   "description": "Adobe Experience Platform Web SDK",
   "main": "libEs5/index.js",
   "module": "libEs6/index.js",
@@ -28,7 +28,8 @@
     "build": "npm run format && npm run lint && npm run clean && rollup -c --environment BASE_CODE_MIN,STANDALONE,STANDALONE_MIN && echo \"Base Code:\" && cat distTest/baseCode.min.js",
     "prepare": "husky install && cd sandbox && npm install",
     "prepublishOnly": "rimraf libEs5 libEs6 && babel src -d libEs5 --env-name npmEs5 && babel src -d libEs6 --env-name npmEs6",
-    "checkthattestfilesexist": "./scripts/checkThatTestFilesExist.js"
+    "checkthattestfilesexist": "./scripts/checkThatTestFilesExist.js",
+    "add-license": "./scripts/add-license.js"
   },
   "lint-staged": {
     "./*.js": [
@@ -64,7 +65,7 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.15.0-alpha.0",
+    "@adobe/alloy": "^2.15.0",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",
@@ -86,6 +87,7 @@
     "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-testcafe": "^0.2.1",
     "glob": "^7.1.3",
+    "handlebars": "^4.7.7",
     "husky": "^6.0.0",
     "jasmine-core": "^3.4.0",
     "karma": "^6.3.9",
@@ -117,6 +119,7 @@
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-terser": "^7.0.2",
     "semver": "^7.3.7",
+    "staged-git-files": "^1.3.0",
     "start-server-and-test": "^1.10.6",
     "testcafe": "^2.3.1",
     "testcafe-browser-provider-saucelabs": "^1.9.0",