Psp 7081 cancellation status and note.

source/backend/api/Controllers/LookupController.cs

@@ -128,6 +128,7 @@ public IActionResult GetAll()
                 var acqChecklistSectionTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllAcquisitionChecklistSectionTypes());
                 var acqChecklistItemStatusTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllAcquisitionChecklistItemStatusTypes());
                 var agreementTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllAgreementTypes());
+                var agreementStatusTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllAgreementStatusTypes());
                 var interestHolderInterestTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllInterestHolderInterestTypes());
                 var expropriationPaymentItemTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllExpropriationPaymentItemTypes());
                 var mgmtActivityStatusTypes = _mapper.Map<Model.LookupModel[]>(_lookupRepository.GetAllPropMgmtActivityStatusTypes());
@@ -189,6 +190,7 @@ public IActionResult GetAll()
                 codes.AddRange(acqChecklistSectionTypes);
                 codes.AddRange(acqChecklistItemStatusTypes);
                 codes.AddRange(agreementTypes);
+                codes.AddRange(agreementStatusTypes);
                 codes.AddRange(interestHolderInterestTypes);
                 codes.AddRange(expropriationPaymentItemTypes);
                 codes.AddRange(mgmtActivityStatusTypes);

source/backend/api/Models/Concepts/AcquisitionFile/AgreementMap.cs

@@ -11,6 +11,7 @@ public void Register(TypeAdapterConfig config)
                 .Map(dest => dest.AgreementId, src => src.AgreementId)
                 .Map(dest => dest.AcquisitionFileId, src => src.AcquisitionFileId)
                 .Map(dest => dest.AgreementType, src => src.AgreementTypeCodeNavigation)
+                .Map(dest => dest.AgreementStatusType, src => src.AgreementStatusTypeCodeNavigation)
                 .Map(dest => dest.AgreementDate, src => src.AgreementDate)
                 //.Map(dest => dest.IsDraft, src => src.IsDraft) TODO: Fix this
                 .Map(dest => dest.CompletionDate, src => src.CompletionDate)
@@ -25,12 +26,14 @@ public void Register(TypeAdapterConfig config)
                 .Map(dest => dest.ExpiryDateTime, src => src.ExpiryTs)
                 .Map(dest => dest.SignedDate, src => src.SignedDate)
                 .Map(dest => dest.InspectionDate, src => src.InspectionDate)
+                .Map(dest => dest.CancellationNote, src => src.CancellationNote)
                 .Inherits<Entity.IBaseAppEntity, BaseAppModel>();
 
             config.NewConfig<AgreementModel, Entity.PimsAgreement>()
                 .Map(dest => dest.AgreementId, src => src.AgreementId)
                 .Map(dest => dest.AcquisitionFileId, src => src.AcquisitionFileId)
                 .Map(dest => dest.AgreementTypeCode, src => src.AgreementType.Id)
+                .Map(dest => dest.AgreementStatusTypeCode, src => src.AgreementStatusType.Id)
                 .Map(dest => dest.AgreementDate, src => src.AgreementDate)
                 //.Map(dest => dest.IsDraft, src => src.IsDraft) TODO: Fix this
                 .Map(dest => dest.CompletionDate, src => src.CompletionDate)
@@ -45,6 +48,7 @@ public void Register(TypeAdapterConfig config)
                 .Map(dest => dest.ExpiryTs, src => src.ExpiryDateTime)
                 .Map(dest => dest.SignedDate, src => src.SignedDate)
                 .Map(dest => dest.InspectionDate, src => src.InspectionDate)
+                .Map(dest => dest.CancellationNote, src => src.CancellationNote)
                 .Inherits<BaseAppModel, Entity.IBaseAppEntity>();
         }
     }

source/backend/api/Models/Concepts/AcquisitionFile/AgreementModel.cs

@@ -10,6 +10,8 @@ public class AgreementModel : BaseAppModel
 
         public TypeModel<string> AgreementType { get; set; }
 
+        public TypeModel<string> AgreementStatusType { get; set; }
+
         public DateTime? AgreementDate { get; set; }
 
         public bool? IsDraft { get; set; }
@@ -37,5 +39,7 @@ public class AgreementModel : BaseAppModel
         public DateTime? SignedDate { get; set; }
 
         public DateTime? InspectionDate { get; set; }
