xcally-nest-library 0.0.4 → 0.0.6

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "",
   "license": "UNLICENSED",
   "scripts": {
+    "bump:patch": "npm version patch -m \"Bump version to %s\"",
     "prepublishOnly": "pnpm build",
     "build": "tsc",
     "build:watch": "rimraf dist && tsc-watch -b -v",

package/src/db/typeorm/generic.repository.ts

@@ -1,38 +1,52 @@
 import { Repository, EntityTarget, EntityManager, Equal, FindOptionsWhere, ObjectLiteral, DeepPartial } from 'typeorm';
-import { Injectable } from '@nestjs/common';
 import { PaginateConfig, PaginateQuery, Paginated, paginate } from 'nestjs-paginate';
 
 interface IId {
   id: number;
 }
 
-interface IGenericRepository<E> {
-  save<T extends DeepPartial<E>>(entity: T): Promise<E>;
-  update<T extends DeepPartial<E> & IId>(entity: T): Promise<E>;
-  count(options: FindOptionsWhere<E>): Promise<number>;
-  getMany(query: PaginateQuery): Promise<Paginated<E>>;
-}
-
-@Injectable()
-export class GenericRepository<E extends ObjectLiteral> implements IGenericRepository<E> {
+/**
+ * Represents a generic repository for managing entities.
+ */
+export class GenericRepository<E extends ObjectLiteral> {
   protected repository: Repository<E>;
   protected paginateConfig: PaginateConfig<E>;
+
   constructor(
-    readonly entityManager: EntityManager,
+    private readonly entityManager: EntityManager,
     entity: EntityTarget<E>,
     paginateConfig: PaginateConfig<E>,
   ) {
-    this.repository = entityManager.getRepository(entity);
+    this.repository = this.entityManager.getRepository(entity);
     this.paginateConfig = paginateConfig;
   }
+  /**
+   * Retrieves a paginated list of entities based on the provided query.
+   *
+   * @param query - The pagination query parameters.
+   * @returns A promise that resolves to a paginated list of entities.
+   */
   getMany(query: PaginateQuery): Promise<Paginated<E>> {
     return paginate(query, this.repository, this.paginateConfig);
   }
+  /**
+   * Saves an entity to the database.
+   *
+   * @param entity - The entity to be saved.
+   * @returns A promise that resolves to the saved entity.
+   */
   save<T extends DeepPartial<E>>(entity: T): Promise<E> {
     const res = this.repository.create({ ...entity });
     return this.repository.save(res);
   }
 
+  /**
+   * Updates an entity in the database.
+   *
+   * @param dto - The updated entity data.
+   * @returns A promise that resolves to the updated entity.
+   * @throws Error if the entity is not found.
+   */
   async update<T extends DeepPartial<E> & IId>(dto: T): Promise<E> {
     const entity = await this.repository.findOneBy({
       id: Equal(dto.id),
@@ -40,11 +54,40 @@ export class GenericRepository<E extends ObjectLiteral> implements IGenericRepos
     if (!entity) {
       throw new Error('Entity not found');
     }
-    const entityUpdated = await this.repository.save({ id: entity.id, ...dto });
-    return Object.assign(entity, entityUpdated);
+    return this.repository.save({ id: entity.id, ...dto });
   }
 
+  /**
+   * Counts the number of entities that match the provided options.
+   *
+   * @param options - The options to filter the entities.
+   * @returns A promise that resolves to the number of entities that match the options.
+   */
   count(options: FindOptionsWhere<E>): Promise<number> {
     return this.repository.count(options);
   }
+
+  /**
+   * Retrieves all entities from the database.
+   *
+   * @returns A promise that resolves to an array of entities.
+   */
+  findAll(): Promise<E[]> {
+    return this.repository.find();
+  }
+
+  /**
+   * Retrieves the total count of all entities in the database.
+   *
+   * @returns A promise that resolves to the total count of entities.
+   */
+  countAll(): Promise<number> {
+    return this.repository.count();
+  }
+
+  findById(id: number): Promise<E> {
+    return this.repository.findOneBy({
+      id: Equal(id),
+    } as unknown as FindOptionsWhere<E>);
+  }
 }