@splitsoftware/splitio-commons 2.6.1-rc.0 → 2.6.1-rc.1

package/CHANGES.txt

@@ -1,4 +1,4 @@
-2.7.0 (October XX, 2025)
+2.7.0 (October 6, 2025)
  - Added support for custom loggers: added `logger` configuration option and `LoggerAPI.setLogger` method to allow the SDK to use a custom logger.
 
 2.6.0 (September 18, 2025)

package/cjs/logger/index.js

@@ -18,6 +18,12 @@ var LogLevelIndexes = {
     ERROR: 4,
     NONE: 5
 };
+var DEFAULT_LOGGER = {
+    debug: function (msg) { console.log('[DEBUG] ' + msg); },
+    info: function (msg) { console.log('[INFO]  ' + msg); },
+    warn: function (msg) { console.log('[WARN]  ' + msg); },
+    error: function (msg) { console.log('[ERROR] ' + msg); }
+};
 function isLogLevelString(str) {
     return !!(0, lang_1.find)(exports.LogLevels, function (lvl) { return str === lvl; });
 }
@@ -42,7 +48,6 @@ exports._sprintf = _sprintf;
 var defaultOptions = {
     prefix: 'splitio',
     logLevel: exports.LogLevels.NONE,
-    showLevel: true,
 };
 var Logger = /** @class */ (function () {
     function Logger(options, codes) {
@@ -55,31 +60,38 @@ var Logger = /** @class */ (function () {
         this.logLevel = LogLevelIndexes[logLevel];
     };
     Logger.prototype.setLogger = function (logger) {
-        if (!logger || (0, commons_1.isLogger)(logger)) {
-            this.logger = logger;
-        }
-        else {
-            this._log(exports.LogLevels.ERROR, 'Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
-            this.logger = undefined;
+        if (logger) {
+            if ((0, commons_1.isLogger)(logger)) {
+                this.logger = logger;
+                // If custom logger is set, all logs are either enabled or disabled
+                if (this.logLevel !== LogLevelIndexes.NONE)
+                    this.setLogLevel(exports.LogLevels.DEBUG);
+                return;
+            }
+            else {
+                this.error('Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
+            }
         }
+        // unset
+        this.logger = undefined;
     };
     Logger.prototype.debug = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.DEBUG))
-            this._log(exports.LogLevels.DEBUG, msg, args);
+            this._log('debug', msg, args);
     };
     Logger.prototype.info = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.INFO))
-            this._log(exports.LogLevels.INFO, msg, args);
+            this._log('info', msg, args);
     };
     Logger.prototype.warn = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.WARN))
-            this._log(exports.LogLevels.WARN, msg, args);
+            this._log('warn', msg, args);
     };
     Logger.prototype.error = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.ERROR))
-            this._log(exports.LogLevels.ERROR, msg, args);
+            this._log('error', msg, args);
     };
