@xeno-js/shared 0.1.6 → 0.2.0

package/dist/index.d.cts

@@ -2,6 +2,82 @@ import { SupabaseClient, User, Session as Session$1, Provider as Provider$1 } fr
 import { AxiosInstance } from 'axios';
 import { z, ZodType } from 'zod';
 
+/**
+ * @description DomainEvent is an interface that represents a domain event in the application. It defines the structure and properties of a domain event, which is a message that is published when a significant change
+ * occurs within the domain. Domain events are used to notify other parts of the application about these changes and trigger appropriate actions.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ */
+interface IDomainEvent<TPayload = unknown, TValueObject extends object = object> {
+    /**
+     * @description The unique identifier of the aggregate that triggered the domain event.
+     */
+    readonly aggregateId: TValueObject;
+    /**
+     * @description The type of the domain event.
+     */
+    readonly eventType: string;
+    /**
+     * @description The version of the domain event.
+     */
+    readonly version: number;
+    /**
+     * @description The timestamp when the domain event occurred.
+     */
+    readonly occurredAt: Date;
+    /**
+     * @description The payload of the domain event, containing the specific data related to the event.
+     */
+    readonly payload: TPayload;
+}
+
+/**
+ * The IValueObject interface defines the contract for value objects in the domain. A value object is an immutable type that represents a concept or measurement in the domain, and its equality is based on its properties rather than its identity. The IValueObject interface includes methods for retrieving the underlying value, comparing value objects for equality, and providing a string representation of the value object.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+interface IValueObject<T extends object> {
+    /**
+     * Retrieves the underlying value of the value object. This method provides access to the encapsulated data, allowing it to be used in comparisons, transformations, or other operations while maintaining the integrity and immutability of the value object.
+     * @returns The underlying value of the value object.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    getValue(): T;
+    /**
+     * Compares the current value object with another value object for equality. This method checks if the underlying values of both value objects are equal, allowing for meaningful comparisons between value objects based on their encapsulated data rather than their reference identity.
+     * @param other The other value object to compare with the current value object.
+     * @returns True if the underlying values of both value objects are equal; otherwise, returns false.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    equals(other: IValueObject<T>): boolean;
+    /**
+     * Returns a string representation of the value object. This method can be used for debugging, logging, or any scenario where a human-readable representation of the value object is needed. The string representation should ideally include relevant information about the underlying value to provide context when the value object is printed or logged.
+     * @returns A string representation of the value object.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    toString(): string;
+}
+
 /**
  * @description This module defines constants related to concurrency handling in the application, specifically for the ConcurrencyRetryPipeline. These constants include the maximum number of retry attempts, the base delay for retries, and the maximum jitter to be added to the delay. The constants are exported as a frozen object to prevent modification at runtime, ensuring consistent behavior across the application when handling concurrency conflicts.
 
@@ -785,25 +861,14 @@ type Permission = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
  * @description This file defines the tokens used for dependency injection in the application.
  * Tokens are unique identifiers that are used to register and resolve dependencies in the container.
  * They can be symbols, strings, or classes, but using symbols is a common practice to avoid naming collisions.
-
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 declare const TOKENS: Readonly<{
-    readonly ALLOW_ORIGIN: "ALLOW_ORIGIN";
-    readonly 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
-     */
-    readonly 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
@@ -811,15 +876,14 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly AUTH_SERVICE: "AUTH_SERVICE";
-    readonly 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
      */
-    readonly BEARER_TOKEN_EXTRACTOR: "BEARER_TOKEN_EXTRACTOR";
+    readonly BASE_AUTH_SERVICE: "BASE_AUTH_SERVICE";
     /** @description Token used to register and resolve the InMemoryCache instance in the dependency injection container.
      *
      * @author Xeno
@@ -836,14 +900,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly CLAIMS_IDENTITY_MAPPER: "CLAIMS_IDENTITY_MAPPER";
     /** @description Token used to register and resolve command pipeline behaviors in the dependency injection container.
      *
      * @author Xeno
@@ -852,22 +908,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly 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
-     */
-    readonly CONCURRENCY_RETRY_PIPELINE: "CONCURRENCY_RETRY_PIPELINE";
     /** @description Token used to register and resolve the ConcurrencyService instance in the dependency injection container.
      *
      * @author Xeno
@@ -884,14 +924,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly CONSOLE_LOGGER: "CONSOLE_LOGGER";
     /** @description Token used to register and resolve the ContextAccessor instance in the dependency injection container.
      *
      * @author Xeno
@@ -900,46 +932,30 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly CONTEXT_ACCESSOR: "CONTEXT_ACCESSOR";
-    /** @description Token used to register and resolve the DbContext 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
      */
