feat:Implement Request Validation DTOs for All Endpoints #7

Author: OlufunbiIK

package-lock.json

@@ -40,91 +40,92 @@
     "health": "curl -f http://localhost:3000/health || exit 1"
   },
   "dependencies": {
+    "@nestjs/bull": "^10.0.1",
     "@nestjs/common": "^10.3.0",
+    "@nestjs/config": "^3.1.1",
     "@nestjs/core": "^10.3.0",
+    "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.3.0",
-    "@nestjs/config": "^3.1.1",
-    "@nestjs/swagger": "^7.2.0",
-    "@nestjs/throttler": "^5.1.1",
-    "@nestjs/bull": "^10.0.1",
     "@nestjs/schedule": "^4.0.0",
+    "@nestjs/swagger": "^7.2.0",
     "@nestjs/terminus": "^10.2.3",
+    "@nestjs/throttler": "^5.1.1",
+    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
+    "@prisma/client": "^5.7.1",
+    "axios": "^1.6.2",
+    "bcrypt": "^5.1.1",
     "bull": "^4.12.2",
-    "redis": "^4.6.12",
-    "ioredis": "^5.3.2",
-    "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^4.7.1",
-    "nest-winston": "^1.9.4",
-    "class-validator": "^0.14.1",
     "class-transformer": "^0.5.1",
-    "helmet": "^7.1.0",
-    "cors": "^2.8.5",
+    "class-validator": "^0.14.1",
     "compression": "^1.7.4",
-    "express-rate-limit": "^7.1.5",
-    "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.1",
-    "pg": "^8.11.3",
-    "@prisma/client": "^5.7.1",
-    "prisma": "^5.7.1",
+    "cors": "^2.8.5",
+    "crypto-js": "^4.2.0",
+    "csv-parser": "^3.0.0",
+    "dotenv": "^16.3.1",
     "ethers": "^6.9.0",
-    "web3": "^4.3.0",
-    "@nomicfoundation/hardhat-toolbox": "^4.0.0",
+    "express-rate-limit": "^7.1.5",
     "hardhat": "^2.19.4",
-    "dotenv": "^16.3.1",
+    "helmet": "^7.1.0",
+    "ioredis": "^5.3.2",
     "joi": "^17.11.0",
-    "bcrypt": "^5.1.1",
     "jsonwebtoken": "^9.0.2",
+    "lodash": "^4.17.21",
+    "mapped-types": "^0.0.1",
+    "moment": "^2.29.4",
+    "multer": "^1.4.5-lts.1",
+    "nest-winston": "^1.9.4",
     "passport": "^0.7.0",
-    "@nestjs/passport": "^10.0.3",
     "passport-jwt": "^4.0.1",
     "passport-local": "^1.0.0",
-    "multer": "^1.4.5-lts.1",
+    "pg": "^8.11.3",
+    "prisma": "^5.7.1",
+    "redis": "^4.6.12",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1",
     "sharp": "^0.33.1",
     "uuid": "^9.0.1",
-    "crypto-js": "^4.2.0",
-    "axios": "^1.6.2",
-    "lodash": "^4.17.21",
-    "moment": "^2.29.4",
-    "csv-parser": "^3.0.0",
+    "web3": "^4.3.0",
+    "winston": "^3.11.0",
+    "winston-daily-rotate-file": "^4.7.1",
     "xlsx": "^0.18.5"
   },
   "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@nestjs/cli": "^10.3.0",
     "@nestjs/schematics": "^10.0.3",
     "@nestjs/testing": "^10.3.0",
+    "@types/bcrypt": "^5.0.2",
+    "@types/compression": "^1.7.5",
+    "@types/cors": "^2.8.17",
+    "@types/crypto-js": "^4.2.1",
     "@types/express": "^4.17.21",
     "@types/jest": "^29.5.8",
-    "@types/node": "^20.10.4",
-    "@types/supertest": "^2.0.16",
-    "@types/bcrypt": "^5.0.2",
     "@types/jsonwebtoken": "^9.0.5",
+    "@types/lodash": "^4.14.202",
+    "@types/multer": "^1.4.11",
+    "@types/node": "^20.10.4",
     "@types/passport-jwt": "^3.0.13",
     "@types/passport-local": "^1.0.38",
-    "@types/multer": "^1.4.11",
+    "@types/supertest": "^2.0.16",
     "@types/uuid": "^9.0.7",
