feat: add qr validation

infrastructure/docker-compose.deploy.yml

@@ -1035,6 +1035,8 @@ services:
       - LOCALE=en
       - ESIGNET_USERINFO_URL=${ESIGNET_USERINFO_URL:-}
       - OIDP_CLIENT_PRIVATE_KEY=${OIDP_CLIENT_PRIVATE_KEY:-}
+      - ESIGNET_TOKEN_URL=${ESIGNET_TOKEN_URL:-}
+      - OIDP_JWT_AUD_CLAIM=${OIDP_JWT_AUD_CLAIM:-}
     deploy:
       replicas: 1
       labels:
@@ -1064,7 +1066,7 @@ services:
     image: ghcr.io/opencrvs/mosip-mock:${MOSIP_API_VERSION}
     environment:
       - NODE_ENV=production
-      - OPENCRVS_MOSIP_SERVER_URL=https://mosip-api.{{hostname}}/webhooks/mosip
+      - OPENCRVS_MOSIP_API_URL=https://mosip-api.{{hostname}}/webhooks/mosip
       - SENDER_EMAIL_ADDRESS=${SENDER_EMAIL_ADDRESS:-}
       - ALERT_EMAIL=${ALERT_EMAIL:-}
       - SMTP_HOST=${SMTP_HOST:-}

package.json

@@ -64,8 +64,8 @@
     "@hapi/boom": "^9.1.1",
     "@hapi/hapi": "^20.0.1",
     "@hapi/inert": "^6.0.3",
-    "@opencrvs/mosip": "^1.7.0-alpha.13",
-    "@opencrvs/toolkit": "0.0.32-jr",
+    "@opencrvs/mosip": "^1.7.0-alpha.17",
+    "@opencrvs/toolkit": "0.0.33",
     "@types/chalk": "^2.2.0",
     "@types/csv2json": "^1.4.0",
     "@types/fhir": "^0.0.30",
@@ -122,4 +122,4 @@
     "minimist": "^1.2.2",
     "acorn": "^6.4.1"
   }
-}
+}

src/form/birth/index.ts

