Merge pull request #423 from bcgov/feature/electrification-form-updates

Electrification form updates

Author: kyle1morel

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

@@ -29,6 +29,7 @@ import {
 } from '@/services';
 import { useCodeStore, useProjectStore } from '@/store';
 import { MIN_SEARCH_INPUT_LENGTH, YES_NO_LIST } from '@/utils/constants/application';
+import { BC_HYDRO_POWER_AUTHORITY } from '@/utils/constants/electrification';
 import {
   APPLICATION_STATUS_LIST,
   ATS_ENQUIRY_TYPE_CODE_PROJECT_INTAKE_SUFFIX,
@@ -264,16 +265,25 @@ function onInvalidSubmit(e: GenericObject) {
   scrollToFirstError(e.errors);
 }
 
-async function onRegisteredNameInput(e: AutoCompleteCompleteEvent) {
-  if (e?.query?.length >= 2) {
-    const results = (await externalApiService.searchOrgBook(e.query))?.data?.results ?? [];
+async function getOrgBookOptions(companyNameRegistered: string) {
+  if (companyNameRegistered.length >= 2) {
+    const results = (await externalApiService.searchOrgBook(companyNameRegistered))?.data?.results ?? [];
     orgBookOptions.value = results
       .filter((obo: Record<string, string>) => obo.type === 'name')
       // map value and topic_source_id for AutoComplete display and selection
       .map((obo: Record<string, string>) => ({
         registeredName: obo.value,
         registeredId: obo.topic_source_id
       }));
+    // If the searched company name includes BC Hydro Power Authority, add it as an option since it is not registered
+    if (BC_HYDRO_POWER_AUTHORITY.includes(companyNameRegistered.toUpperCase())) {
+      orgBookOptions.value.push({
+        registeredName: BC_HYDRO_POWER_AUTHORITY,
+        registeredId: ''
+      });
+    }
+    // sort options alphabetically
+    orgBookOptions.value.sort((a, b) => a.registeredName.localeCompare(b.registeredName));
   }
 }
 
@@ -392,6 +402,9 @@ onBeforeMount(async () => {
     assigneeOptions.value = (await userService.searchUsers({ userId: [project.assignedUserId] })).data;
   }
 
+  // Load options for org book autocomplete to prevent schema validation errors on existing values
+  if (project.companyNameRegistered) await getOrgBookOptions(project.companyNameRegistered);
+
   // Default form values
   initialFormValues.value = initilizeFormValues(project);
 });
@@ -469,7 +482,7 @@ onBeforeMount(async () => {
               :placeholder="t('i.common.projectForm.searchBCRegistered')"
               :get-option-label="(option: OrgBookOption) => option.registeredName"
               :suggestions="orgBookOptions"
-              @on-complete="onRegisteredNameInput"
+              @on-complete="(e: AutoCompleteCompleteEvent) => getOrgBookOptions(e.query)"
               @on-select="
                 (orgBookOption: OrgBookOption) => {
                   setFieldValue('project.companyIdRegistered', orgBookOption.registeredId);

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

@@ -13,6 +13,7 @@ import { createProjectIntakeSchema } from '@/validators/electrification/projectI
 import { Button, Card, Message, useConfirm, useToast } from '@/lib/primevue';
 import { documentService, electrificationProjectService, externalApiService } from '@/services';
 import { useAppStore, useConfigStore, useCodeStore, useContactStore, useProjectStore } from '@/store';
+import { BC_HYDRO_POWER_AUTHORITY } from '@/utils/constants/electrification';
 import { RouteName } from '@/utils/enums/application';
 import { confirmationTemplateElectrificationSubmission, confirmationTemplateEnquiry } from '@/utils/templates';
 import { omit, setEmptyStringsToNull, toTitleCase } from '@/utils/utils';
@@ -140,6 +141,15 @@ async function onRegisteredNameInput(e: AutoCompleteCompleteEvent) {
         registeredName: obo.value,
         registeredId: obo.topic_source_id
       }));
+    // If the searched company name includes BC Hydro Power Authority, add it as an option since it is not registered
+    if (BC_HYDRO_POWER_AUTHORITY.includes(e.query.toUpperCase())) {
+      orgBookOptions.value.push({
+        registeredName: BC_HYDRO_POWER_AUTHORITY,
+        registeredId: ''
+      });
+    }
+    // sort options alphabetically
+    orgBookOptions.value.sort((a, b) => a.registeredName.localeCompare(b.registeredName));
   }
 }
 

frontend/src/components/electrification/project/ProjectListNavigatorElectrification.vue

@@ -88,20 +88,20 @@ const { codeDisplay } = codeStore;
     style="min-width: 150px"
   />
   <Column
-    field="activity.activity_contact.0.contact.first_name"
+    field="activity.activityContact.0.contact.firstName"
     header="First name"
     :sortable="true"
     style="min-width: 150px"
   />
   <Column
-    field="activity.activity_contact.0.contact.last_name"
+    field="activity.activityContact.0.contact.lastName"
     header="Last name"
     :sortable="true"
     style="min-width: 150px"
   />
   <Column
     field="user.fullName"
-    header="Assigned-to"
+    header="Assigned to"
     :sortable="true"
     style="min-width: 200px"
   />

frontend/src/components/projectCommon/ProjectListNavigator.vue

@@ -20,7 +20,7 @@ import {
 import { useAppStore, useAuthZStore } from '@/store';
 import { APPLICATION_STATUS_LIST } from '@/utils/constants/projectCommon';
 import { Action, Initiative } from '@/utils/enums/application';
-import { ApplicationStatus } from '@/utils/enums/projectCommon';
+import { ActivityContactRole, ApplicationStatus } from '@/utils/enums/projectCommon';
 import { projectRouteNameKey, projectServiceKey, resourceKey } from '@/utils/keys';
 import { toNumber } from '@/utils/utils';
 
@@ -77,7 +77,7 @@ const selection: Ref<Project | undefined> = ref(undefined);
 const selectedFilter: Ref<FilterOption> = ref(FILTER_OPTIONS[0]!);
 
 /**
- * Filter projects based on status
+ * Filter projects based on status and reduce contacts to primary contact only
  * Inject a joined location field for housing for proper sorting and searching
  */
 const filteredProjects = computed(() => {
@@ -86,12 +86,27 @@ const filteredProjects = computed(() => {
       return selectedFilter.value.statuses.includes(element.applicationStatus);
     })
     .map((x) => {
+      const primaryContact = x.activity?.activityContact?.find(
+        (contact) => contact.role === ActivityContactRole.PRIMARY
+      );
+
       if ('housingProjectId' in x) {
         return {
           ...x,
-          location: [x.streetAddress, x.locality, x.province].filter((str) => str?.trim()).join(', ')
+          location: [x.streetAddress, x.locality, x.province].filter((str) => str?.trim()).join(', '),
+          activity: {
+            ...x.activity,
+            activityContact: primaryContact ? [primaryContact] : []
+          }
+        };
+      } else
+        return {
+          ...x,
+          activity: {
+            ...x.activity,
+            activityContact: primaryContact ? [primaryContact] : []
+          }
         };
-      } else return x;
     });
 });
 

frontend/src/utils/constants/electrification.ts

@@ -0,0 +1 @@
+export const BC_HYDRO_POWER_AUTHORITY = 'BC HYDRO AND POWER AUTHORITY';

frontend/src/validators/electrification/projectFormNavigatorSchema.ts

@@ -37,7 +37,7 @@ export function createProjectFormSchema(
     project: object({
       companyIdRegistered: string().nullable(),
       bcEnvironmentAssessNeeded: string().notRequired().oneOf(YES_NO_LIST).label('BC Environmental Assessment needed?'),
-      bcHydroNumber: string().required().max(255).label('BC Hydro Call for Power project number'),
+      bcHydroNumber: string().notRequired().max(255).label('BC Hydro Call for Power project number'),
       companyNameRegistered: string()
         .required()
         .max(255)

frontend/tests/unit/components/electrification/project/ProjectForm.spec.ts

@@ -92,7 +92,7 @@ describe('onRegisteredNameInput', () => {
     vi.clearAllMocks();
   });
 
-  it('should not call searchOrgBook when query length is less than 2', async () => {
+  it('should call searchOrgBook once when query length is less than 2', async () => {
     const wrapper = mount(ProjectForm, wrapperSettingsForm());
     await nextTick();
     await nextTick();
@@ -106,10 +106,10 @@ describe('onRegisteredNameInput', () => {
     await autoComplete.vm.$emit('on-complete', event);
     await nextTick();
 
-    expect(searchOrgBookSpy).not.toHaveBeenCalled();
+    expect(searchOrgBookSpy).toHaveBeenCalledOnce();
   });
 
-  it('should call searchOrgBook when query length is 2 or more', async () => {
+  it('should call searchOrgBook twice when query length is 2 or more', async () => {
     const mockResponse = {
       data: {
         results: [
@@ -134,7 +134,7 @@ describe('onRegisteredNameInput', () => {
     await autoComplete.vm.$emit('on-complete', event);
     await nextTick();
 
-    expect(searchOrgBookSpy).toHaveBeenCalledTimes(1);
+    expect(searchOrgBookSpy).toHaveBeenCalledTimes(2);
     expect(searchOrgBookSpy).toHaveBeenCalledWith('Test');
   });
 
@@ -203,30 +203,6 @@ describe('onRegisteredNameInput', () => {
     expect(orgBookOptions).toHaveLength(0);
   });
 
-  it('should handle undefined results from searchOrgBook', async () => {
-    const mockResponse = {
-      data: {}
-    };
-
-    searchOrgBookSpy.mockResolvedValue(mockResponse as AxiosResponse);
-
-    const wrapper = mount(ProjectForm, wrapperSettingsForm());
-    await nextTick();
-    await nextTick();
-
-    const event: AutoCompleteCompleteEvent = {
-      query: 'Test',
-      originalEvent: new Event('input')
-    };
-
-    const autoComplete = wrapper.findComponent({ name: 'AutoComplete' });
-    await autoComplete.vm.$emit('on-complete', event);
-    await nextTick();
-
-    const orgBookOptions = (wrapper.vm as any).orgBookOptions; // eslint-disable-line @typescript-eslint/no-explicit-any
-    expect(orgBookOptions).toHaveLength(0);
-  });
-
   it('should handle results with only non-name types', async () => {
     const mockResponse = {
       data: {