feat: added only rokt, all, none click ids when collectClickIdV2Enabl… (#1062)

Author: jaissica12

src/batchUploader.ts

@@ -173,9 +173,12 @@ export class BatchUploader {
 
         let customFlags: SDKEventCustomFlags = {...event.CustomFlags};
         let integrationAttributes: IntegrationAttributes = _Store.integrationAttributes;
+        const integrationSpecificIds = getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds) as boolean;
+        const integrationSpecificIdsV2 = getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIdsV2) as string || '';
+        const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
 
         // https://go.mparticle.com/work/SQDSDKS-5053
-        if (getFeatureFlag && getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds)) {
+        if (isIntegrationCaptureEnabled) {
 
             // Attempt to recapture click IDs in case a third party integration
             // has added or updated  new click IDs since the last event was sent.

src/constants.ts

@@ -184,7 +184,15 @@ const Constants = {
         DirectUrlRouting: 'directURLRouting',
         CacheIdentity: 'cacheIdentity',
         AudienceAPI: 'audienceAPI',
+        // CaptureIntegrationSpecificIds (legacy): boolean flag from server/UI
+        //   - 'True'  → capture all integration-specific IDs
+        //   - 'False' → capture none
         CaptureIntegrationSpecificIds: 'captureIntegrationSpecificIds',
+        // CaptureIntegrationSpecificIdsV2 (new): string mode from server
+        //   - 'all'      → capture all IDs
+        //   - 'none'     → capture none
+        //   - 'roktonly' → capture only Rokt-related IDs
+        CaptureIntegrationSpecificIdsV2: 'captureIntegrationSpecificIdsV2',
         AstBackgroundEvents: 'astBackgroundEvents',
     },
     DefaultInstance: 'default_instance',
@@ -200,6 +208,11 @@ const Constants = {
         Development: 'development',
         Production: 'production',
     },
+    CaptureIntegrationSpecificIdsV2Modes: {
+        All: 'all',
+        None: 'none',
+        RoktOnly: 'roktonly',
+    },
 } as const;
 
 export default Constants;

src/integrationCapture.ts

@@ -1,4 +1,5 @@
 import { SDKEventCustomFlags } from './sdkRuntimeModels';
+import Constants from './constants';
 import { IntegrationAttributes } from './store';
 import {
     Dictionary,
@@ -73,7 +74,7 @@ interface IntegrationIdMapping {
     [key: string]: IntegrationMappingItem;
 }
 
-const integrationMapping: IntegrationIdMapping = {
+const integrationMappingExternal: IntegrationIdMapping = {
     // Facebook / Meta
     fbclid: {
         mappedKey: 'Facebook.ClickId',
@@ -103,6 +104,25 @@ const integrationMapping: IntegrationIdMapping = {
         output: IntegrationOutputs.CUSTOM_FLAGS,
     },
 
+    // TIKTOK
+    ttclid: {
+        mappedKey: 'TikTok.Callback',
+        output: IntegrationOutputs.CUSTOM_FLAGS,
+    },
+    _ttp: {
+        mappedKey: 'tiktok_cookie_id',
+        output: IntegrationOutputs.PARTNER_IDENTITIES,
+    },
+
+    // Snapchat
+    // https://businesshelp.snapchat.com/s/article/troubleshooting-click-id?language=en_US
+    ScCid: {
+        mappedKey: 'SnapchatConversions.ClickId',
+        output: IntegrationOutputs.CUSTOM_FLAGS,
+    },
+};
+
+const integrationMappingRokt: IntegrationIdMapping = {
     // Rokt
     // https://docs.rokt.com/developers/integration-guides/web/advanced/rokt-id-tag/
     // https://go.mparticle.com/work/SQDSDKS-7167
@@ -121,23 +141,6 @@ const integrationMapping: IntegrationIdMapping = {
         output: IntegrationOutputs.INTEGRATION_ATTRIBUTES,
         moduleId: 1277,
     },
-
-    // TIKTOK
-    ttclid: {
-        mappedKey: 'TikTok.Callback',
-        output: IntegrationOutputs.CUSTOM_FLAGS,
-    },
-    _ttp: {
-        mappedKey: 'tiktok_cookie_id',
-        output: IntegrationOutputs.PARTNER_IDENTITIES,
-    },
-
-    // Snapchat
-    // https://businesshelp.snapchat.com/s/article/troubleshooting-click-id?language=en_US
-    ScCid: {
-        mappedKey: 'SnapchatConversions.ClickId',
-        output: IntegrationOutputs.CUSTOM_FLAGS,
-    },
 };
 
 export default class IntegrationCapture {
@@ -146,9 +149,11 @@ export default class IntegrationCapture {
     public readonly filteredPartnerIdentityMappings: IntegrationIdMapping;
     public readonly filteredCustomFlagMappings: IntegrationIdMapping;
     public readonly filteredIntegrationAttributeMappings: IntegrationIdMapping;
+    public captureMode?: valueof<typeof Constants.CaptureIntegrationSpecificIdsV2Modes>;
 
-    constructor() {
+    constructor(captureMode: valueof<typeof Constants.CaptureIntegrationSpecificIdsV2Modes>) {
         this.initialTimestamp = Date.now();
+        this.captureMode = captureMode;
 
         // Cache filtered mappings for faster access
         this.filteredPartnerIdentityMappings = this.filterMappings(IntegrationOutputs.PARTNER_IDENTITIES);
@@ -205,7 +210,8 @@ export default class IntegrationCapture {
      * Captures cookies based on the integration ID mapping.
      */
     public captureCookies(): Dictionary<string> {
-        const cookies = getCookies(Object.keys(integrationMapping));
+        const integrationKeys = this.getAllowedKeysForMode();
+        const cookies = getCookies(integrationKeys);
         return this.applyProcessors(cookies, getHref(), this.initialTimestamp);
     }
 
@@ -221,8 +227,9 @@ export default class IntegrationCapture {
      * Captures local storage based on the integration ID mapping.
      */
     public captureLocalStorage(): Dictionary<string> {
+        const integrationKeys = this.getAllowedKeysForMode();
         let localStorageItems: Dictionary<string> = {};
-        for (const key in integrationMapping) {
+        for (const key of integrationKeys) {
             const localStorageItem = localStorage.getItem(key);
             if (localStorageItem) {
                 localStorageItems[key] = localStorageItem;
@@ -237,7 +244,8 @@ export default class IntegrationCapture {
      * @returns {Dictionary<string>} The query parameters.
      */
     public getQueryParams(): Dictionary<string> {
-        return queryStringParser(getHref(), Object.keys(integrationMapping));
+        const integrationKeys = this.getAllowedKeysForMode();
+        return queryStringParser(getHref(), integrationKeys);
     }
 
     /**
@@ -316,27 +324,52 @@ export default class IntegrationCapture {
         timestamp?: number
     ): Dictionary<string> {
         const processedClickIds: Dictionary<string> = {};
-
+        const integrationKeys = this.getActiveIntegrationMapping();
+    
         for (const key in clickIds) {
             if (clickIds.hasOwnProperty(key)) {
                 const value = clickIds[key];
-                const processor = integrationMapping[key]?.processor;
+                const processor = integrationKeys[key]?.processor;
                 processedClickIds[key] = processor ? processor(value, url, timestamp) : value;
             }
         }
-
         return processedClickIds;
     }
 
     private filterMappings(
         outputType: valueof<typeof IntegrationOutputs>
     ): IntegrationIdMapping {
         const filteredMappings: IntegrationIdMapping = {};
-        for (const key in integrationMapping) {
-            if (integrationMapping[key].output === outputType) {
-                filteredMappings[key] = integrationMapping[key];
+        const integrationKeys = this.getActiveIntegrationMapping();
+        for (const key in integrationKeys) {
+            if (integrationKeys[key].output === outputType) {
+                filteredMappings[key] = integrationKeys[key];
             }
         }
         return filteredMappings;
     }
+
+    /**
+     * Returns the allowed keys to capture based on the current mode.
+     * For RoktOnly, limit capture to Rokt keys; for All, capture all mapped keys.
+     */
+    private getAllowedKeysForMode(): string[] {
+        return Object.keys(this.getActiveIntegrationMapping());
+    }
+    
+    /**
+    * Selects the active integration mapping for the current captureMode.
+    * - 'roktonly': only Rokt IDs are considered
+    * - 'all': both External and Rokt IDs are considered
+    * - else: returns an empty mapping and nothing will be captured
+    */
+    private getActiveIntegrationMapping(): IntegrationIdMapping {
+        if (this.captureMode === Constants.CaptureIntegrationSpecificIdsV2Modes.RoktOnly) {
+            return integrationMappingRokt;
+        }
+        if (this.captureMode === Constants.CaptureIntegrationSpecificIdsV2Modes.All) {
+            return { ...integrationMappingExternal, ...integrationMappingRokt };
+        }
+        return {};
+    }
 }

src/mp-instance.ts

@@ -36,7 +36,7 @@ import Consent, { IConsent } from './consent';
 import KitBlocker from './kitBlocking';
 import ConfigAPIClient, { IKitConfigs } from './configAPIClient';
 import IdentityAPIClient from './identityApiClient';
-import { isFunction, parseConfig } from './utils';
+import { isFunction, parseConfig, valueof } from './utils';
 import { LocalStorageVault } from './vault';
 import { removeExpiredIdentityCacheDates } from './identity-utils';
 import IntegrationCapture from './integrationCapture';
@@ -91,8 +91,8 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _timeOnSiteTimer: ForegroundTimer; 
 }
 
-const { Messages, HTTPCodes, FeatureFlags } = Constants;
-const { ReportBatching, CaptureIntegrationSpecificIds } = FeatureFlags;
+const { Messages, HTTPCodes, FeatureFlags, CaptureIntegrationSpecificIdsV2Modes } = Constants;
+const { ReportBatching, CaptureIntegrationSpecificIds, CaptureIntegrationSpecificIdsV2 } = FeatureFlags;
 const { StartingInitialization } = Messages.InformationMessages;
 
 /**
@@ -128,7 +128,6 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         integrationDelays: {},
         forwarderConstructors: [],
     };
-    this._IntegrationCapture = new IntegrationCapture();
     this._RoktManager = new RoktManager();
 
     // required for forwarders once they reference the mparticle instance
@@ -1354,6 +1353,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
 // Some (server) config settings need to be returned before they are set on SDKConfig in a self hosted environment
 function completeSDKInitialization(apiKey, config, mpInstance) {
     const kitBlocker = createKitBlocker(config, mpInstance);
+    const { getFeatureFlag } = mpInstance._Helpers;
 
     mpInstance._APIClient = new APIClient(mpInstance, kitBlocker);
     mpInstance._Forwarders = new Forwarders(mpInstance, kitBlocker);
@@ -1386,11 +1386,22 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
             ? { userIdentities: currentUserIdentities }
             : mpInstance._Store.SDKConfig.identifyRequest;
 
-        if (mpInstance._Helpers.getFeatureFlag(ReportBatching)) {
+        if (getFeatureFlag(ReportBatching)) {
             mpInstance._ForwardingStatsUploader.startForwardingStatsTimer();
         }
-
-        if (mpInstance._Helpers.getFeatureFlag(CaptureIntegrationSpecificIds)) {
+        // https://go.mparticle.com/work/SQDSDKS-7639
+        const integrationSpecificIds = getFeatureFlag(CaptureIntegrationSpecificIds) as boolean;
+        const integrationSpecificIdsV2 = getFeatureFlag(CaptureIntegrationSpecificIdsV2) as string;
+        
+        const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
+        if (isIntegrationCaptureEnabled) {
+            let captureMode: valueof<typeof CaptureIntegrationSpecificIdsV2Modes> | undefined;
+            if (integrationSpecificIds || integrationSpecificIdsV2 === CaptureIntegrationSpecificIdsV2Modes.All) {
+                captureMode = 'all';
+            } else if (integrationSpecificIdsV2 === CaptureIntegrationSpecificIdsV2Modes.RoktOnly) {
+                captureMode = 'roktonly';
+            }
+            mpInstance._IntegrationCapture = new IntegrationCapture(captureMode);
             mpInstance._IntegrationCapture.capture();
         }
 

src/sdkToEventsApiConverter.ts

@@ -18,11 +18,10 @@ import { SDKIdentityTypeEnum } from './identity.interfaces';
 import Constants from './constants';
 import { IMParticleWebSDKInstance } from './mp-instance';
 
-const { 
-    FeatureFlags
-} = Constants;
+const { FeatureFlags } = Constants;
 const {
-    CaptureIntegrationSpecificIds
+    CaptureIntegrationSpecificIds, 
+    CaptureIntegrationSpecificIdsV2,
 } = FeatureFlags;
 
 type PartnerIdentities = Dictionary<string>;
@@ -127,8 +126,12 @@ export function convertEvents(
             },
         };
     }
+    // https://go.mparticle.com/work/SQDSDKS-7639
+    const integrationSpecificIds = getFeatureFlag && Boolean(getFeatureFlag(CaptureIntegrationSpecificIds));
+    const integrationSpecificIdsV2 = getFeatureFlag && (getFeatureFlag(CaptureIntegrationSpecificIdsV2) as string);
+        
+    const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;
 
-    const isIntegrationCaptureEnabled: boolean = getFeatureFlag && Boolean(getFeatureFlag(CaptureIntegrationSpecificIds));
     if (isIntegrationCaptureEnabled) {
         const capturedPartnerIdentities: PartnerIdentities = _IntegrationCapture?.getClickIdsAsPartnerIdentities();
         if (!isEmpty(capturedPartnerIdentities)) {

src/serverModel.ts

@@ -276,18 +276,22 @@ export default function ServerModel(
             let customFlags: SDKEventCustomFlags = {...event.customFlags};
             let integrationAttributes: IntegrationAttributes = mpInstance._Store.integrationAttributes;
 
+            const { getFeatureFlag } = mpInstance._Helpers;
             // https://go.mparticle.com/work/SQDSDKS-5053
-            if (mpInstance._Helpers.getFeatureFlag && mpInstance._Helpers.getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds)) {
-
+            // https://go.mparticle.com/work/SQDSDKS-7639
+            const integrationSpecificIds = getFeatureFlag && (getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds) as boolean);
+            const integrationSpecificIdsV2 = getFeatureFlag && ((getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIdsV2) as string) || '');
+            const isIntegrationCaptureEnabled = (integrationSpecificIdsV2 && integrationSpecificIdsV2 !== Constants.CaptureIntegrationSpecificIdsV2Modes.None) || integrationSpecificIds === true;     
+            if (isIntegrationCaptureEnabled) {
                 // Attempt to recapture click IDs in case a third party integration
                 // has added or updated  new click IDs since the last event was sent.
                 mpInstance._IntegrationCapture.capture();
                 const transformedClickIDs = mpInstance._IntegrationCapture.getClickIdsAsCustomFlags();
-                customFlags = {...transformedClickIDs, ...customFlags};
-
+                customFlags = { ...transformedClickIDs, ...customFlags };
                 const transformedIntegrationAttributes = mpInstance._IntegrationCapture.getClickIdsAsIntegrationAttributes();
-                integrationAttributes = {...transformedIntegrationAttributes, ...integrationAttributes};
+                integrationAttributes = { ...transformedIntegrationAttributes, ...integrationAttributes };
             }
+            
 
             if (event.hasOwnProperty('toEventAPIObject')) {
                 eventObject = event.toEventAPIObject();

src/store.ts

@@ -145,6 +145,7 @@ export interface IFeatureFlags {
     directURLRouting?: boolean;
     cacheIdentity?: boolean;
     captureIntegrationSpecificIds?: boolean;
+    captureIntegrationSpecificIdsV2?: string;
     astBackgroundEvents?: boolean;
 }
 
@@ -771,6 +772,7 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
         CacheIdentity,
         AudienceAPI,
         CaptureIntegrationSpecificIds,
+        CaptureIntegrationSpecificIdsV2,
         AstBackgroundEvents
     } = Constants.FeatureFlags;
 
@@ -790,8 +792,8 @@ export function processFlags(config: SDKInitConfig): IFeatureFlags {
     flags[CacheIdentity] = config.flags[CacheIdentity] === 'True';
     flags[AudienceAPI] = config.flags[AudienceAPI] === 'True';
     flags[CaptureIntegrationSpecificIds] = config.flags[CaptureIntegrationSpecificIds] === 'True';
+    flags[CaptureIntegrationSpecificIdsV2] = (config.flags[CaptureIntegrationSpecificIdsV2] || 'none');
     flags[AstBackgroundEvents] = config.flags[AstBackgroundEvents] === 'True';
-
     return flags;
 }