jet-logger 1.3.1 → 2.0.1

package/README.md

@@ -13,7 +13,7 @@ $ npm install --save jet-logger
 ```
 
 ### Guide
-The logger package's main export is the default `logger` object. This default export will use of course, all the default settings. If you wish to pass your own settings you can import the `jetLogger()` function and pass parameters to configure your own custom logging objects.
+The logger package's default export is an instance of the `JetLogger` class. This default export uses all the default settings. If you wish to pass your own settings you can import the `JetLogger` class and pass parameters to the constructor to configure your own custom logger.
 
 - The five environment variables are:
   - `JET_LOGGER_MODE`: can be `'CONSOLE'`(default), `'FILE'`, `'CUSTOM'`, and `'OFF'`.
@@ -22,7 +22,7 @@ The logger package's main export is the default `logger` object. This default ex
   - `JET_LOGGER_TIMESTAMP`: adds a timestamp next to each log. Can be `'TRUE'` (default) or `'FALSE'`.
   - `JET_LOGGER_FORMAT`: formats log as a line or JSON object. Can be `'LINE'` (default) or `'JSON'`.
 
-_logger_ has an export `LoggerModes` which is an enum that provides all the modes if you want to use them in code. I would recommend using `Console` for local development, `File` for remote development, and `Custom` or `Off` for production. If you want to change the settings in code, you can do so via importing the `JetLogger` function and calling it with whatever options you want.
+_logger_ has an export `LoggerModes` which is an enum that provides all the modes if you want to use them in code. I would recommend using `Console` for local development, `File` for remote development, and `Custom` or `Off` for production. If you want to change the settings in code, you can do so via importing the `JetLogger` class and calling it with whatever options you want.
 <br>
 
 - There are 4 functions on Logger to print logs.
@@ -97,18 +97,17 @@ For production you'll probably have some third party logging tool like ElasticSe
 // In the route file
 import { OK } from 'http-status-codes';
 import { Router, Request, Response } from 'express';
-import { jetLogger, TCustomLogFn, ILogger } from 'jet-logger';
+import { JetLogger, TCustomLogFn } from 'jet-logger';
 import { thirdPartyLoggingApp } from 'thirdPartyLoggingApplicationLib';
 
 
 // Needs to be implemented
-const customSend: TCustomLogFn = (timestamp: Date, level: string, content: any) => {
+const customSend: TCustomLogFn = (timestamp: Date, level: string, content: unknown) => {
   thirdPartyLoggingApp.doStuff(...);
 }
 
 router.get('api/users', async (req: Request, res: Reponse) => {
-  const logger: ILogger = jetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
-  logger.settings.rmTimestamp = true;
+  const logger = new JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
   logger.info(req.params.msg);
   return res.status(OK).json({
     message: 'console_mode',

package/lib/JetLogger.d.ts

@@ -0,0 +1,30 @@
+export declare enum LoggerModes {
+    Console = "CONSOLE",
+    File = "FILE",
+    Custom = "CUSTOM",
+    Off = "OFF"
+}
+export declare enum Formats {
+    Line = "LINE",
+    Json = "JSON"
+}
+export declare type TCustomLogFn = (timestamp: Date, prefix: string, content: unknown) => void;
+export declare class JetLogger {
+    private mode;
+    private filePath;
+    private timestamp;
+    private format;
+    private customLogFn;
+    constructor(mode?: LoggerModes, filepath?: string, filepathDatetimeParam?: boolean, timestamp?: boolean, format?: Formats, customLogFn?: TCustomLogFn);
+    private addDatetimeToFileName;
+    info(content: unknown, printFull?: boolean): void;
+    imp(content: unknown, printFull?: boolean): void;
+    warn(content: unknown, printFull?: boolean): void;
+    err(content: unknown, printFull?: boolean): void;
+    private printLog;
+    private setupLineFormat;
+    private setupJsonFormat;
+    private writeToFile;
+}
+declare const _default: JetLogger;
+export default _default;

package/lib/JetLogger.js

@@ -0,0 +1,178 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JetLogger = exports.Formats = exports.LoggerModes = void 0;
+var util_1 = __importDefault(require("util"));
+var colors_1 = __importDefault(require("colors"));
+var fs_1 = __importDefault(require("fs"));
+var LoggerModes;
+(function (LoggerModes) {
+    LoggerModes["Console"] = "CONSOLE";
+    LoggerModes["File"] = "FILE";
+    LoggerModes["Custom"] = "CUSTOM";
+    LoggerModes["Off"] = "OFF";
+})(LoggerModes = exports.LoggerModes || (exports.LoggerModes = {}));
+var Formats;
+(function (Formats) {
+    Formats["Line"] = "LINE";
+    Formats["Json"] = "JSON";
+})(Formats = exports.Formats || (exports.Formats = {}));
+var Levels = {
+    Info: {
+        Color: 'green',
+        Prefix: 'INFO',
+    },
+    Important: {
+        Color: 'magenta',
+        Prefix: 'IMPORTANT',
+    },
+    Warning: {
+        Color: 'yellow',
+        Prefix: 'WARNING',
+    },
+    Error: {
+        Color: 'red',
+        Prefix: 'ERROR',
+    }
+};
+var Errors = {
+    CustomLogFn: 'Custom logger mode set to true, but no custom logger was ' +
+        'provided.',
+    Mode: 'The correct logger mode was not specified: Must be "CUSTOM", ' +
+        '"FILE", "OFF", or "CONSOLE".'
+};
+var JetLogger = (function () {
+    function JetLogger(mode, filepath, filepathDatetimeParam, timestamp, format, customLogFn) {
+        this.mode = LoggerModes.Console;
+        this.filePath = 'jet-logger.log';
+        this.timestamp = true;
+        this.format = Formats.Line;
+        this.customLogFn = function () { return ({}); };
+        if (mode !== undefined) {
+            this.mode = mode;
+        }
+        else if (!!process.env.JET_LOGGER_MODE) {
+            this.mode = process.env.JET_LOGGER_MODE.toUpperCase();
+        }
+        if (filepath !== undefined) {
+            this.filePath = filepath;
+        }
+        else if (!!process.env.JET_LOGGER_FILEPATH) {
+            this.filePath = process.env.JET_LOGGER_FILEPATH;
+        }
+        var filePathDatetime = true;
+        if (filepathDatetimeParam !== undefined) {
+            filePathDatetime = filepathDatetimeParam;
+        }
+        else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
+            var envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
+            filePathDatetime = envVar.toUpperCase() === 'TRUE';
+        }
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        else if (!!process.env.JET_LOGGER_TIMESTAMP) {
+            var envVar = process.env.JET_LOGGER_TIMESTAMP;
+            this.timestamp = (envVar.toUpperCase() === 'TRUE');
+        }
+        if (format !== undefined) {
+            this.format = format;
+        }
+        else if (!!process.env.JET_LOGGER_FORMAT) {
+            this.format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+        }
+        if (filePathDatetime) {
+            this.filePath = this.addDatetimeToFileName(this.filePath);
+        }
+        if (customLogFn !== undefined) {
+            this.customLogFn = customLogFn;
+        }
+    }
+    JetLogger.prototype.addDatetimeToFileName = function (filePath) {
+        var dateStr = new Date().toISOString()
+            .split('-').join('')
+            .split(':').join('')
+            .slice(0, 15);
+        var filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = (dateStr + '_' + fileName);
+        filePathArr[lastIdx] = fileNameNew;
+        return filePathArr.join('/');
+    };
+    JetLogger.prototype.info = function (content, printFull) {
+        this.printLog(content, !!printFull, Levels.Info);
+    };
+    JetLogger.prototype.imp = function (content, printFull) {
+        this.printLog(content, !!printFull, Levels.Important);
+    };
+    JetLogger.prototype.warn = function (content, printFull) {
+        this.printLog(content, !!printFull, Levels.Warning);
+    };
+    JetLogger.prototype.err = function (content, printFull) {
+        this.printLog(content, !!printFull, Levels.Error);
+    };
+    JetLogger.prototype.printLog = function (contentParam, printFull, level) {
+        if (this.mode === LoggerModes.Off) {
+            return;
+        }
+        var content;
+        if (printFull) {
+            content = util_1.default.inspect(contentParam);
+        }
+        else {
+            content = String(contentParam);
+        }
+        if (this.mode === LoggerModes.Custom) {
+            if (!!this.customLogFn) {
+                return this.customLogFn(new Date(), level.Prefix, content);
+            }
+            else {
+                throw Error(Errors.CustomLogFn);
+            }
+        }
+        if (this.format === Formats.Line) {
+            content = this.setupLineFormat(content, level);
+        }
+        else if (this.format === Formats.Json) {
+            content = this.setupJsonFormat(content, level);
+        }
+        if (this.mode === LoggerModes.Console) {
+            var colorFn = colors_1.default[level.Color];
+            console.log(colorFn(content));
+        }
+        else if (this.mode === LoggerModes.File) {
+            this.writeToFile(content + '\n');
+        }
+        else {
+            throw Error(Errors.Mode);
+        }
+    };
+    JetLogger.prototype.setupLineFormat = function (content, level) {
+        content = (level.Prefix + ': ' + content);
+        if (this.timestamp) {
+            var time = '[' + new Date().toISOString() + '] ';
+            return (time + content);
+        }
+        return content;
+    };
+    JetLogger.prototype.setupJsonFormat = function (content, level) {
+        var json = {
+            level: level.Prefix,
+            message: content,
+        };
+        if (this.timestamp) {
+            json.timestamp = new Date().toISOString();
+        }
+        return JSON.stringify(json);
+    };
+    JetLogger.prototype.writeToFile = function (content) {
+        fs_1.default.appendFile(this.filePath, content, function (err) {
+            if (!!err) {
+                console.error(err);
+            }
+        });
+    };
+    return JetLogger;
+}());
+exports.JetLogger = JetLogger;
+exports.default = new JetLogger();

package/lib/index.d.ts

@@ -1 +1 @@
-export { LoggerModes, Formats, TCustomLogFn, ILogger, jetLogger, default as default, } from './jetLogger';
+export { LoggerModes, Formats, TCustomLogFn, JetLogger, default as default, } from './JetLogger';

package/lib/index.js

@@ -3,9 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = exports.jetLogger = exports.Formats = exports.LoggerModes = void 0;
-var jetLogger_1 = require("./jetLogger");
-Object.defineProperty(exports, "LoggerModes", { enumerable: true, get: function () { return jetLogger_1.LoggerModes; } });
-Object.defineProperty(exports, "Formats", { enumerable: true, get: function () { return jetLogger_1.Formats; } });
-Object.defineProperty(exports, "jetLogger", { enumerable: true, get: function () { return jetLogger_1.jetLogger; } });
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(jetLogger_1).default; } });
+exports.default = exports.JetLogger = exports.Formats = exports.LoggerModes = void 0;
+var JetLogger_1 = require("./JetLogger");
+Object.defineProperty(exports, "LoggerModes", { enumerable: true, get: function () { return JetLogger_1.LoggerModes; } });
+Object.defineProperty(exports, "Formats", { enumerable: true, get: function () { return JetLogger_1.Formats; } });
+Object.defineProperty(exports, "JetLogger", { enumerable: true, get: function () { return JetLogger_1.JetLogger; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(JetLogger_1).default; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jet-logger",
-  "version": "1.3.1",
+  "version": "2.0.1",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",

package/lib/jetLogger.d.ts

@@ -1,30 +0,0 @@
-export declare enum LoggerModes {
-    Console = "CONSOLE",
-    File = "FILE",
-    Custom = "CUSTOM",
-    Off = "OFF"
-}
-export declare enum Formats {
-    Line = "LINE",
-    Json = "JSON"
-}
-declare type TLogFn = (content: any, printFull?: boolean) => void;
-export declare type TCustomLogFn = (timestamp: Date, prefix: string, content: unknown) => void;
-export interface ILogger {
-    settings: ISettings;
-    info: TLogFn;
-    imp: TLogFn;
-    warn: TLogFn;
-    err: TLogFn;
-}
-interface ISettings {
-    mode: LoggerModes;
-    filepath: string;
-    filepathDatetime: boolean;
-    timestamp: boolean;
-    format: Formats;
-    customLogFn?: TCustomLogFn;
-}
-export declare function jetLogger(mode?: LoggerModes, filepath?: string, filepathDatetime?: boolean, timestamp?: boolean, format?: Formats, customLogFn?: TCustomLogFn): ILogger;
-declare const _default: ILogger;
-export default _default;

package/lib/jetLogger.js

@@ -1,190 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jetLogger = exports.Formats = exports.LoggerModes = void 0;
-var util_1 = __importDefault(require("util"));
-var colors_1 = __importDefault(require("colors"));
-var fs_1 = __importDefault(require("fs"));
-var LoggerModes;
-(function (LoggerModes) {
-    LoggerModes["Console"] = "CONSOLE";
-    LoggerModes["File"] = "FILE";
-    LoggerModes["Custom"] = "CUSTOM";
-    LoggerModes["Off"] = "OFF";
-})(LoggerModes = exports.LoggerModes || (exports.LoggerModes = {}));
-var Formats;
-(function (Formats) {
-    Formats["Line"] = "LINE";
-    Formats["Json"] = "JSON";
-})(Formats = exports.Formats || (exports.Formats = {}));
-var Levels = {
-    Info: {
-        Color: 'green',
-        Prefix: 'INFO',
-    },
-    Imp: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
-    },
-    Warn: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
-    },
-    Err: {
-        Color: 'red',
-        Prefix: 'ERROR',
-    }
-};
-var Errors = {
-    customLogFn: 'Custom logger mode set to true, but no custom logger was ' +
-        'provided.',
-    Mode: 'The correct logger mode was not specified: Must be "CUSTOM", ' +
-        '"FILE", "OFF", or "CONSOLE".'
-};
-var Defaults = {
-    Filepath: 'jet-logger.log',
-    Mode: LoggerModes.Console,
-    Timestamp: true,
-    FilepathDatetime: true,
-    Format: Formats.Line,
-};
-function jetLogger(mode, filepath, filepathDatetime, timestamp, format, customLogFn) {
-    var settings = _getSettings(mode, filepath, timestamp, filepathDatetime, format, customLogFn);
-    return { settings: settings, info: info, imp: imp, warn: warn, err: err };
-}
-exports.jetLogger = jetLogger;
-function _getSettings(mode, filepath, filepathDatetime, timestamp, format, customLogFn) {
-    if (!mode) {
-        if (!!process.env.JET_LOGGER_MODE) {
-            mode = process.env.JET_LOGGER_MODE.toUpperCase();
-        }
-        else {
-            mode = Defaults.Mode;
-        }
-    }
-    if (!filepath) {
-        if (!!process.env.JET_LOGGER_FILEPATH) {
-            filepath = process.env.JET_LOGGER_FILEPATH;
-        }
-        else {
-            filepath = Defaults.Filepath;
-        }
-    }
-    if (filepathDatetime === undefined || filepathDatetime === null) {
-        var envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-        if (!!envVar) {
-            filepathDatetime = (envVar.toUpperCase() === 'TRUE');
-        }
-        else {
-            filepathDatetime = Defaults.FilepathDatetime;
-        }
-    }
-    if (timestamp === undefined || timestamp === null) {
-        if (!!process.env.JET_LOGGER_TIMESTAMP) {
-            timestamp = (process.env.JET_LOGGER_TIMESTAMP.toUpperCase() === 'TRUE');
-        }
-        else {
-            timestamp = Defaults.Timestamp;
-        }
-    }
-    if (!format) {
-        if (!!process.env.JET_LOGGER_FORMAT) {
-            format = process.env.JET_LOGGER_FORMAT.toUpperCase();
-        }
-        else {
-            format = Defaults.Format;
-        }
-    }
-    if (filepathDatetime) {
-        filepath = _addDatetimeToFileName(filepath);
-    }
-    return {
-        mode: mode,
-        filepath: filepath,
-        filepathDatetime: filepathDatetime,
-        timestamp: timestamp,
-        format: format,
-        customLogFn: customLogFn,
-    };
-}
-function _addDatetimeToFileName(filePath) {
-    var dateStr = new Date().toISOString()
-        .split('-').join('')
-        .split(':').join('')
-        .slice(0, 15);
-    var filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = (dateStr + '_' + fileName);
-    filePathArr[lastIdx] = fileNameNew;
-    return filePathArr.join('/');
-}
-function info(content, printFull) {
-    return _printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, Levels.Info, this.settings);
-}
-function imp(content, printFull) {
-    return _printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, Levels.Imp, this.settings);
-}
-function warn(content, printFull) {
-    return _printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, Levels.Warn, this.settings);
-}
-function err(content, printFull) {
-    return _printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, Levels.Err, this.settings);
-}
-function _printLog(content, printFull, level, settings) {
-    var mode = settings.mode, format = settings.format, timestamp = settings.timestamp, filepath = settings.filepath, customLogFn = settings.customLogFn;
-    if (mode === LoggerModes.Off) {
-        return;
-    }
-    if (printFull) {
-        content = util_1.default.inspect(content);
-    }
-    if (mode === LoggerModes.Custom) {
-        if (!!customLogFn) {
-            return customLogFn(new Date(), level.Prefix, content);
-        }
-        else {
-            throw Error(Errors.customLogFn);
-        }
-    }
-    if (format === Formats.Line) {
-        content = _setupLineFormat(content, timestamp, level);
-    }
-    else if (format === Formats.Json) {
-        content = _setupJsonFormat(content, timestamp, level);
-    }
-    if (mode === LoggerModes.Console) {
-        var colorFn = colors_1.default[level.Color];
-        console.log(colorFn(content));
-    }
-    else if (mode === LoggerModes.File) {
-        _writeToFile(content + '\n', filepath)
-            .catch(function (err) { return console.log(err); });
-    }
-    else {
-        throw Error(Errors.Mode);
-    }
-}
-function _setupLineFormat(content, timestamp, level) {
-    content = (level.Prefix + ': ' + content);
-    if (timestamp) {
-        var time = '[' + new Date().toISOString() + '] ';
-        return (time + content);
-    }
-    return content;
-}
-function _setupJsonFormat(content, timestamp, level) {
-    var json = {
-        level: level.Prefix,
-        message: content,
-    };
-    if (timestamp) {
-        json.timestamp = new Date().toISOString();
-    }
-    return JSON.stringify(json);
-}
-function _writeToFile(content, filePath) {
-    return new Promise(function (res, rej) {
-        return fs_1.default.appendFile(filePath, content, (function (err) { return !!err ? rej(err) : res(); }));
-    });
-}
-exports.default = jetLogger();

package/tsconfig.build.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "exclude": [
-    "./node_modules",
-    "test"
-  ]
-}