Updated backend and frontend to use the concept model for contact sum…

…mary (#4394)

Co-authored-by: Alejandro Sanchez <[email protected]>

source/backend/api/Areas/Contacts/Controllers/SearchController.cs

@@ -8,6 +8,7 @@
 using Pims.Api.Helpers.Exceptions;
 using Pims.Api.Helpers.Extensions;
 using Pims.Api.Models.Base;
+using Pims.Api.Models.Concepts.Contact;
 using Pims.Api.Policies;
 using Pims.Api.Services.Interfaces;
 using Pims.Dal.Entities.Models;

source/backend/api/Areas/Contacts/Mapping/Search/ContactMap.cs → source/backend/apimodels/Models/Concepts/Contact/ContactMap.cs

@@ -1,14 +1,13 @@
 using Mapster;
 using Entity = Pims.Dal.Entities;
-using Model = Pims.Api.Areas.Contact.Models.Search;
 
-namespace Pims.Api.Areas.Contact.Mapping.Search
+namespace Pims.Api.Models.Concepts.Contact
 {
-    public class ContactMap : IRegister
+    public class ContactSummaryMap : IRegister
     {
         public void Register(TypeAdapterConfig config)
         {
-            config.NewConfig<Entity.PimsContactMgrVw, Model.ContactSummaryModel>()
+            config.NewConfig<Entity.PimsContactMgrVw, ContactSummaryModel>()
                 .Map(dest => dest.Id, src => src.Id)
                 .Map(dest => dest.PersonId, src => src.PersonId)
                 .Map(dest => dest.Person, src => src.Person)

source/backend/api/Areas/Contacts/Models/Search/ContactSummaryModel.cs → source/backend/apimodels/Models/Concepts/Contact/ContactSummaryModel.cs

@@ -1,4 +1,7 @@
-namespace Pims.Api.Areas.Contact.Models.Search
+using Pims.Api.Models.Concepts.Organization;
+using Pims.Api.Models.Concepts.Person;
+
+namespace Pims.Api.Models.Concepts.Contact
 {
     public class ContactSummaryModel
     {
@@ -14,19 +17,14 @@ public class ContactSummaryModel
         /// </summary>
         public long? PersonId { get; set; }
 
-        public Pims.Api.Models.Concepts.Person.PersonModel Person { get; set; }
+        public PersonModel Person { get; set; }
 
         /// <summary>
         /// get/set - The primary key to identify the organization.
         /// </summary>
         public long? OrganizationId { get; set; }
 
-        public Pims.Api.Models.Concepts.Organization.OrganizationModel Organization { get; set; }
-
-        /// <summary>
-        /// get/set - The concurrency row version.
-        /// </summary>
-        public long RowVersion { get; set; }
+        public OrganizationModel Organization { get; set; }
 
         /// <summary>
         /// get/set - Either the person name or the organization name.

source/frontend/src/components/contact/ContactManagerView/ContactManagerView.test.tsx

@@ -18,6 +18,8 @@ import { defaultFilter } from './ContactFilterComponent/ContactFilterComponent';
 import ContactManagerView from './ContactManagerView';
 import { MockedFunction } from 'vitest';
 import { MaybeMocked } from '@vitest/spy';
+import { ApiGen_Concepts_ContactSummary } from '@/models/api/generated/ApiGen_Concepts_ContactSummary';
+import { getEmptyContactSummary } from '@/mocks/contacts.mock';
 
 // mock auth library
 
@@ -44,7 +46,7 @@ const setup = (renderOptions: RenderOptions = {}) => {
   return { searchButton, ...utils };
 };
 
-const setupMockSearch = (searchResults?: IContactSearchResult[]) => {
+const setupMockSearch = (searchResults?: ApiGen_Concepts_ContactSummary[]) => {
   const results = searchResults ?? [];
   const len = results.length;
   getContacts.mockResolvedValue({
@@ -58,7 +60,8 @@ const setupMockSearch = (searchResults?: IContactSearchResult[]) => {
   });
 };
 
-const defaultPersonSearchResult: IContactSearchResult = {
+const defaultPersonSearchResult: ApiGen_Concepts_ContactSummary = {
+  ...getEmptyContactSummary(),
   id: '1',
   summary: 'summary',
   mailingAddress: '123 mock st',
@@ -68,7 +71,6 @@ const defaultPersonSearchResult: IContactSearchResult = {
   municipalityName: 'city',
   provinceState: 'province',
   isDisabled: false,
-  provinceStateId: 0,
 };
 
 const defaultPagedFilter = {

source/frontend/src/components/contact/ContactManagerView/ContactManagerView.tsx

@@ -10,7 +10,8 @@ import { Claims } from '@/constants/claims';
 import { useApiContacts } from '@/hooks/pims-api/useApiContacts';
 import { useKeycloakWrapper } from '@/hooks/useKeycloakWrapper';
 import { useSearch } from '@/hooks/useSearch';
-import { IContactSearchResult } from '@/interfaces/IContactSearchResult';
+import { fromContactSummary, IContactSearchResult } from '@/interfaces';
+import { ApiGen_Concepts_ContactSummary } from '@/models/api/generated/ApiGen_Concepts_ContactSummary';
 
 import {
   ContactFilterComponent,
@@ -70,7 +71,7 @@ const ContactManagerView = ({
     setCurrentPage,
     setPageSize,
     loading,
-  } = useSearch<IContactSearchResult, IContactFilter>(
+  } = useSearch<ApiGen_Concepts_ContactSummary, IContactFilter>(
     initialFilter,
     getContacts,
     'Search returned no results',
@@ -110,7 +111,7 @@ const ContactManagerView = ({
       <div>
         <ContactResultComponent
           loading={loading}
-          results={results}
+          results={results.map(fromContactSummary)}
           sort={sort}
           pageSize={pageSize}
           pageIndex={currentPage}

source/frontend/src/components/contact/ContactManagerView/ContactResultComponent/ContactResultComponent.test.tsx

@@ -50,7 +50,10 @@ const defaultPersonSearchResult: IContactSearchResult = {
   municipalityName: 'city',
   provinceState: 'province',
   isDisabled: false,
-  provinceStateId: 0,
+  personId: 1,
+  person:  null,
+  middleNames:  null,
+  organizationName:  null,
 };
 
 const mockResults: IContactSearchResult[] = [

source/frontend/src/components/contact/ContactManagerView/ContactResultComponent/ContactResultComponent.tsx

@@ -27,7 +27,6 @@ export interface IContactResultComponentProps {
 
 /**
  * Display a react table with the results filtered by the {@link ContactFilter}
- * @param {IContactSearchResult} props
  */
 export function ContactResultComponent(props: IContactResultComponentProps) {
   const { results, sort = {}, setSort, setPageSize, setPageIndex, ...rest } = props;

source/frontend/src/components/contact/ContactManagerView/ContactResultComponent/columns.tsx

@@ -11,7 +11,7 @@ import { InlineFlexDiv } from '@/components/common/styles';
 import { ColumnWithProps } from '@/components/Table';
 import { Claims } from '@/constants/claims';
 import { useKeycloakWrapper } from '@/hooks/useKeycloakWrapper';
-import { IContactSearchResult, isPersonResult } from '@/interfaces';
+import { IContactSearchResult, isPersonSummary } from '@/interfaces';
 import { stringToFragment } from '@/utils';
 
 const columns: ColumnWithProps<IContactSearchResult>[] = [
@@ -35,7 +35,7 @@ const columns: ColumnWithProps<IContactSearchResult>[] = [
     width: 20,
     maxWidth: 20,
     Cell: (props: CellProps<IContactSearchResult>) =>
-      isPersonResult(props.row.original) ? (
+      isPersonSummary(props.row.original) ? (
         <StatusIndicators className={props.row.original.isDisabled ? 'inactive' : 'active'}>
           <FaRegUser size={20} />
         </StatusIndicators>

source/frontend/src/components/contact/ContactManagerView/ContactResultComponent/summaryColumns.tsx

@@ -2,7 +2,7 @@ import { FaRegBuilding, FaRegUser } from 'react-icons/fa';
 import { CellProps } from 'react-table';
 
 import { ColumnWithProps } from '@/components/Table';
-import { IContactSearchResult, isPersonResult } from '@/interfaces';
+import { IContactSearchResult, isPersonSummary } from '@/interfaces';
 import { isValidId } from '@/utils';
 
 const summaryColumns: ColumnWithProps<IContactSearchResult>[] = [
@@ -28,7 +28,7 @@ const summaryColumns: ColumnWithProps<IContactSearchResult>[] = [
     width: 80,
     maxWidth: 120,
     Cell: (props: CellProps<IContactSearchResult>) =>
-      isPersonResult(props.row.original) ? (
+      isPersonSummary(props.row.original) ? (
         <strong>{props.row.original.firstName + ' ' + props.row.original.surname}</strong>
       ) : (
         <span></span>

source/frontend/src/features/contacts/list/ContactListView.test.tsx

@@ -59,7 +59,9 @@ const defaultPersonSearchResult: IContactSearchResult = {
   municipalityName: 'city',
   provinceState: 'province',
   isDisabled: false,
-  provinceStateId: 0,
+  person:  null,
+  middleNames:  null,
+  organizationName:  null,
 };
 
 const defaultPagedFilter = {

source/frontend/src/features/contacts/list/__snapshots__/ContactListView.test.tsx.snap

@@ -1237,17 +1237,13 @@ exports[`Contact List View > matches snapshot 1`] = `
                     role="cell"
                     style="box-sizing: border-box; flex: 60 0 auto; min-width: 30px; width: 60px; justify-content: left; text-align: left; flex-wrap: wrap; align-items: center; display: flex;"
                     title=""
-                  >
-                    first
-                  </div>
+                  />
                   <div
                     class="td"
                     role="cell"
                     style="box-sizing: border-box; flex: 60 0 auto; min-width: 30px; width: 60px; justify-content: left; text-align: left; flex-wrap: wrap; align-items: center; display: flex;"
                     title=""
-                  >
-                    last
-                  </div>
+                  />
                   <div
                     class="td"
                     role="cell"

source/frontend/src/features/leases/detail/LeasePages/stakeholders/AddLeaseStakeholderContainer.test.tsx

@@ -7,7 +7,7 @@ import { Claims } from '@/constants';
 import { LeaseContextProvider } from '@/features/leases/context/LeaseContext';
 import { LeaseFormModel } from '@/features/leases/models';
 import { useApiContacts } from '@/hooks/pims-api/useApiContacts';
-import { IContactSearchResult } from '@/interfaces';
+import { IContactSearchResult, fromContactSummary } from '@/interfaces';
 import {
   getEmptyPerson,
   getMockContactOrganizationWithMultiplePeople,
@@ -127,7 +127,9 @@ describe('AddLeaseTenantContainer component', () => {
     await setup({});
 
     await act(async () => {
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithOnePerson()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithOnePerson()),
+      ]);
     });
     expect(getPersonConcept).toHaveBeenCalledTimes(1);
     expect(viewProps.selectedStakeholders[0].organizationPersons).toHaveLength(1);
@@ -138,8 +140,8 @@ describe('AddLeaseTenantContainer component', () => {
 
     await waitFor(() => {
       viewProps.setSelectedStakeholders([
-        getMockContactOrganizationWithOnePerson(),
-        getMockContactOrganizationWithOnePerson(),
+        fromContactSummary(getMockContactOrganizationWithOnePerson()),
+        fromContactSummary(getMockContactOrganizationWithOnePerson()),
       ]);
       expect(getPersonConcept).toHaveBeenCalledTimes(1);
       expect(viewProps.selectedStakeholders[0].organizationPersons).toHaveLength(1);
@@ -182,14 +184,18 @@ describe('AddLeaseTenantContainer component', () => {
 
     //setup
     await waitFor(() => {
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithOnePerson()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithOnePerson()),
+      ]);
       expect(getPersonConcept).toHaveBeenCalledTimes(1);
       expect(viewProps.selectedStakeholders).toHaveLength(1);
     });
 
     await act(async () => {
       //act
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithOnePerson()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithOnePerson()),
+      ]);
     });
     //assert
     expect(getPersonConcept).toHaveBeenCalledTimes(1);
@@ -199,7 +205,9 @@ describe('AddLeaseTenantContainer component', () => {
     await setup({});
 
     await waitFor(() => {
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithMultiplePeople()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithMultiplePeople()),
+      ]);
       expect(viewProps.selectedStakeholders).toHaveLength(1);
     });
     await act(async () => {
@@ -215,7 +223,9 @@ describe('AddLeaseTenantContainer component', () => {
     await setup({});
 
     await act(async () => {
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithMultiplePeople()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithMultiplePeople()),
+      ]);
     });
     expect(viewProps.selectedStakeholders).toHaveLength(1);
     await act(async () => {
@@ -278,7 +288,9 @@ describe('AddLeaseTenantContainer component', () => {
 
     //setup
     await waitFor(() => {
-      viewProps.setSelectedStakeholders([getMockContactOrganizationWithMultiplePeople()]);
+      viewProps.setSelectedStakeholders([
+        fromContactSummary(getMockContactOrganizationWithMultiplePeople()),
+      ]);
       expect(viewProps.selectedStakeholders).toHaveLength(1);
       expect(viewProps.saveCallback).not.toBeNull();
     });

source/frontend/src/features/leases/detail/LeasePages/stakeholders/AddLeaseStakeholderContainer.tsx

@@ -52,7 +52,7 @@ export const AddLeaseStakeholderContainer: React.FunctionComponent<
   const [handleSubmit, setHandleSubmit] = useState<(() => void) | undefined>(undefined);
 
   const { getPersonConcept } = useApiContacts();
-  const { execute } = useApiRequestWrapper({
+  const { execute: executeGetPerson } = useApiRequestWrapper({
     requestFunction: getPersonConcept,
     requestName: 'get person by id',
   });
@@ -114,7 +114,7 @@ export const AddLeaseStakeholderContainer: React.FunctionComponent<
     );
 
     // fetch any person ids that we do not have person information for.
-    const personQueries = unprocessedPersons.map(person => execute(person.personId));
+    const personQueries = unprocessedPersons.map(person => executeGetPerson(person.personId));
     const personResponses = await Promise.all(personQueries);
     const allPersons = personResponses.concat(processedPersons);
 
@@ -127,14 +127,13 @@ export const AddLeaseStakeholderContainer: React.FunctionComponent<
             op.person = matchingPerson;
           }
         });
-        stakeholder.stakeholderType = stakeholder?.stakeholderType
-          ? stakeholder.stakeholderType
-          : isPayableLease
-          ? 'OWNER'
-          : 'TEN';
         return stakeholder;
       }) ?? [];
-    const formTenants = tenantsWithPersons?.map(t => new FormStakeholder(undefined, t)) ?? [];
+    const stakeholderType = isPayableLease ? 'OWNER' : 'TEN';
+    const formTenants =
+      tenantsWithPersons?.map(
+        t => new FormStakeholder(undefined, { contact: t, stakeholderType }),
+      ) ?? [];
     setStakeholders([...formTenants, ...matchingExistingTenants]);
   };