@abejarano/ts-mongodb-criteria 1.4.0 → 1.5.0

package/README.md

@@ -147,19 +147,39 @@ const criteria = new Criteria(
 
 // 3. Use with your MongoDB repository
 class UserRepository extends MongoRepository<User> {
+  constructor() {
+    super(User)
+  }
+
   collectionName(): string {
     return "users"
   }
 }
 
 const userRepo = new UserRepository()
-const users = await userRepo.searchByCriteria(criteria)
+const { results } = await userRepo.list(criteria)
 ```
 
 MongoRepository provides ready-to-use public methods for repositories that extend it:
 - `list(criteria, fieldsToExclude?)` for paginated queries
 - `one(filter)` to fetch a single entity
 - `upsert(entity)` to persist an aggregate
+Internal helpers are private, so repositories should call these public methods
+directly.
+
+If you need a repository interface in your app, extend `IRepository<T>` so your
+custom interfaces stay aligned with the library return types:
+
+```typescript
+import { IRepository } from "@abejarano/ts-mongodb-criteria"
+
+export interface IUserRepository extends IRepository<User> {
+  // Add domain-specific methods here
+}
+```
+
+The goal of `IRepository` is to prevent signature drift (e.g. `upsert` returning
+`void` in your app while the base repository returns `ObjectId | null`).
 
 **Your First Query in 30 Seconds:**
 

package/dist/cjs/mongo/IRepository.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/mongo/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./MongoCriteriaConverter"), exports);
 __exportStar(require("./MongoRepository"), exports);
+__exportStar(require("./IRepository"), exports);
 __exportStar(require("./MongoClientFactory"), exports);

package/dist/esm/mongo/IRepository.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/mongo/index.js

@@ -1,3 +1,4 @@
 export * from "./MongoCriteriaConverter";
 export * from "./MongoRepository";
+export * from "./IRepository";
 export * from "./MongoClientFactory";

package/dist/types/mongo/IRepository.d.ts

@@ -0,0 +1,8 @@
+import { ObjectId } from "mongodb";
+import { Criteria, Paginate } from "../criteria";
+import { AggregateRoot } from "../AggregateRoot";
+export interface IRepository<T extends AggregateRoot> {
+    one(filter: object): Promise<T | null>;
+    list<D>(criteria: Criteria, fieldsToExclude?: string[]): Promise<Paginate<D>>;
+    upsert(entity: T): Promise<ObjectId | null>;
+}

package/dist/types/mongo/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./MongoCriteriaConverter";
 export * from "./MongoRepository";
+export * from "./IRepository";
 export * from "./MongoClientFactory";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@abejarano/ts-mongodb-criteria",
   "author": "angel bejarano / angel.bejarano@jaspesoft.com",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Patrón Criteria para consultas MongoDB en TypeScript",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",