@adobe/alloy 2.30.1-beta.11 → 2.30.1-beta.13

package/libEs5/components/BrandConcierge/constants.js

@@ -0,0 +1,15 @@
+"use strict";
+
+exports.BC_SESSION_COOKIE_NAME = void 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.
+*/
+const BC_SESSION_COOKIE_NAME = exports.BC_SESSION_COOKIE_NAME = "bc_session_id";

package/libEs5/components/BrandConcierge/createBuildEndpointUrl.js

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.default = void 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.
+*/
+var _default = ({
+  queryString
+}) => {
+  return ({
+    edgeDomain,
+    request,
+    datastreamId
+  }) => {
+    const params = request.getRequestParams();
+    const configId = request.getDatastreamIdOverride() || datastreamId;
+    params.requestId = request.getId();
+    params.configId = configId;
+    const stringifiedRequestParams = queryString.stringify({
+      ...params
+    });
+    return "https://" + edgeDomain + request.getEdgeSubPath() + "/" + request.getAction() + "?" + stringifiedRequestParams;
+  };
+};
+exports.default = _default;

package/libEs5/components/BrandConcierge/createConversationServiceRequest.js

@@ -0,0 +1,35 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/request/index.js");
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var _default = ({
+  payload,
+  action = "conversations",
+  sessionId
+}) => {
+  return (0, _index.createRequest)({
+    payload: payload,
+    edgeSubPath: "/brand-concierge",
+    requestParams: {
+      sessionId
+    },
+    getAction() {
+      return action;
+    },
+    getUseSendBeacon() {
+      return false;
+    }
+  });
+};
+exports.default = _default;

package/libEs5/components/BrandConcierge/createSendConversationEvent.js

@@ -0,0 +1,132 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/request/index.js");
+var _createConversationServiceRequest = require("./createConversationServiceRequest.js");
+var _utils = require("./utils.js");
+var _uuid = require("../../utils/uuid.js");
+var _createStreamParser = require("./createStreamParser.js");
+/*
+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.
+*/
+var _default = ({
+  eventManager,
+  loggingCookieJar,
+  config,
+  logger,
+  sendConversationServiceRequest,
+  buildEndpointUrl,
+  cookieTransfer,
+  createResponse,
+  decodeKndctrCookie,
+  lifecycle
+}) => {
+  const {
+    edgeDomain,
+    edgeBasePath,
+    datastreamId,
+    onBeforeEventSend
+  } = config;
+  return options => {
+    let streamingEnabled = false;
+    const {
+      message,
+      onStreamResponse,
+      xdm,
+      data
+    } = options;
+    const sessionId = (0, _utils.getConciergeSessionCookie)({
+      loggingCookieJar,
+      config
+    }) || (0, _uuid.default)();
+    const payload = (0, _index.createDataCollectionRequestPayload)();
+    const request = (0, _createConversationServiceRequest.default)({
+      payload,
+      sessionId: sessionId
+    });
+    const event = eventManager.createEvent();
+    if (message || data) {
+      const pageSurface = (0, _utils.getPageSurface)();
+      event.mergeQuery({
+        conversation: {
+          surfaces: [pageSurface],
+          message,
+          data
+        }
+      });
+    }
+    const ecid = decodeKndctrCookie();
+    event.mergeXdm({
+      identityMap: {
+        ECID: [{
+          id: ecid
+        }]
+      }
+    });
+    event.mergeXdm({
+      ...xdm
+    });
+    if (message || data) {
+      streamingEnabled = true;
+    }
+    const url = buildEndpointUrl({
+      edgeDomain,
+      edgeBasePath,
+      datastreamId,
+      request
+    });
+    return lifecycle.onBeforeEvent({
+      event
+    }).then(() => {
+      try {
+        // NOTE: this calls onBeforeEventSend callback (if configured)
+        event.finalize(onBeforeEventSend);
+      } catch (error) {
+        onStreamResponse({
+          error
+        });
+        throw error;
+      }
+      payload.addEvent(event);
+      cookieTransfer.cookiesToPayload(payload, edgeDomain);
+      return sendConversationServiceRequest({
+        requestId: (0, _uuid.default)(),
+        url,
+        request,
+        onStreamResponse,
+        streamingEnabled
+      }).then(response => {
+        if (response.status === 204) {
+          return;
+        }
+        const onStreamResponseCallback = event => {
+          if (event.error) {
+            onStreamResponse({
+              error: event.error
+            });
+            return;
+          }
+          const substr = event.data.replace("data: ", "");
+          const responseJson = JSON.parse(substr);
+          const response = createResponse({
+            content: responseJson
+          });
+          cookieTransfer.responseToCookies(response);
+          logger.info("onStreamResponse callback called with", response.getPayloadsByType("brand-concierge:conversation"));
+          onStreamResponse(response.getPayloadsByType("brand-concierge:conversation"));
+        };
+        const streamParser = (0, _createStreamParser.default)();
+        streamParser(response.body, onStreamResponseCallback);
+      });
+    });
+  };
+};
+exports.default = _default;

