@mparticle/web-sdk 2.61.0 → 2.62.0

package/dist/mparticle.common.js

@@ -15,7 +15,7 @@ map:function map(a,b){var c,d,e;if(null===this)throw new TypeError(" this is nul
 filter:function filter(a/*, thisArg*/){if(void 0===this||null===this)throw new TypeError;var b=Object(this),c=b.length>>>0;if("function"!=typeof a)throw new TypeError;for(var d=[],e=2<=arguments.length?arguments[1]:void 0,f=0;f<c;f++)if(f in b){var g=b[f];a.call(e,g,f,b)&&d.push(g);}return d},// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
 isArray:function isArray(a){return "[object Array]"===Object.prototype.toString.call(a)},Base64:Base64$1};
 
-var version = "2.61.0";
+var version = "2.62.0";
 
 var Constants={sdkVersion:version,sdkVendor:"mparticle",platform:"web",Messages:{DeprecationMessages:{MethodHasBeenDeprecated:"has been deprecated.",MethodMarkedForDeprecationPostfix:"is a deprecated method and will be removed in future releases.",AlternativeMethodPrefix:"Please use the alternate method:"},ErrorMessages:{NoToken:"A token must be specified.",EventNameInvalidType:"Event name must be a valid string value.",EventDataInvalidType:"Event data must be a valid object hash.",LoggingDisabled:"Event logging is currently disabled.",CookieParseError:"Could not parse cookie",EventEmpty:"Event object is null or undefined, cancelling send",APIRequestEmpty:"APIRequest is null or undefined, cancelling send",NoEventType:"Event type must be specified.",TransactionIdRequired:"Transaction ID is required",TransactionRequired:"A transaction attributes object is required",PromotionIdRequired:"Promotion ID is required",BadAttribute:"Attribute value cannot be object or array",BadKey:"Key value cannot be object or array",BadLogPurchase:"Transaction attributes and a product are both required to log a purchase, https://docs.mparticle.com/?javascript#measuring-transactions",AudienceAPINotEnabled:"Your workspace is not enabled to retrieve user audiences."},InformationMessages:{CookieSearch:"Searching for cookie",CookieFound:"Cookie found, parsing values",CookieNotFound:"Cookies not found",CookieSet:"Setting cookie",CookieSync:"Performing cookie sync",SendBegin:"Starting to send event",SendIdentityBegin:"Starting to send event to identity server",SendWindowsPhone:"Sending event to Windows Phone container",SendIOS:"Calling iOS path: ",SendAndroid:"Calling Android JS interface method: ",SendHttp:"Sending event to mParticle HTTP service",SendAliasHttp:"Sending alias request to mParticle HTTP service",SendIdentityHttp:"Sending event to mParticle HTTP service",StartingNewSession:"Starting new Session",StartingLogEvent:"Starting to log event",StartingLogOptOut:"Starting to log user opt in/out",StartingEndSession:"Starting to end session",StartingInitialization:"Starting to initialize",StartingLogCommerceEvent:"Starting to log commerce event",StartingAliasRequest:"Starting to Alias MPIDs",LoadingConfig:"Loading configuration options",AbandonLogEvent:"Cannot log event, logging disabled or developer token not set",AbandonAliasUsers:"Cannot Alias Users, logging disabled or developer token not set",AbandonStartSession:"Cannot start session, logging disabled or developer token not set",AbandonEndSession:"Cannot end session, logging disabled or developer token not set",NoSessionToEnd:"Cannot end session, no active session found"},ValidationMessages:{ModifyIdentityRequestUserIdentitiesPresent:"identityRequests to modify require userIdentities to be present. Request not sent to server. Please fix and try again",IdentityRequesetInvalidKey:"There is an invalid key on your identityRequest object. It can only contain a `userIdentities` object and a `onUserAlias` function. Request not sent to server. Please fix and try again.",OnUserAliasType:"The onUserAlias value must be a function.",UserIdentities:"The userIdentities key must be an object with keys of identityTypes and values of strings. Request not sent to server. Please fix and try again.",UserIdentitiesInvalidKey:"There is an invalid identity key on your `userIdentities` object within the identityRequest. Request not sent to server. Please fix and try again.",UserIdentitiesInvalidValues:"All user identity values must be strings or null. Request not sent to server. Please fix and try again.",AliasMissingMpid:"Alias Request must contain both a destinationMpid and a sourceMpid",AliasNonUniqueMpid:"Alias Request's destinationMpid and sourceMpid must be unique",AliasMissingTime:"Alias Request must have both a startTime and an endTime",AliasStartBeforeEndTime:"Alias Request's endTime must be later than its startTime"}},NativeSdkPaths:{LogEvent:"logEvent",SetUserTag:"setUserTag",RemoveUserTag:"removeUserTag",SetUserAttribute:"setUserAttribute",RemoveUserAttribute:"removeUserAttribute",SetSessionAttribute:"setSessionAttribute",AddToCart:"addToCart",RemoveFromCart:"removeFromCart",ClearCart:"clearCart",LogOut:"logOut",SetUserAttributeList:"setUserAttributeList",RemoveAllUserAttributes:"removeAllUserAttributes",GetUserAttributesLists:"getUserAttributesLists",GetAllUserAttributes:"getAllUserAttributes",Identify:"identify",Logout:"logout",Login:"login",Modify:"modify",Alias:"aliasUsers",Upload:"upload"},StorageNames:{localStorageName:"mprtcl-api",localStorageNameV3:"mprtcl-v3",cookieName:"mprtcl-api",cookieNameV2:"mprtcl-v2",cookieNameV3:"mprtcl-v3",localStorageNameV4:"mprtcl-v4",localStorageProductsV4:"mprtcl-prodv4",cookieNameV4:"mprtcl-v4",currentStorageName:"mprtcl-v4",currentStorageProductsName:"mprtcl-prodv4"},DefaultConfig:{cookieDomain:null,cookieExpiration:365,logLevel:null,timeout:300,sessionTimeout:30,maxProducts:20,forwarderStatsTimeout:5e3,integrationDelayTimeout:5e3,maxCookieSize:3e3,aliasMaxWindow:90,uploadInterval:0// Maximum milliseconds in between batch uploads, below 500 will mean immediate upload.  The server returns this as a string, but we are using it as a number internally
 },DefaultBaseUrls:{v1SecureServiceUrl:"jssdks.mparticle.com/v1/JS/",v2SecureServiceUrl:"jssdks.mparticle.com/v2/JS/",v3SecureServiceUrl:"jssdks.mparticle.com/v3/JS/",configUrl:"jssdkcdns.mparticle.com/JS/v2/",identityUrl:"identity.mparticle.com/v1/",aliasUrl:"jssdks.mparticle.com/v1/identity/",userAudienceUrl:"nativesdks.mparticle.com/v1/"},// These are the paths that are used to construct the CNAME urls

package/dist/mparticle.esm.js

@@ -15,7 +15,7 @@ map:function map(a,b){var c,d,e;if(null===this)throw new TypeError(" this is nul
 filter:function filter(a/*, thisArg*/){if(void 0===this||null===this)throw new TypeError;var b=Object(this),c=b.length>>>0;if("function"!=typeof a)throw new TypeError;for(var d=[],e=2<=arguments.length?arguments[1]:void 0,f=0;f<c;f++)if(f in b){var g=b[f];a.call(e,g,f,b)&&d.push(g);}return d},// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
 isArray:function isArray(a){return "[object Array]"===Object.prototype.toString.call(a)},Base64:Base64$1};
 
-var version = "2.61.0";
+var version = "2.62.0";
 
 var Constants={sdkVersion:version,sdkVendor:"mparticle",platform:"web",Messages:{DeprecationMessages:{MethodHasBeenDeprecated:"has been deprecated.",MethodMarkedForDeprecationPostfix:"is a deprecated method and will be removed in future releases.",AlternativeMethodPrefix:"Please use the alternate method:"},ErrorMessages:{NoToken:"A token must be specified.",EventNameInvalidType:"Event name must be a valid string value.",EventDataInvalidType:"Event data must be a valid object hash.",LoggingDisabled:"Event logging is currently disabled.",CookieParseError:"Could not parse cookie",EventEmpty:"Event object is null or undefined, cancelling send",APIRequestEmpty:"APIRequest is null or undefined, cancelling send",NoEventType:"Event type must be specified.",TransactionIdRequired:"Transaction ID is required",TransactionRequired:"A transaction attributes object is required",PromotionIdRequired:"Promotion ID is required",BadAttribute:"Attribute value cannot be object or array",BadKey:"Key value cannot be object or array",BadLogPurchase:"Transaction attributes and a product are both required to log a purchase, https://docs.mparticle.com/?javascript#measuring-transactions",AudienceAPINotEnabled:"Your workspace is not enabled to retrieve user audiences."},InformationMessages:{CookieSearch:"Searching for cookie",CookieFound:"Cookie found, parsing values",CookieNotFound:"Cookies not found",CookieSet:"Setting cookie",CookieSync:"Performing cookie sync",SendBegin:"Starting to send event",SendIdentityBegin:"Starting to send event to identity server",SendWindowsPhone:"Sending event to Windows Phone container",SendIOS:"Calling iOS path: ",SendAndroid:"Calling Android JS interface method: ",SendHttp:"Sending event to mParticle HTTP service",SendAliasHttp:"Sending alias request to mParticle HTTP service",SendIdentityHttp:"Sending event to mParticle HTTP service",StartingNewSession:"Starting new Session",StartingLogEvent:"Starting to log event",StartingLogOptOut:"Starting to log user opt in/out",StartingEndSession:"Starting to end session",StartingInitialization:"Starting to initialize",StartingLogCommerceEvent:"Starting to log commerce event",StartingAliasRequest:"Starting to Alias MPIDs",LoadingConfig:"Loading configuration options",AbandonLogEvent:"Cannot log event, logging disabled or developer token not set",AbandonAliasUsers:"Cannot Alias Users, logging disabled or developer token not set",AbandonStartSession:"Cannot start session, logging disabled or developer token not set",AbandonEndSession:"Cannot end session, logging disabled or developer token not set",NoSessionToEnd:"Cannot end session, no active session found"},ValidationMessages:{ModifyIdentityRequestUserIdentitiesPresent:"identityRequests to modify require userIdentities to be present. Request not sent to server. Please fix and try again",IdentityRequesetInvalidKey:"There is an invalid key on your identityRequest object. It can only contain a `userIdentities` object and a `onUserAlias` function. Request not sent to server. Please fix and try again.",OnUserAliasType:"The onUserAlias value must be a function.",UserIdentities:"The userIdentities key must be an object with keys of identityTypes and values of strings. Request not sent to server. Please fix and try again.",UserIdentitiesInvalidKey:"There is an invalid identity key on your `userIdentities` object within the identityRequest. Request not sent to server. Please fix and try again.",UserIdentitiesInvalidValues:"All user identity values must be strings or null. Request not sent to server. Please fix and try again.",AliasMissingMpid:"Alias Request must contain both a destinationMpid and a sourceMpid",AliasNonUniqueMpid:"Alias Request's destinationMpid and sourceMpid must be unique",AliasMissingTime:"Alias Request must have both a startTime and an endTime",AliasStartBeforeEndTime:"Alias Request's endTime must be later than its startTime"}},NativeSdkPaths:{LogEvent:"logEvent",SetUserTag:"setUserTag",RemoveUserTag:"removeUserTag",SetUserAttribute:"setUserAttribute",RemoveUserAttribute:"removeUserAttribute",SetSessionAttribute:"setSessionAttribute",AddToCart:"addToCart",RemoveFromCart:"removeFromCart",ClearCart:"clearCart",LogOut:"logOut",SetUserAttributeList:"setUserAttributeList",RemoveAllUserAttributes:"removeAllUserAttributes",GetUserAttributesLists:"getUserAttributesLists",GetAllUserAttributes:"getAllUserAttributes",Identify:"identify",Logout:"logout",Login:"login",Modify:"modify",Alias:"aliasUsers",Upload:"upload"},StorageNames:{localStorageName:"mprtcl-api",localStorageNameV3:"mprtcl-v3",cookieName:"mprtcl-api",cookieNameV2:"mprtcl-v2",cookieNameV3:"mprtcl-v3",localStorageNameV4:"mprtcl-v4",localStorageProductsV4:"mprtcl-prodv4",cookieNameV4:"mprtcl-v4",currentStorageName:"mprtcl-v4",currentStorageProductsName:"mprtcl-prodv4"},DefaultConfig:{cookieDomain:null,cookieExpiration:365,logLevel:null,timeout:300,sessionTimeout:30,maxProducts:20,forwarderStatsTimeout:5e3,integrationDelayTimeout:5e3,maxCookieSize:3e3,aliasMaxWindow:90,uploadInterval:0// Maximum milliseconds in between batch uploads, below 500 will mean immediate upload.  The server returns this as a string, but we are using it as a number internally
 },DefaultBaseUrls:{v1SecureServiceUrl:"jssdks.mparticle.com/v1/JS/",v2SecureServiceUrl:"jssdks.mparticle.com/v2/JS/",v3SecureServiceUrl:"jssdks.mparticle.com/v3/JS/",configUrl:"jssdkcdns.mparticle.com/JS/v2/",identityUrl:"identity.mparticle.com/v1/",aliasUrl:"jssdks.mparticle.com/v1/identity/",userAudienceUrl:"nativesdks.mparticle.com/v1/"},// These are the paths that are used to construct the CNAME urls

package/dist/mparticle.js

@@ -203,7 +203,7 @@ var mParticle = (function () {
       Base64: Base64$1
     };
 
-    var version = "2.61.0";
+    var version = "2.62.0";
 
     var Constants = {
       sdkVersion: version,

package/dist/types/src/apiClient.d.ts

@@ -0,0 +1,34 @@
+import { BatchUploader } from './batchUploader';
+import { SDKEvent, SDKDataPlan } from './sdkRuntimeModels';
+import KitBlocker from './kitBlocking';
+import { Dictionary } from './utils';
+import { IUploadObject } from './serverModel';
+import { MPForwarder } from './forwarders.interfaces';
+import { IMParticleUser, ISDKUserAttributes } from './identity-user-interfaces';
+import { AsyncUploader } from './uploaders';
+import { IMParticleWebSDKInstance } from './mp-instance';
+export interface IAPIClient {
+    uploader: BatchUploader | null;
+    queueEventForBatchUpload: (event: SDKEvent) => void;
+    processQueuedEvents: () => void;
+    appendUserInfoToEvents: (user: IMParticleUser, events: SDKEvent[]) => void;
+    sendEventToServer: (event: SDKEvent, _options?: Dictionary<any>) => void;
+    sendSingleEventToServer: (event: SDKEvent) => void;
+    sendBatchForwardingStatsToServer: (forwardingStatsData: IForwardingStatsData, xhr: XMLHttpRequest) => void;
+    initializeForwarderStatsUploader: () => AsyncUploader;
+    prepareForwardingStats: (forwarder: MPForwarder, event: IUploadObject) => void;
+}
+export interface IForwardingStatsData {
+    mid: number;
+    esid: number;
+    n: string;
+    attrs: ISDKUserAttributes;
+    sdk: string;
+    dt: number;
+    et: number;
+    dbg: boolean;
+    ct: number;
+    eec: number;
+    dp: SDKDataPlan;
+}
+export default function APIClient(this: IAPIClient, mpInstance: IMParticleWebSDKInstance, kitBlocker: KitBlocker): void;

package/dist/types/src/audience.d.ts

@@ -0,0 +1,4 @@
+export default class Audience {
+    audience_id: number;
+    constructor(audience_id: number);
+}

package/dist/types/src/audienceManager.d.ts

@@ -0,0 +1,19 @@
+import { SDKLoggerApi } from './sdkRuntimeModels';
+import { AsyncUploader } from './uploaders';
+import Audience from './audience';
+export interface IAudienceMembershipsServerResponse {
+    dt: 'cam';
+    ct: number;
+    id: string;
+    audience_memberships: Audience[];
+}
+export interface IAudienceMemberships {
+    currentAudienceMemberships: Audience[];
+}
+export default class AudienceManager {
+    url: string;
+    userAudienceAPI: AsyncUploader;
+    logger: SDKLoggerApi;
+    constructor(userAudienceUrl: string, apiKey: string, logger: SDKLoggerApi);
+    sendGetUserAudienceRequest(mpid: string, callback: (userAudiences: IAudienceMemberships) => void): Promise<void>;
+}

package/dist/types/src/batchUploader.d.ts

@@ -0,0 +1,72 @@
+import { Batch } from '@mparticle/event-models';
+import { SDKEvent } from './sdkRuntimeModels';
+import { IMParticleWebSDKInstance } from './mp-instance';
+/**
+ * BatchUploader contains all the logic to store/retrieve events and batches
+ * to/from persistence, and upload batches to mParticle.
+ * It queues events as they come in, storing them in persistence, then at set
+ * intervals turns them into batches and transfers between event and batch
+ * persistence.
+ * It then attempts to upload them to mParticle, purging batch persistence if
+ * the upload is successful
+ *
+ * These uploads happen on an interval basis using window.fetch or XHR
+ * requests, depending on what is available in the browser.
+ *
+ * Uploads can also be triggered on browser visibility/focus changes via an
+ * event listener, which then uploads to mPartice via the browser's Beacon API.
+ */
+export declare class BatchUploader {
+    static readonly CONTENT_TYPE: string;
+    static readonly MINIMUM_INTERVAL_MILLIS: number;
+    uploadIntervalMillis: number;
+    eventsQueuedForProcessing: SDKEvent[];
+    batchesQueuedForProcessing: Batch[];
+    mpInstance: IMParticleWebSDKInstance;
+    uploadUrl: string;
+    batchingEnabled: boolean;
+    private eventVault;
+    private batchVault;
+    private offlineStorageEnabled;
+    private uploader;
+    private lastASTEventTime;
+    private readonly AST_DEBOUNCE_MS;
+    /**
+     * Creates an instance of a BatchUploader
+     * @param {IMParticleWebSDKInstance} mpInstance - the mParticle SDK instance
+     * @param {number} uploadInterval - the desired upload interval in milliseconds
+     */
+    constructor(mpInstance: IMParticleWebSDKInstance, uploadInterval: number);
+    private isOfflineStorageAvailable;
+    private shouldDebounceAndUpdateLastASTTime;
+    private createBackgroundASTEvent;
+    private addEventListeners;
+    private isBeaconAvailable;
+    private triggerUploadInterval;
+    /**
+     * This method will queue a single Event which will eventually be processed into a Batch
+     * @param event event that should be queued
+     */
+    queueEvent(event: SDKEvent): void;
+    private shouldTriggerImmediateUpload;
+    /**
+     * This implements crucial logic to:
+     * - bucket pending events by MPID, and then by Session, and upload individual batches for each bucket.
+     *
+     * In the future this should enforce other requirements such as maximum batch size.
+     *
+     * @param sdkEvents current pending events
+     * @param defaultUser the user to reference for events that are missing data
+     */
+    private static createNewBatches;
+    /**
+     * This is the main loop function:
+     *  - take all pending events and turn them into batches
+     *  - attempt to upload each batch
+     *
+     * @param triggerFuture whether to trigger the loop again - for manual/forced uploads this should be false
+     * @param useBeacon whether to use the beacon API - used when the page is being unloaded
+     */
+    prepareAndUpload(triggerFuture?: boolean, useBeacon?: boolean): Promise<void>;
+    private uploadBatches;
+}

package/dist/types/src/configAPIClient.d.ts

@@ -0,0 +1,68 @@
+import { BooleanStringLowerCase, DataPlanResult, SDKEventCustomFlags, SDKInitConfig } from './sdkRuntimeModels';
+import { Dictionary } from './utils';
+import { IPixelConfiguration } from './cookieSyncManager';
+import { IMParticleWebSDKInstance } from './mp-instance';
+export interface IKitConfigs extends IKitFilterSettings {
+    name: string;
+    suffix?: string;
+    moduleId: number;
+    isDebug: boolean;
+    isVisible: boolean;
+    isDebugString: BooleanStringLowerCase;
+    hasDebugString: BooleanStringLowerCase;
+    settings: Dictionary;
+    eventSubscriptionId: number;
+    excludeAnonymousUser: boolean;
+}
+export interface IKitFilterSettings {
+    eventTypeFilters: number[];
+    eventNameFilters: number[];
+    screenNameFilters: number[];
+    screenAttributeFilters: number[];
+    userIdentityFilters: number[];
+    userAttributeFilters: number[];
+    attributeFilters: number[];
+    filteringEventAttributeValue?: IFilteringEventAttributeValue;
+    filteringUserAttributeValue?: IFilteringUserAttributeValue;
+    filteringConsentRuleValues?: IFilteringConsentRuleValues;
+    consentRegulationFilters: number[];
+    consentRegulationPurposeFilters: number[];
+    messageTypeFilters: number[];
+    messageTypeStateFilters: number[];
+}
+export interface IFilteringEventAttributeValue {
+    eventAttributeName: string;
+    eventAttributeValue: string;
+    includeOnMatch: boolean;
+}
+export interface IFilteringUserAttributeValue {
+    userAttributeName: string;
+    userAttributeValue: string;
+    includeOnMatch: boolean;
+}
+export interface IFilteringConsentRuleValues {
+    includeOnMatch: boolean;
+    values: IConsentRuleValue[];
+}
+export interface IConsentRuleValue {
+    consentPurpose: string;
+    hasConsented: boolean;
+}
+export interface IConfigResponse {
+    appName: string;
+    dataPlanResult: DataPlanResult;
+    kitConfigs: IKitConfigs[];
+    serviceUrl: string;
+    secureServiceUrl: string;
+    minWebviewBridgeVersion: number;
+    workspaceToken: string;
+    pixelConfigs: IPixelConfiguration[];
+    flags: SDKEventCustomFlags;
+}
+export interface IConfigAPIClient {
+    apiKey: string;
+    config: SDKInitConfig;
+    mpInstance: IMParticleWebSDKInstance;
+    getSDKConfiguration: () => Promise<IConfigResponse>;
+}
+export default function ConfigAPIClient(this: IConfigAPIClient, apiKey: string, config: SDKInitConfig, mpInstance: IMParticleWebSDKInstance): void;

package/dist/types/src/consent.d.ts

@@ -0,0 +1,71 @@
+import { ConsentState, PrivacyConsentState } from '@mparticle/web-sdk';
+import { Dictionary } from './utils';
+import { IMParticleUser } from './identity-user-interfaces';
+import { IMParticleWebSDKInstance } from './mp-instance';
+declare const CCPAPurpose: "data_sale_opt_out";
+export interface IMinifiedConsentJSONObject {
+    gdpr?: Dictionary<IPrivacyV2DTO>;
+    ccpa?: {
+        [CCPAPurpose]: IPrivacyV2DTO;
+    };
+}
+export interface ICreatePrivacyConsentFunction {
+    (consented: boolean, timestamp?: number, consentDocument?: string, location?: string, hardwareId?: string): PrivacyConsentState | null;
+}
+export interface SDKConsentApi {
+    createGDPRConsent: ICreatePrivacyConsentFunction;
+    createCCPAConsent: ICreatePrivacyConsentFunction;
+    createConsentState: (consentState?: ConsentState) => ConsentState;
+}
+export interface IConsentSerialization {
+    toMinifiedJsonObject: (state: ConsentState) => IMinifiedConsentJSONObject;
+    fromMinifiedJsonObject: (json: IMinifiedConsentJSONObject) => ConsentState;
+}
+export interface SDKConsentState extends Omit<ConsentState, 'getGDPRConsentState' | 'getCCPAConsentState'> {
+    getGDPRConsentState(): SDKGDPRConsentState;
+    getCCPAConsentState(): SDKCCPAConsentState;
+}
+export interface SDKConsentStateData {
+    Consented: boolean;
+    Timestamp?: number;
+    ConsentDocument?: string;
+    Location?: string;
+    HardwareId?: string;
+}
+export type SDKGDPRConsentState = Dictionary<SDKConsentStateData>;
+export interface SDKCCPAConsentState extends SDKConsentStateData {
+}
+export interface IPrivacyV2DTO {
+    c: boolean;
+    ts: number;
+    d: string;
+    l: string;
+    h: string;
+}
+export type IGDPRConsentStateV2DTO = Dictionary<IPrivacyV2DTO>;
+export interface ICCPAConsentStateV2DTO {
+    [CCPAPurpose]: IPrivacyV2DTO;
+}
+export interface IConsentStateV2DTO {
+    gdpr?: IGDPRConsentStateV2DTO;
+    ccpa?: ICCPAConsentStateV2DTO;
+}
+export interface IConsentRulesValues {
+    consentPurpose: string;
+    hasConsented: boolean;
+}
+export interface IConsentRules {
+    includeOnMatch: boolean;
+    values: IConsentRulesValues[];
+}
+export interface IConsentState extends ConsentState {
+    removeCCPAState: () => ConsentState;
+}
+export interface IConsent {
+    isEnabledForUserConsent: (consentRules: IConsentRules, user: IMParticleUser) => boolean;
+    createPrivacyConsent: ICreatePrivacyConsentFunction;
+    createConsentState: (consentState?: ConsentState) => ConsentState;
+    ConsentSerialization: IConsentSerialization;
+}
+export default function Consent(this: IConsent, mpInstance: IMParticleWebSDKInstance): void;
+export {};

package/dist/types/src/constants.d.ts

@@ -0,0 +1,201 @@
+declare const Constants: {
+    readonly sdkVersion: string;
+    readonly sdkVendor: "mparticle";
+    readonly platform: "web";
+    readonly Messages: {
+        readonly DeprecationMessages: {
+            readonly MethodHasBeenDeprecated: "has been deprecated.";
+            readonly MethodMarkedForDeprecationPostfix: "is a deprecated method and will be removed in future releases.";
+            readonly AlternativeMethodPrefix: "Please use the alternate method:";
+        };
+        readonly ErrorMessages: {
+            readonly NoToken: "A token must be specified.";
+            readonly EventNameInvalidType: "Event name must be a valid string value.";
+            readonly EventDataInvalidType: "Event data must be a valid object hash.";
+            readonly LoggingDisabled: "Event logging is currently disabled.";
+            readonly CookieParseError: "Could not parse cookie";
+            readonly EventEmpty: "Event object is null or undefined, cancelling send";
+            readonly APIRequestEmpty: "APIRequest is null or undefined, cancelling send";
+            readonly NoEventType: "Event type must be specified.";
+            readonly TransactionIdRequired: "Transaction ID is required";
+            readonly TransactionRequired: "A transaction attributes object is required";
+            readonly PromotionIdRequired: "Promotion ID is required";
+            readonly BadAttribute: "Attribute value cannot be object or array";
+            readonly BadKey: "Key value cannot be object or array";
+            readonly BadLogPurchase: "Transaction attributes and a product are both required to log a purchase, https://docs.mparticle.com/?javascript#measuring-transactions";
+            readonly AudienceAPINotEnabled: "Your workspace is not enabled to retrieve user audiences.";
+        };
+        readonly InformationMessages: {
+            readonly CookieSearch: "Searching for cookie";
+            readonly CookieFound: "Cookie found, parsing values";
+            readonly CookieNotFound: "Cookies not found";
+            readonly CookieSet: "Setting cookie";
+            readonly CookieSync: "Performing cookie sync";
+            readonly SendBegin: "Starting to send event";
+            readonly SendIdentityBegin: "Starting to send event to identity server";
+            readonly SendWindowsPhone: "Sending event to Windows Phone container";
+            readonly SendIOS: "Calling iOS path: ";
+            readonly SendAndroid: "Calling Android JS interface method: ";
+            readonly SendHttp: "Sending event to mParticle HTTP service";
+            readonly SendAliasHttp: "Sending alias request to mParticle HTTP service";
+            readonly SendIdentityHttp: "Sending event to mParticle HTTP service";
+            readonly StartingNewSession: "Starting new Session";
+            readonly StartingLogEvent: "Starting to log event";
+            readonly StartingLogOptOut: "Starting to log user opt in/out";
+            readonly StartingEndSession: "Starting to end session";
+            readonly StartingInitialization: "Starting to initialize";
+            readonly StartingLogCommerceEvent: "Starting to log commerce event";
+            readonly StartingAliasRequest: "Starting to Alias MPIDs";
+            readonly LoadingConfig: "Loading configuration options";
+            readonly AbandonLogEvent: "Cannot log event, logging disabled or developer token not set";
+            readonly AbandonAliasUsers: "Cannot Alias Users, logging disabled or developer token not set";
+            readonly AbandonStartSession: "Cannot start session, logging disabled or developer token not set";
+            readonly AbandonEndSession: "Cannot end session, logging disabled or developer token not set";
+            readonly NoSessionToEnd: "Cannot end session, no active session found";
+        };
+        readonly ValidationMessages: {
+            readonly ModifyIdentityRequestUserIdentitiesPresent: "identityRequests to modify require userIdentities to be present. Request not sent to server. Please fix and try again";
+            readonly IdentityRequesetInvalidKey: "There is an invalid key on your identityRequest object. It can only contain a `userIdentities` object and a `onUserAlias` function. Request not sent to server. Please fix and try again.";
+            readonly OnUserAliasType: "The onUserAlias value must be a function.";
+            readonly UserIdentities: "The userIdentities key must be an object with keys of identityTypes and values of strings. Request not sent to server. Please fix and try again.";
+            readonly UserIdentitiesInvalidKey: "There is an invalid identity key on your `userIdentities` object within the identityRequest. Request not sent to server. Please fix and try again.";
+            readonly UserIdentitiesInvalidValues: "All user identity values must be strings or null. Request not sent to server. Please fix and try again.";
+            readonly AliasMissingMpid: "Alias Request must contain both a destinationMpid and a sourceMpid";
+            readonly AliasNonUniqueMpid: "Alias Request's destinationMpid and sourceMpid must be unique";
+            readonly AliasMissingTime: "Alias Request must have both a startTime and an endTime";
+            readonly AliasStartBeforeEndTime: "Alias Request's endTime must be later than its startTime";
+        };
+    };
+    readonly NativeSdkPaths: {
+        readonly LogEvent: "logEvent";
+        readonly SetUserTag: "setUserTag";
+        readonly RemoveUserTag: "removeUserTag";
+        readonly SetUserAttribute: "setUserAttribute";
+        readonly RemoveUserAttribute: "removeUserAttribute";
+        readonly SetSessionAttribute: "setSessionAttribute";
+        readonly AddToCart: "addToCart";
+        readonly RemoveFromCart: "removeFromCart";
+        readonly ClearCart: "clearCart";
+        readonly LogOut: "logOut";
+        readonly SetUserAttributeList: "setUserAttributeList";
+        readonly RemoveAllUserAttributes: "removeAllUserAttributes";
+        readonly GetUserAttributesLists: "getUserAttributesLists";
+        readonly GetAllUserAttributes: "getAllUserAttributes";
+        readonly Identify: "identify";
+        readonly Logout: "logout";
+        readonly Login: "login";
+        readonly Modify: "modify";
+        readonly Alias: "aliasUsers";
+        readonly Upload: "upload";
+    };
+    readonly StorageNames: {
+        readonly localStorageName: "mprtcl-api";
+        readonly localStorageNameV3: "mprtcl-v3";
+        readonly cookieName: "mprtcl-api";
+        readonly cookieNameV2: "mprtcl-v2";
+        readonly cookieNameV3: "mprtcl-v3";
+        readonly localStorageNameV4: "mprtcl-v4";
+        readonly localStorageProductsV4: "mprtcl-prodv4";
+        readonly cookieNameV4: "mprtcl-v4";
+        readonly currentStorageName: "mprtcl-v4";
+        readonly currentStorageProductsName: "mprtcl-prodv4";
+    };
+    readonly DefaultConfig: {
+        readonly cookieDomain: any;
+        readonly cookieExpiration: 365;
+        readonly logLevel: any;
+        readonly timeout: 300;
+        readonly sessionTimeout: 30;
+        readonly maxProducts: 20;
+        readonly forwarderStatsTimeout: 5000;
+        readonly integrationDelayTimeout: 5000;
+        readonly maxCookieSize: 3000;
+        readonly aliasMaxWindow: 90;
+        readonly uploadInterval: 0;
+    };
+    readonly DefaultBaseUrls: {
+        readonly v1SecureServiceUrl: "jssdks.mparticle.com/v1/JS/";
+        readonly v2SecureServiceUrl: "jssdks.mparticle.com/v2/JS/";
+        readonly v3SecureServiceUrl: "jssdks.mparticle.com/v3/JS/";
+        readonly configUrl: "jssdkcdns.mparticle.com/JS/v2/";
+        readonly identityUrl: "identity.mparticle.com/v1/";
+        readonly aliasUrl: "jssdks.mparticle.com/v1/identity/";
+        readonly userAudienceUrl: "nativesdks.mparticle.com/v1/";
+    };
+    readonly CNAMEUrlPaths: {
+        readonly v1SecureServiceUrl: "/webevents/v1/JS/";
+        readonly v2SecureServiceUrl: "/webevents/v2/JS/";
+        readonly v3SecureServiceUrl: "/webevents/v3/JS/";
+        readonly configUrl: "/tags/JS/v2/";
+        readonly identityUrl: "/identity/v1/";
+        readonly aliasUrl: "/webevents/v1/identity/";
+    };
+    readonly Base64CookieKeys: {
+        readonly csm: 1;
+        readonly sa: 1;
+        readonly ss: 1;
+        readonly lsa: 1;
+        readonly ua: 1;
+        readonly ui: 1;
+        readonly csd: 1;
+        readonly ia: 1;
+        readonly con: 1;
+    };
+    readonly SDKv2NonMPIDCookieKeys: {
+        readonly gs: 1;
+        readonly cu: 1;
+        readonly l: 1;
+        readonly globalSettings: 1;
+        readonly currentUserMPID: 1;
+    };
+    readonly HTTPCodes: {
+        readonly noHttpCoverage: -1;
+        readonly activeIdentityRequest: -2;
+        readonly activeSession: -3;
+        readonly validationIssue: -4;
+        readonly nativeIdentityRequest: -5;
+        readonly loggingDisabledOrMissingAPIKey: -6;
+        readonly tooManyRequests: 429;
+    };
+    readonly FeatureFlags: {
+        readonly ReportBatching: "reportBatching";
+        readonly EventBatchingIntervalMillis: "eventBatchingIntervalMillis";
+        readonly OfflineStorage: "offlineStorage";
+        readonly DirectUrlRouting: "directURLRouting";
+        readonly CacheIdentity: "cacheIdentity";
+        readonly AudienceAPI: "audienceAPI";
+        readonly CaptureIntegrationSpecificIds: "captureIntegrationSpecificIds";
+        readonly CaptureIntegrationSpecificIdsV2: "captureIntegrationSpecificIdsV2";
+        readonly AstBackgroundEvents: "astBackgroundEvents";
+    };
+    readonly DefaultInstance: "default_instance";
+    readonly CCPAPurpose: "data_sale_opt_out";
+    readonly IdentityMethods: {
+        readonly Modify: "modify";
+        readonly Logout: "logout";
+        readonly Login: "login";
+        readonly Identify: "identify";
+    };
+    readonly Environment: {
+        readonly Development: "development";
+        readonly Production: "production";
+    };
+    readonly CaptureIntegrationSpecificIdsV2Modes: {
+        readonly All: "all";
+        readonly None: "none";
+        readonly RoktOnly: "roktonly";
+    };
+    readonly Rokt: {
+        readonly LauncherInstanceGuidKey: "__rokt_li_guid__";
+    };
+};
+export default Constants;
+export declare const ONE_DAY_IN_SECONDS: number;
+export declare const MILLIS_IN_ONE_SEC = 1000;
+export declare const HTTP_OK: 200;
+export declare const HTTP_ACCEPTED: 202;
+export declare const HTTP_BAD_REQUEST: 400;
+export declare const HTTP_UNAUTHORIZED: 401;
+export declare const HTTP_FORBIDDEN: 403;
+export declare const HTTP_NOT_FOUND: 404;
+export declare const HTTP_SERVER_ERROR: 500;

package/dist/types/src/cookieConsentManager.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Cookie consent flags control SDK behavior based on user consent preferences for Rokt integration.
+ * @see https://docs.rokt.com/developers/integration-guides/web/cookie-consent-flags/
+ */
+export interface ICookieConsentFlags {
+    /**
+     * When true, indicates the user has opted out of functional cookies/tracking.
+     * Default: false (functional tracking is allowed)
+     */
+    noFunctional: boolean;
+    /**
+     * When true, indicates the user has opted out of targeting cookies/tracking.
+     * This flag is used to block cookie syncs and other targeting-related features.
+     * Default: false (targeting is allowed)
+     */
+    noTargeting: boolean;
+}
+export interface ICookieConsentManager {
+    /**
+     * Targeting is allowed when noTargeting is false (default)
+     */
+    getNoTargeting: () => boolean;
+    /**
+     * Functional tracking is allowed when noFunctional is false (default)
+     */
+    getNoFunctional: () => boolean;
+}
+/**
+ * CookieConsentManager handles storage and access of consent flags (noFunctional, noTargeting)
+ * that are passed via launcherOptions during SDK initialization.
+ *
+ * These flags allow Rokt integration to respect user privacy choices.
+ *
+ * Default behavior: Both flags default to false, meaning all features are allowed
+ * unless explicitly opted out by the user.
+ */
+export default class CookieConsentManager implements ICookieConsentManager {
+    private flags;
+    constructor(flags: ICookieConsentFlags);
+    /**
+     * Returns true if third-party targeting is disabled.
+     * Targeting is allowed when noTargeting is false (default).
+     */
+    getNoTargeting(): boolean;
+    /**
+     * Returns true if functional tracking is disabled.
+     * Functional tracking is allowed when noFunctional is false (default).
+     */
+    getNoFunctional(): boolean;
+}

package/dist/types/src/cookieSyncManager.d.ts

@@ -0,0 +1,34 @@
+import { Dictionary } from './utils';
+import { MPID } from '@mparticle/web-sdk';
+import { IConsentRules } from './consent';
+import { IMParticleWebSDKInstance } from './mp-instance';
+export declare const DAYS_IN_MILLISECONDS: number;
+export declare const PARTNER_MODULE_IDS: {
+    readonly AdobeEventForwarder: 11;
+    readonly DoubleclickDFP: 41;
+    readonly AppNexus: 50;
+    readonly Lotame: 58;
+    readonly TradeDesk: 103;
+    readonly VerizonMedia: 155;
+    readonly Rokt: 1277;
+};
+export type CookieSyncDates = Dictionary<number>;
+export interface IPixelConfiguration {
+    name?: string;
+    moduleId: number;
+    esId?: number;
+    isDebug?: boolean;
+    isProduction?: boolean;
+    settings: Dictionary<string>;
+    frequencyCap: number;
+    pixelUrl: string;
+    redirectUrl: string;
+    filteringConsentRuleValues?: IConsentRules;
+}
+export interface ICookieSyncManager {
+    attemptCookieSync: (mpid: MPID, mpidIsNotInCookies?: boolean) => void;
+    performCookieSync: (url: string, moduleId: string, mpid: MPID, cookieSyncDates: CookieSyncDates) => void;
+    combineUrlWithRedirect: (mpid: MPID, pixelUrl: string, redirectUrl: string) => string;
+}
+export default function CookieSyncManager(this: ICookieSyncManager, mpInstance: IMParticleWebSDKInstance): void;
+export declare const isLastSyncDateExpired: (frequencyCap: number, lastSyncDate?: number) => boolean;