@adobe/alloy 2.27.0 → 2.28.0-beta.1

package/libEs6/core/createLifecycle.js

@@ -1,65 +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.
-*/
-
-// TO-DOCUMENT: Lifecycle hooks and their params.
-const hookNames = [
-// Called after all components have been registered.
-"onComponentsRegistered",
-// Called before an event is sent on a data collection request
-"onBeforeEvent",
-// Called before each request is made to the edge.
-"onBeforeRequest",
-// Called after each response is returned from the edge with a successful
-// status code
-"onResponse",
-// Called after a network request to the edge fails. Either the request
-// didn't make it to the edge, didn't make it to Konductor, or Konductor
-// failed to return a regularly-structured response. (In this case { error }
-// is passed as the parameter)
-// Also called when the respone returns a 400 or 500 error. (In this case
-// { response } is passed as the parameter)
-"onRequestFailure",
-// A user clicked on an element.
-"onClick",
-// Called by RulesEngine when a ruleset is satisfied with a list of
-// propositions
-"onDecision"];
-const createHook = (componentRegistry, hookName) => {
-  return (...args) => {
-    return Promise.all(componentRegistry.getLifecycleCallbacks(hookName).map(callback => {
-      return new Promise(resolve => {
-        resolve(callback(...args));
-      });
-    }));
-  };
-};
-
-/**
- * This ensures that if a component's lifecycle method X
- * attempts to execute lifecycle method Y, that all X methods on all components
- * will have been called before any of their Y methods are called. It does
- * this by kicking the call to the Y method to the next JavaScript tick.
- * @returns {function}
- */
-const guardHook = fn => {
-  return (...args) => {
-    return Promise.resolve().then(() => {
-      return fn(...args);
-    });
-  };
-};
-export default componentRegistry => {
-  return hookNames.reduce((memo, hookName) => {
-    memo[hookName] = guardHook(createHook(componentRegistry, hookName));
-    return memo;
-  }, {});
-};

package/libEs6/core/createLogController.js

@@ -1,68 +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 { queryString, stringToBoolean } from "../utils/index.js";
-import debugQueryParam from "../constants/debugQueryParam.js";
-export default ({
-  console,
-  locationSearch,
-  createLogger,
-  instanceName,
-  createNamespacedStorage,
-  getMonitors
-}) => {
-  const parsedQueryString = queryString.parse(locationSearch);
-  const storage = createNamespacedStorage(`instance.${instanceName}.`);
-  const debugSessionValue = storage.session.getItem("debug");
-  let debugEnabled = debugSessionValue === "true";
-  let debugEnabledWritableFromConfig = debugSessionValue === null;
-  const getDebugEnabled = () => debugEnabled;
-  const setDebugEnabled = (value, {
-    fromConfig
-  }) => {
-    if (!fromConfig || debugEnabledWritableFromConfig) {
-      debugEnabled = value;
-    }
-    if (!fromConfig) {
-      // Web storage only allows strings, so we explicitly convert to string.
-      storage.session.setItem("debug", value.toString());
-      debugEnabledWritableFromConfig = false;
-    }
-  };
-  if (parsedQueryString[debugQueryParam] !== undefined) {
-    setDebugEnabled(stringToBoolean(parsedQueryString[debugQueryParam]), {
-      fromConfig: false
-    });
-  }
-  return {
-    setDebugEnabled,
-    logger: createLogger({
-      getDebugEnabled,
-      context: {
-        instanceName
-      },
-      getMonitors,
-      console
-    }),
-    createComponentLogger(componentName) {
-      return createLogger({
-        getDebugEnabled,
-        context: {
-          instanceName,
-          componentName
-        },
-        getMonitors,
-        console
-      });
-    }
-  };
-};

package/libEs6/core/createLogger.js

