@mparticle/web-sdk 2.57.0 → 2.58.0

package/src/logging/types.ts

@@ -0,0 +1,32 @@
+import { valueof } from '../utils';
+
+export const ErrorCodes = {
+    UNKNOWN_ERROR: 'UNKNOWN_ERROR',
+    UNHANDLED_EXCEPTION: 'UNHANDLED_EXCEPTION',
+    IDENTITY_REQUEST: 'IDENTITY_REQUEST',
+} as const;
+
+export type ErrorCodes = valueof<typeof ErrorCodes>;
+
+export type ErrorCode = ErrorCodes | string;
+
+export const WSDKErrorSeverity = {
+    ERROR: 'ERROR',
+    INFO: 'INFO',
+    WARNING: 'WARNING',
+} as const;
+
+export type WSDKErrorSeverity = (typeof WSDKErrorSeverity)[keyof typeof WSDKErrorSeverity];
+
+export type ErrorsRequestBody = {
+    additionalInformation?: Record<string, string>;
+    code: ErrorCode;
+    severity: WSDKErrorSeverity;
+    stackTrace?: string;
+    deviceInfo?: string;
+    integration?: string;
+    reporter?: string;
+    url?: string;
+};
+
+export type LogRequestBody = ErrorsRequestBody;

package/src/mp-instance.ts

@@ -52,6 +52,7 @@ import ForegroundTimer from './foregroundTimeTracker';
 import RoktManager, { IRoktOptions } from './roktManager';
 import filteredMparticleUser from './filteredMparticleUser';
 import CookieConsentManager, { ICookieConsentManager } from './cookieConsentManager';
+import { ReportingLogger } from './logging/reportingLogger';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -84,14 +85,16 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _NativeSdkHelpers: INativeSdkHelpers;
     _Persistence: IPersistence;
     _CookieConsentManager: ICookieConsentManager;
+    _ReportingLogger: ReportingLogger;
     _RoktManager: RoktManager;
     _SessionManager: ISessionManager;
     _ServerModel: IServerModel;
     _Store: IStore;
     _instanceName: string;
     _preInit: IPreInit;
-    _timeOnSiteTimer: ForegroundTimer; 
+    _timeOnSiteTimer: ForegroundTimer;
     setLauncherInstanceGuid: () => void;
+    getLauncherInstanceGuid: () => string;
     captureTiming(metricName: string);
     processQueueOnIdentityFailure?: () => void;
 }
@@ -245,12 +248,14 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         }
     };
 
-    this._resetForTests = function(config, keepPersistence, instance) {
+    this._resetForTests = function(config, keepPersistence, instance, reportingLogger?: ReportingLogger) {
         if (instance._Store) {
             delete instance._Store;
         }
-        instance.Logger = new Logger(config);
+        instance.Logger = new Logger(config, reportingLogger);
         instance._Store = new Store(config, instance);
+        // Update ReportingLogger with the new Store reference to avoid stale data
+        reportingLogger?.setStore(instance._Store);
         instance._Store.isLocalStorageAvailable = instance._Persistence.determineLocalStorageAvailability(
             window.localStorage
         );
@@ -1372,7 +1377,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
             };
         }
     };
-    
+
     const launcherInstanceGuidKey = Constants.Rokt.LauncherInstanceGuidKey;
     this.setLauncherInstanceGuid = function() {
         if (!window[launcherInstanceGuidKey] 
@@ -1381,6 +1386,10 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         }
     };
 
