@xeno-js/core 0.1.1 → 0.1.3

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { IPipelineBehavior, IRequest, IExtendendService, IBaseAuthService, IServiceExtractor, HttpHeaders, Optional, ICache, ICacheKeyBuilder, IBaseMapper, AuthClaims, Identity, ICommand, IQuery, IConcurrencyService, IConfigurationService, ILoggerClient, IGateKeeper, IIdempotencyStore, ILogger, IMediator, IMiddleware, IStrategy, IPolicyRegistry, HttpMethod, RequestContext, IServiceResilience, Metadata, IFactory, ITransactionState, IUnitOfWork, IDisposable, IValidatorService, IIdentityAccessor, IContextAccessor, INetworkContextAccessor, UserContext, Factory, IBaseAccessor, AuthConfig, CookieOptions, SetupAction, HttpClientConfig, LogLevel, Dictionary, AuthPolicy, ResponseDto, IHandler, ResultType, ISpecification, CacheConfig, DbConfig, IReadDao, IReadDataSource, IMapper, IRepository, IWriteDataSource, IController, AppError } from '@xeno-js/shared';
+import { ICache, Optional, IPipelineBehavior, IRequest, IExtendendService, IBaseAuthService, IServiceExtractor, HttpHeaders, ICacheKeyBuilder, IBaseMapper, AuthClaims, Identity, ICommand, IQuery, IConcurrencyService, IConfigurationService, ILoggerClient, IGateKeeper, IIdempotencyStore, ILogger, IMediator, IMiddleware, IStrategy, IPolicyRegistry, HttpMethod, RequestContext, IServiceResilience, Metadata, IFactory, ITransactionState, IUnitOfWork, IDisposable, IValidatorService, IIdentityAccessor, IContextAccessor, INetworkContextAccessor, UserContext, Factory, IBaseAccessor, AuthConfig, CookieOptions, SetupAction, HttpClientConfig, LogLevel, Dictionary, AuthPolicy, ResponseDto, IHandler, ResultType, ISpecification, CacheConfig, DbConfig, IReadDao, IReadDataSource, IMapper, IRepository, IWriteDataSource, IController, AppError } from '@xeno-js/shared';
 export * from '@xeno-js/shared';
 export { Query as BaseQuery } from '@xeno-js/shared';
 import { SupabaseClientOptions } from '@supabase/supabase-js';
@@ -8,6 +8,21 @@ import { NodePgDatabase } from 'drizzle-orm/node-postgres';
 export * from 'drizzle-orm';
 export { Query } from 'drizzle-orm';
 
+/**
+ * @description IAtomicCache is an interface that extends the ICache interface and adds an increment method. The increment method takes a key and an optional ttlSeconds parameter and returns a Promise that resolves to an incremented value.
+ *
+ */
+interface IAtomicCache extends ICache {
+    /**
+     * @description The increment method increments the value associated with the given key in the cache. If the key does not exist, it is created with an initial value of 1. The method returns a Promise that resolves to the incremented value.
+     *
+     * @param key The key to increment the value for.
+     * @param ttlSeconds The time-to-live (TTL) in seconds for the key-value pair. If not provided, the default TTL is used.
+     * @returns A Promise that resolves to the incremented value.
+     */
+    increment(key: string, ttlSeconds: Optional<number | string>): Promise<number>;
+}
+
 /**
  * @description This file defines the injection tokens used for dependency injection in the application.
  * Injection tokens are unique identifiers that are used to register and resolve dependencies in the container.
@@ -53,7 +68,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @since 2025-09-30
      * @link https://github.com/xeno-js/xeno-js
      */