-    readonly DB_CONTEXT: "DB_CONTEXT";
-    /** @description Token used to register and resolve the ExceptionPipeline instance in the dependency injection container.
+    readonly 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
      */
-    readonly EXCEPTION_PIPELINE: "EXCEPTION_PIPELINE";
-    /** @description Token used to register and resolve the GateKeeper 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 GATE_KEEPER: "GATE_KEEPER";
-    /** @description Token used to register and resolve the IdempotencyPipeline 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 IDEMPOTENCY_PIPELINE: "IDEMPOTENCY_PIPELINE";
-    /** @description Token used to register and resolve the IdempotencyStore instance in the dependency injection container.
+    readonly 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
      */
-    readonly IDEMPOTENCY_STORE: "IDEMPOTENCY_STORE";
+    readonly DB_CONTEXT: "DB_CONTEXT";
     /** @description Token used to register and resolve the IdentityAccessor instance in the dependency injection container.
      *
      * @author Xeno
@@ -956,22 +972,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly 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
-     */
-    readonly LOGGING_PIPELINE: "LOGGING_PIPELINE";
     /** @description Token used to register and resolve the Mediator instance in the dependency injection container.
      *
      * @author Xeno
@@ -980,46 +980,14 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly 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
-     */
-    readonly 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
      */
-    readonly 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
-     */
-    readonly 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
-     */
-    readonly QUERY_CACHING_PIPELINE: "QUERY_CACHING_PIPELINE";
+    readonly NETWORK_CONTEXT_ACCESSOR: "NETWORK_CONTEXT_ACCESSOR";
     /** @description Token used to register and resolve query pipeline behaviors in the dependency injection container.
      *
      * @author Xeno
@@ -1036,7 +1004,7 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
@@ -1044,14 +1012,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly MIDDLEWARE: "MIDDLEWARE";
-    readonly AUTH_MIDDLEWARE: "AUTH_MIDDLEWARE";
-    readonly CSRF_MIDDLEWARE: "CSRF_MIDDLEWARE";
-    readonly ALLOW_ORIGIN_MIDDLEWARE: "ALLOW_ORIGIN_MIDDLEWARE";
-    readonly CORS_MIDDLEWARE: "CORS_MIDDLEWARE";
-    readonly METHOD_CHECK_MIDDLEWARE: "METHOD_CHECK_MIDDLEWARE";
-    readonly OPTIONS_MIDDLEWARE: "OPTIONS_MIDDLEWARE";
-    readonly REQUEST_CONTEXT_MIDDLEWARE: "REQUEST_CONTEXT_MIDDLEWARE";
-    readonly RATE_LIMITER_MIDDLEWARE: "RATE_LIMITER_MIDDLEWARE";
     /** @description Token used to register and resolve the IServiceResilience instance in the dependency injection container.
      *
      * @author Xeno
@@ -1060,14 +1020,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly ROLE_AUTHORIZATION_PIPELINE: "ROLE_AUTHORIZATION_PIPELINE";
     /** @description Token used to register and resolve the SchemaValidationStrategy instance in the dependency injection container.
      *
      * @author Xeno
@@ -1076,14 +1028,6 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly SENTRY_LOGGER: "SENTRY_LOGGER";
     /** @description Token used to register and resolve the ServiceContainer instance in the dependency injection container.
      *
      * @author Xeno
@@ -1100,22 +1044,14 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly SERVICE_EXTRACTOR: "SERVICE_EXTRACTOR";
-    /** @description Token used to register and resolve the ServiceScopeFactory 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
      */
