sasai-common-utils 1.0.53 → 1.0.54

package/index.d.ts

@@ -1,88 +1,88 @@
-import { AxiosInstance } from "axios";
-import { Logger } from "winston";
-import { NextFunction, Request, Response } from "express";
-import { Logger as WinstonLogger } from "winston";
-
-// Extend the Winston Logger to include custom methods
-export interface ExtendedLogger extends WinstonLogger {
-    logError: (data: Record<string, any>, req?: Record<string, any>) => void;
-    logInfo: (message: string, data?: Record<string, any>) => void;
-    logDebug: (message: string, data?: Record<string, any>) => void;
-}
-
-// Export the logger with the extended type
-export const logger: ExtendedLogger;
-/**
- * Logger configuration options.
- */
-export interface LoggerConfig {
-    level?: string;
-    SERVICE_NAME?: string;
-    DEBUG_MODE?: string;
-    LOG_LEVEL?: string;
-}
-
-/**
- * Context provider type for custom context setup.
- */
-export type ContextProvider = () => Record<string, any>;
-
-/**
- * Logs information-level messages.
- * @param message The message to log.
- * @param data Additional data to include in the log.
- */
-export function logInfo(message: string, data?: Record<string, any>): void;
-
-/**
- * Logs error-level messages.
- * @param error The error object or message to log.
- * @param data Additional data to include in the log.
- */
-export function logError(error: Error | string, data?: Record<string, any>): void;
-
-/**
- * Logs debug-level messages.
- * @param message The message to log.
- * @param data Additional data to include in the log.
- */
-export function logDebug(message: string, data?: Record<string, any>): void;
-
-/**
- * A shared logger instance configured with the provided settings.
- */
-// export const logger: Logger;
-
-/**
- * Creates a new logger instance.
- * @param config Optional configuration for the logger.
- */
-export function createLogger(config?: LoggerConfig): Logger;
-
-/**
- * Sets a context provider for adding custom context to logs.
- * @param provider A function that returns custom context as an object.
- */
-export function setContextProvider(provider: ContextProvider): void;
-
-/**
- * Middleware to log Express API requests and responses.
- */
-export function logExpressApis(logger: Logger): void;
-
-/**
- * Attaches Axios request and response interceptors for logging.
- * @param axiosInstance An Axios instance.
- * @param logger A logger instance.
- * @param apmTracing An object containing APM trace ID and span ID.
- */
-export function attachAxiosLogger(
-    axiosInstance: AxiosInstance,
-    logger: Logger,
-    apmTracing?: Record<string, any>
-): void;
-
-/**
- * Utility functions (future scope).
- */
-export const utils: Record<string, any>;
+import { AxiosInstance } from "axios";
+import { Logger } from "winston";
+import { NextFunction, Request, Response } from "express";
+import { Logger as WinstonLogger } from "winston";
+
+// Extend the Winston Logger to include custom methods
+export interface ExtendedLogger extends WinstonLogger {
+    logError: (data: Record<string, any>, req?: Record<string, any>) => void;
+    logInfo: (message: string, data?: Record<string, any>) => void;
+    logDebug: (message: string, data?: Record<string, any>) => void;
+}
+
+// Export the logger with the extended type
+export const logger: ExtendedLogger;
+/**
+ * Logger configuration options.
+ */
+export interface LoggerConfig {
+    level?: string;
+    SERVICE_NAME?: string;
+    DEBUG_MODE?: string;
+    LOG_LEVEL?: string;
+}
+
+/**
+ * Context provider type for custom context setup.
+ */
+export type ContextProvider = () => Record<string, any>;
+
+/**
+ * Logs information-level messages.
+ * @param message The message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logInfo(message: string, data?: Record<string, any>): void;
+
+/**
+ * Logs error-level messages.
+ * @param error The error object or message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logError(error: Error | string, data?: Record<string, any>): void;
+
+/**
+ * Logs debug-level messages.
+ * @param message The message to log.
+ * @param data Additional data to include in the log.
+ */
+export function logDebug(message: string, data?: Record<string, any>): void;
+
+/**
+ * A shared logger instance configured with the provided settings.
+ */
+// export const logger: Logger;
+
+/**
+ * Creates a new logger instance.
+ * @param config Optional configuration for the logger.
+ */
+export function createLogger(config?: LoggerConfig): Logger;
+
+/**
+ * Sets a context provider for adding custom context to logs.
+ * @param provider A function that returns custom context as an object.
+ */
+export function setContextProvider(provider: ContextProvider): void;
+
+/**
+ * Middleware to log Express API requests and responses.
+ */
+export function logExpressApis(logger: Logger): void;
+
+/**
+ * Attaches Axios request and response interceptors for logging.
+ * @param axiosInstance An Axios instance.
+ * @param logger A logger instance.
+ * @param apmTracing An object containing APM trace ID and span ID.
+ */
+export function attachAxiosLogger(
+    axiosInstance: AxiosInstance,
+    logger: Logger,
+    apmTracing?: Record<string, any>
+): void;
+
+/**
+ * Utility functions (future scope).
+ */
+export const utils: Record<string, any>;