@@ -1,114 +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.
-*/
-
-export default ({
-  getDebugEnabled,
-  console,
-  getMonitors,
-  context
-}) => {
-  let prefix = `[${context.instanceName}]`;
-  if (context.componentName) {
-    prefix += ` [${context.componentName}]`;
-  }
-  const notifyMonitors = (method, data) => {
-    const monitors = getMonitors();
-    if (monitors.length > 0) {
-      const dataWithContext = {
-        ...context,
-        ...data
-      };
-      monitors.forEach(monitor => {
-        if (monitor[method]) {
-          monitor[method](dataWithContext);
-        }
-      });
-    }
-  };
-  const log = (level, ...rest) => {
-    notifyMonitors("onBeforeLog", {
-      level,
-      arguments: rest
-    });
-    if (getDebugEnabled()) {
-      console[level](prefix, ...rest);
-    }
-  };
-  return {
-    get enabled() {
-      return getMonitors().length > 0 || getDebugEnabled();
-    },
-    logOnInstanceCreated(data) {
-      notifyMonitors("onInstanceCreated", data);
-      log("info", "Instance initialized.");
-    },
-    logOnInstanceConfigured(data) {
-      notifyMonitors("onInstanceConfigured", data);
-      log("info", "Instance configured. Computed configuration:", data.config);
-    },
-    logOnBeforeCommand(data) {
-      notifyMonitors("onBeforeCommand", data);
-      log("info", `Executing ${data.commandName} command. Options:`, data.options);
-    },
-    logOnCommandResolved(data) {
-      notifyMonitors("onCommandResolved", data);
-      log("info", `${data.commandName} command resolved. Result:`, data.result);
-    },
-    logOnCommandRejected(data) {
-      notifyMonitors("onCommandRejected", data);
-      log("error", `${data.commandName} command was rejected. Error:`, data.error);
-    },
-    logOnBeforeNetworkRequest(data) {
-      notifyMonitors("onBeforeNetworkRequest", data);
-      log("info", `Request ${data.requestId}: Sending request.`, data.payload);
-    },
-    logOnNetworkResponse(data) {
-      notifyMonitors("onNetworkResponse", data);
-      const messagesSuffix = data.parsedBody || data.body ? `response body:` : `no response body.`;
-      log("info", `Request ${data.requestId}: Received response with status code ${data.statusCode} and ${messagesSuffix}`, data.parsedBody || data.body);
-    },
-    logOnNetworkError(data) {
-      notifyMonitors("onNetworkError", data);
-      log("error", `Request ${data.requestId}: Network request failed.`, data.error);
-    },
-    logOnContentHiding(data) {
-      notifyMonitors("onContentHiding", {
-        status: data.status
-      });
-      log(data.logLevel, data.message);
-    },
-    logOnContentRendering(data) {
-      notifyMonitors("onContentRendering", {
-        status: data.status,
-        payload: data.detail
-      });
-      log(data.logLevel, data.message);
-    },
-    /**
-     * Outputs informational message to the web console. In some
-     * browsers a small "i" icon is displayed next to these items
-     * in the web console's log.
-     * @param {...*} arg Any argument to be logged.
-     */
-    info: log.bind(null, "info"),
-    /**
-     * Outputs a warning message to the web console.
-     * @param {...*} arg Any argument to be logged.
-     */
-    warn: log.bind(null, "warn"),
-    /**
-     * Outputs an error message to the web console.
-     * @param {...*} arg Any argument to be logged.
-     */
-    error: log.bind(null, "error")
-  };
-};

package/libEs6/core/edgeNetwork/handleRequestFailure.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 onRequestFailureCallbackAggregator => {
-  return error => {
-    // Regardless of whether the network call failed, an unexpected status
-    // code was returned, or the response body was malformed, we want to call
-    // the onRequestFailure callbacks, but still throw the exception.
-    const throwError = () => {
-      throw error;
-    };
-    return onRequestFailureCallbackAggregator.call({
-      error
-    }).then(throwError, throwError);
-  };
-};

package/libEs6/core/edgeNetwork/injectApplyResponse.js

@@ -1,58 +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 { createCallbackAggregator, noop } from "../../utils/index.js";
-import mergeLifecycleResponses from "./mergeLifecycleResponses.js";
-import handleRequestFailure from "./handleRequestFailure.js";
-const HTTP_STATUS_OK = 200;
-export default ({
-  cookieTransfer,
-  lifecycle,
-  createResponse,
-  processWarningsAndErrors
-}) => {
-  return ({
-    request,
-    responseHeaders,
-    responseBody,
-    runOnResponseCallbacks = noop,
-    runOnRequestFailureCallbacks = noop
-  }) => {
-    const onResponseCallbackAggregator = createCallbackAggregator();
-    onResponseCallbackAggregator.add(lifecycle.onResponse);
-    onResponseCallbackAggregator.add(runOnResponseCallbacks);
-    const onRequestFailureCallbackAggregator = createCallbackAggregator();
-    onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
-    onRequestFailureCallbackAggregator.add(runOnRequestFailureCallbacks);
-    const getHeader = key => responseHeaders[key];
-    return lifecycle.onBeforeRequest({
-      request,
-      onResponse: onResponseCallbackAggregator.add,
-      onRequestFailure: onRequestFailureCallbackAggregator.add
-    }).then(() => processWarningsAndErrors({
-      statusCode: HTTP_STATUS_OK,
-      getHeader,
-      body: JSON.stringify(responseBody),
-      parsedBody: responseBody
-    })).catch(handleRequestFailure(onRequestFailureCallbackAggregator)).then(() => {
-      const response = createResponse({
-        content: responseBody,
-        getHeader
-      });
-
-      // This will clobber any cookies set via HTTP from the server.  So care should be given to remove any state:store handles if that is not desirable
-      cookieTransfer.responseToCookies(response);
-      return onResponseCallbackAggregator.call({
-        response
-      }).then(mergeLifecycleResponses);
-    });
-  };
-};