-    readonly SERVICE_SCOPE_FACTORY: "SERVICE_SCOPE_FACTORY";
-    /** @description Token used to register and resolve the TenantAuthorizationPipeline 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 TENANT_AUTHORIZATION_PIPELINE: "TENANT_AUTHORIZATION_PIPELINE";
+    readonly SERVICE_SCOPE_ACCESSOR: "SERVICE_SCOPE_ACCESSOR";
     /** @description Token used to register and resolve the UnitOfWork instance in the dependency injection container.
      *
      * @author Xeno
@@ -1124,34 +1060,14 @@ declare const TOKENS: Readonly<{
      * @link https://github.com/xeno-js/xeno-js
      */
     readonly 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
-     */
-    readonly USER_AUTHORIZATION_PIPELINE: "USER_AUTHORIZATION_PIPELINE";
-    /** @description Token used to register and resolve the ValidationPipeline 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 VALIDATION_PIPELINE: "VALIDATION_PIPELINE";
-    /** @description Token used to register and resolve the ZodValidator 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
      */
-    readonly ZOD_VALIDATOR: "ZOD_VALIDATOR";
-    readonly SERVICE_SCOPE_ACCESSOR: "SERVICE_SCOPE_ACCESSOR";
-    readonly NETWORK_CONTEXT_ACCESSOR: "NETWORK_CONTEXT_ACCESSOR";
-    readonly USER_CONTEXT_FACTORY: "USER_CONTEXT_FACTORY";
-    readonly TRANSACTION_STATE: "TRANSACTION_STATE";
+    readonly VALIDATOR_SERVICE: "VALIDATOR_SERVICE";
 }>;
 
 /**
@@ -1546,12 +1462,25 @@ interface HttpResponse<TData = unknown> {
      */
     readonly data: TData;
 }
+/**
+ * @description Represents the CookieOptions interface.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 interface CookieOptions {
+    /** @description The path for which the cookie is valid. Defaults to '/'. */
     path?: Optional<string>;
+    /** @description The value of the maximum age in seconds. If not specified, the cookie will expire when the browser session ends. */
     maxAge?: Optional<number>;
-    sameSite?: Optional<'lax' | 'strict' | 'none' | boolean>;
-    secure?: boolean;
+    /** @description The domain for which the cookie is valid. Defaults to the domain of the current document host. */
     domain?: Optional<string>;