package/package.json

@@ -1,30 +1,30 @@
-{
-  "name": "sasai-common-utils",
-  "version": "1.0.53",
-  "description": "Reusable utility library for common logging and other shared features.",
-  "main": "src/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@elastic/ecs-winston-format": "^1.5.3",
-    "@opentelemetry/api-logs": "^0.211.0",
-    "@opentelemetry/exporter-logs-otlp-http": "^0.211.0",
-    "@opentelemetry/resources": "^2.5.0",
-    "@opentelemetry/sdk-logs": "^0.211.0",
-    "jsonwebtoken": "^9.0.2",
-    "klona": "^2.0.6",
-    "pino": "^9.6.0",
-    "pino-opentelemetry-transport": "^1.1.0",
-    "pino-pretty": "^13.0.0",
-    "traverse": "^0.6.11",
-    "winston": "^3.17.0"
-  },
-  "devDependencies": {
-    "eslint": "^9.15.0",
-    "jest": "^29.7.0"
-  }
-}
+{
+  "name": "sasai-common-utils",
+  "version": "1.0.54",
+  "description": "Reusable utility library for common logging and other shared features.",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@elastic/ecs-winston-format": "^1.5.3",
+    "@opentelemetry/api-logs": "^0.211.0",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.211.0",
+    "@opentelemetry/instrumentation-pino": "^0.55.0",
+    "@opentelemetry/resources": "^2.5.0",
+    "@opentelemetry/sdk-logs": "^0.211.0",
+    "jsonwebtoken": "^9.0.2",
+    "klona": "^2.0.6",
+    "pino": "^9.6.0",
+    "pino-pretty": "^13.0.0",
+    "traverse": "^0.6.11",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "eslint": "^9.15.0",
+    "jest": "^29.7.0"
+  }
+}

package/src/features/axios-logger/axiosLogger.js

