feat: add type property to the proposal document with database migration

migrations/20241113130700-proposal-type.js

@@ -0,0 +1,12 @@
+module.exports = {
+  async up(db, client) {
+    db.collection("Proposal").updateMany(
+      { type: { $exists: false } },
+      { $set: { type: "Default Proposal" } },
+    );
+  },
+
+  async down(db, client) {
+    db.collection("Proposal").updateMany({}, { $unset: { type: 1 } });
+  },
+};

src/proposals/dto/update-proposal.dto.ts

@@ -4,12 +4,14 @@ import {
   IsArray,
   IsDateString,
   IsEmail,
+  IsEnum,
   IsObject,
   IsOptional,
   IsString,
   ValidateNested,
 } from "class-validator";
 import { OwnableDto } from "../../common/dto/ownable.dto";
+import { ProposalType } from "../proposal-type.enum";
 import { CreateMeasurementPeriodDto } from "./create-measurement-period.dto";
 
 @ApiTags("proposals")
@@ -133,6 +135,21 @@ export class UpdateProposalDto extends OwnableDto {
   @IsOptional()
   @IsString()
   readonly parentProposalId?: string;
+
+  @ApiProperty({
+    type: String,
+    required: false,
+    enum: [
+      ProposalType.DefaultProposal,
+      ProposalType.DOORProposal,
+      ProposalType.Beamtime,
+    ],
+    description:
+      "Characterize type of proposal, either 'Default Proposal', 'DOOR Proposal' or 'Beamtime'",
+  })
+  @IsOptional()
+  @IsEnum(ProposalType)
+  readonly type?: string;
 }
 
 export class PartialUpdateProposalDto extends PartialType(UpdateProposalDto) {}

src/proposals/proposal-type.enum.ts

@@ -0,0 +1,5 @@
+export enum ProposalType {
+  DefaultProposal = "Default Proposal",
+  DOORProposal = "DOOR Proposal",
+  Beamtime = "Beamtime",
+}

src/proposals/schemas/proposal.schema.ts

@@ -3,6 +3,7 @@ import { ApiProperty } from "@nestjs/swagger";
 import { Document } from "mongoose";
 
 import { OwnableClass } from "src/common/schemas/ownable.schema";
+import { ProposalType } from "../proposal-type.enum";
 import {
   MeasurementPeriodClass,
   MeasurementPeriodSchema,
@@ -182,6 +183,30 @@ export class ProposalClass extends OwnableClass {
     ref: "Proposal",
   })
   parentProposalId: string;
+
+  @ApiProperty({
+    type: String,
+    required: true,
+    enum: [
+      ProposalType.DefaultProposal,
+      ProposalType.DOORProposal,
+      ProposalType.Beamtime,
+    ],
+    default: ProposalType.DefaultProposal,
+    description:
+      "Characterize type of proposal, either 'Default Proposal', 'DOOR Proposal' or 'Beamtime'",
+  })
+  @Prop({
+    type: String,
+    required: true,
+    enum: [
+      ProposalType.DefaultProposal,
+      ProposalType.DOORProposal,
+      ProposalType.Beamtime,
+    ],
+    default: ProposalType.DefaultProposal,
+  })
+  type: string;
 }
 
 export const ProposalSchema = SchemaFactory.createForClass(ProposalClass);

test/Proposal.js

@@ -171,6 +171,8 @@ describe("1500: Proposal: Simple Proposal", () => {
       .then((res) => {
         res.body.should.have.property("createdBy").and.be.string;
         res.body.should.have.property("updatedBy").and.be.string;
+        res.body.should.have.property("type").and.be.string;
+        res.body.type.should.be.equal("Default Proposal");
       });
   });
 
@@ -241,6 +243,45 @@ describe("1500: Proposal: Simple Proposal", () => {
       });
   });
 
+  it("0116: adds a new proposal with a type different than default", async () => {
+    const proposalType = "DOOR Proposal";
+    const proposalWithType = {
+      ...TestData.ProposalCorrectComplete,
+      proposalId: faker.string.numeric(8),
+      type: proposalType,
+    };
+
+    return request(appUrl)
+      .post("/api/v3/Proposals")
+      .send(proposalWithType)
+      .set("Accept", "application/json")
+      .set({ Authorization: `Bearer ${accessTokenProposalIngestor}` })
+      .expect(TestData.EntryCreatedStatusCode)
+      .expect("Content-Type", /json/)
+      .then((res) => {
+        res.body.should.have.property("ownerGroup").and.be.string;
+        res.body.should.have.property("proposalId").and.be.string;
+        res.body.type.should.be.equal(proposalType);
+      });
+  });
+
+  it("0117: cannot add a new proposal with a type different than predefined proposal types", async () => {
+    const proposalType = "Incorrect type";
+    const proposalWithIncorrectType = {
+      ...TestData.ProposalCorrectComplete,
+      proposalId: faker.string.numeric(8),
+      type: proposalType,
+    };
+
+    return request(appUrl)
+      .post("/api/v3/Proposals")
+      .send(proposalWithIncorrectType)
+      .set("Accept", "application/json")
+      .set({ Authorization: `Bearer ${accessTokenProposalIngestor}` })
+      .expect(TestData.BadRequestStatusCode)
+      .expect("Content-Type", /json/);
+  });
+
   it("0120: updates a proposal with a new parent proposal", async () => {
     return request(appUrl)
       .patch("/api/v3/Proposals/" + proposalWithParentId)