@adv-re/segment-wrapper 4.36.2 → 5.0.0-beta.0

package/dist/index.mjs

@@ -98,237 +98,6 @@ var getAdobeMCVisitorID = async () => {
   return getConfig("importAdobeVisitorId") === true ? importVisitorApiAndGetAdobeMCVisitorID() : getAdobeMarketingCloudVisitorIdFromWindow();
 };
 
-// src/events.ts
-var EVENTS = {
-  GA4_INIT_EVENT_SENT: "ga4InitEventSent"
-};
-
-// src/middlewares/source/pageReferrer.ts
-var referrerState = {
-  spaReferrer: "",
-  referrer: ""
-};
-var utils = {
-  /**
-   * @returns The referrer of the document
-   */
-  getDocumentReferrer: () => document.referrer,
-  /**
-   * @returns The actual location with protocol, domain and pathname
-   */
-  getActualLocation: () => {
-    const { origin, pathname } = window.location;
-    return `${origin}${pathname}`;
-  },
-  /**
-   * @returns The actual query string
-   */
-  getActualQueryString: () => {
-    const { search } = window.location;
-    return search;
-  }
-};
-var getPageReferrer = ({ isPageTrack = false } = {}) => {
-  const { referrer, spaReferrer } = referrerState;
-  const referrerToUse = isPageTrack ? referrer : spaReferrer;
-  return referrerToUse || utils.getDocumentReferrer();
-};
-var updatePageReferrer = () => {
-  referrerState.spaReferrer = getPageReferrer({ isPageTrack: true });
-  referrerState.referrer = utils.getActualLocation();
-};
-var pageReferrer = ({ payload, next }) => {
-  const {
-    obj: { context }
-  } = payload;
-  const { isPageTrack } = context;
-  const referrer = getPageReferrer({ isPageTrack });
-  payload.obj.context = {
-    ...context,
-    page: {
-      ...context.page,
-      referrer
-    }
-  };
-  if (isPageTrack) {
-    updatePageReferrer();
-  }
-  next(payload);
-};
-
-// src/repositories/googleRepository.ts
-var FIELDS = {
-  clientId: "client_id",
-  sessionId: "session_id"
-};
-var DEFAULT_DATA_LAYER_NAME = "dataLayer";
-var CONSENT_STATES = {
-  granted: "granted",
-  denied: "denied"
-};
-var CONSENT_STATE_GRANTED_VALUE = 1;
-var CONSENT_STATE_DENIED_VALUE = 2;
-var STC = {
-  QUERY: "stc",
-  SPLIT_SYMBOL: "-",
-  CAMPAIGN_SPLIT_SYMBOL: ":"
-};
-var UTM_CAMPAIGN = "utm_campaign";
-var UTM_MEDIUM = "utm_medium";
-var UTM_SOURCE = "utm_source";
-var UTM_CONTENT = "utm_content";
-var UTM_CAMPAIGN_ID = "utm_id";
-var UTM_TERM = "utm_term";
-var STC_MEDIUM_TRANSFORMATIONS = {
-  aff: "affiliate",
-  dis: "display",
-  em: "email",
-  met: "paid-metasearch",
-  sem: "paid-search",
-  rt: "display",
-  sm: "social-media",
-  sp: "paid-social",
-  pn: "push-notification",
-  cs: "cross-sites"
-};
-var STC_INVALID_CONTENT = "na";
-var DEFAULT_GA_INIT_EVENT = "sui";
-var EMPTY_STC = { medium: null, source: null, campaign: null };
-var loadScript = async (src) => new Promise(function(resolve, reject) {
-  const script = document.createElement("script");
-  script.src = src;
-  script.onload = () => resolve();
-  script.onerror = reject;
-  document.head.appendChild(script);
-});
-var loadGoogleAnalytics = async () => {
-  const googleAnalyticsMeasurementId = getConfig("googleAnalyticsMeasurementId");
-  const dataLayerName = getConfig("googleAnalyticsDataLayer") || DEFAULT_DATA_LAYER_NAME;
-  if (!googleAnalyticsMeasurementId) return Promise.resolve(false);
-  const gtagScript = `https://www.googletagmanager.com/gtag/js?id=${googleAnalyticsMeasurementId}&l=${dataLayerName}`;
-  return loadScript(gtagScript).then(() => true);
-};
-var triggerGoogleAnalyticsInitEvent = (sessionId) => {
-  const eventName = getConfig("googleAnalyticsInitEvent") ?? DEFAULT_GA_INIT_EVENT;
-  const eventPrefix = `ga_event_${eventName}_`;
-  const eventKey = `${eventPrefix}${sessionId}`;
-  if (typeof window.gtag === "undefined") return;
-  if (!localStorage.getItem(eventKey)) {
-    window.gtag("event", eventName);
-    console.log(`Sending GA4 event "${eventName}" for the session "${sessionId}"`);
-    localStorage.setItem(eventKey, "true");
-    if (typeof window.dispatchEvent === "function") {
-      const event = new CustomEvent(EVENTS.GA4_INIT_EVENT_SENT, {
-        detail: { eventName, sessionId }
-      });
-      window.dispatchEvent(event);
-    }
-  }
-  Object.keys(localStorage).forEach((key) => {
-    if (key.startsWith(eventPrefix) && key !== eventKey) {
-      localStorage.removeItem(key);
-    }
-  });
-};
-var getGoogleField = async (field) => {
-  const googleAnalyticsMeasurementId = getConfig("googleAnalyticsMeasurementId");
-  if (!googleAnalyticsMeasurementId) return Promise.resolve(void 0);
-  return new Promise((resolve) => {
-    window.gtag?.("get", googleAnalyticsMeasurementId, field, resolve);
-  });
-};
-var trackingTagsTypes = {
-  STC: "stc",
-  UTM: "utm"
-};
-var getCampaignDetails = ({ needsTransformation = true } = {}) => {
-  const { medium, source, campaign, content, term } = readQueryParams();
-  if (!medium || !source || !campaign) return null;
-  const [id, name] = campaign.split(STC.CAMPAIGN_SPLIT_SYMBOL);
-  if (!id && !name) return null;
-  const needsContent = typeof content !== "undefined" && content !== STC_INVALID_CONTENT;
-  return {
-    campaign: {
-      medium: needsTransformation && STC_MEDIUM_TRANSFORMATIONS[medium] || medium,
-      ...typeof name !== "undefined" && { id },
-      name: name ?? id,
-      source,
-      ...needsContent && { content },
-      ...typeof term !== "undefined" && { term }
-    }
-  };
-};
-function readQueryParams() {
-  const search = utils.getActualQueryString();
-  const searchParams = new URLSearchParams(search);
-  return getConfig("trackingTagsType") === trackingTagsTypes.UTM ? readFromUtm(searchParams) : readFromStc(searchParams);
-}
-function readFromStc(searchParams) {
-  if (!hasStc(searchParams)) return EMPTY_STC;
-  const stc = searchParams.get(STC.QUERY);
-  const [medium, source, campaign, content, term] = stc?.split(STC.SPLIT_SYMBOL) || [];
-  return { medium, source, campaign, content, term };
-}
-function hasStc(searchParams) {
-  return searchParams.has(STC.QUERY);
-}
-function readFromUtm(searchParams) {
-  const campaignId = searchParams.get(UTM_CAMPAIGN_ID);
-  const campaignName = searchParams.get(UTM_CAMPAIGN);
-  const medium = searchParams.get(UTM_MEDIUM);
-  const source = searchParams.get(UTM_SOURCE);
-  const content = searchParams.get(UTM_CONTENT);
-  const term = searchParams.get(UTM_TERM);
-  const campaign = campaignId ? `${campaignId}${STC.CAMPAIGN_SPLIT_SYMBOL}${campaignName}` : campaignName;
-  const missingAnyMandatoryFields = !medium || !source || !campaign;
-  if (missingAnyMandatoryFields && hasStc(searchParams)) {
-    return readFromStc(searchParams);
-  }
-  return {
-    campaign,
-    medium,
-    source,
-    content: content ?? void 0,
-    term: term ?? void 0
-  };
-}
-var getGoogleClientId = async () => getGoogleField(FIELDS.clientId);
-var getGoogleSessionId = async () => {
-  const sessionId = await getGoogleField(FIELDS.sessionId);
-  if (sessionId) {
-    triggerGoogleAnalyticsInitEvent(sessionId);
-  }
-  return sessionId;
-};
-function getGoogleConsentValue(consentType = "analytics_storage") {
-  try {
-    const value = window.google_tag_data?.ics?.getConsentState?.(consentType);
-    if (value === CONSENT_STATE_GRANTED_VALUE) return CONSENT_STATES.granted;
-    if (value === CONSENT_STATE_DENIED_VALUE) return CONSENT_STATES.denied;
-    return void 0;
-  } catch {
-    return void 0;
-  }
-}
-var getConsentState = () => getGoogleConsentValue() ?? CONSENT_STATES.denied;
-var setGoogleUserId = (userId) => {
-  const googleAnalyticsMeasurementId = getConfig("googleAnalyticsMeasurementId");
-  if (!googleAnalyticsMeasurementId || !userId) return;
-  window.gtag?.("set", "user_id", userId);
-};
-var sendGoogleConsents = (mode = "default", consents) => {
-  window.gtag?.(
-    "consent",
-    mode,
-    consents || {
-      analytics_storage: CONSENT_STATES.denied,
-      ad_user_data: CONSENT_STATES.denied,
-      ad_personalization: CONSENT_STATES.denied,
-      ad_storage: CONSENT_STATES.denied
-    }
-  );
-};
-
 // src/tcf.ts
 var TCF_COOKIE_KEY = "borosTcf";
 var TCF_API_VERSION = 2;