@@ -1,108 +1,108 @@
-const { LOG_LEVELS } = require("../logger/constants");
-
-/**
- * Logs Axios requests.
- * @param {Object} request - Axios request object.
- * @param {Object} logger - Logger instance.
- */
-const logRequest = (request, logger) => {
-  const { method, url, headers, data, params } = request;
-  const api = "REQUEST";
-
-  const logObject = {
-    method,
-    url,
-    headers,
-    requestBody: data,
-    parameters: params,
-    api,
-  };
-
-  logger.logInfo("Axios Request", logObject);
-  return request;
-};
-
-/**
- * Logs Axios responses.
- * @param {Object} response - Axios response object.
- * @param {Object} logger - Logger instance.
- */
-const logResponse = (response, logger) => {
-  const { status, config, data, headers: responseHeaders } = response;
-  const { method, url, headers, data: requestBody, params } = config || {};
-  const api = "RESPONSE";
-
-  const logObject = {
-    statusCode: status,
-    method,
-    url,
-    headers, // request headers
-    responseHeaders, // actual response headers
-    requestBody,
-    responseBody: data,
-    parameters: params,
-    api,
-  };
-
-  logger.logInfo("Axios Response", logObject);
-  return response;
-};
-
-/**
- * Logs Axios errors.
- * @param {Object} error - Axios error object.
- * @param {Object} logger - Logger instance.
- */
-const logError = (error, logger) => {
-  const { response, config } = error || {};
-  const { method, url, headers, data: requestBody, params } = config || {};
-
-  const logObject = {
-    step: "Axios Error",
-    error,
-    method,
-    url,
-    headers,
-    requestBody,
-    parameters: params,
-    responseBody: response?.data || {},
-    statusCode: response?.status || "",
-    responseHeaders: response?.headers || {},
-    api: "ERROR",
-  };
-
-  logger.logError(logObject);
-  return Promise.reject(error);
-};
-
-/**
- * Attaches logging interceptors to an Axios instance.
- * @param {Object} axiosInstance - Axios instance.
- * @param {Object} logger - Logger instance.
- * @param {Object} traceContext - Trace context provider.
- */
-const attachAxiosLogger = (axiosInstance, logger, traceContext) => {
-  axiosInstance.interceptors.request.use(
-    (request) => {
-      const currentTraceContext =
-        traceContext?.getCurrentTraceContext?.() || {};
-
-      request.headers = {
-        ...request.headers,
-        "x-b3-traceid": currentTraceContext?.trace_id ?? "",
-        "x-b3-spanid": currentTraceContext?.span_id ?? "",
-        "x-b3-parentspanid": currentTraceContext?.parent_span_id ?? "",
-      };
-
-      return logRequest(request, logger);
-    },
-    (error) => logError(error, logger),
-  );
-
-  axiosInstance.interceptors.response.use(
-    (response) => logResponse(response, logger),
-    (error) => logError(error, logger),
-  );
-};
-
-module.exports = { attachAxiosLogger };
+const { LOG_LEVELS } = require("../logger/constants");
+
+/**
+ * Logs Axios requests.
+ * @param {Object} request - Axios request object.
+ * @param {Object} logger - Logger instance.
+ */
+const logRequest = (request, logger) => {
+  const { method, url, headers, data, params } = request;
+  const api = "REQUEST";
+
+  const logObject = {
+    method,
+    url,
+    headers,
+    requestBody: data,
+    parameters: params,
+    api,
+  };
+
+  logger.logInfo("Axios Request", logObject);
+  return request;
+};
+
+/**
+ * Logs Axios responses.
+ * @param {Object} response - Axios response object.
+ * @param {Object} logger - Logger instance.
+ */
+const logResponse = (response, logger) => {
+  const { status, config, data, headers: responseHeaders } = response;
+  const { method, url, headers, data: requestBody, params } = config || {};
+  const api = "RESPONSE";
+
+  const logObject = {
+    statusCode: status,
+    method,
+    url,
+    headers, // request headers
+    responseHeaders, // actual response headers
+    requestBody,
+    responseBody: data,
+    parameters: params,
+    api,
+  };
+
+  logger.logInfo("Axios Response", logObject);
+  return response;
+};
+
+/**
+ * Logs Axios errors.
+ * @param {Object} error - Axios error object.
+ * @param {Object} logger - Logger instance.
+ */
+const logError = (error, logger) => {
+  const { response, config } = error || {};
+  const { method, url, headers, data: requestBody, params } = config || {};
+
+  const logObject = {
+    step: "Axios Error",
+    error,
+    method,
+    url,
+    headers,
+    requestBody,
+    parameters: params,
+    responseBody: response?.data || {},
+    statusCode: response?.status || "",
+    responseHeaders: response?.headers || {},
+    api: "ERROR",
+  };
+
+  logger.logError(logObject);
+  return Promise.reject(error);
+};
+
+/**
+ * Attaches logging interceptors to an Axios instance.
+ * @param {Object} axiosInstance - Axios instance.
+ * @param {Object} logger - Logger instance.
+ * @param {Object} traceContext - Trace context provider.
+ */
+const attachAxiosLogger = (axiosInstance, logger, traceContext) => {
+  axiosInstance.interceptors.request.use(
+    (request) => {
+      const currentTraceContext =
+        traceContext?.getCurrentTraceContext?.() || {};
+
+      request.headers = {
+        ...request.headers,
+        "x-b3-traceid": currentTraceContext?.trace_id ?? "",
+        "x-b3-spanid": currentTraceContext?.span_id ?? "",
+        "x-b3-parentspanid": currentTraceContext?.parent_span_id ?? "",
+      };
+
+      return logRequest(request, logger);
+    },
+    (error) => logError(error, logger),
+  );
+
+  axiosInstance.interceptors.response.use(
+    (response) => logResponse(response, logger),
+    (error) => logError(error, logger),
+  );
+};
+
+module.exports = { attachAxiosLogger };

