@adobe/alloy 2.29.0-beta.1 → 2.29.0-beta.14

package/libEs5/{components/Identity → utils}/createDecodeKndctrCookie.js

@@ -1,7 +1,8 @@
 "use strict";
 
 exports.default = exports.decodeVarint = void 0;
-var _index = require("../../utils/index.js");
+var _index = require("./index.js");
+var _bytes = require("./bytes.js");
 /*
 Copyright 2024 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -29,39 +30,39 @@ governing permissions and limitations under the License.
  * and https://git.corp.adobe.com/experience-edge/konductor/blob/master/feature-identity/src/main/kotlin/com/adobe/edge/features/identity/data/StoredIdentity.kt#L16
 
  * syntax = "proto3";
- * 
+ *
  * // Device-level identity for Experience Edge
  * message Identity {
  *   // The Experience Cloud ID value
  *   string ecid = 1;
- * 
+ *
  *   IdentityMetadata metadata = 10;
- * 
+ *
  *   // Used only in the 3rd party domain context.
  *   // It stores the UNIX timestamp and some metadata about the last identity sync triggered by Experience Edge.
  *   int64 last_sync = 20;
  *   int64 sync_hash = 21;
  *   int32 id_sync_container_id = 22;
- * 
+ *
  *   // UNIX timestamp when the Identity was last returned in a `state:store` instruction.
  *   // The Identity is written at most once every 24h with a large TTL, to ensure it does not expire.
  *   int64 write_time = 30;
  * }
- * 
+ *
  * message IdentityMetadata {
  *   // UNIX timestamp when this identity was minted.
  *   int64 created_at = 1;
- * 
+ *
  *   // Whether or not the identity is random (new) or based on an existing seed.
  *   bool is_new = 2;
- * 
+ *
  *   // Type of device for which the identity was generated.
  *   // 0 = UNKNOWN, 1 = BROWSER, 2 = MOBILE
  *   int32 device_type = 3;
- * 
+ *
  *   // The Experience Edge region in which the identity was minted.
  *   string region = 5;
- * 
+ *
  *   // More details on the source of the ECID identity.
  *   // Invariant: when `is_new` = true, the source must be set to `RANDOM`.
  *   // 0 = RANDOM, 1 = THIRD_PARTY_ID, 2 = FIRST_PARTY_ID, 3 = RECEIVED_IN_REQUEST
@@ -224,15 +225,6 @@ const decodeKndctrProtobuf = buffer => {
   throw new Error("No ECID found in cookie.");
 };
 
-/**
- * takes a base64 string of bytes and returns a Uint8Array
- * @param {string} base64
- * @returns {Uint8Array}
- */
-const base64ToBytes = base64 => {
-  const binString = atob(base64);
-  return Uint8Array.from(binString, m => m.codePointAt(0));
-};
 // #endregion
 
 // #region decode cookie
