feat: general project navigator form validation

Author: kyle1morel

app/src/controllers/generalProject.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';
@@ -205,11 +206,7 @@ const generateGeneralProjectData = async (
       queuePriority: null,
       relatedPermits: null,
       astNotes: null,
-      astUpdated: false,
-      addedToAts: false,
       atsClientId: null,
-      ltsaCompleted: false,
-      bcOnlineCompleted: false,
       checkProvincialPermits: null,
       atsEnquiryId: null
     } as GeneralProject,
@@ -420,12 +417,19 @@ export const upsertGeneralProjectDraftController = async (req: Request<never, ne
   res.status(update ? 200 : 201).json(response);
 };
 
-export const updateGeneralProjectController = async (req: Request<never, never, GeneralProject>, res: Response) => {
+export const updateGeneralProjectController = async (
+  req: Request<{ generalProjectId: string }, never, Omit<Prisma.general_projectUpdateInput, 'generalProjectId'>>,
+  res: Response
+) => {
   const response = await transactionWrapper<GeneralProject>(async (tx: PrismaTransactionClient) => {
-    return await updateGeneralProject(tx, {
-      ...req.body,
-      ...generateUpdateStamps(req.currentContext)
-    });
+    return await updateGeneralProject(
+      tx,
+      {
+        ...req.body,
+        ...generateUpdateStamps(req.currentContext)
+      },
+      req.params.generalProjectId
+    );
   });
 
   res.status(200).json(response);

app/src/routes/v1/generalProject.ts

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

app/src/services/generalProject.ts

@@ -204,20 +204,19 @@ export const searchGeneralProjects = async (
 /**
  * Updates a specific general project
  * @param tx Prisma transaction client
- * @param data General project to update
+ * @param data General project data to update
+ * @param generalProjectId ID of the project to update
  * @returns A Promise that resolves to the updated general project
  */
 export const updateGeneralProject = async (
   tx: PrismaTransactionClient,
-  data: GeneralProjectBase
+  data: Omit<Prisma.general_projectUpdateInput, 'generalProjectId'>,
+  generalProjectId: string
 ): Promise<GeneralProject> => {
   const result = await tx.general_project.update({
-    data: {
-      ...data,
-      geoJson: jsonToPrismaInputJson(data.geoJson)
-    },
+    data,
     where: {
-      generalProjectId: data.generalProjectId
+      generalProjectId
     },
     include: {
       activity: {

app/src/validators/generalProject.ts

@@ -6,7 +6,7 @@ import { activityId, email, uuidv4 } from './common.ts';
 import { contactSchema } from './contact.ts';
 
 import { validate } from '../middleware/validation';
-import { YES_NO_UNSURE_LIST } from '../utils/constants/application.ts';
+import { YES_NO_LIST, YES_NO_UNSURE_LIST } from '../utils/constants/application.ts';
 import { APPLICATION_STATUS_LIST, SUBMISSION_TYPE_LIST } from '../utils/constants/projectCommon';
 import { ProjectApplicant } from '../utils/enums/housing.ts';
 import { PROJECT_APPLICANT_LIST } from '../utils/constants/housing.ts';
@@ -51,17 +51,6 @@ const schema = {
       })
     })
   },
-  emailConfirmation: {
-    body: Joi.object({
-      bcc: Joi.array().items(email).allow(null),
-      bodyType: Joi.string().required().allow(null),
-      body: Joi.string().required(),
-      cc: Joi.array().items(email),
-      from: email.required(),
-      subject: Joi.string().required(),
-      to: Joi.array().items(email).required()
-    })
-  },
   deleteGeneralProject: {
     params: Joi.object({
       generalProjectId: uuidv4.required()
@@ -96,17 +85,15 @@ const schema = {
   },
   updateGeneralProject: {
     body: Joi.object({
-      generalProjectId: uuidv4.required(),
-      activityId: activityId,
-      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),
+      isRegisteredInBc: Joi.boolean().required(),
       projectName: Joi.string().required(),
+      activityType: Joi.string().required(),
       projectDescription: Joi.string().allow(null),
       streetAddress: Joi.string().allow(null).max(255),
       locality: Joi.string().allow(null).max(255),
@@ -118,12 +105,14 @@ const schema = {
       naturalDisaster: Joi.boolean().required(),
       projectLocationDescription: Joi.string().allow(null).max(4000),
       ...atsValidator.atsEnquirySubmissionFields,
-      ltsaCompleted: Joi.boolean().required(),
-      bcOnlineCompleted: Joi.boolean().required(),
+      addedToAts: Joi.optional(),
       aaiUpdated: Joi.boolean().required(),
       astNotes: Joi.string().allow(null).max(4000),
       assignedUserId: uuidv4.allow(null),
-      applicationStatus: Joi.string().valid(...APPLICATION_STATUS_LIST)
+      applicationStatus: Joi.string().valid(...APPLICATION_STATUS_LIST),
+      region: Joi.string().allow(null),
+      area: Joi.string().allow(null),
+      businessArea: Joi.string() //TODO: add .valid() and make this list
     }),
     params: Joi.object({
       generalProjectId: uuidv4.required()
@@ -133,7 +122,6 @@ const schema = {
 
 export default {
   createGeneralProject: validate(schema.createGeneralProject),
-  emailConfirmation: validate(schema.emailConfirmation),
   deleteGeneralProject: validate(schema.deleteGeneralProject),
   deleteDraft: validate(schema.deleteDraft),
   getStatistics: validate(schema.getStatistics),

frontend/src/components/ats/ATSInfo.vue

@@ -154,7 +154,7 @@ watch(visible, () => {
     <Select
       v-if="getInitiative === Initiative.GENERAL"
       class="w-full"
-      name="submissionState.businessArea"
+      name="atsInfo.businessArea"
       :label="t('i.housing.project.projectForm.businessAreaLabel')"
       :options="BUSINESS_AREA_LIST"
     />

frontend/src/components/form/panel/CompanyProjectNamePanel.vue

@@ -117,6 +117,12 @@ async function onRegisteredNameInput(e: AutoCompleteCompleteEvent) {
         :disabled="!getEditable"
         :options="YES_NO_LIST"
       />
+      <InputText
+        v-if="getInitiative === Initiative.GENERAL"
+        name="companyProjectName.projectNumber"
+        :label="t('i.common.projectForm.projectNumber')"
+        :disabled="true"
+      />
     </div>
   </Panel>
 </template>

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

@@ -20,12 +20,20 @@ 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, generalProjectService, mapService, userService } from '@/services';
-import { useAppStore, 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,
+  Area,
+  BusinessArea,
+  FormState,
+  FormType,
+  Region
+} 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 {
@@ -34,7 +42,8 @@ import type {
   ATSEnquiryResource,
   Contact,
   DeepPartial,
-  GeneralProject
+  GeneralProject,
+  User
 } from '@/types';
 import type { FormSchemaType } from '@/validators/general/projectFormNavigatorSchema';
 
@@ -154,7 +163,7 @@ async function handleAtsCreate(values: GenericObject) {
 }
 
 async function initializeFormValues(project: GeneralProject): Promise<DeepPartial<FormSchemaType>> {
-  let assigneeOptions = [];
+  let assigneeOptions: User[] = [];
   if (project.assignedUserId)
     assigneeOptions = (await userService.searchUsers({ userId: [project.assignedUserId] })).data;
 
@@ -186,7 +195,10 @@ async function initializeFormValues(project: GeneralProject): Promise<DeepPartia
     companyProjectName: {
       companyIdRegistered: project.companyIdRegistered,
       companyNameRegistered: project.companyNameRegistered,
-      projectName: project.projectName
+      projectName: project.projectName,
+      projectNumber: project.projectNumber,
+      activityType: project.activityType,
+      isRegisteredInBc: project.isRegisteredInBc ? BasicResponse.YES : BasicResponse.NO
     },
 
     // Additional Info
@@ -202,14 +214,17 @@ async function initializeFormValues(project: GeneralProject): Promise<DeepPartia
     submissionState: {
       queuePriority: project.queuePriority,
       submissionType: project.submissionType,
-      assignedUser: assigneeOptions[0] ?? null,
-      applicationStatus: project.applicationStatus
+      assignedUser: assigneeOptions[0]?.fullName ?? null,
+      applicationStatus: project.applicationStatus,
+      region: String(project.region),
+      area: String(project.area)
     },
 
     // ATS link
     atsInfo: {
       atsClientId: project.atsClientId,
-      atsEnquiryId: project.atsEnquiryId
+      atsEnquiryId: project.atsEnquiryId,
+      businessArea: String(project.businessArea)
     },
 
     relatedEnquiries: { csv: project.relatedEnquiries },
@@ -237,7 +252,6 @@ function onCancel() {
 }
 
 function onInvalidSubmit(e: GenericObject) {
-  console.log(e);
   const errors = Object.keys(e.errors);
 
   if (errors.includes('contact.firstName')) {
@@ -262,40 +276,56 @@ function onReOpen() {
 
 const onSubmit = async (formValues: GenericObject) => {
   try {
-    const values: FormSchemaType = formValues as FormSchemaType;
+    // 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);
 
-    console.log(values);
-
-    // Generate final submission object
-    const payload: GeneralProject = {
-      ...project,
-
-      assignedUserId: values.submissionState.assignedUser?.userId ?? undefined,
-      applicationStatus: values.submissionState.applicationStatus,
-
-      companyIdRegistered: values.companyProjectName.companyIdRegistered,
-      companyNameRegistered: values.companyProjectName.companyNameRegistered,
-      queuePriority: values.submissionState.queuePriority,
-      submissionType: values.submissionState.submissionType,
+    // Generate final payload
+    // TODO: Create a type using Pick instead of Partial?
+    const payload: Partial<GeneralProject> = {
+      // Company and Project Information
       projectName: values.companyProjectName.projectName,
-      projectDescription: values.projectDescription.description,
-      astNotes: values.astNotes.notes,
-      atsClientId: values.atsInfo.atsClientId ?? null,
-      atsEnquiryId: values.atsInfo.atsEnquiryId ?? null,
-      aaiUpdated: values.projectAreasUpdated.aaiUpdated,
-      projectNumber: values.companyProjectName.projectNumber, // need to add this
-      // projectLocation: string; // was ist das
-      projectLocationDescription: values.locationDescription.description,
+      companyNameRegistered: values.companyProjectName.companyNameRegistered,
+      companyIdRegistered: values.companyProjectName.companyIdRegistered,
+      activityType: values.companyProjectName.activityType!, // Req for General but the type doesnt know until runtime
+      isRegisteredInBc: values.companyProjectName.isRegisteredInBc === BasicResponse.YES,
+
+      // 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
+      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
+        : undefined,
+      region: values.submissionState.region as Region,
+      area: values.submissionState.area as Area,
+      applicationStatus: values.submissionState.applicationStatus,
+      submissionType: values.submissionState.submissionType,
+      queuePriority: values.submissionState.queuePriority,
+
+      // ATS
+      businessArea: values.atsInfo.businessArea as BusinessArea,
+
+      // Updates
+      aaiUpdated: values.projectAreasUpdated.aaiUpdated
     };
 
     // Update project
@@ -307,9 +337,7 @@ const onSubmit = async (formValues: GenericObject) => {
 
     // Reinitialize the form
     formRef.value?.resetForm({
-      values: {
-        ...initializeFormValues(result.data)
-      }
+      values: await initializeFormValues(result.data)
     });
 
     toast.success(t('i.common.form.savedMessage'));
@@ -346,6 +374,8 @@ watch(primaryContact, (newContact, oldContact) => {
 });
 
 onBeforeMount(async () => {
+  useFormStore().setFormType(FormType.NAVIGATOR);
+  useFormStore().setFormState(FormState.UNLOCKED);
   locationPidsAuto.value = (await mapService.getPIDs(project.generalProjectId)).data;
 
   // Default form values

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

@@ -32,6 +32,7 @@ import { PermitNeeded, PermitStage } from '@/utils/enums/permit';
 import { ActivityContactRole, FormState, FormType } from '@/utils/enums/projectCommon';
 import { generalErrorHandler } from '@/utils/utils';
 
+import type { GeoJSON } from 'geojson';
 import type { GenericObject } from 'vee-validate';
 import type { Ref } from 'vue';
 import type {
@@ -164,7 +165,7 @@ function loadProjectValues() {
         longitude: project.longitude,
         ltsaPidLookup: project.locationPids,
         geomarkUrl: project.geomarkUrl,
-        projectLocationDescription: project?.projectLocationDescription,
+        projectLocationDescription: project.projectLocationDescription,
         geoJson: project.geoJson
       },
       permits: {
@@ -249,7 +250,8 @@ async function onSubmit(data: FormSchemaType) {
         locality: data.location.locality,
         province: data.location.province,
         geomarkUrl: data.location.geomarkUrl,
-        streetAddress: data.location.streetAddress
+        streetAddress: data.location.streetAddress,
+        geoJson: data.location.geoJson ? (data.location.geoJson as GeoJSON) : undefined
       },
       permits: {
         appliedPermits: data.permits.appliedPermits?.map((x) => ({