package/src/features/axios-logger/index.js

@@ -1,5 +1,5 @@
-const { attachAxiosLogger } = require("./axiosLogger");
-
-module.exports = {
-    attachAxiosLogger,
-};
+const { attachAxiosLogger } = require("./axiosLogger");
+
+module.exports = {
+    attachAxiosLogger,
+};

package/src/features/express-logger/expressLogger.js

@@ -1,46 +1,46 @@
-const { LOG_LEVELS } = require("../logger/constants");
-
-/**
- * Logs incoming HTTP requests.
- * @param {Object} request - Express request object.
- * @param {Object} logger - Logger instance.
- */
-const logRequest = (request, logger) => {
-    const { method, url, headers, body, query, params } = request;
-    const api = "REQUEST"
-    const logObject = { method, url, headers, requestBody: body, query, parameters: query, api };
-    logger.logInfo( "Incoming Request", logObject);
-};
-
-/**
- * Logs outgoing HTTP responses.
- * @param {Object} response - Express response object.
- * @param {Object} logger - Logger instance.
- */
-const logResponse = (response, logger) => {
-    const originalJson = response.json;
-    const api = "RESPONSE"
-    // Override res.json to intercept response data
-    response.json = function (data) {
-        const { statusCode } = response;
-        const { method, url, headers, body } = response.req;
-        const logObject = { statusCode, method, url, responseHeaders: headers, headers, requestBody: body, responseBody: data, api };
-        logger.logInfo("Outgoing Response", logObject);
-
-        // Call the original res.json
-        return originalJson.call(this, data);
-    };
-};
-
-/**
- * Express middleware for logging requests and responses.
- * @param {Object} logger - Logger instance.
- * @returns {Function} Middleware function.
- */
-const logExpressApis = (logger) => (request, response, next) => {
-    logRequest(request, logger);
-    logResponse(response, logger);
-    next();
-};
-
-module.exports = { logExpressApis };
+const { LOG_LEVELS } = require("../logger/constants");
+
+/**
+ * Logs incoming HTTP requests.
+ * @param {Object} request - Express request object.
+ * @param {Object} logger - Logger instance.
+ */
+const logRequest = (request, logger) => {
+    const { method, url, headers, body, query, params } = request;
+    const api = "REQUEST"
+    const logObject = { method, url, headers, requestBody: body, query, parameters: query, api };
+    logger.logInfo( "Incoming Request", logObject);
+};
+
+/**
+ * Logs outgoing HTTP responses.
+ * @param {Object} response - Express response object.
+ * @param {Object} logger - Logger instance.
+ */
+const logResponse = (response, logger) => {
+    const originalJson = response.json;
+    const api = "RESPONSE"
+    // Override res.json to intercept response data
+    response.json = function (data) {
+        const { statusCode } = response;
+        const { method, url, headers, body } = response.req;
+        const logObject = { statusCode, method, url, responseHeaders: headers, headers, requestBody: body, responseBody: data, api };
+        logger.logInfo("Outgoing Response", logObject);
+
+        // Call the original res.json
+        return originalJson.call(this, data);
+    };
+};
+
+/**
+ * Express middleware for logging requests and responses.
+ * @param {Object} logger - Logger instance.
+ * @returns {Function} Middleware function.
+ */
+const logExpressApis = (logger) => (request, response, next) => {
+    logRequest(request, logger);
+    logResponse(response, logger);
+    next();
+};
+
+module.exports = { logExpressApis };

