api/src/modules/suppliers/suppliers.controller.ts
import {
Body,
Controller,
Delete,
Get,
Param,
Patch,
Post,
Query,
UseInterceptors,
UsePipes,
ValidationPipe,
} from '@nestjs/common';
import { SuppliersService } from 'modules/suppliers/suppliers.service';
import {
ApiBadRequestResponse,
ApiBearerAuth,
ApiForbiddenResponse,
ApiNotFoundResponse,
ApiOkResponse,
ApiOperation,
ApiTags,
ApiUnauthorizedResponse,
} from '@nestjs/swagger';
import {
JSONAPIQueryParams,
JSONAPISingleEntityQueryParams,
} from 'decorators/json-api-parameters.decorator';
import {
FetchSpecification,
ProcessFetchSpecification,
} from 'nestjs-base-service';
import { Supplier, supplierResource } from 'modules/suppliers/supplier.entity';
import { CreateSupplierDto } from 'modules/suppliers/dto/create.supplier.dto';
import { UpdateSupplierDto } from 'modules/suppliers/dto/update.supplier.dto';
import { ApiOkTreeResponse } from 'decorators/api-tree-response.decorator';
import { PaginationMeta } from 'utils/app-base.service';
import { GetSupplierTreeWithOptions } from 'modules/suppliers/dto/get-supplier-tree-with-options.dto';
import {
GetSupplierByType,
GetSupplierEUDR,
} from 'modules/suppliers/dto/get-supplier-by-type.dto';
import { SetScenarioIdsInterceptor } from 'modules/impact/set-scenario-ids.interceptor';
@Controller(`/api/v1/suppliers`)
@ApiTags(supplierResource.className)
@ApiBearerAuth()
export class SuppliersController {
constructor(public readonly suppliersService: SuppliersService) {}
@ApiOperation({
description: 'Find all suppliers',
})
@ApiOkResponse({
type: Supplier,
})
@ApiUnauthorizedResponse()
@ApiForbiddenResponse()
@JSONAPIQueryParams({
availableFilters: supplierResource.columnsAllowedAsFilter.map(
(columnName: string) => ({
name: columnName,
}),
),
})
@Get()
async findAll(
@ProcessFetchSpecification({
allowedFilters: supplierResource.columnsAllowedAsFilter,
})
fetchSpecification: FetchSpecification,
): Promise<Supplier> {
const results: {
data: (Partial<Supplier> | undefined)[];
metadata: PaginationMeta | undefined;
} = await this.suppliersService.findAllPaginated(fetchSpecification);
return this.suppliersService.serialize(results.data, results.metadata);
}
@ApiOperation({
description:
'Find all suppliers and return them in a tree format. Data in the "children" will recursively extend for the full depth of the tree',
})
@ApiOkTreeResponse({
treeNodeType: Supplier,
})
@ApiUnauthorizedResponse()
@ApiForbiddenResponse()
@UseInterceptors(SetScenarioIdsInterceptor)
@Get('/trees')
async getTrees(
@Query(ValidationPipe) supplierTreeOptions: GetSupplierTreeWithOptions,
): Promise<Supplier> {
const results: Supplier[] = await this.suppliersService.getTrees(
supplierTreeOptions,
);
return this.suppliersService.serialize(results);
}
@ApiOperation({
description: 'Find all suppliers by type',
})
@ApiOkResponse({
type: Supplier,
})
@ApiUnauthorizedResponse()
@ApiForbiddenResponse()
@Get('/types')
async getSupplierByType(
@Query(ValidationPipe) type: GetSupplierByType,
): Promise<Supplier[]> {
const results: Supplier[] = await this.suppliersService.getSupplierByType(
type,
);
return this.suppliersService.serialize(results);
}
@ApiOperation({ description: 'Find supplier by id' })
@ApiOkResponse({ type: Supplier })
@ApiNotFoundResponse({ description: 'Supplier not found' })
@JSONAPISingleEntityQueryParams()
@Get(':id')
async findOne(@Param('id') id: string): Promise<Supplier> {
return await this.suppliersService.serialize(
await this.suppliersService.getById(id),
);
}
@ApiOperation({ description: 'Create a supplier' })
@ApiOkResponse({ type: Supplier })
@ApiBadRequestResponse({
description: 'Bad Request. Incorrect or missing parameters',
})
@Post()
@UsePipes(ValidationPipe)
async create(@Body() dto: CreateSupplierDto): Promise<Supplier> {
return await this.suppliersService.serialize(
await this.suppliersService.create(dto),
);
}
@ApiOperation({ description: 'Updates a supplier' })
@ApiOkResponse({ type: Supplier })
@ApiNotFoundResponse({ description: 'Supplier not found' })
@Patch(':id')
async update(
@Body(new ValidationPipe()) dto: UpdateSupplierDto,
@Param('id') id: string,
): Promise<Supplier> {
return await this.suppliersService.serialize(
await this.suppliersService.update(id, dto),
);
}
@ApiOperation({ description: 'Deletes a supplier' })
@ApiOkResponse()
@ApiNotFoundResponse({ description: 'Supplier not found' })
@Delete(':id')
async delete(@Param('id') id: string): Promise<void> {
return await this.suppliersService.remove(id);
}
}