feat: QR code scanner

infrastructure/docker-compose.deploy.yml

@@ -581,6 +581,11 @@ services:
       - INFOBIP_API_KEY=${INFOBIP_API_KEY:-}
       - INFOBIP_SENDER_ID=${INFOBIP_SENDER_ID:-}
       - DOMAIN={{hostname}}
+      - E_SIGNET_AUTH_URL=${E_SIGNET_AUTH_URL}
+      - OPENID_PROVIDER_CLIENT_ID=${OPENID_PROVIDER_CLIENT_ID}
+      - OPENID_PROVIDER_CLAIMS=${OPENID_PROVIDER_CLAIMS}
+      - OIDP_USER_INFO_URL=${OIDP_USER_INFO_URL}
+      - LOCALE=en
     networks:
       - overlay_net
     logging:

infrastructure/docker-compose.development-deploy.yml

@@ -28,6 +28,10 @@ services:
       - SMTP_USERNAME=${SMTP_USERNAME}
       - SMTP_PASSWORD=${SMTP_PASSWORD}
       - SMTP_SECURE=${SMTP_SECURE}
+      - E_SIGNET_AUTH_URL=${E_SIGNET_AUTH_URL}
+      - OPENID_PROVIDER_CLIENT_ID=${OPENID_PROVIDER_CLIENT_ID}
+      - OPENID_PROVIDER_CLAIMS=${OPENID_PROVIDER_CLAIMS}
+      - OIDP_USER_INFO_URL=${OIDP_USER_INFO_URL}
     deploy:
       replicas: 1
     networks:

infrastructure/docker-compose.qa-deploy.yml

@@ -57,6 +57,10 @@ services:
       - SMTP_USERNAME=${SMTP_USERNAME}
       - SMTP_PASSWORD=${SMTP_PASSWORD}
       - SMTP_SECURE=${SMTP_SECURE}
+      - E_SIGNET_AUTH_URL=${E_SIGNET_AUTH_URL}
+      - OPENID_PROVIDER_CLIENT_ID=${OPENID_PROVIDER_CLIENT_ID}
+      - OPENID_PROVIDER_CLAIMS=${OPENID_PROVIDER_CLAIMS}
+      - OIDP_USER_INFO_URL=${OIDP_USER_INFO_URL}
     deploy:
       replicas: 1
     networks:

infrastructure/docker-compose.staging-deploy.yml

@@ -107,6 +107,10 @@ services:
       - SMTP_USERNAME=${SMTP_USERNAME}
       - SMTP_PASSWORD=${SMTP_PASSWORD}
       - SMTP_SECURE=${SMTP_SECURE}
+      - E_SIGNET_AUTH_URL=${E_SIGNET_AUTH_URL}
+      - OPENID_PROVIDER_CLIENT_ID=${OPENID_PROVIDER_CLIENT_ID}
+      - OPENID_PROVIDER_CLAIMS=${OPENID_PROVIDER_CLAIMS}
+      - OIDP_USER_INFO_URL=${OIDP_USER_INFO_URL}
     deploy:
       replicas: 1
 

package.json

@@ -64,7 +64,7 @@
     "@hapi/boom": "^9.1.1",
     "@hapi/hapi": "^20.0.1",
     "@hapi/inert": "^6.0.3",
-    "@opencrvs/mosip": "^1.7.0-alpha.2",
+    "@opencrvs/mosip": "^1.7.0-alpha.4",
     "@opencrvs/toolkit": "0.0.6-events",
     "@types/chalk": "^2.2.0",
     "@types/csv2json": "^1.4.0",
@@ -122,4 +122,4 @@
     "minimist": "^1.2.2",
     "acorn": "^6.4.1"
   }
-}
+}

src/constants.ts

@@ -30,3 +30,9 @@ export const CHECK_INVALID_TOKEN = env.CHECK_INVALID_TOKEN
 
 export const PRODUCTION = env.isProd
 export const QA_ENV = env.QA_ENV
+
+// e-signet
+export const E_SIGNET_AUTH_URL = env.E_SIGNET_AUTH_URL
+export const OPENID_PROVIDER_CLIENT_ID = env.OPENID_PROVIDER_CLIENT_ID
+export const OPENID_PROVIDER_CLAIMS = env.OPENID_PROVIDER_CLAIMS
+export const OIDP_USER_INFO_URL = env.OIDP_USER_INFO_URL

src/environment.ts

@@ -30,5 +30,9 @@ export const env = cleanEnv(process.env, {
   CONFIRM_REGISTRATION_URL: url({
     devDefault: 'http://localhost:5050/confirm/registration'
   }),
-  QA_ENV: bool({ default: false })
+  QA_ENV: bool({ default: false }),
+  E_SIGNET_AUTH_URL: url({ devDefault: '' }),
+  OPENID_PROVIDER_CLIENT_ID: str({ devDefault: '' }),
+  OPENID_PROVIDER_CLAIMS: str({ devDefault: '' }),
+  OIDP_USER_INFO_URL: url({ devDefault: '' })
 })

