feat: add instrumentIds property to Proposal schema (#2124)

* feat: add instrumentIds property to Proposal schema

* add missing config

* fix proposal fullQuery example

* make _id customizable for each measurementPeriod

* add missing fields in the dto

Author: Junjiequan

migrations/20250814143105-add-instrumentids-field-to-proposal.js

@@ -0,0 +1,14 @@
+module.exports = {
+  async up(db, client) {
+    await db
+      .collection("Proposal")
+      .updateMany(
+        { instrumentIds: { $exists: false } },
+        { $set: { instrumentIds: [] } },
+      );
+  },
+
+  async down(db, client) {
+    // No path backward
+  },
+};

src/common/utils.ts

@@ -922,7 +922,7 @@ export const filterDescription =
 </pre>';
 
 export const fullQueryExampleLimits =
-  '{"limit": 1, "skip": 1, "order": "creationTime:desc"}';
+  '{"limit": 1, "skip": 0, "order": "creationTime:desc"}';
 
 export const fullQueryDescriptionLimits =
   '<pre>\n \

src/config/frontend.config.json

@@ -436,5 +436,27 @@
         "row": 2
       }
     ]
+  },
+  "mainMenu": {
+    "nonAuthenticatedUser": {
+      "datasets": true,
+      "files": false,
+      "instruments": true,
+      "jobs": false,
+      "policies": false,
+      "proposals": true,
+      "publishedData": true,
+      "samples": false
+    },
+    "authenticatedUser": {
+      "datasets": true,
+      "files": true,
+      "instruments": true,
+      "jobs": true,
+      "policies": false,
+      "proposals": true,
+      "publishedData": true,
+      "samples": true
+    }
   }
 }

src/proposals/dto/create-measurement-period.dto.ts

@@ -1,6 +1,12 @@
 import { IsDateString, IsOptional, IsString } from "class-validator";
 
 export class CreateMeasurementPeriodDto {
+  /**
+   * Unique identifier for the measurement period. Ideally, it should match the UUID of the corresponding instrument from the instrument table
+   */
+  @IsOptional()
+  @IsString()
+  readonly _id?: string;
   /**
    * Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT
    */

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

@@ -111,6 +111,14 @@ export class UpdateProposalDto extends OwnableDto {
   @IsOptional()
   @IsString()
   readonly type?: string;
+
+  /**
+   * List of instrument IDs associated with the proposal.
+   */
+  @IsOptional()
+  @IsArray()
+  @IsString({ each: true })
+  readonly instrumentIds?: string[];
 }
 
 export class PartialUpdateProposalDto extends PartialType(UpdateProposalDto) {}

src/proposals/schemas/measurement-period.schema.ts

@@ -5,6 +5,14 @@ export type MeasurementPeriodDocument = MeasurementPeriodClass & Document;
 
 @Schema()
 export class MeasurementPeriodClass {
+  /**
+   * Unique identifier for the measurement period. Ideally, it should match the UUID of the corresponding instrument from the instrument table
+   */
+  @Prop({
+    type: String,
+  })
+  _id: string;
+
   /**
    * Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT
    */

src/proposals/schemas/proposal.schema.ts

@@ -161,6 +161,16 @@ export class ProposalClass extends OwnableClass {
     default: DEFAULT_PROPOSAL_TYPE,
   })
   type: string = DEFAULT_PROPOSAL_TYPE;
+
+  /**
+   * List of instrument IDs associated with the proposal.
+   */
+  @Prop({
+    type: [String],
+    default: [],
+    required: false,
+  })
+  instrumentIds?: string[];
 }
 
 export const ProposalSchema = SchemaFactory.createForClass(ProposalClass);