@xeno-js/core 0.1.5 → 0.1.7

package/dist/index.d.cts

@@ -23,6 +23,25 @@ interface IAtomicCache extends ICache {
     increment(key: string, ttlSeconds: Optional<number | string>): Promise<number>;
 }
 
+/**
+ * @description An interface that defines the contract for a rate limit key builder in a Xeno Vue application. This interface requires the implementation of a single method, buildRateLimitKey, which takes a resource and a client IP address as parameters and returns a string representing the rate limit key.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-vue
+ * @copyright Xeno
+ * @license MIT
+ */
+interface IRateLimitKeyBuilder {
+    /**
+     * Builds a rate limit key based on the provided resource and client IP address
+     * @param resource the resource to limit
+     * @param clientIp the client IP address
+     */
+    buildRateLimitKey(resource: string): Optional<string>;
+}
+
 /**
  * @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.
@@ -241,6 +260,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
     readonly OPTIONS_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly REQUEST_CONTEXT_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly RATE_LIMITER_MIDDLEWARE: IMiddleware<HttpHeaders>;
+    readonly RATE_LIMIT_KEY_BUILDER: IRateLimitKeyBuilder;
     /** @description Token used to register and resolve the PerformancePipeline instance in the dependency injection container.
      *
      * @author Xeno
@@ -846,6 +866,16 @@ interface IAllowMethod {
      * @link https://github.com/xeno-js/xeno-js
      */
     check(path: string, method: HttpMethod): boolean;
+    /**
+     * @description Get the allowed methods for the given path.
+     * @param path the path to get the allowed methods for.
+     * @returns the allowed methods for the given path.
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getMethods(path: string): string;
 }
 
 /**
@@ -1320,6 +1350,16 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     allowOrigins: Optional<string[]>;
+    /**
+     * @description
+     * The allowMethods property is an optional property that can be used to configure the allowed methods for the application. It is an array of strings that specifies the methods that are allowed to be used in requests to the application. This property is used to implement CORS and restrict access to the application based on the method of the request.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    allowHeaders: Optional<string[]>;
     /**
      * @description
      * The cors property is a boolean property that is used to enable or disable 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 first resource was served. This property is used to configure the CORS middleware that is responsible for handling CORS requests and responses.
@@ -1330,6 +1370,15 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     cors: boolean;
+    /**
+     * @description The exposeHeaders property is an array of strings that specifies the headers that should be exposed to the client. This property is used to configure the CORS middleware that is responsible for handling CORS requests and responses.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    withCredentials: boolean;
 }
 /**
  * @description
@@ -2117,4 +2166,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 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 };
+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 IRateLimitKeyBuilder, 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

@@ -23,6 +23,25 @@ interface IAtomicCache extends ICache {
     increment(key: string, ttlSeconds: Optional<number | string>): Promise<number>;
 }
 
+/**
+ * @description An interface that defines the contract for a rate limit key builder in a Xeno Vue application. This interface requires the implementation of a single method, buildRateLimitKey, which takes a resource and a client IP address as parameters and returns a string representing the rate limit key.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-vue
+ * @copyright Xeno
+ * @license MIT
+ */
+interface IRateLimitKeyBuilder {
+    /**
+     * Builds a rate limit key based on the provided resource and client IP address
+     * @param resource the resource to limit
+     * @param clientIp the client IP address
+     */
+    buildRateLimitKey(resource: string): Optional<string>;
+}
+
 /**
  * @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.
@@ -241,6 +260,7 @@ interface ApplicationRegistry<T = unknown, Ttx = unknown> {
     readonly OPTIONS_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly REQUEST_CONTEXT_MIDDLEWARE: IMiddleware<HttpHeaders>;
     readonly RATE_LIMITER_MIDDLEWARE: IMiddleware<HttpHeaders>;
+    readonly RATE_LIMIT_KEY_BUILDER: IRateLimitKeyBuilder;
     /** @description Token used to register and resolve the PerformancePipeline instance in the dependency injection container.
      *
      * @author Xeno
@@ -846,6 +866,16 @@ interface IAllowMethod {
      * @link https://github.com/xeno-js/xeno-js
      */
     check(path: string, method: HttpMethod): boolean;
+    /**
+     * @description Get the allowed methods for the given path.
+     * @param path the path to get the allowed methods for.
+     * @returns the allowed methods for the given path.
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getMethods(path: string): string;
 }
 
 /**
@@ -1320,6 +1350,16 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     allowOrigins: Optional<string[]>;
+    /**
+     * @description
+     * The allowMethods property is an optional property that can be used to configure the allowed methods for the application. It is an array of strings that specifies the methods that are allowed to be used in requests to the application. This property is used to implement CORS and restrict access to the application based on the method of the request.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    allowHeaders: Optional<string[]>;
     /**
      * @description
      * The cors property is a boolean property that is used to enable or disable 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 first resource was served. This property is used to configure the CORS middleware that is responsible for handling CORS requests and responses.
@@ -1330,6 +1370,15 @@ interface MiddlewareConfig {
      * @link https://github.com/xeno-js/xeno-js
      */
     cors: boolean;
+    /**
+     * @description The exposeHeaders property is an array of strings that specifies the headers that should be exposed to the client. This property is used to configure the CORS middleware that is responsible for handling CORS requests and responses.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    withCredentials: boolean;
 }
 /**
  * @description
@@ -2117,4 +2166,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 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 };
+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 IRateLimitKeyBuilder, 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 };