+    /** @description Whether the cookie is only transmitted over secure (HTTPS) connections. Defaults to true in production. */
+    secure?: Optional<boolean>;
+    /** @description Controls whether the cookie is withheld on cross-site requests, providing some protection against cross-site request forgery attacks. */
+    sameSite?: Optional<'lax' | 'strict' | 'none' | boolean>;
 }
 
 /**
@@ -2721,10 +2650,10 @@ declare const GuidHelper: Readonly<{
    */
 declare const HttpHelper: Readonly<{
     /**
-      * @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.
-      */
+     * @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.
+     */
     readonly maskIp: (ip: Optional<string>) => Optional<string>;
     /**
      * @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.
@@ -3038,17 +2967,118 @@ declare const StringHelper: Readonly<{
     readonly getSingleValueWithSplit: (value: string, separator: string) => string;
 }>;
 
+/**
+ * The ValueObject class is an abstract implementation of the IValueObject interface, providing a base class for creating value objects in the domain. A value object is an immutable type that represents a concept or measurement in the domain, and its equality is based on its properties rather than its identity. The ValueObject class includes a constructor that initializes the properties of the value object and an equals method that compares two value objects for equality based on their properties.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+declare abstract class ValueObject<T extends object> implements IValueObject<T> {
+    /** @description The properties of the value object, which are immutable and define the value represented by the value object.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    protected readonly _props: T;
+    protected constructor(props: T);
+    equals(vo?: Optional<IValueObject<T>>): boolean;
+    getValue(): T;
+    toString(): string;
+}
+
+/**
+ * @description AggregateRoot is an abstract class that represents the base class for all aggregate roots in the application. An aggregate root is the root entity of an aggregate, which is a group of related entities and value objects that are treated as a single unit. The AggregateRoot class provides common functionality for managing the state and behavior of aggregate roots, including methods for adding and retrieving uncommitted events, and methods for applying events to the aggregate.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ */
+declare abstract class AggregateRoot<TEvent = unknown, TValueObject extends object = object> {
+    readonly id: IValueObject<TValueObject>;
+    private _version;
+    private readonly _uncommittedEvents;
+    /**
+     * @description Constructs a new instance of the AggregateRoot class with the specified ID.
+     * @param {IValueObject<TValueObject>} id - The ID of the aggregate.
+     */
+    constructor(id: IValueObject<TValueObject>);
+    /**
+     * @description Gets the current version of the aggregate.
+     * @returns {number} The current version of the aggregate.
+     */
+    get version(): number;
+    /**
+     * @description Gets the uncommitted events of the aggregate.
+     * @returns {readonly IDomainEvent[]} The uncommitted events of the aggregate.
+     */
+    getUncommittedEvents(): readonly IDomainEvent<TEvent, IValueObject<TValueObject>>[];
+    /**
+     * @description Clears the uncommitted events of the aggregate.
+     */
+    clearUncommittedEvents(): void;
+    /**
+     * @description Loads the aggregate from a history of domain events.
+     * @param {IDomainEvent<TEvent, IValueObject<TValueObject>>[]} history - The history of domain events to load.
+     */
+    loadFromHistory(history: IDomainEvent<TEvent, IValueObject<TValueObject>>[]): void;
+    /**
+     * @description Raises a domain event and adds it to the uncommitted events list.
+     * @param {Omit<IDomainEvent<TEvent, IValueObject<TValueObject>>, 'aggregateId' | 'version' | 'occurredAt'>} eventData - The data of the domain event to raise.
+     */
+    protected raise(eventData: Omit<IDomainEvent<TEvent, IValueObject<TValueObject>>, 'aggregateId' | 'version' | 'occurredAt'>): void;
+    /**
+     * @description Applies a domain event to the aggregate root.
+     * @param {IDomainEvent<TEvent, IValueObject<TValueObject>>} event - The domain event to apply.
+     * @param {boolean} isNew - Indicates whether the event is new or already committed.
+     */
+    protected abstract apply(event: IDomainEvent<TEvent, IValueObject<TValueObject>>, isNew: boolean): void;
+}
+
+/**
+ * @description Configuration options for the authentication service.
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 interface AuthConfig<TOptions = unknown> {
+    /**
+     * @description The URL of the authentication service.
+     * @type {string}
+     */
     url: string;
+    /**
+     * @description The key of the authentication service.
+     * @type {string}
+     */
     key: string;
+    /**
+     * @description The options of the authentication service.
+     * @type {TOptions}
+     */
     opts: Optional<TOptions>;
-    storageOpts: {
-        type: Optional<'local' | 'session' | 'memory' | 'cookie'>;
-        cookieOpts: Optional<CookieOptions>;
-        storage: Optional<IStorage>;
-    };
+    /**
+     * @description The storage options of the authentication service.
+     * @type {StorageOptions}
+     * @default { type: 'local', cookieOpts: {}, storage: null }
+     */
+    storageOpts: Optional<StorageOptions>;
+    /**
+     * @description The redirect URL of the authentication service.
+     * @type {string}
+     * @default '/'
+     */
     redirectTo: Optional<string>;
 }