package/libEs6/core/edgeNetwork/injectExtractEdgeInfo.js

@@ -1,33 +0,0 @@
-/*
-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.
-*/
-
-export default ({
-  logger
-}) => adobeEdgeHeader => {
-  if (adobeEdgeHeader) {
-    const headerParts = adobeEdgeHeader.split(";");
-    if (headerParts.length >= 2 && headerParts[1].length > 0) {
-      try {
-        const regionId = parseInt(headerParts[1], 10);
-        if (!Number.isNaN(regionId)) {
-          return {
-            regionId
-          };
-        }
-      } catch {
-        // No need to do anything. The log statement below will log an error
-      }
-    }
-    logger.warn(`Invalid adobe edge: "${adobeEdgeHeader}"`);
-  }
-  return {};
-};

package/libEs6/core/edgeNetwork/injectGetLocationHint.js

@@ -1,32 +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 { getNamespacedCookieName } from "../../utils/index.js";
-import { CLUSTER } from "../../constants/cookieNameKey.js";
-import { MBOX_EDGE_CLUSTER } from "../../constants/legacyCookies.js";
-export default ({
-  orgId,
-  cookieJar
-}) => {
-  const clusterCookieName = getNamespacedCookieName(orgId, CLUSTER);
-  const fromClusterCookie = () => cookieJar.get(clusterCookieName);
-  const fromTarget = () => {
-    const mboxEdgeCluster = cookieJar.get(MBOX_EDGE_CLUSTER);
-    if (mboxEdgeCluster) {
-      return `t${mboxEdgeCluster}`;
-    }
-    return undefined;
-  };
-  return () => {
-    return fromClusterCookie() || fromTarget();
-  };
-};

package/libEs6/core/edgeNetwork/injectProcessWarningsAndErrors.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 { NO_CONTENT } from "../../constants/httpStatusCode.js";
-const MESSAGE_PREFIX = "The server responded with a";
-export default ({
-  logger
-}) => {
-  return networkResponse => {
-    const {
-      statusCode,
-      body,
-      parsedBody
-    } = networkResponse;
-    if (statusCode < 200 || statusCode >= 300 || !parsedBody && statusCode !== NO_CONTENT || parsedBody && !Array.isArray(parsedBody.handle)) {
-      const bodyToLog = parsedBody ? JSON.stringify(parsedBody, null, 2) : body;
-      const messageSuffix = bodyToLog ? `response body:\n${bodyToLog}` : `no response body.`;
-      throw new Error(`${MESSAGE_PREFIX} status code ${statusCode} and ${messageSuffix}`);
-    }
-    if (parsedBody) {
-      const {
-        warnings = [],
-        errors = []
-      } = parsedBody;
-      warnings.forEach(warning => {
-        logger.warn(`${MESSAGE_PREFIX} warning:`, warning);
-      });
-      errors.forEach(error => {
-        logger.error(`${MESSAGE_PREFIX} non-fatal error:`, error);
-      });
-    }
-  };
-};

package/libEs6/core/edgeNetwork/injectSendEdgeNetworkRequest.js

