@adobe/alloy 2.28.1 → 2.29.0-beta.0

package/libEs5/components/Advertising/configValidators.js

@@ -0,0 +1,26 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/validation/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 = exports.default = (0, _index.objectOf)({
+  advertising: (0, _index.objectOf)({
+    id5PartnerId: (0, _index.string)(),
+    rampIdJSPath: (0, _index.string)(),
+    dspEnabled: (0, _index.boolean)(),
+    advertiserSettings: (0, _index.arrayOf)((0, _index.objectOf)({
+      advertiserId: (0, _index.string)().required(),
+      enabled: (0, _index.boolean)().required()
+    }).noUnknownFields())
+  }).noUnknownFields()
+});

package/libEs5/components/Advertising/constants/index.js

@@ -0,0 +1,78 @@
+"use strict";
+
+exports.XDM_AD_STITCH_DATA = exports.XDM_AD_CLOUD_PATH = exports.XDM_AD_ASSET_REFERENCE = exports.XDM_AD_ASSET_DATA = exports.XDM_ADVERTISER = exports.UNKNOWN_ADVERTISER = exports.TRACKING_IDENTITIES = exports.TRACKING_CODE = exports.SURFER_USER_ID = exports.SURFER_TRUSTED_ORIGIN = exports.SURFER_TIMEOUT_MS = exports.SURFER_PIXEL_HOST = exports.SURFER_PARAM_KEY = exports.SURFER_ID_COOKIE_KEY = exports.SURFER_ID = exports.SKWCID_PARAM = exports.RAMP_ID_EXPIRES = exports.RAMP_ID_COOKIE_KEY = exports.RAMP_ID = exports.LOG_SENDING_CONVERSION = exports.LOG_ID_RESOLVED = exports.LOG_ID_CONVERSION_SUCCESS = exports.LOG_ERROR_RESOLVING_ID = exports.LOG_COOKIE_WRITTEN = exports.LOG_CONVERSION_TIME_UPDATED = exports.LOG_ALL_IDS_USED = exports.LOG_ALL_IDS_THROTTLED = exports.LOG_AD_CONVERSION_START = exports.LOG_AD_CONVERSION_FAILED = exports.LAST_CONVERSION_TIME_KEY_EXPIRES = exports.LAST_CONVERSION_TIME_KEY = exports.LAST_CLICK_COOKIE_KEY = exports.ID5_SCRIPT_URL = exports.ID5_ID = exports.ID5_COOKIE_KEY = exports.ERROR_RAMP_ID_MAX_RETRIES = exports.ERROR_ID5_PARTNER_ID_REQUIRED = exports.EFID_PARAM = exports.DISPLAY_CLICK_COOKIE_KEY_EXPIRES = exports.DISPLAY_CLICK_COOKIE_KEY = exports.DEFAULT_THROTTLE_MINUTES = exports.DEFAULT_COOKIE_EXPIRATION_MINUTES = exports.AD_CONVERSION_VIEW_EVENT_TYPE = exports.AD_CONVERSION_CLICK_EVENT_TYPE = exports.ADVERTISING_COOKIE_KEY = 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.
+*/
+
+// Cookie Keys
+const ADVERTISING_COOKIE_KEY = exports.ADVERTISING_COOKIE_KEY = "advertising";
+const SURFER_ID_COOKIE_KEY = exports.SURFER_ID_COOKIE_KEY = "surfer_id";
+const RAMP_ID_COOKIE_KEY = exports.RAMP_ID_COOKIE_KEY = "ramp_id";
+const ID5_COOKIE_KEY = exports.ID5_COOKIE_KEY = "id5_id";
+const LAST_CLICK_COOKIE_KEY = exports.LAST_CLICK_COOKIE_KEY = "_les_lsc";
+const LAST_CONVERSION_TIME_KEY = exports.LAST_CONVERSION_TIME_KEY = "lastConversionTime";
+const DISPLAY_CLICK_COOKIE_KEY_EXPIRES = exports.DISPLAY_CLICK_COOKIE_KEY_EXPIRES = "displayClickCookieExpires";
+const RAMP_ID_EXPIRES = exports.RAMP_ID_EXPIRES = "rampIdExpires";
+const LAST_CONVERSION_TIME_KEY_EXPIRES = exports.LAST_CONVERSION_TIME_KEY_EXPIRES = "lastConversionTimeExpires";
+// URL Parameters
+const SKWCID_PARAM = exports.SKWCID_PARAM = "s_kwcid";
+const EFID_PARAM = exports.EFID_PARAM = "ef_id";
+
+// Identity Types
+const SURFER_ID = exports.SURFER_ID = "surferId";
+const RAMP_ID = exports.RAMP_ID = "rampId";
+const ID5_ID = exports.ID5_ID = "id5Id";
+
+// Default Values
+const UNKNOWN_ADVERTISER = exports.UNKNOWN_ADVERTISER = "";
+const DEFAULT_THROTTLE_MINUTES = exports.DEFAULT_THROTTLE_MINUTES = 30;
+const DEFAULT_COOKIE_EXPIRATION_MINUTES = exports.DEFAULT_COOKIE_EXPIRATION_MINUTES = 527040; // 365 days
+
+// Event Types
+const AD_CONVERSION_CLICK_EVENT_TYPE = exports.AD_CONVERSION_CLICK_EVENT_TYPE = "advertising.enrichment_ct";
+const AD_CONVERSION_VIEW_EVENT_TYPE = exports.AD_CONVERSION_VIEW_EVENT_TYPE = "advertising.enrichment";
+
+// XDM Paths
+const XDM_AD_CLOUD_PATH = exports.XDM_AD_CLOUD_PATH = "_experience.adloud";
+const XDM_AD_ASSET_REFERENCE = exports.XDM_AD_ASSET_REFERENCE = "adAssetReference";
+const XDM_AD_STITCH_DATA = exports.XDM_AD_STITCH_DATA = "adStitchData";
+const XDM_AD_ASSET_DATA = exports.XDM_AD_ASSET_DATA = "adAssetData";
+const XDM_ADVERTISER = exports.XDM_ADVERTISER = "advertiser";
+const TRACKING_CODE = exports.TRACKING_CODE = "trackingCode";
+const TRACKING_IDENTITIES = exports.TRACKING_IDENTITIES = "trackingIdentities";
+
+// Script URLs
+const ID5_SCRIPT_URL = exports.ID5_SCRIPT_URL = "https://www.everestjs.net/static/id5-api.js";
+
+// Surfer ID Configuration
+const SURFER_PIXEL_HOST = exports.SURFER_PIXEL_HOST = "pixel.everesttech.net";
+const SURFER_USER_ID = exports.SURFER_USER_ID = "1";
+const SURFER_TIMEOUT_MS = exports.SURFER_TIMEOUT_MS = 5000;
+const SURFER_TRUSTED_ORIGIN = exports.SURFER_TRUSTED_ORIGIN = "www.everestjs.net";
+const SURFER_PARAM_KEY = exports.SURFER_PARAM_KEY = "gsurfer";
+
+// Error Messages
+const ERROR_ID5_PARTNER_ID_REQUIRED = exports.ERROR_ID5_PARTNER_ID_REQUIRED = "ID5 partner ID is required";
+const ERROR_RAMP_ID_MAX_RETRIES = exports.ERROR_RAMP_ID_MAX_RETRIES = "Failed to retrieve RampID after maximum retries";
+
+// Log Messages
+const LOG_AD_CONVERSION_START = exports.LOG_AD_CONVERSION_START = "Processing ad conversion";
+const LOG_COOKIE_WRITTEN = exports.LOG_COOKIE_WRITTEN = "Ad tracking data saved";
+const LOG_CONVERSION_TIME_UPDATED = exports.LOG_CONVERSION_TIME_UPDATED = "Conversion timing recorded";
+const LOG_SENDING_CONVERSION = exports.LOG_SENDING_CONVERSION = "Submitting ad conversion data";
+const LOG_ALL_IDS_THROTTLED = exports.LOG_ALL_IDS_THROTTLED = "Ad conversion paused to prevent duplicate submissions";
+const LOG_ALL_IDS_USED = exports.LOG_ALL_IDS_USED = "Ad conversion already processed";
+const LOG_ID_RESOLVED = exports.LOG_ID_RESOLVED = "Ad identity available";
+const LOG_ERROR_RESOLVING_ID = exports.LOG_ERROR_RESOLVING_ID = "Unable to obtain ad identity";
+const LOG_ID_CONVERSION_SUCCESS = exports.LOG_ID_CONVERSION_SUCCESS = "Ad conversion submitted successfully";
+const LOG_AD_CONVERSION_FAILED = exports.LOG_AD_CONVERSION_FAILED = "Ad conversion submission failed";
+const DISPLAY_CLICK_COOKIE_KEY = exports.DISPLAY_CLICK_COOKIE_KEY = "ev_lcc";

