@nest-util/nest-crud 1.0.0 → 1.0.1

package/README.md

@@ -4,14 +4,12 @@ This library was generated with [Nx](https://nx.dev).
 
 ## Installation
 
-To install this library in your project, use the permanent URL from the latest GitHub Release:
+We recommend using **pnpm** as your package manager.
 
 ```bash
-pnpm add https://github.com/nigussolomon/nest-util/releases/download/latest/nest-util-nest-crud-0.1.1.tgz
+pnpm add @nest-util/nest-crud@^1.0.1 @nest-util/nest-auth@^1.0.1 typeorm@^1.1.0 @nestjs/typeorm @nestjs/swagger @nestjs/jwt @nestjs/passport class-validator class-transformer bcrypt
 ```
 
-> **Tip:** This tarball contains only the compiled code and its specific dependencies, making it as clean as a standard npm package.
-
 ## Features
 
 - Generic CRUD service with filtering, pagination, and sorting

package/dist/lib/testing/crud-controller.test-suites.d.ts

@@ -0,0 +1,4 @@
+import { ObjectLiteral } from 'typeorm';
+import { CrudControllerTestConfig, CrudTestContext } from './testing.interface';
+export declare function crudControllerTests<TEntity extends ObjectLiteral, TCreateDto, TUpdateDto, TResponseDto>(config: CrudControllerTestConfig<TEntity, TCreateDto, TUpdateDto, TResponseDto>): CrudTestContext;
+//# sourceMappingURL=crud-controller.test-suites.d.ts.map

package/dist/lib/testing/crud-controller.test-suites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-controller.test-suites.d.ts","sourceRoot":"","sources":["../../../src/lib/testing/crud-controller.test-suites.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAMxC,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGhF,wBAAgB,mBAAmB,CACjC,OAAO,SAAS,aAAa,EAC7B,UAAU,EACV,UAAU,EACV,YAAY,EAEZ,MAAM,EAAE,wBAAwB,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,GAC9E,eAAe,CAoNjB"}

package/dist/lib/testing/crud-controller.test-suites.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.crudControllerTests = crudControllerTests;
+const testing_1 = require("@nestjs/testing");
+const common_1 = require("@nestjs/common");
+const nest_crud_controller_1 = require("../controllers/nest-crud.controller");
+const mock_repository_1 = require("./mock-repository");
+function crudControllerTests(config) {
+    let controller;
+    let service;
+    let ControllerBase;
+    let moduleRef;
+    beforeEach(async () => {
+        service = {
+            disabledEndpoints: [],
+            findAll: jest.fn(),
+            findOne: jest.fn(),
+            create: jest.fn(),
+            update: jest.fn(),
+            remove: jest.fn(),
+            findAuditLogs: jest.fn(),
+            findMine: jest.fn(),
+        };
+        ControllerBase = config.controllerFactory();
+        class TestController extends ControllerBase {
+            constructor() {
+                super(service);
+            }
+        }
+        moduleRef = await testing_1.Test.createTestingModule({
+            controllers: [TestController],
+        }).compile();
+        controller = moduleRef.get(TestController);
+    });
+    describe('findAll', () => {
+        it('should call service.findAll with query params', async () => {
+            const query = { page: 1, limit: 10 };
+            const expected = { data: [], meta: { total: 0 } };
+            service.findAll.mockResolvedValue(expected);
+            const result = await controller.findAll(query);
+            expect(service.findAll).toHaveBeenCalledWith(query);
+            expect(result).toEqual(expected);
+        });
+        it('should handle pagination parameters', async () => {
+            const query = { page: 5, limit: 100 };
+            service.findAll.mockResolvedValue({ data: [] });
+            await controller.findAll(query);
+            expect(service.findAll).toHaveBeenCalledWith(expect.objectContaining({ page: 5, limit: 100 }));
+        });
+        it('should handle complex filter objects', async () => {
+            const query = {
+                filter: { name_cont: 'Alice', isActive_eq: 'true' },
+            };
+            service.findAll.mockResolvedValue({ data: [] });
+            await controller.findAll(query);
+            expect(service.findAll).toHaveBeenCalledWith(expect.objectContaining({
+                filter: { name_cont: 'Alice', isActive_eq: 'true' },
+            }));
+        });
+        it('should work with no query parameters', async () => {
+            service.findAll.mockResolvedValue({ data: [] });
+            await controller.findAll({});
+            expect(service.findAll).toHaveBeenCalledWith({});
+        });
+    });
+    describe('findOne', () => {
+        it('should call service.findOne with correct id', async () => {
+            const expectedResult = { id: 1, name: 'Test' };
+            service.findOne.mockResolvedValue(expectedResult);
+            const result = await controller.findOne(1);
+            expect(service.findOne).toHaveBeenCalledWith(1);
+            expect(result).toEqual(expectedResult);
+        });
+    });
+    describe('create', () => {
+        it('should call service.create with dto', async () => {
+            const dto = config.test.createPayload;
+            const expectedResult = { id: 1 };
+            service.create.mockResolvedValue(expectedResult);
+            const result = await controller.create(dto);
+            expect(service.create).toHaveBeenCalledWith(dto);
+            expect(result).toEqual(expectedResult);
+        });
+    });
+    describe('update', () => {
+        it('should call service.update with id and dto', async () => {
+            const dto = config.test.updatePayload;
+            const expectedResult = { id: 1 };
+            service.update.mockResolvedValue(expectedResult);
+            const result = await controller.update(1, dto);
+            expect(service.update).toHaveBeenCalledWith(1, dto);
+            expect(result).toEqual(expectedResult);
+        });
+    });
+    describe('remove', () => {
+        it('should call service.remove', async () => {
+            service.remove.mockResolvedValue(true);
+            const result = await controller.remove(1);
+            expect(service.remove).toHaveBeenCalledWith(1);
+            expect(result).toBe(true);
+        });
+    });
+    describe('findMine', () => {
+        it('should call service.findMine with user id', async () => {
+            const query = { page: 1, limit: 10 };
+            const expected = { data: [] };
+            service.findMine.mockResolvedValue(expected);
+            const mockUser = { id: 42 };
+            const result = await controller.findMine(mockUser, query);
+            expect(service.findMine).toHaveBeenCalledWith(42, query);
+            expect(result).toEqual(expected);
+        });
+    });
+    describe('disabledEndpoints', () => {
+        it('should block disabled endpoints', async () => {
+            service.disabledEndpoints = ['create'];
+            expect(() => controller.create({})).toThrow(common_1.NotFoundException);
+            expect(service.create).not.toHaveBeenCalled();
+        });
+    });
+    describe('findAuditLogs', () => {
+        it('should call service.findAuditLogs with query params', async () => {
+            const query = { page: 1, limit: 5, user_id: '1' };
+            const expected = { data: [], meta: { total: 0, page: 1, limit: 5 } };
+            service.findAuditLogs.mockResolvedValue(expected);
+            const result = await controller.findAuditLogs?.(query);
+            expect(service.findAuditLogs).toHaveBeenCalledWith(query);
+            expect(result).toEqual(expected);
+        });
+        it('should throw when audit logs endpoint is not available', () => {
+            service.findAuditLogs = undefined;
+            expect(() => controller.findAuditLogs?.({})).toThrow(common_1.NotFoundException);
+        });
+    });
+    describe('permissions', () => {
+        it('should attach auth permission metadata to configured handlers', () => {
+            if (!config.permissions)
+                return;
+            const PermissionedBase = config.controllerFactory();
+            class PermissionedCtrl extends PermissionedBase {
+                constructor() {
+                    super(service);
+                }
+            }
+            for (const [endpoint, permission] of Object.entries(config.permissions)) {
+                const method = PermissionedCtrl.prototype[endpoint];
+                if (!method)
+                    continue;
+                const metadata = Reflect.getMetadata(nest_crud_controller_1.AUTH_PERMISSIONS_METADATA_KEY, method);
+                const expected = Array.isArray(permission)
+                    ? permission
+                    : [permission];
+                expect(metadata).toEqual(expected);
+            }
+        });
+    });
+    const ctx = {
+        get module() {
+            return moduleRef;
+        },
+        repository: null,
+        createMockQb: mock_repository_1.createMockQb,
+    };
+    return ctx;
+}

package/dist/lib/testing/crud-service.test-suites.d.ts

@@ -0,0 +1,4 @@
+import { ObjectLiteral } from 'typeorm';
+import { CrudTestConfig, CrudTestContext } from './testing.interface';
+export declare function crudServiceTests<TEntity extends ObjectLiteral, TCreateDto, TUpdateDto, TResponseDto>(config: CrudTestConfig<TEntity, TCreateDto, TUpdateDto, TResponseDto>): CrudTestContext;
+//# sourceMappingURL=crud-service.test-suites.d.ts.map

package/dist/lib/testing/crud-service.test-suites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud-service.test-suites.d.ts","sourceRoot":"","sources":["../../../src/lib/testing/crud-service.test-suites.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAGtE,wBAAgB,gBAAgB,CAC9B,OAAO,SAAS,aAAa,EAC7B,UAAU,EACV,UAAU,EACV,YAAY,EACZ,MAAM,EAAE,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,eAAe,CAqVxF"}

package/dist/lib/testing/crud-service.test-suites.js

@@ -0,0 +1,279 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.crudServiceTests = crudServiceTests;
+const testing_1 = require("@nestjs/testing");
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const nest_crud_service_1 = require("../services/nest-crud.service");
+const mock_repository_1 = require("./mock-repository");
+function crudServiceTests(config) {
+    let service;
+    let repository;
+    let moduleRef;
+    let lastQb;
+    beforeEach(async () => {
+        repository = (0, mock_repository_1.createMockRepository)(config.entity, config.test.mockRepoOverrides);
+        const serviceOptions = {
+            repository,
+            allowedFilters: config.allowedFilters ?? [],
+            allowedSortFields: config.allowedSortFields ?? [],
+            include: config.include ?? [],
+            relations: config.relations ?? [],
+            toResponseDto: config.toResponseDto,
+            disabledEndpoints: config.disabledEndpoints ?? [],
+            hooks: config.hooks,
+            userOwnershipField: config.userOwnershipField,
+            findMineQuery: config.findMineQuery,
+        };
+        service = new nest_crud_service_1.NestCrudService(serviceOptions);
+        moduleRef = await testing_1.Test.createTestingModule({
+            providers: [
+                { provide: config.serviceClass, useValue: service },
+                { provide: (0, typeorm_1.getRepositoryToken)(config.entity), useValue: repository },
+            ],
+        }).compile();
+    });
+    describe('findAll', () => {
+        it('should return paginated data and meta', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const mockEntity = createMockEntity(config);
+            lastQb.getManyAndCount.mockResolvedValue([[mockEntity], 1]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findAll({ page: 1, limit: 10 });
+            expect(repository.createQueryBuilder).toHaveBeenCalledWith('e');
+            expect(lastQb.getManyAndCount).toHaveBeenCalled();
+            expect(result).toHaveProperty('data');
+            expect(result).toHaveProperty('meta');
+        });
+        it('should apply filters via andWhen allowedFilters is configured', async () => {
+            if (!config.allowedFilters || config.allowedFilters.length === 0)
+                return;
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const filterKey = config.allowedFilters[0];
+            await service.findAll({
+                page: 1,
+                limit: 10,
+                filter: { [`${String(filterKey)}_cont`]: 'test' },
+            });
+            expect(lastQb.andWhere).toHaveBeenCalled();
+        });
+        it('should join include relations via leftJoinAndSelect', async () => {
+            if (!config.include || config.include.length === 0)
+                return;
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            await service.findAll({ page: 1, limit: 10 });
+            expect(lastQb.leftJoinAndSelect).toHaveBeenCalled();
+        });
+        it('should apply orderBy when specified', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            await service.findAll({
+                page: 1,
+                limit: 10,
+                orderBy: 'id',
+                orderDirection: 'ASC',
+            });
+            expect(lastQb.orderBy).toHaveBeenCalledWith('e.id', 'ASC');
+        });
+        it('should default orderBy to DESC', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            await service.findAll({
+                page: 1,
+                limit: 10,
+                orderBy: 'id',
+            });
+            expect(lastQb.orderBy).toHaveBeenCalledWith('e.id', 'DESC');
+        });
+        it('should return empty data when no results', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findAll({ page: 1, limit: 10 });
+            expect(result).toHaveProperty('data');
+            expect(result.data).toEqual([]);
+        });
+    });
+    describe('findOne', () => {
+        it('should return the entity', async () => {
+            const mockEntity = createMockEntity(config);
+            repository.findOne.mockResolvedValue(mockEntity);
+            const result = await service.findOne(1);
+            expect(repository.findOne).toHaveBeenCalledWith({
+                where: { id: 1 },
+                relations: config.include ?? [],
+            });
+            expect(result).toBeDefined();
+        });
+        it('should throw NotFoundException when not found', async () => {
+            repository.findOne.mockResolvedValue(null);
+            await expect(service.findOne(999)).rejects.toThrow(common_1.NotFoundException);
+        });
+    });
+    describe('create', () => {
+        it('should save and return the entity', async () => {
+            const mockEntity = createMockEntity(config);
+            repository.save.mockResolvedValue(mockEntity);
+            const result = await service.create(config.test.createPayload);
+            expect(repository.save).toHaveBeenCalled();
+            expect(result).toBeDefined();
+        });
+    });
+    describe('update', () => {
+        it('should merge, save, and return the updated entity', async () => {
+            const mockEntity = createMockEntity(config);
+            repository.findOneBy.mockResolvedValue(mockEntity);
+            repository.save.mockResolvedValue(mockEntity);
+            repository.findOne.mockResolvedValue(mockEntity);
+            const result = await service.update(1, config.test.updatePayload);
+            expect(repository.findOneBy).toHaveBeenCalled();
+            expect(repository.merge).toHaveBeenCalled();
+            expect(repository.save).toHaveBeenCalled();
+            expect(result).toBeDefined();
+        });
+        it('should throw NotFoundException when entity not found', async () => {
+            repository.findOneBy.mockResolvedValue(null);
+            await expect(service.update(999, config.test.updatePayload)).rejects.toThrow(common_1.NotFoundException);
+        });
+    });
+    describe('remove', () => {
+        it('should delete and return true', async () => {
+            const mockEntity = createMockEntity(config);
+            repository.findOneBy.mockResolvedValue(mockEntity);
+            repository.delete.mockResolvedValue({ affected: 1 });
+            const result = await service.remove(1);
+            expect(repository.findOneBy).toHaveBeenCalled();
+            expect(repository.delete).toHaveBeenCalledWith(1);
+            expect(result).toBe(true);
+        });
+        it('should throw NotFoundException when not found', async () => {
+            repository.findOneBy.mockResolvedValue(null);
+            await expect(service.remove(999)).rejects.toThrow(common_1.NotFoundException);
+        });
+    });
+    describe('findMine', () => {
+        it('should filter by ownership field', async () => {
+            if (!config.userOwnershipField && !config.findMineQuery)
+                return;
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const mockEntity = createMockEntity(config);
+            lastQb.getManyAndCount.mockResolvedValue([[mockEntity], 1]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findMine(123, { page: 1, limit: 10 });
+            expect(repository.createQueryBuilder).toHaveBeenCalled();
+            expect(result).toHaveProperty('data');
+        });
+        it('should throw BadRequestException when not configured', async () => {
+            if (config.userOwnershipField || config.findMineQuery)
+                return;
+            await expect(service.findMine(123, {})).rejects.toThrow(common_1.BadRequestException);
+        });
+        it('should apply filters via andWhere', async () => {
+            if (!config.userOwnershipField && !config.findMineQuery)
+                return;
+            if (!config.allowedFilters || config.allowedFilters.length === 0)
+                return;
+            lastQb = (0, mock_repository_1.createMockQb)();
+            lastQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const filterKey = config.allowedFilters[0];
+            await service.findMine(123, {
+                filter: { [`${String(filterKey)}_cont`]: 'test' },
+            });
+            expect(lastQb.andWhere).toHaveBeenCalled();
+        });
+    });
+    describe('findAllWithCursor', () => {
+        it('should return cursor-based results', async () => {
+            if (config.disabledEndpoints?.includes('findMine'))
+                return;
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const mockEntity = createMockEntity(config);
+            lastQb.getMany.mockResolvedValue([mockEntity]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findAllWithCursor({ limit: 10 });
+            expect(result).toHaveProperty('data');
+            expect(result).toHaveProperty('meta');
+            expect(result.meta).toHaveProperty('limit', 10);
+            expect(result.meta).toHaveProperty('hasMore');
+            expect(result.meta).toHaveProperty('nextCursor');
+        });
+        it('should detect hasMore when entities exceed limit', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const entities = Array.from({ length: 11 }, () => createMockEntity(config));
+            lastQb.getMany.mockResolvedValue(entities);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findAllWithCursor({ limit: 10 });
+            expect(result.meta.hasMore).toBe(true);
+            expect(result.meta.nextCursor).toBeDefined();
+        });
+        it('should set hasMore false when entities <= limit', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const mockEntity = createMockEntity(config);
+            lastQb.getMany.mockResolvedValue([mockEntity]);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const result = await service.findAllWithCursor({ limit: 10 });
+            expect(result.meta.hasMore).toBe(false);
+            expect(result.meta.nextCursor).toBeNull();
+        });
+        it('should include total when includeTotal is true', async () => {
+            lastQb = (0, mock_repository_1.createMockQb)();
+            const mockEntity = createMockEntity(config);
+            lastQb.getMany.mockResolvedValue([mockEntity]);
+            lastQb.getCount.mockResolvedValue(1);
+            repository.createQueryBuilder.mockReturnValue(lastQb);
+            const countQb = (0, mock_repository_1.createMockQb)();
+            countQb.getCount.mockResolvedValue(1);
+            repository.createQueryBuilder.mockReturnValueOnce(lastQb);
+            repository.createQueryBuilder.mockReturnValueOnce(countQb);
+            const result = await service.findAllWithCursor({
+                limit: 10,
+                includeTotal: true,
+            });
+            expect(result.meta).toHaveProperty('total');
+        });
+    });
+    describe('findAuditLogs', () => {
+        it('should query audit logs with pagination', async () => {
+            const auditQb = (0, mock_repository_1.createMockQb)();
+            auditQb.getManyAndCount.mockResolvedValue([[], 0]);
+            repository.manager.getRepository.mockReturnValue({
+                createQueryBuilder: jest.fn().mockReturnValue(auditQb),
+            });
+            const result = await service.findAuditLogs({ page: 1, limit: 10 });
+            expect(repository.manager.getRepository).toHaveBeenCalled();
+            expect(result).toHaveProperty('data');
+            expect(result).toHaveProperty('meta');
+        });
+    });
+    describe('disabledEndpoints', () => {
+        it('should block disabled endpoints', async () => {
+            if (!config.disabledEndpoints || config.disabledEndpoints.length === 0)
+                return;
+            const disabled = config.disabledEndpoints[0];
+            service.disabledEndpoints = config.disabledEndpoints;
+            expect(service.disabledEndpoints).toContain(disabled);
+        });
+    });
+    const ctx = {
+        get module() {
+            return moduleRef;
+        },
+        get repository() {
+            return repository;
+        },
+        createMockQb: mock_repository_1.createMockQb,
+    };
+    return ctx;
+}
+function createMockEntity(config) {
+    const { createDefaultMockEntity } = require('./mock-repository');
+    const defaults = createDefaultMockEntity(config.entity);
+    return { ...defaults, ...(config.test.mockEntity ?? {}) };
+}