@@ -382,17 +151,30 @@ var checkTcfIsAvailable = () => {
 };
 var checkHasUserConsentedAnalytics = (userConsents) => NEEDED_PURPOSES.analytics.every((purposeId) => userConsents[`${purposeId}`]);
 var checkHasUserConsentedAdvertising = (userConsents) => NEEDED_PURPOSES.advertising.every((purposeId) => userConsents[`${purposeId}`]);
-var trackTcf = ({ gdprPrivacy }) => segmentWrapper_default.track(
-  CMP_TRACK_EVENT,
-  {
-    ...TCF_TRACK_PROPERTIES,
-    ...getConfig("tcfTrackDefaultProperties") || {}
-  },
-  {
-    gdpr_privacy: gdprPrivacy.analytics,
-    gdpr_privacy_advertising: gdprPrivacy.advertising
-  }
-);
+var trackTcf = ({ gdprPrivacy }) => {
+  const isAnalyticsAccepted = gdprPrivacy.analytics === USER_GDPR.ACCEPTED;
+  const isAdvertisingAccepted = gdprPrivacy.advertising === USER_GDPR.ACCEPTED;
+  return segmentWrapper_default.track(
+    CMP_TRACK_EVENT,
+    {
+      ...TCF_TRACK_PROPERTIES,
+      ...getConfig("tcfTrackDefaultProperties") || {}
+    },
+    {
+      // Consent Mode properties for Segment → GA4 mapping (v5)
+      // These are mapped in Segment Dashboard from context.google_consents.* to GA4 Consent Mode
+      google_consents: {
+        analytics_storage: isAnalyticsAccepted ? "granted" : "denied",
+        ad_storage: isAdvertisingAccepted ? "granted" : "denied",
+        ad_user_data: isAdvertisingAccepted ? "granted" : "denied",
+        ad_personalization: isAdvertisingAccepted ? "granted" : "denied"
+      },
+      // Keep gdpr_privacy in context for compatibility with other integrations
+      gdpr_privacy: gdprPrivacy.analytics,
+      gdpr_privacy_advertising: gdprPrivacy.advertising
+    }
+  );
+};
 var getGdprPrivacyValue = () => {
   const gdprPrivacyValue = gdprState.get();
   if (gdprPrivacyValue !== void 0) return Promise.resolve(gdprPrivacyValue);
@@ -574,14 +356,10 @@ var getTrackIntegrations = async ({
 }) => {
   const isGdprAccepted = checkAnalyticsGdprIsAccepted(gdprPrivacyValue);
   let marketingCloudVisitorId;
-  let sessionId;
-  let clientId;
   try {
     if (isGdprAccepted) {
       marketingCloudVisitorId = await getAdobeMCVisitorID();
     }
-    sessionId = await getGoogleSessionId();
-    clientId = await getGoogleClientId();
   } catch (error) {
     console.error(error);
   }
@@ -589,10 +367,7 @@ var getTrackIntegrations = async ({
   return {
     ...restOfIntegrations,
     "Adobe Analytics": marketingCloudVisitorId ? { marketingCloudVisitorId } : true,
-    "Google Analytics 4": clientId && sessionId ? {
-      clientId,
-      sessionId
-    } : true
+    "Google Analytics 4": true
   };
 };
 var getRestOfIntegrations = ({
@@ -631,9 +406,6 @@ var getExternalIds = ({
   );
   return { externalIds: uniqueExternalIds };
 };
-var getConsentValue = (gdprValue) => {
-  return gdprValue === USER_GDPR.ACCEPTED ? CONSENT_STATES.granted : CONSENT_STATES.denied;
-};
 var decorateContextWithNeededData = async ({
   event = "",
   context = {}
@@ -645,10 +417,6 @@ var decorateContextWithNeededData = async ({
     getTrackIntegrations({ gdprPrivacyValue, event }),
     getXandrId({ gdprPrivacyValueAdvertising })
   ]);
-  const analyticsConsentValue = getGoogleConsentValue("analytics_storage") ?? getConsentValue(gdprPrivacyValueAnalytics);
-  const adUserDataConsentValue = getGoogleConsentValue("ad_user_data") ?? getConsentValue(gdprPrivacyValueAdvertising);
-  const adPersonalizationConsentValue = getGoogleConsentValue("ad_personalization") ?? getConsentValue(gdprPrivacyValueAdvertising);
-  const adStorageConsentValue = getGoogleConsentValue("ad_storage") ?? getConsentValue(gdprPrivacyValueAdvertising);
   if (!isGdprAccepted) {
     context.integrations = {
       ...context.integrations ?? {},
@@ -657,21 +425,13 @@ var decorateContextWithNeededData = async ({
       Webhook: true
     };
   }
-  const google_consents = {
-    analytics_storage: analyticsConsentValue,
-    ad_user_data: adUserDataConsentValue,
-    ad_personalization: adPersonalizationConsentValue,
-    ad_storage: adStorageConsentValue
-  };
   return {
     ...context,
     ...!isGdprAccepted && { ip: "0.0.0.0" },
     ...getExternalIds({ context, xandrId }),
-    analytics_storage: getConsentState(),
-    clientVersion: `segment-wrapper@${"4.36.2"}`,
+    clientVersion: `segment-wrapper@${"5.0.0-beta.0"}`,
     gdpr_privacy: gdprPrivacyValueAnalytics,
     gdpr_privacy_advertising: gdprPrivacyValueAdvertising,
-    google_consents,
     integrations: {
       ...context.integrations,
       ...integrations
@@ -697,10 +457,6 @@ var track = (event, properties, context = {}, callback) => new Promise((resolve)
         resolve();
       }
     };
-    const needsConsentManagement = getConfig("googleAnalyticsConsentManagement");
-    if (needsConsentManagement && event === CMP_TRACK_EVENT) {
-      sendGoogleConsents("update", newContext.google_consents);
-    }
     window.analytics.track(
       event,
       newProperties,
@@ -720,7 +476,6 @@ var track = (event, properties, context = {}, callback) => new Promise((resolve)
 var identify = async (userIdParam, traits, options, callback) => {
   const gdprPrivacyValue = await getGdprPrivacyValue();
   const userId = getUserId(userIdParam);
-  setGoogleUserId(userId);
   return window.analytics.identify(
     userId,
     checkAnalyticsGdprIsAccepted(gdprPrivacyValue) ? traits : {},
@@ -764,16 +519,148 @@ if (isClient) {
   }
 }
 
+// src/middlewares/source/pageReferrer.ts
+var referrerState = {
+  spaReferrer: "",
+  referrer: ""
+};
+var utils = {
+  /**
+   * @returns The referrer of the document
+   */
+  getDocumentReferrer: () => document.referrer,
+  /**
+   * @returns The actual location with protocol, domain and pathname
+   */
+  getActualLocation: () => {
+    const { origin, pathname } = window.location;
+    return `${origin}${pathname}`;
+  },
+  /**
+   * @returns The actual query string
+   */
+  getActualQueryString: () => {
+    const { search } = window.location;
+    return search;
+  }
+};
+var getPageReferrer = ({ isPageTrack = false } = {}) => {
+  const { referrer, spaReferrer } = referrerState;
+  const referrerToUse = isPageTrack ? referrer : spaReferrer;
+  return referrerToUse || utils.getDocumentReferrer();
+};
+var updatePageReferrer = () => {
+  referrerState.spaReferrer = getPageReferrer({ isPageTrack: true });
+  referrerState.referrer = utils.getActualLocation();
+};
+var pageReferrer = ({ payload, next }) => {
+  const {
+    obj: { context }
+  } = payload;
+  const { isPageTrack } = context;
+  const referrer = getPageReferrer({ isPageTrack });
+  payload.obj.context = {
+    ...context,
+    page: {
+      ...context.page,
+      referrer
+    }
+  };
+  if (isPageTrack) {
+    updatePageReferrer();
+  }
+  next(payload);
+};
+
+// src/repositories/googleRepository.ts
+var STC = {
+  QUERY: "stc",
+  SPLIT_SYMBOL: "-",
+  CAMPAIGN_SPLIT_SYMBOL: ":"
+};
+var UTM_CAMPAIGN = "utm_campaign";
+var UTM_MEDIUM = "utm_medium";
+var UTM_SOURCE = "utm_source";
+var UTM_CONTENT = "utm_content";
+var UTM_CAMPAIGN_ID = "utm_id";
+var UTM_TERM = "utm_term";
+var STC_MEDIUM_TRANSFORMATIONS = {
+  aff: "affiliate",
+  dis: "display",
+  em: "email",
+  met: "paid-metasearch",
+  sem: "paid-search",
+  rt: "display",
+  sm: "social-media",
+  sp: "paid-social",
+  pn: "push-notification",
+  cs: "cross-sites"
+};
+var STC_INVALID_CONTENT = "na";
+var EMPTY_STC = { medium: null, source: null, campaign: null };
+var trackingTagsTypes = {
+  STC: "stc",
+  UTM: "utm"
+};
+var getCampaignDetails = ({ needsTransformation = true } = {}) => {
+  const { medium, source, campaign, content, term } = readQueryParams();
+  if (!medium || !source || !campaign) return null;
+  const [id, name] = campaign.split(STC.CAMPAIGN_SPLIT_SYMBOL);
+  if (!id && !name) return null;
+  const needsContent = typeof content !== "undefined" && content !== STC_INVALID_CONTENT;
+  return {
+    campaign: {
+      medium: needsTransformation && STC_MEDIUM_TRANSFORMATIONS[medium] || medium,
+      ...typeof name !== "undefined" && { id },
+      name: name ?? id,
+      source,
+      ...needsContent && { content },
+      ...typeof term !== "undefined" && { term }
+    }
+  };
+};
+function readQueryParams() {
+  const search = utils.getActualQueryString();
+  const searchParams = new URLSearchParams(search);
+  return getConfig("trackingTagsType") === trackingTagsTypes.UTM ? readFromUtm(searchParams) : readFromStc(searchParams);
+}
+function readFromStc(searchParams) {
+  if (!hasStc(searchParams)) return EMPTY_STC;
+  const stc = searchParams.get(STC.QUERY);
+  const [medium, source, campaign, content, term] = stc?.split(STC.SPLIT_SYMBOL) || [];
+  return { medium, source, campaign, content, term };
+}
+function hasStc(searchParams) {
+  return searchParams.has(STC.QUERY);
+}
+function readFromUtm(searchParams) {
+  const campaignId = searchParams.get(UTM_CAMPAIGN_ID);
+  const campaignName = searchParams.get(UTM_CAMPAIGN);
+  const medium = searchParams.get(UTM_MEDIUM);
+  const source = searchParams.get(UTM_SOURCE);
+  const content = searchParams.get(UTM_CONTENT);
+  const term = searchParams.get(UTM_TERM);
+  const campaign = campaignId ? `${campaignId}${STC.CAMPAIGN_SPLIT_SYMBOL}${campaignName}` : campaignName;
+  const missingAnyMandatoryFields = !medium || !source || !campaign;
+  if (missingAnyMandatoryFields && hasStc(searchParams)) {
+    return readFromStc(searchParams);
+  }
+  return {
+    campaign,
+    medium,
+    source,
+    content: content ?? void 0,
+    term: term ?? void 0
+  };
+}
+
 // src/middlewares/source/campaignContext.ts
 var campaignContext = ({ payload, next }) => {
-  const googleAnalyticsMeasurementId = getConfig("googleAnalyticsMeasurementId");
-  if (googleAnalyticsMeasurementId) {
-    const campaignDetails = getCampaignDetails();
-    payload.obj.context = {
-      ...payload.obj.context,
-      ...campaignDetails
-    };
-  }
+  const campaignDetails = getCampaignDetails();
+  payload.obj.context = {
+    ...payload.obj.context,
+    ...campaignDetails
+  };
   next(payload);
 };
 
@@ -1001,6 +888,11 @@ var TCFEvents = /* @__PURE__ */ ((TCFEvents2) => {
   return TCFEvents2;
 })(TCFEvents || {});
 
+// src/events.ts
+var EVENTS = {
+  GA4_INIT_EVENT_SENT: "ga4InitEventSent"
+};
+
 // src/utils/storage.ts
 var storage = ({
   type = "localStorage",
@@ -1066,36 +958,11 @@ var addMiddlewares = () => {
   }
 };
 if (isClient && window.analytics) {
-  const googleAnalyticsMeasurementId = getConfig("googleAnalyticsMeasurementId");
-  const dataLayerName = getConfig("googleAnalyticsDataLayer") || DEFAULT_DATA_LAYER_NAME;
-  const needsConsentManagement = getConfig("googleAnalyticsConsentManagement");
-  if (googleAnalyticsMeasurementId) {
-    const googleAnalyticsConfig = getConfig("googleAnalyticsConfig");
-    window[dataLayerName] = window[dataLayerName] || [];
-    window.gtag = window.gtag || function gtag() {
-      ;
-      window[dataLayerName].push(arguments);
-    };
-    window.gtag("js", /* @__PURE__ */ new Date());
-    if (needsConsentManagement) {
-      sendGoogleConsents();
-    }
-    window.gtag("config", googleAnalyticsMeasurementId, {
-      cookie_prefix: "segment",
-      send_page_view: false,
-      ...googleAnalyticsConfig,
-      ...getCampaignDetails()
-    });
-    loadGoogleAnalytics().catch((error) => {
-      console.error("[segment-wrapper] Failed to load Google Analytics", error);
-    });
-  }
   window.analytics.ready(checkAnonymousId);
   window.analytics.addSourceMiddleware ? addMiddlewares() : window.analytics.ready(addMiddlewares);
 }
 var index_default = segmentWrapper_default;
 export {
-  CONSENT_STATES,
   EVENTS,
   TCFEvents,
   UserGDPR,
@@ -1105,6 +972,7 @@ export {
   index_default as default,
   getAdobeMCVisitorID,
   getAdobeVisitorData,
+  getCampaignDetails,
   getConfig,
   getStorageItem,
   getUniversalId,
@@ -1119,5 +987,6 @@ export {
   setConfig,
   setStorageItem,
   storage,
-  toCookieDomain
+  toCookieDomain,
+  trackingTagsTypes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adv-re/segment-wrapper",
-  "version": "4.36.2",
+  "version": "5.0.0-beta.0",
   "description": "Modern TypeScript abstraction layer on top of the Segment library",
   "sideEffects": [
     "./src/utils/patchAnalytics.ts",
@@ -63,4 +63,4 @@
   },
   "author": "",
   "license": "ISC"
-}
+}