+
+        public string CancellationNote { get; set; }
     }
 }

source/backend/dal/Repositories/AgreementRepository.cs

@@ -39,6 +39,7 @@
             return Context.PimsAgreements
                 .Where(ci => ci.AcquisitionFileId == acquisitionFileId)
                 .Include(ci => ci.AgreementTypeCodeNavigation)
+                .Include(ci => ci.AgreementStatusTypeCodeNavigation)
                 .AsNoTracking()
                 .ToList();
         }

source/backend/dal/Repositories/Interfaces/ILookupRepository.cs

@@ -129,5 +129,7 @@ public interface ILookupRepository : IRepository
         IEnumerable<PimsPropMgmtActivitySubtype> GetAllPropMgmtActivitySubtypes();
 
         IEnumerable<PimsPropMgmtActivityType> GetAllPropMgmtActivityTypes();
+
+        IEnumerable<PimsAgreementStatusType> GetAllAgreementStatusTypes();
     }
 }

source/backend/dal/Repositories/LookupRepository.cs

@@ -373,6 +373,11 @@
             return Context.PimsPropMgmtActivityTypes.AsNoTracking().ToArray();
         }
 
+        public IEnumerable<PimsAgreementStatusType> GetAllAgreementStatusTypes()
+        {
+            return Context.PimsAgreementStatusTypes.AsNoTracking().ToArray();
+        }
+
         #endregion
     }
 }

source/backend/entities/Partials/AgreementStatusType.cs

@@ -0,0 +1,19 @@
+using System.ComponentModel.DataAnnotations.Schema;
+
+namespace Pims.Dal.Entities
+{
+    /// <summary>
+    /// PimsAgreementStatusType class, provides an entity for the datamodel to manage agreement status types.
+    /// </summary>
+    public partial class PimsAgreementStatusType : ITypeEntity<string>
+    {
+        #region Properties
+
+        /// <summary>
+        /// get/set - Primary key to identify agreement status type.
+        /// </summary>
+        [NotMapped]
+        public string Id { get => AgreementStatusTypeCode; set => AgreementStatusTypeCode = value; }
+        #endregion
+    }
+}

source/frontend/src/constants/API.ts

@@ -115,6 +115,7 @@ export const PAYMENT_ITEM_TYPES = 'PimsPaymentItemType';
 export const PROP_MGMT_ACTIVITY_STATUS_TYPES = 'PimsPropMgmtActivityStatusType';
 export const PROP_MGMT_ACTIVITY_SUBTYPES_TYPES = 'PimsPropMgmtActivitySubtype';
 export const PROP_MGMT_ACTIVITY_TYPES = 'PimsPropMgmtActivityType';
+export const AGREEMENT_STATUS_TYPES = 'PimsAgreementStatusType';
 
 // TODO: PSP-4395 This should all be removed from this and moved to the useApi* hooks.
 // Auth Service

source/frontend/src/features/mapSideBar/acquisition/tabs/agreement/detail/AgreementView.tsx

@@ -11,7 +11,7 @@
 import { StyledAddButton } from '@/components/common/styles';
 import Claims from '@/constants/claims';
 import useKeycloakWrapper from '@/hooks/useKeycloakWrapper';
-import { Api_Agreement } from '@/models/api/Agreement';
+import { AgreementStatusTypes, Api_Agreement } from '@/models/api/Agreement';
 import { formatMoney, prettyFormatDate } from '@/utils';
 
 import { StyledSectionSubheader } from '../styles';
@@ -73,8 +73,13 @@
         >
           <StyledSectionSubheader>Agreement details</StyledSectionSubheader>
           <SectionField labelWidth="5" label="Agreement status">
-            {agreement.isDraft === true ? 'Draft' : 'Final'}
+            {agreement.agreementStatusType?.description ?? ''}
           </SectionField>
+          {agreement.agreementStatusType?.id === AgreementStatusTypes.CANCELLED && (
+            <SectionField labelWidth="5" label="Cancellation reason">
+              {agreement.cancellationNote ?? ''}
+            </SectionField>
+          )}
           <SectionField labelWidth="5" label="Legal survey plan">
             {agreement.legalSurveyPlanNum}
           </SectionField>

source/frontend/src/features/mapSideBar/acquisition/tabs/agreement/update/AgreementSubForm.tsx

