feat: Update the order of system user add/edit form fields and labels…

… and remove NID field (#7697) * Ask surname first in the User details form we often receive requests from countries to have the surname first in this form, we have decided to satisfy that requirement by putting surname first for ALL countries. #6830 * Change name and surname labels for User Details form A request came for the clients to change the labels for "First name(s)" to "User's first name". Also change "Last name" to "User's surname" for clarity and less confussion. #6830 * Remove NID field from the user details form Remove the question that asks the user for a national ID number in this form as it is not required #6830 * Remove lang suffix for FamilyName field We no longer need the suffixes for the FamilyName field since we not really using it anywhere #6830 * Add migration to remove NID field from user A requirement from client to remove the NID field since most of the contries are not really using it. #6830 * Record changes in the CHANGELOG To keep track of changes done on this PR #6830 * Remove Eng suffix for the firstName in user form We currently don't support milti language support for both surname and first names so the ENG/EN suffixes are not needed. Also remove EN bits that were left for the surname field #6830 --------- Co-authored-by: Siyasanga Mtshokotsha <siya@Siyasangas-MBP.lan> Co-authored-by: Siyasanga Mtshokotsha <siya@Siyasangas-MacBook-Pro.local>
opencrvs · Oct 17, 2024 · 1695fb1 · 1695fb1
1 parent a953b65
commit 1695fb1
Show file tree

Hide file tree

Showing 29 changed files with 73 additions and 199 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@
 - Two new statuses of record are added: `Validated` and `Correction Requested` for advanced search parameters [#6365](https://github.com/opencrvs/opencrvs-core/issues/6365)
 - A new field: `Time Period` is added to advanced search [#6365](https://github.com/opencrvs/opencrvs-core/issues/6365)
 - Deploy UI-Kit Storybook to [opencrvs.pages.dev](https://opencrvs.pages.dev) to allow extending OpenCRVS using the component library
+- Reoder the sytem user add/edit field for surname to be first, also change labels from `Last name` to `User's surname` and lastly remove the NID question from the form [#6830](https://github.com/opencrvs/opencrvs-core/issues/6830)
 
 ## Bug fixes
 

diff --git a/packages/client/src/forms/user/fieldDefinitions/createUser.ts b/packages/client/src/forms/user/fieldDefinitions/createUser.ts
@@ -18,7 +18,6 @@ import {
   UserSection
 } from '@client/forms/index'
 import { messages as userFormMessages } from '@client/i18n/messages/views/userForm'
-import { NATIONAL_ID } from '@client/utils/constants'
 
 export function userSectionFormType(): ISerializedFormSection {
   return {
@@ -79,38 +78,38 @@ export function userSectionFormType(): ISerializedFormSection {
         title: userFormMessages.userDetails,
         fields: [
           {
-            name: 'firstNamesEng',
+            name: 'familyName',
             type: TEXT,
-            label: userFormMessages.firstNameEn,
+            label: userFormMessages.lastName,
             required: true,
             initialValue: '',
             validator: [{ operation: 'englishOnlyNameFormat' }],
             mapping: {
               mutation: {
                 operation: 'fieldToNameTransformer',
-                parameters: ['en', 'firstNames']
+                parameters: ['en', 'familyName']
               },
               query: {
                 operation: 'nameToFieldTransformer',
-                parameters: ['en', 'firstNames']
+                parameters: ['en', 'familyName']
               }
             }
           },
           {
-            name: 'familyNameEng',
+            name: 'firstName',
             type: TEXT,
-            label: userFormMessages.lastNameEn,
+            label: userFormMessages.firstName,
             required: true,
             initialValue: '',
             validator: [{ operation: 'englishOnlyNameFormat' }],
             mapping: {
               mutation: {
                 operation: 'fieldToNameTransformer',
-                parameters: ['en', 'familyName']
+                parameters: ['en', 'firstNames']
               },
               query: {
                 operation: 'nameToFieldTransformer',
-                parameters: ['en', 'familyName']
+                parameters: ['en', 'firstNames']
               }
             }
           },
@@ -152,29 +151,6 @@ export function userSectionFormType(): ISerializedFormSection {
             initialValue: '',
             validator: [{ operation: 'emailAddressFormat' }]
           },
-          {
-            name: 'nid',
-            type: TEXT,
-            label: userFormMessages.NID,
-            required: false,
-            initialValue: '',
-            validator: [
-              {
-                operation: 'validIDNumber',
-                parameters: [NATIONAL_ID]
-              }
-            ],
-            mapping: {
-              mutation: {
-                operation: 'fieldToIdentifierWithTypeTransformer',
-                parameters: [NATIONAL_ID]
-              },
-              query: {
-                operation: 'identifierWithTypeToFieldTransformer',
-                parameters: [NATIONAL_ID]
-              }
-            }
-          },
           {
             name: 'seperator',
             type: 'DIVIDER',

diff --git a/packages/client/src/i18n/messages/views/userForm.ts b/packages/client/src/i18n/messages/views/userForm.ts
@@ -49,15 +49,15 @@ export const messages = {
     description: 'User details section',
     id: 'form.section.userDetails'
   },
-  firstNameEn: {
-    defaultMessage: 'First name',
-    description: 'English first name',
-    id: 'form.field.label.firstNameEN'
+  firstName: {
+    defaultMessage: "User's first name",
+    description: "User's English first name",
+    id: 'form.field.label.userFirstName'
   },
-  lastNameEn: {
-    defaultMessage: 'Last name',
-    description: 'English last name',
-    id: 'form.field.label.lastNameEN'
+  lastName: {
+    defaultMessage: "User's surname",
+    description: "User's English surname",
+    id: 'form.field.label.userSurname'
   },
   phoneNumber: {
     defaultMessage: 'Phone number',
@@ -69,11 +69,6 @@ export const messages = {
     description: 'Input label for email address',
     id: 'form.field.label.email'
   },
-  NID: {
-    defaultMessage: 'NID',
-    description: 'National ID',
-    id: 'form.field.label.NID'
-  },
   accountDetails: {
     defaultMessage: 'Account details',
     description: 'Account details section',

diff --git a/packages/client/src/tests/forms.json b/packages/client/src/tests/forms.json
@@ -12203,7 +12203,7 @@
                 "label": {
                   "defaultMessage": "Last name",
                   "description": "English last name",
-                  "id": "form.field.label.lastNameEN"
+                  "id": "form.field.label.userSurname"
                 },
                 "required": true,
                 "initialValue": "",
@@ -12264,33 +12264,6 @@
                   }
                 }
               },
-              {
-                "name": "nid",
-                "type": "TEXT",
-                "label": {
-                  "defaultMessage": "NID",
-                  "description": "National ID",
-                  "id": "form.field.label.NID"
-                },
-                "required": false,
-                "initialValue": "",
-                "validate": [
-                  {
-                    "operation": "validIDNumber",
-                    "parameters": ["NATIONAL_ID"]
-                  }
-                ],
-                "mapping": {
-                  "mutation": {
-                    "operation": "fieldToIdentifierWithTypeTransformer",
-                    "parameters": ["NATIONAL_ID"]
-                  },
-                  "query": {
-                    "operation": "identifierWithTypeToFieldTransformer",
-                    "parameters": ["NATIONAL_ID"]
-                  }
-                }
-              },
               {
                 "name": "seperator",
                 "type": "SUBSECTION",
@@ -12555,7 +12528,7 @@
                 "label": {
                   "defaultMessage": "Last name",
                   "description": "English last name",
-                  "id": "form.field.label.lastNameEN"
+                  "id": "form.field.label.userSurname"
                 },
                 "required": true,
                 "initialValue": "",
@@ -12616,33 +12589,6 @@
                   }
                 }
               },
-              {
-                "name": "nid",
-                "type": "TEXT",
-                "label": {
-                  "defaultMessage": "NID",
-                  "description": "National ID",
-                  "id": "form.field.label.NID"
-                },
-                "required": false,
-                "initialValue": "",
-                "validate": [
-                  {
-                    "operation": "validIDNumber",
-                    "parameters": ["NATIONAL_ID"]
-                  }
-                ],
-                "mapping": {
-                  "mutation": {
-                    "operation": "fieldToIdentifierWithTypeTransformer",
-                    "parameters": ["NATIONAL_ID"]
-                  },
-                  "query": {
-                    "operation": "identifierWithTypeToFieldTransformer",
-                    "parameters": ["NATIONAL_ID"]
-                  }
-                }
-              },
               {
                 "name": "seperator",
                 "type": "SUBSECTION",

diff --git a/packages/client/src/tests/util.tsx b/packages/client/src/tests/util.tsx
@@ -1446,10 +1446,8 @@ export const mockCompleteFormData = {
   accountDetails: '',
   assignedRegistrationOffice: '',
   device: '',
-  familyName: 'হোসেন',
-  familyNameEng: 'Hossain',
-  firstNames: 'Jeff',
-  firstNamesEng: 'Jeff',
+  familyName: 'Hossain',
+  firstName: 'Jeff',
   nid: '123456789',
   phoneNumber: '01662132132',
   email: 'jeff.hossain@gmail.com',
@@ -1600,7 +1598,7 @@ export const mockUserGraphqlOperation = {
                       }
                     },
                     {
-                      name: 'firstNamesEng',
+                      name: 'firstNames',
                       type: 'TEXT',
                       label: {
                         defaultMessage: 'English first name',
@@ -1622,12 +1620,12 @@ export const mockUserGraphqlOperation = {
                       }
                     },
                     {
-                      name: 'familyNameEng',
+                      name: 'familyName',
                       type: 'TEXT',
                       label: {
                         defaultMessage: 'English last name',
                         description: 'English last name',
-                        id: 'form.field.label.lastNameEN'
+                        id: 'form.field.label.userSurname'
                       },
                       required: true,
                       initialValue: '',
@@ -1665,33 +1663,6 @@ export const mockUserGraphqlOperation = {
                         }
                       }
                     },
-                    {
-                      name: 'nid',
-                      type: 'TEXT',
-                      label: {
-                        defaultMessage: 'NID',
-                        description: 'National ID',
-                        id: 'form.field.label.NID'
-                      },
-                      required: true,
-                      initialValue: '',
-                      validator: [
-                        {
-                          operation: 'validIDNumber',
-                          parameters: ['NATIONAL_ID']
-                        }
-                      ],
-                      mapping: {
-                        mutation: {
-                          operation: 'fieldToIdentifierWithTypeTransformer',
-                          parameters: ['NATIONAL_ID']
-                        },
-                        query: {
-                          operation: 'identifierWithTypeToFieldTransformer',
-                          parameters: ['NATIONAL_ID']
-                        }
-                      }
-                    },
                     {
                       name: 'accountDetails',
                       type: 'FIELD_GROUP_TITLE',
@@ -1822,10 +1793,8 @@ export const mockDataWithRegistarRoleSelected = {
   accountDetails: '',
   assignedRegistrationOffice: '',
   device: '',
-  familyName: 'হোসেন',
-  familyNameEng: 'Hossain',
-  firstNames: 'Jeff',
-  firstNamesEng: 'Jeff',
+  familyName: 'Hossain',
+  firstName: 'Jeff',
   email: 'jeff@gmail.com',
   nid: '101488192',
   phoneNumber: '01662132132',

diff --git a/packages/client/src/views/SysAdmin/Team/user/userCreation/CreateNewUser.test.tsx b/packages/client/src/views/SysAdmin/Team/user/userCreation/CreateNewUser.test.tsx
@@ -230,7 +230,7 @@ describe('create new user tests', () => {
       expect(
         testComponent
           .find(FormFieldGenerator)
-          .find('#familyNameEng_error')
+          .find('#familyName_error')
           .hostNodes()
           .text()
       ).toBe('Required to register a new user')
@@ -288,13 +288,13 @@ describe('create new user tests', () => {
 
     it('clicking change button on a field takes user back to form', async () => {
       testComponent
-        .find('#btn_change_firstNamesEng')
+        .find('#btn_change_firstName')
         .hostNodes()
         .first()
         .simulate('click')
       await flushPromises()
       expect(history.location.pathname).toBe('/createUser/user/user-view-group')
-      expect(history.location.hash).toBe('#firstNamesEng')
+      expect(history.location.hash).toBe('#firstName')
     })
 
     it('clicking submit button submits the form data', async () => {
@@ -339,11 +339,6 @@ describe('edit user tests', () => {
             username: 'shakib1',
             mobile: '+8801662132163',
             email: 'jeff@gmail.com',
-            identifier: {
-              system: 'NATIONAL_ID',
-              value: '101488192',
-              __typename: 'Identifier'
-            },
             systemRole: 'NATIONAL_REGISTRAR',
             role: { _id: '63ef9466f708ea080777c27a' },
             status: 'active',

diff --git a/packages/client/src/views/SysAdmin/Team/user/userCreation/UserReviewForm.tsx b/packages/client/src/views/SysAdmin/Team/user/userCreation/UserReviewForm.tsx
@@ -249,7 +249,7 @@ class UserReviewFormComponent extends React.Component<
       (field) => field.name === 'firstNamesEng'
     ) as IFormField
     const familyNameEngField = fields.find(
-      (field) => field.name === 'familyNameEng'
+      (field) => field.name === 'familyName'
     ) as IFormField
 
     return `${this.getValue(firstNamesEngField)} ${this.getValue(

diff --git a/packages/gateway/src/features/registration/type-resolvers.test.ts b/packages/gateway/src/features/registration/type-resolvers.test.ts
@@ -51,7 +51,6 @@ const MOCK_USER: IUserModelData = {
     }
   ],
   username: 'd.bulaya',
-  identifiers: [],
   email: '',
   device: 'Samsung Galaxy S9',
   emailForNotification: 'kalushabw.alya17@gmail.com',

diff --git a/packages/gateway/src/features/user/root-resolvers.ts b/packages/gateway/src/features/user/root-resolvers.ts
@@ -26,7 +26,6 @@ import {
   GQLHumanNameInput,
   GQLResolver,
   GQLSearchFieldAgentResponse,
-  GQLUserIdentifierInput,
   GQLUserInput
 } from '@gateway/graphql/schema'
 import { logger, isBase64FileString } from '@opencrvs/commons'
@@ -640,7 +639,6 @@ function createOrUpdateUserPayload(user: GQLUserInput): IUserPayload {
     role: user.role as string,
     ...(user.password && { password: user.password }),
     ...(user.status && { status: user.status }),
-    identifiers: (user.identifier as GQLUserIdentifierInput[]) || [],
     primaryOfficeId: user.primaryOffice as string,
     email: '',
     ...(user.email && { emailForNotification: user.email }), //instead of saving data in email, we want to store it in emailForNotification property

diff --git a/packages/gateway/src/features/user/type-resolvers.test.ts b/packages/gateway/src/features/user/type-resolvers.test.ts
@@ -51,7 +51,6 @@ describe('User type resolvers', () => {
     username: 'tamim.iqlbal',
     mobile: '+8801711111111',
     email: 'test@test.org',
-    identifiers: [{ system: 'NATIONAL_ID', value: '1010101010' }],
     systemRole: 'REGISTRATION_AGENT',
     scope: ['certify'],
     status: 'active',
@@ -90,13 +89,6 @@ describe('User type resolvers', () => {
     const res = userTypeResolvers.User!.underInvestigation(mockResponse)
     expect(res).toBeTruthy()
   })
-  it('return user identifier', () => {
-    const res = userTypeResolvers.User!.identifier(mockResponse)
-    expect(res).toEqual({
-      system: mockResponse.identifiers[0].system,
-      value: mockResponse.identifiers[0].value
-    })
-  })
   it('return primaryOffice type', async () => {
     const mockOffice = {
       resourceType: 'Location',