package/libEs5/components/BrandConcierge/createSendConversationServiceRequest.js

@@ -0,0 +1,85 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+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.
+*/
+var _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 (0, _index.stackError)({
+          error,
+          message: "Network request failed after all retries."
+        });
+      }
+    };
+    const executeRequest = async () => {
+      return fetchWithRetries();
+    };
+    return executeRequest();
+  };
+};
+exports.default = _default;

package/libEs5/components/BrandConcierge/createStreamParser.js

@@ -0,0 +1,96 @@
+"use strict";
+
+exports.default = void 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.
+*/
+var _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
+      });
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/BrandConcierge/index.js

@@ -0,0 +1,104 @@
+"use strict";
+
+exports.default = void 0;
+var _validateMessage = require("./validateMessage.js");
+var _createSendConversationEvent = require("./createSendConversationEvent.js");
+var _createBuildEndpointUrl = require("./createBuildEndpointUrl.js");
+var _reactorQueryString = require("@adobe/reactor-query-string");
+var _index = require("../../utils/index.js");
+var _constants = require("./constants.js");
+var _index2 = require("../../utils/validation/index.js");
+var _createDecodeKndctrCookie = require("../../utils/createDecodeKndctrCookie.js");
+var _createSendConversationServiceRequest = require("./createSendConversationServiceRequest.js");
+/*
+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.
+*/
+
+const createConciergeComponent = ({
+  loggingCookieJar,
+  logger,
+  eventManager,
+  consent,
+  instanceName,
+  sendEdgeNetworkRequest,
+  config,
+  lifecycle,
+  cookieTransfer,
+  createResponse,
+  apexDomain
+}) => {
+  const {
+    fetch
+  } = window;
+  if (!config.stickyConversationSession) {
+    loggingCookieJar.remove((0, _index.getNamespacedCookieName)(config.orgId, _constants.BC_SESSION_COOKIE_NAME), {
+      domain: apexDomain
+    });
+  }
+  const buildEndpointUrl = (0, _createBuildEndpointUrl.default)({
+    queryString: _reactorQueryString.default
+  });
+  const sendConversationServiceRequest = (0, _createSendConversationServiceRequest.default)({
+    logger,
+    fetch,
+    config
+  });
+  const decodeKndctrCookie = (0, _createDecodeKndctrCookie.default)({
+    orgId: config.orgId,
+    cookieJar: loggingCookieJar,
+    logger
+  });
+  const sendConversationEvent = (0, _createSendConversationEvent.default)({
+    loggingCookieJar,
+    logger,
+    eventManager,
+    consent,
+    instanceName,
+    sendEdgeNetworkRequest,
+    config,
+    buildEndpointUrl,
+    lifecycle,
+    cookieTransfer,
+    createResponse,
+    sendConversationServiceRequest,
+    decodeKndctrCookie
+  });
+  return {
+    lifecycle: {
+      onBeforeEvent({
+        event
+      }) {
+        const parsedParams = _reactorQueryString.default.parse(window.location.search);
+        if (parsedParams.source) {
+          const source = parsedParams.source;
+          event.mergeXdm({
+            channel: {
+              referringSource: source
+            }
+          });
+        }
+      }
+    },
+    commands: {
+      sendConversationEvent: {
+        optionsValidator: options => (0, _validateMessage.default)({
+          options
+        }),
+        run: sendConversationEvent
+      }
+    }
+  };
+};
+createConciergeComponent.namespace = "BrandConcierge";
+createConciergeComponent.configValidators = (0, _index2.objectOf)({
+  stickyConversationSession: (0, _index2.boolean)().default(false)
+});
+var _default = exports.default = createConciergeComponent;

