feat/[BACKEND] Implement Vendor Contract Management Module #295

Olufunbi · Olufunbi · commit b81fbaed1a98 · 2025-10-02T21:45:16.000+01:00
diff --git a/backend/package-lock.json b/backend/package-lock.json
diff --git a/backend/package.json b/backend/package.json
@@ -28,6 +28,7 @@
     "@nestjs/mapped-types": "*",
     "@nestjs/passport": "^11.0.5",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/schedule": "^6.0.1",
     "@nestjs/swagger": "^7.3.0",
     "@nestjs/typeorm": "^10.0.2",
     "@types/multer": "^2.0.0",
@@ -36,6 +37,7 @@
     "bwip-js": "^4.7.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
+    "date-fns": "^4.1.0",
     "json2csv": "^6.0.0-alpha.2",
     "multer": "^2.0.2",
     "nestjs-i18n": "^10.5.1",
diff --git a/backend/src/app.module.ts b/backend/src/app.module.ts
@@ -19,6 +19,7 @@ import { FileUpload } from './file-uploads/entities/file-upload.entity';
 import { Asset } from './assets/entities/assest.entity';
 import { Supplier } from './suppliers/entities/supplier.entity';
 import { QrBarcodeModule } from './qr-barcode/qr-barcode.module';
+import { VendorContractsModule } from './vendor-contracts/vendor-contracts.module';
 
 @Module({
   imports: [
@@ -56,6 +57,7 @@ import { QrBarcodeModule } from './qr-barcode/qr-barcode.module';
     RiskModule,
     ReportingModule,
     QrBarcodeModule,
+    VendorContractsModule,
   ],
   controllers: [AppController],
   providers: [AppService],
diff --git a/backend/src/notifications/console-notification.service.ts b/backend/src/notifications/console-notification.service.ts
@@ -0,0 +1,18 @@
+import { Injectable, Logger } from '@nestjs/common';
+import {
+  ContractExpiryPayload,
+  NotificationService,
+} from './interfaces/notification.interface';
+
+@Injectable()
+export class ConsoleNotificationService implements NotificationService {
+  private readonly logger = new Logger(ConsoleNotificationService.name);
+
+  async notifyContractExpiring(payload: ContractExpiryPayload) {
+    // Replace with real email/push logic
+    this.logger.warn(
+      `Contract expiring soon: ${payload.contractName} (id=${payload.contractId}) for supplier ${payload.supplierId}. Expires in ${payload.daysUntilExpiry} days on ${payload.endDate}`,
+    );
+    // e.g., call mailerService.sendMail(...) or push to queue
+  }
+}
diff --git a/backend/src/notifications/interfaces/notification.interface.ts b/backend/src/notifications/interfaces/notification.interface.ts
diff --git a/backend/src/qr-barcode/dto/update-qr-barcode.dto.ts b/backend/src/qr-barcode/dto/update-qr-barcode.dto.ts
@@ -1,4 +0,0 @@
-import { PartialType } from '@nestjs/swagger';
-import { CreateQrBarcodeDto } from './generate-qr-barcode.dto';
-
-export class UpdateQrBarcodeDto extends PartialType(CreateQrBarcodeDto) {}
diff --git a/backend/src/vendor-contracts/dto/create-vendor-contract.dto.ts b/backend/src/vendor-contracts/dto/create-vendor-contract.dto.ts
@@ -0,0 +1,27 @@
+import {
+  IsUUID,
+  IsString,
+  IsDateString,
+  IsOptional,
+  IsUrl,
+  Length,
+} from 'class-validator';
+
+export class CreateVendorContractDto {
+  @IsUUID()
+  supplierId: string;
+
+  @IsString()
+  @Length(1, 255)
+  contractName: string;
+
+  @IsDateString()
+  startDate: string;
+
+  @IsDateString()
+  endDate: string;
+
+  @IsOptional()
+  @IsUrl()
+  fileUrl?: string;
+}
diff --git a/backend/src/vendor-contracts/dto/query-vendor-contract.dto.ts b/backend/src/vendor-contracts/dto/query-vendor-contract.dto.ts
@@ -0,0 +1,19 @@
+import { IsOptional, IsUUID, IsNumberString } from 'class-validator';
+
+export class QueryVendorContractDto {
+  @IsOptional()
+  @IsUUID()
+  supplierId?: string;
+
+  @IsOptional()
+  search?: string;
+
+  // simple pagination
+  @IsOptional()
+  @IsNumberString()
+  page?: string;
+
+  @IsOptional()
+  @IsNumberString()
+  limit?: string;
+}
diff --git a/backend/src/vendor-contracts/dto/update-vendor-contract.dto.ts b/backend/src/vendor-contracts/dto/update-vendor-contract.dto.ts
@@ -0,0 +1,11 @@
+import { PartialType } from '@nestjs/mapped-types';
+import { CreateVendorContractDto } from './create-vendor-contract.dto';
+import { IsOptional, IsBoolean } from 'class-validator';
+
+export class UpdateVendorContractDto extends PartialType(
+  CreateVendorContractDto,
+) {
+  @IsOptional()
+  @IsBoolean()
+  isActive?: boolean;
+}
diff --git a/backend/src/vendor-contracts/entities/vendor-contract.entity.ts b/backend/src/vendor-contracts/entities/vendor-contract.entity.ts
@@ -0,0 +1,41 @@
+import {
+  Entity,
+  PrimaryGeneratedColumn,
+  Column,
+  CreateDateColumn,
+  UpdateDateColumn,
+  Index,
+} from 'typeorm';
+
+@Entity({ name: 'vendor_contracts' })
+export class VendorContract {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  // Could be a FK to suppliers table (uuid). Keep simple as UUID.
+  @Column({ type: 'uuid' })
+  @Index()
+  supplierId: string;
+
+  @Column({ type: 'varchar', length: 255 })
+  contractName: string;
+
+  @Column({ type: 'date' })
+  startDate: string; // ISO date string
+
+  @Column({ type: 'date' })
+  @Index()
+  endDate: string; // ISO date string
+
+  @Column({ type: 'text', nullable: true })
+  fileUrl?: string;
+
+  @Column({ type: 'boolean', default: true })
+  isActive: boolean;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
+}
diff --git a/backend/src/vendor-contracts/vendor-contract-scheduler.ts b/backend/src/vendor-contracts/vendor-contract-scheduler.ts
@@ -0,0 +1,24 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { Cron, CronExpression } from '@nestjs/schedule';
+import { VendorContractsService } from './vendor-contracts.service';
+
+@Injectable()
+export class VendorContractsScheduler {
+  private readonly logger = new Logger(VendorContractsScheduler.name);
+
+  constructor(
+    private readonly vendorContractsService: VendorContractsService,
+  ) {}
+
+  // Runs every day at 08:00 server time — change as needed
+  @Cron(CronExpression.EVERY_DAY_AT_8AM)
+  async dailyExpiryCheck() {
+    this.logger.debug('Running daily vendor-contract expiry check');
+    try {
+      // configurable window (e.g., 30 days)
+      await this.vendorContractsService.notifyExpiringContracts(30);
+    } catch (err) {
+      this.logger.error('Expiry check failed', err);
+    }
+  }
+}
diff --git a/backend/src/vendor-contracts/vendor-contracts.controller.spec.ts b/backend/src/vendor-contracts/vendor-contracts.controller.spec.ts
@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { VendorContractsController } from './vendor-contracts.controller';
+import { VendorContractsService } from './vendor-contracts.service';
+
+describe('VendorContractsController', () => {
+  let controller: VendorContractsController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [VendorContractsController],
+      providers: [VendorContractsService],
+    }).compile();
+
+    controller = module.get<VendorContractsController>(VendorContractsController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});
diff --git a/backend/src/vendor-contracts/vendor-contracts.controller.ts b/backend/src/vendor-contracts/vendor-contracts.controller.ts
@@ -0,0 +1,64 @@
+import {
+  Controller,
+  Post,
+  Body,
+  Get,
+  Query,
+  Param,
+  Patch,
+  Delete,
+  ParseUUIDPipe,
+  DefaultValuePipe,
+  ParseIntPipe,
+} from '@nestjs/common';
+import { VendorContractsService } from './vendor-contracts.service';
+import { CreateVendorContractDto } from './dto/create-vendor-contract.dto';
+import { UpdateVendorContractDto } from './dto/update-vendor-contract.dto';
+import { QueryVendorContractDto } from './dto/query-vendor-contract.dto';
+
+@Controller('vendor-contracts')
+export class VendorContractsController {
+  constructor(private readonly service: VendorContractsService) {}
+
+  @Post()
+  async create(@Body() dto: CreateVendorContractDto) {
+    return this.service.create(dto);
+  }
+
+  @Get()
+  async findAll(@Query() q: QueryVendorContractDto) {
+    const page = q.page ? parseInt(q.page, 10) : 1;
+    const limit = q.limit ? parseInt(q.limit, 10) : 20;
+    return this.service.findAll({
+      supplierId: q.supplierId,
+      search: (q as any).search,
+      page,
+      limit,
+    });
+  }
+
+  @Get('expiring-soon')
+  async expiringSoon(
+    @Query('days', new DefaultValuePipe(30), ParseIntPipe) days: number,
+  ) {
+    return this.service.findExpiringWithin(days);
+  }
+
+  @Get(':id')
+  async findOne(@Param('id', new ParseUUIDPipe()) id: string) {
+    return this.service.findOne(id);
+  }
+
+  @Patch(':id')
+  async update(
+    @Param('id', new ParseUUIDPipe()) id: string,
+    @Body() dto: UpdateVendorContractDto,
+  ) {
+    return this.service.update(id, dto);
+  }
+
+  @Delete(':id')
+  async remove(@Param('id', new ParseUUIDPipe()) id: string) {
+    return this.service.remove(id);
+  }
+}
diff --git a/backend/src/vendor-contracts/vendor-contracts.module.ts b/backend/src/vendor-contracts/vendor-contracts.module.ts
@@ -0,0 +1,21 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { VendorContractsService } from './vendor-contracts.service';
+import { VendorContractsController } from './vendor-contracts.controller';
+import { ConsoleNotificationService } from '../notifications/console-notification.service';
+import { VendorContract } from './entities/vendor-contract.entity';
+import { VendorContractsScheduler } from './vendor-contract-scheduler';
+import { NotificationService } from 'src/notifications/interfaces/notification.interface';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([VendorContract])],
+  controllers: [VendorContractsController],
+  providers: [
+    VendorContractsService,
+    VendorContractsScheduler,
+    // Provide a concrete notification implementation here:
+    { provide: NotificationService, useClass: ConsoleNotificationService },
+  ],
+  exports: [VendorContractsService],
+})
+export class VendorContractsModule {}
diff --git a/backend/src/vendor-contracts/vendor-contracts.service.spec.ts b/backend/src/vendor-contracts/vendor-contracts.service.spec.ts
diff --git a/backend/src/vendor-contracts/vendor-contracts.service.ts b/backend/src/vendor-contracts/vendor-contracts.service.ts
