@adobe/alloy 2.31.1-beta.2 → 2.31.2-beta.0

package/libEs6/components/BrandConcierge/createStreamParser.js

@@ -1,138 +0,0 @@
-/*
-Copyright 2024 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 () => {
-  // SSE streams are always UTF-8 encoded per specification
-  const ENCODING = "utf-8";
-  // SSE spec allows three line ending styles: CRLF (\r\n), LF (\n), or CR (\r)
-  const LINE_ENDING_REGEX = /\r\n|\r|\n/;
-  // Events are separated by blank lines (double line endings)
-  const EVENT_SEPARATOR_REGEX = /\r\n\r\n|\n\n|\r\r/;
-  // Ping comment format: `: ping` (colon followed immediately by "ping")
-  const PING_COMMENT = ": ping";
-
-  /**
-   * Check if an event block is a ping comment.
-   * Ping comments are SSE comments in the format `:ping`
-   *
-   * @param {string} eventData - Raw event data
-   * @returns {boolean} - True if this is a ping comment
-   */
-  const isPingComment = eventData => {
-    const trimmed = eventData.trim();
-    return trimmed.startsWith(PING_COMMENT);
-  };
-
-  /**
-   * Parse a single SSE event from raw event data.
-   * Follows the Server-Sent Events specification (https://html.spec.whatwg.org/multipage/server-sent-events.html)
-   *
-   * @param {string} eventData - Raw event data (multi-line string containing SSE fields)
-   * @returns {Object|null} - Parsed SSE event with structure { type, data, id } or null if invalid
-   */
-  const parseEventFromBuffer = eventData => {
-    const lines = eventData.split(LINE_ENDING_REGEX);
-    const parsedEvent = {};
-    for (const line of lines) {
-      const trimmedLine = line.trim();
-      if (!trimmedLine) {
-        continue;
-      }
-      const colonIndex = trimmedLine.indexOf(":");
-      if (colonIndex === -1) {
-        continue;
-      }
-      const field = trimmedLine.substring(0, colonIndex).trim();
-      const value = trimmedLine.substring(colonIndex + 1).trim();
-      if (field === "data") {
-        parsedEvent.data = (parsedEvent.data || "") + value;
-      } else if (field === "event") {
-        parsedEvent.type = value;
-      } else if (field === "id") {
-        parsedEvent.id = value;
-      }
-    }
-    return parsedEvent.data ? parsedEvent : null;
-  };
-
-  /**
-   * Parse SSE stream using callbacks.
-   * Uses ReadableStreamDefaultReader for cross-browser compatibility (Safari 11+, Firefox, Chrome).
-   *
-   * @param {ReadableStream} stream - The readable stream from fetch response
-   * @param {Object} callbacks - Callback functions for stream events
-   * @param {Function} callbacks.onEvent - Callback function called for each parsed event
-   * @param {Function} callbacks.onPing - Callback function called for ping comments
-   * @param {Function} callbacks.onComplete - Callback function called when stream ends
-   */
-  return async (stream, {
-    onEvent,
-    onPing,
-    onComplete
-  }) => {
-    const reader = stream.getReader();
-    const decoder = new TextDecoder(ENCODING);
-    let buffer = "";
-    try {
-      while (true) {
-        // eslint-disable-next-line no-await-in-loop
-        const {
-          done,
-          value
-        } = await reader.read();
-        if (done) {
-          break;
-        }
-        buffer += decoder.decode(value, {
-          stream: true
-        });
-        const events = buffer.split(EVENT_SEPARATOR_REGEX);
-        buffer = events.pop() || "";
-        for (const event of events) {
-          const trimmedEvent = event.trim();
-          if (!trimmedEvent) {
-            continue;
-          }
-          if (isPingComment(trimmedEvent)) {
-            onPing();
-            continue;
-          }
-          const parsedEvent = parseEventFromBuffer(trimmedEvent);
-          if (parsedEvent !== null) {
-            onEvent(parsedEvent);
-          }
-        }
-      }
-      const trimmedBuffer = buffer.trim();
-      if (!trimmedBuffer) {
-        onComplete();
-        return;
-      }
-      if (isPingComment(trimmedBuffer)) {
-        onPing();
-        onComplete();
-        return;
-      }
-      const event = parseEventFromBuffer(trimmedBuffer);
-      if (event !== null) {
-        onEvent(event);
-      }
-      onComplete();
-    } catch (error) {
-      onEvent({
-        error
-      });
-      onComplete();
-    } finally {
-      reader.releaseLock();
-    }
-  };
-};