package/libEs5/components/BrandConcierge/utils.js

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.getPageSurface = exports.getConciergeSessionCookie = void 0;
+var _index = require("../../utils/index.js");
+var _surfaceUtils = require("../../utils/surfaceUtils.js");
+var _constants = require("./constants.js");
+/*
+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.
+*/
+
+const getPageSurface = () => {
+  const pageLocation = (0, _index.createGetPageLocation)({
+    window: window
+  });
+  return (0, _surfaceUtils.buildPageSurface)(pageLocation);
+};
+exports.getPageSurface = getPageSurface;
+const getConciergeSessionCookie = ({
+  loggingCookieJar,
+  config
+}) => {
+  const cookieName = (0, _index.getNamespacedCookieName)(config.orgId, _constants.BC_SESSION_COOKIE_NAME);
+  return loggingCookieJar.get(cookieName);
+};
+exports.getConciergeSessionCookie = getConciergeSessionCookie;

package/libEs5/components/BrandConcierge/validateMessage.js

@@ -0,0 +1,41 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/validation/index.js");
+/*
+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.
+*/
+var _default = ({
+  options
+}) => {
+  const brandConciergeEventValidator = (0, _index.anyOf)([(0, _index.objectOf)({
+    message: (0, _index.string)().required()
+  }), (0, _index.objectOf)({
+    xdm: (0, _index.objectOf)({
+      interactionId: (0, _index.string)(),
+      conversationId: (0, _index.string)(),
+      conversation: (0, _index.objectOf)({
+        feedback: (0, _index.objectOf)({
+          classification: (0, _index.string)(),
+          comment: (0, _index.string)(),
+          reasons: (0, _index.arrayOf)((0, _index.string)())
+        })
+      })
+    })
+  }).required(), (0, _index.objectOf)({
+    data: (0, _index.objectOf)({
+      type: (0, _index.string)().required(),
+      payload: (0, _index.objectOf)({})
+    }).required()
+  })]);
+  return brandConciergeEventValidator(options);
+};
+exports.default = _default;

package/libEs5/components/Context/createComponent.js

@@ -27,8 +27,7 @@ var _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/libEs5/components/Context/implementationDetails.js

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

package/libEs5/components/Context/index.js

@@ -9,6 +9,7 @@ var _injectTimestamp = require("./injectTimestamp.js");
 var _implementationDetails = require("./implementationDetails.js");
 var _createComponent = require("./createComponent.js");
 var _injectHighEntropyUserAgentHints = require("./injectHighEntropyUserAgentHints.js");
+var _injectOneTimeAnalyticsReferrer = require("./injectOneTimeAnalyticsReferrer.js");
 var _index = require("../../utils/validation/index.js");
 /*
 Copyright 2019 Adobe. All rights reserved.
@@ -28,6 +29,7 @@ const environment = (0, _injectEnvironment.default)(window);
 const placeContext = (0, _injectPlaceContext.default)(() => new Date());
 const timestamp = (0, _injectTimestamp.default)(() => new Date());
 const highEntropyUserAgentHints = (0, _injectHighEntropyUserAgentHints.default)(navigator);
+const oneTimeAnalyticsReferrer = (0, _injectOneTimeAnalyticsReferrer.default)(window);
 const defaultEnabledContexts = {
   web,
   device,
@@ -35,7 +37,8 @@ const defaultEnabledContexts = {
   placeContext
 };
 const defaultDisabledContexts = {
-  highEntropyUserAgentHints
+  highEntropyUserAgentHints,
+  oneTimeAnalyticsReferrer
 };
 const optionalContexts = {
   ...defaultEnabledContexts,

package/libEs5/components/Context/injectDevice.js

@@ -44,7 +44,7 @@ const getScreenOrientationViaMediaQuery = window => {
   return null;
 };
 var _default = window => {
-  return xdm => {
+  return event => {
     const {
       screen: {
         width,
@@ -65,7 +65,7 @@ var _default = window => {
       device.screenOrientation = orientation;
     }
     if (Object.keys(device).length > 0) {
-      (0, _index.deepAssign)(xdm, {
+      event.mergeXdm({
         device
       });
     }

package/libEs5/components/Context/injectEnvironment.js

@@ -14,7 +14,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 var _default = window => {
-  return xdm => {
+  return event => {
     const {
       document: {
         documentElement: {
@@ -37,7 +37,7 @@ var _default = window => {
       environment.browserDetails = environment.browserDetails || {};
       environment.browserDetails.viewportHeight = viewportHeight;
     }
-    (0, _index.deepAssign)(xdm, {
+    event.mergeXdm({
       environment
     });
   };