-    readonly CACHE: ICache;
+    readonly CACHE: IAtomicCache;
     /** @description Token used to register and resolve the CacheKeyBuilder instance in the dependency injection container.
      *
      * @author Xeno
@@ -118,6 +133,33 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly CONSOLE_LOGGER: ILoggerClient;
+    /** @description Token used to register and resolve the CookieExtractor instance in the dependency injection container.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly COOKIE_EXTRACTOR: IServiceExtractor<{
+        header: Optional<string>;
+        name: string;
+    }, Optional<string>>;
+    /** @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
+     */
+    readonly CSRF_TOKEN_SERVICE: ICsrfTokenService;
+    /** @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
+     */
+    readonly CRYPTO_SERVICE: ICryptoService;
     /** @description Token used to register and resolve the DbContext instance in the dependency injection container.
      *
      * @author Xeno
@@ -192,6 +234,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
     readonly MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly AUTH_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly CSRF_MIDDLEWARE: IMiddleware<HttpHeaders>;
+    readonly CSRF_COOKIE_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly ALLOW_ORIGIN_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly CORS_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly METHOD_CHECK_MIDDLEWARE: IMiddleware<HttpHeaders>;
@@ -270,6 +313,14 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly RESILIENCE_CLIENT: IServiceResilience;
+    /** @description Token used to register and resolve the IIPResolver instance in the dependency injection container.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly IP_RESOLVER: IIPResolver;
     /** @description Token used to register and resolve the RoleAuthorizationPipeline instance in the dependency injection container.
      *
      * @author Xeno
@@ -709,6 +760,32 @@ interface IServiceScopeAccessor<TRegistry extends ApplicationRegistry<unknown> =
     getScope(): Optional<IServiceScope<TRegistry>>;
 }
 
+/**
+ * @description Interface for the crypto service
+ */
+interface ICryptoService {
+    /**
+     * @description Generates a random byte array of the specified size.
+     * @param size The size of the byte array to generate.
+     * @returns A random byte array of the specified size.
+     */
+    randomBytes(size: number): Uint8Array;
+    /**
+     * @description Generates a HMAC SHA-256 hash of the specified data using the specified secret.
+     * @param secret The secret to use for the HMAC SHA-256 hash.
+     * @param data The data to hash.
+     * @returns A promise that resolves to the HMAC SHA-256 hash of the specified data.
+     */
+    hmacSha256(secret: string, data: string): Promise<string>;
+    /**
+     * @description Compares two byte arrays in a way that is resistant to timing attacks.
+     * @param a The first byte array to compare.
+     * @param b The second byte array to compare.
+     * @returns True if the two byte arrays are equal, false otherwise.
+     */
+    timingSafeEqual(a: Uint8Array, b: Uint8Array): boolean;
+}
+
 /**
  * @description Represents a module that can be registered with the service container.
  *
@@ -736,6 +813,19 @@ interface IModule<TRegistry extends ApplicationRegistry<unknown> = ApplicationRe
     configure(container: IServiceContainer<TRegistry>, opts?: Optional<TOptions>): Promise<void>;
 }
 
+/**
+ * @description IIPResolver is a generic interface that defines a contract for resolving IP addresses.
+ */
+interface IIPResolver {
+    /**
+    * @description Resolves a optional string based on the input of type T.
+    * @param request The input of type T.
+    * @param ip The optional IP address of the client.
+    * @returns The resolved optional string.
+    */
+    resolve<T>(request: T, ip: Optional<string>): Optional<string>;
+}
+
 /**
  * @description Interface for the allow method service.
  *
@@ -779,6 +869,25 @@ interface IAllowOrigin {
     isAllowed(origin: Optional<string>): boolean;
 }
 
+/**
+ * @description Interface for the CSRF token service
+ */
+interface ICsrfTokenService {
+    /**
+     * @description Generate a new CSRF token
+     * @param subject The subject of the token
+     * @returns A promise that resolves to the token
+     */
+    generate(subject: string): Promise<string>;
+    /**
+     * @description Validate a CSRF token
+     * @param token The token to validate
+     * @param subject The subject of the token
+     * @returns A priomise that resolves to true if the token is valid, false otherwise
+     */
+    validate(token: string, subject: string): Promise<boolean>;
+}
+
 interface ISsrCookie {
     name: string;
     value: string;
@@ -1160,7 +1269,7 @@ interface MiddlewareConfig {
      * @since 2025-09-30
      * @link https://github.com/xeno-js/xeno-js
      */
-    csrf: Optional<string>;
+    csrf: Optional<CsrfConfig>;
     /**
      * @description
      * The cors property is an optional property that can be used to configure Cross-Origin Resource Sharing (CORS) for the application. CORS is a mechanism that allows resources on a web page to be requested from another domain outside the domain from which the resource originated. The cors property is an object that contains properties to configure CORS, such as allowedOrigins, allowedMethods, allowedHeaders, and exposedHeaders.
@@ -1191,6 +1300,16 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     trustedIpHeader: Optional<string>;
+    /**
+     * @description
+     * The trustedProxies property is an optional property that can be used to configure the trusted proxies for the application. It is an array of strings that specifies the IP addresses or hostnames of the proxies that are trusted by the application. This property is used to determine the trusted IP address of the client making the request and can be useful for security and authentication purposes.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    trustedProxies: Optional<string[]>;
     /**
      * @description
      * The allowOrigins property is an optional property that can be used to configure the allowed origins for the application. It is an array of strings that specifies the origins that are allowed to make requests to the application. This property is used to implement Cross-Origin Resource Sharing (CORS) and restrict access to the application based on the origin of the request.
@@ -1212,6 +1331,36 @@ interface MiddlewareConfig {
      */
     cors: boolean;
 }
+/**
+ * @description
+ * The csrf property is an object that contains configuration options for the CSRF middleware. The csrf property is used to configure the CSRF middleware that is responsible for handling CSRF requests and responses.
+ */
+interface CsrfConfig {
+    /**
+     * Secret used to sign CSRF tokens.
+     */
+    secret: string;
+    /**
+     * @description the name of the cookie that will be used to store the CSRF token.
+     */
+    cookieName: Optional<string>;
+    /**
+    * @description the name of the header that will be used to send the CSRF token.
+    */
+    headerName: Optional<string>;
+    /**
+     * @description the number of seconds that the CSRF token will be valid for.
+    */
+    cookieMaxAgeSeconds: Optional<number>;
+    /**
+     * Cookie SameSite policy.
+     */
+    sameSite?: 'strict' | 'lax' | 'none';
+    /**
+     * Enforce Origin/Referer validation for unsafe requests.
+     */
+    enforceOrigin?: boolean;
+}
 
 /**
  * @description PipelineConfig defines the configuration options for the CQRS pipelines in the application. It includes settings for performance monitoring, authorization, validation, command bus, and query bus. Each section allows for enabling or disabling specific features and providing additional configuration details as needed. This configuration is used by the CqrsModule to set up the appropriate middleware and services in the dependency injection container based on the specified options.
@@ -1968,4 +2117,4 @@ declare abstract class BaseController<TRequest, TResponse> implements IControlle
     protected getContext(): Optional<RequestContext>;
 }
 
-export { AppBuilder, type ApplicationRegistry, type AuthSsrConfig, BaseAuthorizationStrategy, BaseController, BaseHandler, ContainerUtils, type DbContext, type DbTransaction, type ExecutionContext, type HttpConfig, type HttpCoreConfig, type IAllowMethod, type IAllowOrigin, type IModule, type IRequestContext, type IServiceContainer, type IServiceProvider, type IServiceScope, type IServiceScopeAccessor, type ISsrCookie, type ISsrCookieHandler, type ISsrCookieToSet, type Lifetime, type LoggerConfig, type MiddlewareConfig, type PinoLoggerConfig, type PipelineConfig, ReadDao, Repository, type ResilienceConfig, type SchemaConfig, type SentryLoggerConfig, type ServiceDescriptor, Specification, SupabaseServerAuthFactory, type XenoRegistry };
+export { AppBuilder, type ApplicationRegistry, type AuthSsrConfig, BaseAuthorizationStrategy, BaseController, BaseHandler, ContainerUtils, type DbContext, type DbTransaction, type ExecutionContext, type HttpConfig, type HttpCoreConfig, type IAllowMethod, type IAllowOrigin, type IAtomicCache, type ICryptoService, type ICsrfTokenService, type IIPResolver, type IModule, type IRequestContext, type IServiceContainer, type IServiceProvider, type IServiceScope, type IServiceScopeAccessor, type ISsrCookie, type ISsrCookieHandler, type ISsrCookieToSet, type Lifetime, type LoggerConfig, type MiddlewareConfig, type PinoLoggerConfig, type PipelineConfig, ReadDao, Repository, type ResilienceConfig, type SchemaConfig, type SentryLoggerConfig, type ServiceDescriptor, Specification, SupabaseServerAuthFactory, type XenoRegistry };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IPipelineBehavior, IRequest, IExtendendService, IBaseAuthService, IServiceExtractor, HttpHeaders, Optional, ICache, ICacheKeyBuilder, IBaseMapper, AuthClaims, Identity, ICommand, IQuery, IConcurrencyService, IConfigurationService, ILoggerClient, IGateKeeper, IIdempotencyStore, ILogger, IMediator, IMiddleware, IStrategy, IPolicyRegistry, HttpMethod, RequestContext, IServiceResilience, Metadata, IFactory, ITransactionState, IUnitOfWork, IDisposable, IValidatorService, IIdentityAccessor, IContextAccessor, INetworkContextAccessor, UserContext, Factory, IBaseAccessor, AuthConfig, CookieOptions, SetupAction, HttpClientConfig, LogLevel, Dictionary, AuthPolicy, ResponseDto, IHandler, ResultType, ISpecification, CacheConfig, DbConfig, IReadDao, IReadDataSource, IMapper, IRepository, IWriteDataSource, IController, AppError } from '@xeno-js/shared';
+import { ICache, Optional, IPipelineBehavior, IRequest, IExtendendService, IBaseAuthService, IServiceExtractor, HttpHeaders, ICacheKeyBuilder, IBaseMapper, AuthClaims, Identity, ICommand, IQuery, IConcurrencyService, IConfigurationService, ILoggerClient, IGateKeeper, IIdempotencyStore, ILogger, IMediator, IMiddleware, IStrategy, IPolicyRegistry, HttpMethod, RequestContext, IServiceResilience, Metadata, IFactory, ITransactionState, IUnitOfWork, IDisposable, IValidatorService, IIdentityAccessor, IContextAccessor, INetworkContextAccessor, UserContext, Factory, IBaseAccessor, AuthConfig, CookieOptions, SetupAction, HttpClientConfig, LogLevel, Dictionary, AuthPolicy, ResponseDto, IHandler, ResultType, ISpecification, CacheConfig, DbConfig, IReadDao, IReadDataSource, IMapper, IRepository, IWriteDataSource, IController, AppError } from '@xeno-js/shared';
 export * from '@xeno-js/shared';
 export { Query as BaseQuery } from '@xeno-js/shared';
 import { SupabaseClientOptions } from '@supabase/supabase-js';
@@ -8,6 +8,21 @@ import { NodePgDatabase } from 'drizzle-orm/node-postgres';
 export * from 'drizzle-orm';
 export { Query } from 'drizzle-orm';
 
+/**
+ * @description IAtomicCache is an interface that extends the ICache interface and adds an increment method. The increment method takes a key and an optional ttlSeconds parameter and returns a Promise that resolves to an incremented value.
+ *
+ */
+interface IAtomicCache extends ICache {
+    /**
+     * @description The increment method increments the value associated with the given key in the cache. If the key does not exist, it is created with an initial value of 1. The method returns a Promise that resolves to the incremented value.
+     *
+     * @param key The key to increment the value for.
+     * @param ttlSeconds The time-to-live (TTL) in seconds for the key-value pair. If not provided, the default TTL is used.
+     * @returns A Promise that resolves to the incremented value.
+     */
+    increment(key: string, ttlSeconds: Optional<number | string>): Promise<number>;
+}
+
 /**
  * @description This file defines the injection tokens used for dependency injection in the application.
  * Injection tokens are unique identifiers that are used to register and resolve dependencies in the container.
@@ -53,7 +68,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @since 2025-09-30
      * @link https://github.com/xeno-js/xeno-js
      */
-    readonly CACHE: ICache;
+    readonly CACHE: IAtomicCache;
     /** @description Token used to register and resolve the CacheKeyBuilder instance in the dependency injection container.
      *
      * @author Xeno
@@ -118,6 +133,33 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly CONSOLE_LOGGER: ILoggerClient;
+    /** @description Token used to register and resolve the CookieExtractor instance in the dependency injection container.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly COOKIE_EXTRACTOR: IServiceExtractor<{
+        header: Optional<string>;
+        name: string;
+    }, Optional<string>>;
+    /** @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
+     */
+    readonly CSRF_TOKEN_SERVICE: ICsrfTokenService;
+    /** @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
+     */
+    readonly CRYPTO_SERVICE: ICryptoService;
     /** @description Token used to register and resolve the DbContext instance in the dependency injection container.
      *
      * @author Xeno
@@ -192,6 +234,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
     readonly MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly AUTH_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly CSRF_MIDDLEWARE: IMiddleware<HttpHeaders>;
+    readonly CSRF_COOKIE_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly ALLOW_ORIGIN_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly CORS_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly METHOD_CHECK_MIDDLEWARE: IMiddleware<HttpHeaders>;
@@ -270,6 +313,14 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly RESILIENCE_CLIENT: IServiceResilience;
+    /** @description Token used to register and resolve the IIPResolver instance in the dependency injection container.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly IP_RESOLVER: IIPResolver;
     /** @description Token used to register and resolve the RoleAuthorizationPipeline instance in the dependency injection container.
      *
      * @author Xeno
@@ -709,6 +760,32 @@ interface IServiceScopeAccessor<TRegistry extends ApplicationRegistry<unknown> =
     getScope(): Optional<IServiceScope<TRegistry>>;
 }
 
+/**
+ * @description Interface for the crypto service
+ */
+interface ICryptoService {
+    /**
+     * @description Generates a random byte array of the specified size.
+     * @param size The size of the byte array to generate.
+     * @returns A random byte array of the specified size.
+     */
+    randomBytes(size: number): Uint8Array;
+    /**
+     * @description Generates a HMAC SHA-256 hash of the specified data using the specified secret.
+     * @param secret The secret to use for the HMAC SHA-256 hash.
+     * @param data The data to hash.
+     * @returns A promise that resolves to the HMAC SHA-256 hash of the specified data.
+     */
+    hmacSha256(secret: string, data: string): Promise<string>;
+    /**
+     * @description Compares two byte arrays in a way that is resistant to timing attacks.
+     * @param a The first byte array to compare.
+     * @param b The second byte array to compare.
+     * @returns True if the two byte arrays are equal, false otherwise.
+     */
+    timingSafeEqual(a: Uint8Array, b: Uint8Array): boolean;
+}
+
 /**
  * @description Represents a module that can be registered with the service container.
  *
@@ -736,6 +813,19 @@ interface IModule<TRegistry extends ApplicationRegistry<unknown> = ApplicationRe
     configure(container: IServiceContainer<TRegistry>, opts?: Optional<TOptions>): Promise<void>;
 }
 
+/**
+ * @description IIPResolver is a generic interface that defines a contract for resolving IP addresses.
+ */
+interface IIPResolver {
+    /**
+    * @description Resolves a optional string based on the input of type T.
+    * @param request The input of type T.
+    * @param ip The optional IP address of the client.
+    * @returns The resolved optional string.
+    */
+    resolve<T>(request: T, ip: Optional<string>): Optional<string>;
+}
+
 /**
  * @description Interface for the allow method service.
  *
@@ -779,6 +869,25 @@ interface IAllowOrigin {
     isAllowed(origin: Optional<string>): boolean;
 }
 
+/**
+ * @description Interface for the CSRF token service
+ */
+interface ICsrfTokenService {
+    /**
+     * @description Generate a new CSRF token
+     * @param subject The subject of the token
+     * @returns A promise that resolves to the token
+     */
+    generate(subject: string): Promise<string>;
+    /**
+     * @description Validate a CSRF token
+     * @param token The token to validate
+     * @param subject The subject of the token
+     * @returns A priomise that resolves to true if the token is valid, false otherwise
+     */
+    validate(token: string, subject: string): Promise<boolean>;
+}
+
 interface ISsrCookie {
     name: string;
     value: string;
@@ -1160,7 +1269,7 @@ interface MiddlewareConfig {
      * @since 2025-09-30
      * @link https://github.com/xeno-js/xeno-js
      */
-    csrf: Optional<string>;
+    csrf: Optional<CsrfConfig>;
     /**
      * @description
      * The cors property is an optional property that can be used to configure Cross-Origin Resource Sharing (CORS) for the application. CORS is a mechanism that allows resources on a web page to be requested from another domain outside the domain from which the resource originated. The cors property is an object that contains properties to configure CORS, such as allowedOrigins, allowedMethods, allowedHeaders, and exposedHeaders.
@@ -1191,6 +1300,16 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     trustedIpHeader: Optional<string>;
+    /**
+     * @description
+     * The trustedProxies property is an optional property that can be used to configure the trusted proxies for the application. It is an array of strings that specifies the IP addresses or hostnames of the proxies that are trusted by the application. This property is used to determine the trusted IP address of the client making the request and can be useful for security and authentication purposes.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    trustedProxies: Optional<string[]>;
     /**
      * @description
      * The allowOrigins property is an optional property that can be used to configure the allowed origins for the application. It is an array of strings that specifies the origins that are allowed to make requests to the application. This property is used to implement Cross-Origin Resource Sharing (CORS) and restrict access to the application based on the origin of the request.
@@ -1212,6 +1331,36 @@ interface MiddlewareConfig {
      */
     cors: boolean;
 }
+/**
+ * @description
+ * The csrf property is an object that contains configuration options for the CSRF middleware. The csrf property is used to configure the CSRF middleware that is responsible for handling CSRF requests and responses.
+ */
+interface CsrfConfig {
+    /**
+     * Secret used to sign CSRF tokens.
+     */
+    secret: string;
+    /**
+     * @description the name of the cookie that will be used to store the CSRF token.
+     */
+    cookieName: Optional<string>;
+    /**
+    * @description the name of the header that will be used to send the CSRF token.
+    */
+    headerName: Optional<string>;
+    /**
+     * @description the number of seconds that the CSRF token will be valid for.
+    */
+    cookieMaxAgeSeconds: Optional<number>;
+    /**
+     * Cookie SameSite policy.
+     */
+    sameSite?: 'strict' | 'lax' | 'none';
+    /**
+     * Enforce Origin/Referer validation for unsafe requests.
+     */
+    enforceOrigin?: boolean;
+}
 
 /**
  * @description PipelineConfig defines the configuration options for the CQRS pipelines in the application. It includes settings for performance monitoring, authorization, validation, command bus, and query bus. Each section allows for enabling or disabling specific features and providing additional configuration details as needed. This configuration is used by the CqrsModule to set up the appropriate middleware and services in the dependency injection container based on the specified options.
@@ -1968,4 +2117,4 @@ declare abstract class BaseController<TRequest, TResponse> implements IControlle
     protected getContext(): Optional<RequestContext>;
 }
 
-export { AppBuilder, type ApplicationRegistry, type AuthSsrConfig, BaseAuthorizationStrategy, BaseController, BaseHandler, ContainerUtils, type DbContext, type DbTransaction, type ExecutionContext, type HttpConfig, type HttpCoreConfig, type IAllowMethod, type IAllowOrigin, type IModule, type IRequestContext, type IServiceContainer, type IServiceProvider, type IServiceScope, type IServiceScopeAccessor, type ISsrCookie, type ISsrCookieHandler, type ISsrCookieToSet, type Lifetime, type LoggerConfig, type MiddlewareConfig, type PinoLoggerConfig, type PipelineConfig, ReadDao, Repository, type ResilienceConfig, type SchemaConfig, type SentryLoggerConfig, type ServiceDescriptor, Specification, SupabaseServerAuthFactory, type XenoRegistry };
+export { AppBuilder, type ApplicationRegistry, type AuthSsrConfig, BaseAuthorizationStrategy, BaseController, BaseHandler, ContainerUtils, type DbContext, type DbTransaction, type ExecutionContext, type HttpConfig, type HttpCoreConfig, type IAllowMethod, type IAllowOrigin, type IAtomicCache, type ICryptoService, type ICsrfTokenService, type IIPResolver, type IModule, type IRequestContext, type IServiceContainer, type IServiceProvider, type IServiceScope, type IServiceScopeAccessor, type ISsrCookie, type ISsrCookieHandler, type ISsrCookieToSet, type Lifetime, type LoggerConfig, type MiddlewareConfig, type PinoLoggerConfig, type PipelineConfig, ReadDao, Repository, type ResilienceConfig, type SchemaConfig, type SentryLoggerConfig, type ServiceDescriptor, Specification, SupabaseServerAuthFactory, type XenoRegistry };