@oino-ts/types 0.7.2 → 0.8.1

package/common/src/OINOLog.d.ts

@@ -1,13 +1,15 @@
 /** Logging levels */
 export declare enum OINOLogLevel {
     /** Debug messages */
-    debug = 0,
+    debug = 1,
     /** Informational messages */
-    info = 1,
+    info = 2,
     /** Warning messages */
-    warn = 2,
+    warning = 3,
     /** Error messages */
-    error = 3
+    error = 4,
+    /** Exception messages */
+    exception = 5
 }
 /**
  * Abstract base class for logging implementations supporting
@@ -17,11 +19,11 @@ export declare enum OINOLogLevel {
  */
 export declare abstract class OINOLog {
     protected static _instance: OINOLog;
-    protected _logLevel: OINOLogLevel;
+    protected _logLevels: Record<string, OINOLogLevel>;
     /**
      * Abstract logging method to implement the actual logging operation.
      *
-     * @param logLevel level of the log events
+     * @param logLevel default loglevel for all log events
      *
      */
     constructor(logLevel?: OINOLogLevel);
@@ -29,11 +31,14 @@ export declare abstract class OINOLog {
      * Abstract logging method to implement the actual logging operation.
      *
      * @param levelStr level string of the log event
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
      * @param message message of the log event
      * @param data structured data associated with the log event
      *
      */
-    protected abstract _writeLog(levelStr: string, message: string, data?: any): void;
+    protected abstract _writeLog(levelStr: string, domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
      * Abstract logging method to implement the actual logging operation.
      *
@@ -43,7 +48,7 @@ export declare abstract class OINOLog {
      * @param data structured data associated with the log event
      *
      */
-    protected static _log(level: OINOLogLevel, levelStr: string, message: string, data?: any): void;
+    protected static _log(level: OINOLogLevel, levelStr: string, domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
      * Set active logger and log level.
      *
@@ -52,44 +57,76 @@ export declare abstract class OINOLog {
      */
     static setLogger(logger: OINOLog): void;
     /**
-     * Set log level.
+     * Set log level for given combination of domain/channel/method. Not defining dimension(s) means they match any value.
+     * Multiple settings can be combined to set different logging accuracy specifically
+     *
+     * For example:
+     * logLevel: warning, domain: *, channel: *, method: * will only output error events.
+     * logLevel: debug, domain: d1, channel: c1, method: "*" will enable debug events for channel c1 of domain d1.
+     * logLevel: info, domain: d1, channel: c1, method: m1 will supress debug events for method m1.
      *
      * @param logLevel log level to use
+     * @param domain domain of the log event (default: "*" for all)
+     * @param channel channel of the log event (default: "*" for all)
+     * @param method method of the log event (default: "*" for all)
+     *
+     */
+    static setLogLevel(logLevel: OINOLogLevel, domain?: string, channel?: string, method?: string): void;
+    /**
+     * Log exception event. Exception events are prettyprinted and preserve newlines so that stack traces are readable.
+     *
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
+     * @param message message of the log event
+     * @param data structured data associated with the log event
      *
      */
-    static setLogLevel(logLevel: OINOLogLevel): void;
+    static exception(domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
-     * Log error event.
+     * Log error event. Error events are printed as a single line.
      *
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
      * @param message message of the log event
      * @param data structured data associated with the log event
      *
      */
-    static error(message: string, data?: any): void;
+    static error(domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
-     * Log warning event.
+     * Log warning event. Warning events are printed as a single line.
      *
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
      * @param message message of the log event
      * @param data structured data associated with the log event
      *
      */
-    static warning(message: string, data?: any): void;
+    static warning(domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
-     * Log info event.
+     * Log info event. Info events are printed as a single line.
      *
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
      * @param message message of the log event
      * @param data structured data associated with the log event
      *
      */
-    static info(message: string, data?: any): void;
+    static info(domain: string, channel: string, method: string, message: string, data?: any): void;
     /**
-     * Log debug event.
+     * Log debug event. Debug events are prettyprinted.
      *
+     * @param domain domain of the log event
+     * @param channel channel of the log event
+     * @param method method of the log event
      * @param message message of the log event
      * @param data structured data associated with the log event
      *
      */
-    static debug(message: string, data?: any): void;
+    static debug(domain: string, channel: string, method: string, message: string, data?: any): void;
 }
 /**
  * Logging implementation based on console.log.
@@ -101,5 +138,5 @@ export declare class OINOConsoleLog extends OINOLog {
      * @param logLevel logging level
      */
     constructor(logLevel?: OINOLogLevel);
-    protected _writeLog(level: string, message: string, data?: any): void;
+    protected _writeLog(level: string, domain: string, channel: string, method: string, message: string, data?: any): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",