@mparticle/web-sdk 2.33.1 → 2.35.0

package/dist/mparticle.js

@@ -203,7 +203,7 @@ var mParticle = (function () {
       Base64: Base64$1
     };
 
-    var version = "2.33.1";
+    var version = "2.35.0";
 
     var Constants = {
       sdkVersion: version,
@@ -363,7 +363,8 @@ var mParticle = (function () {
         DirectUrlRouting: 'directURLRouting',
         CacheIdentity: 'cacheIdentity',
         AudienceAPI: 'audienceAPI',
-        CaptureIntegrationSpecificIds: 'captureIntegrationSpecificIds'
+        CaptureIntegrationSpecificIds: 'captureIntegrationSpecificIds',
+        AstBackgroundEvents: 'astBackgroundEvents'
       },
       DefaultInstance: 'default_instance',
       CCPAPurpose: 'data_sale_opt_out',
@@ -1800,8 +1801,13 @@ var mParticle = (function () {
     }
     function convertAST(sdkEvent) {
       var commonEventData = convertBaseEventData(sdkEvent);
+      // Determine the transition type based on IsBackgroundAST flag
+      var _a = dist.ApplicationStateTransitionEventDataApplicationTransitionTypeEnum,
+        applicationBackground = _a.applicationBackground,
+        applicationInitialized = _a.applicationInitialized;
+      var transitionType = sdkEvent.IsBackgroundAST ? applicationBackground : applicationInitialized;
       var astEventData = {
-        application_transition_type: dist.ApplicationStateTransitionEventDataApplicationTransitionTypeEnum.applicationInitialized,
+        application_transition_type: transitionType,
         is_first_run: sdkEvent.IsFirstRun,
         is_upgrade: false,
         launch_referral: sdkEvent.LaunchReferral
@@ -2198,6 +2204,53 @@ var mParticle = (function () {
       return XHRUploader;
     }(AsyncUploader);
 
+    function hasMPIDAndUserLoginChanged(previousUser, newUser) {
+      return !previousUser || newUser.getMPID() !== previousUser.getMPID() || previousUser.isLoggedIn() !== newUser.isLoggedIn();
+    }
+    // https://go.mparticle.com/work/SQDSDKS-6504
+    function hasMPIDChanged(prevUser, identityApiResult) {
+      return !prevUser || prevUser.getMPID() && identityApiResult.mpid && identityApiResult.mpid !== prevUser.getMPID();
+    }
+    // https://go.mparticle.com/work/SQDSDKS-7136
+    function appendUserInfo(user, event) {
+      if (!event) {
+        return;
+      }
+      if (!user) {
+        event.MPID = null;
+        event.ConsentState = null;
+        event.UserAttributes = null;
+        event.UserIdentities = null;
+        return;
+      }
+      if (event.MPID && event.MPID === user.getMPID()) {
+        return;
+      }
+      event.MPID = user.getMPID();
+      event.ConsentState = user.getConsentState();
+      event.UserAttributes = user.getAllUserAttributes();
+      var userIdentities = user.getUserIdentities().userIdentities;
+      var dtoUserIdentities = {};
+      for (var identityKey in userIdentities) {
+        var identityType = Types.IdentityType.getIdentityType(identityKey);
+        if (identityType !== false) {
+          dtoUserIdentities[identityType] = userIdentities[identityKey];
+        }
+      }
+      var validUserIdentities = [];
+      if (isObject(dtoUserIdentities)) {
+        if (Object.keys(dtoUserIdentities).length) {
+          for (var key in dtoUserIdentities) {
+            var userIdentity = {};
+            userIdentity.Identity = dtoUserIdentities[key];
+            userIdentity.Type = parseNumber(key);
+            validUserIdentities.push(userIdentity);
+          }
+        }
+      }
+      event.UserIdentities = validUserIdentities;
+    }
+
     /**
      * BatchUploader contains all the logic to store/retrieve events and batches
      * to/from persistence, and upload batches to mParticle.
@@ -2222,6 +2275,8 @@ var mParticle = (function () {
       function BatchUploader(mpInstance, uploadInterval) {
         var _a;
         this.offlineStorageEnabled = false;
+        this.lastASTEventTime = 0;
+        this.AST_DEBOUNCE_MS = 1000; // 1 second debounce
         this.mpInstance = mpInstance;
         this.uploadIntervalMillis = uploadInterval;
         this.batchingEnabled = uploadInterval >= BatchUploader.MINIMUM_INTERVAL_MILLIS;
@@ -2269,20 +2324,78 @@ var mParticle = (function () {
         //       https://go.mparticle.com/work/SQDSDKS-5022
         return offlineStoragePercentage >= rampNumber;
       };
+      // debounce AST just in case multiple events are fired in a short period of time due to browser differences
+      BatchUploader.prototype.shouldDebounceAndUpdateLastASTTime = function () {
+        var now = Date.now();
+        if (now - this.lastASTEventTime < this.AST_DEBOUNCE_MS) {
+          return true;
+        }
+        this.lastASTEventTime = now;
+        return false;
+      };
+      // https://go.mparticle.com/work/SQDSDKS-7133
+      BatchUploader.prototype.createBackgroundASTEvent = function () {
+        var now = Date.now();
+        var _a = this.mpInstance,
+          _Store = _a._Store,
+          Identity = _a.Identity,
+          _timeOnSiteTimer = _a._timeOnSiteTimer,
+          _Helpers = _a._Helpers;
+        var sessionId = _Store.sessionId,
+          deviceId = _Store.deviceId,
+          sessionStartDate = _Store.sessionStartDate,
+          SDKConfig = _Store.SDKConfig;
+        var generateUniqueId = _Helpers.generateUniqueId;
+        var getCurrentUser = Identity.getCurrentUser;
+        var event = {
+          AppName: SDKConfig.appName,
+          AppVersion: SDKConfig.appVersion,
+          Package: SDKConfig["package"],
+          EventDataType: MessageType$1.AppStateTransition,
+          Timestamp: now,
+          SessionId: sessionId,
+          DeviceId: deviceId,
+          IsFirstRun: false,
+          SourceMessageId: generateUniqueId(),
+          SDKVersion: Constants.sdkVersion,
+          CustomFlags: {},
+          EventAttributes: {},
+          SessionStartDate: (sessionStartDate === null || sessionStartDate === void 0 ? void 0 : sessionStartDate.getTime()) || now,
+          Debug: SDKConfig.isDevelopmentMode,
+          ActiveTimeOnSite: (_timeOnSiteTimer === null || _timeOnSiteTimer === void 0 ? void 0 : _timeOnSiteTimer.getTimeInForeground()) || 0,
+          IsBackgroundAST: true
+        };
+        appendUserInfo(getCurrentUser(), event);
+        return event;
+      };
       // Adds listeners to be used trigger Navigator.sendBeacon if the browser
       // loses focus for any reason, such as closing browser tab or minimizing window
       BatchUploader.prototype.addEventListeners = function () {
+        var _this_1 = this;
         var _this = this;
+        var handleExit = function handleExit() {
+          // Check for debounce before creating and queueing event
+          var getFeatureFlag = _this_1.mpInstance._Helpers.getFeatureFlag;
+          var AstBackgroundEvents = Constants.FeatureFlags.AstBackgroundEvents;
+          if (getFeatureFlag(AstBackgroundEvents)) {
+            if (_this.shouldDebounceAndUpdateLastASTTime()) {
+              return;
+            }
+            // Add application state transition event to queue
+            var event_1 = _this.createBackgroundASTEvent();
+            _this.queueEvent(event_1);
+          }
+          // Then trigger the upload with beacon
+          _this.prepareAndUpload(false, _this.isBeaconAvailable());
+        };
         // visibility change is a document property, not window
         document.addEventListener('visibilitychange', function () {
-          _this.prepareAndUpload(false, _this.isBeaconAvailable());
-        });
-        window.addEventListener('beforeunload', function () {
-          _this.prepareAndUpload(false, _this.isBeaconAvailable());
-        });
-        window.addEventListener('pagehide', function () {
-          _this.prepareAndUpload(false, _this.isBeaconAvailable());
+          if (document.visibilityState === 'hidden') {
+            handleExit();
+          }
         });
+        window.addEventListener('beforeunload', handleExit);
+        window.addEventListener('pagehide', handleExit);
       };
       BatchUploader.prototype.isBeaconAvailable = function () {
         if (navigator.sendBeacon) {
@@ -2567,7 +2680,7 @@ var mParticle = (function () {
       this.appendUserInfoToEvents = function (user, events) {
         events.forEach(function (event) {
           if (!event.MPID) {
-            mpInstance._ServerModel.appendUserInfo(user, event);
+            appendUserInfo(user, event);
           }
         });
       };
@@ -4355,7 +4468,8 @@ var mParticle = (function () {
         DirectUrlRouting = _a.DirectUrlRouting,
         CacheIdentity = _a.CacheIdentity,
         AudienceAPI = _a.AudienceAPI,
-        CaptureIntegrationSpecificIds = _a.CaptureIntegrationSpecificIds;
+        CaptureIntegrationSpecificIds = _a.CaptureIntegrationSpecificIds,
+        AstBackgroundEvents = _a.AstBackgroundEvents;
       if (!config.flags) {
         return {};
       }
@@ -4369,6 +4483,7 @@ var mParticle = (function () {
       flags[CacheIdentity] = config.flags[CacheIdentity] === 'True';
       flags[AudienceAPI] = config.flags[AudienceAPI] === 'True';
       flags[CaptureIntegrationSpecificIds] = config.flags[CaptureIntegrationSpecificIds] === 'True';
+      flags[AstBackgroundEvents] = config.flags[AstBackgroundEvents] === 'True';
       return flags;
     }
     function processBaseUrls(config, flags, apiKey) {
@@ -6558,45 +6673,6 @@ var mParticle = (function () {
     }
     function ServerModel(mpInstance) {
       var self = this;
-      // TODO: Can we refactor this to not mutate the event?
-      this.appendUserInfo = function (user, event) {
-        if (!event) {
-          return;
-        }
-        if (!user) {
-          event.MPID = null;
-          event.ConsentState = null;
-          event.UserAttributes = null;
-          event.UserIdentities = null;
-          return;
-        }
-        if (event.MPID && event.MPID === user.getMPID()) {
-          return;
-        }
-        event.MPID = user.getMPID();
-        event.ConsentState = user.getConsentState();
-        event.UserAttributes = user.getAllUserAttributes();
-        var userIdentities = user.getUserIdentities().userIdentities;
-        var dtoUserIdentities = {};
-        for (var identityKey in userIdentities) {
-          var identityType = Types.IdentityType.getIdentityType(identityKey);
-          if (identityType !== false) {
-            dtoUserIdentities[identityType] = userIdentities[identityKey];
-          }
-        }
-        var validUserIdentities = [];
-        if (mpInstance._Helpers.isObject(dtoUserIdentities)) {
-          if (Object.keys(dtoUserIdentities).length) {
-            for (var key in dtoUserIdentities) {
-              var userIdentity = {};
-              userIdentity.Identity = dtoUserIdentities[key];
-              userIdentity.Type = mpInstance._Helpers.parseNumber(key);
-              validUserIdentities.push(userIdentity);
-            }
-          }
-        }
-        event.UserIdentities = validUserIdentities;
-      };
       this.convertToConsentStateV2DTO = function (state) {
         if (!state) {
           return null;
@@ -6713,7 +6789,7 @@ var mParticle = (function () {
           // FIXME: Remove duplicate occurence
           eventObject.CurrencyCode = mpInstance._Store.currencyCode;
           var currentUser = user || mpInstance.Identity.getCurrentUser();
-          self.appendUserInfo(currentUser, eventObject);
+          appendUserInfo(currentUser, eventObject);
           if (event.messageType === Types.MessageType.SessionEnd) {
             eventObject.SessionLength = mpInstance._Store.dateLastEventSent.getTime() - mpInstance._Store.sessionStartDate.getTime();
             eventObject.currentSessionMPIDs = mpInstance._Store.currentSessionMPIDs;
@@ -7088,14 +7164,6 @@ var mParticle = (function () {
       return AudienceManager;
     }();
 
-    function hasMPIDAndUserLoginChanged(previousUser, newUser) {
-      return !previousUser || newUser.getMPID() !== previousUser.getMPID() || previousUser.isLoggedIn() !== newUser.isLoggedIn();
-    }
-    // https://go.mparticle.com/work/SQDSDKS-6504
-    function hasMPIDChanged(prevUser, identityApiResult) {
-      return !prevUser || prevUser.getMPID() && identityApiResult.mpid && identityApiResult.mpid !== prevUser.getMPID();
-    }
-
     var _this = undefined;
     var processReadyQueue = function processReadyQueue(readyQueue) {
       if (!isEmpty(readyQueue)) {
@@ -9374,6 +9442,12 @@ var mParticle = (function () {
       _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
       }
     };
     var IntegrationCapture = /** @class */function () {
@@ -9530,6 +9604,62 @@ var mParticle = (function () {
       return IntegrationCapture;
     }();
 
+    var RoktManager = /** @class */function () {
+      function RoktManager() {
+        this.launcher = null;
+        this.messageQueue = [];
+        this.launcher = null;
+      }
+      RoktManager.prototype.attachLauncher = function (launcher) {
+        this.setLauncher(launcher);
+        this.processMessageQueue();
+      };
+      RoktManager.prototype.selectPlacements = function (options) {
+        if (!this.launcher) {
+          this.queueMessage({
+            methodName: 'selectPlacements',
+            payload: options
+          });
+          return Promise.resolve({});
+        }
+        try {
+          return this.launcher.selectPlacements(options);
+        } catch (error) {
+          return Promise.reject(error instanceof Error ? error : new Error('Unknown error occurred'));
+        }
+      };
+      RoktManager.prototype.processMessageQueue = function () {
+        var _this = this;
+        if (this.messageQueue.length > 0) {
+          this.messageQueue.forEach(function (message) {
+            return __awaiter(_this, void 0, void 0, function () {
+              return __generator(this, function (_a) {
+                switch (_a.label) {
+                  case 0:
+                    if (!(this.launcher && message.methodName in this.launcher)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, this.launcher[message.methodName](message.payload)];
+                  case 1:
+                    _a.sent();
+                    _a.label = 2;
+                  case 2:
+                    return [2 /*return*/];
+                }
+              });
+            });
+          });
+
+          this.messageQueue = [];
+        }
+      };
+      RoktManager.prototype.queueMessage = function (message) {
+        this.messageQueue.push(message);
+      };
+      RoktManager.prototype.setLauncher = function (launcher) {
+        this.launcher = launcher;
+      };
+      return RoktManager;
+    }();
+
     var Messages = Constants.Messages,
       HTTPCodes = Constants.HTTPCodes,
       FeatureFlags = Constants.FeatureFlags;
@@ -9569,6 +9699,7 @@ var mParticle = (function () {
         forwarderConstructors: []
       };
       this._IntegrationCapture = new IntegrationCapture();
+      this._RoktManager = new RoktManager();
       // required for forwarders once they reference the mparticle instance
       this.IdentityType = IdentityType;
       this.EventType = EventType;
@@ -10842,7 +10973,7 @@ var mParticle = (function () {
       // Only leaving this here in case any clients are trying to access mParticle.Store, to prevent from throwing
       this.Store = {};
       this._instances = {};
-      this.IdentityType = Types.IdentityType;
+      this.IdentityType = IdentityType;
       this.EventType = EventType;
       this.CommerceEventType = CommerceEventType;
       this.PromotionType = PromotionActionType;
@@ -10893,6 +11024,7 @@ var mParticle = (function () {
           return client;
         }
       };
+      this.Rokt = self.getInstance()._RoktManager;
       this.getDeviceId = function () {
         return self.getInstance().getDeviceId();
       };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mparticle/web-sdk",
-    "version": "2.33.1",
+    "version": "2.35.0",
     "description": "mParticle core SDK for web applications",
     "license": "Apache-2.0",
     "keywords": [

package/src/apiClient.ts

@@ -9,6 +9,7 @@ import { MPForwarder } from './forwarders.interfaces';
 import { IMParticleUser, ISDKUserAttributes } from './identity-user-interfaces';
 import { AsyncUploader, FetchUploader, XHRUploader } from './uploaders';
 import { IMParticleWebSDKInstance } from './mp-instance';
+import { appendUserInfo } from './user-utils';
 
 export interface IAPIClient {
     uploader: BatchUploader | null;
@@ -82,7 +83,7 @@ export default function APIClient(
     this.appendUserInfoToEvents = function(user, events) {
         events.forEach(function(event) {
             if (!event.MPID) {
-                mpInstance._ServerModel.appendUserInfo(user, event);
+                appendUserInfo(user, event);
             }
         });
     };

package/src/batchUploader.ts

@@ -2,7 +2,7 @@ import { Batch } from '@mparticle/event-models';
 import Constants from './constants';
 import { SDKEvent, SDKLoggerApi } from './sdkRuntimeModels';
 import { convertEvents } from './sdkToEventsApiConverter';
-import { MessageType } from './types';
+import { MessageType, EventType } from './types';
 import { getRampNumber, isEmpty } from './utils';
 import { SessionStorageVault, LocalStorageVault } from './vault';
 import {
@@ -13,7 +13,7 @@ import {
 } from './uploaders';
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
-
+import { appendUserInfo } from './user-utils';
 /**
  * BatchUploader contains all the logic to store/retrieve events and batches
  * to/from persistence, and upload batches to mParticle.
@@ -44,6 +44,8 @@ export class BatchUploader {
     private batchVault: LocalStorageVault<Batch[]>;
     private offlineStorageEnabled: boolean = false;
     private uploader: AsyncUploader;
+    private lastASTEventTime: number = 0;
+    private readonly AST_DEBOUNCE_MS: number = 1000; // 1 second debounce
 
     /**
      * Creates an instance of a BatchUploader
@@ -129,21 +131,79 @@ export class BatchUploader {
         return offlineStoragePercentage >= rampNumber;
     }
 
+    // debounce AST just in case multiple events are fired in a short period of time due to browser differences
+    private shouldDebounceAndUpdateLastASTTime(): boolean {
+        const now = Date.now();
+        if (now - this.lastASTEventTime < this.AST_DEBOUNCE_MS) {
+            return true;
+        }
+
+        this.lastASTEventTime = now;
+        return false;
+    }
+
+    // https://go.mparticle.com/work/SQDSDKS-7133
+    private createBackgroundASTEvent(): SDKEvent {
+        const now = Date.now();
+        const { _Store, Identity, _timeOnSiteTimer, _Helpers  } = this.mpInstance;
+        const { sessionId, deviceId, sessionStartDate, SDKConfig } = _Store;
+        const { generateUniqueId } = _Helpers;
+        const { getCurrentUser } = Identity;
+
+        const event = {
+            AppName: SDKConfig.appName,
+            AppVersion: SDKConfig.appVersion,
+            Package: SDKConfig.package,
+            EventDataType: MessageType.AppStateTransition,
+            Timestamp: now,
+            SessionId: sessionId,
+            DeviceId: deviceId,
+            IsFirstRun: false,
+            SourceMessageId: generateUniqueId(),
+            SDKVersion: Constants.sdkVersion,
+            CustomFlags: {},
+            EventAttributes: {},
+            SessionStartDate: sessionStartDate?.getTime() || now,
+            Debug: SDKConfig.isDevelopmentMode,
+            ActiveTimeOnSite: _timeOnSiteTimer?.getTimeInForeground() || 0,
+            IsBackgroundAST: true
+        } as SDKEvent;
+
+        appendUserInfo(getCurrentUser(), event);
+        return event;
+    }
+
     // Adds listeners to be used trigger Navigator.sendBeacon if the browser
     // loses focus for any reason, such as closing browser tab or minimizing window
     private addEventListeners() {
         const _this = this;
 
+        const handleExit = () => {
+            // Check for debounce before creating and queueing event
+            const {
+                _Helpers: { getFeatureFlag },
+            } = this.mpInstance;
+            const { AstBackgroundEvents } = Constants.FeatureFlags;
+
+            if (getFeatureFlag(AstBackgroundEvents)) {
+                if (_this.shouldDebounceAndUpdateLastASTTime()) {
+                    return;
+                }
+                // Add application state transition event to queue
+                const event = _this.createBackgroundASTEvent();
+                _this.queueEvent(event);
+            }
+            // Then trigger the upload with beacon
+            _this.prepareAndUpload(false, _this.isBeaconAvailable());
+        };
         // visibility change is a document property, not window
         document.addEventListener('visibilitychange', () => {
-            _this.prepareAndUpload(false, _this.isBeaconAvailable());
-        });
-        window.addEventListener('beforeunload', () => {
-            _this.prepareAndUpload(false, _this.isBeaconAvailable());
-        });
-        window.addEventListener('pagehide', () => {
-            _this.prepareAndUpload(false, _this.isBeaconAvailable());
+            if (document.visibilityState === 'hidden') {
+                handleExit();
+            }
         });
+        window.addEventListener('beforeunload', handleExit);
+        window.addEventListener('pagehide', handleExit);
     }
 
     private isBeaconAvailable(): boolean {
@@ -387,6 +447,7 @@ export class BatchUploader {
                 let blob = new Blob([fetchPayload.body], {
                     type: 'text/plain;charset=UTF-8',
                 });
+
                 navigator.sendBeacon(this.uploadUrl, blob);
             } else {
                 try {

package/src/constants.ts

@@ -175,6 +175,7 @@ const Constants = {
         CacheIdentity: 'cacheIdentity',
         AudienceAPI: 'audienceAPI',
         CaptureIntegrationSpecificIds: 'captureIntegrationSpecificIds',
+        AstBackgroundEvents: 'astBackgroundEvents',
     },
     DefaultInstance: 'default_instance',
     CCPAPurpose: 'data_sale_opt_out',

package/src/forwarders.interfaces.ts

@@ -1,6 +1,6 @@
 import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
 import { Dictionary } from './utils';
-import { IKitConfigs } from './configAPIClient';
+import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
 import { IdentityApiData } from '@mparticle/web-sdk';
 import {
     IMParticleUser,
@@ -8,28 +8,37 @@ import {
     UserAttributes,
 } from './identity-user-interfaces';
 
-// TODO: https://go.mparticle.com/work/SQDSDKS-6035
-export type Kit = Dictionary;
+// TODO: https://go.mparticle.com/work/SQDSDKS-4475
 export type MPForwarder = Dictionary;
 
 // The state of the kit when accessed via window.KitName via CDN
 // or imported as an NPM package
 export interface UnregisteredKit {
-    register(config): void;
+    constructor: () => void;
+    register(config: KitRegistrationConfig): void;
+    name: string;
+    suffix?: string;
 }
 
 // The state of the kit after being added to forwarderConstructors in the CDN
 // or after registered to SDKConfig.kits via NPM
 export interface RegisteredKit {
-    constructor(): void;
-    name: string;
-    getId(): number;
+    constructor: () => void;
+
+    // Applies to sideloaded kits only
+    filters?: IKitFilterSettings;
+}
+
+// This is the subset of the SDKConfig.kits object that is used to register kits.
+export interface KitRegistrationConfig {
+    kits: Dictionary<RegisteredKit>;
 }
 
 // The state of the kit after being configured. This is what the kit looks like when acted on.
 export interface ConfiguredKit
     extends Omit<IKitConfigs, 'isDebugString' | 'hasDebugString'> {
     common: Dictionary<unknown>;
+    id: number;
     init(
         settings: Dictionary<unknown>,
         service: forwardingStatsCallback,
@@ -45,22 +54,22 @@ export interface ConfiguredKit
     onIdentifyComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onLoginComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onLogoutComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
+    ): string;
     onModifyComplete(
         user: IMParticleUser,
         filteredIdentityRequest: IdentityApiData
-    ): string | KitMappedMethodFailure;
-    onUserIdentified(user: IMParticleUser): string | KitMappedMethodFailure;
+    ): string;
+    onUserIdentified(user: IMParticleUser): string;
     process(event: SDKEvent): string;
-    setOptOut(isOptingOut: boolean): string | KitMappedMethodFailure;
+    setOptOut(isOptingOut: boolean): string;
     removeUserAttribute(key: string): string;
     setUserAttribute(key: string, value: string): string;
     setUserIdentity(id: UserIdentityId, type: UserIdentityType): void;
@@ -69,9 +78,6 @@ export interface ConfiguredKit
     isSandbox: boolean;
     hasSandbox: boolean;
 }
-export interface KitMappedMethodFailure {
-    error: string;
-}
 
 export type UserIdentityId = string;
 export type UserIdentityType = number;

package/src/integrationCapture.ts

@@ -125,6 +125,13 @@ const integrationMapping: IntegrationIdMapping = {
         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 {

package/src/mp-instance.ts

@@ -49,6 +49,7 @@ import { IECommerce } from './ecommerce.interfaces';
 import { INativeSdkHelpers } from './nativeSdkHelpers.interfaces';
 import { IPersistence } from './persistence.interfaces';
 import ForegroundTimer from './foregroundTimeTracker';
+import RoktManager from './roktManager';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -80,6 +81,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _IntegrationCapture: IntegrationCapture;
     _NativeSdkHelpers: INativeSdkHelpers;
     _Persistence: IPersistence;
+    _RoktManager: RoktManager;
     _SessionManager: ISessionManager;
     _ServerModel: IServerModel;
     _Store: IStore;
@@ -126,13 +128,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         forwarderConstructors: [],
     };
     this._IntegrationCapture = new IntegrationCapture();
+    this._RoktManager = new RoktManager();
 
     // required for forwarders once they reference the mparticle instance
     this.IdentityType = IdentityType;
-    this.EventType = EventType as unknown as valueof<typeof EventType>;
-    this.CommerceEventType = CommerceEventType as unknown as valueof<typeof CommerceEventType>;
-    this.PromotionType = PromotionActionType as unknown as valueof<typeof PromotionActionType>;
-    this.ProductActionType = ProductActionType as unknown as valueof<typeof ProductActionType>;
+    this.EventType = EventType;
+    this.CommerceEventType = CommerceEventType;
+    this.PromotionType = PromotionActionType;
+    this.ProductActionType = ProductActionType;
 
 
     this._Identity = new Identity(this);