package/libEs6/components/BrandConcierge/createTimeoutWrapper.js

@@ -1,76 +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.
-*/
-
-/**
- * Creates a wrapper around a callback that implements a rolling timeout.
- * The timeout resets on every data event or ping. If no activity occurs
- * within the timeout period, an error is passed to the callback.
- * After timeout fires, all subsequent calls are ignored.
- *
- * @param {Object} options - Configuration options
- * @param {Function} options.onStreamResponseCallback - The callback function to wrap
- * @param {number} options.streamTimeout - Timeout duration in milliseconds
- * @returns {Object} Object with onEvent, onPing, and onComplete handler functions
- */
-export default ({
-  onStreamResponseCallback,
-  streamTimeout
-}) => {
-  let timedOut = false;
-  let timeoutId;
-  const resetTimeout = () => {
-    clearTimeout(timeoutId);
-    timeoutId = setTimeout(() => {
-      timedOut = true;
-      onStreamResponseCallback({
-        error: {
-          message: `Stream timeout: No data received within ${streamTimeout / 1000} seconds`
-        }
-      });
-    }, streamTimeout);
-  };
-
-  // Start initial timeout
-  resetTimeout();
-  return {
-    /**
-     * Handle data events from the stream parser.
-     * Resets the timeout and forwards the event to the callback.
-     *
-     * @param {Object} event - The parsed SSE event
-     */
-    onEvent: event => {
-      if (timedOut) {
-        return;
-      }
-      resetTimeout();
-      onStreamResponseCallback(event);
-    },
-    /**
-     * Handle ping events from the stream parser.
-     * Resets the timeout but does not forward anything to the callback.
-     */
-    onPing: () => {
-      if (timedOut) {
-        return;
-      }
-      resetTimeout();
-    },
-    /**
-     * Handle stream completion.
-     * Clears the timeout since the stream has ended successfully.
-     */
-    onComplete: () => {
-      clearTimeout(timeoutId);
-    }
-  };
-};

package/libEs6/components/BrandConcierge/index.js

@@ -1,98 +0,0 @@
-/*
-Copyright 2024 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 validateMessage from "./validateMessage.js";
-import createSendConversationEvent from "./createSendConversationEvent.js";
-import createBuildEndpointUrl from "./createBuildEndpointUrl.js";
-import queryString from "@adobe/reactor-query-string";
-import { getNamespacedCookieName } from "../../utils/index.js";
-import { BC_SESSION_COOKIE_NAME } from "./constants.js";
-import createGetEcidFromCookie from "../../utils/createDecodeKndctrCookie.js";
-import createSendConversationServiceRequest from "./createSendConversationServiceRequest.js";
-import configValidators from "./configValidators.js";
-const createConciergeComponent = ({
-  loggingCookieJar,
-  logger,
-  eventManager,
-  consent,
-  instanceName,
-  sendEdgeNetworkRequest,
-  config,
-  lifecycle,
-  cookieTransfer,
-  createResponse,
-  apexDomain
-}) => {
-  const {
-    fetch
-  } = window;
-  if (!config.conversation.stickyConversationSession) {
-    loggingCookieJar.remove(getNamespacedCookieName(config.orgId, BC_SESSION_COOKIE_NAME), {
-      domain: apexDomain
-    });
-  }
-  const buildEndpointUrl = createBuildEndpointUrl({
-    queryString
-  });
-  const sendConversationServiceRequest = createSendConversationServiceRequest({
-    logger,
-    fetch,
-    config
-  });
-  const decodeKndctrCookie = createGetEcidFromCookie({
-    orgId: config.orgId,
-    cookieJar: loggingCookieJar,
-    logger
-  });
-  const sendConversationEvent = createSendConversationEvent({
-    loggingCookieJar,
-    logger,
-    eventManager,
-    consent,
-    instanceName,
-    sendEdgeNetworkRequest,
-    config,
-    buildEndpointUrl,
-    lifecycle,
-    cookieTransfer,
-    createResponse,
-    sendConversationServiceRequest,
-    decodeKndctrCookie
-  });
-  return {
-    lifecycle: {
-      onBeforeEvent({
-        event
-      }) {
-        const parsedParams = queryString.parse(window.location.search);
-        if (parsedParams.source) {
-          const source = parsedParams.source;
-          event.mergeXdm({
-            channel: {
-              referringSource: source
-            }
-          });
-        }
-      }
-    },
-    commands: {
-      sendConversationEvent: {
-        optionsValidator: options => validateMessage({
-          options
-        }),
-        run: sendConversationEvent
-      }
-    }
-  };
-};
-createConciergeComponent.namespace = "BrandConcierge";
-createConciergeComponent.configValidators = configValidators;
-export default createConciergeComponent;

package/libEs6/components/BrandConcierge/utils.js

@@ -1,27 +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.
-*/
-import { getNamespacedCookieName, createGetPageLocation } from "../../utils/index.js";
-import { buildPageSurface } from "../../utils/surfaceUtils.js";
-import { BC_SESSION_COOKIE_NAME } from "./constants.js";
-export const getPageSurface = () => {
-  const pageLocation = createGetPageLocation({
-    window: window
-  });
-  return buildPageSurface(pageLocation);
-};
-export const getConciergeSessionCookie = ({
-  loggingCookieJar,
-  config
-}) => {
-  const cookieName = getNamespacedCookieName(config.orgId, BC_SESSION_COOKIE_NAME);
-  return loggingCookieJar.get(cookieName);
-};

