#1837 - Fix missing details on submitting Designation Request

sources/packages/backend/apps/api/src/route-controllers/designation-agreement/designation-agreement.institutions.controller.ts

@@ -16,7 +16,11 @@ import {
   IsInstitutionAdmin,
   UserToken,
 } from "../../auth/decorators";
-import { DesignationAgreementService, FormService } from "../../services";
+import {
+  DesignationAgreementService,
+  FormService,
+  InstitutionService,
+} from "../../services";
 import {
   DesignationAgreementAPIOutDTO,
   DesignationAgreementDetailsAPIOutDTO,
@@ -45,6 +49,7 @@ export class DesignationAgreementInstitutionsController extends BaseController {
   constructor(
     private readonly designationAgreementService: DesignationAgreementService,
     private readonly formService: FormService,
+    private readonly institutionService: InstitutionService,
     private readonly designationAgreementControllerService: DesignationAgreementControllerService,
   ) {
     super();
@@ -81,6 +86,12 @@ export class DesignationAgreementInstitutionsController extends BaseController {
         "User does not have the rights to create a designation agreement.",
       );
     }
+
+    // Check if institution is private and append it to the payload.
+    payload.isBCPrivate = await this.institutionService.isPrivateInstitution(
+      userToken.authorizations.institutionId,
+    );
+
     // Validate the dynamic data submission.
     const submissionResult = await this.formService.dryRunSubmission(
       FormNames.DesignationAgreementDetails,

sources/packages/backend/apps/api/src/route-controllers/designation-agreement/models/designation-agreement.dto.ts

@@ -75,6 +75,11 @@ export class SubmitDesignationAgreementAPIInDTO {
   @ValidateNested({ each: true })
   @Type(() => SubmittedLocationsAPIInDTO)
   locations: SubmittedLocationsAPIInDTO[];
+  /**
+   * isBCPrivate is part of the form and defines if the dynamic area of the form.io definition will be visible or not, which also will impact the validation using the dryrun.
+   * Since this value has the source of truth on the institution, it must be populated by the API prior to the dryrun validation and it is part of DTO to make explicit its place in the form payload submitted but it will also be ignored by Nestjs because it does not have a decorator.
+   */
+  isBCPrivate: boolean;
 }
 
 /**

sources/packages/backend/apps/api/src/services/institution/institution.service.ts

@@ -37,6 +37,7 @@ import {
   INSTITUTION_USER_ALREADY_EXISTS,
   LEGAL_SIGNING_AUTHORITY_EXIST,
 } from "../../constants";
+import { INSTITUTION_TYPE_BC_PRIVATE } from "@sims/sims-db/constant";
 import { InstitutionUserAuthService } from "../institution-user-auth/institution-user-auth.service";
 import { UserService } from "../user/user.service";
 
@@ -694,6 +695,37 @@ export class InstitutionService extends RecordDataModelService<Institution> {
       .getOne();
   }
 
+  /**
+   * Check if institution is private.
+   * @param institutionId is the institution id.
+   * @returns boolean true if institution is private, else false.
+   */
+  async isPrivateInstitution(institutionId: number): Promise<boolean> {
+    const institutionType = await this.getInstitutionTypeById(institutionId);
+    return INSTITUTION_TYPE_BC_PRIVATE === institutionType.institutionType.id;
+  }
+
+  /**
+   * Get the institutionType by institution id.
+   * @param institutionId Institution id.
+   * @returns Institution retrieved, if found, otherwise returns null.
+   */
+  async getInstitutionTypeById(institutionId: number): Promise<Institution> {
+    return this.repo.findOne({
+      select: {
+        institutionType: {
+          id: true,
+        },
+      },
+      relations: {
+        institutionType: true,
+      },
+      where: {
+        id: institutionId,
+      },
+    });
+  }
+
   /**
    * Get the basic info of the institution by ID.
    * @param institutionId Institution id.

sources/packages/backend/apps/db-migrations/src/migrations/1680120153698-DesignationAgreementsTableAlterSubmittedData.ts

@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { getSQLFileData } from "../utilities/sqlLoader";
+
+export class DesignationAgreementsTableAlterSubmittedData1680120153698
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData(
+        "Update-col-submitted-data-drop-not-null.sql",
+        "DesignationAgreements",
+      ),
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData(
+        "Update-col-submitted-data-add-not-null.sql",
+        "DesignationAgreements",
+      ),
+    );
+  }
+}

sources/packages/backend/apps/db-migrations/src/sql/DesignationAgreements/Update-col-submitted-data-add-not-null.sql

@@ -0,0 +1,7 @@
+-- Updated the submitted_data column from NULL to NOT NULL
+ALTER TABLE
+  sims.designation_agreements
+ALTER COLUMN
+  submitted_data
+SET
+  NOT NULL;

sources/packages/backend/apps/db-migrations/src/sql/DesignationAgreements/Update-col-submitted-data-drop-not-null.sql

@@ -0,0 +1,5 @@
+-- Updated the submitted_data column from NOT NULL to NULL
+ALTER TABLE
+  sims.designation_agreements
+ALTER COLUMN
+  submitted_data DROP NOT NULL;

sources/packages/backend/libs/sims-db/src/entities/designation-agreement.model.ts

@@ -48,9 +48,9 @@ export class DesignationAgreement extends RecordDataModel {
   @Column({
     name: "submitted_data",
     type: "jsonb",
-    nullable: false,
+    nullable: true,
   })
-  submittedData: any;
+  submittedData: unknown;
   /**
    * Current status of the designation agreement.
    */