@adobe/alloy 2.20.0-beta.0 → 2.20.0-beta.2

package/libEs6/components/Context/implementationDetails.js

@@ -1,24 +0,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.
-*/
-import { deepAssign } from "../../utils";
-import libraryName from "../../constants/libraryName";
-import libraryVersion from "../../constants/libraryVersion";
-export default (xdm => {
-  const implementationDetails = {
-    name: libraryName,
-    version: libraryVersion,
-    environment: "browser"
-  };
-  deepAssign(xdm, {
-    implementationDetails
-  });
-});

package/libEs6/components/Context/index.js

@@ -1,52 +0,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.
-*/
-
-import injectWeb from "./injectWeb";
-import injectDevice from "./injectDevice";
-import injectEnvironment from "./injectEnvironment";
-import injectPlaceContext from "./injectPlaceContext";
-import injectTimestamp from "./injectTimestamp";
-import implementationDetails from "./implementationDetails";
-import createComponent from "./createComponent";
-import injectHighEntropyUserAgentHints from "./injectHighEntropyUserAgentHints";
-import { arrayOf, objectOf, string } from "../../utils/validation";
-const web = injectWeb(window);
-const device = injectDevice(window);
-const environment = injectEnvironment(window);
-const placeContext = injectPlaceContext(() => new Date());
-const timestamp = injectTimestamp(() => new Date());
-const highEntropyUserAgentHints = injectHighEntropyUserAgentHints(navigator);
-const defaultEnabledContexts = {
-  web,
-  device,
-  environment,
-  placeContext
-};
-const defaultDisabledContexts = {
-  highEntropyUserAgentHints
-};
-const optionalContexts = {
-  ...defaultEnabledContexts,
-  ...defaultDisabledContexts
-};
-const requiredContexts = [timestamp, implementationDetails];
-const createContext = ({
-  config,
-  logger
-}) => {
-  return createComponent(config, logger, optionalContexts, requiredContexts);
-};
-createContext.namespace = "Context";
-createContext.configValidators = objectOf({
-  context: arrayOf(string()).default(Object.keys(defaultEnabledContexts))
-});
-export default createContext;

package/libEs6/components/Context/injectDevice.js

@@ -1,70 +0,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.
-*/
-
-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 {
-      screen: {
-        width,
-        height
-      }
-    } = 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

@@ -1,42 +0,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.
-*/
-
-import { deepAssign, toInteger } from "../../utils";
-export default (window => {
-  return xdm => {
-    const {
-      document: {
-        documentElement: {
-          clientWidth,
-          clientHeight
-        } = {}
-      }
-    } = window;
-    const environment = {
-      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

@@ -1,45 +0,0 @@
-/*
-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 { 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 */
-          typeof hints[hintName] === hintType) {
-            userAgentClientHints[hintName] = hints[hintName];
-          }
-        });
-        deepAssign(xdm, {
-          environment: {
-            browserDetails: {
-              userAgentClientHints
-            }
-          }
-        });
-      });
-    } catch (error) {
-      logger.warn(`Unable to collect user-agent client hints. ${error.message}`);
-      return noop;
-    }
-  };
-});

package/libEs6/components/Context/injectPlaceContext.js

@@ -1,29 +0,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.
-*/
-import { deepAssign, toISOStringLocal, toInteger } from "../../utils";
-export default (dateProvider => {
-  return xdm => {
-    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
-    if (localTimezoneOffset === undefined || Math.abs(localTimezoneOffset) < 6000) {
-      placeContext.localTime = toISOStringLocal(date);
-    }
-    deepAssign(xdm, {
-      placeContext
-    });
-  };
-});

package/libEs6/components/Context/injectTimestamp.js

@@ -1,21 +0,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.
-*/
-
-import { deepAssign } from "../../utils";
-export default (dateProvider => {
-  return xdm => {
-    const timestamp = dateProvider().toISOString();
-    deepAssign(xdm, {
-      timestamp
-    });
-  };
-});

package/libEs6/components/Context/injectWeb.js

