Merge pull request #2715 from techmatters/gian_CHI-3107

feat: add isPII flag to form definitions [CHI-3107]
techmatters · Jan 21, 2025 · 5df492b · 5df492b
2 parents 3691707 + 4f5048e
commit 5df492b
Show file tree

Hide file tree

Showing 11 changed files with 61 additions and 20 deletions.
diff --git a/hrm-form-definitions/form-definitions/as/v1/caseForms/CaseOverview.json b/hrm-form-definitions/form-definitions/as/v1/caseForms/CaseOverview.json
@@ -0,0 +1,3 @@
+{
+  "summary": { "isPII": true }
+}
diff --git a/hrm-form-definitions/form-definitions/as/v1/caseForms/HouseholdForm.json b/hrm-form-definitions/form-definitions/as/v1/caseForms/HouseholdForm.json
@@ -3,13 +3,15 @@
     "name": "firstName",
     "type": "input",
     "label": "First Name",
-    "required": { "value": true, "message": "RequiredFieldError" }
+    "required": { "value": true, "message": "RequiredFieldError" },
+    "isPII": true
   },
   {
     "name": "lastName",
     "type": "input",
     "label": "Last Name",
-    "required": { "value": true, "message": "RequiredFieldError" }
+    "required": { "value": true, "message": "RequiredFieldError" },
+    "isPII": true
   },
   {
     "name": "relationshipToChild",
@@ -32,7 +34,8 @@
   {
     "name": "streetAddress",
     "label": "Street Address",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "province",

diff --git a/hrm-form-definitions/form-definitions/as/v1/caseForms/PerpetratorForm.json b/hrm-form-definitions/form-definitions/as/v1/caseForms/PerpetratorForm.json
@@ -3,13 +3,15 @@
     "name": "firstName",
     "type": "input",
     "label": "First Name",
-    "required": { "value": true, "message": "RequiredFieldError" }
+    "required": { "value": true, "message": "RequiredFieldError" },
+    "isPII": true
   },
   {
     "name": "lastName",
     "type": "input",
     "label": "Last Name",
-    "required": { "value": true, "message": "RequiredFieldError" }
+    "required": { "value": true, "message": "RequiredFieldError" },
+    "isPII": true
   },
   {
     "name": "relationshipToChild",
@@ -32,7 +34,8 @@
   {
     "name": "streetAddress",
     "label": "Street Address",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "province",

diff --git a/hrm-form-definitions/form-definitions/as/v1/profileForms/ProfileOverview.json b/hrm-form-definitions/form-definitions/as/v1/profileForms/ProfileOverview.json
@@ -0,0 +1,4 @@
+{
+  "name": { "isPII": true }, 
+  "identifiers": { "isPII": true }
+}
diff --git a/hrm-form-definitions/form-definitions/as/v1/profileForms/Sections.json b/hrm-form-definitions/form-definitions/as/v1/profileForms/Sections.json
@@ -24,6 +24,7 @@
     "type": "textarea",
     "rows": 20,
     "width": 500,
-    "placeholder": "Enter Details"
+    "placeholder": "Enter Details",
+    "isPII": true
   }
 ]
diff --git a/hrm-form-definitions/form-definitions/as/v1/tabbedForms/CallerInformationTab.json b/hrm-form-definitions/form-definitions/as/v1/tabbedForms/CallerInformationTab.json
@@ -2,12 +2,14 @@
   {
     "name": "firstName",
     "label": "First Name",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "lastName",
     "label": "Last Name",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "relationshipToChild",
@@ -31,7 +33,8 @@
   {
     "name": "streetAddress",
     "label": "Street Address",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "province",

diff --git a/hrm-form-definitions/form-definitions/as/v1/tabbedForms/CaseInformationTab.json b/hrm-form-definitions/form-definitions/as/v1/tabbedForms/CaseInformationTab.json
@@ -3,7 +3,8 @@
     "name": "callSummary",
     "label": "Contact Summary",
     "type": "textarea",
-    "required": { "value": true, "message": "RequiredFieldError" }
+    "required": { "value": true, "message": "RequiredFieldError" },
+    "isPII": true
   },
   {
     "name": "repeatCaller",

diff --git a/hrm-form-definitions/form-definitions/as/v1/tabbedForms/ChildInformationTab.json b/hrm-form-definitions/form-definitions/as/v1/tabbedForms/ChildInformationTab.json
@@ -2,12 +2,14 @@
   {
     "name": "firstName",
     "label": "First Name",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "lastName",
     "label": "Last Name",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "gender",
@@ -63,7 +65,8 @@
   {
     "name": "streetAddress",
     "label": "Street Address",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "city",
@@ -126,12 +129,14 @@
   {
     "name": "phone1",
     "label": "Phone #1",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "phone2",
     "label": "Phone #2",
-    "type": "input"
+    "type": "input",
+    "isPII": true
   },
   {
     "name": "language",

diff --git a/hrm-form-definitions/src/__tests__/fetchDefinitionsMock.ts b/hrm-form-definitions/src/__tests__/fetchDefinitionsMock.ts
@@ -27,6 +27,7 @@ const BASE_URL_MOCK = 'http://base_url_mock';
 
 const files = [
   'LayoutDefinitions.json',
+  'caseForms/CaseOverview.json',
   'caseForms/HouseholdForm.json',
   'caseForms/IncidentForm.json',
   'caseForms/NoteForm.json',
@@ -47,6 +48,7 @@ const files = [
   'PrepopulateKeys.json',
   'ReferenceData.json',
   'BlockedEmojis.json',
+  'profileForms/ProfileOverview.json',
   'profileForms/Sections.json',
   'profileForms/FlagDurations.json',
 ];

diff --git a/hrm-form-definitions/src/formDefinition/types.ts b/hrm-form-definitions/src/formDefinition/types.ts
@@ -49,6 +49,10 @@ export enum FormInputType {
   CustomContactComponent = 'custom-contact-component',
 }
 
+type IsPIIFlag = {
+  isPII?: boolean;
+};
+
 /**
  * Types used for customizable forms
  */
@@ -57,7 +61,8 @@ type ItemBase = {
   label: string;
   type: FormInputType;
   metadata?: Record<string, any>;
-} & RegisterOptions;
+} & IsPIIFlag &
+  RegisterOptions;
 
 type NonSaveable = {
   saveable: false;
@@ -201,7 +206,7 @@ export declare type ProfileSectionDefinition = {
   rows: number;
   placeholder: string;
   width: number;
-};
+} & IsPIIFlag;
 
 export declare type ProfileFlagDurationDefinition = {
   flag: string;
@@ -307,11 +312,23 @@ export type StatusInfo = {
   transitions: string[]; // possible statuses this one can transition to (further update may be to include who can make such a transition for a more granular control)
 };
 
+export type CaseOverviewDefinition = {
+  followUpDate?: IsPIIFlag;
+  childIsAtRisk?: IsPIIFlag;
+  summary?: IsPIIFlag;
+};
+
+export type ProfileOverviewDefinition = {
+  name?: IsPIIFlag;
+  identifiers?: IsPIIFlag;
+};
+
 /**
  * Type that defines a complete version for all the customizable forms used across the app
  */
 export type DefinitionVersion = {
   caseForms: {
+    // CaseOverview: CaseOverviewDefinition;
     HouseholdForm: FormDefinition;
     IncidentForm: FormDefinition;
     NoteForm: FormDefinition;
@@ -352,6 +369,7 @@ export type DefinitionVersion = {
   referenceData?: Record<string, any>;
   blockedEmojis: string[];
   profileForms?: {
+    // ProfileOverview: ProfileOverviewDefinition;
     Sections: ProfileSectionDefinition[];
     FlagDurations: ProfileFlagDurationDefinition[];
   };

diff --git a/plugin-hrm-form/src/types/types.ts b/plugin-hrm-form/src/types/types.ts
@@ -69,7 +69,6 @@ export type CSAMReportEntry = {
 } & Omit<EntryInfo, 'id'>;
 
 export type CaseOverview = {
-
   followUpDate?: string;
   childIsAtRisk?: boolean;
   summary?: string;
@@ -97,7 +96,6 @@ export type Case = {
   previousStatus?: string;
   categories: Record<string, string[]>;
   firstContact?: Contact;
-
 };
 
 export type TwilioStoredMedia = {