+interface StorageOptions {
+    type: Optional<'local' | 'session' | 'memory' | 'cookie'>;
+    cookieOpts: Optional<CookieOptions>;
+    storage: Optional<IStorage>;
+}
 
 /** @description Configuration for Redis integration, including details such as host, port, and credentials. If enabled, the query bus and command bus (in case of idempotency) pipelines will use Redis as the cache system to store and retrieve data efficiently. The configuration includes specific details for Redis integration, such as host, port, and credentials, providing flexibility in how the cache is implemented and used within the application.
  *
@@ -5298,18 +5328,16 @@ interface IRepository<T> {
 /**
  * @description IAuthService defines the contract for authentication services.
  * It provides methods to check if a user is authenticated and to retrieve the user's claims.
-
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 interface IBaseAuthService {
     /**
      * Checks if the user is authenticated.
      * @returns A promise that resolves to true if the user is authenticated, false otherwise.
-    
      *
      * @author Xeno
      * @version 1.0.0
@@ -5318,14 +5346,19 @@ interface IBaseAuthService {
      */
     isAuthenticated(): Promise<boolean>;
     /**
-     * Restituisce l'utente attualmente autenticato.
+     * Retrieves the user's claims.
+     * @returns A promise that resolves to the user's claims, or null if not authenticated.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
      */
     getUser(): Promise<ResultType<Maybe<AuthClaims>>>;
     /**
      * Authenticates a user based on a token.
      * @param token The token to authenticate the user.
      * @returns A promise that resolves to the user's claims, or null if not authenticated.
-    
      *
      * @author Xeno
      * @version 1.0.0
@@ -5346,22 +5379,38 @@ interface IBaseAuthService {
    */
 interface IAuthService {
     /**
-     * Avvia il flusso di autenticazione OAuth con un provider esterno (es. Google).
+     * Signs in a user by the specified provider.
+     * @param provider The provider to use for signing in the user.
+     * @returns A promise that resolves to the URL for the specified provider.
      */
     signInWithProvider(provider: Provider): Promise<ResultType<{
         url: string;
     }>>;
     /**
-     * Restituisce la sessione corrente attiva salvata nel client Supabase.
+     * @description Gets the current session of the user.
+     * @returns A promise that resolves to the current session of the user.
      */
     getSession(): Promise<ResultType<Maybe<Session>>>;
     /**
-     * Esegue il logout dell'utente e pulisce la sessione locale.
+     * @description Signs out the user.
+     * @returns A promise that resolves when the user is signed out.
      */
     signOut(): Promise<ResultType<void>>;
+    /**
+     * @description Exchanges the code for a session.
+     * @param code the code to exchange for a session
+     * @returns A promise that resolves to the session wit
+     */
     exchangeCodeForSession(code: string): Promise<ResultType<Optional<Session>>>;
 }
-interface IExtendendService extends IBaseAuthService, IAuthService {
+/**
+ * @description An extended version of the IAuthService interface that includes additional methods for managing user sessions.
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+interface IExtendendAuthService extends IBaseAuthService, IAuthService {
 }
 
 /**
@@ -5784,81 +5833,25 @@ declare abstract class Entity<T> implements IEntity<T> {
 }
 
 /**
- * The IValueObject interface defines the contract for value objects in the domain. A value object is an immutable type that represents a concept or measurement in the domain, and its equality is based on its properties rather than its identity. The IValueObject interface includes methods for retrieving the underlying value, comparing value objects for equality, and providing a string representation of the value object.
-
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-interface IValueObject<T extends object> {
-    /**
-     * Retrieves the underlying value of the value object. This method provides access to the encapsulated data, allowing it to be used in comparisons, transformations, or other operations while maintaining the integrity and immutability of the value object.
-     * @returns The underlying value of the value object.
-    
-     *
-     * @author Xeno
-     * @version 1.0.0
-     * @since 2025-09-30
-     * @link https://github.com/xeno-js/xeno-js
-     */
-    getValue(): T;
-    /**
-     * Compares the current value object with another value object for equality. This method checks if the underlying values of both value objects are equal, allowing for meaningful comparisons between value objects based on their encapsulated data rather than their reference identity.
-     * @param other The other value object to compare with the current value object.
-     * @returns True if the underlying values of both value objects are equal; otherwise, returns false.
-    
-     *
-     * @author Xeno
-     * @version 1.0.0
-     * @since 2025-09-30
-     * @link https://github.com/xeno-js/xeno-js
-     */
-    equals(other: IValueObject<T>): boolean;
-    /**
-     * Returns a string representation of the value object. This method can be used for debugging, logging, or any scenario where a human-readable representation of the value object is needed. The string representation should ideally include relevant information about the underlying value to provide context when the value object is printed or logged.
-     * @returns A string representation of the value object.
-    
-     *
-     * @author Xeno
-     * @version 1.0.0
-     * @since 2025-09-30
-     * @link https://github.com/xeno-js/xeno-js
-     */
-    toString(): string;
-}
-
-/**
- * The ValueObject class is an abstract implementation of the IValueObject interface, providing a base class for creating value objects in the domain. A value object is an immutable type that represents a concept or measurement in the domain, and its equality is based on its properties rather than its identity. The ValueObject class includes a constructor that initializes the properties of the value object and an equals method that compares two value objects for equality based on their properties.
-
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
-declare abstract class ValueObject<T extends object> implements IValueObject<T> {
-    /** @description The properties of the value object, which are immutable and define the value represented by the value object.
-     *
-     * @author Xeno
-     * @version 1.0.0
-     * @since 2025-09-30
-     * @link https://github.com/xeno-js/xeno-js
-     */
-    protected readonly _props: T;
-    protected constructor(props: T);
-    equals(vo?: Optional<IValueObject<T>>): boolean;
-    getValue(): T;
-    toString(): string;
-}
-
+ * @description Base class for all commands.
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 declare abstract class Command<TResponse = unknown> implements ICommand<TResponse> {
     readonly intent: string;
     readonly type: RequestType;
     constructor(intent: string);
 }
 