package/dist/lib/testing/index.d.ts

@@ -0,0 +1,5 @@
+export * from './testing.interface';
+export * from './mock-repository';
+export * from './crud-service.test-suites';
+export * from './crud-controller.test-suites';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC"}

package/dist/lib/testing/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./testing.interface"), exports);
+tslib_1.__exportStar(require("./mock-repository"), exports);
+tslib_1.__exportStar(require("./crud-service.test-suites"), exports);
+tslib_1.__exportStar(require("./crud-controller.test-suites"), exports);

package/dist/lib/testing/mock-repository.d.ts

@@ -0,0 +1,7 @@
+import { Type } from '@nestjs/common';
+import { ObjectLiteral, Repository } from 'typeorm';
+import { MockQueryBuilder } from './testing.interface';
+export declare function createMockQb(): MockQueryBuilder;
+export declare function createMockRepository<TEntity extends ObjectLiteral>(entity: Type<TEntity>, overrides?: Partial<jest.Mocked<Repository<TEntity>>>): jest.Mocked<Repository<TEntity>>;
+export declare function createDefaultMockEntity<TEntity extends ObjectLiteral>(entity: Type<TEntity>): TEntity;
+//# sourceMappingURL=mock-repository.d.ts.map

package/dist/lib/testing/mock-repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-repository.d.ts","sourceRoot":"","sources":["../../../src/lib/testing/mock-repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEvD,wBAAgB,YAAY,IAAI,gBAAgB,CAgB/C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,aAAa,EAChE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EACrB,SAAS,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,GACpD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAiClC;AAED,wBAAgB,uBAAuB,CAAC,OAAO,SAAS,aAAa,EACnE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GACpB,OAAO,CAuCT"}

