@adobe/alloy 2.30.1-beta.2 → 2.30.1-beta.21

package/libEs6/components/BrandConcierge/createSendConversationServiceRequest.js

@@ -0,0 +1,81 @@
+/*
+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 { stackError } from "../../utils/index.js";
+export default ({
+  logger,
+  fetch
+}) => {
+  return async ({
+    requestId,
+    url,
+    request,
+    streamingEnabled = true
+  }) => {
+    const payload = request.getPayload();
+    const stringifiedPayload = JSON.stringify(payload);
+    const parsedPayload = JSON.parse(stringifiedPayload);
+    const headers = {
+      "Content-Type": "text/plain"
+    };
+    if (streamingEnabled) {
+      headers.Accept = "text/event-stream";
+    } else {
+      headers.Accept = "text/plain";
+    }
+    logger.logOnBeforeNetworkRequest({
+      url,
+      requestId,
+      payload: parsedPayload
+    });
+    const fetchWithRetries = async (attemptNumber = 1) => {
+      const maxAttempts = 4;
+      const retryDelays = [2000, 3000, 5000];
+      try {
+        const response = await fetch(url, {
+          method: "POST",
+          headers: headers,
+          body: stringifiedPayload
+        });
+        if (!response.ok) {
+          throw new Error(`Request failed with status ${response.status}`);
+        }
+        return response;
+      } catch (error) {
+        if (attemptNumber < maxAttempts) {
+          const delay = retryDelays[attemptNumber - 1];
+          logger.logOnNetworkError({
+            requestId,
+            url,
+            payload: parsedPayload,
+            error: new Error(`Attempt ${attemptNumber} failed, retrying in ${delay}ms: ${error.message}`)
+          });
+          await new Promise(resolve => setTimeout(resolve, delay));
+          return fetchWithRetries(attemptNumber + 1);
+        }
+        logger.logOnNetworkError({
+          requestId,
+          url,
+          payload: parsedPayload,
+          error
+        });
+        throw stackError({
+          error,
+          message: "Network request failed after all retries."
+        });
+      }
+    };
+    const executeRequest = async () => {
+      return fetchWithRetries();
+    };
+    return executeRequest();
+  };
+};

package/libEs6/components/BrandConcierge/createStreamParser.js

@@ -0,0 +1,92 @@
+/*
+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/;
+
+  /**
+   * 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 modern async iteration (for await...of) for clean, performant stream processing.
+   *
+   * @param {ReadableStream} stream - The readable stream from fetch response
+   * @param {Function} onEvent - Callback function called for each parsed event
+   */
+  return async (stream, onEvent) => {
+    const decoder = new TextDecoder(ENCODING);
+    let buffer = "";
+    try {
+      for await (const chunk of stream) {
+        buffer += decoder.decode(chunk, {
+          stream: true
+        });
+        const events = buffer.split(EVENT_SEPARATOR_REGEX);
+        buffer = events.pop() || "";
+        for (const eventData of events) {
+          const trimmedEvent = eventData.trim();
+          if (trimmedEvent) {
+            const event = parseEventFromBuffer(trimmedEvent);
+            if (event !== null) {
+              onEvent(event);
+            }
+          }
+        }
+      }
+      const trimmedBuffer = buffer.trim();
+      if (trimmedBuffer) {
+        const event = parseEventFromBuffer(trimmedBuffer);
+        if (event !== null) {
+          onEvent(event);
+        }
+      }
+    } catch (error) {
+      onEvent({
+        error
+      });
+    }
+  };
+};

package/libEs6/components/BrandConcierge/createTimeoutWrapper.js

@@ -0,0 +1,49 @@
+/*
+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 { STREAM_START_TIMEOUT_MS } from "./constants.js";
+
+/**
+ * Creates a wrapper around a callback that implements a timeout for the first call.
+ * If the callback is not invoked within the specified timeout, an error is passed to it.
+ * After timeout fires, all subsequent calls are ignored.
+ *
+ * @param {Function} callback - The callback function to wrap
+ * @returns {Function} Wrapped callback function
+ */
+export default ({
+  onStreamResponseCallback
+}) => {
+  const timeoutMs = STREAM_START_TIMEOUT_MS;
+  let firstCallMade = false;
+  let timedOut = false;
+  const timeoutId = setTimeout(() => {
+    // Double-check firstCallMade right before firing
+    if (!firstCallMade) {
+      timedOut = true;
+      onStreamResponseCallback({
+        error: {
+          message: "Stream timeout: No data received within 10 seconds"
+        }
+      });
+    }
+  }, timeoutMs);
+  return event => {
+    if (timedOut) {
+      return;
+    }
+    if (!firstCallMade) {
+      firstCallMade = true;
+      clearTimeout(timeoutId);
+    }
+    onStreamResponseCallback(event);
+  };
+};