@@ -9,7 +9,7 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 
-import { Event, ISerializedForm, SerializedFormField } from '../types/types'
+import { Event, ISerializedForm } from '../types/types'
 import { formMessageDescriptors } from '../common/messages'
 import { informantType } from './required-fields'
 import {
@@ -76,23 +76,16 @@ import {
 } from './required-sections'
 import { certificateHandlebars } from './certificate-handlebars'
 import { getSectionMapping } from '@countryconfig/utils/mapping/section/birth/mapping-utils'
-import { getCommonSectionMapping } from '@countryconfig/utils/mapping/field-mapping-utils'
+import {
+  getCommonSectionMapping,
+  getCustomFieldMapping
+} from '@countryconfig/utils/mapping/field-mapping-utils'
 import { getReasonForLateRegistration } from '../custom-fields'
 import { getIDNumberFields, getIDType } from '../custom-fields'
-import {
-  esignet,
-  esignetCallback,
-  idReader,
-  idVerificationFields,
-  qr
-} from '@opencrvs/mosip'
 import { getGenderCustom } from './custom-fields'
-import {
-  ESIGNET_TOKEN_URL,
-  MOSIP_API_USERINFO_URL,
-  OPENID_PROVIDER_CLAIMS,
-  OPENID_PROVIDER_CLIENT_ID
-} from '@countryconfig/constants'
+import { idReaderFields, getInitialValueFromIDReader } from '@opencrvs/mosip'
+import { esignetConfig, qrCodeConfig } from '../common/id-reader-configurations'
+
 // import { createCustomFieldExample } from '../custom-fields'
 
 // ======================= FORM CONFIGURATION =======================
@@ -233,64 +226,40 @@ export const birthForm: ISerializedForm = {
           fields: [
             informantType, // Required field.
             otherInformantType(Event.Birth), // Required field.
-            idReader(
+            ...idReaderFields(
               'birth',
               'informant',
-              informantFirstNameConditionals
-                .concat(hideIfInformantMotherOrFather)
-                .concat({
-                  action: 'hide',
-                  expression: '!!$form?.verified'
-                }),
-              [
-                qr(),
-                esignet(
-                  ESIGNET_TOKEN_URL,
-                  OPENID_PROVIDER_CLIENT_ID,
-                  OPENID_PROVIDER_CLAIMS,
-                  'esignet',
-                  'esignetCallback'
-                )
-              ]
-            ) as SerializedFormField,
-            esignetCallback({
-              fieldName: 'esignetCallback',
-              mosipAPIUserInfoUrl: MOSIP_API_USERINFO_URL,
-              openIdProviderClientId: OPENID_PROVIDER_CLIENT_ID
-            }) as SerializedFormField,
-            ...(idVerificationFields(
-              'birth',
-              'informant'
-            ) as SerializedFormField[]),
+              qrCodeConfig,
+              esignetConfig,
+              getCustomFieldMapping(
+                `birth.informant.informant-view-group.verified`
+              ),
+              informantFirstNameConditionals.concat(
+                hideIfInformantMotherOrFather
+              )
+            ),
             getFirstNameField(
               'informantNameInEnglish',
               informantFirstNameConditionals.concat(
                 hideIfInformantMotherOrFather
               ),
               certificateHandlebars.informantFirstName,
-              {
-                dependsOn: ['idReader', 'esignetCallback'],
-                expression:
-                  '$form?.idReader?.firstName || $form?.esignetCallback?.data?.firstName || ""'
-              }
+              getInitialValueFromIDReader('firstName')
             ), // Required field. In Farajaland, we have built the option to integrate with MOSIP. So we have different conditionals for each name to check MOSIP responses.  You could always refactor firstNamesEng for a basic setup
             getFamilyNameField(
               'informantNameInEnglish',
               informantFamilyNameConditionals.concat(
                 hideIfInformantMotherOrFather
               ),
               certificateHandlebars.informantFamilyName,
-              {
-                dependsOn: ['idReader', 'esignetCallback'],
-                expression:
-                  '$form?.idReader?.familyName || $form?.esignetCallback?.data?.familyName || ""'
-              }
+              getInitialValueFromIDReader('familyName')
+            ), // Required field.
+            getGenderCustom(
+              'birth',
+              'informant',
+              [],
+              getInitialValueFromIDReader('gender')
             ), // Required field.
-            getGenderCustom('birth', 'informant', [], {
-              dependsOn: ['idReader', 'esignetCallback'],
-              expression:
-                '$form?.idReader?.gender || $form?.esignetCallback?.data?.gender || ""'
-            }),
             getBirthDate(
               'informantBirthDate',
               informantBirthDateConditionals.concat(
@@ -307,11 +276,7 @@ export const birthForm: ISerializedForm = {
                 }
               ],
               certificateHandlebars.informantBirthDate,
-              {
-                dependsOn: ['idReader', 'esignetCallback'],
-                expression:
-                  '$form?.idReader?.birthDate || $form?.esignetCallback?.data?.birthDate || ""'
-              }
+              getInitialValueFromIDReader('birthDate')
             ), // Required field.
             exactDateOfBirthUnknown(hideIfInformantMotherOrFather),
             getAgeOfIndividualInYears(
@@ -370,21 +335,32 @@ export const birthForm: ISerializedForm = {
               mothersDetailsExistConditionals
             ),
             getReasonNotExisting(certificateHandlebars.motherReasonNotApplying), // Strongly recommend is required if you want to register abandoned / orphaned children!
+            ...idReaderFields(
+              'birth',
+              'mother',
+              qrCodeConfig,
+              esignetConfig,
+              getCustomFieldMapping(`birth.mother.mother-view-group.verified`),
+              detailsExist
+            ),
             getFirstNameField(
               'motherNameInEnglish',
               motherFirstNameConditionals,
-              certificateHandlebars.motherFirstName
+              certificateHandlebars.motherFirstName,
+              getInitialValueFromIDReader('firstName')
             ), // Required field.
             getFamilyNameField(
               'motherNameInEnglish',
               motherFamilyNameConditionals,
-              certificateHandlebars.motherFamilyName
+              certificateHandlebars.motherFamilyName,
+              getInitialValueFromIDReader('familyName')
             ), // Required field.
             getBirthDate(
               'motherBirthDate',
               mothersBirthDateConditionals,
               parentsBirthDateValidators,
-              certificateHandlebars.motherBirthDate
+              certificateHandlebars.motherBirthDate,
+              getInitialValueFromIDReader('birthDate')
             ), // Required field.
             exactDateOfBirthUnknown(detailsExistConditional),
             getAgeOfIndividualInYears(
@@ -449,21 +425,32 @@ export const birthForm: ISerializedForm = {
               fathersDetailsExistConditionals
             ),
             getReasonNotExisting('fatherReasonNotApplying'), // Strongly recommend is required if you want to register abandoned / orphaned children!
+            ...idReaderFields(
+              'birth',
+              'father',
+              qrCodeConfig,
+              esignetConfig,
+              getCustomFieldMapping(`birth.father.father-view-group.verified`),
+              detailsExist
+            ),
             getFirstNameField(
               'fatherNameInEnglish',
               fatherFirstNameConditionals,
-              certificateHandlebars.fatherFirstName
+              certificateHandlebars.fatherFirstName,
+              getInitialValueFromIDReader('firstName')
             ), // Required field.
             getFamilyNameField(
               'fatherNameInEnglish',
               fatherFamilyNameConditionals,
-              certificateHandlebars.fatherFamilyName
+              certificateHandlebars.fatherFamilyName,
+              getInitialValueFromIDReader('familyName')
             ), // Required field.
             getBirthDate(
               'fatherBirthDate',
               fathersBirthDateConditionals,
               parentsBirthDateValidators,
-              certificateHandlebars.fatherBirthDate
+              certificateHandlebars.fatherBirthDate,
+              getInitialValueFromIDReader('birthDate')
             ), // Required field.
             exactDateOfBirthUnknown(detailsExistConditional),
             getAgeOfIndividualInYears(

src/form/common/id-reader-configurations.ts

@@ -0,0 +1,45 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+
+import { and, objectHasProperty } from '@opencrvs/toolkit/conditionals'
+import {
+  ESIGNET_TOKEN_URL,
+  MOSIP_API_USERINFO_URL,
+  OPENID_PROVIDER_CLIENT_ID
+} from '@countryconfig/constants'
+
+export const qrCodeConfig = {
+  validation: {
+    rule: and(
+      objectHasProperty('firstName', 'string'),
+      objectHasProperty('familyName', 'string'),
+      objectHasProperty('gender', 'string'),
+      objectHasProperty('birthDate', 'string'),
+      objectHasProperty('nid', 'string')
+    ),
+    errorMessage: {
+      defaultMessage: 'This QR code is not recognised. Please try again.',
+      description: 'Error message for QR code validation',
+      id: 'form.field.qr.validation.error'
+    }
+  }
+}
+
+export const esignetConfig = {
+  fieldName: 'esignet',
+  esignetAuthUrl: ESIGNET_TOKEN_URL,
+  openIdProviderClientId: OPENID_PROVIDER_CLIENT_ID,
+  openIdProviderClaims: undefined,
+  callback: {
+    fieldName: 'esignetCallback',
+    mosipAPIUserInfoUrl: MOSIP_API_USERINFO_URL
+  }
+}

src/form/custom-fields.ts

@@ -157,7 +157,10 @@ export function getIDType(
       description: 'A form field that asks for the type of ID.',
       defaultMessage: 'Type of ID'
     },
-    initialValue: '',
+    initialValue: {
+      dependsOn: ['idReader'],
+      expression: '!!$form?.idReader?.nid? "NATIONAL_ID" : ""'
+    },
     validator: [],
     mapping: getCustomFieldMapping(fieldId),
     placeholder: formMessageDescriptors.formSelectPlaceholder,
@@ -173,6 +176,18 @@ function getValidators(configCase: string, idValue: IDType) {
   return []
 }
 
+function initialValuesForIDType(idType: IDType) {
+  if (idType === 'NATIONAL_ID') {
+    return {
+      dependsOn: ['idReader'],
+      expression:
+        '$form?.idReader?.nid || $form?.esignetCallback?.data?.nid || ""'
+    }
+  } else {
+    return ''
+  }
+}
+
 export function getIDNumber(
   sectionId: string,
   idValue: IDType,
@@ -194,7 +209,7 @@ export function getIDNumber(
       description: 'A form field that asks for the id number.',
       defaultMessage: 'ID number'
     },
-    initialValue: '',
+    initialValue: initialValuesForIDType(idValue),
     validator: validators,
     mapping: {
       template: {