added Currency entity; added Swagger

.env

@@ -1,7 +1,8 @@
+# !just for testing purposes. The .env file should be removed from git
 HTTP_PORT=3000
 
-#DB_HOST=localhost # for running locally
-DB_HOST=postgres
+DB_HOST=localhost # for running locally
+#DB_HOST=postgres
 DB_PORT=5432
 DB_USERNAME=curex
 DB_PASSWORD=dbpassword

README.md

@@ -37,6 +37,9 @@ DB_NAME=curex-db
 DB_SYNCHRONIZE=true
 ```
 
+## API docs (Swagger)
+  Url to try existing endpoints: `localhost:3000/api-docs`
+
 
 ## Answers
 
@@ -71,4 +74,3 @@ DB_SYNCHRONIZE=true
      https://i.imgur.com/yKvgJcy.png
 
 
-

docker-compose.yml

@@ -29,6 +29,7 @@ services:
       - "${DB_PORT}:5432"
     volumes:
       - pgData:/var/lib/postgresql/data
+      - ./src/config/init.sql:/docker-entrypoint-initdb.d/init.sql
     networks:
       - curex-net
 

nest-cli.json

@@ -3,7 +3,6 @@
   "collection": "@nestjs/schematics",
   "sourceRoot": "src",
   "compilerOptions": {
-    "deleteOutDir": true
-  },
-  "assets": ["**/db/file-importer/*.txt"]
+    "plugins": ["@nestjs/swagger"]
+  }
 }

package.json

@@ -25,6 +25,7 @@
     "@nestjs/config": "^3.0.0",
     "@nestjs/core": "^9.0.0",
     "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/swagger": "^7.1.8",
     "@nestjs/typeorm": "^10.0.0",
     "pg": "^8.11.3",
     "reflect-metadata": "^0.1.13",

src/app.module.ts

@@ -6,7 +6,13 @@ import { pgDbConfig } from './config';
 import { DbModule } from './db/db.module';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
-import { Country, Exchange, ExchangeOffice, Rate } from './db/entities';
+import {
+  Country,
+  Currency,
+  Exchange,
+  ExchangeOffice,
+  Rate,
+} from './db/entities';
 
 @Module({
   imports: [
@@ -17,7 +23,7 @@ import { Country, Exchange, ExchangeOffice, Rate } from './db/entities';
     }),
     TypeOrmModule.forRoot({
       ...pgDbConfig(),
-      entities: [Country, ExchangeOffice, Exchange, Rate],
+      entities: [Country, ExchangeOffice, Exchange, Rate, Currency],
     }),
   ],
   controllers: [AppController],

src/config/init.sql

@@ -0,0 +1,19 @@
+DO $$
+BEGIN
+    IF NOT EXISTS (SELECT 1 FROM pg_database WHERE datname = 'curex-db') THEN
+        CREATE DATABASE "curex-db";
+    END IF;
+END $$;
+
+CREATE TABLE currency (
+  id serial PRIMARY KEY,
+  code character varying(3) UNIQUE NOT NULL,
+  title character varying(50) NOT NULL
+);
+
+INSERT INTO currency (code, title) VALUES
+  ('USD', 'United States Dollar'),
+  ('EUR', 'Euro'),
+  ('AUD', 'Australian Dollar'),
+  ('UAH', 'Ukrainian Hryvnia'),
+  ('CAD', 'Canadian Dollar');

src/db/db-import.service.ts

@@ -11,6 +11,7 @@ import {
   countriesField,
   exchangeOfficesField,
 } from './file-importer/types';
+import { ImportResponseDto } from './io.dto';
 
 @Injectable()
 export class DbImportService {
@@ -36,7 +37,9 @@ export class DbImportService {
     return this.storeFileContentInDb(content);
   }
 
-  private async storeFileContentInDb(content: TJsonContent) {
+  private async storeFileContentInDb(
+    content: TJsonContent,
+  ): Promise<ImportResponseDto> {
     if (!content) {
       this.logger.warn(`No content for storing in DB`);
       return {

src/db/db.controller.ts

@@ -1,29 +1,43 @@
 import {
   Controller,
-  Get,
+  Get, HttpCode,
   Post,
   Query,
   UploadedFile,
   UseInterceptors,
 } from '@nestjs/common';
+import { ApiBody, ApiConsumes, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { FileInterceptor } from '@nestjs/platform-express';
 import { Express } from 'express';
 
 import { fileUploadOptions } from '../config';
 import { DbImportService } from './db-import.service';
+import { FileUploadDto, ImportResponseDto } from './io.dto';
 
+@ApiTags('import')
 @Controller('db')
 export class DbController {
   constructor(private readonly dbImportService: DbImportService) {}
 
   @Get('import')
-  async import(@Query('filename') fileName?: string) {
+  @ApiQuery({ name: 'filename', required: false })
+  async import(
+    @Query('filename') fileName?: string,
+  ): Promise<ImportResponseDto> {
     return this.dbImportService.importFileFromDiskToDb(fileName);
   }
 
   @Post('import-file')
+  @HttpCode(200)
   @UseInterceptors(FileInterceptor('file', fileUploadOptions))
-  async handleFileImport(@UploadedFile() file: Express.Multer.File) {
+  @ApiConsumes('multipart/form-data')
+  @ApiBody({
+    description: 'File to import',
+    type: FileUploadDto,
+  })
+  async handleFileImport(
+    @UploadedFile() file: Express.Multer.File,
+  ): Promise<ImportResponseDto> {
     return this.dbImportService.uploadFileToDb(file.buffer.toString());
   }
 }

src/db/entities/index.ts

@@ -7,58 +7,94 @@ import {
   ManyToOne,
   JoinColumn,
 } from 'typeorm';
+import { ApiProperty } from '@nestjs/swagger';
 
-export type Currencies = 'CAD' | 'AUD' | 'EUR' | 'UAH' | 'USD';
+export type TCurrencies = 'CAD' | 'AUD' | 'EUR' | 'UAH' | 'USD';
+
+@Entity()
+export class Currency {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @ApiProperty()
+  @Column({
+    unique: true,
+    length: 3,
+  })
+  code: TCurrencies;
+
+  @Column({ length: 50 })
+  title: string;
+}
 
 abstract class CommonRateExchangeInfo {
   @PrimaryGeneratedColumn()
   id: number;
 
-  @Column({ length: 3 })
-  from: Currencies;
+  @ApiProperty({ type: String })
+  @ManyToOne(() => Currency, (cur) => cur.code)
+  @JoinColumn({
+    name: 'from',
+    referencedColumnName: 'code',
+  })
+  from: Currency;
 
-  @Column({ length: 3 })
-  to: Currencies;
+  @ApiProperty({ type: String })
+  @ManyToOne(() => Currency, (cur) => cur.code)
+  @JoinColumn({
+    name: 'to',
+    referencedColumnName: 'code',
+  })
+  to: Currency;
 
+  @ApiProperty()
   @Column()
   date: Date;
 }
 
 @Entity()
 export class Country {
+  @ApiProperty()
   @PrimaryGeneratedColumn()
   id: number;
 
+  @ApiProperty()
   @Column({
     unique: true,
     length: 3,
   })
   code: string;
 
+  @ApiProperty()
   @Column({ length: 50 })
   name: string;
 }
 
 @Entity()
 export class ExchangeOffice {
+  @ApiProperty()
   @PrimaryColumn()
   id: number;
 
+  @ApiProperty()
   @Column({ length: 100 })
   name: string;
 
+  @ApiProperty()
   @ManyToOne(() => Country, (c) => c.code, { nullable: false })
   @JoinColumn({
     name: 'country',
     referencedColumnName: 'code',
   })
   country: Country;
 
+  @ApiProperty({ type: () => [Exchange] })
   @OneToMany(() => Exchange, (exchange) => exchange.exchangeOffice, {
     cascade: true,
   })
   exchanges: Exchange[];
 
+  @ApiProperty({ type: () => [Rate] })
   @OneToMany(() => Rate, (rate) => rate.exchangeOffice, {
     cascade: true,
   })
@@ -68,6 +104,7 @@ export class ExchangeOffice {
 
 @Entity()
 export class Exchange extends CommonRateExchangeInfo {
+  @ApiProperty()
   @Column('float')
   ask: number;
 
@@ -80,12 +117,15 @@ export class Exchange extends CommonRateExchangeInfo {
 
 @Entity()
 export class Rate extends CommonRateExchangeInfo {
+  @ApiProperty()
   @Column('float')
   in: number;
 
+  @ApiProperty()
   @Column('float')
   out: number;
 
+  @ApiProperty()
   @Column('float')
   reserve: number;