Merge pull request #23 from stbestichhh/22-add-findandcountall

stbestichhh · web-flow · commit 5b43774a4db3 · 2025-09-09T10:58:42.000+03:00
feat: reduced package size, add new findAllPaginated method
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# Patch 0.1.10
+### Added:
+* New method for find with pagination `findAllPaginated`
+
+### Changed:
+* Now default auto generated id is type of UUIDv4 instead of v7, what helped to reduce package size 
+
 # Patch 0.1.9
 ### Fixed:
 * `deletedAt` property is null on force delete
diff --git a/README.md b/README.md
@@ -115,7 +115,7 @@ You can pass options when instantiating:
 {
   autoGenerateId: true,                 // optional
   idField: 'user_id',                   // optional, default field is 'id'  
-  idGenerator: myGenerateIdFunc;        // optional, default is v7 from 'uuid' package
+  idGenerator: myGenerateIdFunc,        // optional, default is UUIDv4
   logger: new MyCustomLogger('MyRepo'), // optional
 }
 ```
diff --git a/SECURITY.md b/SECURITY.md
@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 |---------|--------------------|
+| 0.1.10  | :white_check_mark: |
 | 0.1.9   | :white_check_mark: |
 | 0.1.8   | :white_check_mark: |
 | 0.1.7   | :white_check_mark: |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nest-sequelize-repository",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Abstract repository for Nest and Sequelize.js ORM",
   "keywords": [
     "sequelize.js",
@@ -54,11 +54,7 @@
     "sqlite3": "^5.1.7",
     "ts-jest": "^29.3.2",
     "tsx": "^4.19.3",
-    "typescript": "^5.8.3",
-    "uuid": "^11.1.0"
-  },
-  "dependencies": {
-    "uuid": "^11.1.0"
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "@nestjs/common": "11.x",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/IRepository.ts b/src/IRepository.ts
@@ -3,6 +3,7 @@ import {
   BulkCreateOptions,
   CreateOptions,
   CreationAttributes,
+  FindAndCountOptions,
   FindOptions,
   InstanceDestroyOptions,
   InstanceRestoreOptions,
@@ -37,6 +38,15 @@ export interface IRepository<TModel extends Model> {
     query?: WhereOptions<Attributes<TModel>>,
     options?: Omit<FindOptions<Attributes<TModel>>, 'where'>,
   ): Promise<TModel[]>;
+  findAllPaginated(
+    limit: number,
+    offset?: number,
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<
+      FindAndCountOptions<Attributes<TModel>>,
+      'where' | 'offset' | 'limit'
+    >,
+  ): Promise<{ rows: TModel[]; count: number }>;
   updateByPk(
     primaryKey: string | number,
     dto: Partial<Attributes<TModel>>,
diff --git a/src/abstract.repository.ts b/src/abstract.repository.ts
@@ -10,19 +10,20 @@ import {
   InstanceDestroyOptions,
   InstanceRestoreOptions,
   BulkCreateOptions,
+  FindAndCountOptions,
 } from 'sequelize';
 import { IRepository } from './IRepository';
 import { Model, ModelCtor } from 'sequelize-typescript';
 import { IRepositoryOptions } from './IRepositoryOptions';
-import { v7 as uuidv7 } from 'uuid';
+import { randomUUID } from 'crypto';
 
 export class AbstractRepository<TModel extends Model>
   implements IRepository<TModel>
 {
   protected readonly logger: Logger;
   protected readonly autoGenerateId: boolean;
   protected readonly idField: string;
-  protected readonly idGenerator: () => string;
+  protected readonly idGenerator: () => string | number;
 
   constructor(
     protected readonly model: ModelCtor<TModel>,
@@ -32,7 +33,7 @@ export class AbstractRepository<TModel extends Model>
       autoGenerateId = false,
       idField = 'id',
       logger = new Logger(this.constructor.name),
-      idGenerator = uuidv7,
+      idGenerator = randomUUID,
     } = options;
 
     if (new.target === AbstractRepository) {
@@ -137,6 +138,28 @@ export class AbstractRepository<TModel extends Model>
     }
   }
 
+  public async findAllPaginated(
+    limit: number,
+    offset: number = 0,
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<
+      FindAndCountOptions<Attributes<TModel>>,
+      'where' | 'offset' | 'limit'
+    >,
+  ): Promise<{ rows: TModel[]; count: number }> {
+    try {
+      return await this.model.findAndCountAll({
+        where: query,
+        limit,
+        offset,
+        ...options,
+      });
+    } catch (error) {
+      this.logger.error(`findAllPaginated: ${error}`);
+      throw new InternalServerErrorException();
+    }
+  }
+
   public async updateByPk(
     primaryKey: string | number,
     dto: Partial<Attributes<TModel>>,
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -36,10 +36,11 @@ export interface IRepositoryOptions<T extends Model> {
   /**
    * Function responsible for generating unique IDs when `autoGenerateId` is true.
    *
-   * @default v7 from 'uuid'
+   * @default UUIDv4 from 'node:crypto' package
    * @returns string
+   * @returns number
    */
-  idGenerator?: () => string;
+  idGenerator?: () => string | number;
 
   /**
    * Optional NestJS logger instance used for internal logging
@@ -126,6 +127,25 @@ export interface IRepository<TModel extends Model> {
     options?: Omit<FindOptions<Attributes<TModel>>, 'where'>,
   ): Promise<TModel[]>;
 
+  /**
+   * Find first amount of records set by limit and count all existing records
+   *
+   * @param limit Amout of records to find and return.
+   * @param offset Amout of records to skip.
+   * @param query A Sequelize where clause.
+   * @param options Optional Sequelize find options, excluding `where`.
+   * @returns A Promise resolving `rows`(found records) and `count`(amout of existing records).
+   */
+  findAllPaginated(
+    limit: number,
+    offset?: number,
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<
+      FindAndCountOptions<Attributes<TModel>>,
+      'where' | 'offset' | 'limit'
+    >,
+  ): Promise<{ rows: TModel[]; count: number }>;
+
   /**
    * Updates a records by its primary key.
    *
@@ -202,7 +222,7 @@ export declare class AbstractRepository<TModel extends Model>
   /**
    * Function responsible for generating unique IDs when `autoGenerateId` is true.
    */
-  protected readonly idGenerator: () => string;
+  protected readonly idGenerator: () => string | number;
 
   /**
    * Constructs the abstract repository.
diff --git a/src/index.ts b/src/index.ts
@@ -10,14 +10,15 @@ import {
   InstanceDestroyOptions,
   InstanceRestoreOptions,
   BulkCreateOptions,
+  FindAndCountOptions,
 } from 'sequelize';
 import { Model, ModelCtor } from 'sequelize-typescript';
-import { v7 as uuidv7 } from 'uuid';
+import { randomUUID } from 'crypto';
 
 export interface IRepositoryOptions<T extends Model> {
   autoGenerateId?: boolean;
   idField?: Extract<keyof Attributes<T>, string>;
-  idGenerator?: () => string;
+  idGenerator?: () => string | number;
   logger?: Logger;
 }
 
@@ -46,6 +47,15 @@ export interface IRepository<TModel extends Model> {
     query?: WhereOptions<Attributes<TModel>>,
     options?: Omit<FindOptions<Attributes<TModel>>, 'where'>,
   ): Promise<TModel[]>;
+  findAllPaginated(
+    limit: number,
+    offset?: number,
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<
+      FindAndCountOptions<Attributes<TModel>>,
+      'where' | 'offset' | 'limit'
+    >,
+  ): Promise<{ rows: TModel[]; count: number }>;
   updateByPk(
     primaryKey: string | number,
     dto: Partial<Attributes<TModel>>,
@@ -70,7 +80,7 @@ export class AbstractRepository<TModel extends Model>
   protected readonly logger: Logger;
   protected readonly autoGenerateId: boolean;
   protected readonly idField: string;
-  protected readonly idGenerator: () => string;
+  protected readonly idGenerator: () => string | number;
 
   constructor(
     protected readonly model: ModelCtor<TModel>,
@@ -80,7 +90,7 @@ export class AbstractRepository<TModel extends Model>
       autoGenerateId = false,
       idField = 'id',
       logger = new Logger(this.constructor.name),
-      idGenerator = uuidv7,
+      idGenerator = randomUUID,
     } = options;
 
     if (new.target === AbstractRepository) {
@@ -185,6 +195,28 @@ export class AbstractRepository<TModel extends Model>
     }
   }
 
+  public async findAllPaginated(
+    limit: number,
+    offset: number = 0,
+    query?: WhereOptions<Attributes<TModel>>,
+    options?: Omit<
+      FindAndCountOptions<Attributes<TModel>>,
+      'where' | 'offset' | 'limit'
+    >,
+  ): Promise<{ rows: TModel[]; count: number }> {
+    try {
+      return await this.model.findAndCountAll({
+        where: query,
+        limit,
+        offset,
+        ...options,
+      });
+    } catch (error) {
+      this.logger.error(`findAllPaginated: ${error}`);
+      throw new InternalServerErrorException();
+    }
+  }
+
   public async updateByPk(
     primaryKey: string | number,
     dto: Partial<Attributes<TModel>>,
diff --git a/test/abstract.repository.spec.ts b/test/abstract.repository.spec.ts
@@ -194,4 +194,12 @@ describe('UserRepository', () => {
 
     expect(result.id).toBeDefined();
   });
+
+  it('should find all with pagination', async () => {
+    const allRecords = await userRepo.findAll();
+    const paginated = await userRepo.findAllPaginated(allRecords.length);
+
+    expect(paginated.rows.length).toBe(allRecords.length);
+    expect(paginated.count).toBe(allRecords.length);
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ You can pass options when instantiating:`
`115`	`115`	`{`
`116`	`116`	`autoGenerateId: true, // optional`
`117`	`117`	`idField: 'user_id', // optional, default field is 'id'`
`118`		`- idGenerator: myGenerateIdFunc; // optional, default is v7 from 'uuid' package`
	`118`	`+ idGenerator: myGenerateIdFunc, // optional, default is UUIDv4`
`119`	`119`	`logger: new MyCustomLogger('MyRepo'), // optional`
`120`	`120`	`}`
`121`	`121`	```