@xeno-js/shared 0.1.4 → 0.1.6

package/README.md

@@ -200,17 +200,11 @@ flows from feature branches ➡️ `develop` ➡️ `main`._
 | Command             | Description                                        |
 | ------------------- | -------------------------------------------------- |
 | `npm run build`     | Builds the TypeScript source code into `dist/`<br> |
-| `npm run typecheck` | Checks types without emitting files                |
-
-| | `npm run lint` | Runs ESLint
-
-| | `npm run format` | Formats code with Prettier
-
-| | `npm run test` | Runs the Vitest test suite
-
-| | `npm run test:coverage` | Runs tests and generates a coverage report
-
-|
+| `npm run typecheck` | Checks types without emitting files |
+| `npm run lint` | Runs ESLint | 
+| `npm run format` | Formats code with Prettier |
+| `npm run test` | Runs the Vitest test suite | 
+| `npm run test:coverage` | Runs tests and generates a coverage report |
 
 ### Code Quality (Husky & Git Hooks)
 

package/dist/index.cjs

@@ -51,6 +51,7 @@ __export(index_exports, {
   InMemoryCache: () => InMemoryCache,
   LOG_LEVEL: () => LOG_LEVEL,
   LOG_LEVEL_NAMES: () => LOG_LEVEL_NAMES,
+  LoggerUtils: () => LoggerUtils,
   MathHelper: () => MathHelper,
   PAGINATION_DEFAULTS: () => PAGINATION_DEFAULTS,
   PERMISSIONS: () => PERMISSIONS,
@@ -1626,6 +1627,29 @@ var GuidHelper = Object.freeze({
 
 // src/shared/utils/http.utils.ts
 var HttpHelper = Object.freeze({
+  /**
+    * @description A function that masks the IP address in the given headers object.
+    * @param ip The IP address to mask.
+    * @returns The masked IP address.
+    */
+  maskIp(ip) {
+    if (!Guards.isDefined(ip)) return void 0;
+    if (ip.includes(".")) {
+      const parts = ip.split(".");
+      if (parts.length === 4) {
+        parts[3] = "x";
+        return parts.join(".");
+      }
+    }
+    if (ip.includes(":")) {
+      const parts = ip.split(":");
+      if (parts.length > 0) {
+        parts[parts.length - 1] = "x";
+        return parts.join(":");
+      }
+    }
+    return ip;
+  },
   /**
    * @description Normalizes HTTP headers by converting all header values to strings. If a header value is an array, it joins the array elements into a single string separated by commas. This method ensures that the headers are in a consistent format, which can be particularly useful when working with different HTTP client libraries that may represent headers in various ways. If the input headers are not defined or not an object, it returns an empty object.
    * @param headers The input headers to be normalized, which can be of any type. The method checks if the headers are defined and are an object before processing them.
@@ -2076,6 +2100,36 @@ var Query = class {
   type = REQUEST_TYPE.QUERY;
 };
 
+// src/application/loggers/utils/logger-context.utils.ts
+var LoggerUtils = Object.freeze({
+  /**
+   * @description toSafeContext converts a RequestContext object to a LoggerContext object, ensuring that only the necessary fields are included.
+   * @param ctx The RequestContext object to convert.
+   * @returns The converted LoggerContext object.
+   */
+  toSafeContext(ctx) {
+    return {
+      identity: {
+        userId: ctx?.identity?.userId,
+        tenantId: ctx?.identity?.tenantId
+      },
+      network: {
+        requestId: ctx?.network?.requestId,
+        path: ctx?.network?.path,
+        origin: ctx?.network?.origin,
+        clientIp: HttpHelper.maskIp(ctx?.network?.clientIp)
+      },
+      tracing: {
+        correlationId: ctx?.tracing?.correlationId,
+        spanId: ctx?.tracing?.spanId,
+        startTime: ctx?.tracing?.startTime,
+        parentSpanId: ctx?.tracing.parentSpanId
+      },
+      messaging: ctx?.messaging
+    };
+  }
+});
+
 // src/application/loggers/base.logger.ts
 var BaseLogger = class {
   /**
@@ -2128,8 +2182,9 @@ var BaseLogger = class {
     if (level < this._minLevel) return;
     const logMessage = `[${LOG_LEVEL_NAMES[level]}] ${message}`;
     const context = this._requestContext.getContext();
+    const safeContext = LoggerUtils.toSafeContext(context);
     for (const logger of this._loggers) {
-      logger.track(level, logMessage, context, error);
+      logger.track(level, logMessage, safeContext, error);
     }
   }
 };
@@ -3154,6 +3209,7 @@ var ZodValidatorService = class _ZodValidatorService {
   InMemoryCache,
   LOG_LEVEL,
   LOG_LEVEL_NAMES,
+  LoggerUtils,
   MathHelper,
   PAGINATION_DEFAULTS,
   PERMISSIONS,