+    this.getLauncherInstanceGuid = function() {
+        return window[launcherInstanceGuidKey];
+    };
+
     this.captureTiming = function(metricsName) {
         if (typeof window !== 'undefined' && window.performance?.mark) {
             window.performance.mark(metricsName);
@@ -1446,6 +1455,8 @@ function completeSDKInitialization(apiKey, config, mpInstance) {
         // Configure Rokt Manager with user and filtered user
         const roktConfig: IKitConfigs = parseConfig(config, 'Rokt', 181);
         if (roktConfig) {
+            const accountId = roktConfig.settings?.accountId;
+            mpInstance._Store.setRoktAccountId(accountId);
             const { userAttributeFilters } = roktConfig;
             const roktFilteredUser = filteredMparticleUser(
                 currentUserMPID,
@@ -1579,9 +1590,16 @@ function createIdentityCache(mpInstance) {
 }
 
 function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
-    mpInstance.Logger = new Logger(config);
+    mpInstance._ReportingLogger = new ReportingLogger(
+        config,
+        Constants.sdkVersion,
+        undefined,
+        mpInstance.getLauncherInstanceGuid(),
+    );
+    mpInstance.Logger = new Logger(config, mpInstance._ReportingLogger);
     mpInstance._Store = new Store(config, mpInstance, apiKey);
     window.mParticle.Store = mpInstance._Store;
+    mpInstance._ReportingLogger.setStore(mpInstance._Store);
     mpInstance.Logger.verbose(StartingInitialization);
 
     // Initialize CookieConsentManager with privacy flags from launcherOptions

package/src/roktManager.ts

@@ -59,6 +59,12 @@ export interface RoktKitFilterSettings {
     filteredUser?: IMParticleUser | null;
 }
 
+export interface IRoktKitSettings {
+    accountId?: string;
+    placementAttributesMapping?: string;
+    hashedEmailUserIdentityType?: string;
+}
+
 export interface IRoktKit {
     filters: RoktKitFilterSettings;
     filteredUser: IMParticleUser | null;
@@ -69,6 +75,8 @@ export interface IRoktKit {
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use: <T>(name: string) => Promise<T>;
     launcherOptions?: Dictionary<any>;
+    settings?: IRoktKitSettings;
+    integrationName?: string;
 }
 
 export interface IRoktOptions {
@@ -181,6 +189,15 @@ export default class RoktManager {
 
     public attachKit(kit: IRoktKit): void {
         this.kit = kit;
+
+        if (kit.settings?.accountId) {
+            this.store.setRoktAccountId(kit.settings.accountId);
+        }
+
+        if (kit.integrationName) {
+            this.store?.setIntegrationName(kit.integrationName);
+        }
+
         this.processMessageQueue();
 
         try {
@@ -588,4 +605,4 @@ export default class RoktManager {
         
         return false; // Values are the same
     }
-}
+}

package/src/sdkRuntimeModels.ts

@@ -7,18 +7,24 @@ import {
     SDKEventAttrs,
     Callback,
 } from '@mparticle/web-sdk';
-import { IntegrationAttribute, IntegrationAttributes, IStore, WrapperSDKTypes } from './store';
+import {
+    IntegrationAttribute,
+    IntegrationAttributes,
+    IStore,
+    WrapperSDKTypes,
+} from './store';
 import Validators from './validators';
 import { Dictionary, valueof } from './utils';
 import { IKitConfigs } from './configAPIClient';
 import { SDKConsentApi, SDKConsentState } from './consent';
 import MPSideloadedKit from './sideloadedKit';
 import { ISessionManager } from './sessionManager';
-import { ConfiguredKit, MPForwarder, UnregisteredKit } from './forwarders.interfaces';
 import {
-    SDKIdentityApi,
-    IAliasCallback,
-} from './identity.interfaces';
+    ConfiguredKit,
+    MPForwarder,
+    UnregisteredKit,
+} from './forwarders.interfaces';
+import { SDKIdentityApi, IAliasCallback } from './identity.interfaces';
 import {
     ISDKUserAttributeChangeData,
     ISDKUserIdentityChanges,
@@ -36,11 +42,16 @@ import {
 } from './types';
 import { IPixelConfiguration } from './cookieSyncManager';
 import _BatchValidator from './mockBatchCreator';
-import {  SDKECommerceAPI } from './ecommerce.interfaces';
-import { IErrorLogMessage, IMParticleWebSDKInstance, IntegrationDelays } from './mp-instance';
+import { SDKECommerceAPI } from './ecommerce.interfaces';
+import {
+    IErrorLogMessage,
+    IMParticleWebSDKInstance,
+    IntegrationDelays,
+} from './mp-instance';
 import Constants from './constants';
 import RoktManager, { IRoktLauncherOptions } from './roktManager';
 import { IConsoleLogger } from './logger';
+import { ErrorCodes } from './logging/types';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -178,7 +189,7 @@ export interface MParticleWebSDK {
     _resetForTests(
         MPConfig?: SDKInitConfig,
         keepPersistence?: boolean,
-        instance?: IMParticleWebSDKInstance,
+        instance?: IMParticleWebSDKInstance
     ): void;
     configurePixel(config: IPixelConfiguration): void;
     endSession(): void;
@@ -207,9 +218,24 @@ export interface MParticleWebSDK {
     ): void;
     logBaseEvent(event: BaseEvent, eventOptions?: SDKEventOptions): void;
     logError(error: IErrorLogMessage, attrs?: SDKEventAttrs): void;
-    logLink(selector: string, eventName: string, eventType: valueof<typeof EventType>, eventInfo: SDKEventAttrs): void;
-    logForm(selector: string, eventName: string, eventType: valueof<typeof EventType>, eventInfo: SDKEventAttrs): void;
-    logPageView(eventName?: string, attrs?: SDKEventAttrs, customFlags?: SDKEventCustomFlags, eventOptions?: SDKEventOptions): void;
+    logLink(
+        selector: string,
+        eventName: string,
+        eventType: valueof<typeof EventType>,
+        eventInfo: SDKEventAttrs
+    ): void;
+    logForm(
+        selector: string,
+        eventName: string,
+        eventType: valueof<typeof EventType>,
+        eventInfo: SDKEventAttrs
+    ): void;
+    logPageView(
+        eventName?: string,
+        attrs?: SDKEventAttrs,
+        customFlags?: SDKEventCustomFlags,
+        eventOptions?: SDKEventOptions
+    ): void;
     setOptOut(isOptingOut: boolean): void;
     eCommerce: SDKECommerceAPI;
     isInitialized(): boolean;
@@ -227,7 +253,10 @@ export interface MParticleWebSDK {
 
     stopTrackingLocation(): void;
     generateHash(value: string): string;
-    setIntegrationAttribute(integrationModuleId: number, attrs: IntegrationAttribute): void;
+    setIntegrationAttribute(
+        integrationModuleId: number,
+        attrs: IntegrationAttribute
+    ): void;
     getIntegrationAttributes(integrationModuleId: number): IntegrationAttribute;
     captureTiming(metricName: string): void;
 }
@@ -248,14 +277,13 @@ export interface IMParticleInstanceManager extends MParticleWebSDK {
     MPSideloadedKit: typeof MPSideloadedKit;
     Rokt: RoktManager;
     // https://go.mparticle.com/work/SQDSDKS-7060
-    sessionManager: Pick<ISessionManager, 'getSession'>; 
+    sessionManager: Pick<ISessionManager, 'getSession'>;
     Store: IStore;
 
     // Public Methods
     getInstance(instanceName?: string): IMParticleWebSDKInstance;
 }
 
-
 // Used in cases where server requires booleans as strings
 export type BooleanStringLowerCase = 'false' | 'true';
 export type BooleanStringTitleCase = 'False' | 'True';
@@ -311,6 +339,7 @@ export interface SDKInitConfig
     identityCallback?: IdentityCallback;
 
     launcherOptions?: IRoktLauncherOptions;
+    isLoggingEnabled?: boolean;
 
     rq?: Function[] | any[];
     logger?: IConsoleLogger;
@@ -361,9 +390,9 @@ export interface SDKHelpersApi {
 }
 
 export interface SDKLoggerApi {
-    error(arg0: string): void;
-    verbose(arg0: string): void;
-    warning(arg0: string): void;
+    error(msg: string, code?: ErrorCodes): void;
+    verbose(msg: string): void;
+    warning(msg: string): void;
     setLogLevel(logLevel: LogLevelType): void;
 }
 

package/src/store.ts

@@ -96,6 +96,9 @@ export interface SDKConfig {
     webviewBridgeName?: string;
     workspaceToken?: string;
     requiredWebviewBridgeName?: string;
+    loggingUrl?: string;
+    errorUrl?: string;
+    isLoggingEnabled?: boolean;
 }
 
 function createSDKConfig(config: SDKInitConfig): SDKConfig {
@@ -120,6 +123,9 @@ function createSDKConfig(config: SDKInitConfig): SDKConfig {
         sdkConfig[prop] = Constants.DefaultBaseUrls[prop];
     }
 
+    // Always initialize flags to at least an empty object to prevent undefined access
+    sdkConfig.flags = sdkConfig.flags || {};
+
     return sdkConfig;
 }
 
@@ -202,6 +208,8 @@ export interface IStore {
     integrationDelayTimeoutStart: number; // UNIX Timestamp
     webviewBridgeEnabled?: boolean;
     wrapperSDKInfo: WrapperSDKInfo;
+    roktAccountId: string | null;
+    integrationName: string | null;
 
     persistenceData?: IPersistenceMinified;
 
@@ -223,6 +231,10 @@ export interface IStore {
     setUserAttributes?(mpid: MPID, attributes: UserAttributes): void;
     getUserIdentities?(mpid: MPID): UserIdentities;
     setUserIdentities?(mpid: MPID, userIdentities: UserIdentities): void;
+    getRoktAccountId?(): string;
+    setRoktAccountId?(accountId: string): void;
+    getIntegrationName?(): string;
+    setIntegrationName?(integrationName: string): void;
 
     addMpidToSessionHistory?(mpid: MPID, previousMpid?: MPID): void;
     hasInvalidIdentifyRequest?: () => boolean;
@@ -289,6 +301,8 @@ export default function Store(
             version: null,
             isInfoSet: false,
         },
+        roktAccountId: null,
+        integrationName: null,
 
         // Placeholder for in-memory persistence model
         persistenceData: {
@@ -311,10 +325,6 @@ export default function Store(
             this.SDKConfig.flags = {};
         }
 
-        // We process the initial config that is passed via the SDK init
-        // and then we will reprocess the config within the processConfig
-        // function when the config is updated from the server
-        // https://go.mparticle.com/work/SQDSDKS-6317
         this.SDKConfig.flags = processFlags(config);
 
         if (config.deviceId) {
@@ -338,10 +348,6 @@ export default function Store(
             this.SDKConfig[baseUrlKeys] = baseUrls[baseUrlKeys];
         }
 
-        if (config.hasOwnProperty('logLevel')) {
-            this.SDKConfig.logLevel = config.logLevel;
-        }
-
         this.SDKConfig.useNativeSdk = !!config.useNativeSdk;
 
         this.SDKConfig.kits = config.kits || {};
@@ -667,6 +673,16 @@ export default function Store(
     this.setUserIdentities = (mpid: MPID, userIdentities: UserIdentities) => {
         this._setPersistence(mpid, 'ui', userIdentities);
     };
+    
+    this.getRoktAccountId = () => this.roktAccountId;
+    this.setRoktAccountId = (accountId: string) => {
+        this.roktAccountId = accountId;
+    };
+
+    this.getIntegrationName = () => this.integrationName;
+    this.setIntegrationName = (integrationName: string) => {
+        this.integrationName = integrationName;
+    };
 
     this.addMpidToSessionHistory = (mpid: MPID, previousMPID?: MPID): void => {
         const indexOfMPID = this.currentSessionMPIDs.indexOf(mpid);
@@ -699,7 +715,10 @@ export default function Store(
         // We should reprocess the flags and baseUrls in case they have changed when we request an updated config
         // such as if the SDK is being self-hosted and the flags are different on the server config
         // https://go.mparticle.com/work/SQDSDKS-6317
-        this.SDKConfig.flags = processFlags(config);
+        // Only update flags if the config actually has flags (don't overwrite with empty object)
+        if (config.flags) {
+            this.SDKConfig.flags = processFlags(config);
+        }
 
         const baseUrls: Dictionary<string> = processBaseUrls(
             config,
@@ -842,7 +861,7 @@ function processDirectBaseUrls(
     for (let baseUrlKey in defaultBaseUrls) {
         // Any custom endpoints passed to mpConfig will take priority over direct
         // mapping to the silo.  The most common use case is a customer provided CNAME.
-        if (baseUrlKey === 'configUrl') {
+        if (baseUrlKey === 'configUrl' || baseUrlKey === 'loggingUrl' || baseUrlKey === 'errorUrl') {
             directBaseUrls[baseUrlKey] =
                 config[baseUrlKey] || defaultBaseUrls[baseUrlKey];
             continue;

package/src/uploaders.ts

@@ -5,6 +5,7 @@ export interface IFetchPayload {
     headers: {
         Accept: string;
         'Content-Type'?: string;
+        'rokt-account-id'?: string;
     };
     body?: string;
 }