package/libEs6/components/BrandConcierge/index.js

@@ -0,0 +1,100 @@
+/*
+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 { boolean, objectOf } from "../../utils/validation/index.js";
+import createGetEcidFromCookie from "../../utils/createDecodeKndctrCookie.js";
+import createSendConversationServiceRequest from "./createSendConversationServiceRequest.js";
+const createConciergeComponent = ({
+  loggingCookieJar,
+  logger,
+  eventManager,
+  consent,
+  instanceName,
+  sendEdgeNetworkRequest,
+  config,
+  lifecycle,
+  cookieTransfer,
+  createResponse,
+  apexDomain
+}) => {
+  const {
+    fetch
+  } = window;
+  if (!config.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 = objectOf({
+  stickyConversationSession: boolean().default(false)
+});
+export default createConciergeComponent;

package/libEs6/components/BrandConcierge/utils.js

@@ -0,0 +1,27 @@
+/*
+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

@@ -0,0 +1,37 @@
+/*
+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 } from "../../utils/validation/index.js";
+export default ({
+  options
+}) => {
+  const brandConciergeEventValidator = anyOf([objectOf({
+    message: string().required()
+  }), 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()
+  })]);
+  return brandConciergeEventValidator(options);
+};

package/libEs6/components/Consent/types.js

@@ -1,3 +1,15 @@
+/*
+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.
+*/
+
 /**
  * Request payload object with methods for merging different types of data.
  *

package/libEs6/components/Context/createComponent.js

@@ -24,8 +24,7 @@ export default (config, logger, optionalContexts, requiredContexts) => {
       onBeforeEvent({
         event
       }) {
-        const xdm = {};
-        return Promise.all(contexts.map(context => Promise.resolve(context(xdm, logger)))).then(() => event.mergeXdm(xdm));
+        return Promise.all(contexts.map(context => Promise.resolve(context(event, logger))));
       }
     }
   };

package/libEs6/components/Context/implementationDetails.js

@@ -9,16 +9,14 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { deepAssign } from "../../utils/index.js";
 import libraryName from "../../constants/libraryName.js";
 import libraryVersion from "../../constants/libraryVersion.js";
-export default xdm => {
-  const implementationDetails = {
-    name: libraryName,
-    version: libraryVersion,
-    environment: "browser"
-  };
-  deepAssign(xdm, {
-    implementationDetails
+export default event => {
+  event.mergeXdm({
+    implementationDetails: {
+      name: libraryName,
+      version: libraryVersion,
+      environment: "browser"
+    }
   });
 };

package/libEs6/components/Context/index.js

@@ -18,6 +18,7 @@ import injectTimestamp from "./injectTimestamp.js";
 import implementationDetails from "./implementationDetails.js";
 import createComponent from "./createComponent.js";
 import injectHighEntropyUserAgentHints from "./injectHighEntropyUserAgentHints.js";
+import injectOneTimeAnalyticsReferrer from "./injectOneTimeAnalyticsReferrer.js";
 import { arrayOf, objectOf, string } from "../../utils/validation/index.js";
 const web = injectWeb(window);
 const device = injectDevice(window);
@@ -25,6 +26,7 @@ const environment = injectEnvironment(window);
 const placeContext = injectPlaceContext(() => new Date());
 const timestamp = injectTimestamp(() => new Date());
 const highEntropyUserAgentHints = injectHighEntropyUserAgentHints(navigator);
+const oneTimeAnalyticsReferrer = injectOneTimeAnalyticsReferrer(window);
 const defaultEnabledContexts = {
   web,
   device,
@@ -32,7 +34,8 @@ const defaultEnabledContexts = {
   placeContext
 };
 const defaultDisabledContexts = {
-  highEntropyUserAgentHints
+  highEntropyUserAgentHints,
+  oneTimeAnalyticsReferrer
 };
 const optionalContexts = {
   ...defaultEnabledContexts,

package/libEs6/components/Context/injectDevice.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { deepAssign, isFunction, toInteger } from "../../utils/index.js";
+import { isFunction, toInteger } from "../../utils/index.js";
 const getScreenOrientationViaProperty = window => {
   const {
     screen: {
@@ -41,7 +41,7 @@ const getScreenOrientationViaMediaQuery = window => {
   return null;
 };
 export default window => {
-  return xdm => {
+  return event => {
     const {
       screen: {
         width,
@@ -62,7 +62,7 @@ export default window => {
       device.screenOrientation = orientation;
     }
     if (Object.keys(device).length > 0) {
-      deepAssign(xdm, {
+      event.mergeXdm({
         device
       });
     }

package/libEs6/components/Context/injectEnvironment.js

@@ -10,9 +10,9 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { deepAssign, toInteger } from "../../utils/index.js";
+import { toInteger } from "../../utils/index.js";
 export default window => {
-  return xdm => {
+  return event => {
     const {
       document: {
         documentElement: {
@@ -35,7 +35,7 @@ export default window => {
       environment.browserDetails = environment.browserDetails || {};
       environment.browserDetails.viewportHeight = viewportHeight;
     }
-    deepAssign(xdm, {
+    event.mergeXdm({
       environment
     });
   };

package/libEs6/components/Context/injectHighEntropyUserAgentHints.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { deepAssign, noop } from "../../utils/index.js";
+import { noop } from "../../utils/index.js";
 import highEntropyUserAgentHints from "../../constants/highEntropyUserAgentClientHints.js";
 const browserSupportsUserAgentClientHints = navigator => {
   return "userAgentData" in navigator;
@@ -19,7 +19,7 @@ export default navigator => {
   if (!browserSupportsUserAgentClientHints(navigator)) {
     return noop;
   }
-  return (xdm, logger) => {
+  return (event, logger) => {
     try {
       // eslint-disable-next-line compat/compat -- userAgentData support is checked before calling
       return navigator.userAgentData.getHighEntropyValues(highEntropyUserAgentHints.map(hint => hint[0])).then(hints => {
@@ -30,7 +30,7 @@ export default navigator => {
             userAgentClientHints[hintName] = hints[hintName];
           }
         });
-        deepAssign(xdm, {
+        event.mergeXdm({
           environment: {
             browserDetails: {
               userAgentClientHints

package/libEs6/components/Context/injectOneTimeAnalyticsReferrer.js

@@ -0,0 +1,46 @@
+/*
+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.
+*/
+
+export default window => {
+  let lastReferrerSent = null;
+  return event => {
+    const content = event.getContent();
+    const eventType = content.xdm?.eventType;
+    if (eventType === "decisioning.propositionFetch") {
+      return;
+    }
+
+    // Allow customers to explicitly set the referrer (for SPA view changes)
+    // Otherwise, use document.referrer
+    // eslint-disable-next-line no-underscore-dangle
+    const explicitReferrer = content.data?.__adobe?.analytics?.referrer;
+    const currentReferrer = explicitReferrer !== undefined ? explicitReferrer : window.document.referrer;
+    if (currentReferrer === lastReferrerSent) {
+      event.mergeData({
+        __adobe: {
+          analytics: {
+            referrer: ""
+          }
+        }
+      });
+      return;
+    }
+    event.mergeData({
+      __adobe: {
+        analytics: {
+          referrer: currentReferrer
+        }
+      }
+    });
+    lastReferrerSent = currentReferrer;
+  };
+};