package/libEs5/components/Advertising/createComponent.js

@@ -0,0 +1,59 @@
+"use strict";
+
+exports.default = void 0;
+var _sendAdConversion = require("./handlers/sendAdConversion.js");
+var _onBeforeSendEventHandler = require("./handlers/onBeforeSendEventHandler.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 = ({
+  logger,
+  config,
+  eventManager,
+  cookieManager,
+  adConversionHandler,
+  getBrowser
+}) => {
+  const componentConfig = config.advertising;
+  const sharedState = {
+    processedAdvertisingIds: false
+  };
+  const sendAdConversionHandler = (0, _sendAdConversion.default)({
+    eventManager,
+    cookieManager,
+    adConversionHandler,
+    logger,
+    componentConfig,
+    getBrowser
+  });
+  return {
+    lifecycle: {
+      onComponentsRegistered() {
+        sendAdConversionHandler(sharedState);
+      },
+      onBeforeEvent: ({
+        event,
+        advertising = {}
+      }) => {
+        return (0, _onBeforeSendEventHandler.default)({
+          cookieManager,
+          logger,
+          state: sharedState,
+          event,
+          componentConfig,
+          advertising,
+          getBrowser
+        });
+      }
+    }
+  };
+};
+exports.default = _default;

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

@@ -0,0 +1,81 @@
+"use strict";
+
+exports.default = handleClickThrough;
+var _index = require("../constants/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.
+*/
+
+/**
+ * Handles click-through ad conversions
+ * @param {Object} params - All required parameters
+ * @param {Object} params.eventManager - Event manager for creating events
+ * @param {Object} params.cookieManager - Session manager for cookie operations
+ * @param {Object} params.adConversionHandler - Handler for sending ad conversion events
+ * @param {Object} params.logger - Logger instance
+ * @param {string} params.skwcid - Search keyword click ID
+ * @param {string} params.efid - EF ID parameter
+ * @param {Object} params.optionsFromCommand - Additional options from command
+ * @returns {Promise} Result of the ad conversion tracking
+ */
+async function handleClickThrough({
+  eventManager,
+  cookieManager,
+  adConversionHandler,
+  logger,
+  skwcid,
+  efid
+}) {
+  logger.info(_index.LOG_AD_CONVERSION_START, {
+    skwcid,
+    efid
+  });
+  const event = eventManager.createEvent();
+  if (typeof skwcid !== "undefined" && typeof efid !== "undefined" && skwcid.startsWith("AL!")) {
+    const clickData = {
+      click_time: Date.now(),
+      ...(typeof skwcid !== "undefined" && {
+        skwcid
+      }),
+      ...(typeof efid !== "undefined" && {
+        efid
+      })
+    };
+    cookieManager.setValue(_index.LAST_CLICK_COOKIE_KEY, clickData);
+  }
+  const xdm = {
+    _experience: {
+      adcloud: {
+        conversionDetails: {
+          ...(typeof skwcid !== "undefined" && {
+            [_index.TRACKING_CODE]: skwcid
+          }),
+          ...(typeof efid !== "undefined" && {
+            [_index.TRACKING_IDENTITIES]: efid
+          })
+        }
+      }
+    },
+    eventType: _index.AD_CONVERSION_CLICK_EVENT_TYPE
+  };
+  event.setUserXdm(xdm);
+  cookieManager.setValue(_index.LAST_CONVERSION_TIME_KEY);
+  cookieManager.setValue(_index.LAST_CONVERSION_TIME_KEY_EXPIRES, Date.now() + 91 * 24 * 60 * 60 * 1000); //expires in 91 days
+
+  try {
+    return await adConversionHandler.trackAdConversion({
+      event
+    });
+  } catch (error) {
+    logger.error(_index.LOG_AD_CONVERSION_FAILED, error);
+    throw error;
+  }
+}

package/libEs5/components/Advertising/handlers/createAdConversionHandler.js

@@ -0,0 +1,55 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2023 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+/**
+ * Creates a specialized handler for ad conversion events.
+ * This follows a similar pattern to the media event handling in the StreamingMedia component.
+ */
+var _default = ({
+  sendEdgeNetworkRequest,
+  consent,
+  createDataCollectionRequest,
+  createDataCollectionRequestPayload,
+  logger
+}) => {
+  /**
+   * Tracks an ad conversion event by sending it directly to the Edge Network
+   */
+  const trackAdConversion = ({
+    event
+  }) => {
+    const dataCollectionRequestPayload = createDataCollectionRequestPayload();
+    dataCollectionRequestPayload.addEvent(event);
+    event.finalize();
+    const request = createDataCollectionRequest({
+      payload: dataCollectionRequestPayload
+    });
+    return consent.awaitConsent().then(() => {
+      return sendEdgeNetworkRequest({
+        request
+      }).then(() => {
+        return {
+          success: true
+        };
+      }).catch(error => {
+        logger.error("Failed to send ad conversion event", error);
+        throw error;
+      });
+    });
+  };
+  return {
+    trackAdConversion
+  };
+};
+exports.default = _default;

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

@@ -0,0 +1,69 @@
+"use strict";
+
+exports.default = handleOnBeforeSendEvent;
+var _collectSurferId = require("../identities/collectSurferId.js");
+var _collectID5Id = require("../identities/collectID5Id.js");
+var _collectRampId = require("../identities/collectRampId.js");
+var _helpers = require("../utils/helpers.js");
+var _index = require("../constants/index.js");
+var _consentStatus = require("../../../constants/consentStatus.js");
+/*
+Copyright 2023 Adobe. All rights reserved.
+Licensed under the Apache License, Version 2.0.
+http://www.apache.org/licenses/LICENSE-2.0
+*/
+
+const isAdvertisingDisabled = advertising => {
+  return ![_consentStatus.AUTO, _consentStatus.WAIT].includes(advertising?.handleAdvertisingData);
+};
+const waitForAdvertisingId = advertising => {
+  return advertising?.handleAdvertisingData === _consentStatus.WAIT;
+};
+
+/**
+ * Appends advertising identity IDs to AEP event query if not already added.
+ * @param {Object} params
+ * @param {Object} params.cookieManager
+ * @param {Object} params.logger
+ * @param {Object} params.state
+ * @param {Object} params.event
+ * @param {Object} params.componentConfig
+ * @param {Object} params.advertising
+ * @param {Function} params.getBrowser
+ */
+async function handleOnBeforeSendEvent({
+  cookieManager,
+  logger,
+  event,
+  componentConfig,
+  advertising,
+  getBrowser
+}) {
+  const {
+    skwcid,
+    efid
+  } = (0, _helpers.getUrlParams)();
+  const isClickThru = !!(skwcid && efid);
+  if (isAdvertisingDisabled(advertising) || isClickThru || (0, _helpers.isThrottled)(_index.SURFER_ID, cookieManager) && (0, _helpers.isThrottled)(_index.ID5_ID, cookieManager) && (0, _helpers.isThrottled)(_index.RAMP_ID, cookieManager)) return;
+  try {
+    const useShortTimeout = waitForAdvertisingId(advertising);
+    const [surferIdResult, id5IdResult, rampIdResult] = await Promise.allSettled([(0, _collectSurferId.default)(cookieManager, getBrowser, useShortTimeout), (0, _collectID5Id.getID5Id)(logger, componentConfig.id5PartnerId, useShortTimeout, useShortTimeout), (0, _collectRampId.getRampId)(logger, componentConfig.rampIdJSPath, cookieManager, useShortTimeout, useShortTimeout)]);
+    const availableIds = {};
+    if (surferIdResult.status === "fulfilled" && surferIdResult.value && !(0, _helpers.isThrottled)(_index.SURFER_ID, cookieManager)) {
+      availableIds.surferId = surferIdResult.value;
+    }
+    if (id5IdResult.status === "fulfilled" && id5IdResult.value && !(0, _helpers.isThrottled)(_index.ID5_ID, cookieManager)) {
+      availableIds.id5Id = id5IdResult.value;
+    }
+    if (rampIdResult.status === "fulfilled" && rampIdResult.value && !(0, _helpers.isThrottled)(_index.RAMP_ID, cookieManager)) {
+      availableIds.rampId = rampIdResult.value;
+    }
+    // If no IDs are available and any ID is throttled, return , because we dont have new info to send
+    if (Object.keys(availableIds).length === 0 && ((0, _helpers.isThrottled)(_index.SURFER_ID, cookieManager) || (0, _helpers.isThrottled)(_index.ID5_ID, cookieManager) || (0, _helpers.isThrottled)(_index.RAMP_ID, cookieManager))) {
+      return;
+    }
+    (0, _helpers.appendAdvertisingIdQueryToEvent)(availableIds, event, cookieManager, componentConfig);
+  } catch (error) {
+    logger.error("Error in onBeforeSendEvent hook:", error);
+  }
+}

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

@@ -0,0 +1,67 @@
+"use strict";
+
+exports.default = void 0;
+var _clickThroughHandler = require("./clickThroughHandler.js");
+var _viewThroughHandler = require("./viewThroughHandler.js");
+var _helpers = require("../utils/helpers.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.
+*/
+/**
+ * Creates a handler for sending ad conversions.
+ * Handles both click-through and view-through conversions.
+ * This is a workaround to avoid the full lifecycle of the eventManager.sendEvent
+ */
+var _default = ({
+  eventManager,
+  cookieManager,
+  adConversionHandler,
+  logger,
+  componentConfig,
+  getBrowser
+}) => {
+  const activeAdvertiserIds = componentConfig?.advertiserSettings ? (0, _helpers.normalizeAdvertiser)(componentConfig.advertiserSettings) : "";
+  return async () => {
+    const {
+      skwcid,
+      efid
+    } = (0, _helpers.getUrlParams)();
+    const isClickThru = !!(skwcid && efid);
+    try {
+      let result = null;
+      if (isClickThru) {
+        result = await (0, _clickThroughHandler.default)({
+          eventManager,
+          cookieManager,
+          adConversionHandler,
+          logger,
+          skwcid,
+          efid
+        });
+        return result;
+      } else if (activeAdvertiserIds) {
+        result = await (0, _viewThroughHandler.default)({
+          eventManager,
+          cookieManager,
+          logger,
+          componentConfig,
+          adConversionHandler,
+          getBrowser
+        });
+        return result;
+      }
+      return null;
+    } catch (error) {
+      logger.error("Error in sendAdConversion:", error);
+    }
+  };
+};
+exports.default = _default;

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

@@ -0,0 +1,56 @@
+"use strict";
+
+exports.default = handleViewThrough;
+var _collectAllIdentities = require("../identities/collectAllIdentities.js");
+var _index = require("../constants/index.js");
+var _helpers = require("../utils/helpers.js");
+/*
+Copyright 2025 Adobe. All rights reserved.
+Licensed under the Apache License, Version 2.0.
+http://www.apache.org/licenses/LICENSE-2.0
+*/
+
+async function handleViewThrough({
+  eventManager,
+  cookieManager,
+  logger,
+  componentConfig,
+  adConversionHandler,
+  getBrowser
+}) {
+  const resolvedIds = {};
+  const usedIdTracker = {};
+  const triggerConversion = async () => {
+    if (!(0, _helpers.isAnyIdUnused)(resolvedIds, usedIdTracker)) return null;
+    const idTypesToUse = Object.keys(resolvedIds);
+    try {
+      const event = (0, _helpers.appendAdvertisingIdQueryToEvent)(resolvedIds, eventManager.createEvent(), cookieManager, componentConfig, true);
+      const xdm = {
+        eventType: _index.AD_CONVERSION_VIEW_EVENT_TYPE
+      };
+      event.setUserXdm(xdm);
+      const result = await adConversionHandler.trackAdConversion({
+        event
+      });
+      (0, _helpers.markIdsAsConverted)(idTypesToUse, usedIdTracker, cookieManager, logger);
+      return result;
+    } catch (error) {
+      logger.error(_index.LOG_AD_CONVERSION_FAILED, error);
+      return null;
+    }
+  };
+  const identityPromisesMap = (0, _collectAllIdentities.default)(logger, componentConfig, cookieManager, getBrowser);
+  if (Object.keys(identityPromisesMap).length === 0) {
+    return [];
+  }
+  const identityPromises = Object.entries(identityPromisesMap).map(([idType, idPromise]) => idPromise.then(idValue => {
+    if (idValue) {
+      resolvedIds[idType] = idValue;
+      return triggerConversion(); // Return the promise directly
+    }
+  }).catch(error => {
+    logger.error(_index.LOG_ERROR_RESOLVING_ID.replace("{0}", idType), error);
+    return null;
+  }));
+  return Promise.allSettled(identityPromises); // Remove the separate conversionTasks handling
+}

package/libEs5/components/Advertising/identities/collectAllIdentities.js

@@ -0,0 +1,34 @@
+"use strict";
+
+exports.default = void 0;
+var _collectSurferId = require("./collectSurferId.js");
+var _collectRampId = require("./collectRampId.js");
+var _collectID5Id = require("./collectID5Id.js");
+var _index = require("../constants/index.js");
+var _helpers = require("../utils/helpers.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 collectAllIdentities = (logger, componentConfig, cookieManager, getBrowser) => {
+  const promises = {};
+  if (!(0, _helpers.isThrottled)(_index.SURFER_ID, cookieManager)) {
+    promises.surferId = (0, _collectSurferId.default)(cookieManager, getBrowser, true).catch(() => null);
+  }
+  if (componentConfig.id5PartnerId && componentConfig.dspEnabled && !(0, _helpers.isThrottled)(_index.ID5_ID, cookieManager)) {
+    promises.id5Id = (0, _collectID5Id.getID5Id)(logger, componentConfig.id5PartnerId).catch(() => null);
+  }
+  if (componentConfig.rampIdJSPath && componentConfig.dspEnabled && !(0, _helpers.isThrottled)(_index.RAMP_ID, cookieManager)) {
+    promises.rampId = (0, _collectRampId.getRampId)(logger, componentConfig.rampIdJSPath, cookieManager, true).catch(() => null);
+  }
+  return promises;
+};
+var _default = exports.default = collectAllIdentities;

package/libEs5/components/Advertising/identities/collectID5Id.js

@@ -0,0 +1,112 @@
+"use strict";
+
+exports.initiateID5Call = exports.getID5Id = void 0;
+var _index = require("../../../utils/dom/index.js");
+var _index2 = require("../constants/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.
+*/
+
+let id5Id = "";
+let inProgressId5Promise = null;
+const SHORT_TIMEOUT_MS = 5000;
+const DEFAULT_TIMEOUT_MS = 30000;
+const initiateID5Call = (partnerId, useShortTimeout, logger) => {
+  partnerId = Math.floor(Number(partnerId));
+  if (inProgressId5Promise) {
+    return inProgressId5Promise;
+  }
+  const timeoutMs = useShortTimeout ? SHORT_TIMEOUT_MS : DEFAULT_TIMEOUT_MS;
+  let iD5TimedOut = false;
+  const id5ResolutionPromise = new Promise((resolve, reject) => {
+    if (!partnerId) {
+      logger.error("Missing partner ID");
+      reject(new Error("ID5 partner ID is required"));
+      return;
+    }
+    const handleId5 = () => {
+      try {
+        if (typeof window.ID5 === "undefined") {
+          reject(new Error("ID5 object not available after script load"));
+          return;
+        }
+        const id5Instance = window.ID5.init({
+          partnerId
+        });
+        id5Id = id5Instance.getUserId();
+        const safeResolve = val => {
+          if (!iD5TimedOut) resolve(val);
+        };
+        if (!id5Id) {
+          window.ID5.init({
+            partnerId
+          }).onAvailable(function firstRetry(retryStatus) {
+            id5Id = retryStatus.getUserId();
+            if (id5Id) {
+              safeResolve(id5Id);
+            } else {
+              window.ID5.init({
+                partnerId
+              }).onAvailable(function secondRetry(secondRetryStatus) {
+                id5Id = secondRetryStatus.getUserId();
+                if (id5Id) {
+                  safeResolve(id5Id);
+                } else {
+                  logger.error("Failed to get ID5 ID after all retries");
+                  safeResolve(null);
+                }
+              });
+            }
+          }, 1000);
+        } else {
+          safeResolve(id5Id);
+        }
+      } catch (error) {
+        logger.error("Error during ID5 initialization", error);
+        reject(error);
+      }
+    };
+    if (typeof window.ID5 !== "undefined") {
+      handleId5();
+    } else {
+      (0, _index.loadScript)(_index2.ID5_SCRIPT_URL, {
+        onLoad: handleId5,
+        onError: error => {
+          logger.error("Script loading failed", error);
+          reject(error);
+        }
+      });
+    }
+  });
+  const timeoutPromise = new Promise(resolve => {
+    setTimeout(() => {
+      iD5TimedOut = true;
+      resolve(null);
+    }, timeoutMs);
+  });
+  inProgressId5Promise = Promise.race([id5ResolutionPromise, timeoutPromise]).finally(() => {
+    inProgressId5Promise = null;
+  });
+  return inProgressId5Promise;
+};
+exports.initiateID5Call = initiateID5Call;
+const getID5Id = exports.getID5Id = function getID5Id(logger, partnerId, resolveId5IfNotAvailable = true, useShortTimeout = false) {
+  if (id5Id && id5Id !== "") {
+    return Promise.resolve(id5Id);
+  }
+  if (!resolveId5IfNotAvailable) {
+    return Promise.resolve(null);
+  }
+  return initiateID5Call(partnerId, useShortTimeout, logger).then(resolvedId => resolvedId).catch(error => {
+    logger.error("Failed to get ID5 ID", error);
+    throw error;
+  });
+};