-    "@types/crypto-js": "^4.2.1",
-    "@types/lodash": "^4.14.202",
-    "@types/compression": "^1.7.5",
-    "@types/cors": "^2.8.17",
     "@typescript-eslint/eslint-plugin": "^6.13.1",
     "@typescript-eslint/parser": "^6.13.1",
     "eslint": "^8.54.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.1",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.0",
     "prettier": "^3.1.0",
+    "rimraf": "^5.0.5",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
-    "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.3.2",
-    "rimraf": "^5.0.5",
-    "@commitlint/cli": "^18.4.3",
-    "@commitlint/config-conventional": "^18.4.3",
-    "husky": "^8.0.3",
-    "lint-staged": "^15.2.0"
+    "typescript": "^5.3.2"
   },
   "jest": {
     "moduleFileExtensions": [

package.json

@@ -15,6 +15,7 @@ import { BlockchainModule } from './blockchain/blockchain.module';
 import { AuthModule } from './auth/auth.module';
 import { FilesModule } from './files/files.module';
 import { AuthRateLimitMiddleware } from './auth/middleware/auth.middleware';
+import { PropertiesModule } from './properties/properties.module';
 import configuration from './config/configuration';
 
 @Module({

src/app.module.ts

@@ -0,0 +1,33 @@
+import { IsString, IsNotEmpty, IsNumber, ValidateNested, IsArray } from 'class-validator';
+import { Type } from 'class-transformer';
+
+class AddressDto {
+  @IsString()
+  @IsNotEmpty()
+  street: string;
+
+  @IsString()
+  @IsNotEmpty()
+  city: string;
+
+  @IsString()
+  @IsNotEmpty()
+  country: string;
+}
+
+export class CreatePropertyDto {
+  @IsString()
+  @IsNotEmpty()
+  title: string;
+
+  @IsNumber()
+  price: number;
+
+  @ValidateNested()
+  @Type(() => AddressDto)
+  address: AddressDto;
+
+  @IsArray()
+  @IsString({ each: true })
+  features: string[];
+}

src/properties/dto/create-property.dto.ts

@@ -0,0 +1,4 @@
+import { PartialType } from '@nestjs/swagger';
+import { CreatePropertyDto } from './create-property.dto';
+
+export class UpdatePropertyDto extends PartialType(CreatePropertyDto) {}

src/properties/dto/update-property.dto.ts

@@ -0,0 +1 @@
+export class Property {}

src/properties/entities/property.entity.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { PropertiesController } from './properties.controller';
+import { PropertiesService } from './properties.service';
+
+describe('PropertiesController', () => {
+  let controller: PropertiesController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [PropertiesController],
+      providers: [PropertiesService],
+    }).compile();
+
+    controller = module.get<PropertiesController>(PropertiesController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/properties/properties.controller.spec.ts

@@ -0,0 +1,34 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete } from '@nestjs/common';
+import { PropertiesService } from './properties.service';
+import { CreatePropertyDto } from './dto/create-property.dto';
+import { UpdatePropertyDto } from './dto/update-property.dto';
+
+@Controller('properties')
+export class PropertiesController {
+  constructor(private readonly propertiesService: PropertiesService) {}
+
+  @Post()
+  create(@Body() createPropertyDto: CreatePropertyDto) {
+    return this.propertiesService.create(createPropertyDto);
+  }
+
+  @Get()
+  findAll() {
+    return this.propertiesService.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.propertiesService.findOne(+id);
+  }
+
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updatePropertyDto: UpdatePropertyDto) {
+    return this.propertiesService.update(+id, updatePropertyDto);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.propertiesService.remove(+id);
+  }
+}

src/properties/properties.controller.ts

@@ -1,4 +1,9 @@
 import { Module } from '@nestjs/common';
+import { PropertiesService } from './properties.service';
+import { PropertiesController } from './properties.controller';
 
-@Module({})
+@Module({
+  controllers: [PropertiesController],
+  providers: [PropertiesService],
+})
 export class PropertiesModule {}

src/properties/properties.module.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { PropertiesService } from './properties.service';
+
+describe('PropertiesService', () => {
+  let service: PropertiesService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [PropertiesService],
+    }).compile();
+
+    service = module.get<PropertiesService>(PropertiesService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});