@adobe/alloy 2.28.0-beta.7 → 2.28.1-beta.0

package/libEs5/components/Consent/createStoredConsent.js

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _cookieNameKey = require("../../constants/cookieNameKey.js");
+/*
+Copyright 2020 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 = ({
+  parseConsentCookie,
+  orgId,
+  cookieJar
+}) => {
+  const consentCookieName = (0, _index.getNamespacedCookieName)(orgId, _cookieNameKey.CONSENT);
+  return {
+    read() {
+      const cookieValue = cookieJar.get(consentCookieName);
+      return cookieValue ? parseConsentCookie(cookieValue) : {};
+    },
+    clear() {
+      cookieJar.remove(consentCookieName);
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Consent/index.js

@@ -0,0 +1,68 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _createComponent = require("./createComponent.js");
+var _createConsentHashStore = require("./createConsentHashStore.js");
+var _createConsentRequestPayload = require("./createConsentRequestPayload.js");
+var _createConsentRequest = require("./createConsentRequest.js");
+var _createStoredConsent = require("./createStoredConsent.js");
+var _injectSendSetConsentRequest = require("./injectSendSetConsentRequest.js");
+var _parseConsentCookie = require("./parseConsentCookie.js");
+var _validateSetConsentOptions = require("./validateSetConsentOptions.js");
+var _configValidators = require("./configValidators.js");
+/*
+Copyright 2019 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.
+*/
+
+const createConsent = ({
+  config,
+  consent,
+  sendEdgeNetworkRequest,
+  createNamespacedStorage
+}) => {
+  const {
+    orgId,
+    defaultConsent
+  } = config;
+  const storedConsent = (0, _createStoredConsent.default)({
+    parseConsentCookie: _parseConsentCookie.default,
+    orgId,
+    cookieJar: _index.cookieJar
+  });
+  const taskQueue = (0, _index.createTaskQueue)();
+  const sendSetConsentRequest = (0, _injectSendSetConsentRequest.default)({
+    createConsentRequestPayload: _createConsentRequestPayload.default,
+    createConsentRequest: _createConsentRequest.default,
+    sendEdgeNetworkRequest,
+    edgeConfigOverrides: config.edgeConfigOverrides
+  });
+  const storage = createNamespacedStorage((0, _index.sanitizeOrgIdForCookieName)(orgId) + ".consentHashes.");
+  const consentHashStore = (0, _createConsentHashStore.default)({
+    storage: storage.persistent
+  });
+  const doesIdentityCookieExist = (0, _index.injectDoesIdentityCookieExist)({
+    orgId
+  });
+  return (0, _createComponent.default)({
+    storedConsent,
+    taskQueue,
+    defaultConsent,
+    consent,
+    sendSetConsentRequest,
+    validateSetConsentOptions: _validateSetConsentOptions.default,
+    consentHashStore,
+    doesIdentityCookieExist
+  });
+};
+createConsent.namespace = "Consent";
+createConsent.configValidators = _configValidators.default;
+var _default = exports.default = createConsent;

package/libEs5/components/Consent/injectSendSetConsentRequest.js

@@ -0,0 +1,48 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _index2 = require("../../utils/request/index.js");
+/*
+Copyright 2020 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 = ({
+  createConsentRequestPayload,
+  createConsentRequest,
+  sendEdgeNetworkRequest,
+  edgeConfigOverrides: globalConfigOverrides
+}) => ({
+  consentOptions,
+  identityMap,
+  edgeConfigOverrides: localConfigOverrides
+}) => {
+  const requestParams = (0, _index2.createRequestParams)({
+    payload: createConsentRequestPayload(),
+    globalConfigOverrides,
+    localConfigOverrides
+  });
+  requestParams.payload.setConsent(consentOptions);
+  if ((0, _index.isObject)(identityMap)) {
+    Object.keys(identityMap).forEach(key => {
+      identityMap[key].forEach(identity => {
+        requestParams.payload.addIdentity(key, identity);
+      });
+    });
+  }
+  const request = createConsentRequest(requestParams);
+  return sendEdgeNetworkRequest({
+    request
+  }).then(() => {
+    // Don't let response data disseminate beyond this
+    // point unless necessary.
+  });
+};
+exports.default = _default;

package/libEs5/components/Consent/parseConsentCookie.js

@@ -0,0 +1,29 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2019 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.
+*/
+/**
+ * Parses a consent cookie.
+ * @param {string} cookieValue Must be in the format a=b;c=d
+ * @returns {Object} An object where the keys are purpose names and the values
+ * are the consent status for the purpose.
+ */
+var _default = cookieValue => {
+  const categoryPairs = cookieValue.split(";");
+  return categoryPairs.reduce((consentByPurpose, categoryPair) => {
+    const [name, value] = categoryPair.split("=");
+    consentByPurpose[name] = value;
+    return consentByPurpose;
+  }, {});
+};
+exports.default = _default;

