unnbound-logger-sdk 2.0.10 → 3.0.1

package/dist/unnbound-logger.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnnboundLogger = void 0;
+exports.UnnboundLogger = exports.logger = void 0;
 /**
  * Core logger implementation
  */
@@ -13,6 +13,33 @@ const uuid_1 = require("uuid");
 const trace_context_1 = require("./utils/trace-context");
 const axios_1 = require("axios");
 const http_status_messages_1 = require("./utils/http-status-messages");
+const storage_1 = require("./storage");
+exports.logger = (0, pino_1.default)({
+    level: process.env.LOG_LEVEL ?? 'info',
+    base: {
+        environment: process.env.ENVIRONMENT,
+        workflowId: process.env.UNNBOUND_WORKFLOW_ID,
+        workflowUrl: process.env.UNNBOUND_WORKFLOW_URL,
+        serviceId: process.env.UNNBOUND_SERVICE_ID,
+        deploymentId: process.env.UNNBOUND_DEPLOYMENT_ID,
+    },
+    mixin: () => {
+        console.log('storage', storage_1.storage.getStore());
+        return storage_1.storage.getStore() ?? {};
+    },
+    serializers: {
+        req: pino_1.default.stdSerializers.req,
+        res: pino_1.default.stdSerializers.res,
+        err: pino_1.default.stdSerializers.err,
+    },
+    // Let CloudWatch handle timestamps
+    timestamp: false,
+    // Change message field from 'msg' to 'messages'
+    messageKey: 'messages',
+    formatters: {
+        level: (level) => ({ level }),
+    },
+});
 /**
  * UnnboundLogger provides typed, structured logging using Pino
  */
@@ -73,18 +100,18 @@ class UnnboundLogger {
                     ip: 'outgoing', // Mark as outgoing request
                     protocol: 'https', // Default for outgoing
                     secure: true,
-                    get: () => undefined // Mock get method for constructFullUrl
+                    get: () => undefined, // Mock get method for constructFullUrl
                 };
                 this.httpRequest(mockReq, {
                     traceId,
                     requestId,
-                    startTime
+                    startTime,
                 });
                 return config;
             },
             onRejected: (error) => {
                 return Promise.reject(error);
-            }
+            },
         };
         // Axios response interceptor (should be used separately)
         this.axiosResponseInterceptor = {
@@ -106,7 +133,7 @@ class UnnboundLogger {
                     ip: 'outgoing', // Mark as outgoing request
                     protocol: 'https', // Default for outgoing
                     secure: true,
-                    get: () => undefined // Mock get method for constructFullUrl
+                    get: () => undefined, // Mock get method for constructFullUrl
                 };
                 const mockRes = {
                     statusCode: response.status,
@@ -114,14 +141,14 @@ class UnnboundLogger {
                         body: (0, logger_utils_1.safeJsonParse)(response.data),
                         startTime: startTime,
                         traceId: trace_context_1.traceContext.getTraceId(),
-                        requestId: requestId
+                        requestId: requestId,
                     },
-                    getHeaders: () => response.headers || {}
+                    getHeaders: () => response.headers || {},
                 };
                 this.httpResponse(mockRes, mockReq, {
                     requestId,
                     duration,
-                    traceId: trace_context_1.traceContext.getTraceId()
+                    traceId: trace_context_1.traceContext.getTraceId(),
                 });
                 return response;
             },