package/libEs6/components/BrandConcierge/validateMessage.js

@@ -1,40 +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.
-*/
-import { anyOf, arrayOf, objectOf, string, callback } from "../../utils/validation/index.js";
-import { noop } from "../../utils/index.js";
-export default ({
-  options
-}) => {
-  const brandConciergeEventValidator = anyOf([objectOf({
-    message: string().required(),
-    onStreamResponse: callback().default(noop)
-  }), objectOf({
-    xdm: objectOf({
-      interactionId: string(),
-      conversationId: string(),
-      conversation: objectOf({
-        feedback: objectOf({
-          classification: string(),
-          comment: string(),
-          reasons: arrayOf(string())
-        })
-      })
-    })
-  }).required(), objectOf({
-    data: objectOf({
-      type: string().required(),
-      payload: objectOf({})
-    }).required(),
-    onStreamResponse: callback().default(noop)
-  })]);
-  return brandConciergeEventValidator(options);
-};

package/libEs6/components/Consent/computeConsentHash.js

@@ -1,14 +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 { fnv1a32Hex, sortObjectKeysRecursively } from "../../utils/index.js";
-export default obj => fnv1a32Hex(JSON.stringify(sortObjectKeysRecursively(obj)));

package/libEs6/components/Consent/configValidators.js