@@ -1,28 +0,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.
-*/
-
-import { deepAssign } from "../../utils";
-export default (window => {
-  return xdm => {
-    const web = {
-      webPageDetails: {
-        URL: window.location.href || window.location
-      },
-      webReferrer: {
-        URL: window.document.referrer
-      }
-    };
-    deepAssign(xdm, {
-      web
-    });
-  };
-});

package/libEs6/components/DataCollector/index.js

@@ -1,106 +0,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.
-*/
-
-import validateUserEventOptions from "./validateUserEventOptions";
-import validateApplyResponse from "./validateApplyResponse";
-import { deepAssign } from "../../utils";
-const createDataCollector = ({
-  eventManager,
-  logger
-}) => {
-  return {
-    commands: {
-      sendEvent: {
-        documentationUri: "https://adobe.ly/3GQ3Q7t",
-        optionsValidator: options => {
-          return validateUserEventOptions({
-            options
-          });
-        },
-        run: options => {
-          const {
-            xdm,
-            data,
-            documentUnloading,
-            type,
-            mergeId,
-            datasetId,
-            edgeConfigOverrides,
-            ...eventManagerOptions
-          } = 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
-            });
-          }
-          if (edgeConfigOverrides) {
-            eventManagerOptions.edgeConfigOverrides = edgeConfigOverrides;
-          }
-          if (datasetId) {
-            logger.warn("The 'datasetId' option has been deprecated. Please use 'edgeConfigOverrides.com_adobe_experience_platform.datasets.event.datasetId' instead.");
-            eventManagerOptions.edgeConfigOverrides = edgeConfigOverrides || {};
-            deepAssign(eventManagerOptions.edgeConfigOverrides, {
-              com_adobe_experience_platform: {
-                datasets: {
-                  event: {
-                    datasetId
-                  }
-                }
-              }
-            });
-          }
-          return eventManager.sendEvent(event, eventManagerOptions);
-        }
-      },
-      applyResponse: {
-        documentationUri: "",
-        optionsValidator: options => {
-          return validateApplyResponse({
-            options
-          });
-        },
-        run: options => {
-          const {
-            renderDecisions = false,
-            decisionContext = {},
-            responseHeaders = {},
-            responseBody = {
-              handle: []
-            },
-            personalization
-          } = options;
-          const event = eventManager.createEvent();
-          return eventManager.applyResponse(event, {
-            renderDecisions,
-            decisionContext,
-            responseHeaders,
-            responseBody,
-            personalization
-          });
-        }
-      }
-    }
-  };
-};
-createDataCollector.namespace = "DataCollector";
-export default createDataCollector;

package/libEs6/components/DataCollector/validateApplyResponse.js

@@ -1,33 +0,0 @@
-/*
-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 { anything, arrayOf, boolean, mapOfValues, objectOf, string } from "../../utils/validation";
-export default (({
-  options
-}) => {
-  const validator = objectOf({
-    renderDecisions: boolean(),
-    responseHeaders: mapOfValues(string().required()),
-    responseBody: objectOf({
-      handle: arrayOf(objectOf({
-        type: string().required(),
-        payload: anything().required()
-      })).required()
-    }).required(),
-    personalization: objectOf({
-      sendDisplayEvent: boolean().default(true),
-      decisionContext: objectOf({})
-    }).default({
-      sendDisplayEvent: true
-    })
-  }).noUnknownFields();
-  return validator(options);
-});

package/libEs6/components/DataCollector/validateUserEventOptions.js

@@ -1,49 +0,0 @@
-/*
-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.
-*/
-
-import { string, objectOf, boolean, arrayOf } from "../../utils/validation";
-import { validateConfigOverride, validateIdentityMap } from "../../utils";
-/**
- * Verifies user provided event options.
- * @param {*} options The user event options to validate
- * @returns {*} Validated options
- */
-export default (({
-  options
-}) => {
-  const eventOptionsValidator = objectOf({
-    type: string(),
-    xdm: objectOf({
-      eventType: string(),
-      identityMap: validateIdentityMap
-    }),
-    data: objectOf({}),
-    documentUnloading: boolean(),
-    renderDecisions: boolean(),
-    decisionScopes: arrayOf(string()).uniqueItems(),
-    personalization: objectOf({
-      decisionScopes: arrayOf(string()).uniqueItems(),
-      surfaces: arrayOf(string()).uniqueItems(),
-      sendDisplayEvent: boolean().default(true),
-      includeRenderedPropositions: boolean().default(false),
-      defaultPersonalizationEnabled: boolean(),
-      decisionContext: objectOf({})
-    }).default({
-      sendDisplayEvent: true
-    }),
-    datasetId: string(),
-    mergeId: string(),
-    edgeConfigOverrides: validateConfigOverride,
-    initializePersonalization: boolean()
-  }).required().noUnknownFields();
-  return eventOptionsValidator(options);
-});