package/src/features/express-logger/index.js

@@ -1,5 +1,5 @@
-const { logExpressApis } = require("./expressLogger");
-
-module.exports = {
-    logExpressApis,
-};
+const { logExpressApis } = require("./expressLogger");
+
+module.exports = {
+    logExpressApis,
+};

package/src/features/logger/config.js

@@ -1,6 +1,6 @@
-const defaultConfig = {
-    logLevel: "info",
-    transports: [],
-};
-
-module.exports = { defaultConfig };
+const defaultConfig = {
+    logLevel: "info",
+    transports: [],
+};
+
+module.exports = { defaultConfig };

package/src/features/logger/constants.js

@@ -1,36 +1,36 @@
-const LOG_LEVELS = {
-	ERROR: "error",
-	WARN: "warn",
-	INFO: "info",
-	DEBUG: "debug",
-};
-
-const DEBUG_MODES = {
-	FILE: "file",
-	CONSOLE: "console",
-	BOTH: "both",
-	DISABLE: "disable",
-};
-
-const API_LOG_MODE = {
-	TRUE_VALUE: "true",
-};
-
-const API_CALL_TYPE = {
-	REQUEST:"REQUEST",
-	RESPONSE:"RESPONSE"
-}
-
-const HTTP_STATUS_CODES = {
-	SUCCESS: 200,
-	BAD_REQUEST: 400,
-	NOT_FOUND: 404,
-	INTERNAL_SERVER_ERROR: 500,
-	UNAUTHORIZED: 401,
-	FORBIDDEN: 403,
-	BAD_GATEWAY: 502,
-	SERVICE_UNAVAILABLE: 503,
-	GATEWAY_TIMEOUT_ERROR: 504,
-};
-
-module.exports = { LOG_LEVELS, DEBUG_MODES, API_CALL_TYPE, API_LOG_MODE, HTTP_STATUS_CODES };
+const LOG_LEVELS = {
+	ERROR: "error",
+	WARN: "warn",
+	INFO: "info",
+	DEBUG: "debug",
+};
+
+const DEBUG_MODES = {
+	FILE: "file",
+	CONSOLE: "console",
+	BOTH: "both",
+	DISABLE: "disable",
+};
+
+const API_LOG_MODE = {
+	TRUE_VALUE: "true",
+};
+
+const API_CALL_TYPE = {
+	REQUEST:"REQUEST",
+	RESPONSE:"RESPONSE"
+}
+
+const HTTP_STATUS_CODES = {
+	SUCCESS: 200,
+	BAD_REQUEST: 400,
+	NOT_FOUND: 404,
+	INTERNAL_SERVER_ERROR: 500,
+	UNAUTHORIZED: 401,
+	FORBIDDEN: 403,
+	BAD_GATEWAY: 502,
+	SERVICE_UNAVAILABLE: 503,
+	GATEWAY_TIMEOUT_ERROR: 504,
+};
+
+module.exports = { LOG_LEVELS, DEBUG_MODES, API_CALL_TYPE, API_LOG_MODE, HTTP_STATUS_CODES };