[TBCCT-275] fix(api): Remove ecosystem dependant assumptions for conservation activity type (Refactor to reduce technical debt needed)

api/src/modules/calculations/assumptions.repository.ts

@@ -10,8 +10,8 @@ import {
   COMMON_OVERRIDABLE_ASSUMPTION_NAMES,
   ECOSYSTEM_RESTORATION_RATE_NAMES,
 } from '@shared/schemas/assumptions/assumptions.enums';
-import { OverridableAssumptions } from '@api/modules/custom-projects/dto/project-assumptions.dto';
 import { ModelAssumptions } from '@shared/entities/model-assumptions.entity';
+import { OverridableAssumptionsDto } from '@api/modules/custom-projects/dto/create-custom-project.dto';
 
 const NON_OVERRIDABLE_ASSUMPTION_NAMES_MAP = {
   'Annual cost increase': 'annualCostIncrease',
@@ -57,9 +57,6 @@ export class AssumptionsRepository extends Repository<ModelAssumptions> {
       })
       .orderBy('name', 'ASC')
       .getRawMany();
-    if (assumptions.length !== 7) {
-      throw new Error('Not all required overridable assumptions were found');
-    }
     return assumptions;
   }
 
@@ -68,7 +65,9 @@ export class AssumptionsRepository extends Repository<ModelAssumptions> {
   ): string[] {
     const { ecosystem, activity } = dto;
     const assumptions = [...COMMON_OVERRIDABLE_ASSUMPTION_NAMES] as string[];
-    assumptions.push(this.map[ecosystem]);
+    if (activity === ACTIVITY.RESTORATION) {
+      assumptions.push(this.map[ecosystem]);
+    }
     assumptions.push(this.map[activity]);
     return assumptions;
   }
@@ -127,4 +126,4 @@ export class NonOverridableModelAssumptions {
 }
 
 export type ModelAssumptionsForCalculations = NonOverridableModelAssumptions &
-  OverridableAssumptions;
+  OverridableAssumptionsDto;

api/src/modules/calculations/calculation.engine.ts

@@ -1,5 +1,4 @@
 import { Injectable } from '@nestjs/common';
