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

package/libEs5/core/consent/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /**
  * @typedef {Object} ConsentStateMachine
  * @property {function(string): void} in

package/libEs5/core/createEvent.js

@@ -153,6 +153,9 @@ var _default = () => {
       }
       return userXdm.web.webPageDetails.viewName;
     },
+    getUserIdentityMap() {
+      return userXdm?.identityMap;
+    },
     toJSON() {
       if (!isFinalized) {
         throw new Error("toJSON called before finalize");

package/libEs5/core/edgeNetwork/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /** @import { Request } from '../../utils/request/types.js' */
 
 /**

package/libEs5/core/identity/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /** @import { Logger } from '../../core/types.js' */
 /** @import { CookieJar } from '../../utils/types.js' */
 

package/libEs5/core/index.js

@@ -184,6 +184,8 @@ const createExecuteCommand = ({
       getImmediatelyAvailableTools(componentName) {
         const componentLogger = createComponentLogger(componentName);
         return {
+          loggingCookieJar,
+          instanceName,
           config,
           componentRegistry,
           consent,
@@ -199,7 +201,9 @@ const createExecuteCommand = ({
           }),
           createNamespacedStorage,
           apexDomain,
-          getBrowser
+          getBrowser,
+          cookieTransfer,
+          createResponse
         };
       }
     });

package/libEs5/core/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /**
  * @typedef {object} AlloyMonitor
  * @property {function(any): void} [onBeforeLog]

package/libEs5/utils/createCollect.js

@@ -26,11 +26,13 @@ var _default = ({
     documentMayUnload = false,
     eventType = _eventType.DISPLAY,
     propositionEventTypes = [(0, _propositionEventType.getPropositionEventType)(eventType)],
-    viewName
+    viewName,
+    identityMap
   }) => {
     const event = eventManager.createEvent();
     const data = {
-      eventType
+      eventType,
+      identityMap
     };
     if (viewName) {
       data.web = {

package/libEs5/utils/deepAssign.js

@@ -15,8 +15,13 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+// Keys that should never be copied to prevent prototype pollution.
+const DANGEROUS_KEYS = ["__proto__", "constructor", "prototype"];
 const deepAssignObject = (target, source) => {
   Object.keys(source).forEach(key => {
+    if (DANGEROUS_KEYS.includes(key)) {
+      return;
+    }
     if ((0, _isObject.default)(target[key]) && (0, _isObject.default)(source[key])) {
       deepAssignObject(target[key], source[key]);
       return;

package/libEs5/utils/dom/createGetPageLocation.js

@@ -0,0 +1,20 @@
+"use strict";
+
+exports.default = void 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.
+*/
+var _default = ({
+  window
+}) => () => {
+  return window.location;
+};
+exports.default = _default;

package/libEs5/utils/index.js

@@ -36,6 +36,12 @@ Object.defineProperty(exports, "createCallbackAggregator", {
     return _createCallbackAggregator.default;
   }
 });
