Update dropdown values intake forms, DB migration to convert previous values to new values

app/src/controllers/submission.ts

@@ -82,7 +82,7 @@ const controller = {
     if (data.basic) {
       basic = {
         consentToFeedback: data.basic.consentToFeedback ?? false,
-        isDevelopedByCompanyOrOrg: data.basic.isDevelopedByCompanyOrOrg,
+        projectApplicantType: data.basic.projectApplicantType,
         isDevelopedInBC: data.basic.isDevelopedInBC,
         companyNameRegistered: data.basic.registeredName
       };

app/src/db/migrations/20241218000000_018-intake-value-conversion.ts

@@ -0,0 +1,56 @@
+/* eslint-disable max-len */
+import type { Knex } from 'knex';
+
+export async function up(knex: Knex): Promise<void> {
+  return Promise.resolve()
+    .then(() =>
+      knex.schema.raw(`update public.contact
+        set contact_applicant_relationship = case
+          when contact_applicant_relationship = 'Owner' then 'Property owner'
+          when contact_applicant_relationship = 'Employee' then 'Project consultant'
+          when contact_applicant_relationship = 'Agent' then 'Project consultant'
+          when contact_applicant_relationship = 'Consultant' then 'Project consultant'
+          else contact_applicant_relationship
+        end`)
+    )
+
+    .then(() =>
+      knex.schema.raw(`update public.submission
+        set is_developed_by_company_or_org = case
+          when is_developed_by_company_or_org = 'No' then 'Individual'
+          else 'Business'
+        end`)
+    )
+
+    .then(() =>
+      knex.schema.alterTable('submission', (table) => {
+        table.renameColumn('is_developed_by_company_or_org', 'project_applicant_type');
+      })
+    );
+}
+
+export async function down(knex: Knex): Promise<void> {
+  return Promise.resolve()
+
+    .then(() =>
+      knex.schema.alterTable('submission', (table) => {
+        table.renameColumn('project_applicant_type', 'is_developed_by_company_or_org');
+      })
+    )
+    .then(() =>
+      knex.schema.raw(`update public.submission
+        set is_developed_by_company_or_org = case
+          when is_developed_by_company_or_org = 'Individual' then 'No'
+          else 'Yes'
+        end`)
+    )
+
+    .then(() =>
+      knex.schema.raw(`update public.contact
+      set contact_applicant_relationship = case
+        when contact_applicant_relationship = 'Property owner' then 'Owner'
+        when contact_applicant_relationship = 'Project consultant' then 'Agent'
+        else contact_applicant_relationship
+      end`)
+    );
+}

app/src/db/models/submission.ts

@@ -79,7 +79,7 @@ export default {
       waiting_on: input.waitingOn,
       intake_status: input.intakeStatus,
       application_status: input.applicationStatus,
-      is_developed_by_company_or_org: input.isDevelopedByCompanyOrOrg,
+      project_applicant_type: input.projectApplicantType,
       is_developed_in_bc: input.isDevelopedInBC,
       multi_family_units: input.multiFamilyUnits,
       other_units: input.otherUnits,
@@ -133,7 +133,7 @@ export default {
       waitingOn: input.waiting_on,
       intakeStatus: input.intake_status,
       applicationStatus: input.application_status,
-      isDevelopedByCompanyOrOrg: input.is_developed_by_company_or_org,
+      projectApplicantType: input.project_applicant_type,
       isDevelopedInBC: input.is_developed_in_bc,
       multiFamilyUnits: input.multi_family_units,
       otherUnits: input.other_units,

app/src/db/prisma/schema.prisma

@@ -276,7 +276,7 @@ model submission {
   updated_at                         DateTime? @db.Timestamptz(6)
   has_rental_units                   String?
   project_description                String?
-  is_developed_by_company_or_org     String?
+  project_applicant_type             String?
   is_developed_in_bc                 String?
   multi_family_units                 String?
   other_units                        String?

app/src/docs/v1.api-spec.yaml

@@ -1152,7 +1152,7 @@ components:
           example: [email protected]
         contactApplicantRelationship:
           type: string
-          enum: [Owner, Employee, Agent, Consultant, Other]
+          enum: [Property owner, Project consultant, Other]
           description: Relationship of the contact person to the project
           example: Agent
         contactPreference:
@@ -1638,10 +1638,11 @@ components:
           type: string
           description: Status of the application
           example: New
-        isDevelopedByCompanyOrOrg:
+        projectApplicantType:
           type: string
-          description: Is the project being developed by a company or organization
-          example: 'Yes'
+          enum: [Business, Individual]
+          description: Are you applying as an individual or as a business?
+          example: 'Business'
         isDevelopedInBC:
           type: string
           description: Is the project developed in BC?
@@ -1993,12 +1994,11 @@ components:
         basic:
           type: object
           properties:
-            isDevelopedByCompanyOrOrg:
-              type: boolean
-              description: >-
-                Indicates if the project is being developed by a company or
-                organization
-              example: true
+            projectApplicantType:
+              type: string
+              enum: [Business, Individual]
+              description: Are you applying as an individual or as a business?
+              example: 'Business'
             isDevelopedInBC:
               type: boolean
               description: >-

app/src/services/submission.ts

@@ -88,7 +88,7 @@ const service = {
           has_applied_provincial_permits: x.hasAppliedProvincialPermits,
           housing_coop_description: x.housingCoopDescription,
           indigenous_description: x.indigenousDescription,
-          is_developed_by_company_or_org: x.isDevelopedByCompanyOrOrg,
+          project_applicant_type: x.projectApplicantType,
           is_developed_in_bc: x.isDevelopedInBC,
           intake_status: x.intakeStatus,
           location_pids: x.locationPIDs,

app/src/types/Submission.ts

@@ -37,7 +37,7 @@ export type Submission = {
   waitingOn: string | null;
   intakeStatus: string | null;
   applicationStatus: string | null;
-  isDevelopedByCompanyOrOrg: string | null;
+  projectApplicantType: string | null;
   isDevelopedInBC: string | null;
   multiFamilyUnits: string | null;
   otherUnits: string | null;

app/src/types/SubmissionIntake.ts

@@ -11,7 +11,7 @@ export type SubmissionIntake = {
 
   basic?: {
     consentToFeedback?: boolean;
-    isDevelopedByCompanyOrOrg?: string | null;
+    projectApplicantType?: string | null;
     isDevelopedInBC?: string | null;
     registeredName?: string;
   };

app/src/utils/constants/housing.ts

@@ -12,6 +12,7 @@ import {
   PermitAuthorizationStatus,
   PermitNeeded,
   PermitStatus,
+  ProjectApplicant,
   ProjectLocation,
   ProjectRelationship,
   SubmissionType
@@ -72,10 +73,10 @@ export const ORG_BOOK_QUERY_PARAMS = {
   revoked: false
 };
 
+export const PROJECT_APPLICANT_LIST = [ProjectApplicant.BUSINESS, ProjectApplicant.INDIVIDUAL];
+
 export const PROJECT_RELATIONSHIP_LIST = [
   ProjectRelationship.OWNER,
-  ProjectRelationship.EMPLOYEE,
-  ProjectRelationship.AGENT,
   ProjectRelationship.CONSULTANT,
   ProjectRelationship.OTHER
 ];

app/src/utils/enums/housing.ts

@@ -80,11 +80,14 @@ export enum PermitStatus {
   PENDING = 'Pending decision'
 }
 
+export enum ProjectApplicant {
+  BUSINESS = 'Business',
+  INDIVIDUAL = 'Individual'
+}
+
 export enum ProjectRelationship {
-  OWNER = 'Owner',
-  EMPLOYEE = 'Employee',
-  AGENT = 'Agent',
-  CONSULTANT = 'Consultant',
+  OWNER = 'Property owner',
+  CONSULTANT = 'Project consultant',
   OTHER = 'Other'
 }
 

app/src/validators/basic.ts

@@ -1,23 +1,23 @@
 import Joi from 'joi';
 
 import { YES_NO_LIST } from '../utils/constants/application';
-import { ENQUIRY_TYPE_LIST } from '../utils/constants/housing';
-import { BasicResponse } from '../utils/enums/application';
+import { ENQUIRY_TYPE_LIST, PROJECT_APPLICANT_LIST } from '../utils/constants/housing';
+import { ProjectApplicant } from '../utils/enums/housing';
 
 export const basicIntake = Joi.object({
   consentToFeedback: Joi.boolean(),
-  isDevelopedByCompanyOrOrg: Joi.string()
+  projectApplicantType: Joi.string()
     .required()
-    .valid(...YES_NO_LIST),
-  isDevelopedInBC: Joi.when('isDevelopedByCompanyOrOrg', {
-    is: BasicResponse.YES,
+    .valid(...PROJECT_APPLICANT_LIST),
+  isDevelopedInBC: Joi.when('projectApplicantType', {
+    is: ProjectApplicant.BUSINESS,
     then: Joi.string()
       .required()
       .valid(...YES_NO_LIST),
     otherwise: Joi.string().allow(null)
   }),
-  registeredName: Joi.when('isDevelopedInBC', {
-    is: Joi.valid(BasicResponse.YES, BasicResponse.NO),
+  registeredName: Joi.when('projectApplicantType', {
+    is: ProjectApplicant.BUSINESS,
     then: Joi.string().required().max(255).trim(),
     otherwise: Joi.string().allow(null)
   })

app/tests/unit/controllers/submission.spec.ts

@@ -52,7 +52,7 @@ const SUBMISSION_1 = {
   contactPhoneNumber: null,
   contactEmail: null,
   contactPreference: null,
-  contactApplicantRelationship: null,
+  contactApplicantRelationship: 'Property owner',
   projectName: null,
   projectDescription: null,
   singleFamilyUnits: null,
@@ -120,7 +120,7 @@ describe('createSubmission', () => {
       body: {
         applicant: {},
         basic: {
-          isDevelopedByCompanyOrOrg: true
+          projectApplicantType: 'Individual'
         },
         housing: {
           projectName: 'TheProject'
@@ -146,7 +146,7 @@ describe('createSubmission', () => {
     expect(createSubmissionSpy).toHaveBeenCalledTimes(1);
     expect(createSubmissionSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        isDevelopedByCompanyOrOrg: true,
+        projectApplicantType: 'Individual',
         projectName: 'TheProject',
         projectLocation: 'Some place',
         hasAppliedProvincialPermits: true,
@@ -408,7 +408,7 @@ describe('submitDraft', () => {
       body: {
         contacts: [{ firstName: 'test', lastName: 'person' }],
         basic: {
-          isDevelopedByCompanyOrOrg: true
+          projectApplicantType: 'Individual'
         },
         housing: {
           projectName: 'TheProject'
@@ -436,7 +436,7 @@ describe('submitDraft', () => {
     expect(createSubmissionSpy).toHaveBeenCalledTimes(1);
     expect(createSubmissionSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        isDevelopedByCompanyOrOrg: true,
+        projectApplicantType: 'Individual',
         projectName: 'TheProject',
         projectLocation: 'Some place',
         hasAppliedProvincialPermits: true,
@@ -558,7 +558,7 @@ describe('updateDraft', () => {
         contactFirstName: 'test',
         contactLastName: 'person',
         basic: {
-          isDevelopedByCompanyOrOrg: true
+          projectApplicantType: 'Business'
         },
         housing: {
           projectName: 'TheProject'
@@ -600,7 +600,7 @@ describe('updateDraft', () => {
         contactFirstName: 'test',
         contactLastName: 'person',
         basic: {
-          isDevelopedByCompanyOrOrg: true
+          projectApplicantType: 'Business'
         },
         housing: {
           projectName: 'TheProject'

app/tests/unit/validators/basic.spec.ts

@@ -1,10 +1,11 @@
 import { BasicResponse } from '../../../src/utils/enums/application';
+import { ProjectApplicant } from '../../../src/utils/enums/housing';
 import { basicIntake, basicEnquiry } from '../../../src/validators/basic';
 
 describe('basicIntakeSchema', () => {
-  it('should validate when isDevelopedByCompanyOrOrg and isDevelopedInBC are valid', () => {
+  it('should validate when projectApplicantType and isDevelopedInBC are valid', () => {
     const data = {
-      isDevelopedByCompanyOrOrg: BasicResponse.YES,
+      projectApplicantType: ProjectApplicant.BUSINESS,
       isDevelopedInBC: BasicResponse.YES,
       registeredName: 'My Company'
     };
@@ -13,9 +14,9 @@ describe('basicIntakeSchema', () => {
     expect(result.error).toBeUndefined();
   });
 
-  it('should throw an error when isDevelopedByCompanyOrOrg is invalid', () => {
+  it('should throw an error when projectApplicantType is invalid', () => {
     const data = {
-      isDevelopedByCompanyOrOrg: 'invalid',
+      projectApplicantType: 'invalid',
       isDevelopedInBC: BasicResponse.YES,
       registeredName: 'My Company'
     };
@@ -26,27 +27,27 @@ describe('basicIntakeSchema', () => {
 
   it('should throw an error when isDevelopedInBC is invalid', () => {
     const data = {
-      isDevelopedByCompanyOrOrg: BasicResponse.YES,
+      projectApplicantType: ProjectApplicant.BUSINESS,
       isDevelopedInBC: 'invalid'
     };
 
     const result = basicIntake.validate(data);
     expect(result.error).toBeDefined();
   });
 
-  it('should throw an error when isDevelopedInBC is YES but registeredName is not provided', () => {
+  it('should throw an error when isDevelopedInBC is BUSINESS but registeredName is not provided', () => {
     const data = {
-      isDevelopedByCompanyOrOrg: BasicResponse.YES,
+      projectApplicantType: ProjectApplicant.BUSINESS,
       isDevelopedInBC: BasicResponse.YES
     };
 
     const result = basicIntake.validate(data);
     expect(result.error).toBeDefined();
   });
 
-  it('should throw an error when isDevelopedInBC is NO and registeredName is not provided', () => {
+  it('should throw an error when isDevelopedInBC is BUSINESS and registeredName is not provided', () => {
     const data = {
-      isDevelopedByCompanyOrOrg: BasicResponse.YES,
+      projectApplicantType: ProjectApplicant.BUSINESS,
       isDevelopedInBC: BasicResponse.NO
     };
 

app/tests/unit/validators/contacts.spec.ts

@@ -45,7 +45,7 @@ describe('contactsSchema', () => {
         firstName: 'John',
         lastName: 'Doe',
         phoneNumber: '1234567890',
-        contactApplicantRelationship: 'Employee'
+        contactApplicantRelationship: 'Project consultant'
       }
     ];
     const result = contactsSchema.validate(contacts);
@@ -60,7 +60,7 @@ describe('contactsSchema', () => {
         firstName: 'John',
         lastName: 'Doe',
         phoneNumber: '1234567890',
-        contactApplicantRelationship: 'Employee'
+        contactApplicantRelationship: 'Project consultant'
       }
     ];
     const result = contactsSchema.validate(contacts);
@@ -75,7 +75,7 @@ describe('contactsSchema', () => {
         firstName: 'John',
         lastName: 'Doe',
         phoneNumber: '+1234567890',
-        contactApplicantRelationship: 'Employee'
+        contactApplicantRelationship: 'Project consultant'
       }
     ];
     const result = contactsSchema.validate(contacts);
@@ -90,7 +90,7 @@ describe('contactsSchema', () => {
         firstName: 'John',
         lastName: 'Doe',
         phoneNumber: '12345678901',
-        contactApplicantRelationship: 'Employee'
+        contactApplicantRelationship: 'Project consultant'
       }
     ];
     const result = contactsSchema.validate(contacts);