@pristine-ts/logging 0.0.170 → 0.0.174

package/dist/lib/esm/logging.module.js

@@ -6,13 +6,16 @@ import { SeverityEnum } from "./enums/severity.enum";
 export * from "./enums/enums";
 export * from "./handlers/handlers";
 export * from "./interfaces/interfaces";
-export * from "./models/models";
 export * from "./loggers/loggers";
+export * from "./models/models";
 export * from "./utils/utils";
 export * from "./logging.module.keyname";
 export const LoggingModule = {
     keyname: LoggingModuleKeyname,
     configurationDefinitions: [
+        /**
+         * The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+         */
         {
             parameterName: LoggingModuleKeyname + ".numberOfStackedLogs",
             isRequired: false,
@@ -21,6 +24,10 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_NUMBER_OF_STACKED_LOGS")),
             ]
         },
+        /**
+         * The number representing the severity from which logs should be outputted.
+         * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logSeverityLevelConfiguration",
             defaultValue: SeverityEnum.Info,
@@ -29,6 +36,10 @@ export const LoggingModule = {
                 new EnumResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_SEVERITY_LEVEL_CONFIGURATION"), SeverityEnum),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Debug severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logDebugDepthConfiguration",
             defaultValue: 5,
@@ -37,6 +48,10 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_DEBUG_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Info severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logInfoDepthConfiguration",
             defaultValue: 5,
@@ -45,6 +60,10 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_INFO_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Warning severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logWarningDepthConfiguration",
             defaultValue: 5,
@@ -53,6 +72,10 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_WARNING_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Error severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logErrorDepthConfiguration",
             defaultValue: 5,
@@ -61,6 +84,10 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_ERROR_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * The number of level to go down in an object when printing a log with the Critical severity.
+         * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+         */
         {
             parameterName: LoggingModuleKeyname + ".logCriticalDepthConfiguration",
             defaultValue: 5,
@@ -69,6 +96,9 @@ export const LoggingModule = {
                 new NumberResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_LOG_CRITICAL_DEPTH_CONFIGURATION")),
             ]
         },
+        /**
+         * Whether or not the console logger is activated and should output logs.
+         */
         {
             parameterName: LoggingModuleKeyname + ".consoleLoggerActivated",
             defaultValue: true,
@@ -77,6 +107,9 @@ export const LoggingModule = {
                 new BooleanResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_CONSOLE_LOGGER_ACTIVATED")),
             ]
         },
+        /**
+         * The output mode, that the console logger should use from the OutputModeEnum.
+         */
         {
             parameterName: LoggingModuleKeyname + ".consoleLoggerOutputMode",
             defaultValue: OutputModeEnum.Json,
@@ -85,6 +118,9 @@ export const LoggingModule = {
                 new EnumResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_CONSOLE_LOGGER_OUTPUT_MODE"), OutputModeEnum),
             ]
         },
+        /**
+         * The output mode, that the file logger should use from the OutputModeEnum.
+         */
         {
             parameterName: LoggingModuleKeyname + ".fileLoggerOutputMode",
             defaultValue: OutputModeEnum.Json,
@@ -93,6 +129,9 @@ export const LoggingModule = {
                 new EnumResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_OUTPUT_MODE"), OutputModeEnum),
             ]
         },
+        /**
+         * Whether or not the console logger is activated and should output logs.
+         */
         {
             parameterName: LoggingModuleKeyname + ".fileLoggerActivated",
             defaultValue: false,
@@ -101,6 +140,9 @@ export const LoggingModule = {
                 new BooleanResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_ACTIVATED")),
             ]
         },
+        /**
+         * The file path to which the file logger should output the logs.
+         */
         {
             parameterName: LoggingModuleKeyname + ".filePath",
             defaultValue: "./logs.txt",
@@ -109,6 +151,9 @@ export const LoggingModule = {
                 new BooleanResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_PATH")),
             ]
         },
+        /**
+         * Whether or not the file logger should prettify the outputted logs.
+         */
         {
             parameterName: LoggingModuleKeyname + ".fileLoggerPretty",
             defaultValue: false,
@@ -117,6 +162,11 @@ export const LoggingModule = {
                 new BooleanResolver(new EnvironmentVariableResolver("PRISTINE_LOGGING_FILE_LOGGER_PRETTY")),
             ]
         },
+        /**
+         * Whether or not the diagnostic should be activated.
+         * When activated, the stack trace and other diagnostic information will be added to the logs.
+         * This is an intensive process and can dramatically reduce the performance of the code.
+         */
         {
             parameterName: LoggingModuleKeyname + ".activateDiagnostics",
             defaultValue: false,

package/dist/lib/esm/logging.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../../src/logging.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,oBAAoB,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EACH,eAAe,EACf,mBAAmB,EAAE,YAAY,EACjC,2BAA2B,EAC3B,cAAc,EACjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAA;AAExC,MAAM,CAAC,MAAM,aAAa,GAAoB;IAC1C,OAAO,EAAE,oBAAoB;IAC7B,wBAAwB,EAAE;QACtB;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;YAChB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,yCAAyC,CAAC,CAAC;aACjG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,YAAY,CAAC,IAAI;YAC/B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,mDAAmD,CAAC,EAAE,YAAY,CAAC;aACvH;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,4BAA4B;YAClE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,+CAA+C,CAAC,CAAC;aACvG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,+BAA+B;YACrE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,kDAAkD,CAAC,CAAC;aAC1G;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,mDAAmD,CAAC,CAAC;aAC3G;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,yBAAyB;YAC/D,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,2CAA2C,CAAC,CAAC;aACpG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,0BAA0B;YAChE,YAAY,EAAE,cAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,6CAA6C,CAAC,EAAE,cAAc,CAAC;aACnH;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,uBAAuB;YAC7D,YAAY,EAAE,cAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,0CAA0C,CAAC,EAAE,cAAc,CAAC;aAChH;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,wCAAwC,CAAC,CAAC;aACjG;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,WAAW;YACjD,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAC;aACrF;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,mBAAmB;YACzD,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,qCAAqC,CAAC,CAAC;aAC9F;SACJ;QACD;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,uCAAuC,CAAC,CAAC;aAChG;SACJ;KACJ;IACD,aAAa,EAAE;QACX,YAAY;QACZ,mBAAmB;KACtB;IACD,qBAAqB,EAAE,EAAE;CAC5B,CAAC"}
+{"version":3,"file":"logging.module.js","sourceRoot":"","sources":["../../../src/logging.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,oBAAoB,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EACH,eAAe,EACf,mBAAmB,EAAE,YAAY,EACjC,2BAA2B,EAC3B,cAAc,EACjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAA;AAExC,MAAM,CAAC,MAAM,aAAa,GAAoB;IAC1C,OAAO,EAAE,oBAAoB;IAC7B,wBAAwB,EAAE;QACtB;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,EAAE;YAChB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,yCAAyC,CAAC,CAAC;aACjG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,YAAY,CAAC,IAAI;YAC/B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,mDAAmD,CAAC,EAAE,YAAY,CAAC;aACvH;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,4BAA4B;YAClE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,+CAA+C,CAAC,CAAC;aACvG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,+BAA+B;YACrE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,kDAAkD,CAAC,CAAC;aAC1G;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,6BAA6B;YACnE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,gDAAgD,CAAC,CAAC;aACxG;SACJ;QACD;;;WAGG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,gCAAgC;YACtE,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,cAAc,CAAC,IAAI,2BAA2B,CAAC,mDAAmD,CAAC,CAAC;aAC3G;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,yBAAyB;YAC/D,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,2CAA2C,CAAC,CAAC;aACpG;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,0BAA0B;YAChE,YAAY,EAAE,cAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,6CAA6C,CAAC,EAAE,cAAc,CAAC;aACnH;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,uBAAuB;YAC7D,YAAY,EAAE,cAAc,CAAC,IAAI;YACjC,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,YAAY,CAAC,IAAI,2BAA2B,CAAC,0CAA0C,CAAC,EAAE,cAAc,CAAC;aAChH;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,wCAAwC,CAAC,CAAC;aACjG;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,WAAW;YACjD,YAAY,EAAE,YAAY;YAC1B,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,4BAA4B,CAAC,CAAC;aACrF;SACJ;QACD;;WAEG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,mBAAmB;YACzD,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,qCAAqC,CAAC,CAAC;aAC9F;SACJ;QACD;;;;WAIG;QACH;YACI,aAAa,EAAE,oBAAoB,GAAG,sBAAsB;YAC5D,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK;YACjB,gBAAgB,EAAE;gBACd,IAAI,eAAe,CAAC,IAAI,2BAA2B,CAAC,uCAAuC,CAAC,CAAC;aAChG;SACJ;KACJ;IACD,aAAa,EAAE;QACX,YAAY;QACZ,mBAAmB;KACtB;IACD,qBAAqB,EAAE,EAAE;CAC5B,CAAC"}

package/dist/lib/esm/models/diagnostics.model.js

@@ -1,5 +1,12 @@
+/**
+ * The diagnostic model represents detailed information to help debug that will be outputted in the extras of the log
+ * when diagnostic is enabled.
+ */
 export class DiagnosticsModel {
     constructor() {
+        /**
+         * An array representing the stack trace from which the log originated.
+         */
         this.stackTrace = [];
     }
 }

package/dist/lib/esm/models/diagnostics.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"diagnostics.model.js","sourceRoot":"","sources":["../../../../src/models/diagnostics.model.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,gBAAgB;IAA7B;QAEI,eAAU,GAKJ,EAAE,CAAC;IAOb,CAAC;CAAA"}
+{"version":3,"file":"diagnostics.model.js","sourceRoot":"","sources":["../../../../src/models/diagnostics.model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QAOI;;WAEG;QACH,eAAU,GAoBJ,EAAE,CAAC;IA0Bb,CAAC;CAAA"}

package/dist/lib/esm/models/log.model.js

@@ -1,8 +1,23 @@
+/**
+ * The model that represents a log
+ */
 export class LogModel {
+    /**
+     * The model that represents a log
+     * @param severity The log severity.
+     * @param message The actual log message that needs to be outputted.
+     */
     constructor(severity, message) {
         this.severity = severity;
         this.message = message;
+        /**
+         * The date at which the log was created.
+         */
         this.date = new Date();
+        /**
+         * The module from which the log originated.
+         * By default it will be the application module.
+         */
         this.module = "application";
     }
 }

package/dist/lib/esm/models/log.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.model.js","sourceRoot":"","sources":["../../../../src/models/log.model.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,QAAQ;IAOnB,YAAmB,QAAsB,EAAS,OAAe;QAA9C,aAAQ,GAAR,QAAQ,CAAc;QAAS,YAAO,GAAP,OAAO,CAAQ;QALjE,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QACxB,WAAM,GAAW,aAAa,CAAC;IAK/B,CAAC;CAEF"}
+{"version":3,"file":"log.model.js","sourceRoot":"","sources":["../../../../src/models/log.model.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,QAAQ;IA2BnB;;;;OAIG;IACH,YAAmB,QAAsB,EAAS,OAAe;QAA9C,aAAQ,GAAR,QAAQ,CAAc;QAAS,YAAO,GAAP,OAAO,CAAQ;QArBjE;;WAEG;QACH,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QAExB;;;WAGG;QACH,WAAM,GAAW,aAAa,CAAC;IAa/B,CAAC;CAEF"}

package/dist/lib/esm/utils/utils.js

@@ -2,13 +2,28 @@ import { OutputModeEnum } from "../enums/output-mode.enum";
 import { SeverityEnum } from "../enums/severity.enum";
 import format from "date-fns/format";
 import { DiagnosticsModel } from "../models/diagnostics.model";
+/**
+ * This class provides some utility functions to help with the logging.
+ */
 export class Utils {
+    /**
+     * Returns whether or not the value is defined
+     * @param val
+     */
     static isDefined(val) {
         return val !== null && val !== undefined;
     }
+    /**
+     * Returns whether or not the value is flat, meaning it is not an object.
+     * @param val
+     */
     static isFlat(val) {
         return !this.isDefined(val) || ~this.flatTypes.indexOf(val.constructor);
     }
+    /**
+     * Gets the deep keys of an object.
+     * @param obj The object.
+     */
     static getDeepKeys(obj) {
         let subkeys;
         let keys = [];
@@ -27,6 +42,12 @@ export class Utils {
         }
         return keys;
     }
+    /**
+     * This function truncates an object to the max depth required.
+     * @param object The object to truncate.
+     * @param maxDepth The max depth of the object.
+     * @param curDepth The current depth at which we are at.
+     */
     static truncate(object, maxDepth, curDepth = 0) {
         if (curDepth < maxDepth) {
             const newDepth = curDepth + 1;
@@ -60,6 +81,10 @@ export class Utils {
         }
         return;
     }
+    /**
+     * Gets the string representing a value of the log severity enum.
+     * @param logSeverity The log severity for which to get the string representation.
+     */
     static getSeverityText(logSeverity) {
         switch (logSeverity) {
             case SeverityEnum.Debug:
@@ -74,6 +99,13 @@ export class Utils {
                 return "CRITICAL";
         }
     }
+    /**
+     * Returns the string formatted log based on the output model.
+     * @param log The log to be string formatted.
+     * @param outputMode The output mode desired.
+     * @param logDepth The log depth.
+     * @param spaceNumber The number of spaces for a tab.
+     */
     static outputLog(log, outputMode, logDepth, spaceNumber = 0) {
         const jsonSortOrders = ["severity", "message", "date", "module", "traceId", "kernelInstantiationId"];
         switch (outputMode) {
@@ -87,6 +119,10 @@ export class Utils {
                 return format(log.date, "yyyy-MM-dd HH:mm:ss") + " - " + " [" + this.getSeverityText(log.severity) + "] - " + log.message + " - " + JSON.stringify(Utils.truncate(log.extra, 2));
         }
     }
+    /**
+     * Creates the diagnostic model from an error object to attach to a log.
+     * @param error The error object from which to get the stack trace.
+     */
     static getDiagnostics(error) {
         const diagnostics = new DiagnosticsModel();
         const errorStack = error.stack;

package/dist/lib/esm/utils/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/utils/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,cAAc,EAAC,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACpD,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAC,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAG7D,MAAM,OAAO,KAAK;IAIP,MAAM,CAAC,SAAS,CAAC,GAAQ;QAC5B,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,GAAQ;QACzB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC3E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,GAAQ;QAC9B,IAAI,OAAiB,CAAC;QACtB,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;YACjB,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC1D,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;gBACtC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aAC/B;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACtC,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC/B;aACJ;YAED,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAGM,MAAM,CAAC,QAAQ,CAAC,MAAW,EAAE,QAAgB,EAAE,QAAQ,GAAG,CAAC;QAC9D,IAAI,QAAQ,GAAG,QAAQ,EAAE;YACrB,MAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;YAE9B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBACrB,OAAO,MAAM,CAAC;aACjB;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAU,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;oBACf,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;wBACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBACtB;yBAAM;wBACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;qBACzD;gBACL,CAAC,CAAC,CAAA;gBACF,OAAO,MAAM,CAAC;aACjB;iBAAM;gBACH,MAAM,MAAM,GAAQ,EAAE,CAAA;gBACtB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;oBACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;wBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;qBAC7B;yBAAM;wBACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;qBAChE;iBACJ;gBACD,OAAO,MAAM,CAAC;aACjB;SACJ;QAED,OAAO;IACX,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,WAAyB;QACnD,QAAQ,WAAW,EAAE;YACjB,KAAK,YAAY,CAAC,KAAK;gBACnB,OAAO,OAAO,CAAC;YAEnB,KAAK,YAAY,CAAC,IAAI;gBAClB,OAAO,MAAM,CAAC;YAElB,KAAK,YAAY,CAAC,OAAO;gBACrB,OAAO,SAAS,CAAC;YAErB,KAAK,YAAY,CAAC,KAAK;gBACnB,OAAO,OAAO,CAAC;YAEnB,KAAK,YAAY,CAAC,QAAQ;gBACtB,OAAO,UAAU,CAAC;SACzB;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,GAAa,EAAE,UAA0B,EAAE,QAAgB,EAAE,WAAW,GAAG,CAAC;QAChG,MAAM,cAAc,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,uBAAuB,CAAC,CAAC;QAE/G,QAAQ,UAAU,EAAE;YAChB,KAAK,cAAc,CAAC,IAAI;gBACpB,MAAM,YAAY,GAAQ,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxD,YAAY,CAAC,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAErE,MAAM,gBAAgB,GAAa,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,MAAM,CAAE,CAAC,eAAuB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,eAAe,CAAC,KAAK,SAAS,CAAC,CAAA;gBAElL,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;gBAEzC,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;YACrE,KAAK,cAAc,CAAC,MAAM;gBACtB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,qBAAqB,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,MAAM,GAAG,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;SACxL;IACL,CAAC;IAEM,MAAM,CAAC,cAAc,CAAC,KAAY;QACrC,MAAM,WAAW,GAAqB,IAAI,gBAAgB,EAAE,CAAC;QAE7D,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;QAE/B,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,8DAA8D,EAAE,GAAG,CAAC,CAAC;QAE9F,IAAI,UAAU,KAAK,SAAS,EAAE;YAC1B,OAAO,WAAW,CAAC;SACtB;QAED,IAAI,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnC,OAAO,KAAK,KAAK,IAAI,EAAE;YACnB,MAAM,UAAU,GAAG;gBACf,SAAS,EAAG,KAAK,CAAC,CAAC,CAAC;gBACpB,QAAQ,EAAG,KAAK,CAAC,CAAC,CAAC;gBACnB,IAAI,EAAG,KAAK,CAAC,CAAC,CAAC;gBACf,MAAM,EAAG,KAAK,CAAC,CAAC,CAAC;aACpB,CAAC;YAEF,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAExC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClC;QAED,IAAG,WAAW,CAAC,cAAc,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9E,WAAW,CAAC,cAAc,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;SAC1D;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;;AAnIM,eAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/utils/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,cAAc,EAAC,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACpD,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,EAAC,gBAAgB,EAAC,MAAM,6BAA6B,CAAC;AAG7D;;GAEG;AACH,MAAM,OAAO,KAAK;IAId;;;OAGG;IACI,MAAM,CAAC,SAAS,CAAC,GAAQ;QAC5B,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAQ;QACzB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC3E,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,GAAQ;QAC9B,IAAI,OAAiB,CAAC;QACtB,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;YACjB,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC1D,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;gBACtC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;aAC/B;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACtC,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;iBAC/B;aACJ;YAED,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,MAAW,EAAE,QAAgB,EAAE,QAAQ,GAAG,CAAC;QAC9D,IAAI,QAAQ,GAAG,QAAQ,EAAE;YACrB,MAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAC;YAE9B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBACrB,OAAO,MAAM,CAAC;aACjB;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAU,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;oBACf,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;wBACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBACtB;yBAAM;wBACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;qBACzD;gBACL,CAAC,CAAC,CAAA;gBACF,OAAO,MAAM,CAAC;aACjB;iBAAM;gBACH,MAAM,MAAM,GAAQ,EAAE,CAAA;gBACtB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;oBACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;wBAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;qBAC7B;yBAAM;wBACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;qBAChE;iBACJ;gBACD,OAAO,MAAM,CAAC;aACjB;SACJ;QAED,OAAO;IACX,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,WAAyB;QACnD,QAAQ,WAAW,EAAE;YACjB,KAAK,YAAY,CAAC,KAAK;gBACnB,OAAO,OAAO,CAAC;YAEnB,KAAK,YAAY,CAAC,IAAI;gBAClB,OAAO,MAAM,CAAC;YAElB,KAAK,YAAY,CAAC,OAAO;gBACrB,OAAO,SAAS,CAAC;YAErB,KAAK,YAAY,CAAC,KAAK;gBACnB,OAAO,OAAO,CAAC;YAEnB,KAAK,YAAY,CAAC,QAAQ;gBACtB,OAAO,UAAU,CAAC;SACzB;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,SAAS,CAAC,GAAa,EAAE,UAA0B,EAAE,QAAgB,EAAE,WAAW,GAAG,CAAC;QAChG,MAAM,cAAc,GAAa,CAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,uBAAuB,CAAC,CAAC;QAE/G,QAAQ,UAAU,EAAE;YAChB,KAAK,cAAc,CAAC,IAAI;gBACpB,MAAM,YAAY,GAAQ,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxD,YAAY,CAAC,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAErE,MAAM,gBAAgB,GAAa,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,MAAM,CAAE,CAAC,eAAuB,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,eAAe,CAAC,KAAK,SAAS,CAAC,CAAA;gBAElL,cAAc,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;gBAEzC,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;YACrE,KAAK,cAAc,CAAC,MAAM;gBACtB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,qBAAqB,CAAC,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,MAAM,GAAG,GAAG,CAAC,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;SACxL;IACL,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,cAAc,CAAC,KAAY;QACrC,MAAM,WAAW,GAAqB,IAAI,gBAAgB,EAAE,CAAC;QAE7D,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC;QAE/B,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,8DAA8D,EAAE,GAAG,CAAC,CAAC;QAE9F,IAAI,UAAU,KAAK,SAAS,EAAE;YAC1B,OAAO,WAAW,CAAC;SACtB;QAED,IAAI,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnC,OAAO,KAAK,KAAK,IAAI,EAAE;YACnB,MAAM,UAAU,GAAG;gBACf,SAAS,EAAG,KAAK,CAAC,CAAC,CAAC;gBACpB,QAAQ,EAAG,KAAK,CAAC,CAAC,CAAC;gBACnB,IAAI,EAAG,KAAK,CAAC,CAAC,CAAC;gBACf,MAAM,EAAG,KAAK,CAAC,CAAC,CAAC;aACpB,CAAC;YAEF,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAExC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClC;QAED,IAAG,WAAW,CAAC,cAAc,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9E,WAAW,CAAC,cAAc,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;SAC1D;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;;AAnKM,eAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA"}

package/dist/types/enums/output-mode.enum.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Output mode for the logs.
+ */
 export declare enum OutputModeEnum {
+    /**
+     * The logs will output a JSON format.
+     */
     Json = "JSON",
+    /**
+     * The logs will output a simple string format.
+     */
     Simple = "SIMPLE"
 }

package/dist/types/enums/severity.enum.d.ts

@@ -1,3 +1,6 @@
+/**
+ * The severity supported for logging purposes.
+ */
 export declare enum SeverityEnum {
     Critical = 4,
     Error = 3,

package/dist/types/handlers/log.handler.d.ts

@@ -2,17 +2,72 @@ import "reflect-metadata";
 import { LoggerInterface } from "../interfaces/logger.interface";
 import { TracingContext } from "@pristine-ts/common";
 import { LogHandlerInterface } from "../interfaces/log-handler.interface";
+/**
+ * The LogHandler to use when we want to output some logs.
+ * This handler makes sure that only the right level of logs are outputted, stacks logs, and logs with different loggers.
+ * It is registered with the tag LogHandlerInterface so that it can be injected as a LogHandlerInterface to facilitate mocking.
+ */
 export declare class LogHandler implements LogHandlerInterface {
     private readonly loggers;
     private readonly logSeverityLevelConfiguration;
     private readonly activateDiagnostics;
     private readonly kernelInstantiationId;
     private readonly tracingContext;
+    /**
+     * The LogHandler to use when we want to output some logs.
+     * @param loggers The loggers to use to output the logs. All services with the tag ServiceDefinitionTagEnum.Logger will be automatically injected here.
+     * @param logSeverityLevelConfiguration The severity from which to start logging the logs.
+     * @param activateDiagnostics Whether or not the outputted logs should contain the diagnostic part. This is an intensive process and can dramatically reduce the performance of the code.
+     * @param kernelInstantiationId The id of instantiation of the kernel.
+     * @param tracingContext The context of the tracing.
+     */
     constructor(loggers: LoggerInterface[], logSeverityLevelConfiguration: number, activateDiagnostics: boolean, kernelInstantiationId: string, tracingContext: TracingContext);
-    error(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     critical(message: string, extra?: any, module?: string): void;
-    debug(message: string, extra?: any, module?: string): void;
-    info(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to error or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    error(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to warning or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     warning(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to info or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    info(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to debug or above.
+     * This function is wrapper function for the log method with the proper severity to make it cleaner when using it in the code.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    debug(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message based on the severity.
+     * @param message The message to log.
+     * @param severity The minimum severity to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     private log;
 }

package/dist/types/interfaces/log-handler.interface.d.ts

@@ -1,7 +1,41 @@
+/**
+ * This interface defines what functions should be implemented by a LogHandler.
+ * This interface is what should be injected when you want a LogHandler so that mocking can be done easier.
+ */
 export interface LogHandlerInterface {
-    error(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     critical(message: string, extra?: any, module?: string): void;
-    debug(message: string, extra?: any, module?: string): void;
-    info(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    error(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
     warning(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    info(message: string, extra?: any, module?: string): void;
+    /**
+     * Logs the message if the severity is set to critical or above.
+     * @param message The message to log.
+     * @param extra The extra object to log.
+     * @param module The module from where the log was created.
+     */
+    debug(message: string, extra?: any, module?: string): void;
 }

package/dist/types/interfaces/logger.interface.d.ts

@@ -1,6 +1,17 @@
 /// <reference types="node" />
 import { Readable } from "stream";
+/**
+ * This interface defines what should be implemented by a Logger.
+ * A logger is a class that defines how logs should be outputted.
+ * For example, an application could have multiple active loggers, one to output in the console, one to output in a file, etc.
+ */
 export interface LoggerInterface {
+    /**
+     * The readable stream from which the logger reads the logs that need to be outputted.
+     */
     readableStream: Readable;
+    /**
+     * Returns whether or not this particular logger is active and should ouput logs.
+     */
     isActive(): boolean;
 }

package/dist/types/loggers/base.logger.d.ts

@@ -1,5 +1,10 @@
 import { LogModel } from "../models/log.model";
 import { OutputModeEnum } from "../enums/output-mode.enum";
+/**
+ * The BaseLogger is the base abstract class that all internal loggers should extend.
+ * It defines the basic logic that applies to all internal loggers.
+ * External loggers could extend the base logger but it is not mandatory.
+ */
 export declare abstract class BaseLogger {
     protected readonly numberOfStackedLogs: number;
     protected readonly logSeverityLevelConfiguration: number;
@@ -11,15 +16,80 @@ export declare abstract class BaseLogger {
     private readonly isActivated;
     protected readonly outputMode: OutputModeEnum;
     protected readonly spaces: number;
+    /**
+     * The stacked logs are the logs that were not outputted right away but that will need to be outputted if a log with a higher severity arrives.
+     * @private
+     */
     private stackedLogs;
+    /**
+     * The BaseLogger is the base abstract class that all loggers should extend.
+     * It defines the basic logic that applies to all loggers.
+     * @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+     * @param logSeverityLevelConfiguration The number representing the severity from which logs should be outputted.
+     * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+     * @param logDebugDepthConfiguration The number of level to go down in an object when printing a log with the Debug severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logInfoDepthConfiguration The number of level to go down in an object when printing a log with the Info severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logWarningDepthConfiguration The number of level to go down in an object when printing a log with the Warning severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logErrorDepthConfiguration The number of level to go down in an object when printing a log with the Error severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logCriticalDepthConfiguration The number of level to go down in an object when printing a log with the Critical severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param isActivated Whether or not this particular logger is activated and should output logs.
+     * @param outputMode The output mode, that the logger should use.
+     * @param spaces The number of spaces to indent the outputted logs.
+     */
     constructor(numberOfStackedLogs: number, logSeverityLevelConfiguration: number, logDebugDepthConfiguration: number, logInfoDepthConfiguration: number, logWarningDepthConfiguration: number, logErrorDepthConfiguration: number, logCriticalDepthConfiguration: number, isActivated?: boolean, outputMode?: OutputModeEnum, spaces?: number);
+    /**
+     * Initializes the logger. To be implemented in each logger.
+     * @protected
+     */
     protected abstract initialize(): void;
+    /**
+     * Returns whether this particular logger is active and should output logs.
+     */
     isActive(): boolean;
-    outputLog(log: LogModel): string;
+    /**
+     * Gets the formatted output log based on a log model.
+     * @param log The log to be formatted.
+     */
+    getFormattedOutputLog(log: LogModel): string;
+    /**
+     * Actually outputs the log. To be implemented in each logger.
+     * @param log The log to be outputted.
+     * @protected
+     */
     protected abstract log(log: LogModel): void;
+    /**
+     * Captures the log and evaluates which logs need to be outputted or stacked.
+     * @param log The log to be captured.
+     * @protected
+     */
     protected captureLog(log: LogModel): void;
+    /**
+     * Sets up the stack of logs if it is required.
+     * @param traceId Optional trace id to stack logs based on different requests.
+     * @private
+     */
     private setupStackedLogsArrayIfRequired;
+    /**
+     * Adds the log to the stacked logs and makes sure we only keep the right amount of stacked logs.
+     * @param log The log to be added.
+     * @private
+     */
     private addStackedLog;
+    /**
+     * Outputs the stacked logs.
+     * @param traceId Optional trace id so that we only output the stacked logs for this trace.
+     * @private
+     */
     private outputStackedLogs;
+    /**
+     * Clears the stacked logs.
+     * @param traceId Optional trace id so that we only remove the stacked logs for this trace.
+     * @private
+     */
     private clearStackedLogs;
 }

package/dist/types/loggers/console.logger.d.ts

@@ -4,9 +4,44 @@ import { LoggerInterface } from "../interfaces/logger.interface";
 import { Readable } from "stream";
 import { OutputModeEnum } from "../enums/output-mode.enum";
 import { BaseLogger } from "./base.logger";
+/**
+ * The ConsoleLogger outputs the logs in the console.
+ * It is registered with the tag Logger so that it can be injected along with all the other Loggers.
+ * It is module scoped to the logging module so that it is only registered if the logging module is imported.
+ */
 export declare class ConsoleLogger extends BaseLogger implements LoggerInterface {
+    /**
+     * The readable stream from which the logger reads the logs that need to be outputted.
+     */
     readableStream: Readable;
-    constructor(numberOfStackedLogs: number, logSeverityLevelConfiguration: number, logDebugDepthConfiguration: number, logInfoDepthConfiguration: number, logWarningDepthConfiguration: number, logErrorDepthConfiguration: number, logCriticalDepthConfiguration: number, isActive: boolean, outputMode: OutputModeEnum);
+    /**
+     * The ConsoleLogger outputs the logs in the console.
+     * @param numberOfStackedLogs The number of logs to keep in the stack and to print once a log with a high enough severity arrives.
+     * @param logSeverityLevelConfiguration The number representing the severity from which logs should be outputted.
+     * For example, if this is set to 3, any log that has a severity of Error(3) or critical(4) will be outputted.
+     * @param logDebugDepthConfiguration The number of level to go down in an object when printing a log with the Debug severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logInfoDepthConfiguration The number of level to go down in an object when printing a log with the Info severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logWarningDepthConfiguration The number of level to go down in an object when printing a log with the Warning severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logErrorDepthConfiguration The number of level to go down in an object when printing a log with the Error severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param logCriticalDepthConfiguration The number of level to go down in an object when printing a log with the Critical severity.
+     * We often do not need to go to the bottom layer of an object, so we can truncate at a certain depth.
+     * @param isActivated Whether or not this particular logger is activated and should output logs.
+     * @param outputMode The output mode, that the logger should use.
+     */
+    constructor(numberOfStackedLogs: number, logSeverityLevelConfiguration: number, logDebugDepthConfiguration: number, logInfoDepthConfiguration: number, logWarningDepthConfiguration: number, logErrorDepthConfiguration: number, logCriticalDepthConfiguration: number, isActivated: boolean, outputMode: OutputModeEnum);
+    /**
+     * Initializes the console logger.
+     * @protected
+     */
     protected initialize(): void;
+    /**
+     * Outputs the log in the console.
+     * @param log The log to be outputted
+     * @protected
+     */
     protected log(log: LogModel): void;
 }