zeddemore-logger 2.2.5 → 2.2.7

package/lib/enums.js

@@ -1,207 +1,208 @@
-// Copyright (c) 2025-2026 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
-    HTTP_REDIRECTION: 36, // blue
-    HTTP_SERVER_ERROR: 31, // red
-    HTTP_SUCCESSFUL: 32, // green
-    LOG_LEVEL_DEBUG: 34, // blue
-    LOG_LEVEL_ERROR: 31, // red
-    LOG_LEVEL_HTTP: 32, // green
-    LOG_LEVEL_INFO: 32, // green
-    LOG_LEVEL_SILLY: 35, // magenta
-    LOG_LEVEL_VERBOSE: 36, // cyan
-    LOG_LEVEL_WARNING: 33, // yellow
-};
-
-const chalkFormats = {
-    ANSI: 'ansi',
-    HEX: 'hex',
-    RGB: 'rgb',
-};
-
-const chalkLayers = {
-    BACKGROUND: 'bg',
-    FOREGROUND: 'fg',
-};
-
-const hexColors = {
-    BEARDON_RED: '#951A1D',
-    BLACK: '#000000',
-    CONSOLE_WHITE: '#ECECEC',
-    DB_DELETE: '#F22613',
-    DB_INSERT: '#00B16A',
-    DB_SELECT: '#1E90FF',
-    DB_TRUNCATE: '#750505',
-    DB_UPDATE: '#F9690E',
-    HTTP_CONNECT: '#FFFFFF',
-    HTTP_DELETE: '#EF968A',
-    HTTP_GET: '#67D193',
-    HTTP_HEAD: '#68D696',
-    HTTP_OPTIONS: '#E55AA8',
-    HTTP_PATCH: '#C0A8E1',
-    HTTP_POST: '#F4DA7A',
-    HTTP_PUT: '#74AEF6',
-    HTTP_TRACE: '#FFFFFF',
-    PACKAGE_ANGULARJS: '#C04737',
-    PACKAGE_AXIOS: '#6200e1',
-    PACKAGE_EXPRESS: '#F7DF1E',
-    PACKAGE_HANDLEBARS: '#F0772B',
-    PACKAGE_JIMP: '#FF0000',
-    PACKAGE_MYSQL: '#00618A',
-    PACKAGE_NODE_JS: '#689F63',
-    PACKAGE_NODEMAILER: '#29ABE2',
-    PACKAGE_PASSPORT: '#51E492',
-    PACKAGE_PDFKIT: '#DB000D',
-    PACKAGE_POSTGRESQL: '#336791',
-    PACKAGE_REDIS: '#C23936',
-    PACKAGE_SEQUELIZE: '#00AFEF',
-    PACKAGE_ZEDDEMORE: '#E2B68F',
-};
-
-const httpStatusCodeGroups = {
-    INFORMATIONAL: 1,
-    SUCCESSFUL: 2,
-    REDIRECTION: 3,
-    CLIENT_ERROR: 4,
-    SERVER_ERROR: 5,
-};
-
-const httpMethods = {
-    GET: 'GET',
-    HEAD: 'HEAD',
-    POST: 'POST',
-    PUT: 'PUT',
-    DELETE: 'DELETE',
-    CONNECT: 'CONNECT',
-    OPTIONS: 'OPTIONS',
-    TRACE: 'TRACE',
-    PATCH: 'PATCH',
-};
-
-const httpRequestHeaders = {
-    ALLOW: 'Allow',
-    APP_VERSION: 'App-Version',
-    AUTHORIZATION: 'Authorization',
-    BEARER_PREFIX: 'Bearer',
-    FORWARDED_FOR: 'X-Forwarded-For',
-    REQUEST_ID: 'X-Request-Id',
-    USER_AGENT: 'User-Agent',
-};
-
-const httpResponseHeaders = {
-    CONTENT_LENGTH: 'Content-Length',
-};
-
-const logLevelTypes = {
-    CONSOLE: 'console',
-    EMAIL: 'email',
-};
-
-const morganFormats = {
-    COMBINED: 'combined',
-    COMMON: 'common',
-    DEV: 'dev',
-    SHORT: 'short',
-    TINY: 'tiny',
-    ZEDDEMORE: 'zeddemore', // added for `zeddemore-logger`
-};
-
-const morganFormatTokens = {
-    CONTENT_LENGTH_FORMAT: 'content-length-format', // added for `zeddemore-logger`
-    DATE: 'date', // :date[format]
-    DECODED_URL: 'decoded-url', // added for `zeddemore-logger`
-    HTTP_VERSION: 'http-version',
-    METHOD: 'method',
-    REFERRER: 'referrer',
-    REMOTE_ADDR: 'remote-addr',
-    REMOTE_USER: 'remote-user',
-    REQ: 'req', // :req[header]
-    RES: 'res', // :res[header]
-    RESPONSE_TIME: 'response-time', // :response-time[digits]
-    RESPONSE_TIME_FORMAT: 'response-time-format', // added for `zeddemore-logger`
-    STATUS: 'status',
-    STATUS_COLORED: 'status-colored', // added for `zeddemore-logger`
-    TOTAL_TIME: 'total-time', // :total-time[digits]
-    URL: 'url',
-    USER_AGENT: 'user-agent',
-};
-
-const winstonFormats = {
-    COLORIZE: 'colorize',
-    JSON: 'json',
-    METADATA: 'metadata',
-    PRETTY_PRINT: 'pretty_print',
-    SIMPLE: 'simple',
-    SPLAT: 'splat',
-    TIMESTAMP: 'timestamp',
-    ZEDDEMORE_INFO_MUTATION: 'zeddemore_info_mutation',
-    ZEDDEMORE_LABEL: 'zeddemore_label',
-    ZEDDEMORE_PRINTF: 'zeddemore_printf',
-    ZEDDEMORE_TIMESTAMP: 'zeddemore_timestamp',
-};
-
-const winstonLogLevelNames = {
-    ERROR: 'error',
-    WARNING: 'warn',
-    INFO: 'info',
-    HTTP: 'http',
-    VERBOSE: 'verbose',
-    DEBUG: 'debug',
-    SILLY: 'silly',
-};
-
-// using NPM logging levels
-const winstonLogLevels = {
-    ERROR: 0,
-    WARNING: 1,
-    INFO: 2,
-    HTTP: 3,
-    VERBOSE: 4,
-    DEBUG: 5,
-    SILLY: 6,
-};
-
-const winstonTransports = {
-    CONSOLE: 'console',
-    EMAIL: 'email',
-};
-
-const zeddemoreLogLevelCaptions = {
-    DEFAULT: 'Default',
-    ERROR: 'Error',
-    WARNING: 'Warning',
-    INFO: 'Info',
-    HTTP: 'HTTP',
-    VERBOSE: 'Verbose',
-    DEBUG: 'Debug',
-    SILLY: 'Silly',
-};
-
-module.exports = {
-    doesEnumInclude,
-    ansiColors,
-    chalkFormats,
-    chalkLayers,
-    hexColors,
-    httpStatusCodeGroups,
-    httpMethods,
-    httpRequestHeaders,
-    httpResponseHeaders,
-    logLevelTypes,
-    morganFormats,
-    morganFormatTokens,
-    winstonFormats,
-    winstonLogLevelNames,
-    winstonLogLevels,
-    winstonTransports,
-    zeddemoreLogLevelCaptions,
-};
+// Copyright (c) 2025-2026 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
+    HTTP_REDIRECTION: 36, // blue
+    HTTP_SERVER_ERROR: 31, // red
+    HTTP_SUCCESSFUL: 32, // green
+    LOG_LEVEL_DEBUG: 34, // blue
+    LOG_LEVEL_ERROR: 31, // red
+    LOG_LEVEL_HTTP: 32, // green
+    LOG_LEVEL_INFO: 32, // green
+    LOG_LEVEL_SILLY: 35, // magenta
+    LOG_LEVEL_VERBOSE: 36, // cyan
+    LOG_LEVEL_WARNING: 33, // yellow
+};
+
+const chalkFormats = {
+    ANSI: 'ansi',
+    HEX: 'hex',
+    RGB: 'rgb',
+};
+
+const chalkLayers = {
+    BACKGROUND: 'bg',
+    FOREGROUND: 'fg',
+};
+
+const hexColors = {
+    BEARDON_RED: '#951A1D',
+    BLACK: '#000000',
+    CONSOLE_WHITE: '#ECECEC',
+    DB_DELETE: '#F22613',
+    DB_INSERT: '#00B16A',
+    DB_SELECT: '#1E90FF',
+    DB_TRUNCATE: '#750505',
+    DB_UPDATE: '#F9690E',
+    HTTP_CONNECT: '#FFFFFF',
+    HTTP_DELETE: '#EF968A',
+    HTTP_GET: '#67D193',
+    HTTP_HEAD: '#68D696',
+    HTTP_OPTIONS: '#E55AA8',
+    HTTP_PATCH: '#C0A8E1',
+    HTTP_POST: '#F4DA7A',
+    HTTP_PUT: '#74AEF6',
+    HTTP_TRACE: '#FFFFFF',
+    PACKAGE_ANGULARJS: '#C04737',
+    PACKAGE_AXIOS: '#6200e1',
+    PACKAGE_EXPRESS: '#F7DF1E',
+    PACKAGE_HANDLEBARS: '#F0772B',
+    PACKAGE_JIMP: '#FF0000',
+    PACKAGE_MYSQL: '#00618A',
+    PACKAGE_NODE_JS: '#689F63',
+    PACKAGE_NODEMAILER: '#29ABE2',
+    PACKAGE_PASSPORT: '#51E492',
+    PACKAGE_PDFKIT: '#DB000D',
+    PACKAGE_POSTGRESQL: '#336791',
+    PACKAGE_REDIS: '#C23936',
+    PACKAGE_SEQUELIZE: '#00AFEF',
+    PACKAGE_ZEDDEMORE: '#E2B68F',
+};
+
+const httpStatusCodeGroups = {
+    INFORMATIONAL: 1,
+    SUCCESSFUL: 2,
+    REDIRECTION: 3,
+    CLIENT_ERROR: 4,
+    SERVER_ERROR: 5,
+};
+
+const httpMethods = {
+    GET: 'GET',
+    HEAD: 'HEAD',
+    POST: 'POST',
+    PUT: 'PUT',
+    DELETE: 'DELETE',
+    CONNECT: 'CONNECT',
+    OPTIONS: 'OPTIONS',
+    TRACE: 'TRACE',
+    PATCH: 'PATCH',
+};
+
+const httpRequestHeaders = {
+    ACCEPT_LANGUAGE: 'Accept-Language',
+    ALLOW: 'Allow',
+    APP_VERSION: 'App-Version',
+    AUTHORIZATION: 'Authorization',
+    BEARER_PREFIX: 'Bearer',
+    FORWARDED_FOR: 'X-Forwarded-For',
+    REQUEST_ID: 'X-Request-Id',
+    USER_AGENT: 'User-Agent',
+};
+
+const httpResponseHeaders = {
+    CONTENT_LENGTH: 'Content-Length',
+};
+
+const logLevelTypes = {
+    CONSOLE: 'console',
+    EMAIL: 'email',
+};
+
+const morganFormats = {
+    COMBINED: 'combined',
+    COMMON: 'common',
+    DEV: 'dev',
+    SHORT: 'short',
+    TINY: 'tiny',
+    ZEDDEMORE: 'zeddemore', // added for `zeddemore-logger`
+};
+
+const morganFormatTokens = {
+    CONTENT_LENGTH_FORMAT: 'content-length-format', // added for `zeddemore-logger`
+    DATE: 'date', // :date[format]
+    DECODED_URL: 'decoded-url', // added for `zeddemore-logger`
+    HTTP_VERSION: 'http-version',
+    METHOD: 'method',
+    REFERRER: 'referrer',
+    REMOTE_ADDR: 'remote-addr',
+    REMOTE_USER: 'remote-user',
+    REQ: 'req', // :req[header]
+    RES: 'res', // :res[header]
+    RESPONSE_TIME: 'response-time', // :response-time[digits]
+    RESPONSE_TIME_FORMAT: 'response-time-format', // added for `zeddemore-logger`
+    STATUS: 'status',
+    STATUS_COLORED: 'status-colored', // added for `zeddemore-logger`
+    TOTAL_TIME: 'total-time', // :total-time[digits]
+    URL: 'url',
+    USER_AGENT: 'user-agent',
+};
+
+const winstonFormats = {
+    COLORIZE: 'colorize',
+    JSON: 'json',
+    METADATA: 'metadata',
+    PRETTY_PRINT: 'pretty_print',
+    SIMPLE: 'simple',
+    SPLAT: 'splat',
+    TIMESTAMP: 'timestamp',
+    ZEDDEMORE_INFO_MUTATION: 'zeddemore_info_mutation',
+    ZEDDEMORE_LABEL: 'zeddemore_label',
+    ZEDDEMORE_PRINTF: 'zeddemore_printf',
+    ZEDDEMORE_TIMESTAMP: 'zeddemore_timestamp',
+};
+
+const winstonLogLevelNames = {
+    ERROR: 'error',
+    WARNING: 'warn',
+    INFO: 'info',
+    HTTP: 'http',
+    VERBOSE: 'verbose',
+    DEBUG: 'debug',
+    SILLY: 'silly',
+};
+
+// using NPM logging levels
+const winstonLogLevels = {
+    ERROR: 0,
+    WARNING: 1,
+    INFO: 2,
+    HTTP: 3,
+    VERBOSE: 4,
+    DEBUG: 5,
+    SILLY: 6,
+};
+
+const winstonTransports = {
+    CONSOLE: 'console',
+    EMAIL: 'email',
+};
+
+const zeddemoreLogLevelCaptions = {
+    DEFAULT: 'Default',
+    ERROR: 'Error',
+    WARNING: 'Warning',
+    INFO: 'Info',
+    HTTP: 'HTTP',
+    VERBOSE: 'Verbose',
+    DEBUG: 'Debug',
+    SILLY: 'Silly',
+};
+
+module.exports = {
+    doesEnumInclude,
+    ansiColors,
+    chalkFormats,
+    chalkLayers,
+    hexColors,
+    httpStatusCodeGroups,
+    httpMethods,
+    httpRequestHeaders,
+    httpResponseHeaders,
+    logLevelTypes,
+    morganFormats,
+    morganFormatTokens,
+    winstonFormats,
+    winstonLogLevelNames,
+    winstonLogLevels,
+    winstonTransports,
+    zeddemoreLogLevelCaptions,
+};