@@ -1,123 +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 { ID_THIRD_PARTY as ID_THIRD_PARTY_DOMAIN } from "../../constants/domain.js";
-import apiVersion from "../../constants/apiVersion.js";
-import { createCallbackAggregator, noop } from "../../utils/index.js";
-import { isNetworkError } from "../../utils/networkErrors.js";
-import mergeLifecycleResponses from "./mergeLifecycleResponses.js";
-import handleRequestFailure from "./handleRequestFailure.js";
-const isDemdexBlockedError = (error, request) => {
-  return request.getUseIdThirdPartyDomain() && isNetworkError(error);
-};
-export default ({
-  config,
-  lifecycle,
-  cookieTransfer,
-  sendNetworkRequest,
-  createResponse,
-  processWarningsAndErrors,
-  getLocationHint,
-  getAssuranceValidationTokenParams
-}) => {
-  const {
-    edgeDomain,
-    edgeBasePath,
-    datastreamId
-  } = config;
-  let hasDemdexFailed = false;
-  const buildEndpointUrl = (endpointDomain, request) => {
-    const locationHint = getLocationHint();
-    const edgeBasePathWithLocationHint = locationHint ? `${edgeBasePath}/${locationHint}${request.getEdgeSubPath()}` : `${edgeBasePath}${request.getEdgeSubPath()}`;
-    const configId = request.getDatastreamIdOverride() || datastreamId;
-    if (configId !== datastreamId) {
-      request.getPayload().mergeMeta({
-        sdkConfig: {
-          datastream: {
-            original: datastreamId
-          }
-        }
-      });
-    }
-    return `https://${endpointDomain}/${edgeBasePathWithLocationHint}/${apiVersion}/${request.getAction()}?configId=${configId}&requestId=${request.getId()}${getAssuranceValidationTokenParams()}`;
-  };
-
-  /**
-   * Sends a network request that is aware of payload interfaces,
-   * lifecycle methods, configured edge domains, response structures, etc.
-   */
-  return ({
-    request,
-    runOnResponseCallbacks = noop,
-    runOnRequestFailureCallbacks = noop
-  }) => {
-    const onResponseCallbackAggregator = createCallbackAggregator();
-    onResponseCallbackAggregator.add(lifecycle.onResponse);
-    onResponseCallbackAggregator.add(runOnResponseCallbacks);
-    const onRequestFailureCallbackAggregator = createCallbackAggregator();
-    onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
-    onRequestFailureCallbackAggregator.add(runOnRequestFailureCallbacks);
-    return lifecycle.onBeforeRequest({
-      request,
-      onResponse: onResponseCallbackAggregator.add,
-      onRequestFailure: onRequestFailureCallbackAggregator.add
-    }).then(() => {
-      const endpointDomain = hasDemdexFailed || !request.getUseIdThirdPartyDomain() ? edgeDomain : ID_THIRD_PARTY_DOMAIN;
-      const url = buildEndpointUrl(endpointDomain, request);
-      const payload = request.getPayload();
-      cookieTransfer.cookiesToPayload(payload, endpointDomain);
-      return sendNetworkRequest({
-        requestId: request.getId(),
-        url,
-        payload,
-        useSendBeacon: request.getUseSendBeacon()
-      });
-    }).then(networkResponse => {
-      processWarningsAndErrors(networkResponse);
-      return networkResponse;
-    }).catch(error => {
-      if (isDemdexBlockedError(error, request)) {
-        hasDemdexFailed = true;
-        request.setUseIdThirdPartyDomain(false);
-        const url = buildEndpointUrl(edgeDomain, request);
-        const payload = request.getPayload();
-        cookieTransfer.cookiesToPayload(payload, edgeDomain);
-        return sendNetworkRequest({
-          requestId: request.getId(),
-          url,
-          payload,
-          useSendBeacon: request.getUseSendBeacon()
-        });
-      }
-      return handleRequestFailure(onRequestFailureCallbackAggregator)(error);
-    }).then(({
-      parsedBody,
-      getHeader
-    }) => {
-      // Note that networkResponse.parsedBody may be undefined if it was a
-      // 204 No Content response. That's fine.
-      const response = createResponse({
-        content: parsedBody,
-        getHeader
-      });
-      cookieTransfer.responseToCookies(response);
-
-      // Notice we're calling the onResponse lifecycle method even if there are errors
-      // inside the response body. This is because the full request didn't actually fail--
-      // only portions of it that are considered non-fatal (a specific, non-critical
-      // Konductor plugin, for example).
-      return onResponseCallbackAggregator.call({
-        response
-      }).then(mergeLifecycleResponses);
-    });
-  };
-};

package/libEs6/core/edgeNetwork/mergeLifecycleResponses.js

@@ -1,21 +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 { assignConcatArrayValues } from "../../utils/index.js";
-export default returnValues => {
-  // Merges all returned objects from all `onResponse` callbacks into
-  // a single object that can later be returned to the customer.
-  const lifecycleOnResponseReturnValues = returnValues.shift() || [];
-  const consumerOnResponseReturnValues = returnValues.shift() || [];
-  const lifecycleOnBeforeRequestReturnValues = returnValues;
-  return assignConcatArrayValues({}, ...lifecycleOnResponseReturnValues, ...consumerOnResponseReturnValues, ...lifecycleOnBeforeRequestReturnValues);
-};

package/libEs6/core/getMonitors.js

@@ -1,31 +0,0 @@
-/*
-Copyright 2025 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.
-*/
-
-/* eslint-disable dot-notation */
-
-/** @import { AlloyMonitor } from './types.js' */
-
-/**
- * This factory function creates a getter that combines both provided monitors
- * and any monitors found in the global window.__alloyMonitors array.
- *
- * @param {Array<AlloyMonitor>} [monitors] - Optional array of monitor objects to append to the current one
- * @returns {Function} A function that when called, returns all available monitors
- */
-export default monitors => {
-  /** @type {Array<AlloyMonitor>} */
-  let alloyMonitors = window["__alloyMonitors"] || [];
-  if (monitors) {
-    alloyMonitors = alloyMonitors.concat(monitors);
-  }
-  return alloyMonitors;
-};