+Object.defineProperty(exports, "createGetPageLocation", {
+  enumerable: true,
+  get: function () {
+    return _createGetPageLocation.default;
+  }
+});
 Object.defineProperty(exports, "createLoggingCookieJar", {
   enumerable: true,
   get: function () {
@@ -362,4 +368,5 @@ var _toISOStringLocal = require("./toISOStringLocal.js");
 var _uuid = require("./uuid.js");
 var _updateErrorMessage = require("./updateErrorMessage.js");
 var _validateIdentityMap = require("./validateIdentityMap.js");
-var _validateConfigOverride = require("./validateConfigOverride.js");
+var _validateConfigOverride = require("./validateConfigOverride.js");
+var _createGetPageLocation = require("./dom/createGetPageLocation.js");

package/libEs5/utils/request/createRequest.js

@@ -47,7 +47,8 @@ var _default = options => {
     getAction,
     getUseSendBeacon,
     datastreamIdOverride,
-    edgeSubPath
+    edgeSubPath,
+    requestParams = {}
   } = options;
   const id = (0, _index.uuid)();
   let shouldUseThirdPartyDomain = false;
@@ -86,6 +87,9 @@ var _default = options => {
     },
     setIsIdentityEstablished() {
       isIdentityEstablished = true;
+    },
+    getRequestParams() {
+      return requestParams;
     }
   };
 };

package/libEs5/utils/request/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /**
  * Request object with methods to access and modify request properties.
  *

package/libEs5/utils/surfaceUtils.js

@@ -0,0 +1,82 @@
+"use strict";
+
+exports.normalizeSurfaces = exports.isPageWideSurface = exports.buildPageSurface = void 0;
+var _surface = require("../constants/surface.js");
+var _index = require("./index.js");
+/*
+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.
+*/
+
+const SURFACE_REGEX = /^(\w+):\/\/([^/#]+)(\/[^#]*)?(#.*)?$/;
+const AUTHORITY_REGEX = /^(?:.*@)?(?:[a-z\d\u00a1-\uffff.-]+|\[[a-f\d:]+])(?::\d+)?$/;
+const PATH_REGEX = /^\/(?:[/\w\u00a1-\uffff-.~]|%[a-fA-F\d]{2})*$/;
+const FRAGMENT_REGEX = /^#(?:[/\w\u00a1-\uffff-.~]|%[a-fA-F\d]{2})+$/;
+const normalizePath = (path = "/") => {
+  let end = path.length;
+  while (end > 0 && "/".indexOf(path.charAt(end - 1)) !== -1) {
+    end -= 1;
+  }
+  return path.substring(0, end) || "/";
+};
+const getSurfaceType = surfaceTypeMatch => (0, _index.isNonEmptyString)(surfaceTypeMatch) ? surfaceTypeMatch.toLowerCase() : "";
+const getAuthority = authorityMatch => (0, _index.isNonEmptyString)(authorityMatch) ? authorityMatch.toLowerCase() : "";
+const getPath = pathMatch => (0, _index.isNonEmptyString)(pathMatch) ? normalizePath(pathMatch) : "/";
+const parseSurface = surfaceString => {
+  const matched = surfaceString.match(SURFACE_REGEX);
+  return matched ? {
+    surfaceType: getSurfaceType(matched[1]),
+    authority: getAuthority(matched[2]),
+    path: getPath(matched[3]),
+    fragment: matched[4]
+  } : null;
+};
+const stringifySurface = surface => "" + surface.surfaceType + _surface.SURFACE_TYPE_DELIMITER + surface.authority + (surface.path || "") + (surface.fragment || "");
+const buildPageSurface = getPageLocation => {
+  const location = getPageLocation();
+  const host = location.host.toLowerCase();
+  const path = location.pathname;
+  return _surface.WEB + _surface.SURFACE_TYPE_DELIMITER + host + normalizePath(path);
+};
+exports.buildPageSurface = buildPageSurface;
+const expandFragmentSurface = (surface, getPageLocation) => surface.startsWith(_surface.FRAGMENT_DELIMITER) ? buildPageSurface(getPageLocation) + surface : surface;
+const validateSurface = (surface, getPageLocation, logger) => {
+  const invalidateSurface = validationError => {
+    logger.warn(validationError);
+    return null;
+  };
+  if (!(0, _index.isNonEmptyString)(surface)) {
+    return invalidateSurface("Invalid surface: " + surface);
+  }
+  const expanded = expandFragmentSurface(surface, getPageLocation);
+  const parsed = parseSurface(expanded);
+  if (parsed === null) {
+    return invalidateSurface("Invalid surface: " + surface);
+  }
+  if (![_surface.WEB, _surface.WEBAPP].includes(parsed.surfaceType)) {
+    return invalidateSurface("Unsupported surface type " + parsed.surfaceType + " in surface: " + surface);
+  }
+  if (!parsed.authority || !AUTHORITY_REGEX.test(parsed.authority)) {
+    return invalidateSurface("Invalid authority " + parsed.authority + " in surface: " + surface);
+  }
+  if (parsed.path && !PATH_REGEX.test(parsed.path)) {
+    return invalidateSurface("Invalid path " + parsed.path + " in surface: " + surface);
+  }
+  if (parsed.fragment && !FRAGMENT_REGEX.test(parsed.fragment)) {
+    return invalidateSurface("Invalid fragment " + parsed.fragment + " in surface: " + surface);
+  }
+  return parsed;
+};
+const isPageWideSurface = scope => !!scope && scope.indexOf(_surface.WEB + _surface.SURFACE_TYPE_DELIMITER) === 0 && scope.indexOf(_surface.FRAGMENT_DELIMITER) === -1;
+
+// eslint-disable-next-line default-param-last
+exports.isPageWideSurface = isPageWideSurface;
+const normalizeSurfaces = (surfaces = [], getPageLocation, logger) => surfaces.map(surface => validateSurface(surface, getPageLocation, logger)).filter(surface => !(0, _index.isNil)(surface)).map(stringifySurface);
+exports.normalizeSurfaces = normalizeSurfaces;

package/libEs5/utils/types.js

@@ -1,6 +1,18 @@
 "use strict";
 
 exports.Types = 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.
+*/
+
 /**
  * @typedef {Object} Storage
  * @property {function(string): string|null} getItem

package/libEs5/utils/uuid.js

@@ -13,4 +13,5 @@ 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.
 */
+// eslint-disable-next-line import/no-unresolved
 var _default = exports.default = _uuid.v4;

package/libEs6/components/Advertising/handlers/onBeforeSendEventHandler.js

@@ -1,7 +1,13 @@
 /*
 Copyright 2023 Adobe. All rights reserved.
-Licensed under the Apache License, Version 2.0.
-http://www.apache.org/licenses/LICENSE-2.0
+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 collectSurferId from "../identities/collectSurferId.js";

package/libEs6/components/Advertising/handlers/viewThroughHandler.js

@@ -1,7 +1,13 @@
 /*
 Copyright 2025 Adobe. All rights reserved.
-Licensed under the Apache License, Version 2.0.
-http://www.apache.org/licenses/LICENSE-2.0
+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 collectAllIdentities from "../identities/collectAllIdentities.js";

package/libEs6/components/Advertising/identities/collectSurferId.js

@@ -1,6 +1,13 @@
 /*
 Copyright 2025 Adobe. All rights reserved.
-This file is licensed under the Apache License, Version 2.0.
+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 { DISPLAY_CLICK_COOKIE_KEY, SURFER_ID, SURFER_PIXEL_HOST, SURFER_USER_ID, SURFER_TIMEOUT_MS, SURFER_TRUSTED_ORIGIN, SURFER_PARAM_KEY, DISPLAY_CLICK_COOKIE_KEY_EXPIRES } from "../constants/index.js";

package/libEs6/components/BrandConcierge/constants.js

@@ -0,0 +1,13 @@
+/*
+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 const BC_SESSION_COOKIE_NAME = "bc_session_id";
+export const STREAM_START_TIMEOUT_MS = 10000;

package/libEs6/components/BrandConcierge/createBuildEndpointUrl.js

@@ -0,0 +1,30 @@
+/*
+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 ({
+  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}`;
+  };
+};

package/libEs6/components/BrandConcierge/createConversationServiceRequest.js

@@ -0,0 +1,31 @@
+/*
+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 { createRequest } from "../../utils/request/index.js";
+export default ({
+  payload,
+  action = "conversations",
+  sessionId
+}) => {
+  return createRequest({
+    payload: payload,
+    edgeSubPath: "/brand-concierge",
+    requestParams: {
+      sessionId
+    },
+    getAction() {
+      return action;
+    },
+    getUseSendBeacon() {
+      return false;
+    }
+  });
+};

package/libEs6/components/BrandConcierge/createSendConversationEvent.js

@@ -0,0 +1,142 @@
+/*
+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 { createDataCollectionRequestPayload } from "../../utils/request/index.js";
+import createConversationServiceRequest from "./createConversationServiceRequest.js";
+import { getConciergeSessionCookie, getPageSurface } from "./utils.js";
+import uuid from "../../utils/uuid.js";
+import createStreamParser from "./createStreamParser.js";
+import createTimeoutWrapper from "./createTimeoutWrapper.js";
+export default ({
+  eventManager,
+  loggingCookieJar,
+  config,
+  logger,
+  sendConversationServiceRequest,
+  buildEndpointUrl,
+  cookieTransfer,
+  createResponse,
+  decodeKndctrCookie,
+  lifecycle,
+  consent
+}) => {
+  const {
+    edgeDomain,
+    edgeBasePath,
+    datastreamId,
+    onBeforeEventSend
+  } = config;
+  return options => {
+    let streamingEnabled = false;
+    const {
+      message,
+      onStreamResponse,
+      xdm,
+      data
+    } = options;
+    const sessionId = getConciergeSessionCookie({
+      loggingCookieJar,
+      config
+    }) || uuid();
+    const payload = createDataCollectionRequestPayload();
+    const request = createConversationServiceRequest({
+      payload,
+      sessionId: sessionId
+    });
+    const event = eventManager.createEvent();
+    if (message || data) {
+      const pageSurface = getPageSurface();
+      event.mergeQuery({
+        conversation: {
+          surfaces: [pageSurface],
+          message,
+          data
+        }
+      });
+    }
+    const {
+      state
+    } = consent.current();
+    event.mergeMeta({
+      consent: {
+        state: state
+      }
+    });
+    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: uuid(),
+        url,
+        request,
+        onStreamResponse,
+        streamingEnabled
+      }).then(response => {
+        if (response.status === 204) {
+          return;
+        }
+        const onStreamResponseCallback = event => {
+          if (event.error) {
+            logger.error("Stream error occurred", 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 wrappedCallback = createTimeoutWrapper({
+          onStreamResponseCallback
+        });
+        const streamParser = createStreamParser();
+        streamParser(response.body, wrappedCallback);
+      });
+    });
+  };
+};