@@ -1,16 +0,0 @@
-/*
-Copyright 2024 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 { IN, OUT, PENDING } from "../../constants/consentStatus.js";
-import { objectOf, enumOf } from "../../utils/validation/index.js";
-export default objectOf({
-  defaultConsent: enumOf(IN, OUT, PENDING).default(IN)
-});

package/libEs6/components/Consent/createComponent.js

@@ -1,85 +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 { GENERAL } from "../../constants/consentPurpose.js";
-export default ({
-  storedConsent,
-  taskQueue,
-  defaultConsent,
-  consent,
-  sendSetConsentRequest,
-  validateSetConsentOptions,
-  consentHashStore,
-  doesIdentityCookieExist
-}) => {
-  const defaultConsentByPurpose = {
-    [GENERAL]: defaultConsent
-  };
-  let storedConsentByPurpose = storedConsent.read();
-  const identityCookieExists = doesIdentityCookieExist();
-  const consentCookieExists = storedConsentByPurpose[GENERAL] !== undefined;
-  if (!identityCookieExists || !consentCookieExists) {
-    consentHashStore.clear();
-  }
-  // If the identity cookie is gone, remove the consent cookie because the
-  // consent info is tied to the identity.
-  if (!identityCookieExists) {
-    storedConsent.clear();
-    storedConsentByPurpose = {};
-  }
-  consent.initializeConsent(defaultConsentByPurpose, storedConsentByPurpose);
-  const readCookieIfQueueEmpty = () => {
-    if (taskQueue.length === 0) {
-      const storedConsentObject = storedConsent.read();
-      // Only read cookies when there are no outstanding setConsent
-      // requests. This helps with race conditions.
-      if (storedConsentObject[GENERAL] !== undefined) {
-        consent.setConsent(storedConsentObject);
-      }
-    }
-  };
-  return {
-    commands: {
-      setConsent: {
-        optionsValidator: validateSetConsentOptions,
-        run: ({
-          consent: consentOptions,
-          identityMap,
-          edgeConfigOverrides
-        }) => {
-          consent.suspend();
-          const consentHashes = consentHashStore.lookup(consentOptions);
-          return taskQueue.addTask(() => {
-            if (consentHashes.isNew()) {
-              return sendSetConsentRequest({
-                consentOptions,
-                identityMap,
-                edgeConfigOverrides
-              });
-            }
-            return Promise.resolve();
-          }).then(() => consentHashes.save()).finally(readCookieIfQueueEmpty);
-        }
-      }
-    },
-    lifecycle: {
-      // Read the cookie here too because the consent cookie may change on any request
-      onResponse: readCookieIfQueueEmpty,
-      // Even when we get a failure HTTP status code, the consent cookie can
-      // still get updated. This could happen, for example, if the user is
-      // opted out in AudienceManager, but no consent cookie exists on the
-      // client. The request will be sent and the server will respond with a
-      // 403 Forbidden and a consent cookie.
-      onRequestFailure: readCookieIfQueueEmpty
-    }
-  };
-};

package/libEs6/components/Consent/createConsentHashStore.js

@@ -1,57 +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 computeConsentHash from "./computeConsentHash.js";
-const getKey = ({
-  standard,
-  version
-}) => {
-  return `${standard}.${version}`;
-};
-export default ({
-  storage
-}) => {
-  return {
-    clear() {
-      storage.clear();
-    },
-    lookup(consentObjects) {
-      const currentHashes = {};
-      const getCurrentHash = consentObject => {
-        const key = getKey(consentObject);
-        const {
-          standard,
-          version,
-          ...rest
-        } = consentObject;
-        if (!currentHashes[key]) {
-          currentHashes[key] = computeConsentHash(rest).toString();
-        }
-        return currentHashes[key];
-      };
-      return {
-        isNew() {
-          return consentObjects.some(consentObject => {
-            const key = getKey(consentObject);
-            const previousHash = storage.getItem(key);
-            return previousHash === null || previousHash !== getCurrentHash(consentObject);
-          });
-        },
-        save() {
-          consentObjects.forEach(consentObject => {
-            const key = getKey(consentObject);
-            storage.setItem(key, getCurrentHash(consentObject));
-          });
-        }
-      };
-    }
-  };
-};

package/libEs6/components/Consent/createConsentRequest.js

@@ -1,28 +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 { createRequest } from "../../utils/request/index.js";
-export default ({
-  payload,
-  datastreamIdOverride
-}) => {
-  return createRequest({
-    payload,
-    datastreamIdOverride,
-    getAction() {
-      return "privacy/set-consent";
-    },
-    getUseSendBeacon() {
-      return false;
-    }
-  });
-};

package/libEs6/components/Consent/createConsentRequestPayload.js

@@ -1,44 +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 { ConsentRequestPayload } from './types.js' */
-
-import { createRequestPayload } from "../../utils/request/index.js";
-
-/**
- * @function
- *
- * @returns {ConsentRequestPayload}
- */
-export default () => {
-  const content = {};
-  const requestPayload = createRequestPayload({
-    content,
-    addIdentity: (namespaceCode, identity) => {
-      content.identityMap = content.identityMap || {};
-      content.identityMap[namespaceCode] = content.identityMap[namespaceCode] || [];
-      content.identityMap[namespaceCode].push(identity);
-    },
-    hasIdentity: namespaceCode => {
-      return (content.identityMap && content.identityMap[namespaceCode]) !== undefined;
-    }
-  });
-
-  /** @type {ConsentRequestPayload} */
-  const payload = {
-    ...requestPayload,
-    setConsent: consent => {
-      content.consent = consent;
-    }
-  };
-  return payload;
-};

package/libEs6/components/Consent/createStoredConsent.js

@@ -1,30 +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 { getNamespacedCookieName } from "../../utils/index.js";
-import { CONSENT } from "../../constants/cookieNameKey.js";
-export default ({
-  parseConsentCookie,
-  orgId,
-  cookieJar
-}) => {
-  const consentCookieName = getNamespacedCookieName(orgId, CONSENT);
-  return {
-    read() {
-      const cookieValue = cookieJar.get(consentCookieName);
-      return cookieValue ? parseConsentCookie(cookieValue) : {};
-    },
-    clear() {
-      cookieJar.remove(consentCookieName);
-    }
-  };
-};