@@ -256,7 +248,7 @@ var _default = ({
       // cookie is a base64 encoded byte representation of a Identity protobuf message
       // and we need to get it to a Uint8Array in order to decode it
 
-      const cookieBytes = base64ToBytes(decodedCookie);
+      const cookieBytes = (0, _bytes.base64ToBytes)(decodedCookie);
       return decodeKndctrProtobuf(cookieBytes);
     } catch (error) {
       logger.warn("Unable to decode ECID from " + kndctrCookieName + " cookie", error);

package/libEs5/utils/createLoggingCookieJar.js

@@ -12,6 +12,19 @@ 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 { Logger } from '../core/types.js' */
+/** @import { CookieJar } from './types.js' */
+/**
+ * Creates a logging wrapper around a cookie jar that logs cookie operations.
+ *
+ * @function
+ *
+ * @param {object} options
+ * @param {Logger} options.logger
+ * @param {CookieJar} options.cookieJar
+ *
+ * @returns {CookieJar}
+ */
 var _default = ({
   logger,
   cookieJar
@@ -24,7 +37,7 @@ var _default = ({
         value,
         ...options
       });
-      cookieJar.set(key, value, options);
+      return cookieJar.set(key, value, options);
     }
   };
 };

package/libEs5/utils/createMerger.js

@@ -16,10 +16,11 @@ governing permissions and limitations under the License.
 /**
  * Creates a function that, when passed an object of updates, will merge
  * the updates onto the current value of a payload property.
- * @param {Object} content The base object to modify
- * @param {String } key The property to merge updates into. This
- * can be a dot-notation property path.
- * @returns {Function}
+ *
+ * @param {object} content The base object to modify
+ * @param {string} key The property to merge updates into. This can be a dot-notation property path.
+ *
+ * @returns {function(object): void}
  */
 var _default = (content, key) => updates => {
   const propertyPath = key.split(".");

package/libEs5/utils/index.js

@@ -6,6 +6,18 @@ Object.defineProperty(exports, "assignConcatArrayValues", {
     return _assignConcatArrayValues.default;
   }
 });
+Object.defineProperty(exports, "base64ToBytes", {
+  enumerable: true,
+  get: function () {
+    return _bytes.base64ToBytes;
+  }
+});
+Object.defineProperty(exports, "bytesToBase64", {
+  enumerable: true,
+  get: function () {
+    return _bytes.bytesToBase64;
+  }
+});
 Object.defineProperty(exports, "clone", {
   enumerable: true,
   get: function () {
@@ -301,6 +313,7 @@ Object.defineProperty(exports, "validateIdentityMap", {
   }
 });
 var _assignConcatArrayValues = require("./assignConcatArrayValues.js");
+var _bytes = require("./bytes.js");
 var _clone = require("./clone.js");
 var _cookieJar = require("./cookieJar.js");
 var _createMerger = require("./createMerger.js");

package/libEs5/utils/injectStorage.js

@@ -14,6 +14,16 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+/** @import { Storage, StorageCreator } from './types.js' */
+
+/**
+ * Creates a storage interface for a specific storage type with namespaced keys.
+ *
+ * @param {Object} context - The context object (typically window) that provides storage APIs.
+ * @param {string} storageType - The type of storage to use ('localStorage' or 'sessionStorage').
+ * @param {string} namespace - The namespace prefix to prepend to all storage keys.
+ * @returns {Storage}
+ */
 const getStorageByType = (context, storageType, namespace) => {
   // When storage is disabled on Safari, the mere act of referencing
   // window.localStorage or window.sessionStorage throws an error.
@@ -62,6 +72,15 @@ const getStorageByType = (context, storageType, namespace) => {
     }
   };
 };
+
+/**
+ * Creates a storage factory function that provides access to both session and persistent storage
+ * with namespaced keys. This is a higher-order function that returns a function which can be
+ * used to create storage instances with additional namespace suffixes.
+ *
+ * @param {Object} context - The context object (typically window) that provides storage APIs.
+ * @returns {StorageCreator}
+ */
 var _default = context => additionalNamespace => {
   const finalNamespace = _namespace.default + additionalNamespace;
   return {

package/libEs5/utils/request/createDataCollectionRequestPayload.js

@@ -15,20 +15,28 @@ 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 { DataCollectionRequestPayload } from './types.js' */
+/**
+ * @function
+ *
+ * @returns {DataCollectionRequestPayload}
+ */
 var _default = () => {
   const content = {};
-  const payload = (0, _createRequestPayload.default)({
+  const requestPayload = (0, _createRequestPayload.default)({
     content,
     addIdentity: (0, _createAddIdentity.default)(content),
     hasIdentity: (0, _createHasIdentity.default)(content)
   });
-  payload.addEvent = event => {
-    content.events = content.events || [];
-    content.events.push(event);
+  return {
+    ...requestPayload,
+    addEvent: event => {
+      content.events = content.events || [];
+      content.events.push(event);
+    },
+    getDocumentMayUnload: () => {
+      return (content.events || []).some(event => event.getDocumentMayUnload());
+    }
   };
-  payload.getDocumentMayUnload = () => {
-    return (content.events || []).some(event => event.getDocumentMayUnload());
-  };
-  return payload;
 };
 exports.default = _default;

package/libEs5/utils/request/createRequest.js

@@ -13,7 +13,34 @@ 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.
 */
-// This provides the base functionality that all types of requests share.
+/** @import { Request, RequestPayload } from './types.js' */
+/**
+ * Creates a request object with methods to access and modify request properties.
+ *
+ * @function
+ *
+ * @param {Object} options
+ * @param {RequestPayload} options.payload
+ * @param {function({isIdentityEstablished: boolean}): string} options.getAction
+ * @param {function({isIdentityEstablished: boolean}): boolean} options.getUseSendBeacon
+ * @param {string} [options.datastreamIdOverride]
+ * @param {string} [options.edgeSubPath]
+ *
+ * @returns {Request}
+ *
+ * @example
+ * const request = createRequest({
+ *   payload: { event: 'pageView' },
+ *   getAction: ({ isIdentityEstablished }) => isIdentityEstablished ? 'send' : 'queue',
+ *   getUseSendBeacon: ({ isIdentityEstablished }) => isIdentityEstablished,
+ *   datastreamIdOverride: 'custom-datastream-id',
+ *   edgeSubPath: 'custom/path'
+ * });
+ *
+ * console.log(request.getId()); // Returns unique UUID
+ * request.setIsIdentityEstablished();
+ * console.log(request.getAction()); // Returns action based on identity status
+ */
 var _default = options => {
   const {
     payload,

package/libEs5/utils/request/createRequestPayload.js

@@ -13,20 +13,84 @@ 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.
 */
-// This provides the base functionality that all types of
-// request payloads share.
+
+/** @import { RequestPayload, Identity } from './types.js' */
+
+/**
+ * createMerger creates a function that does a deep merge. Example:
+ * ```js
+ * payload.mergeConfigOverride({
+ *   com_adobe_analytics: {
+ *     reportSuites: ["reportSuite1"],
+ *   },
+ * });
+ *
+ * payload.mergeConfigOverride({
+ *   com_adobe_analytics: {
+ *     enabled: false,
+ *   },
+ * });
+ *
+ *
+ * // payload.meta.configOverrides is now:
+ * // {
+ * //   com_adobe_analytics: {
+ * //     enabled: false,
+ * //     reportSuites: ["reportSuite1"],
+ * //   },
+ * // }
+ * ```
+ * however, we need the result to be:
+ * ```js
+ * // {
+ * //   com_adobe_analytics: {
+ * //     enabled: false,
+ * //   },
+ * // }
+ * ```
+ * aka a shallow merge, where the second object overwrites the first.
+ * This is because order matters and we don't want to send reportSuites when something is
+ * disabled.
+ * This function does that.
+ *
+ * @param {Object} content
+ * @param {string} key
+ * @returns {(updates: Object) => void}
+ */
+const createMergeConfigOverride = (content, key) => updates => {
+  const propertyPath = key.split(".");
+  const hostObjectForUpdates = propertyPath.reduce((obj, propertyName) => {
+    obj[propertyName] = obj[propertyName] || {};
+    return obj[propertyName];
+  }, content);
+  Object.assign(hostObjectForUpdates, updates);
+};
+
+/**
+ * Creates a request payload object with methods for merging different types of data.
+ * This provides the base functionality that all types of request payloads share.
+ *
+ * @function
+ *
+ * @param {Object} options
+ * @param {Object} options.content
+ * @param {function(string, Identity): void} options.addIdentity
+ * @param {function(string):  boolean} options.hasIdentity
+ *
+ * @returns {RequestPayload}
+ */
 var _default = options => {
   const {
     content,
     addIdentity,
     hasIdentity
   } = options;
-  const mergeConfigOverride = (0, _index.createMerger)(content, "meta.configOverrides");
+  const mergeConfigOverrides = createMergeConfigOverride(content, "meta.configOverrides");
   return {
     mergeMeta: (0, _index.createMerger)(content, "meta"),
     mergeState: (0, _index.createMerger)(content, "meta.state"),
     mergeQuery: (0, _index.createMerger)(content, "query"),
-    mergeConfigOverride: updates => mergeConfigOverride((0, _index.prepareConfigOverridesForEdge)(updates)),
+    mergeConfigOverride: updates => mergeConfigOverrides((0, _index.prepareConfigOverridesForEdge)(updates)),
     addIdentity,
     hasIdentity,
     toJSON() {

package/libEs5/utils/request/types.js

@@ -0,0 +1,52 @@
+"use strict";
+
+exports.Types = void 0;
+/**
+ * Request object with methods to access and modify request properties.
+ *
+ * @typedef {Object} Request
+ * @property {function(): string} getId
+ * @property {function(): RequestPayload} getPayload
+ * @property {function({isIdentityEstablished: boolean}): string}  getAction
+ * @property {function(): string|undefined} getDatastreamIdOverride
+ * @property {Function} getUseSendBeacon
+ * @property {function(): string|undefined} getEdgeSubPath
+ * @property {Function} getUseIdThirdPartyDomain
+ * @property {Function} setUseIdThirdPartyDomain
+ * @property {Function} setIsIdentityEstablished
+ */
+
+/**
+ * Request payload object with methods for merging different types of data.
+ *
+ * @typedef {Object} RequestPayload
+ * @property {function(object): void} mergeMeta
+ * @property {function(object): void} mergeState
+ * @property {function(object): void} mergeQuery
+ * @property {function(object): void} mergeConfigOverride
+ * @property {function(string, Identity): void} options.addIdentity
+ * @property {function(string): boolean} options.hasIdentity
+ * @property {function(): object} toJSON
+ */
+
+/**
+ * Request payload object with methods for merging different types of data.
+ *
+ * @typedef {Object} DataCollectionRequestPayload
+ * @property {function(object): void} mergeMeta
+ * @property {function(object): void} mergeState
+ * @property {function(object): void} mergeQuery
+ * @property {function(object): void} mergeConfigOverride
+ * @property {function(string, Identity): void} options.addIdentity
+ * @property {function(string): boolean} options.hasIdentity
+ * @property {function(object): void} addEvent
+ * @property {function(): boolean} getDocumentMayUnload
+ * @property {function(): object} toJSON
+ */
+
+/**
+ * @typedef {Object} Identity
+ * @property {string} id
+ */
+
+const Types = exports.Types = {};

package/libEs5/utils/types.js

@@ -0,0 +1,39 @@
+"use strict";
+
+exports.Types = void 0;
+/**
+ * @typedef {Object} Storage
+ * @property {function(string): string|null} getItem
+ * @property {function(string, string): void} setItem
+ * @property {function(): void} clear
+ */
+
+/**
+ * @typedef {Object} CookieAttributes
+ * @property {number|Date} [expires] - Cookie expiration (number of days or Date object)
+ * @property {string} [path] - Cookie path (default: "/")
+ * @property {string} [domain] - Cookie domain
+ * @property {boolean} [secure] - Requires HTTPS transmission
+ * @property {"strict"|"lax"|"none"} [sameSite] - SameSite attribute
+ */
+
+/**
+ * @typedef {Object} CookieConverter
+ * @property {function(string, string): string} [read] - Custom decoder function
+ * @property {function(string, string): string} [write] - Custom encoder function
+ */
+
+/**
+ * @typedef {Object} CookieJar
+ * @property {function(string): string|undefined} get - Get cookie value by name, or get all cookies as object if no name provided
+ * @property {function(): Object<string, string>} get - Get all cookies as key-value object when called with no arguments
+ * @property {function(string, string, CookieAttributes=): string|undefined} set - Set cookie with optional attributes
+ * @property {function(string, CookieAttributes=): void} remove - Remove cookie with optional attributes (must match set attributes)
+ * @property {function(CookieConverter): CookieJar} withConverter - Create new instance with custom encoding/decoding
+ */
+
+/**
+ * @typedef {function(string): { session: Storage, persistent: Storage }} StorageCreator
+ */
+
+const Types = exports.Types = {};

package/libEs6/components/ActivityCollector/utils/dom/findClickableElement.js

@@ -17,6 +17,10 @@ import isButtonSubmitElement from "./isButtonSubmitElement.js";
 export default element => {
   let node = element;
   while (node) {
+    // Stop looking when BODY is reached
+    if (node.nodeName && node.nodeName === "BODY") {
+      break;
+    }
     if (isSupportedAnchorElement(node) || elementHasClickHandler(node) || isInputSubmitElement(node) || isButtonSubmitElement(node)) {
       return node;
     }

package/libEs6/components/Advertising/createComponent.js

@@ -21,9 +21,6 @@ export default ({
   getBrowser
 }) => {
   const componentConfig = config.advertising;
-  const sharedState = {
-    processedAdvertisingIds: false
-  };
   const sendAdConversionHandler = createSendAdConversion({
     eventManager,
     cookieManager,
@@ -35,7 +32,7 @@ export default ({
   return {
     lifecycle: {
       onComponentsRegistered() {
-        sendAdConversionHandler(sharedState);
+        return sendAdConversionHandler();
       },
       onBeforeEvent: ({
         event,
@@ -44,7 +41,6 @@ export default ({
         return handleOnBeforeSendEvent({
           cookieManager,
           logger,
-          state: sharedState,
           event,
           componentConfig,
           advertising,

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

@@ -62,7 +62,8 @@ export default async function handleClickThrough({
         }
       }
     },
-    eventType: AD_CONVERSION_CLICK_EVENT_TYPE
+    eventType: AD_CONVERSION_CLICK_EVENT_TYPE,
+    timestamp: new Date().toISOString()
   };
   event.setUserXdm(xdm);
   cookieManager.setValue(LAST_CONVERSION_TIME_KEY);

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

@@ -33,11 +33,11 @@ export default ({
       skwcid,
       efid
     } = getUrlParams();
-    const isClickThru = !!(skwcid && efid);
+    const isClickThru = !!(skwcid || efid);
     try {
-      let result = null;
       if (isClickThru) {
-        result = await handleClickThrough({
+        // wait for click through to complete
+        return handleClickThrough({
           eventManager,
           cookieManager,
           adConversionHandler,
@@ -45,19 +45,17 @@ export default ({
           skwcid,
           efid
         });
-        return result;
       } else if (activeAdvertiserIds) {
-        result = await handleViewThrough({
+        // fire and forget view through
+        handleViewThrough({
           eventManager,
           cookieManager,
           logger,
           componentConfig,
           adConversionHandler,
           getBrowser
-        });
-        return result;
+        }).catch(error => logger.error("Error in view through:", error));
       }
-      return null;
     } catch (error) {
       logger.error("Error in sendAdConversion:", error);
     }

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

@@ -23,7 +23,8 @@ export default async function handleViewThrough({
     try {
       const event = appendAdvertisingIdQueryToEvent(resolvedIds, eventManager.createEvent(), cookieManager, componentConfig, true);
       const xdm = {
-        eventType: AD_CONVERSION_VIEW_EVENT_TYPE
+        eventType: AD_CONVERSION_VIEW_EVENT_TYPE,
+        timestamp: new Date().toISOString()
       };
       event.setUserXdm(xdm);
       const result = await adConversionHandler.trackAdConversion({
@@ -43,11 +44,11 @@ export default async function handleViewThrough({
   const identityPromises = Object.entries(identityPromisesMap).map(([idType, idPromise]) => idPromise.then(idValue => {
     if (idValue) {
       resolvedIds[idType] = idValue;
-      return triggerConversion(); // Return the promise directly
+      return triggerConversion();
     }
   }).catch(error => {
     logger.error(LOG_ERROR_RESOLVING_ID.replace("{0}", idType), error);
     return null;
   }));
-  return Promise.allSettled(identityPromises); // Remove the separate conversionTasks handling
+  return Promise.allSettled(identityPromises);
 }

package/libEs6/components/Consent/createConsentRequestPayload.js

@@ -10,10 +10,18 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 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 payload = createRequestPayload({
+  const requestPayload = createRequestPayload({
     content,
     addIdentity: (namespaceCode, identity) => {
       content.identityMap = content.identityMap || {};
@@ -24,8 +32,13 @@ export default () => {
       return (content.identityMap && content.identityMap[namespaceCode]) !== undefined;
     }
   });
-  payload.setConsent = consent => {
-    content.consent = consent;
+
+  /** @type {ConsentRequestPayload} */
+  const payload = {
+    ...requestPayload,
+    setConsent: consent => {
+      content.consent = consent;
+    }
   };
   return payload;
 };

package/libEs6/components/Consent/types.js

@@ -0,0 +1,15 @@
+/**
+ * Request payload object with methods for merging different types of data.
+ *
+ * @typedef {Object} ConsentRequestPayload
+ * @property {Function} mergeMeta
+ * @property {Function} mergeState
+ * @property {Function} mergeQuery
+ * @property {Function} mergeConfigOverride
+ * @property {Function} addIdentity
+ * @property {Function} hasIdentity
+ * @property {Function} toJSON
+ * @property {Function} setConsent
+ */
+
+export const Types = {};

package/libEs6/components/Identity/createComponent.js

@@ -22,8 +22,8 @@ export default ({
   consent,
   appendIdentityToUrl,
   logger,
-  getIdentityOptionsValidator,
-  decodeKndctrCookie
+  identity,
+  getIdentityOptionsValidator
 }) => {
   let namespaces;
   let edge = {};
@@ -65,6 +65,7 @@ export default ({
           ...edge,
           ...response.getEdge()
         };
+        identity.setIdentityAcquired();
         return handleResponseForIdSyncs(response);
       }
     },
@@ -79,7 +80,7 @@ export default ({
             if (namespaces) {
               return undefined;
             }
-            const ecidFromCookie = decodeKndctrCookie();
+            const ecidFromCookie = identity.getEcidFromCookie();
             if (ecidFromCookie && requestedNamespaces.includes(ecidNamespace)) {
               if (!namespaces) {
                 namespaces = {};
@@ -110,7 +111,7 @@ export default ({
             if (namespaces) {
               return undefined;
             }
-            const ecidFromCookie = decodeKndctrCookie();
+            const ecidFromCookie = identity.getEcidFromCookie();
             if (ecidFromCookie) {
               if (!namespaces) {
                 namespaces = {};