-import { DataSource } from 'typeorm';
 import {
   CostCalculator,
   ProjectInput,

api/src/modules/calculations/cost.calculator.ts

@@ -5,10 +5,6 @@ import { ConservationProjectInput } from '@api/modules/custom-projects/input-fac
 import { RestorationProjectInput } from '@api/modules/custom-projects/input-factory/restoration-project.input';
 import { BaseSize } from '@shared/entities/base-size.entity';
 import { BaseIncrease } from '@shared/entities/base-increase.entity';
-import {
-  OverridableCostInputs,
-  PROJECT_DEVELOPMENT_TYPE,
-} from '@api/modules/custom-projects/dto/project-cost-inputs.dto';
 import { RevenueProfitCalculator } from '@api/modules/calculations/revenue-profit.calculator';
 import { SequestrationRateCalculator } from '@api/modules/calculations/sequestration-rate.calculator';
 import { parseInt, sum } from 'lodash';
@@ -20,9 +16,11 @@ import {
   YearlyBreakdown,
   YearlyBreakdownCostName,
 } from '@shared/dtos/custom-projects/custom-project-output.dto';
+import { OverridableCostInputsDto } from '@api/modules/custom-projects/dto/create-custom-project.dto';
+import { PROJECT_DEVELOPMENT_TYPE } from '@shared/dtos/projects/project-development.type';
 
 export type CostPlans = Record<
-  keyof OverridableCostInputs | string,
+  keyof OverridableCostInputsDto | string,
   CostPlanMap
 >;
 

api/src/modules/calculations/data.repository.ts

@@ -8,7 +8,6 @@ import {
   RESTORATION_ACTIVITY_SUBTYPE,
 } from '@shared/entities/activity.enum';
 import { GetOverridableCostInputs } from '@shared/dtos/custom-projects/get-overridable-cost-inputs.dto';
-import { OverridableCostInputs } from '@api/modules/custom-projects/dto/project-cost-inputs.dto';
 import { BaseSize } from '@shared/entities/base-size.entity';
 import { BaseIncrease } from '@shared/entities/base-increase.entity';
 import { AssumptionsRepository } from '@api/modules/calculations/assumptions.repository';
@@ -19,6 +18,7 @@ import {
   RestorationActivityDefaults,
 } from '@shared/dtos/custom-projects/activity-types-defaults';
 import { Country } from '@shared/entities/country.entity';
+import { OverridableCostInputsDto } from '@api/modules/custom-projects/dto/create-custom-project.dto';
 
 /**
  * Additional data that is required to perform calculations, which is not overridable by the user. Better naming and clustering of concepts would be great
@@ -189,7 +189,7 @@ export class DataRepository extends Repository<BaseDataView> {
 
   async getOverridableCostInputs(
     dto: GetOverridableCostInputs,
-  ): Promise<OverridableCostInputs> {
+  ): Promise<OverridableCostInputsDto> {
     const { countryCode, activity, ecosystem } = dto;
     const queryBuilder = this.createQueryBuilder().where({
       countryCode,

api/src/modules/calculations/sequestration-rate.calculator.ts

@@ -1,21 +1,21 @@
 import { Injectable } from '@nestjs/common';
 import { ProjectInput } from '@api/modules/calculations/cost.calculator';
 import { ACTIVITY } from '@shared/entities/activity.enum';
-import { OverridableAssumptions } from '@api/modules/custom-projects/dto/project-assumptions.dto';
 import { NonOverridableModelAssumptions } from '@api/modules/calculations/assumptions.repository';
 import { AdditionalBaseData } from '@api/modules/calculations/data.repository';
 import { CostPlanMap } from '@shared/dtos/custom-projects/custom-project-output.dto';
+import { OverridableAssumptionsDto } from '@api/modules/custom-projects/dto/create-custom-project.dto';
 
 @Injectable()
 export class SequestrationRateCalculator {
   projectInput: ProjectInput;
   activity: ACTIVITY;
   defaultProjectLength: number;
   projectLength: number;
-  buffer: OverridableAssumptions['buffer'];
+  buffer: OverridableAssumptionsDto['buffer'];
   plantingSuccessRate: NonOverridableModelAssumptions['plantingSuccessRate'];
   tier1SequestrationRate: AdditionalBaseData['tier1SequestrationRate'];
-  restorationRate: OverridableAssumptions['restorationRate'];
+  restorationRate: OverridableAssumptionsDto['restorationRate'];
   soilOrganicCarbonReleaseLength: NonOverridableModelAssumptions['soilOrganicCarbonReleaseLength'];
   constructor(projectInput: ProjectInput) {
     this.projectInput = projectInput;

api/src/modules/custom-projects/cost-inputs.interface.ts

@@ -1,5 +1,3 @@
-import { ViewColumn } from 'typeorm';
-
 export interface CostInputsDeprecated {
   feasibilityAnalysis: number;
   conservationPlanningAndAdmin: number;

api/src/modules/custom-projects/custom-projects.controller.ts

@@ -10,7 +10,6 @@ import { tsRestHandler, TsRestHandler } from '@ts-rest/nest';
 import { ControllerResponse } from '@api/types/controller-response.type';
 import { customProjectContract } from '@shared/contracts/custom-projects.contract';
 import { CustomProjectsService } from '@api/modules/custom-projects/custom-projects.service';
-import { CreateCustomProjectDto } from '@api/modules/custom-projects/dto/create-custom-project-dto';
 import { GetUser } from '@api/decorators/get-user.decorator';
 import { User } from '@shared/entities/users/user.entity';
 import { AuthGuard } from '@nestjs/passport';
@@ -73,17 +72,12 @@ export class CustomProjectsController {
     );
   }
 
-  @TsRestHandler(customProjectContract.createCustomProject, {
-    validateRequestBody: false,
-  })
-  async create(
-    @Body(new ValidationPipe({ enableDebugMessages: true, transform: true }))
-    dto: CreateCustomProjectDto,
-  ): Promise<ControllerResponse> {
+  @TsRestHandler(customProjectContract.createCustomProject)
+  async create(): Promise<ControllerResponse> {
     return tsRestHandler(
       customProjectContract.createCustomProject,
-      async () => {
-        const customProject = await this.customProjects.create(dto as any);
+      async ({ body }) => {
+        const customProject = await this.customProjects.create(body);
         return {
           status: 201,
           body: { data: customProject },

api/src/modules/custom-projects/custom-projects.service.ts

@@ -4,15 +4,13 @@ import {
   ServiceUnavailableException,
 } from '@nestjs/common';
 import { AppBaseService } from '@api/utils/app-base.service';
-import { CreateCustomProjectDto } from '@api/modules/custom-projects/dto/create-custom-project-dto';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository, SelectQueryBuilder } from 'typeorm';
 import { CustomProject } from '@shared/entities/custom-project.entity';
 import { CalculationEngine } from '@api/modules/calculations/calculation.engine';
 import { CustomProjectFactory } from '@api/modules/custom-projects/input-factory/custom-project.factory';
 import { GetOverridableCostInputs } from '@shared/dtos/custom-projects/get-overridable-cost-inputs.dto';
 import { DataRepository } from '@api/modules/calculations/data.repository';
-import { OverridableCostInputs } from '@api/modules/custom-projects/dto/project-cost-inputs.dto';
 import { GetOverridableAssumptionsDTO } from '@shared/dtos/custom-projects/get-overridable-assumptions.dto';
 import { AssumptionsRepository } from '@api/modules/calculations/assumptions.repository';
 import { User } from '@shared/entities/users/user.entity';
@@ -23,6 +21,10 @@ import { GetActivityTypesDefaults } from '@shared/dtos/custom-projects/get-activ
 import { z } from 'zod';
 import { customProjecsQuerySchema } from '@shared/contracts/custom-projects.contract';
 import { In } from 'typeorm';
+import {
+  CreateCustomProjectDto,
+  OverridableCostInputsDto,
+} from '@api/modules/custom-projects/dto/create-custom-project.dto';
 
 export type CustomProjectFetchSpecificacion = z.infer<
   typeof customProjecsQuerySchema
@@ -48,7 +50,7 @@ export class CustomProjectsService extends AppBaseService<
     super(repo, 'customProject', 'customProjects');
   }
 
-  async create(dto: CreateCustomProjectDto): Promise<any> {
+  async create(dto: CreateCustomProjectDto): Promise<CustomProject> {
     const { countryCode, ecosystem, activity } = dto;
     const {
       additionalBaseData,
@@ -114,7 +116,7 @@ export class CustomProjectsService extends AppBaseService<
 
   async getDefaultCostInputs(
     dto: GetOverridableCostInputs,
-  ): Promise<OverridableCostInputs> {
+  ): Promise<OverridableCostInputsDto> {
     return this.dataRepository.getOverridableCostInputs(dto);
   }
 

api/src/modules/custom-projects/dto/create-custom-project.dto.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import {
+  AssumptionsSchema,
+  ConservationCustomProjectSchema,
+  CreateCustomProjectSchema,
+  InputCostsSchema,
+} from '@shared/schemas/custom-projects/create-custom-project.schema';
+
+export type CreateCustomProjectDto = z.infer<typeof CreateCustomProjectSchema>;
+export type ConservationCustomProjectDto = z.infer<
+  typeof ConservationCustomProjectSchema
+>;
+export type OverridableCostInputsDto = z.infer<typeof InputCostsSchema>;
+export type OverridableAssumptionsDto = z.infer<typeof AssumptionsSchema>;

api/src/modules/custom-projects/dto/custom-project-snapshot.dto.ts

@@ -5,8 +5,8 @@ import {
   IsString,
   IsOptional,
 } from 'class-validator';
-import { CreateCustomProjectDto } from './create-custom-project-dto';
 import { CustomProjectOutput } from '@shared/dtos/custom-projects/custom-project-output.dto';
+import { CreateCustomProjectDto } from '@api/modules/custom-projects/dto/create-custom-project.dto';
 
 export class CustomPrpjectAnnualProjectCashFlowDto {
   @IsArray()