package/lib/ip_address.js

@@ -0,0 +1,10 @@
+const _ = require('lodash');
+
+function parseIpAddress(ipAddress) {
+    const ipChain = (_.isString(ipAddress) && !!ipAddress.trim().length) ? ipAddress.split(',').map((ip) => ip.trim()) : [ ];
+    return !!ipChain.length ? ipChain[ 0 ] : null;
+}
+
+module.exports = {
+    parseIpAddress,
+};

package/lib/request.js

@@ -1,67 +1,68 @@
-// Copyright (c) 2025 by Beardon Services, Inc.
-
-const _ = require('lodash');
-
-const enums = require('./enums');
-
-const { httpRequestHeaders: rqh } = enums;
-
-function extractToken(req) {
-    let token;
-    const authHeader = req.header(rqh.AUTHORIZATION);
-    if (authHeader && authHeader.startsWith(`${ rqh.BEARER_PREFIX } `)) {
-        token = req.header(rqh.AUTHORIZATION).split(' ')[ 1 ];
-    } else if (req.query && req.query.token) {
-        token = req.query.token;
-    }
-    return token;
-}
-
-function getRequestResponseTime(req, res) {
-    if (!req._startAt || !res._startAt) return null;
-    return (res._startAt[ 0 ] - req._startAt[ 0 ]) * 1e3 + (res._startAt[ 1 ] - req._startAt[ 1 ]) * 1e-6;
-}
-
-function isRequestOfMethod(req, method) {
-    const methods = Array.isArray(method) ? method : [ method ];
-    if (!req || !req.method || _.isEmpty(methods)) return false;
-    return methods.includes(req.method);
-}
-
-function parseRequest(req) {
-    if (!req) return { };
-    const body = req.body || { };
-    return {
-        acceptLanguage: parseRequestAcceptLanguage(req),
-        client: body.client || null,
-        clientVersion: body.applicationVersion || null,
-        ipAddress: parseRequestIpAddress(req),
-        sessionAge: body.uptime || 0,
-        sessionId: body.sessionId || null,
-        userAgent: parseRequestUserAgent(req),
-    };
-}
-
-function parseRequestAcceptLanguage(req) {
-    const body = req.body || { };
-    return body.language || req.header('Accept-Language');
-}
-
-function parseRequestIpAddress(req) {
-    const body = req.body || { };
-    const LOCALHOST_IPS = [ '127.0.0.1', '::1' ];
-    const ipAddress = body.ipAddress || req.get('X-Forwarded-For') || req.socket.remoteAddress;
-    return LOCALHOST_IPS.includes(ipAddress) ? 'localhost' : ipAddress;
-}
-
-function parseRequestUserAgent(req) {
-    const body = req.body || { };
-    return body.agent || body.osVersion || req.get('User-Agent');
-}
-
-module.exports = {
-    extractToken,
-    getRequestResponseTime,
-    isRequestOfMethod,
-    parseRequest,
-};
+// Copyright (c) 2025-2026 by Beardon Services, Inc.
+
+const _ = require('lodash');
+
+const enums = require('./enums');
+const { parseIpAddress } = require('./ip_address');
+
+const { httpRequestHeaders: rqh } = enums;
+
+function extractToken(req) {
+    let token;
+    const authHeader = req.header(rqh.AUTHORIZATION);
+    if (authHeader && authHeader.startsWith(`${ rqh.BEARER_PREFIX } `)) {
+        token = req.header(rqh.AUTHORIZATION).split(' ')[ 1 ];
+    } else if (req.query && req.query.token) {
+        token = req.query.token;
+    }
+    return token;
+}
+
+function getRequestResponseTime(req, res) {
+    if (!req._startAt || !res._startAt) return null;
+    return (res._startAt[ 0 ] - req._startAt[ 0 ]) * 1e3 + (res._startAt[ 1 ] - req._startAt[ 1 ]) * 1e-6;
+}
+
+function isRequestOfMethod(req, method) {
+    const methods = Array.isArray(method) ? method : [ method ];
+    if (!req || !req.method || _.isEmpty(methods)) return false;
+    return methods.includes(req.method);
+}
+
+function parseRequest(req) {
+    if (!req) return { };
+    const body = req.body || { };
+    return {
+        acceptLanguage: parseRequestAcceptLanguage(req),
+        client: body.client || null,
+        clientVersion: body.applicationVersion || null,
+        ipAddress: parseRequestIpAddress(req),
+        sessionAge: body.uptime || 0,
+        sessionId: body.sessionId || null,
+        userAgent: parseRequestUserAgent(req),
+    };
+}
+
+function parseRequestAcceptLanguage(req) {
+    const body = req.body || { };
+    return body.language || req.header(rqh.ACCEPT_LANGUAGE);
+}
+
+function parseRequestIpAddress(req) {
+    const LOCALHOST_IPS = [ '127.0.0.1', '::1' ];
+    const body = req.body || { };
+    const requestIpAddress = parseIpAddress(body.ipAddress) || parseIpAddress(req.get(rqh.FORWARDED_FOR)) || parseIpAddress(req.socket.remoteAddress);
+    return LOCALHOST_IPS.includes(requestIpAddress) ? 'localhost' : requestIpAddress;
+}
+
+function parseRequestUserAgent(req) {
+    const body = req.body || { };
+    return body.agent || body.osVersion || req.get(rqh.USER_AGENT);
+}
+
+module.exports = {
+    extractToken,
+    getRequestResponseTime,
+    isRequestOfMethod,
+    parseRequest,
+};