-    Logger.prototype._log = function (level, msg, args) {
+    Logger.prototype._log = function (method, msg, args) {
         if (typeof msg === 'number') {
             var format = this.codes.get(msg);
             msg = format ? _sprintf(format, args) : "Message code " + msg + (args ? ', with args: ' + args.toString() : '');
@@ -88,27 +100,16 @@ var Logger = /** @class */ (function () {
             if (args)
                 msg = _sprintf(msg, args);
         }
-        var formattedText = this._generateLogMessage(level, msg);
-        // Do not break on custom logger errors
+        if (this.options.prefix)
+            msg = this.options.prefix + ' => ' + msg;
         if (this.logger) {
-            try { // @ts-expect-error
-                this.logger[level.toLowerCase()](formattedText);
+            try {
+                this.logger[method](msg);
                 return;
             }
             catch (e) { /* empty */ }
         }
-        console.log(formattedText);
-    };
-    Logger.prototype._generateLogMessage = function (level, text) {
-        var textPre = ' => ';
-        var result = '';
-        if (this.options.showLevel) {
-            result += '[' + level + ']' + (level === exports.LogLevels.INFO || level === exports.LogLevels.WARN ? ' ' : '') + ' ';
-        }
-        if (this.options.prefix) {
-            result += this.options.prefix + textPre;
-        }
-        return result += text;
+        DEFAULT_LOGGER[method](msg);
     };
     Logger.prototype._shouldLog = function (level) {
         return level >= this.logLevel;

package/cjs/utils/settingsValidation/logger/builtinLogger.js

@@ -39,9 +39,9 @@ function validateLogger(settings) {
     var logLevel = debug !== undefined ? (0, commons_1.getLogLevel)(debug) : initialLogLevel;
     var log = new logger_1.Logger({ logLevel: logLevel || initialLogLevel }, allCodes);
     log.setLogger(logger);
-    // @ts-ignore // if logLevel is undefined at this point, it means that settings `debug` value is invalid
+    // if logLevel is undefined at this point, it means that settings `debug` value is invalid
     if (!logLevel)
-        log._log(logger_1.LogLevels.ERROR, 'Invalid Log Level - No changes to the logs will be applied.');
+        log._log('error', 'Invalid Log Level - No changes to the logs will be applied.');
     return log;
 }
 exports.validateLogger = validateLogger;

package/cjs/utils/settingsValidation/logger/pluggableLogger.js

@@ -27,9 +27,9 @@ function validateLogger(settings) {
     }
     var log = new logger_1.Logger({ logLevel: logLevel || initialLogLevel });
     log.setLogger(logger);
-    // @ts-ignore // `debug` value is invalid if logLevel is undefined at this point
+    // `debug` value is invalid if logLevel is undefined at this point
     if (!logLevel)
-        log._log(logger_1.LogLevels.ERROR, 'Invalid `debug` value at config. Logs will be disabled.');
+        log._log('error', 'Invalid `debug` value at config. Logs will be disabled.');
     return log;
 }
 exports.validateLogger = validateLogger;

package/esm/logger/index.js

@@ -15,6 +15,12 @@ var LogLevelIndexes = {
     ERROR: 4,
     NONE: 5
 };
+var DEFAULT_LOGGER = {
+    debug: function (msg) { console.log('[DEBUG] ' + msg); },
+    info: function (msg) { console.log('[INFO]  ' + msg); },
+    warn: function (msg) { console.log('[WARN]  ' + msg); },
+    error: function (msg) { console.log('[ERROR] ' + msg); }
+};
 export function isLogLevelString(str) {
     return !!find(LogLevels, function (lvl) { return str === lvl; });
 }
@@ -37,7 +43,6 @@ export function _sprintf(format, args) {
 var defaultOptions = {
     prefix: 'splitio',
     logLevel: LogLevels.NONE,
-    showLevel: true,
 };
 var Logger = /** @class */ (function () {
     function Logger(options, codes) {
@@ -50,31 +55,38 @@ var Logger = /** @class */ (function () {
         this.logLevel = LogLevelIndexes[logLevel];
     };
     Logger.prototype.setLogger = function (logger) {
-        if (!logger || isLogger(logger)) {
-            this.logger = logger;
-        }
-        else {
-            this._log(LogLevels.ERROR, 'Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
-            this.logger = undefined;
+        if (logger) {
+            if (isLogger(logger)) {
+                this.logger = logger;
+                // If custom logger is set, all logs are either enabled or disabled
+                if (this.logLevel !== LogLevelIndexes.NONE)
+                    this.setLogLevel(LogLevels.DEBUG);
+                return;
+            }
+            else {
+                this.error('Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
+            }
         }
+        // unset
+        this.logger = undefined;
     };
     Logger.prototype.debug = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.DEBUG))
-            this._log(LogLevels.DEBUG, msg, args);
+            this._log('debug', msg, args);
     };
     Logger.prototype.info = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.INFO))
-            this._log(LogLevels.INFO, msg, args);
+            this._log('info', msg, args);
     };
     Logger.prototype.warn = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.WARN))
-            this._log(LogLevels.WARN, msg, args);
+            this._log('warn', msg, args);
     };
     Logger.prototype.error = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.ERROR))
-            this._log(LogLevels.ERROR, msg, args);
+            this._log('error', msg, args);
     };