@@ -1,16 +1,19 @@
-import { FormikProps } from 'formik';
-import React from 'react';
+import { FormikProps, getIn } from 'formik';
+import React, { useEffect } from 'react';
 import styled from 'styled-components';
 
 import {
   FastCurrencyInput,
   FastDatePicker,
   Input,
   Select,
-  SelectOption,
   TextArea,
 } from '@/components/common/form';
 import { SectionField, StyledFieldLabel } from '@/components/common/Section/SectionField';
+import * as API from '@/constants/API';
+import useLookupCodeHelpers from '@/hooks/useLookupCodeHelpers';
+import { useModalContext } from '@/hooks/useModalContext';
+import { AgreementStatusTypes } from '@/models/api/Agreement';
 import { ILookupCode } from '@/store/slices/lookupCodes';
 import { mapLookupCode } from '@/utils';
 import { withNameSpace } from '@/utils/formUtils';
@@ -32,16 +35,53 @@
   agreementTypes,
 }) => {
   const H0074Type = 'H0074';
-  const options: SelectOption[] = [
-    { label: 'Draft', value: 'true' },
-    { label: 'Final', value: 'false' },
-  ];
+  const { getOptionsByType } = useLookupCodeHelpers();
+
+  const agreementStatusOptions = getOptionsByType(API.AGREEMENT_STATUS_TYPES);
+  const agreement = getIn(formikProps.values, nameSpace);
+
+  const { setDisplayModal, setModalContent } = useModalContext();
+  const setFieldValue = formikProps.setFieldValue;
+  useEffect(() => {
+    if (
+      agreement.agreementStatusTypeCode !== AgreementStatusTypes.CANCELLED &&
+      !!agreement.cancellationNote
+    ) {
+      setModalContent({
+        okButtonText: 'Yes',
+        cancelButtonText: 'No',
+        message:
+          'Changing status to a status other than "Cancelled" will remove your "Cancellation reason". Are you sure you want to continue?',
+        title: 'Warning',
+        handleCancel: () => {
+          setFieldValue(
+            withNameSpace(nameSpace, 'agreementStatusTypeCode'),
+            AgreementStatusTypes.CANCELLED,
+          );
+          setDisplayModal(false);
+        },
+        handleOk: () => {
+          setFieldValue(withNameSpace(nameSpace, 'cancellationNote'), '');
+          setDisplayModal(false);
+        },
+      });
+      setDisplayModal(true);
+    }
+  }, [agreement, setFieldValue, nameSpace, setDisplayModal, setModalContent]);
   return (
     <>
       <StyledSectionSubheader>Agreement details</StyledSectionSubheader>
       <SectionField labelWidth="5" label="Agreement status">
-        <Select options={options} field={withNameSpace(nameSpace, 'isDraft')} />
+        <Select
+          options={agreementStatusOptions}
+          field={withNameSpace(nameSpace, 'agreementStatusTypeCode')}
+        />
       </SectionField>
+      {agreement.agreementStatusTypeCode === AgreementStatusTypes.CANCELLED && (
+        <SectionField labelWidth="5" label="Cancellation reason">
+          <Input field={withNameSpace(nameSpace, 'cancellationNote')} />
+        </SectionField>
+      )}
       <SectionField labelWidth="5" label="Legal survey plan">
         <Input field={withNameSpace(nameSpace, 'legalSurveyPlanNum')} />
       </SectionField>

source/frontend/src/features/mapSideBar/acquisition/tabs/agreement/update/UpdateAgreementsForm.test.tsx

@@ -6,7 +6,14 @@ import { useApiUsers } from '@/hooks/pims-api/useApiUsers';
 import { mockAgreementsResponse } from '@/mocks/agreements.mock';
 import { mockLookups } from '@/mocks/index.mock';
 import { ILookupCode, lookupCodesSlice } from '@/store/slices/lookupCodes';
-import { act, render, RenderOptions } from '@/utils/test-utils';
+import {
+  act,
+  fillInput,
+  render,
+  RenderOptions,
+  selectOptions,
+  userEvent,
+} from '@/utils/test-utils';
 
 import { AgreementsFormModel } from './models';
 import { IUpdateAgreementsFormProps, UpdateAgreementsForm } from './UpdateAgreementsForm';
@@ -79,4 +86,48 @@ describe('UpdateAgreementsForm component', () => {
     });
     expect(mockViewProps.onSave).toHaveBeenCalled();
   });