src/form/birth/custom-fields.ts

@@ -0,0 +1,36 @@
+import { getCustomFieldMapping } from '@countryconfig/utils/mapping/field-mapping-utils'
+import { formMessageDescriptors } from '../common/messages'
+import { Conditional, SerializedFormField } from '../types/types'
+import { genderOptions } from '../common/select-options'
+
+/**
+ *
+ * @param event
+ * @param sectionId
+ * @returns hidden field to store QR scanned data
+ */
+
+/** To bypass config validation */
+export function getGenderCustom(
+  event: string,
+  sectionId: string,
+  conditionals: Conditional[],
+  initialValue: { dependsOn: string[]; expression: string } | string = ''
+) {
+  const fieldName: string = 'gender'
+  const fieldId: string = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`
+  return {
+    name: fieldName,
+    type: 'SELECT_WITH_OPTIONS',
+    customQuestionMappingId: fieldId,
+    custom: true,
+    label: formMessageDescriptors.sex,
+    required: false,
+    initialValue,
+    conditionals,
+    validator: [],
+    placeholder: formMessageDescriptors.formSelectPlaceholder,
+    mapping: getCustomFieldMapping(fieldId),
+    options: genderOptions
+  } satisfies SerializedFormField
+}

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 } from '../types/types'
+import { Event, ISerializedForm, SerializedFormField } from '../types/types'
 import { formMessageDescriptors } from '../common/messages'
 import { informantType } from './required-fields'
 import {
@@ -79,6 +79,20 @@
 import { getCommonSectionMapping } 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 {
+  E_SIGNET_AUTH_URL,
+  OIDP_USER_INFO_URL,
+  OPENID_PROVIDER_CLAIMS,
+  OPENID_PROVIDER_CLIENT_ID
+} from '@countryconfig/constants'
 // import { createCustomFieldExample } from '../custom-fields'
 
 // ======================= FORM CONFIGURATION =======================
@@ -219,20 +233,66 @@
           fields: [
             informantType, // Required field.
             otherInformantType(Event.Birth), // Required field.
+            idReader(
+              'birth',
+              'informant',
+              informantFirstNameConditionals
+                .concat(hideIfInformantMotherOrFather)
+                .concat({
+                  action: 'hide',
+                  expression: '!!$form?.verified'
+                }),
+              [
+                qr(),
+                esignet(
+                  'birth',
+                  'informant',
+                  E_SIGNET_AUTH_URL,
+                  OPENID_PROVIDER_CLIENT_ID,
+                  OPENID_PROVIDER_CLAIMS,
+                  'esignet',
+                  'esignetCallback'
+                )
+              ]
+            ) as SerializedFormField,
+            esignetCallback({
+              fieldName: 'esignetCallback',
+              getOIDPUserInfoUrl: OIDP_USER_INFO_URL,
+              openIdProviderClientId: OPENID_PROVIDER_CLIENT_ID
+            }) as SerializedFormField,
+            ...(idVerificationFields(
+              'birth',
+              'informant'
+            ) as SerializedFormField[]),
             getFirstNameField(
               'informantNameInEnglish',
               informantFirstNameConditionals.concat(
                 hideIfInformantMotherOrFather
               ),
-              certificateHandlebars.informantFirstName
-            ), // Required field.
+              certificateHandlebars.informantFirstName,
+              {
+                dependsOn: ['idReader', 'esignetCallback'],
+                expression:
+                  '$form?.idReader?.firstName || "$form?.esignetCallback?.data?.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
+              certificateHandlebars.informantFamilyName,
+              {
+                dependsOn: ['idReader', 'esignetCallback'],
+                expression:
+                  '$form?.idReader?.familyName || "$form?.esignetCallback?.data?.familyName"'
+              }
             ), // Required field.
+            getGenderCustom('birth', 'informant', [], {
+              dependsOn: ['idReader', 'esignetCallback'],
+              expression:
+                '$form?.idReader?.gender || "$form?.esignetCallback?.data?.gender"'
+            }),
             getBirthDate(
               'informantBirthDate',
               informantBirthDateConditionals.concat(
@@ -248,7 +308,12 @@
                   parameters: []
                 }
               ],
-              certificateHandlebars.informantBirthDate
+              certificateHandlebars.informantBirthDate,
+              {
+                dependsOn: ['idReader', 'esignetCallback'],
+                expression:
+                  '$form?.idReader?.birthDate || "$form?.esignetCallback?.data?.birthDate"'
+              }
             ), // Required field.
             exactDateOfBirthUnknown(hideIfInformantMotherOrFather),
             getAgeOfIndividualInYears(

src/form/common/common-required-fields.ts

@@ -20,14 +20,15 @@ export const getBirthDate = (
   fieldName: string,
   conditionals: Conditional[],
   validator: any[],
-  certificateHandlebar: string
+  certificateHandlebar: string,
+  initialValue: string | { dependsOn: string[]; expression: string } = ''
 ): SerializedFormField => ({
   name: fieldName, // A field with this name MUST exist
   type: 'DATE',
   label: formMessageDescriptors.dateOfBirth,
   required: true,
   conditionals,
-  initialValue: '',
+  initialValue,
   validator,
   mapping: getFieldMapping('birthDate', certificateHandlebar)
 })
@@ -48,7 +49,8 @@ export const getGender = (certificateHandlebar: string) =>
 export const getFamilyNameField = (
   previewGroup: string,
   conditionals: Conditional[],
-  certificateHandlebar: string
+  certificateHandlebar: string,
+  initialValue: string | { dependsOn: string[]; expression: string } = ''
 ) =>
   ({
     name: 'familyNameEng', // A field with this name MUST exist
@@ -58,7 +60,7 @@ export const getFamilyNameField = (
     label: formMessageDescriptors.familyName,
     maxLength: 32,
     required: true,
-    initialValue: '',
+    initialValue,
     validator: [
       {
         operation: 'englishOnlyNameFormat'
@@ -70,7 +72,8 @@ export const getFamilyNameField = (
 export const getFirstNameField = (
   previewGroup: string,
   conditionals: Conditional[],
-  certificateHandlebar: string
+  certificateHandlebar: string,
+  initialValue: string | { dependsOn: string[]; expression: string } = ''
 ) =>
   ({
     name: 'firstNamesEng', // A field with this name MUST exist
@@ -84,7 +87,7 @@ export const getFirstNameField = (
     conditionals,
     maxLength: 32,
     required: true,
-    initialValue: '',
+    initialValue,
     validator: [
       {
         operation: 'englishOnlyNameFormat'

src/form/types/types.ts

@@ -115,6 +115,7 @@
 export const NUMBER = 'NUMBER'
 export const BIG_NUMBER = 'BIG_NUMBER'
 export const RADIO_GROUP = 'RADIO_GROUP'
+export const HIDDEN = 'HIDDEN'
 export const INFORMATIVE_RADIO_GROUP = 'INFORMATIVE_RADIO_GROUP'
 export const CHECKBOX_GROUP = 'CHECKBOX_GROUP'
 export const CHECKBOX = 'CHECKBOX'
@@ -142,6 +143,11 @@
 export const DIVIDER = 'DIVIDER'
 export const HEADING3 = 'HEADING3'
 export const SIGNATURE = 'SIGNATURE'
+export const HIDDEN = 'HIDDEN'
+export const LINK_BUTTON = 'LINK_BUTTON'
+export const ID_READER = 'ID_READER'
+export const HTTP = 'HTTP'
+export const ID_VERIFICATION_BANNER = 'ID_VERIFICATION_BANNER'
 
 export enum RadioSize {
   LARGE = 'large',
@@ -491,6 +497,54 @@
   )[]
 }
 
+export interface IHiddenFormField extends IFormFieldBase {
+  type: typeof HIDDEN
+}
+
+export interface IHttpFormField extends IFormFieldBase {
+  type: typeof HTTP
+  options: {
+    url: string
+    method?: string
+    headers: Record<string, string>
+    body?: Record<string, any>
+    params?: Record<string, any>
+  }
+}
+
+export interface ILinkButtonFormField extends IFormFieldBase {
+  type: typeof LINK_BUTTON
+  icon?: {
+    desktop: string
+    mobile: string
+  }
+  options: {
+    url: string
+    callback: {
+      trigger: string
+      params: Record<string, string>
+    }
+  }
+}
+
+export interface QRReaderType {
+  type: 'QR'
+}
+
+type ReaderType = QRReaderType | ILinkButtonFormField
+export interface IIDReaderFormField extends IFormFieldBase {
+  type: typeof ID_READER
+  dividerLabel: MessageDescriptor
+  manualInputInstructionLabel: MessageDescriptor
+  readers: [ReaderType, ...ReaderType[]]
+}
+
+export type BannerType = 'pending' | 'verified' | 'failed'
+export interface IIDVerificationBannerFormField extends IFormFieldBase {
+  type: typeof ID_VERIFICATION_BANNER
+  bannerType: BannerType
+  idFieldName: string
+}
 export type IFormField =
   | ITextFormField
   | ITelFormField
@@ -524,6 +578,11 @@
   | IDividerField
   | IHeading3Field
   | ISignatureFormField
+  | IHiddenFormField
+  | IIDReaderFormField
+  | ILinkButtonFormField
+  | IHttpFormField
+  | IIDVerificationBannerFormField
 
 export interface SelectComponentOption {
   value: string
@@ -739,6 +798,10 @@
   mapping?: IFormFieldMapping
 }
 
+interface IHiddenFormField extends IFormFieldBase {
+  type: typeof HIDDEN
+}
+
 export type IFormSectionQueryMapFunction = (
   transFormedData: IFormData,
   queryData: any,