Types and data validation

apps/client/package.json

@@ -13,6 +13,7 @@
     "@chakra-ui/react": "^3.8.0",
     "@emotion/react": "^11.14.0",
     "@types/leaflet": "^1.9.16",
+    "woof-api-client": "file:../../packages/woof-api-client",
     "leaflet": "^1.9.4",
     "next": "15.1.7",
     "react": "^19.0.0",
@@ -28,4 +29,4 @@
     "eslint-config-next": "15.1.7",
     "typescript": "^5"
   }
-}
+}

apps/server/.gitignore

@@ -54,3 +54,5 @@ pids
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+bin

apps/server/package.json

@@ -15,14 +15,18 @@
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
-    "prisma:generate": "prisma generate"
+    "prisma:generate": "prisma generate",
+    "codegen:download": "bash ./setup_codegen.sh",
+    "codegen:run": "java -jar ./bin/codegen.jar generate -i http://localhost:3000/api/json -l typescript-axios -o ../../packages/woof-api-client"
   },
   "dependencies": {
     "@nestjs/common": "^11.0.1",
     "@nestjs/core": "^11.0.1",
     "@nestjs/platform-express": "^11.0.1",
     "@nestjs/swagger": "^11.0.6",
     "@prisma/client": "^6.4.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1"
   },
@@ -55,4 +59,4 @@
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.20.0"
   }
-}
+}

apps/server/setup_codegen.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+mkdir ./bin
+wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar -O ./bin/codegen.jar

apps/server/src/main.ts

@@ -1,6 +1,7 @@
 import { NestFactory } from "@nestjs/core";
 import { AppModule } from "./app.module";
 import { SwaggerModule, DocumentBuilder } from "@nestjs/swagger";
+import { ValidationPipe } from "@nestjs/common";
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -11,7 +12,16 @@ async function bootstrap() {
     .build();
   const documentFactory = () =>
     SwaggerModule.createDocument(app, swaggerConfig);
-  SwaggerModule.setup("api", app, documentFactory);
+  SwaggerModule.setup("api", app, documentFactory, {
+    jsonDocumentUrl: "api/json",
+  });
+
+  app.useGlobalPipes(
+    new ValidationPipe({
+      disableErrorMessages: false,
+      enableDebugMessages: true,
+    }),
+  );
 
   await app.listen(process.env.PORT ?? 3000);
 }

apps/server/src/partners/dto/CreatePartnerDto.ts

@@ -0,0 +1,61 @@
+import { ApiProperty } from "@nestjs/swagger";
+import {
+  IsString,
+  IsNotEmpty,
+  Length,
+  IsPostalCode,
+  IsPhoneNumber,
+  IsUrl,
+  IsEnum,
+} from "class-validator";
+
+enum PartnerType {
+  VET = "VET",
+  ORG = "ORG",
+  SHOP = "SHOP",
+  SHELTER = "SHELTER",
+}
+
+export default class CreatePartnerDto {
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  @Length(2, 64)
+  name: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  city?: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsNotEmpty()
+  street?: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsPostalCode("PL")
+  @IsNotEmpty()
+  postal?: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsPhoneNumber("PL")
+  @IsNotEmpty()
+  phone?: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsUrl()
+  @IsNotEmpty()
+  website?: string;
+
+  @ApiProperty({
+    enum: PartnerType,
+  })
+  @IsEnum(PartnerType)
+  @IsString()
+  @IsNotEmpty()
+  type: PartnerType;
+}

apps/server/src/partners/partners.controller.ts

@@ -1,12 +1,17 @@
-import { Controller, Get, Param, Res } from "@nestjs/common";
+import { Body, Controller, Get, Param, Post, Res } from "@nestjs/common";
 import { PartnersService } from "./partners.service";
-import type { Response } from "express";
+import { Response } from "express";
+import CreatePartnerDto from "./dto/CreatePartnerDto";
+import { ApiResponse, ApiTags } from "@nestjs/swagger";
+import { GetAllPartnersResponse } from "../types";
 
+@ApiTags("partners")
 @Controller("partners")
 export class PartnersController {
   constructor(private readonly partnersService: PartnersService) {}
 
   // GET /partners
+  @ApiResponse({ type: GetAllPartnersResponse })
   @Get()
   async getAllPartners(@Res() res: Response) {
     return this.partnersService.findAll(res);
@@ -17,4 +22,9 @@ export class PartnersController {
   async getPartnerByUuid(@Param("uuid") uuid: string, @Res() res: Response) {
     return this.partnersService.findOne(uuid, res);
   }
+
+  @Post()
+  createPartner(@Body() body: CreatePartnerDto, @Res() res: Response) {
+    return this.partnersService.create(body, res);
+  }
 }

apps/server/src/partners/partners.service.ts

@@ -1,19 +1,34 @@
 import { Injectable } from "@nestjs/common";
 import { PrismaService } from "../prisma/prisma.service";
-import type { Response } from "express";
+import { Response } from "express";
+import CreatePartnerDto from "./dto/CreatePartnerDto";
+import type { GenericResponse, GetAllPartnersResponse } from "../types/index";
 
 @Injectable()
 export class PartnersService {
   constructor(private readonly prisma: PrismaService) {}
 
-  async findAll(res: Response) {
+  async findAll(res: Response): Promise<GetAllPartnersResponse> {
     try {
-      return await this.prisma.partner.findMany();
-    } catch {
-      res.status(500).json({
+      const data = await this.prisma.partner.findMany();
+      res.status(200);
+      const response: GetAllPartnersResponse = {
+        ok: true,
+        data,
+      };
+      return response;
+    } catch (e: unknown) {
+      res.status(500);
+      const response: GetAllPartnersResponse = {
         ok: false,
-        message: "Internal server error!",
-      });
+        message: "Internal server error",
+        error:
+          process.env.NODE_ENV == "development"
+            ? (e as Error).message
+            : undefined,
+        data: undefined,
+      };
+      return response;
     }
   }
 
@@ -29,4 +44,12 @@ export class PartnersService {
       });
     }
   }
+
+  create(body: CreatePartnerDto, res: Response) {
+    // TODO: na razie testowo, chciałem zobaczyć czy typowanie i walidacja działa
+    const resData: GenericResponse = {
+      ok: true,
+    };
+    return res.status(200).json(resData);
+  }
 }

apps/server/src/types/index.ts

@@ -0,0 +1,23 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { Partner } from "@prisma/client";
+
+export interface GenericResponse {
+  ok: boolean;
+  data?: unknown;
+  message?: string;
+  error?: string;
+}
+
+export class GetAllPartnersResponse implements GenericResponse {
+  @ApiProperty()
+  ok: boolean;
+
+  @ApiProperty({ required: false })
+  data?: Partner[];
+
+  @ApiProperty({ required: false })
+  message?: string | undefined;
+
+  @ApiProperty({ required: false })
+  error?: string | undefined;
+}