refactor: replace SDKLoggerApi with ILogger interface

Define proper ILogger and IConsoleLogger interfaces in logger.ts and
have Logger/ConsoleLogger implement them directly. SDKLoggerApi is
retained as a deprecated type alias for backwards compatibility.

Updates all consumers (audienceManager, batchUploader, roktManager)
and tests to import ILogger from logger.ts.

Author: alexs-mparticle

src/audienceManager.ts

@@ -1,4 +1,4 @@
-import { SDKLoggerApi } from './sdkRuntimeModels';
+import { ILogger } from './logger';
 import {
     FetchUploader,
     XHRUploader,
@@ -21,12 +21,12 @@ export interface IAudienceMemberships {
 export default class AudienceManager {
     public url: string = '';
     public userAudienceAPI: AsyncUploader;
-    public logger: SDKLoggerApi;
+    public logger: ILogger;
 
     constructor(
         userAudienceUrl: string,
         apiKey: string,
-        logger: SDKLoggerApi,
+        logger: ILogger,
     ) {
         this.logger = logger;
         this.url = `https://${userAudienceUrl}${apiKey}/audience`;

src/batchUploader.ts

@@ -1,7 +1,7 @@
 import { Batch } from '@mparticle/event-models';
 import Constants from './constants';
 import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
-import { convertEvents } from './sdkToEventsApiConverter';
+import { convertEvents} from './sdkToEventsApiConverter';
 import { MessageType, EventType } from './types';
 import { getRampNumber, isEmpty, obfuscateDevData } from './utils';
 import { SessionStorageVault, LocalStorageVault } from './vault';

src/logger.ts

@@ -1,9 +1,23 @@
-import { LogLevelType, SDKInitConfig, SDKLoggerApi } from './sdkRuntimeModels';
+import { LogLevelType, SDKInitConfig } from './sdkRuntimeModels';
+import { ReportingLogger } from './logging/reportingLogger';
+import { ErrorCodes } from './logging/types';
+
+export interface ILogger {
+    error(msg: string, code?: ErrorCodes): void;
+    verbose(msg: string): void;
+    warning(msg: string): void;
+    setLogLevel(logLevel: LogLevelType): void;
+}
+
+export interface IConsoleLogger {
+    error?(msg: string): void;
+    verbose?(msg: string): void;
+    warning?(msg: string): void;
+}
 
 export type ILoggerConfig = Pick<SDKInitConfig, 'logLevel' | 'logger'>;
-export type IConsoleLogger = Partial<Pick<SDKLoggerApi, 'error' | 'warning' | 'verbose'>>;
 
-export class Logger {
+export class Logger implements ILogger {
     private logLevel: LogLevelType;
     private logger: IConsoleLogger;
 

src/roktManager.ts

@@ -12,7 +12,7 @@ import {
     obfuscateDevData,
 } from "./utils";
 import { SDKIdentityApi } from "./identity.interfaces";
-import { SDKLoggerApi } from "./sdkRuntimeModels";
+import { ILogger } from "./logger";
 import { IStore, LocalSessionAttributes } from "./store";
 import { UserIdentities } from "@mparticle/web-sdk";
 import { IdentityType, PerformanceMarkType } from "./types";
@@ -108,7 +108,7 @@ export default class RoktManager {
     private identityService: SDKIdentityApi;
     private store: IStore;
     private launcherOptions?: IRoktLauncherOptions;
-    private logger: SDKLoggerApi;
+    private logger: ILogger;
     private errorReporter: IErrorReportingService;
     private loggingService: ILoggingService;
     private domain?: string;
@@ -130,7 +130,7 @@ export default class RoktManager {
      * @param {IKitConfigs} roktConfig - Configuration object containing user attribute filters and settings
      * @param {IMParticleUser} filteredUser - User object with filtered attributes
      * @param {SDKIdentityApi} identityService - The mParticle Identity instance
-     * @param {SDKLoggerApi} logger - The mParticle Logger instance
+     * @param {ILogger} logger - The mParticle Logger instance
      * @param {IRoktOptions} options - Options for the RoktManager
      * @param {Function} captureTiming - Function to capture performance timing marks
      * @param {IErrorReportingService} errorReporter - Dispatcher for error/warning reporting
@@ -143,7 +143,7 @@ export default class RoktManager {
         filteredUser: IMParticleUser,
         identityService: SDKIdentityApi,
         store: IStore,
-        logger?: SDKLoggerApi,
+        logger?: ILogger,
         options?: IRoktOptions,
         captureTiming?: (metricsName: string) => void,
         errorReporter?: IErrorReportingService,

src/sdkRuntimeModels.ts

@@ -50,7 +50,7 @@ import {
 } from './mp-instance';
 import Constants from './constants';
 import RoktManager, { IRoktLauncherOptions } from './roktManager';
-import { IConsoleLogger } from './logger';
+import { IConsoleLogger, ILogger } from './logger';
 import { ErrorCodes, IErrorReportingService, ILoggingService } from './reporting/types';
 
 // TODO: Resolve this with version in @mparticle/web-sdk
@@ -185,7 +185,7 @@ export interface MParticleWebSDK {
     PromotionType: typeof PromotionActionType;
     ProductActionType: typeof ProductActionType;
     Identity: SDKIdentityApi;
-    Logger: SDKLoggerApi;
+    Logger: ILogger;
     Consent: SDKConsentApi;
     _resetForTests(
         MPConfig?: SDKInitConfig,
@@ -392,13 +392,8 @@ export interface SDKHelpersApi {
     Validators: typeof Validators;
 }
 
-export interface SDKLoggerApi {
-    error(msg: string, code?: ErrorCodes): void;
-    verbose(msg: string): void;
-    warning(msg: string): void;
-    isVerbose(): boolean;
-    setLogLevel(logLevel: LogLevelType): void;
-}
+/** @deprecated Use {@link ILogger} from './logger' instead */
+export type SDKLoggerApi = ILogger;
 
 // TODO: Merge this with IStore in store.ts
 export interface SDKStoreApi {

test/src/tests-audience-manager.ts

@@ -3,11 +3,11 @@ import fetchMock from 'fetch-mock/esm/client';
 import { expect } from 'chai';
 import { urls, apiKey, testMPID, MPConfig } from './config/constants';
 import Constants from '../../src/constants';
-import { IMParticleInstanceManager, SDKLoggerApi } from '../../src/sdkRuntimeModels';
+import { IMParticleInstanceManager } from '../../src/sdkRuntimeModels';
 import AudienceManager, {
     IAudienceMemberships, IAudienceMembershipsServerResponse
 } from '../../src/audienceManager';
-import { Logger } from '../../src/logger';
+import { ILogger, Logger } from '../../src/logger';
 import Utils from './config/utils';
 const { fetchMockSuccess } = Utils;
 
@@ -35,7 +35,7 @@ describe('AudienceManager', () => {
 
     describe('initialization', () => {
         it('should have proper properties on AudienceManager', () => {
-            const newLogger: SDKLoggerApi = new Logger(window.mParticle.config);
+            const newLogger: ILogger = new Logger(window.mParticle.config);
             const audienceManager = new AudienceManager(
                 Constants.DefaultBaseUrls.userAudienceUrl,
                 apiKey,
@@ -49,7 +49,7 @@ describe('AudienceManager', () => {
     });
 
     describe('#sendGetUserAudienceRequest', () => {
-        let newLogger: SDKLoggerApi;
+        let newLogger: ILogger;
         let audienceManager: AudienceManager;
         beforeEach(() => {
             newLogger = new Logger(window.mParticle.config);