package/libEs6/components/DecisioningEngine/consequenceAdapters/inAppMessageConsequenceAdapter.js

@@ -1,30 +0,0 @@
-/*
-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 { MESSAGE_IN_APP } from "../../../constants/schema";
-import { TEXT_HTML } from "../../../constants/contentType";
-export default ((id, type, detail) => {
-  const {
-    html,
-    mobileParameters
-  } = detail;
-  const webParameters = {};
-  return {
-    schema: MESSAGE_IN_APP,
-    data: {
-      mobileParameters,
-      webParameters,
-      content: html,
-      contentType: TEXT_HTML
-    },
-    id
-  };
-});

package/libEs6/components/DecisioningEngine/consequenceAdapters/schemaTypeConsequenceAdapter.js

@@ -1,24 +0,0 @@
-/*
-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.
-*/
-
-export default ((id, type, detail) => {
-  const {
-    schema,
-    data,
-    id: detailId
-  } = detail;
-  return {
-    schema,
-    data,
-    id: detailId || id
-  };
-});

package/libEs6/components/DecisioningEngine/constants.js

@@ -1,25 +0,0 @@
-/*
-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.
-*/
-export const CONTEXT_KEY = {
-  TYPE: "~type",
-  SOURCE: "~source"
-};
-export const CONTEXT_EVENT_TYPE = {
-  LIFECYCLE: "com.adobe.eventType.lifecycle",
-  TRACK: "com.adobe.eventType.generic.track",
-  EDGE: "com.adobe.eventType.edge",
-  RULES_ENGINE: "com.adobe.eventType.rulesEngine"
-};
-export const CONTEXT_EVENT_SOURCE = {
-  LAUNCH: "com.adobe.eventSource.applicationLaunch",
-  REQUEST: "com.adobe.eventSource.requestContent"
-};

package/libEs6/components/DecisioningEngine/createApplyResponse.js

@@ -1,31 +0,0 @@
-/*
-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.
-*/
-export default (lifecycle => {
-  return ({
-    renderDecisions = false,
-    propositions = [],
-    event,
-    personalization
-  }) => {
-    if (propositions.length > 0 && lifecycle) {
-      lifecycle.onDecision({
-        renderDecisions,
-        propositions,
-        event,
-        personalization
-      });
-    }
-    return {
-      propositions
-    };
-  };
-});

package/libEs6/components/DecisioningEngine/createConsequenceAdapter.js

@@ -1,29 +0,0 @@
-/*
-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 inAppMessageConsequenceAdapter from "./consequenceAdapters/inAppMessageConsequenceAdapter";
-import schemaTypeConsequenceAdapter from "./consequenceAdapters/schemaTypeConsequenceAdapter";
-const CJM_IN_APP_MESSAGE_TYPE = "cjmiam";
-const SCHEMA = "schema";
-const adapters = {
-  [CJM_IN_APP_MESSAGE_TYPE]: inAppMessageConsequenceAdapter,
-  [SCHEMA]: schemaTypeConsequenceAdapter
-};
-export default (() => {
-  return consequence => {
-    const {
-      id,
-      type,
-      detail
-    } = consequence;
-    return typeof adapters[type] === "function" ? adapters[type](id, type, detail) : detail;
-  };
-});