@gravito/enterprise 1.0.2 → 1.0.3

package/dist/index.d.mts

@@ -28,11 +28,32 @@ interface QueryHandler<TQuery extends Query, TResult> {
     handle(query: TQuery): Promise<TResult>;
 }
 
+/**
+ * Abstract base class for Application Use Cases.
+ *
+ * Use cases encapsulate specific business operations and orchestrate the flow
+ * of data between the domain and infrastructure layers.
+ *
+ * @template TInput - The type of input data required by the use case.
+ * @template TOutput - The type of data returned by the use case.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class UseCase<TInput, TOutput> {
     constructor();
     abstract execute(input: TInput): Promise<TOutput> | TOutput;
 }
 
+/**
+ * Base class for all Domain Events.
+ *
+ * Domain events represent something that happened in the domain that is
+ * relevant to other parts of the system or external services.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class DomainEvent {
     readonly occurredOn: Date;
     readonly eventId: string;
@@ -40,6 +61,17 @@ declare abstract class DomainEvent {
     get eventName(): string;
 }
 
+/**
+ * Abstract base class for Domain Entities.
+ *
+ * Entities are objects that have a unique identity that persists over time,
+ * even if their attributes change.
+ *
+ * @template TId - The type of the entity's unique identifier.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class Entity<TId> {
     protected readonly _id: TId;
     constructor(id: TId);
@@ -59,14 +91,75 @@ declare abstract class AggregateRoot<TId> extends Entity<TId> {
     clearDomainEvents(): void;
 }
 
+/**
+ * Generic Repository interface following Domain-Driven Design (DDD) principles.
+ *
+ * Repositories provide a collection-like interface for accessing and persisting
+ * domain entities. They abstract the underlying data storage mechanism.
+ *
+ * @template TEntity - The type of the Entity managed by the repository.
+ * @template TId - The type of the Entity's unique identifier.
+ *
+ * @example
+ * ```typescript
+ * class UserRepository implements Repository<User, string> {
+ *   async save(user: User): Promise<void> { ... }
+ *   async findById(id: string): Promise<User | null> { ... }
+ *   // ...
+ * }
+ * ```
+ *
+ * @public
+ * @since 3.0.0
+ */
 interface Repository<TEntity extends Entity<TId>, TId> {
+    /**
+     * Persist an entity to the underlying storage.
+     *
+     * @param entity - The entity to save.
+     * @returns A promise that resolves when the save operation is complete.
+     */
     save(entity: TEntity): Promise<void>;
+    /**
+     * Find an entity by its unique identifier.
+     *
+     * @param id - The unique identifier of the entity.
+     * @returns A promise that resolves to the entity if found, or null otherwise.
+     */
     findById(id: TId): Promise<TEntity | null>;
+    /**
+     * Retrieve all entities of this type.
+     *
+     * @returns A promise that resolves to an array of all entities.
+     */
     findAll(): Promise<TEntity[]>;
+    /**
+     * Delete an entity by its unique identifier.
+     *
+     * @param id - The unique identifier of the entity to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
     delete(id: TId): Promise<void>;
+    /**
+     * Determine if an entity with the given identifier exists.
+     *
+     * @param id - The unique identifier to check.
+     * @returns A promise that resolves to true if the entity exists, false otherwise.
+     */
     exists(id: TId): Promise<boolean>;
 }
 
+/**
+ * Abstract base class for Domain Value Objects.
+ *
+ * Value objects are objects that have no conceptual identity. They are defined
+ * solely by their attributes and are considered immutable.
+ *
+ * @template T - The type of the properties held by the value object.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class ValueObject<T> {
     protected readonly props: T;
     constructor(props: T);

package/dist/index.d.ts

@@ -28,11 +28,32 @@ interface QueryHandler<TQuery extends Query, TResult> {
     handle(query: TQuery): Promise<TResult>;
 }
 
+/**
+ * Abstract base class for Application Use Cases.
+ *
+ * Use cases encapsulate specific business operations and orchestrate the flow
+ * of data between the domain and infrastructure layers.
+ *
+ * @template TInput - The type of input data required by the use case.
+ * @template TOutput - The type of data returned by the use case.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class UseCase<TInput, TOutput> {
     constructor();
     abstract execute(input: TInput): Promise<TOutput> | TOutput;
 }
 
+/**
+ * Base class for all Domain Events.
+ *
+ * Domain events represent something that happened in the domain that is
+ * relevant to other parts of the system or external services.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class DomainEvent {
     readonly occurredOn: Date;
     readonly eventId: string;
@@ -40,6 +61,17 @@ declare abstract class DomainEvent {
     get eventName(): string;
 }
 
+/**
+ * Abstract base class for Domain Entities.
+ *
+ * Entities are objects that have a unique identity that persists over time,
+ * even if their attributes change.
+ *
+ * @template TId - The type of the entity's unique identifier.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class Entity<TId> {
     protected readonly _id: TId;
     constructor(id: TId);
@@ -59,14 +91,75 @@ declare abstract class AggregateRoot<TId> extends Entity<TId> {
     clearDomainEvents(): void;
 }
 
+/**
+ * Generic Repository interface following Domain-Driven Design (DDD) principles.
+ *
+ * Repositories provide a collection-like interface for accessing and persisting
+ * domain entities. They abstract the underlying data storage mechanism.
+ *
+ * @template TEntity - The type of the Entity managed by the repository.
+ * @template TId - The type of the Entity's unique identifier.
+ *
+ * @example
+ * ```typescript
+ * class UserRepository implements Repository<User, string> {
+ *   async save(user: User): Promise<void> { ... }
+ *   async findById(id: string): Promise<User | null> { ... }
+ *   // ...
+ * }
+ * ```
+ *
+ * @public
+ * @since 3.0.0
+ */
 interface Repository<TEntity extends Entity<TId>, TId> {
+    /**
+     * Persist an entity to the underlying storage.
+     *
+     * @param entity - The entity to save.
+     * @returns A promise that resolves when the save operation is complete.
+     */
     save(entity: TEntity): Promise<void>;
+    /**
+     * Find an entity by its unique identifier.
+     *
+     * @param id - The unique identifier of the entity.
+     * @returns A promise that resolves to the entity if found, or null otherwise.
+     */
     findById(id: TId): Promise<TEntity | null>;
+    /**
+     * Retrieve all entities of this type.
+     *
+     * @returns A promise that resolves to an array of all entities.
+     */
     findAll(): Promise<TEntity[]>;
+    /**
+     * Delete an entity by its unique identifier.
+     *
+     * @param id - The unique identifier of the entity to delete.
+     * @returns A promise that resolves when the deletion is complete.
+     */
     delete(id: TId): Promise<void>;
+    /**
+     * Determine if an entity with the given identifier exists.
+     *
+     * @param id - The unique identifier to check.
+     * @returns A promise that resolves to true if the entity exists, false otherwise.
+     */
     exists(id: TId): Promise<boolean>;
 }
 
+/**
+ * Abstract base class for Domain Value Objects.
+ *
+ * Value objects are objects that have no conceptual identity. They are defined
+ * solely by their attributes and are considered immutable.
+ *
+ * @template T - The type of the properties held by the value object.
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare abstract class ValueObject<T> {
     protected readonly props: T;
     constructor(props: T);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/enterprise",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Enterprise architecture primitives for Gravito framework (DDD/Clean Architecture)",
   "main": "dist/index.js",
   "module": "dist/index.mjs",