@mparticle/web-sdk 2.52.0 → 2.53.1

package/src/mp-instance.ts

@@ -25,7 +25,7 @@ import CookieSyncManager, { ICookieSyncManager } from './cookieSyncManager';
 import SessionManager, { ISessionManager } from './sessionManager';
 import Ecommerce from './ecommerce';
 import Store, { IStore } from './store';
-import Logger from './logger';
+import { Logger } from './logger';
 import Persistence from './persistence';
 import Events from './events';
 import Forwarders from './forwarders';
@@ -51,6 +51,7 @@ import { IPersistence } from './persistence.interfaces';
 import ForegroundTimer from './foregroundTimeTracker';
 import RoktManager, { IRoktOptions } from './roktManager';
 import filteredMparticleUser from './filteredMparticleUser';
+import CookieConsentManager, { ICookieConsentManager } from './cookieConsentManager';
 
 export interface IErrorLogMessage {
     message?: string;
@@ -82,6 +83,7 @@ export interface IMParticleWebSDKInstance extends MParticleWebSDK {
     _IntegrationCapture: IntegrationCapture;
     _NativeSdkHelpers: INativeSdkHelpers;
     _Persistence: IPersistence;
+    _CookieConsentManager: ICookieConsentManager;
     _RoktManager: RoktManager;
     _SessionManager: ISessionManager;
     _ServerModel: IServerModel;
@@ -227,6 +229,7 @@ export default function mParticleInstance(this: IMParticleWebSDKInstance, instan
         if (instance._Store) {
             delete instance._Store;
         }
+        instance.Logger = new Logger(config);
         instance._Store = new Store(config, instance);
         instance._Store.isLocalStorageAvailable = instance._Persistence.determineLocalStorageAvailability(
             window.localStorage
@@ -1554,6 +1557,10 @@ function runPreConfigFetchInitialization(mpInstance, apiKey, config) {
     window.mParticle.Store = mpInstance._Store;
     mpInstance.Logger.verbose(StartingInitialization);
 
+    // Initialize CookieConsentManager with privacy flags from launcherOptions
+    const { noFunctional, noTargeting } = config?.launcherOptions ?? {};
+    mpInstance._CookieConsentManager = new CookieConsentManager({ noFunctional, noTargeting });
+
     // Check to see if localStorage is available before main configuration runs
     // since we will need this for the current implementation of user persistence
     // TODO: Refactor this when we refactor User Identity Persistence

package/src/roktManager.ts

@@ -17,9 +17,10 @@ import { UserIdentities } from "@mparticle/web-sdk";
 import { IdentityType } from "./types";
 
 // https://docs.rokt.com/developers/integration-guides/web/library/attributes
-export interface IRoktPartnerAttributes {
-    [key: string]: string | number | boolean | undefined | null;
-}
+export type RoktAttributeValueArray = Array<string | number | boolean>;
+export type RoktAttributeValueType = string | number | boolean | undefined | null;
+export type RoktAttributeValue = RoktAttributeValueType | RoktAttributeValueArray;
+export type RoktAttributes = Record<string, RoktAttributeValue>;
 
 export interface IRoktPartnerExtensionData<T> {
     [extensionName: string]: T;
@@ -27,7 +28,7 @@ export interface IRoktPartnerExtensionData<T> {
 
 // https://docs.rokt.com/developers/integration-guides/web/library/select-placements-options
 export interface IRoktSelectPlacementsOptions {
-    attributes: IRoktPartnerAttributes;
+    attributes: RoktAttributes;
     identifier?: string;
 }
 
@@ -40,7 +41,7 @@ export interface IRoktSelection {
 
 export interface IRoktLauncher {
     selectPlacements: (options: IRoktSelectPlacementsOptions) => Promise<IRoktSelection>;
-    hashAttributes: (attributes: IRoktPartnerAttributes) => Promise<Record<string, string>>;
+    hashAttributes: (attributes: RoktAttributes) => Promise<Record<string, string>>;
     use: <T>(name: string) => Promise<T>;
 }
 
@@ -63,7 +64,7 @@ export interface IRoktKit {
     filteredUser: IMParticleUser | null;
     launcher: IRoktLauncher | null;
     userAttributes: Dictionary<string>;
-    hashAttributes: (attributes: IRoktPartnerAttributes) => Promise<Record<string, string>>;
+    hashAttributes: (attributes: RoktAttributes) => Promise<RoktAttributes>;
     selectPlacements: (options: IRoktSelectPlacementsOptions) => Promise<IRoktSelection>;
     setExtensionData<T>(extensionData: IRoktPartnerExtensionData<T>): void;
     use: <T>(name: string) => Promise<T>;
@@ -99,7 +100,7 @@ export default class RoktManager {
     private launcherOptions?: IRoktLauncherOptions;
     private logger: SDKLoggerApi;
     private domain?: string;
-    private mappedEmailShaIdentityType?: string  | null;
+    private mappedEmailShaIdentityType?: string | null;
     /**
      * Initializes the RoktManager with configuration settings and user data.
      * 
@@ -257,11 +258,11 @@ export default class RoktManager {
      * with Rokt-compatible key names (like emailsha256, mobilesha256)
      * 
      * 
-     * @param {IRoktPartnerAttributes} attributes - Attributes to hash
-     * @returns {Promise<IRoktPartnerAttributes>} Object with both original and hashed attributes
+     * @param {RoktAttributes} attributes - Attributes to hash
+     * @returns {Promise<RoktAttributes>} Object with both original and hashed attributes
      * 
      */
-    public async hashAttributes(attributes: IRoktPartnerAttributes): Promise<IRoktPartnerAttributes> {
+    public async hashAttributes(attributes: RoktAttributes): Promise<RoktAttributes> {
         try {
             if (!attributes || typeof attributes !== 'object') {
                 return {};
@@ -276,7 +277,7 @@ export default class RoktManager {
             
             // Hash all attributes in parallel
             const hashPromises = keys.map(async (key) => {
-                const attributeValue = attributes[key];
+                const attributeValue = attributes[key] as RoktAttributeValueType;
                 const hashedValue = await this.hashSha256(attributeValue);
                 return { key, attributeValue, hashedValue };
             });
@@ -284,7 +285,7 @@ export default class RoktManager {
             const results = await Promise.all(hashPromises);
             
             // Build the result object
-            const hashedAttributes: IRoktPartnerAttributes = {};
+            const hashedAttributes: RoktAttributes = {};
             for (const { key, attributeValue, hashedValue } of results) {
                 hashedAttributes[key] = attributeValue;
                 if (hashedValue) {
@@ -333,7 +334,7 @@ export default class RoktManager {
      * @returns {Promise<string | undefined | null>} SHA-256 hashed value or undefined/null
      * 
      */
-    public async hashSha256(attribute: string | number | boolean | undefined | null): Promise<string | undefined | null> {
+    public async hashSha256(attribute: RoktAttributeValueType): Promise<string | undefined | null> {
         if (attribute === null || attribute === undefined) {
             this.logger.warning(`hashSha256 received null/undefined as input`);
             return attribute as null | undefined;
@@ -362,13 +363,14 @@ export default class RoktManager {
         return Boolean(this.kit && this.kit.launcher);
     }
 
-    private setUserAttributes(attributes: IRoktPartnerAttributes): void {
+    private setUserAttributes(attributes: RoktAttributes): void {
         const reservedAttributes = ['sandbox'];
         const filteredAttributes = {};
         
         for (const key in attributes) {
             if (attributes.hasOwnProperty(key) && reservedAttributes.indexOf(key) === -1) {
-                filteredAttributes[key] = attributes[key];
+                const value = attributes[key];
+                filteredAttributes[key] = Array.isArray(value) ? JSON.stringify(value) : value;
             }
         }
 
@@ -379,13 +381,13 @@ export default class RoktManager {
         }
     }
 
-    private mapPlacementAttributes(attributes: IRoktPartnerAttributes, placementAttributesMapping: Dictionary<string>[]): IRoktPartnerAttributes {
+    private mapPlacementAttributes(attributes: RoktAttributes, placementAttributesMapping: Dictionary<string>[]): RoktAttributes {
         const mappingLookup: { [key: string]: string } = {};
         for (const mapping of placementAttributesMapping) {
             mappingLookup[mapping.map] = mapping.value;
         }
     
-        const mappedAttributes: IRoktPartnerAttributes = {};
+        const mappedAttributes: RoktAttributes = {};
         for (const key in attributes) {
             if (attributes.hasOwnProperty(key)) {
                 const newKey = mappingLookup[key] || key;

package/src/sdkRuntimeModels.ts

@@ -40,6 +40,7 @@ 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';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
 export type SDKEventCustomFlags = Dictionary<any>;
@@ -259,7 +260,13 @@ export interface IMParticleInstanceManager extends MParticleWebSDK {
 export type BooleanStringLowerCase = 'false' | 'true';
 export type BooleanStringTitleCase = 'False' | 'True';
 
-export type LogLevelType = 'none' | 'verbose' | 'warning' | 'error';
+export type LogLevelType = (typeof LogLevelType)[keyof typeof LogLevelType];
+export const LogLevelType = {
+    None: 'none',
+    Verbose: 'verbose',
+    Warning: 'warning',
+    Error: 'error',
+} as const;
 
 // TODO: This should eventually be moved into wherever init logic lives
 // TODO: Replace/Merge this with MPConfiguration in @types/mparticle__web-sdk
@@ -306,6 +313,7 @@ export interface SDKInitConfig
     launcherOptions?: IRoktLauncherOptions;
 
     rq?: Function[] | any[];
+    logger?: IConsoleLogger;
 }
 
 export interface DataPlanConfig {

package/src/logger.js

@@ -1,61 +0,0 @@
-function Logger(config) {
-    var self = this;
-    var logLevel = config.logLevel || 'warning';
-    if (config.hasOwnProperty('logger')) {
-        this.logger = config.logger;
-    } else {
-        this.logger = new ConsoleLogger();
-    }
-
-    this.verbose = function(msg) {
-        if (logLevel !== 'none') {
-            if (self.logger.verbose && logLevel === 'verbose') {
-                self.logger.verbose(msg);
-            }
-        }
-    };
-
-    this.warning = function(msg) {
-        if (logLevel !== 'none') {
-            if (
-                self.logger.warning &&
-                (logLevel === 'verbose' || logLevel === 'warning')
-            ) {
-                self.logger.warning(msg);
-            }
-        }
-    };
-
-    this.error = function(msg) {
-        if (logLevel !== 'none') {
-            if (self.logger.error) {
-                self.logger.error(msg);
-            }
-        }
-    };
-
-    this.setLogLevel = function(newLogLevel) {
-        logLevel = newLogLevel;
-    };
-}
-
-function ConsoleLogger() {
-    this.verbose = function(msg) {
-        if (console && console.info) {
-            console.info(msg);
-        }
-    };
-
-    this.error = function(msg) {
-        if (console && console.error) {
-            console.error(msg);
-        }
-    };
-    this.warning = function(msg) {
-        if (console && console.warn) {
-            console.warn(msg);
-        }
-    };
-}
-
-export default Logger;