+
+  it('does not display cancellation note by default', async () => {
+    const { queryByText } = setup();
+
+    expect(queryByText(/Cancellation reason/i)).toBeNull();
+  });
+
+  it('displays cancellation note if status is cancelled', async () => {
+    const { getByText } = setup();
+
+    await act(async () => {
+      await act(() => selectOptions('agreements.0.agreementStatusTypeCode', 'CANCELLED'));
+    });
+    expect(getByText(/Cancellation reason/i)).toBeVisible();
+  });
+
+  it('displays a popup if status is changed from cancelled and there is a cancellation note', async () => {
+    const { getByText, container } = setup();
+
+    await act(async () => selectOptions('agreements.0.agreementStatusTypeCode', 'CANCELLED'));
+    await act(async () =>
+      fillInput(container, 'agreements.0.cancellationNote', 'this is a test cancellation note'),
+    );
+    await act(async () => selectOptions('agreements.0.agreementStatusTypeCode', 'DRAFT'));
+    expect(
+      getByText(
+        'Changing status to a status other than "Cancelled" will remove your "Cancellation reason". Are you sure you want to continue?',
+      ),
+    ).toBeVisible();
+  });
+
+  it('hides cancellation note if status is changed from cancelled and there is a cancellation note, and the displayed popup is confirmed', async () => {
+    const { container, getByText, formikRef, queryByText } = setup();
+
+    await act(async () => selectOptions('agreements.0.agreementStatusTypeCode', 'CANCELLED'));
+    await act(async () =>
+      fillInput(container, 'agreements.0.cancellationNote', 'this is a test cancellation note'),
+    );
+    await act(async () => selectOptions('agreements.0.agreementStatusTypeCode', 'DRAFT'));
+    await act(async () => userEvent.click(getByText('Yes')));
+
+    expect(queryByText(/Cancellation reason/i)).toBeNull();
+    expect(formikRef.current?.values.agreements[0].cancellationNote).toBe('');
+  });
 });

source/frontend/src/features/mapSideBar/acquisition/tabs/agreement/update/__snapshots__/UpdateAgreementsForm.test.tsx.snap

@@ -394,23 +394,30 @@ exports[`UpdateAgreementsForm component renders as expected 1`] = `
               >
                 <select
                   class="form-select form-control"
-                  id="input-agreements.0.isDraft"
-                  name="agreements.0.isDraft"
+                  id="input-agreements.0.agreementStatusTypeCode"
+                  name="agreements.0.agreementStatusTypeCode"
                 >
                   <option
                     class="option"
-                    data-testid="select-option-true"
-                    value="true"
+                    data-testid="select-option-DRAFT"
+                    value="DRAFT"
                   >
                     Draft
                   </option>
                   <option
                     class="option"
-                    data-testid="select-option-false"
-                    value="false"
+                    data-testid="select-option-FINAL"
+                    value="FINAL"
                   >
                     Final
                   </option>
+                  <option
+                    class="option"
+                    data-testid="select-option-CANCELLED"
+                    value="CANCELLED"
+                  >
+                    Cancelled
+                  </option>
                 </select>
               </div>
             </div>
@@ -977,23 +984,30 @@ exports[`UpdateAgreementsForm component renders as expected 1`] = `
               >
                 <select
                   class="form-select form-control"
-                  id="input-agreements.1.isDraft"
-                  name="agreements.1.isDraft"
+                  id="input-agreements.1.agreementStatusTypeCode"
+                  name="agreements.1.agreementStatusTypeCode"
                 >
                   <option
                     class="option"
-                    data-testid="select-option-true"
-                    value="true"
+                    data-testid="select-option-DRAFT"
+                    value="DRAFT"
                   >
                     Draft
                   </option>
                   <option
                     class="option"
-                    data-testid="select-option-false"
-                    value="false"
+                    data-testid="select-option-FINAL"
+                    value="FINAL"
                   >
                     Final
                   </option>
+                  <option
+                    class="option"
+                    data-testid="select-option-CANCELLED"
+                    value="CANCELLED"
+                  >
+                    Cancelled
+                  </option>
                 </select>
               </div>
             </div>