@@ -144,7 +171,7 @@ class UnnboundLogger {
                         ip: 'outgoing', // Mark as outgoing request
                         protocol: 'https', // Default for outgoing
                         secure: true,
-                        get: () => undefined // Mock get method for constructFullUrl
+                        get: () => undefined, // Mock get method for constructFullUrl
                     };
                     const mockRes = {
                         statusCode: error.response.status,
@@ -152,14 +179,14 @@ class UnnboundLogger {
                             body: (0, logger_utils_1.safeJsonParse)(error.response.data),
                             startTime: startTime,
                             traceId: trace_context_1.traceContext.getTraceId(),
-                            requestId: requestId
+                            requestId: requestId,
                         },
-                        getHeaders: () => error.response.headers || {}
+                        getHeaders: () => error.response.headers || {},
                     };
                     this.httpResponse(mockRes, mockReq, {
                         requestId,
                         duration,
-                        traceId: trace_context_1.traceContext.getTraceId()
+                        traceId: trace_context_1.traceContext.getTraceId(),
                     });
                 }
                 else {
@@ -172,11 +199,11 @@ class UnnboundLogger {
                         },
                         error: error.message,
                         requestId,
-                        traceId: trace_context_1.traceContext.getTraceId()
+                        traceId: trace_context_1.traceContext.getTraceId(),
                     });
                 }
                 return Promise.reject(error);
-            }
+            },
         };
         this.workflowId = process.env.UNNBOUND_WORKFLOW_ID || '';
         this.workflowUrl = process.env.UNNBOUND_WORKFLOW_URL || '';
@@ -188,13 +215,18 @@ class UnnboundLogger {
         // Create Pino logger
         this.logger = (0, pino_1.default)({
             level: 'info',
-            base: {}, // Disable all default base fields (pid, hostname)
-            timestamp: false, // Let CloudWatch handle timestamps
-            messageKey: 'messages', // Change message field from 'msg' to 'messages'
+            base: {
+                // Disable all default base fields (pid, hostname) and add our own
+                workflowId: this.workflowId,
+                serviceId: this.serviceId,
+                deploymentId: this.deploymentId,
+            },
+            // Let CloudWatch handle timestamps
+            timestamp: false,
+            // Change message field from 'msg' to 'messages'
+            messageKey: 'messages',
             formatters: {
-                level: (label) => {
-                    return { level: label };
-                },
+                level: (level) => ({ level }),
             },
         });
     }