package/libEs6/components/Context/injectPlaceContext.js

@@ -9,9 +9,9 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { deepAssign, toISOStringLocal, toInteger } from "../../utils/index.js";
+import { toISOStringLocal, toInteger } from "../../utils/index.js";
 export default dateProvider => {
-  return xdm => {
+  return event => {
     const date = dateProvider();
     const placeContext = {};
     const localTimezoneOffset = toInteger(date.getTimezoneOffset());
@@ -22,7 +22,7 @@ export default dateProvider => {
     if (localTimezoneOffset === undefined || Math.abs(localTimezoneOffset) < 6000) {
       placeContext.localTime = toISOStringLocal(date);
     }
-    deepAssign(xdm, {
+    event.mergeXdm({
       placeContext
     });
   };

package/libEs6/components/Context/injectTimestamp.js

@@ -10,11 +10,10 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { deepAssign } from "../../utils/index.js";
 export default dateProvider => {
-  return xdm => {
+  return event => {
     const timestamp = dateProvider().toISOString();
-    deepAssign(xdm, {
+    event.mergeXdm({
       timestamp
     });
   };

package/libEs6/components/Context/injectWeb.js

@@ -10,19 +10,17 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { deepAssign } from "../../utils/index.js";
 export default window => {
-  return xdm => {
-    const web = {
-      webPageDetails: {
-        URL: window.location.href || window.location
-      },
-      webReferrer: {
-        URL: window.document.referrer
+  return event => {
+    event.mergeXdm({
+      web: {
+        webPageDetails: {
+          URL: window.location.href || window.location
+        },
+        webReferrer: {
+          URL: window.document.referrer
+        }
       }
-    };
-    deepAssign(xdm, {
-      web
     });
   };
 };

package/libEs6/components/EventMerge/createEventMergeId.js

@@ -1,5 +1,5 @@
 /*
-Copyright 20219 Adobe. All rights reserved.
+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