package/dist/lib/testing/mock-repository.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockQb = createMockQb;
+exports.createMockRepository = createMockRepository;
+exports.createDefaultMockEntity = createDefaultMockEntity;
+function createMockQb() {
+    const qb = {
+        where: jest.fn().mockReturnThis(),
+        andWhere: jest.fn().mockReturnThis(),
+        leftJoinAndSelect: jest.fn().mockReturnThis(),
+        leftJoin: jest.fn().mockReturnThis(),
+        orderBy: jest.fn().mockReturnThis(),
+        skip: jest.fn().mockReturnThis(),
+        take: jest.fn().mockReturnThis(),
+        getManyAndCount: jest.fn().mockResolvedValue([[], 0]),
+        getMany: jest.fn().mockResolvedValue([]),
+        getOne: jest.fn().mockResolvedValue(null),
+        getCount: jest.fn().mockResolvedValue(0),
+        getRawOne: jest.fn().mockResolvedValue({}),
+    };
+    return qb;
+}
+function createMockRepository(entity, overrides) {
+    const mockEntity = createDefaultMockEntity(entity);
+    const auditQb = createMockQb();
+    const repo = {
+        createQueryBuilder: jest.fn().mockReturnValue(createMockQb()),
+        findOne: jest.fn().mockResolvedValue(mockEntity),
+        findOneBy: jest.fn().mockResolvedValue(mockEntity),
+        merge: jest.fn((e, p) => Object.assign(e, p)),
+        save: jest.fn().mockImplementation((e) => Promise.resolve(e)),
+        delete: jest.fn().mockResolvedValue({ affected: 1 }),
+        find: jest.fn().mockResolvedValue([mockEntity]),
+        metadata: {
+            name: entity.name,
+            primaryColumns: [{ propertyPath: 'id', type: () => Number }],
+        },
+        manager: {
+            getRepository: jest.fn().mockReturnValue({
+                createQueryBuilder: jest.fn().mockReturnValue(auditQb),
+            }),
+            connection: {
+                createQueryRunner: jest.fn().mockReturnValue({
+                    startTransaction: jest.fn(),
+                    commitTransaction: jest.fn(),
+                    rollbackTransaction: jest.fn(),
+                    release: jest.fn(),
+                }),
+            },
+        },
+        ...overrides,
+    };
+    return repo;
+}
+function createDefaultMockEntity(entity) {
+    try {
+        const { getMetadata } = require('typeorm');
+        const metadata = getMetadata(entity);
+        const instance = {};
+        for (const col of metadata.columns) {
+            const type = col.type;
+            const name = col.propertyPath;
+            if (col.isPrimary) {
+                if (type === 'uuid') {
+                    instance[name] = '00000000-0000-0000-0000-000000000001';
+                }
+                else {
+                    instance[name] = 1;
+                }
+            }
+            else if (type === String || type === 'varchar' || type === 'text') {
+                instance[name] = `mock_${name}`;
+            }
+            else if (type === Number || type === 'int' || type === 'integer') {
+                instance[name] = 0;
+            }
+            else if (type === Boolean || type === 'boolean') {
+                instance[name] = true;
+            }
+            else if (type === Date ||
+                type === 'timestamp' ||
+                type === 'datetime') {
+                instance[name] = new Date('2024-01-01T00:00:00.000Z');
+            }
+            else if (type === 'json' || type === 'jsonb') {
+                instance[name] = {};
+            }
+            else {
+                instance[name] = null;
+            }
+        }
+        return instance;
+    }
+    catch {
+        return { id: 1 };
+    }
+}