@@ -205,7 +237,7 @@ class UnnboundLogger {
      * @returns boolean indicating if the path should be ignored
      */
     shouldIgnorePath(path, patterns) {
-        return patterns.some(pattern => {
+        return patterns.some((pattern) => {
             // Convert glob pattern to regex
             const regexPattern = pattern
                 .replace(/\./g, '\\.') // Escape dots
@@ -239,15 +271,10 @@ class UnnboundLogger {
             deploymentId: this.deploymentId,
         };
         if (message instanceof Error) {
-            const error = {
-                name: message.name,
-                message: message.message,
-                stack: message.stack,
-            };
             logEntry = {
                 ...baseEntry,
                 message: message.name,
-                error,
+                error: message,
                 ...(hasRestOptions && { data: restOptions }),
             };
         }
@@ -380,7 +407,7 @@ class UnnboundLogger {
         const workflowId = res.locals.workflowId || this.workflowId;
         const serviceId = res.locals.serviceId || this.serviceId;
         const traceId = res.locals.traceId || options.traceId || trace_context_1.traceContext.getTraceId() || (0, uuid_1.v4)();
-        const duration = options.duration || (Date.now() - startTime);
+        const duration = options.duration || Date.now() - startTime;
         // Determine log level based on status code
         let level = options.level || 'info';
         if (!options.level) {
@@ -414,33 +441,6 @@ class UnnboundLogger {
         this.logger[level](logData, logMessage);
         return logEntry;
     }
-    /**
-     * Logs an SFTP transaction
-     * @param operation - SFTP operation details
-     * @param options - Additional logging options
-     */
-    sftpTransaction(operation, options = {}) {
-        const logId = (0, uuid_1.v4)();
-        const traceId = options.traceId || trace_context_1.traceContext.getTraceId() || (0, uuid_1.v4)();
-        const requestId = options.requestId || (0, uuid_1.v4)();
-        const duration = options.duration || (options.startTime ? Date.now() - options.startTime : 0);
-        const level = operation.status === 'success' ? 'info' : 'error';
-        const logEntry = {
-            logId,
-            type: 'sftpTransaction',
-            message: `SFTP ${operation.operation} ${operation.status} - ${operation.path}`,
-            workflowId: this.workflowId,
-            serviceId: this.serviceId,
-            traceId,
-            requestId,
-            deploymentId: this.deploymentId,
-            duration,
-            sftp: operation,
-        };
-        const { message: logMessage, ...logData } = logEntry;
-        this.logger[level](logData, logMessage);
-        return logEntry;
-    }
     /**
      * Logs a database query transaction
      * @param query - Database query details
@@ -470,3 +470,6 @@ class UnnboundLogger {
     }
 }
 exports.UnnboundLogger = UnnboundLogger;
+process.on('uncaughtException', (err, origin) => {
+    exports.logger.error({ err, origin }, `Uncaught exception.`);
+});

package/dist/utils/http-status-messages.js

@@ -3,48 +3,153 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.httpStatusDetails = void 0;
 exports.getStatusMessage = getStatusMessage;
 exports.httpStatusDetails = {
-    100: { message: 'Continue', description: 'The server has received the request headers, and the client should proceed to send the request body' },
-    101: { message: 'Switching Protocols', description: 'The requester has asked the server to switch protocols' },
-    103: { message: 'Early Hints', description: 'Used with the Link header to allow the browser to start preloading resources while the server prepares a response' },
+    100: {
+        message: 'Continue',
+        description: 'The server has received the request headers, and the client should proceed to send the request body',
+    },
+    101: {
+        message: 'Switching Protocols',
+        description: 'The requester has asked the server to switch protocols',
+    },
+    103: {
+        message: 'Early Hints',
+        description: 'Used with the Link header to allow the browser to start preloading resources while the server prepares a response',
+    },
     200: { message: 'OK', description: 'The request is OK' },
-    201: { message: 'Created', description: 'The request has been fulfilled, and a new resource is created' },
-    202: { message: 'Accepted', description: 'The request has been accepted for processing, but the processing has not been completed' },
-    203: { message: 'Non-Authoritative Information', description: 'The request has been successfully processed, but is returning information that may be from another source' },
-    204: { message: 'No Content', description: 'The request has been successfully processed, but is not returning any content' },
-    205: { message: 'Reset Content', description: 'The request has been successfully processed, but is not returning any content, and requires that the requester reset the document view' },
-    206: { message: 'Partial Content', description: 'The server is delivering only part of the resource due to a range header sent by the client' },
-    300: { message: 'Multiple Choices', description: 'A link list. The user can select a link and go to that location. Maximum five addresses' },
+    201: {
+        message: 'Created',
+        description: 'The request has been fulfilled, and a new resource is created',
+    },
+    202: {
+        message: 'Accepted',
+        description: 'The request has been accepted for processing, but the processing has not been completed',
+    },
+    203: {
+        message: 'Non-Authoritative Information',
+        description: 'The request has been successfully processed, but is returning information that may be from another source',
+    },
+    204: {
+        message: 'No Content',
+        description: 'The request has been successfully processed, but is not returning any content',
+    },
+    205: {
+        message: 'Reset Content',
+        description: 'The request has been successfully processed, but is not returning any content, and requires that the requester reset the document view',
+    },
+    206: {
+        message: 'Partial Content',
+        description: 'The server is delivering only part of the resource due to a range header sent by the client',
+    },
+    300: {
+        message: 'Multiple Choices',
+        description: 'A link list. The user can select a link and go to that location. Maximum five addresses',
+    },
     301: { message: 'Moved Permanently', description: 'The requested page has moved to a new URL' },
     302: { message: 'Found', description: 'The requested page has moved temporarily to a new URL' },
-    303: { message: 'See Other', description: 'The requested page can be found under a different URL' },
-    304: { message: 'Not Modified', description: 'Indicates the requested page has not been modified since last requested' },
-    307: { message: 'Temporary Redirect', description: 'The requested page has moved temporarily to a new URL' },
-    308: { message: 'Permanent Redirect', description: 'The requested page has moved permanently to a new URL' },
+    303: {
+        message: 'See Other',
+        description: 'The requested page can be found under a different URL',
+    },
+    304: {
+        message: 'Not Modified',
+        description: 'Indicates the requested page has not been modified since last requested',
+    },
+    307: {
+        message: 'Temporary Redirect',
+        description: 'The requested page has moved temporarily to a new URL',
+    },
+    308: {
+        message: 'Permanent Redirect',
+        description: 'The requested page has moved permanently to a new URL',
+    },
     400: { message: 'Bad Request', description: 'The request cannot be fulfilled due to bad syntax' },
-    401: { message: 'Unauthorized', description: 'The request was a legal request, but the server is refusing to respond to it. For use when authentication is possible but has failed or not yet been provided' },
+    401: {
+        message: 'Unauthorized',
+        description: 'The request was a legal request, but the server is refusing to respond to it. For use when authentication is possible but has failed or not yet been provided',
+    },
     402: { message: 'Payment Required', description: 'Reserved for future use' },
-    403: { message: 'Forbidden', description: 'The request was a legal request, but the server is refusing to respond to it' },
-    404: { message: 'Not Found', description: 'The requested page could not be found but may be available again in the future' },
-    405: { message: 'Method Not Allowed', description: 'A request was made of a page using a request method not supported by that page' },
-    406: { message: 'Not Acceptable', description: 'The server can only generate a response that is not accepted by the client' },
-    407: { message: 'Proxy Authentication Required', description: 'The client must first authenticate itself with the proxy' },
+    403: {
+        message: 'Forbidden',
+        description: 'The request was a legal request, but the server is refusing to respond to it',
+    },
+    404: {
+        message: 'Not Found',
+        description: 'The requested page could not be found but may be available again in the future',
+    },
+    405: {
+        message: 'Method Not Allowed',
+        description: 'A request was made of a page using a request method not supported by that page',
+    },
+    406: {
+        message: 'Not Acceptable',
+        description: 'The server can only generate a response that is not accepted by the client',
+    },
+    407: {
+        message: 'Proxy Authentication Required',
+        description: 'The client must first authenticate itself with the proxy',
+    },
     408: { message: 'Request Timeout', description: 'The server timed out waiting for the request' },
-    409: { message: 'Conflict', description: 'The request could not be completed because of a conflict in the request' },
+    409: {
+        message: 'Conflict',
+        description: 'The request could not be completed because of a conflict in the request',
+    },
     410: { message: 'Gone', description: 'The requested page is no longer available' },
-    411: { message: 'Length Required', description: 'The "Content-Length" is not defined. The server will not accept the request without it' },
-    412: { message: 'Precondition Failed', description: 'The precondition given in the request evaluated to false by the server' },
-    413: { message: 'Request Too Large', description: 'The server will not accept the request, because the request entity is too large' },
-    414: { message: 'Request-URI Too Long', description: 'The server will not accept the request, because the URI is too long. Occurs when you convert a POST request to a GET request with a long query information' },
-    415: { message: 'Unsupported Media Type', description: 'The server will not accept the request, because the media type is not supported' },
-    416: { message: 'Range Not Satisfiable', description: 'The client has asked for a portion of the file, but the server cannot supply that portion' },
-    417: { message: 'Expectation Failed', description: 'The server cannot meet the requirements of the Expect request-header field' },
-    500: { message: 'Internal Server Error', description: 'A generic error message, given when no more specific message is suitable' },
-    501: { message: 'Not Implemented', description: 'The server either does not recognize the request method, or it lacks the ability to fulfill the request' },
-    502: { message: 'Bad Gateway', description: 'The server was acting as a gateway or proxy and received an invalid response from the upstream server' },
-    503: { message: 'Service Unavailable', description: 'The server is currently unavailable (overloaded or down)' },
-    504: { message: 'Gateway Timeout', description: 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server' },
-    505: { message: 'HTTP Version Not Supported', description: 'The server does not support the HTTP protocol version used in the request' },
-    511: { message: 'Network Authentication Required', description: 'The client needs to authenticate to gain network access' },
+    411: {
+        message: 'Length Required',
+        description: 'The "Content-Length" is not defined. The server will not accept the request without it',
+    },
+    412: {
+        message: 'Precondition Failed',
+        description: 'The precondition given in the request evaluated to false by the server',
+    },
+    413: {
+        message: 'Request Too Large',
+        description: 'The server will not accept the request, because the request entity is too large',
+    },
+    414: {
+        message: 'Request-URI Too Long',
+        description: 'The server will not accept the request, because the URI is too long. Occurs when you convert a POST request to a GET request with a long query information',
+    },
+    415: {
+        message: 'Unsupported Media Type',
+        description: 'The server will not accept the request, because the media type is not supported',
+    },
+    416: {
+        message: 'Range Not Satisfiable',
+        description: 'The client has asked for a portion of the file, but the server cannot supply that portion',
+    },
+    417: {
+        message: 'Expectation Failed',
+        description: 'The server cannot meet the requirements of the Expect request-header field',
+    },
+    500: {
+        message: 'Internal Server Error',
+        description: 'A generic error message, given when no more specific message is suitable',
+    },
+    501: {
+        message: 'Not Implemented',
+        description: 'The server either does not recognize the request method, or it lacks the ability to fulfill the request',
+    },
+    502: {
+        message: 'Bad Gateway',
+        description: 'The server was acting as a gateway or proxy and received an invalid response from the upstream server',
+    },
+    503: {
+        message: 'Service Unavailable',
+        description: 'The server is currently unavailable (overloaded or down)',
+    },
+    504: {
+        message: 'Gateway Timeout',
+        description: 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server',
+    },
+    505: {
+        message: 'HTTP Version Not Supported',
+        description: 'The server does not support the HTTP protocol version used in the request',
+    },
+    511: {
+        message: 'Network Authentication Required',
+        description: 'The client needs to authenticate to gain network access',
+    },
 };
 function getStatusMessage(statusCode) {
     const status = exports.httpStatusDetails[statusCode];

package/dist/utils/logger-utils.d.ts

@@ -19,7 +19,7 @@ export declare function clearTraceId(workflowId: string): void;
  * @param headers The original headers object.
  * @returns A new object containing only the headers from the allow-list.
  */
-export declare function filterHeaders(headers: Record<string, any>): Record<string, string>;
+export declare function filterHeaders(headers?: Record<string, any>): Record<string, string>;
 /**
  * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
  * @param data The data to potentially parse as JSON.

package/dist/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Checks if a path matches any of the ignore patterns
+ * @param path - The path to check
+ * @param patterns - Array of glob patterns to match against
+ * @returns boolean indicating if the path should be ignored
+ */
+export declare const shouldIgnorePath: (path: string, patterns: string[]) => boolean;
+/**
+ * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
+ * @param data The data to potentially parse as JSON.
+ * @returns Parsed JSON object or the original data.
+ */
+export declare function safeJsonParse(data: any): any;
+/**
+ * Normalizes IP addresses by removing IPv6 mapping prefix for IPv4 addresses.
+ * @param ip The IP address to normalize.
+ * @returns Normalized IP address string.
+ */
+export declare function normalizeIp(ip: string | undefined): string | undefined;

package/dist/utils.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldIgnorePath = void 0;
+exports.safeJsonParse = safeJsonParse;
+exports.normalizeIp = normalizeIp;
+/**
+ * Checks if a path matches any of the ignore patterns
+ * @param path - The path to check
+ * @param patterns - Array of glob patterns to match against
+ * @returns boolean indicating if the path should be ignored
+ */
+const shouldIgnorePath = (path, patterns) => {
+    return patterns.some((pattern) => {
+        // Convert glob pattern to regex
+        const regexPattern = pattern
+            .replace(/\./g, '\\.') // Escape dots
+            .replace(/\*/g, '.*') // Convert * to .*
+            .replace(/\?/g, '.'); // Convert ? to .
+        const regex = new RegExp(`^${regexPattern}$`);
+        return regex.test(path);
+    });
+};
+exports.shouldIgnorePath = shouldIgnorePath;
+/**
+ * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
+ * @param data The data to potentially parse as JSON.
+ * @returns Parsed JSON object or the original data.
+ */
+function safeJsonParse(data) {
+    if (typeof data === 'string') {
+        try {
+            return JSON.parse(data);
+        }
+        catch {
+            return data;
+        }
+    }
+    return data;
+}
+/**
+ * Normalizes IP addresses by removing IPv6 mapping prefix for IPv4 addresses.
+ * @param ip The IP address to normalize.
+ * @returns Normalized IP address string.
+ */
+function normalizeIp(ip) {
+    if (!ip)
+        return ip;
+    // Remove IPv4-mapped IPv6 prefix (::ffff:) to get clean IPv4 address
+    if (ip.startsWith('::ffff:')) {
+        return ip.substring(7);
+    }
+    return ip;
+}

package/package.json

@@ -1,23 +1,9 @@
 {
   "name": "unnbound-logger-sdk",
-  "version": "2.0.10",
   "description": "A structured logging library with TypeScript support using Pino. Provides consistent, well-typed logging with automatic logId, workflowId, traceId, and deploymentId tracking across operational contexts.",
+  "version": "3.0.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "test": "npx jest",
-    "test:coverage": "npx jest --coverage",
-    "test:watch": "npx jest --watch",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint . --ext .ts --fix",
-    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
-    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
-    "prepublishOnly": "npm run build && npm test",
-    "check-coverage": "ts-node scripts/check-coverage.ts",
-    "start:example:node-app": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' examples/node-app.ts",
-    "start:example:basic-usage": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' examples/basic-usage.ts"
-  },
   "keywords": [
     "logging",
     "typescript",
@@ -33,11 +19,11 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/unnbound/logger.git"
+    "url": "https://github.com/unnbounddev/unnbound-sdks.git"
   },
-  "homepage": "https://github.com/unnbound/logger#readme",
+  "homepage": "https://github.com/unnbounddev/unnbound-sdks#readme",
   "bugs": {
-    "url": "https://github.com/unnbound/logger/issues"
+    "url": "https://github.com/unnbounddev/unnbound-sdks/issues"
   },
   "dependencies": {
     "axios": "^1.0.0",
@@ -49,19 +35,7 @@
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.24",
-    "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
-    "cors": "^2.8.5",
-    "dotenv": "^16.5.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^10.1.5",
-    "jest": "^29.7.0",
-    "nodemon": "^3.1.10",
-    "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "@types/uuid": "^9.0.8"
   },
   "peerDependencies": {
     "axios": "^1.0.0",
@@ -76,15 +50,25 @@
     }
   },
   "files": [
-    "dist/src/**/*",
-    "dist/index.*",
-    "dist/types.*",
-    "dist/unnbound-logger.*",
-    "dist/utils/**/*",
+    "dist/**/*",
     "README.md",
     "LICENSE"
   ],
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=22.0.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch",
+    "typecheck": "tsc -noEmit",
+    "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
+    "lint:fix": "pnpm lint --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "start:example:node-app": "npx tsx --watch examples/node-app.ts",
+    "start:example:basic-usage": "npx tsx --watch examples/basic-usage.ts"
   }
-}
+}