@xeno-js/shared 0.1.5 → 0.1.7

package/README.md

@@ -197,20 +197,14 @@ flows from feature branches ➡️ `develop` ➡️ `main`._
 
 ### Scripts
 
-| 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
-
-|
+| 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         |
 
 ### 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,
@@ -735,17 +736,7 @@ var RESILIENCE_DEFAULTS = Object.freeze({
 
 // src/shared/constants/tokens.constants.ts
 var TOKENS = Object.freeze({
-  ALLOW_ORIGIN: "ALLOW_ORIGIN",
-  ALLOW_METHOD: "ALLOW_METHOD",
-  /** @description Token used to register and resolve the AuthorizationPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  AUTHORIZATION_PIPELINE: "AUTHORIZATION_PIPELINE",
-  /** @description Token used to register and resolve the AuthService instance in the dependency injection container.
+  /** @description Token used to register and resolve the Extendend AuthService instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
@@ -753,15 +744,14 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   AUTH_SERVICE: "AUTH_SERVICE",
-  BASE_AUTH_SERVICE: "BASE_AUTH_SERVICE",
-  /** @description Token used to register and resolve the BearerTokenExtractor instance in the dependency injection container.
+  /** @description Token used to register and resolve the BaseAuthService instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  BEARER_TOKEN_EXTRACTOR: "BEARER_TOKEN_EXTRACTOR",
+  BASE_AUTH_SERVICE: "BASE_AUTH_SERVICE",
   /** @description Token used to register and resolve the InMemoryCache instance in the dependency injection container.
    *
    * @author Xeno
@@ -778,14 +768,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   CACHE_KEY_BUILDER: "CACHE_KEY_BUILDER",
-  /** @description Token used to register and resolve the ClaimsIdentityMapper instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  CLAIMS_IDENTITY_MAPPER: "CLAIMS_IDENTITY_MAPPER",
   /** @description Token used to register and resolve command pipeline behaviors in the dependency injection container.
    *
    * @author Xeno
@@ -794,22 +776,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   COMMAND_PIPELINES_BEHAVIOR: "COMMAND_PIPELINES_BEHAVIOR",
-  /** @description Token used to register and resolve the CompositePipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  COMPOSITE_PIPELINE: "COMPOSITE_PIPELINE",
-  /** @description Token used to register and resolve the ConcurrencyRetryPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  CONCURRENCY_RETRY_PIPELINE: "CONCURRENCY_RETRY_PIPELINE",
   /** @description Token used to register and resolve the ConcurrencyService instance in the dependency injection container.
    *
    * @author Xeno
@@ -826,14 +792,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   CONFIGURATION_SERVICE: "CONFIGURATION_SERVICE",
-  /** @description Token used to register and resolve the ConsoleLogger instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  CONSOLE_LOGGER: "CONSOLE_LOGGER",
   /** @description Token used to register and resolve the ContextAccessor instance in the dependency injection container.
    *
    * @author Xeno
@@ -842,46 +800,30 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   CONTEXT_ACCESSOR: "CONTEXT_ACCESSOR",
-  /** @description Token used to register and resolve the DbContext instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  DB_CONTEXT: "DB_CONTEXT",
-  /** @description Token used to register and resolve the ExceptionPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  EXCEPTION_PIPELINE: "EXCEPTION_PIPELINE",
-  /** @description Token used to register and resolve the GateKeeper instance in the dependency injection container.
+  /** @description Token used to register and resolve the CryptoService instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  GATE_KEEPER: "GATE_KEEPER",
-  /** @description Token used to register and resolve the IdempotencyPipeline instance in the dependency injection container.
+  CRYPTO_SERVICE: "CRYPTO_SERVICE",
+  /** @description Token used to register and resolve the CsrfTokenService instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  IDEMPOTENCY_PIPELINE: "IDEMPOTENCY_PIPELINE",
-  /** @description Token used to register and resolve the IdempotencyStore instance in the dependency injection container.
+  CSRF_TOKEN_SERVICE: "CSRF_TOKEN_SERVICE",
+  /** @description Token used to register and resolve the DbContext instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  IDEMPOTENCY_STORE: "IDEMPOTENCY_STORE",
+  DB_CONTEXT: "DB_CONTEXT",
   /** @description Token used to register and resolve the IdentityAccessor instance in the dependency injection container.
    *
    * @author Xeno
@@ -898,22 +840,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   LOGGER: "LOGGER",
-  /** @description Token used to register and resolve the LoggerConfig instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  LOGGER_CONFIG: "LOGGER_CONFIG",
-  /** @description Token used to register and resolve the LoggingPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  LOGGING_PIPELINE: "LOGGING_PIPELINE",
   /** @description Token used to register and resolve the Mediator instance in the dependency injection container.
    *
    * @author Xeno
@@ -922,46 +848,14 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   MEDIATOR: "MEDIATOR",
-  /** @description Token used to register and resolve the PerformancePipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  PERFORMANCE_PIPELINE: "PERFORMANCE_PIPELINE",
-  /** @description Token used to register and resolve the PermissionAuthorizationPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  PERMISSION_AUTHORIZATION_PIPELINE: "PERMISSION_AUTHORIZATION_PIPELINE",
-  /** @description Token used to register and resolve the PinoLogger instance in the dependency injection container.
+  /** @description Token used to register and resolve the NetworkContextFactory in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  PINO_LOGGER: "PINO_LOGGER",
-  /** @description Token used to register and resolve the PolicyRegistry instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  POLICY_REGISTRY: "POLICY_REGISTRY",
-  /** @description Token used to register and resolve the QueryCachingPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  QUERY_CACHING_PIPELINE: "QUERY_CACHING_PIPELINE",
+  NETWORK_CONTEXT_ACCESSOR: "NETWORK_CONTEXT_ACCESSOR",
   /** @description Token used to register and resolve query pipeline behaviors in the dependency injection container.
    *
    * @author Xeno
@@ -978,7 +872,7 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   REQUEST_CONTEXT: "REQUEST_CONTEXT",
-  /** @description Token used to register and resolve the RequestContextMiddleware in the dependency injection container.
+  /** @description Token used to register and resolve the CompositeMiddleware in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
@@ -986,14 +880,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   MIDDLEWARE: "MIDDLEWARE",
-  AUTH_MIDDLEWARE: "AUTH_MIDDLEWARE",
-  CSRF_MIDDLEWARE: "CSRF_MIDDLEWARE",
-  ALLOW_ORIGIN_MIDDLEWARE: "ALLOW_ORIGIN_MIDDLEWARE",
-  CORS_MIDDLEWARE: "CORS_MIDDLEWARE",
-  METHOD_CHECK_MIDDLEWARE: "METHOD_CHECK_MIDDLEWARE",
-  OPTIONS_MIDDLEWARE: "OPTIONS_MIDDLEWARE",
-  REQUEST_CONTEXT_MIDDLEWARE: "REQUEST_CONTEXT_MIDDLEWARE",
-  RATE_LIMITER_MIDDLEWARE: "RATE_LIMITER_MIDDLEWARE",
   /** @description Token used to register and resolve the IServiceResilience instance in the dependency injection container.
    *
    * @author Xeno
@@ -1002,14 +888,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   RESILIENCE_CLIENT: "RESILIENCE_CLIENT",
-  /** @description Token used to register and resolve the RoleAuthorizationPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  ROLE_AUTHORIZATION_PIPELINE: "ROLE_AUTHORIZATION_PIPELINE",
   /** @description Token used to register and resolve the SchemaValidationStrategy instance in the dependency injection container.
    *
    * @author Xeno
@@ -1018,14 +896,6 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   SCHEMA_VALIDATION_STRATEGY: "SCHEMA_VALIDATION_STRATEGY",
-  /** @description Token used to register and resolve the SentryLogger instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  SENTRY_LOGGER: "SENTRY_LOGGER",
   /** @description Token used to register and resolve the ServiceContainer instance in the dependency injection container.
    *
    * @author Xeno
@@ -1042,22 +912,14 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   SERVICE_EXTRACTOR: "SERVICE_EXTRACTOR",
-  /** @description Token used to register and resolve the ServiceScopeFactory instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  SERVICE_SCOPE_FACTORY: "SERVICE_SCOPE_FACTORY",
-  /** @description Token used to register and resolve the TenantAuthorizationPipeline instance in the dependency injection container.
+  /** @description Token used to register and resolve the ServiceScopeAccessor in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  TENANT_AUTHORIZATION_PIPELINE: "TENANT_AUTHORIZATION_PIPELINE",
+  SERVICE_SCOPE_ACCESSOR: "SERVICE_SCOPE_ACCESSOR",
   /** @description Token used to register and resolve the UnitOfWork instance in the dependency injection container.
    *
    * @author Xeno
@@ -1066,34 +928,14 @@ var TOKENS = Object.freeze({
    * @link https://github.com/xeno-js/xeno-js
    */
   UNIT_OF_WORK: "UNIT_OF_WORK",
-  /** @description Token used to register and resolve the UserAuthorizationPipeline instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  USER_AUTHORIZATION_PIPELINE: "USER_AUTHORIZATION_PIPELINE",
-  /** @description Token used to register and resolve the ValidationPipeline instance in the dependency injection container.
+  /** @description Token used to register and resolve the ValidatorService instance in the dependency injection container.
    *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
    * @link https://github.com/xeno-js/xeno-js
    */
-  VALIDATION_PIPELINE: "VALIDATION_PIPELINE",
-  /** @description Token used to register and resolve the ZodValidator instance in the dependency injection container.
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-  ZOD_VALIDATOR: "ZOD_VALIDATOR",
-  SERVICE_SCOPE_ACCESSOR: "SERVICE_SCOPE_ACCESSOR",
-  NETWORK_CONTEXT_ACCESSOR: "NETWORK_CONTEXT_ACCESSOR",
-  USER_CONTEXT_FACTORY: "USER_CONTEXT_FACTORY",
-  TRANSACTION_STATE: "TRANSACTION_STATE"
+  VALIDATOR_SERVICE: "VALIDATOR_SERVICE"
 });
 
 // src/shared/utils/guards.utils.ts
@@ -1626,6 +1468,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 +1941,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 {
   /**
@@ -2083,12 +1978,11 @@ var BaseLogger = class {
    * @param _requestContext The request context that provides contextual information for log messages, such as request-specific data or metadata.
    * @param config The minimum log level for this logger instance. Only messages with a log level equal to or higher than this level will be processed and forwarded to the logging clients.
    * @param loggers An array of ILoggerClient instances that will receive log messages from this logger. Each ILoggerClient represents a different logging provider or destination (e.g., console, file, external service).
-  
-   * 
+   *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js 
+   * @link https://github.com/xeno-js/xeno-js
    */
   constructor(_requestContext, config, loggers) {
     this._requestContext = _requestContext;
@@ -2117,19 +2011,19 @@ var BaseLogger = class {
    * @param message The log message.
    * @param context Optional context information to include with the log message.
    * @param error Optional error object to include with the log message.
-  
-   * 
+   *
    * @author Xeno
    * @version 1.0.0
    * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js 
+   * @link https://github.com/xeno-js/xeno-js
    */
   broadcast(level, message, error = void 0) {
     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 +3048,7 @@ var ZodValidatorService = class _ZodValidatorService {
   InMemoryCache,
   LOG_LEVEL,
   LOG_LEVEL_NAMES,
+  LoggerUtils,
   MathHelper,
   PAGINATION_DEFAULTS,
   PERMISSIONS,