package/dist/lib/testing/testing.interface.d.ts

@@ -0,0 +1,52 @@
+import { Type } from '@nestjs/common';
+import { ObjectLiteral, Repository } from 'typeorm';
+import { CrudServiceOptions } from '../services/nest-crud.service';
+import { CrudEndpoint } from '../interfaces/crud.interface';
+export interface CrudTestConfig<TEntity extends ObjectLiteral, TCreateDto, TUpdateDto, TResponseDto> {
+    entity: Type<TEntity>;
+    serviceClass: Type<any>;
+    createDto?: Type<TCreateDto>;
+    updateDto?: Type<TUpdateDto>;
+    responseDto?: Type<TResponseDto>;
+    allowedFilters?: readonly (keyof TEntity)[];
+    allowedSortFields?: readonly (keyof TEntity)[];
+    include?: readonly string[];
+    userOwnershipField?: keyof TEntity;
+    findMineQuery?: (qb: any, userId: string | number) => void;
+    disabledEndpoints?: readonly CrudEndpoint[];
+    hooks?: CrudServiceOptions<TEntity, TResponseDto>['hooks'];
+    toResponseDto?: (entity: TEntity | TEntity[]) => TResponseDto | TResponseDto[];
+    relations?: CrudServiceOptions<TEntity, TResponseDto>['relations'];
+    test: {
+        createPayload: Partial<TCreateDto>;
+        updatePayload: Partial<TUpdateDto>;
+        mockEntity?: Partial<TEntity>;
+        mockEntities?: TEntity[];
+        mockRepoOverrides?: Partial<jest.Mocked<Repository<TEntity>>>;
+    };
+}
+export interface CrudControllerTestConfig<TEntity extends ObjectLiteral, TCreateDto, TUpdateDto, TResponseDto> extends Omit<CrudTestConfig<TEntity, TCreateDto, TUpdateDto, TResponseDto>, 'serviceClass'> {
+    controllerFactory: () => Type<any>;
+    serviceClass: Type<any>;
+    permissions?: Record<CrudEndpoint, string | string[]>;
+}
+export interface CrudTestContext {
+    module: any;
+    repository: jest.Mocked<any>;
+    createMockQb: () => MockQueryBuilder;
+}
+export interface MockQueryBuilder {
+    where: jest.Mock;
+    andWhere: jest.Mock;
+    leftJoinAndSelect: jest.Mock;
+    leftJoin: jest.Mock;
+    orderBy: jest.Mock;
+    skip: jest.Mock;
+    take: jest.Mock;
+    getManyAndCount: jest.Mock;
+    getMany: jest.Mock;
+    getOne: jest.Mock;
+    getCount: jest.Mock;
+    getRawOne: jest.Mock;
+}
+//# sourceMappingURL=testing.interface.d.ts.map

