@sentzunhat/zacatl 0.0.2 → 0.0.3

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sentzunhat/zacatl",
   "main": "src/index.ts",
   "module": "src/index.ts",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/sentzunhat/zacatl.git"

package/src/micro-service/architecture/infrastructure/repositories/abstract.ts

@@ -1,10 +1,8 @@
 import importedMongoose, {
   connection,
   Model,
-  Document,
   Mongoose,
   Schema,
-  Types,
 } from "mongoose";
 import { v4 as uuidv4 } from "uuid";
 import { container } from "tsyringe";
@@ -14,26 +12,23 @@ export type BaseRepositoryConfig<T> = {
   schema: Schema<T>;
 };
 
-export type TDocument<T> = Document<Types.ObjectId, {}, T> &
-  T & {
-    id: string;
-  };
-
-export type TRequiredId<T> = T & {
-  _id: Types.ObjectId;
+export type LeanDocument<T> = T & {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
 };
 
 export type Repository<T> = {
   model: Model<T>;
 
-  findById(id: string): Promise<TDocument<T> | null>;
-  create(entity: T): Promise<TDocument<T>>;
-  update(id: string, entity: Partial<T>): Promise<TDocument<T> | null>;
-  delete(id: string): Promise<TDocument<T> | null>;
+  findById(id: string): Promise<LeanDocument<T> | null>;
+  create(entity: T): Promise<LeanDocument<T>>;
+  update(id: string, update: Partial<T>): Promise<LeanDocument<T> | null>;
+  delete(id: string): Promise<LeanDocument<T> | null>;
 };
 
 export abstract class BaseRepository<T> implements Repository<T> {
-  public model: Model<T>;
+  public readonly model: Model<T>;
 
   constructor(config: BaseRepositoryConfig<T>) {
     const mongoose = connection.db?.databaseName
@@ -53,59 +48,51 @@ export abstract class BaseRepository<T> implements Repository<T> {
     this.model.init();
   }
 
-  /**
-   * Transforms a Mongoose document into a plain entity object.
-   */
-  protected toEntity(doc: TDocument<T>): TRequiredId<T> {
-    // We call the built-in toObject method and cast to T.
-    return doc.toObject<TDocument<T>>({ virtuals: true }) as TRequiredId<T>;
-  }
-
-  async findById(id: string): Promise<TDocument<T> | null> {
-    const foundEntity = await this.model.findById<TDocument<T>>(id).exec();
+  async findById(id: string): Promise<LeanDocument<T> | null> {
+    const entity = await this.model
+      .findById(id)
+      .lean<LeanDocument<T>>({ virtuals: true })
+      .exec();
 
-    if (!foundEntity) {
+    if (!entity) {
       return null;
     }
 
-    return foundEntity.toObject<TDocument<T>>({
-      virtuals: true,
-    });
+    return entity;
   }
 
-  async create(entity: T): Promise<TDocument<T>> {
-    const createdEntity = await this.model.create<TDocument<T>>(entity);
+  async create(entity: T): Promise<LeanDocument<T>> {
+    const doc = await this.model.create(entity);
 
-    return createdEntity.toObject<TDocument<T>>({
-      virtuals: true,
-    });
+    return doc.toObject<LeanDocument<T>>({ virtuals: true });
   }
 
-  async update(id: string, entity: Partial<T>): Promise<TDocument<T> | null> {
-    const updatedEntity = await this.model
-      .findByIdAndUpdate<TDocument<T>>(id, entity, { new: true })
+  async update(
+    id: string,
+    update: Partial<T>
+  ): Promise<LeanDocument<T> | null> {
+    const entity = await this.model
+      .findByIdAndUpdate(id, update, { new: true })
+      .lean<LeanDocument<T>>({ virtuals: true })
       .exec();
 
-    if (!updatedEntity) {
+    if (!entity) {
       return null;
     }
 
-    return updatedEntity.toObject<TDocument<T>>({
-      virtuals: true,
-    });
+    return entity;
   }
 
-  async delete(id: string): Promise<TDocument<T> | null> {
-    const deletedEntity = await this.model
-      .findByIdAndDelete<TDocument<T>>(id)
+  async delete(id: string): Promise<LeanDocument<T> | null> {
+    const entity = await this.model
+      .findByIdAndDelete(id)
+      .lean<LeanDocument<T>>({ virtuals: true })
       .exec();
 
-    if (!deletedEntity) {
+    if (!entity) {
       return null;
     }
 
-    return deletedEntity.toObject<TDocument<T>>({
-      virtuals: true,
-    });
+    return entity;
   }
 }