package/package.json

@@ -1,34 +1,34 @@
-{
-  "name": "zeddemore-logger",
-  "version": "2.2.5",
-  "description": "Node.js Express logger using Morgan and Winston for thread and caller info tracking",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/beardon/zeddemore-logger.git"
-  },
-  "keywords": [
-    "express",
-    "logger",
-    "morgan",
-    "winston"
-  ],
-  "author": "Aaron Bean <aaron.bean@beardon.com> (https://beardon.com)",
-  "license": "UNLICENSED",
-  "bugs": {
-    "url": "https://github.com/beardon/zeddemore-logger/issues"
-  },
-  "homepage": "https://github.com/beardon/zeddemore-logger#readme",
-  "main": "lib/zeddemore-logger.js",
-  "dependencies": {
-    "ansi-html": "^0.0.9",
-    "chalk": "^4.1.2",
-    "lodash": "^4.18.1",
-    "luxon": "^3.7.1",
-    "morgan": "^1.10.1",
-    "nodemailer": "^8.0.5",
-    "object-sizeof": "^2.6.5",
-    "uuid": "^10.0.0",
-    "winston": "^3.17.0",
-    "winston-transport": "^4.9.0"
-  }
-}
+{
+  "name": "zeddemore-logger",
+  "version": "2.2.7",
+  "description": "Node.js Express logger using Morgan and Winston for thread and caller info tracking",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beardon/zeddemore-logger.git"
+  },
+  "keywords": [
+    "express",
+    "logger",
+    "morgan",
+    "winston"
+  ],
+  "author": "Aaron Bean <aaron.bean@beardon.com> (https://beardon.com)",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/beardon/zeddemore-logger/issues"
+  },
+  "homepage": "https://github.com/beardon/zeddemore-logger#readme",
+  "main": "lib/zeddemore-logger.js",
+  "dependencies": {
+    "ansi-html": "^0.0.9",
+    "chalk": "^4.1.2",
+    "lodash": "^4.18.1",
+    "luxon": "^3.7.1",
+    "morgan": "^1.10.1",
+    "nodemailer": "^8.0.5",
+    "object-sizeof": "^2.6.5",
+    "uuid": "^10.0.0",
+    "winston": "^3.17.0",
+    "winston-transport": "^4.9.0"
+  }
+}