-    Logger.prototype._log = function (level, msg, args) {
+    Logger.prototype._log = function (method, msg, args) {
         if (typeof msg === 'number') {
             var format = this.codes.get(msg);
             msg = format ? _sprintf(format, args) : "Message code " + msg + (args ? ', with args: ' + args.toString() : '');
@@ -83,27 +95,16 @@ var Logger = /** @class */ (function () {
             if (args)
                 msg = _sprintf(msg, args);
         }
-        var formattedText = this._generateLogMessage(level, msg);
-        // Do not break on custom logger errors
+        if (this.options.prefix)
+            msg = this.options.prefix + ' => ' + msg;
         if (this.logger) {
-            try { // @ts-expect-error
-                this.logger[level.toLowerCase()](formattedText);
+            try {
+                this.logger[method](msg);
                 return;
             }
             catch (e) { /* empty */ }
         }
-        console.log(formattedText);
-    };
-    Logger.prototype._generateLogMessage = function (level, text) {
-        var textPre = ' => ';
-        var result = '';
-        if (this.options.showLevel) {
-            result += '[' + level + ']' + (level === LogLevels.INFO || level === LogLevels.WARN ? ' ' : '') + ' ';
-        }
-        if (this.options.prefix) {
-            result += this.options.prefix + textPre;
-        }
-        return result += text;
+        DEFAULT_LOGGER[method](msg);
     };
     Logger.prototype._shouldLog = function (level) {
         return level >= this.logLevel;

package/esm/utils/settingsValidation/logger/builtinLogger.js

@@ -36,8 +36,8 @@ export function validateLogger(settings) {
     var logLevel = debug !== undefined ? getLogLevel(debug) : initialLogLevel;
     var log = new Logger({ logLevel: logLevel || initialLogLevel }, allCodes);
     log.setLogger(logger);
-    // @ts-ignore // if logLevel is undefined at this point, it means that settings `debug` value is invalid
+    // if logLevel is undefined at this point, it means that settings `debug` value is invalid
     if (!logLevel)
-        log._log(LogLevels.ERROR, 'Invalid Log Level - No changes to the logs will be applied.');
+        log._log('error', 'Invalid Log Level - No changes to the logs will be applied.');
     return log;
 }

package/esm/utils/settingsValidation/logger/pluggableLogger.js

@@ -24,8 +24,8 @@ export function validateLogger(settings) {
     }
     var log = new Logger({ logLevel: logLevel || initialLogLevel });
     log.setLogger(logger);
-    // @ts-ignore // `debug` value is invalid if logLevel is undefined at this point
+    // `debug` value is invalid if logLevel is undefined at this point
     if (!logLevel)
-        log._log(LogLevels.ERROR, 'Invalid `debug` value at config. Logs will be disabled.');
+        log._log('error', 'Invalid `debug` value at config. Logs will be disabled.');
     return log;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.6.1-rc.0",
+  "version": "2.6.1-rc.1",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/logger/index.ts

@@ -20,6 +20,13 @@ const LogLevelIndexes = {
   NONE: 5
 };
 
+const DEFAULT_LOGGER: SplitIO.Logger = {
+  debug(msg) { console.log('[DEBUG] ' + msg); },
+  info(msg) { console.log('[INFO]  ' + msg); },
+  warn(msg) { console.log('[WARN]  ' + msg); },
+  error(msg) { console.log('[ERROR] ' + msg); }
+};
+
 export function isLogLevelString(str: string): str is SplitIO.LogLevel {
   return !!find(LogLevels, (lvl: string) => str === lvl);
 }
@@ -41,7 +48,6 @@ export function _sprintf(format: string = '', args: any[] = []): string {
 const defaultOptions = {
   prefix: 'splitio',
   logLevel: LogLevels.NONE,
-  showLevel: true,
 };
 
 export class Logger implements ILogger {
@@ -63,31 +69,37 @@ export class Logger implements ILogger {
   }
 
   setLogger(logger?: SplitIO.Logger) {
-    if (!logger || isLogger(logger)) {
-      this.logger = logger;
-    } else {
-      this._log(LogLevels.ERROR, 'Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
-      this.logger = undefined;
+    if (logger) {
+      if (isLogger(logger)) {
+        this.logger = logger;
+        // If custom logger is set, all logs are either enabled or disabled
+        if (this.logLevel !== LogLevelIndexes.NONE) this.setLogLevel(LogLevels.DEBUG);
+        return;
+      } else {
+        this.error('Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
+      }
     }
+    // unset
+    this.logger = undefined;
   }
 
   debug(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.DEBUG)) this._log(LogLevels.DEBUG, msg, args);
+    if (this._shouldLog(LogLevelIndexes.DEBUG)) this._log('debug', msg, args);
   }
 
   info(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.INFO)) this._log(LogLevels.INFO, msg, args);
+    if (this._shouldLog(LogLevelIndexes.INFO)) this._log('info', msg, args);
   }
 
   warn(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.WARN)) this._log(LogLevels.WARN, msg, args);
+    if (this._shouldLog(LogLevelIndexes.WARN)) this._log('warn', msg, args);
   }
 
   error(msg: string | number, args?: any[]) {
-    if (this._shouldLog(LogLevelIndexes.ERROR)) this._log(LogLevels.ERROR, msg, args);
+    if (this._shouldLog(LogLevelIndexes.ERROR)) this._log('error', msg, args);
   }
 
-  private _log(level: SplitIO.LogLevel, msg: string | number, args?: any[]) {
+  _log(method: keyof SplitIO.Logger, msg: string | number, args?: any[]) {
     if (typeof msg === 'number') {
       const format = this.codes.get(msg);
       msg = format ? _sprintf(format, args) : `Message code ${msg}${args ? ', with args: ' + args.toString() : ''}`;
@@ -95,32 +107,15 @@ export class Logger implements ILogger {
       if (args) msg = _sprintf(msg, args);
     }
 
-    const formattedText = this._generateLogMessage(level, msg);
+    if (this.options.prefix) msg = this.options.prefix + ' => ' + msg;
 
-    // Do not break on custom logger errors
     if (this.logger) {
-      try { // @ts-expect-error
-        this.logger[level.toLowerCase()](formattedText);
+      try {
+        this.logger[method](msg);
         return;
       } catch (e) { /* empty */ }
     }
-
-    console.log(formattedText);
-  }
-
-  private _generateLogMessage(level: SplitIO.LogLevel, text: string) {
-    const textPre = ' => ';
-    let result = '';
-
-    if (this.options.showLevel) {
-      result += '[' + level + ']' + (level === LogLevels.INFO || level === LogLevels.WARN ? ' ' : '') + ' ';
-    }
-
-    if (this.options.prefix) {
-      result += this.options.prefix + textPre;
-    }
-
-    return result += text;
+    DEFAULT_LOGGER[method](msg);
   }
 
   private _shouldLog(level: number) {

package/src/logger/types.ts

@@ -3,7 +3,6 @@ import SplitIO from '../../types/splitio';
 export interface ILoggerOptions {
   prefix?: string;
   logLevel?: SplitIO.LogLevel;
-  showLevel?: boolean; // @TODO remove this param eventually since it is not being set `false` anymore
 }
 
 export interface ILogger extends SplitIO.ILogger {

package/src/utils/settingsValidation/logger/builtinLogger.ts

@@ -48,8 +48,8 @@ export function validateLogger(settings: { debug: unknown, logger?: SplitIO.Logg
   const log = new Logger({ logLevel: logLevel || initialLogLevel }, allCodes);
   log.setLogger(logger);
 
-  // @ts-ignore // if logLevel is undefined at this point, it means that settings `debug` value is invalid
-  if (!logLevel) log._log(LogLevels.ERROR, 'Invalid Log Level - No changes to the logs will be applied.');
+  // if logLevel is undefined at this point, it means that settings `debug` value is invalid
+  if (!logLevel) log._log('error', 'Invalid Log Level - No changes to the logs will be applied.');
 
   return log;
 }

package/src/utils/settingsValidation/logger/pluggableLogger.ts

@@ -32,8 +32,8 @@ export function validateLogger(settings: { debug: unknown, logger?: SplitIO.Logg
   const log = new Logger({ logLevel: logLevel || initialLogLevel });
   log.setLogger(logger);
 
-  // @ts-ignore // `debug` value is invalid if logLevel is undefined at this point
-  if (!logLevel) log._log(LogLevels.ERROR, 'Invalid `debug` value at config. Logs will be disabled.');
+  // `debug` value is invalid if logLevel is undefined at this point
+  if (!logLevel) log._log('error', 'Invalid `debug` value at config. Logs will be disabled.');
 
   return log;
 }

package/types/splitio.d.ts

@@ -145,6 +145,8 @@ interface IPluggableSharedSettings {
    * config.debug = ErrorLogger()
    * ```
    *
+   * When combined with the `logger` option, any log level other than `NONE` (false) will be set to `DEBUG` (true), delegating log level control to the custom logger.
+   *
    * @defaultValue `false`
    */
   debug?: boolean | SplitIO.LogLevel | SplitIO.ILogger;
@@ -168,6 +170,8 @@ interface INonPluggableSharedSettings {
    * config.debug = 'WARN'
    * ```
    *
+   * When combined with the `logger` option, any log level other than `NONE` (false) will be set to `DEBUG` (true), delegating log level control to the custom logger.
+   *
    * @defaultValue `false`
    */
   debug?: boolean | SplitIO.LogLevel;