+/**
+ * @description Base class for all queries.
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 declare abstract class Query<TResponse = unknown> implements IQuery<TResponse> {
     readonly intent: string;
     readonly cacheOptions: ICacheableOptions;
@@ -5868,13 +5861,12 @@ declare abstract class Query<TResponse = unknown> implements IQuery<TResponse> {
 
 /**
  * @description Concrete implementation of the ILogger interface that serves as a central logging service within the application. This class is designed to broadcast log messages to multiple logging clients (implementations of ILoggerClient) that are injected via the constructor. The BaseLogger class provides methods for logging messages at different levels (info, warn, debug, error) and ensures that only messages that meet or exceed the specified minimum log level are forwarded to the registered logging clients. This design allows for flexibility in logging, enabling the use of various logging providers (e.g., Sentry, Pino) without coupling the application code to specific logging frameworks.
-
-   *
-   * @author Xeno
-   * @version 1.0.0
-   * @since 2025-09-30
-   * @link https://github.com/xeno-js/xeno-js
-   */
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
 declare class BaseLogger implements ILogger {
     private readonly _requestContext;
     private readonly _minLevel;
@@ -5884,7 +5876,6 @@ declare class BaseLogger implements ILogger {
      * @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
@@ -5902,7 +5893,6 @@ declare class BaseLogger implements ILogger {
      * @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
@@ -6118,4 +6108,4 @@ declare class ZodValidatorService implements IValidatorService {
     validate<T>(key: string, data: T): Promise<ResultType<boolean>>;
 }
 
-export { AbortSignalHelper, type AbstractConstructor, type ApiResponseDto, AppError, type AsyncFactory, type AsyncResolver, type AuthClaims, type AuthConfig, type AuthPolicy, AxiosFactory, AxiosHttpClient, BaseLogger, type CacheClientConfig, type CacheConfig, CacheKeyBuilder, Command, type Constructor, type CookieOptions, DEFAULT_CONCURRENCY, DateHelper, type DbConfig, type Delegate, type Dictionary, ERROR_CODES, ERROR_CODE_MESSAGES, Entity, Enumerable, type ErrorCode, type ErrorResponseDto, type Factory, GUEST, Guards, type Guid, GuidHelper, type HttpBaseRequest, type HttpClientConfig, type HttpHeaders, HttpHelper, type HttpMethod, type HttpOptions, type HttpQueryValue, type HttpRequest, type HttpResponse, type HttpResponseType, type IAuthService, type IBaseAccessor, type IBaseAuthService, type IBaseMapper, type ICache, type ICacheKeyBuilder, type ICacheableOptions, type ICommand, type IConcurrencyService, type IConfigurationService, type IContextAccessor, type IController, IDEMPOTENCY_CONSTANTS, type IDisposable, type IEntity, type IExtendendService, type IFactory, type IGateKeeper, type IHandler, type IHttpClient, type IIdempotencyStore, type IIdentityAccessor, type ILogger, type ILoggerClient, type IMapper, type IMediator, type IMiddleware, type INetworkContextAccessor, type IPaginatedResult, type IPipelineBehavior, type IPolicyRegistry, type IQuery, type IReadDao, type IReadDataSource, type IRemoteDataSource, type IRepository, type IRequest, type IServiceExtractor, type IServiceResilience, type ISpecification, type IStorage, type IStrategy, type ITransactionState, type IUnitOfWork, type IValidatorService, type IValueObject, type IWriteDataSource, type Identity, InMemoryCache, type InjectionToken, type KeysOfType, LOG_LEVEL, LOG_LEVEL_NAMES, type LogLevel, type LoggerContext, LoggerUtils, MathHelper, type Maybe, type MessageSequence, type MessagingContext, type Metadata, type NetworkContext, type Nullable, type Optional, type Override, PAGINATION_DEFAULTS, PERMISSIONS, type Permission, PromiseHelper, type Provider, type ProxyConfig, Query, REQUEST_TYPE, RESILIENCE_DEFAULTS, ROLES, type RequestContext, type RequestType, type RequireKeys, type Resolver, type ResponseDto, Result, type ResultType, type Role, SORT_DIRECTION, STATUS_CODES, SanitizeHelper, type Session, type SetupAction, type SortDirection, type StatusCode, StorageHelper, StringHelper, type SuccessResponseDto, SupabaseAuthService, SupabaseClaimsMapper, SupabaseSessionMapper, TOKENS, type TracingContext, UniqueId, type UserContext, ValueObject, ZodUtils, ZodValidatorService };
+export { AbortSignalHelper, type AbstractConstructor, AggregateRoot, type ApiResponseDto, AppError, type AsyncFactory, type AsyncResolver, type AuthClaims, type AuthConfig, type AuthPolicy, AxiosFactory, AxiosHttpClient, BaseLogger, type CacheClientConfig, type CacheConfig, CacheKeyBuilder, Command, type Constructor, type CookieOptions, DEFAULT_CONCURRENCY, DateHelper, type DbConfig, type Delegate, type Dictionary, ERROR_CODES, ERROR_CODE_MESSAGES, Entity, Enumerable, type ErrorCode, type ErrorResponseDto, type Factory, GUEST, Guards, type Guid, GuidHelper, type HttpBaseRequest, type HttpClientConfig, type HttpHeaders, HttpHelper, type HttpMethod, type HttpOptions, type HttpQueryValue, type HttpRequest, type HttpResponse, type HttpResponseType, type IAuthService, type IBaseAccessor, type IBaseAuthService, type IBaseMapper, type ICache, type ICacheKeyBuilder, type ICacheableOptions, type ICommand, type IConcurrencyService, type IConfigurationService, type IContextAccessor, type IController, IDEMPOTENCY_CONSTANTS, type IDisposable, type IDomainEvent, type IEntity, type IExtendendAuthService, type IFactory, type IGateKeeper, type IHandler, type IHttpClient, type IIdempotencyStore, type IIdentityAccessor, type ILogger, type ILoggerClient, type IMapper, type IMediator, type IMiddleware, type INetworkContextAccessor, type IPaginatedResult, type IPipelineBehavior, type IPolicyRegistry, type IQuery, type IReadDao, type IReadDataSource, type IRemoteDataSource, type IRepository, type IRequest, type IServiceExtractor, type IServiceResilience, type ISpecification, type IStorage, type IStrategy, type ITransactionState, type IUnitOfWork, type IValidatorService, type IValueObject, type IWriteDataSource, type Identity, InMemoryCache, type InjectionToken, type KeysOfType, LOG_LEVEL, LOG_LEVEL_NAMES, type LogLevel, type LoggerContext, LoggerUtils, MathHelper, type Maybe, type MessageSequence, type MessagingContext, type Metadata, type NetworkContext, type Nullable, type Optional, type Override, PAGINATION_DEFAULTS, PERMISSIONS, type Permission, PromiseHelper, type Provider, type ProxyConfig, Query, REQUEST_TYPE, RESILIENCE_DEFAULTS, ROLES, type RequestContext, type RequestType, type RequireKeys, type Resolver, type ResponseDto, Result, type ResultType, type Role, SORT_DIRECTION, STATUS_CODES, SanitizeHelper, type Session, type SetupAction, type SortDirection, type StatusCode, StorageHelper, StringHelper, type SuccessResponseDto, SupabaseAuthService, SupabaseClaimsMapper, SupabaseSessionMapper, TOKENS, type TracingContext, UniqueId, type UserContext, ValueObject, ZodUtils, ZodValidatorService };