#1702 - Allow institution to specify custom regulatory body

sources/packages/backend/apps/api/src/route-controllers/institution/institution.controller.service.ts

@@ -43,6 +43,7 @@ export class InstitutionControllerService {
       primaryEmail: institutionDetail.primaryEmail,
       website: institutionDetail.website,
       regulatingBody: institutionDetail.regulatingBody,
+      otherRegulatingBody: institutionDetail.otherRegulatingBody,
       institutionType: institutionDetail.institutionType.id,
       institutionTypeName: institutionDetail.institutionType.name,
       establishedDate: institutionDetail.establishedDate,

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

@@ -20,6 +20,8 @@ import {
   LEGAL_OPERATING_NAME_MAX_LENGTH,
 } from "@sims/sims-db";
 
+const OTHER_REGULATING_BODY_MAX_LENGTH = 100;
+
 /**
  * DTO for institution creation by the institution user during the on board process
  * when the institution profile and the admin user must be created altogether.
@@ -37,6 +39,10 @@ export class CreateInstitutionAPIInDTO {
   website: string;
   @IsNotEmpty()
   regulatingBody: string;
+  @ValidateIf((e) => e.regulatingBody === "other")
+  @IsNotEmpty()
+  @MaxLength(OTHER_REGULATING_BODY_MAX_LENGTH)
+  otherRegulatingBody: string;
   @IsDateString()
   establishedDate: string;
   @IsPositive()
@@ -102,6 +108,9 @@ export class InstitutionProfileAPIInDTO extends InstitutionContactAPIInDTO {
   website: string;
   @IsNotEmpty()
   regulatingBody: string;
+  @ValidateIf((e) => e.regulatingBody === "other")
+  @IsNotEmpty()
+  otherRegulatingBody: string;
   @IsDateString()
   establishedDate: string;
   @IsPositive()
@@ -114,6 +123,7 @@ export class InstitutionProfileAPIOutDTO extends InstitutionContactAPIOutDTO {
   primaryEmail: string;
   website: string;
   regulatingBody: string;
+  otherRegulatingBody?: string;
   establishedDate: string;
   institutionType: number;
 }

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

@@ -6,6 +6,7 @@ export interface UpdateInstitution {
   primaryEmail?: string;
   website?: string;
   regulatingBody?: string;
+  otherRegulatingBody?: string;
   establishedDate?: string;
   institutionType?: number;
   primaryContactEmail: string;
@@ -34,6 +35,7 @@ export interface InstitutionFormModel {
   primaryEmail: string;
   website: string;
   regulatingBody: string;
+  otherRegulatingBody?: string;
   establishedDate: string;
   primaryContactFirstName: string;
   primaryContactLastName: string;

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

@@ -256,6 +256,7 @@ export class InstitutionService extends RecordDataModelService<Institution> {
     institution.primaryEmail = institutionModel.primaryEmail;
     institution.website = institutionModel.website;
     institution.regulatingBody = institutionModel.regulatingBody;
+    institution.otherRegulatingBody = institutionModel.otherRegulatingBody;
     institution.establishedDate = institutionModel.establishedDate;
     institution.institutionType = {
       id: institutionModel.institutionType,
@@ -853,6 +854,7 @@ export class InstitutionService extends RecordDataModelService<Institution> {
       institution.primaryEmail = updateInstitution.primaryEmail;
       institution.website = updateInstitution.website;
       institution.regulatingBody = updateInstitution.regulatingBody;
+      institution.otherRegulatingBody = updateInstitution.otherRegulatingBody;
       institution.establishedDate = updateInstitution.establishedDate;
       institution.institutionType = {
         id: updateInstitution.institutionType,

sources/packages/backend/apps/db-migrations/src/migrations/1677528030804-InstitutionsTableCreateOtherRegulatingBody.ts

@@ -0,0 +1,18 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { getSQLFileData } from "../utilities/sqlLoader";
+
+export class InstitutionsTableCreateOtherRegulatingBody1677528030804
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData("Add-col-other-regulating-body.sql", "Institution"),
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData("Drop-col-other-regulating-body.sql", "Institution"),
+    );
+  }
+}

sources/packages/backend/apps/db-migrations/src/sql/Institution/Add-col-other-regulating-body.sql

@@ -0,0 +1,7 @@
+-- Add other_regulating_body column to institutions table
+ALTER TABLE
+  sims.institutions
+ADD
+  COLUMN IF NOT EXISTS other_regulating_body VARCHAR(100);
+
+COMMENT ON COLUMN sims.institutions.other_regulating_body IS 'Other institution regulating body.';

sources/packages/backend/apps/db-migrations/src/sql/Institution/Drop-col-other-regulating-body.sql

@@ -0,0 +1,3 @@
+-- Drop other_regulating_body column from institutions table
+ALTER TABLE
+  sims.institutions DROP COLUMN IF EXISTS other_regulating_body;

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

@@ -63,11 +63,20 @@ export class Institution extends RecordDataModel {
     name: "website",
   })
   website: string;
+
   @Column({
     name: "regulating_body",
   })
   regulatingBody: string;
 
+  /**
+   * Other regulating body
+   */
+  @Column({
+    name: "other_regulating_body",
+  })
+  otherRegulatingBody?: string;
+
   @Column({
     name: "established_date",
     type: "date",