package/dist/lib/testing/testing.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.interface.d.ts","sourceRoot":"","sources":["../../../src/lib/testing/testing.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,WAAW,cAAc,CAC7B,OAAO,SAAS,aAAa,EAC7B,UAAU,EACV,UAAU,EACV,YAAY;IAEZ,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACtB,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,SAAS,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACjC,cAAc,CAAC,EAAE,SAAS,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;IAC5C,iBAAiB,CAAC,EAAE,SAAS,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;IAC/C,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC;IACnC,aAAa,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,CAAC;IAC3D,iBAAiB,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAC5C,KAAK,CAAC,EAAE,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC;IAC3D,aAAa,CAAC,EAAE,CACd,MAAM,EAAE,OAAO,GAAG,OAAO,EAAE,KACxB,YAAY,GAAG,YAAY,EAAE,CAAC;IACnC,SAAS,CAAC,EAAE,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;IACnE,IAAI,EAAE;QACJ,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACnC,aAAa,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QACnC,UAAU,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9B,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC;QACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KAC/D,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB,CACvC,OAAO,SAAS,aAAa,EAC7B,UAAU,EACV,UAAU,EACV,YAAY,CACZ,SAAQ,IAAI,CACV,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,YAAY,CAAC,EAC7D,cAAc,CACf;IACD,iBAAiB,EAAE,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;IACnC,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,YAAY,EAAE,MAAM,gBAAgB,CAAC;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC;IACjB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;IACpB,iBAAiB,EAAE,IAAI,CAAC,IAAI,CAAC;IAC7B,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;IACpB,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;IAChB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;IAChB,eAAe,EAAE,IAAI,CAAC,IAAI,CAAC;IAC3B,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC;IACnB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC;IAClB,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC;CACtB"}

package/dist/lib/testing/testing.interface.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nest-util/nest-crud",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,6 +11,12 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./testing": {
+      "@nest-util/source": "./src/lib/testing/index.ts",
+      "types": "./dist/lib/testing/index.d.ts",
+      "import": "./dist/lib/testing/index.js",
+      "default": "./dist/lib/testing/index.js"
     }
   },
   "files": [
@@ -18,6 +24,7 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
+    "@nestjs/testing": "^11.0.0",
     "tslib": "^2.8.1"
   },
   "devDependencies": {