package/libEs5/components/Consent/validateSetConsentOptions.js

@@ -0,0 +1,21 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/validation/index.js");
+var _index2 = require("../../utils/index.js");
+/*
+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.
+*/
+var _default = exports.default = (0, _index.objectOf)({
+  consent: (0, _index.arrayOf)((0, _index.anything)()).required().nonEmpty(),
+  identityMap: _index2.validateIdentityMap,
+  edgeConfigOverrides: _index2.validateConfigOverride
+}).noUnknownFields().required();

package/libEs5/components/Context/createComponent.js

@@ -0,0 +1,36 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2019 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 = (config, logger, optionalContexts, requiredContexts) => {
+  const configuredContexts = config.context;
+  const contexts = configuredContexts.flatMap((context, i) => {
+    if (optionalContexts[context]) {
+      return [optionalContexts[context]];
+    }
+    logger.warn("Invalid context[" + i + "]: '" + context + "' is not available.");
+    return [];
+  }).concat(requiredContexts);
+  return {
+    namespace: "Context",
+    lifecycle: {
+      onBeforeEvent({
+        event
+      }) {
+        const xdm = {};
+        return Promise.all(contexts.map(context => Promise.resolve(context(xdm, logger)))).then(() => event.mergeXdm(xdm));
+      }
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/implementationDetails.js

@@ -0,0 +1,28 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _libraryName = require("../../constants/libraryName.js");
+var _libraryVersion = require("../../constants/libraryVersion.js");
+/*
+Copyright 2019 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 = xdm => {
+  const implementationDetails = {
+    name: _libraryName.default,
+    version: _libraryVersion.default,
+    environment: "browser"
+  };
+  (0, _index.deepAssign)(xdm, {
+    implementationDetails
+  });
+};
+exports.default = _default;

package/libEs5/components/Context/index.js

@@ -0,0 +1,55 @@
+"use strict";
+
+exports.default = void 0;
+var _injectWeb = require("./injectWeb.js");
+var _injectDevice = require("./injectDevice.js");
+var _injectEnvironment = require("./injectEnvironment.js");
+var _injectPlaceContext = require("./injectPlaceContext.js");
+var _injectTimestamp = require("./injectTimestamp.js");
+var _implementationDetails = require("./implementationDetails.js");
+var _createComponent = require("./createComponent.js");
+var _injectHighEntropyUserAgentHints = require("./injectHighEntropyUserAgentHints.js");
+var _index = require("../../utils/validation/index.js");
+/*
+Copyright 2019 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.
+*/
+
+const web = (0, _injectWeb.default)(window);
+const device = (0, _injectDevice.default)(window);
+const environment = (0, _injectEnvironment.default)(window);
+const placeContext = (0, _injectPlaceContext.default)(() => new Date());
+const timestamp = (0, _injectTimestamp.default)(() => new Date());
+const highEntropyUserAgentHints = (0, _injectHighEntropyUserAgentHints.default)(navigator);
+const defaultEnabledContexts = {
+  web,
+  device,
+  environment,
+  placeContext
+};
+const defaultDisabledContexts = {
+  highEntropyUserAgentHints
+};
+const optionalContexts = {
+  ...defaultEnabledContexts,
+  ...defaultDisabledContexts
+};
+const requiredContexts = [timestamp, _implementationDetails.default];
+const createContext = ({
+  config,
+  logger
+}) => {
+  return (0, _createComponent.default)(config, logger, optionalContexts, requiredContexts);
+};
+createContext.namespace = "Context";
+createContext.configValidators = (0, _index.objectOf)({
+  context: (0, _index.arrayOf)((0, _index.string)()).default(Object.keys(defaultEnabledContexts))
+});
+var _default = exports.default = createContext;

package/libEs5/components/Context/injectDevice.js

@@ -0,0 +1,74 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+Copyright 2019 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.
+*/
+
+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 ((0, _index.isFunction)(window.matchMedia)) {
+    if (window.matchMedia("(orientation: portrait)").matches) {
+      return "portrait";
+    }
+    if (window.matchMedia("(orientation: landscape)").matches) {
+      return "landscape";
+    }
+  }
+  return null;
+};
+var _default = window => {
+  return xdm => {
+    const {
+      screen: {
+        width,
+        height
+      }
+    } = window;
+    const device = {};
+    const screenHeight = (0, _index.toInteger)(height);
+    if (screenHeight >= 0) {
+      device.screenHeight = screenHeight;
+    }
+    const screenWidth = (0, _index.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) {
+      (0, _index.deepAssign)(xdm, {
+        device
+      });
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/injectEnvironment.js

@@ -0,0 +1,45 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+Copyright 2019 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 = window => {
+  return xdm => {
+    const {
+      document: {
+        documentElement: {
+          clientWidth,
+          clientHeight
+        } = {}
+      }
+    } = window;
+    const environment = {
+      type: "browser"
+    };
+    const viewportWidth = (0, _index.toInteger)(clientWidth);
+    if (viewportWidth >= 0) {
+      environment.browserDetails = {
+        viewportWidth
+      };
+    }
+    const viewportHeight = (0, _index.toInteger)(clientHeight);
+    if (viewportHeight >= 0) {
+      environment.browserDetails = environment.browserDetails || {};
+      environment.browserDetails.viewportHeight = viewportHeight;
+    }
+    (0, _index.deepAssign)(xdm, {
+      environment
+    });
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/injectHighEntropyUserAgentHints.js

@@ -0,0 +1,50 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+var _highEntropyUserAgentClientHints = require("../../constants/highEntropyUserAgentClientHints.js");
+/*
+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.
+*/
+
+const browserSupportsUserAgentClientHints = navigator => {
+  return "userAgentData" in navigator;
+};
+var _default = navigator => {
+  if (!browserSupportsUserAgentClientHints(navigator)) {
+    return _index.noop;
+  }
+  return (xdm, logger) => {
+    try {
+      // eslint-disable-next-line compat/compat -- userAgentData support is checked before calling
+      return navigator.userAgentData.getHighEntropyValues(_highEntropyUserAgentClientHints.default.map(hint => hint[0])).then(hints => {
+        const userAgentClientHints = {};
+        _highEntropyUserAgentClientHints.default.forEach(([hintName, hintType]) => {
+          if (Object.prototype.hasOwnProperty.call(hints, hintName) && /* eslint-disable-next-line valid-typeof */
+          typeof hints[hintName] === hintType) {
+            userAgentClientHints[hintName] = hints[hintName];
+          }
+        });
+        (0, _index.deepAssign)(xdm, {
+          environment: {
+            browserDetails: {
+              userAgentClientHints
+            }
+          }
+        });
+      });
+    } catch (error) {
+      logger.warn("Unable to collect user-agent client hints. " + error.message);
+      return _index.noop;
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/injectPlaceContext.js

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+Copyright 2019 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 = dateProvider => {
+  return xdm => {
+    const date = dateProvider();
+    const placeContext = {};
+    const localTimezoneOffset = (0, _index.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 = (0, _index.toISOStringLocal)(date);
+    }
+    (0, _index.deepAssign)(xdm, {
+      placeContext
+    });
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/injectTimestamp.js

@@ -0,0 +1,24 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+Copyright 2019 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 = dateProvider => {
+  return xdm => {
+    const timestamp = dateProvider().toISOString();
+    (0, _index.deepAssign)(xdm, {
+      timestamp
+    });
+  };
+};
+exports.default = _default;

package/libEs5/components/Context/injectWeb.js

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+Copyright 2019 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 = window => {
+  return xdm => {
+    const web = {
+      webPageDetails: {
+        URL: window.location.href || window.location
+      },
+      webReferrer: {
+        URL: window.document.referrer
+      }
+    };
+    (0, _index.deepAssign)(xdm, {
+      web
+    });
+  };
+};
+exports.default = _default;