zeddemore-logger 1.2.4 → 2.0.0

package/lib/date.js

@@ -2,9 +2,31 @@
 
 const _ = require('lodash');
 
+function convertFechaDateFormatToLuxon(dateFormat) {
+    const tokenMappings = [
+        { fecha: 'YYYY', luxon: 'yyyy' },
+        { fecha: 'YY', luxon: 'yy' },
+        { fecha: 'MMMM', luxon: 'LLLL' },
+        { fecha: 'MMM', luxon: 'LLL' },
+        { fecha: 'MM', luxon: 'LL' },
+        { fecha: 'M', luxon: 'L' },
+        { fecha: 'dddd', luxon: 'cccc' },
+        { fecha: 'ddd', luxon: 'ccc' },
+        { fecha: 'DD', luxon: 'dd' },
+        { fecha: 'D', luxon: 'd' },
+        { fecha: 'SS', luxon: 'SSS' },
+    ];
+    if (!_.isString(dateFormat)) return null;
+    let _dateFormat = dateFormat.trim();
+    for (const tokenMapping of tokenMappings) {
+        _dateFormat = _dateFormat.replaceAll(tokenMapping.fecha, tokenMapping.luxon);
+    }
+    return _dateFormat;
+}
+
 function convertMilliseconds(milliseconds, options) {
     options = options || { };
-    const digits = _.isInteger(options.digits) ? options.digits : 3;
+    const digits = _.isInteger(options.digits) ? options.digits : 2;
     const spaced = _.isBoolean(options.spaced) ? options.spaced : false;
     let value = milliseconds || 0;
     let unit = 'ms';
@@ -49,5 +71,6 @@ function convertMilliseconds(milliseconds, options) {
 }
 
 module.exports = {
+    convertFechaDateFormatToLuxon,
     convertMilliseconds,
 };

package/lib/defaults.js

@@ -0,0 +1,37 @@
+// Copyright (c) 2024-2025 by Beardon Services, Inc.
+
+const enums = require('./enums');
+
+const { hexColors: hc, morganFormats: mf, morganFormatTokens: mft, winstonLogLevelNames: wlln } = enums;
+
+module.exports = {
+    colorConsoleWhiteHex: hc.CONSOLE_WHITE,
+    consoleDirExtensionMethodName: 'dirp',
+    consoleDirExtensionColors: true,
+    consoleDirExtensionDepth: null,
+    consoleDirExtensionShowHidden: true,
+    consoleTransportName: 'console',
+    contentLengthDigits: 2,
+    liveMessage: '⚡live⚡',
+    morganFormat: mf.ZEDDEMORE,
+    morganFormatTokens: [ mft.METHOD, mft.DECODED_URL, mft.STATUS, mft.RESPONSE_TIME_FORMAT, mft.CONTENT_LENGTH_FORMAT ],
+    morganFormatTokensColorized: [ mft.METHOD, mft.DECODED_URL, mft.STATUS_COLORED, mft.RESPONSE_TIME_FORMAT, mft.CONTENT_LENGTH_FORMAT ],
+    progressBarBarFormat: '{bar}',
+    progressBarCompleteCharacter: '█',
+    progressBarDelimiter: '|',
+    progressBarDurationFormat: '{duration}s',
+    progressBarDurationFormattedFormat: '{duration_formatted}',
+    progressBarEtaFormat: '{eta}s',
+    progressBarEtaFormattedFormat: '{eta_formatted}',
+    progressBarIncompleteCharacter: '░',
+    progressBarPercentageFormat: '{percentage}%',
+    progressBarPostfixFormat: '{postfix}',
+    progressBarValueFormat: '{value}',
+    progressBarTotalFormat: '{total}',
+    requestIdAttribute: 'requestId',
+    requestIdIcon: '🧵',
+    responseTimeDigits: 0,
+    timestampFormat: 'YYYY-MM-DD HH:mm:ss',
+    userLogLevel: -1,
+    winstonLogLevelName: wlln.INFO,
+};

package/lib/enums.js

@@ -1,5 +1,12 @@
 // Copyright (c) 2025 by Beardon Services, Inc.
 
+function doesEnumInclude(set, value) {
+    for (const key in set) {
+        if (set[ key ] === value) return true;
+    }
+    return false;
+}
+
 const ansiColors = {
     HTTP_CLIENT_ERROR: 33, // red
     HTTP_INFORMATIONAL: 0, // white
@@ -144,6 +151,12 @@ const morganFormatTokens = {
     USER_AGENT: 'user-agent',
 };
 
+const progressBarAlignments = {
+    CENTER: 'center',
+    LEFT: 'left',
+    RIGHT: 'right',
+};
+
 const winstonLogLevelNames = {
     ERROR: 'error',
     WARNING: 'warn',
@@ -166,6 +179,7 @@ const winstonLogLevels = {
 };
 
 module.exports = {
+    doesEnumInclude,
     ansiColors,
     apiLogLevelCaptions,
     apiLogLevels,
@@ -179,6 +193,7 @@ module.exports = {
     httpResponseHeaders,
     morganFormats,
     morganFormatTokens,
+    progressBarAlignments,
     winstonLogLevelNames,
     winstonLogLevels,
 };

package/lib/logging.js

@@ -0,0 +1,76 @@
+// Copyright (c) 2025 by Beardon Services, Inc.
+
+const _ = require('lodash');
+
+const defaults = require('./defaults');
+const enums = require('./enums');
+const { logLevelMap } = require('./mappings/log_mappings');
+
+const { doesEnumInclude } = enums;
+
+function isMorganFormat(format) {
+    return doesEnumInclude(enums.morganFormats, format);
+}
+
+function isValidLogLevel(logLevel) {
+    if (!logLevel) return false;
+    if (_.isInteger(logLevel)) return isValidLogLevelId(logLevel);
+    if (_.isString(logLevel)) return isValidLogLevelName(logLevel);
+    return false;
+}
+
+function isValidLogLevelId(logLevelId) {
+    if (!_.isInteger(logLevelId)) return false;
+    return !!(_.find(logLevelMap, { winstonLevel: logLevelId }))
+}
+
+function isValidLogLevelName(logLevelName) {
+    if (!_.isString(logLevelName)) return false;
+    return !!(_.find(logLevelMap, { winstonName: logLevelName }))
+}
+
+/**
+ * Convert a log level ID to a Winston log level name
+ * @param levelId {number}
+ * @returns {string}
+ */
+function logLevelIdToWinstonLogLevelName(levelId) {
+    if (!isValidLogLevelId(levelId)) return defaults.winstonLogLevelName;
+    const logLevelEntry =  _.find(logLevelMap, { winstonLevel: levelId });
+    return (logLevelEntry ? logLevelEntry.winstonName : null) || defaults.winstonLogLevelName;
+}
+
+/**
+ * Convert a log level to a Winston log level name
+ * @param logLevel {number|string}
+ * @returns {string}
+ */
+function logLevelToWinstonLogLevelName(logLevel) {
+    if (!isValidLogLevel(logLevel)) return defaults.winstonLogLevelName;
+    if (_.isString(logLevel)) return logLevel;
+    return logLevelIdToWinstonLogLevelName(logLevel);
+}
+
+/**
+ * Monkey patch console to allow unlimited depth with `console.dirp`
+ */
+function monkeyPatchConsole(methodNames = [ defaults.consoleDirExtensionMethodName ], colors = defaults.consoleDirExtensionColors, depth = defaults.consoleDirExtensionDepth, showHidden = defaults.consoleDirExtensionShowHidden) {
+    if (!_.isArray(methodNames)) methodNames = [ methodNames ];
+    const _colors = _.isBoolean(colors) ? colors : defaults.consoleDirExtensionColors;
+    const _depth = _.isInteger(depth) ? depth : defaults.consoleDirExtensionDepth;
+    const _showHidden = _.isBoolean(showHidden) ? showHidden : defaults.consoleDirExtensionShowHidden;
+    for (const methodName of methodNames) {
+        if (!!console[ methodName ]) continue;
+        console[ methodName ] = function(...args) {
+            console.dir(args, { colors: _colors, depth: _depth, showHidden: _showHidden });
+        };
+    }
+}
+
+module.exports = {
+    isMorganFormat,
+    isValidLogLevel,
+    logLevelIdToWinstonLogLevelName,
+    logLevelToWinstonLogLevelName,
+    monkeyPatchConsole,
+};

package/lib/typedef.js

@@ -0,0 +1,33 @@
+/** @typedef {Object} app
+ * @property {Object} locals
+ * @property {ZeddemoreLoggerController|null} locals.logger
+ */
+
+/**
+ * @typedef {Object|null} Metadata
+ * @property {String} [caller]
+ * @property {String} [fullId]
+ * @property {String} [id]
+ * @property {String} [ip]
+ * @property {String} [label]
+ * @property {String} [prefix]
+ * @property {Boolean} [raw]
+ * @property {String} [subId]
+ * @property {String} [target]
+ * @property {String} [timestamp]
+ * @property {String} [user]
+ */
+
+/**
+ * @typedef {Object|null} SequelizeModel
+ * @property {Function} [create]
+ * @property {Function} [findOne]
+ */
+
+/**
+ * @typedef {Object} user
+ * @property {String} [ipAddress]
+ * @property {String} [login]
+ * @property {number|String} [logLevel]
+ * @property {String} [username]
+ */

package/lib/uuid.js

@@ -0,0 +1,11 @@
+// Copyright (c) 2025 by Beardon Services, Inc.
+
+const { v4: uuid } = require('uuid');
+
+function generateUuid() {
+    return uuid(null, null, null);
+}
+
+module.exports = {
+    generateUuid,
+};