chore: backport form/validation changes to housing

Author: kyle1morel

app/src/controllers/housingProject.ts

@@ -1,4 +1,5 @@
 import config from 'config';
+import { Prisma } from '@prisma/client';
 import { v4 as uuidv4 } from 'uuid';
 
 import { transactionWrapper } from '../db/utils/transactionWrapper.ts';
@@ -487,18 +488,25 @@ export const upsertHousingProjectDraftController = async (req: Request<never, ne
   res.status(update ? 200 : 201).json(response);
 };
 
-export const updateHousingProjectController = async (req: Request<never, never, HousingProject>, res: Response) => {
+export const updateHousingProjectController = async (
+  req: Request<{ housingProjectId: string }, never, Omit<Prisma.housing_projectUpdateInput, 'housingProjectId'>>,
+  res: Response
+) => {
   const response = await transactionWrapper<HousingProject>(async (tx: PrismaTransactionClient) => {
-    return await updateHousingProject(tx, {
-      ...req.body,
-      financiallySupported: [
-        req.body.financiallySupportedBc,
-        req.body.financiallySupportedIndigenous,
-        req.body.financiallySupportedNonProfit,
-        req.body.financiallySupportedHousingCoop
-      ].includes(BasicResponse.YES),
-      ...generateUpdateStamps(req.currentContext)
-    });
+    return await updateHousingProject(
+      tx,
+      {
+        ...req.body,
+        financiallySupported: [
+          req.body.financiallySupportedBc,
+          req.body.financiallySupportedIndigenous,
+          req.body.financiallySupportedNonProfit,
+          req.body.financiallySupportedHousingCoop
+        ].includes(BasicResponse.YES),
+        ...generateUpdateStamps(req.currentContext)
+      },
+      req.params.housingProjectId
+    );
   });
 
   res.status(200).json(response);

app/src/routes/v1/housingProject.ts

@@ -113,7 +113,7 @@ router.get(
 );
 
 /** Updates a housing project*/
-router.put(
+router.patch(
   '/:housingProjectId',
   hasAuthorization(Resource.HOUSING_PROJECT, Action.UPDATE),
   hasAccess('housingProjectId'),

app/src/services/housingProject.ts

@@ -205,19 +205,18 @@ export const searchHousingProjects = async (
  * Updates a specific housing project
  * @param tx Prisma transaction client
  * @param data Housing project to update
+ * @param housingProjectId ID of the project to update
  * @returns A Promise that resolves to the updated housing project
  */
 export const updateHousingProject = async (
   tx: PrismaTransactionClient,
-  data: HousingProjectBase
+  data: Omit<Prisma.housing_projectUpdateInput, 'housingProjectId'>,
+  housingProjectId: string
 ): Promise<HousingProject> => {
   const result = await tx.housing_project.update({
-    data: {
-      ...data,
-      geoJson: jsonToPrismaInputJson(data.geoJson)
-    },
+    data,
     where: {
-      housingProjectId: data.housingProjectId
+      housingProjectId
     },
     include: {
       activity: {

app/src/validators/housingProject.ts

@@ -91,14 +91,11 @@ const schema = {
   },
   updateHousingProject: {
     body: Joi.object({
-      housingProjectId: uuidv4.required(),
-      activityId: activityId.required(),
       consentToFeedback: Joi.boolean(),
       queuePriority: Joi.number().required().integer().min(0).max(3),
       submissionType: Joi.string()
         .required()
         .valid(...SUBMISSION_TYPE_LIST),
-      submittedAt: Joi.string().required(),
       companyNameRegistered: Joi.string().allow(null),
       companyIdRegistered: Joi.string().allow(null),
       projectName: Joi.string().required(),

frontend/src/components/form/section/FeedbackConsentSection.vue

@@ -38,7 +38,7 @@ useFormErrorWatcher(formRef, 'FeedbackConsentSection', tab);
     </h4>
     <Select
       class="col-span-3"
-      name="consentToFeedback"
+      name="consent.consentToFeedback"
       :label="t('i.housing.project.projectForm.researchOptin')"
       :disabled="!getEditable"
       :options="YES_NO_LIST"

frontend/src/components/general/project/ProjectFormNavigator.vue

@@ -312,9 +312,7 @@ const onSubmit = async (formValues: GenericObject) => {
       astNotes: values.astNotes.notes,
 
       // Submission State
-      assignedUserId: values.submissionState.assignedUser
-        ? (values.submissionState.assignedUser as User).userId
-        : undefined,
+      assignedUserId: values.submissionState.assignedUser ? (values.submissionState.assignedUser as User).userId : null,
       region: values.submissionState.region as Region,
       area: values.submissionState.area as Area,
       applicationStatus: values.submissionState.applicationStatus,

frontend/src/components/housing/project/ProjectFormNavigator.vue

@@ -23,12 +23,12 @@ import RelatedEnquiriesSection from '@/components/form/section/RelatedEnquiriesS
 import SubmissionStateSection from '@/components/form/section/SubmissionStateSection.vue';
 import { Button, Message, useConfirm, useToast } from '@/lib/primevue';
 import { atsService, housingProjectService, mapService, userService } from '@/services';
-import { useProjectStore } from '@/store';
+import { useAppStore, useFormStore, useProjectStore } from '@/store';
 import { ATS_ENQUIRY_TYPE_CODE_PROJECT_INTAKE_SUFFIX, ATS_MANAGING_REGION } from '@/utils/constants/projectCommon';
 import { ATSCreateTypes, BasicResponse, GroupName, Initiative } from '@/utils/enums/application';
-import { ActivityContactRole, ApplicationStatus } from '@/utils/enums/projectCommon';
+import { ActivityContactRole, ApplicationStatus, FormState, FormType } from '@/utils/enums/projectCommon';
 import { formatDate } from '@/utils/formatters';
-import { omit, scrollToFirstError, setEmptyStringsToNull, toTitleCase } from '@/utils/utils';
+import { scrollToFirstError, setEmptyStringsToNull, toTitleCase } from '@/utils/utils';
 
 import type { Ref } from 'vue';
 import type {
@@ -37,7 +37,8 @@ import type {
   ATSEnquiryResource,
   Contact,
   DeepPartial,
-  HousingProject
+  HousingProject,
+  User
 } from '@/types';
 import type { FormSchemaType } from '@/validators/housing/projectFormNavigatorSchema';
 
@@ -56,6 +57,7 @@ const confirm = useConfirm();
 const toast = useToast();
 
 // Store
+const { getInitiative } = storeToRefs(useAppStore());
 const projectStore = useProjectStore();
 const { getActivityContacts } = storeToRefs(projectStore);
 
@@ -156,12 +158,11 @@ async function handleAtsCreate(values: GenericObject) {
 }
 
 async function initializeFormValues(project: HousingProject): Promise<DeepPartial<FormSchemaType>> {
-  let assigneeOptions = [];
+  let assigneeOptions: User[] = [];
   if (project.assignedUserId)
     assigneeOptions = (await userService.searchUsers({ userId: [project.assignedUserId] })).data;
 
   return {
-    consentToFeedback: project.consentToFeedback ? BasicResponse.YES : BasicResponse.NO,
     contact: {
       contactId: primaryContact.value?.contactId,
       firstName: primaryContact.value?.firstName,
@@ -194,27 +195,27 @@ async function initializeFormValues(project: HousingProject): Promise<DeepPartia
       geomarkUrl: project.geomarkUrl,
       naturalDisaster: project.naturalDisaster ? BasicResponse.YES : BasicResponse.NO
     },
-    locationPidsAuto: locationPidsAuto.value,
-    project: {
+    locationPids: { auto: locationPidsAuto.value },
+    companyProjectName: {
       companyIdRegistered: project.companyIdRegistered,
       companyNameRegistered: project.companyNameRegistered,
       projectName: project.projectName
     },
 
     // Additional Info
-    projectDescription: project.projectDescription,
+    projectDescription: { description: project.projectDescription },
 
     // Location
-    projectLocationDescription: project.projectLocationDescription,
+    locationDescription: { description: project.projectLocationDescription },
 
     // Automated Status Tool Notes
-    astNotes: project.astNotes,
+    astNotes: { notes: project.astNotes },
 
     // Submission state
     submissionState: {
       queuePriority: project.queuePriority,
       submissionType: project.submissionType,
-      assignedUser: assigneeOptions[0] ?? null,
+      assignedUser: assigneeOptions[0]?.fullName ?? null,
       applicationStatus: project.applicationStatus
     },
 
@@ -228,16 +229,25 @@ async function initializeFormValues(project: HousingProject): Promise<DeepPartia
     },
 
     // ATS link
-    atsClientId: project.atsClientId,
-    atsEnquiryId: project.atsEnquiryId,
+    atsInfo: {
+      atsClientId: project.atsClientId,
+      atsEnquiryId: project.atsEnquiryId
+    },
+
+    // Related enquiries
+    relatedEnquiries: { csv: project.relatedEnquiries },
 
     // Updates
-    aaiUpdated: project.aaiUpdated,
-    addedToAts: project.addedToAts,
-    ltsaCompleted: project.ltsaCompleted,
-    bcOnlineCompleted: project.bcOnlineCompleted,
-    submittedAt: new Date(project.submittedAt),
-    relatedEnquiries: project.relatedEnquiries
+    projectAreasUpdated: {
+      aaiUpdated: project.aaiUpdated,
+      addedToAts: project.addedToAts,
+      ltsaCompleted: project.ltsaCompleted,
+      bcOnlineCompleted: project.bcOnlineCompleted
+    },
+
+    consent: {
+      consentToFeedback: project.consentToFeedback ? BasicResponse.YES : BasicResponse.NO
+    }
   };
 }
 
@@ -280,50 +290,88 @@ function onReOpen() {
   });
 }
 
-const onSubmit = async (values: GenericObject) => {
+const onSubmit = async (formValues: GenericObject) => {
   try {
+    // vee-validate doesn't get transformed data from yup so
+    // manually run the form values through it here
+    const values: FormSchemaType = projectFormNavigatorSchema.cast(formValues);
+
     await handleAtsCreate(values);
 
-    // Generate final submission object
-    const dataOmitted = omit(
-      setEmptyStringsToNull({
-        ...values.project,
-        ...values.units,
-        ...values.location,
-        ...values.finance,
-        ...values.submissionState,
-        activityId: project.activityId,
-        housingProjectId: project.housingProjectId,
-        projectDescription: values.projectDescription,
-        projectLocationDescription: values.projectLocationDescription,
-        astNotes: values.astNotes,
-        atsClientId: Number.parseInt(values.atsClientId) || '',
-        atsEnquiryId: Number.parseInt(values.atsEnquiryId) || '',
-        aaiUpdated: values.aaiUpdated,
-        addedToAts: values.addedToAts,
-        ltsaCompleted: values.ltsaCompleted,
-        bcOnlineCompleted: values.bcOnlineCompleted,
-        companyIdRegistered: values.project?.companyIdRegistered ?? null,
-        submittedAt: values.submittedAt,
-        consentToFeedback: values.consentToFeedback === BasicResponse.YES,
-        naturalDisaster: values.location.naturalDisaster === BasicResponse.YES,
-        assignedUserId: values.submissionState.assignedUser?.userId ?? undefined
-      }),
-      ['contact', 'assignedUser', 'isDevelopedInBc', 'submissionState', 'locationAddress', 'relatedEnquiries']
-    );
+    // Generate final payload
+    // TODO: Create a type using Pick instead of Partial?
+    const payload: Partial<HousingProject> = {
+      // Company and Project Information
+      projectName: values.companyProjectName.projectName,
+      companyNameRegistered: values.companyProjectName.companyNameRegistered,
+      companyIdRegistered: values.companyProjectName.companyIdRegistered,
+
+      // Residential units
+      singleFamilyUnits: values.units.singleFamilyUnits,
+      multiFamilyUnits: values.units.multiFamilyUnits,
+      hasRentalUnits: values.units.hasRentalUnits,
+      rentalUnits: values.units.rentalUnits,
+      otherUnits: values.units.otherUnits,
+      otherUnitsDescription: values.units.otherUnitsDescription,
+
+      // Financially supported
+      financiallySupportedBc: values.finance.financiallySupportedBc,
+      financiallySupportedIndigenous: values.finance.financiallySupportedIndigenous,
+      indigenousDescription: values.finance.indigenousDescription,
+      financiallySupportedNonProfit: values.finance.financiallySupportedNonProfit,
+      nonProfitDescription: values.finance.nonProfitDescription,
+      financiallySupportedHousingCoop: values.finance.financiallySupportedHousingCoop,
+      housingCoopDescription: values.finance.housingCoopDescription,
+
+      // Location
+      locality: values.location.locality,
+      province: values.location.province,
+      locationPids: values.location.locationPids,
+      latitude: values.location.latitude,
+      longitude: values.location.longitude,
+      streetAddress: values.location.streetAddress,
+      geomarkUrl: values.location.geomarkUrl,
+      naturalDisaster: values.location.naturalDisaster === BasicResponse.YES,
+
+      // Additional Location Information
+      projectLocationDescription: values.locationDescription.description,
+
+      // Additional Project Information
+      projectDescription: values.projectDescription.description,
+
+      // AST Notes
+      astNotes: values.astNotes.notes,
+
+      // Submission State
+      assignedUserId: values.submissionState.assignedUser ? (values.submissionState.assignedUser as User).userId : null,
+      applicationStatus: values.submissionState.applicationStatus,
+      submissionType: values.submissionState.submissionType,
+      queuePriority: values.submissionState.queuePriority,
+
+      // ATS
+      atsClientId: values.atsInfo.atsClientId,
+      atsEnquiryId: values.atsInfo.atsEnquiryId,
+
+      // Updates
+      addedToAts: values.projectAreasUpdated.addedToAts,
+      ltsaCompleted: values.projectAreasUpdated.ltsaCompleted,
+      bcOnlineCompleted: values.projectAreasUpdated.bcOnlineCompleted,
+      aaiUpdated: values.projectAreasUpdated.aaiUpdated,
+
+      // Consent
+      consentToFeedback: values.consent.consentToFeedback === BasicResponse.YES
+    };
 
     // Update project
-    const result = await housingProjectService.updateProject(project.housingProjectId, dataOmitted);
+    const result = await housingProjectService.updateProject(project.housingProjectId, payload);
     projectStore.setProject(result.data);
 
     // Wait a tick for store to propagate
     await nextTick();
 
     // Reinitialize the form
     formRef.value?.resetForm({
-      values: {
-        ...initializeFormValues(result.data)
-      }
+      values: await initializeFormValues(result.data)
     });
 
     toast.success(t('i.common.form.savedMessage'));
@@ -332,7 +380,7 @@ const onSubmit = async (values: GenericObject) => {
   }
 };
 
-const projectFormNavigatorSchema = createProjectFormNavigatorSchema();
+const projectFormNavigatorSchema = createProjectFormNavigatorSchema({ initiative: getInitiative.value, t });
 
 // Set basic info, clear it if no contact is provided
 function setBasicInfo(contact?: Contact) {
@@ -360,6 +408,9 @@ watch(primaryContact, (newContact, oldContact) => {
 });
 
 onBeforeMount(async () => {
+  useFormStore().setFormType(FormType.NAVIGATOR);
+  useFormStore().setFormState(FormState.UNLOCKED);
+
   locationPidsAuto.value = (await mapService.getPIDs(project.housingProjectId)).data;
 
   // Default form values

frontend/src/interfaces/IProject.ts

@@ -8,7 +8,7 @@ export interface IProject extends IStamps {
   projectId: string;
   activityId: string;
   submittedAt: string;
-  assignedUserId?: string;
+  assignedUserId?: string | null;
   applicationStatus: ApplicationStatus;
 
   companyIdRegistered?: string | null;

frontend/src/locales/en-CA.json

@@ -45,8 +45,12 @@
       "activityType": "Activity type",
       "companyNameRegistered": "Company name",
       "projectName": "Project name",
+      "projectNumber": "Project number",
       "isRegisteredInBc": "Is Registered in BC"
     },
+    "consent": {
+      "consentToFeedback": "Consent to feedback"
+    },
     "contactCardNavForm": {
       "contactApplicantRelationship": "Relationship to project",
       "contactEmail": "Contact email",
@@ -498,7 +502,6 @@
           "contactPhoneNumber": "Contact phone number",
           "contactApplicantRelationship": "Relationship to project",
           "contactPreference": "Preferred contact method",
-          "consentToFeedback": "Consent to feedback",
           "financeFinanciallySupportedBc": "BC Housing",
           "financeFinanciallySupportedIndigenous": "Indigenous Housing Provider",
           "financeIndigenousDescription": "Name of Indigenous Housing Provider",