feat: contryconfig function for all id-reader fields (#48)

* feat: provide alternative where all id reader fields come from a single function output

* chore: bump package version

* chore: update verification statuses

* chore: update id reader label

* chore: update verified logic to checking on stubbed ids

* chore: update logic so that if the id is not found in the stubbed valid ids, set verified status failed

* chore: update mapping of id reader field

Author: tahmidrahman-dsi

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.7.0-alpha.16",
+  "version": "1.7.0-alpha.17",
   "license": "MPL-2.0",
   "private": true,
   "packageManager": "yarn@1.22.13",

packages/country-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.7.0-alpha.16",
+  "version": "1.7.0-alpha.17",
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {

packages/country-config/src/forms.ts

@@ -147,8 +147,8 @@ export const idReader = (
     required: false,
     type: "ID_READER",
     label: {
-      id: "form.field.label.empty",
-      defaultMessage: "",
+      id: "form.field.label.idReader",
+      defaultMessage: "ID verification",
     },
     hideInPreview: true,
     initialValue: "",
@@ -162,6 +162,11 @@ export const idReader = (
       id: "views.idReader.label.manualInput",
       defaultMessage: "Complete fields below",
     },
+    mapping: {
+      mutation: {
+        operation: "ignoreFieldTransformer",
+      },
+    },
     readers,
   };
 };
@@ -172,18 +177,31 @@ type MessageDescriptor = {
   description?: string;
 };
 
-export const qr = ({
-  validation,
-}: {
-  validation: {
-    rule: Record<string, unknown>;
-    errorMessage: MessageDescriptor;
-  };
-}) => ({
+interface QRValidation {
+  rule: Record<string, unknown>;
+  errorMessage: MessageDescriptor;
+}
+
+interface QRConfig {
+  validation: QRValidation;
+}
+
+export const qr = ({ validation }: QRConfig) => ({
   type: "QR",
   validation,
 });
 
+interface ESignetConfig {
+  esignetAuthUrl: string;
+  openIdProviderClientId: string;
+  openIdProviderClaims: string | undefined;
+  fieldName: string;
+  callback: {
+    fieldName: string;
+    mosipAPIUserInfoUrl: string;
+  };
+}
+
 export const verified = (event: string, sectionId: string, mapping: any) => {
   const fieldName = "verified";
   const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
@@ -202,7 +220,7 @@ export const verified = (event: string, sectionId: string, mapping: any) => {
       expression: 'Boolean($form?.idReader)? "pending":""',
     },
     validator: [],
-    mapping
+    mapping,
   };
 };
 
@@ -213,7 +231,7 @@ function capitalize(str: string) {
 export const idVerificationBanner = (
   event: string,
   sectionId: string,
-  status: "pending" | "verified" | "failed",
+  status: "verified" | "failed" | "authenticated",
 ) => {
   const fieldName = "verified";
   const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
@@ -239,11 +257,64 @@ export const idVerificationBanner = (
   };
 };
 
-export const idVerificationFields = (event: string, sectionId: string, mapping: any) => {
+export const getInitialValueFromIDReader = (fieldNameInReader: string) => ({
+  dependsOn: ["idReader", "esignetCallback"],
+  expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
+});
+
+export const idReaderFields = (
+  event: "birth" | "death",
+  section: "informant" | "mother" | "father",
+  qrConfig: QRConfig,
+  esignetConfig: ESignetConfig | undefined,
+  verifiedCustomFieldMapping: any,
+  conditionals: any[] = [],
+) => {
+  const readers: any[] = [qr(qrConfig)];
+  const fields: any[] = [
+    idReader(
+      event,
+      section,
+      conditionals.concat({
+        action: "hide",
+        expression:
+          "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed'",
+      }),
+      readers,
+    ),
+  ];
+  if (esignetConfig) {
+    readers.push(
+      esignet(
+        esignetConfig.esignetAuthUrl,
+        esignetConfig.openIdProviderClientId,
+        esignetConfig.openIdProviderClaims,
+        esignetConfig.fieldName,
+        esignetConfig.callback.fieldName,
+      ),
+    );
+    fields.push(
+      esignetCallback({
+        fieldName: esignetConfig.callback.fieldName,
+        mosipAPIUserInfoUrl: esignetConfig.callback.mosipAPIUserInfoUrl,
+        openIdProviderClientId: esignetConfig.openIdProviderClientId,
+      }),
+    );
+  }
+  return [
+    ...fields,
+    ...idVerificationFields(event, section, verifiedCustomFieldMapping),
+  ];
+};
+export const idVerificationFields = (
+  event: string,
+  sectionId: string,
+  mapping: any,
+) => {
   return [
     verified(event, sectionId, mapping),
-    idVerificationBanner(event, sectionId, "pending"),
     idVerificationBanner(event, sectionId, "verified"),
     idVerificationBanner(event, sectionId, "failed"),
+    idVerificationBanner(event, sectionId, "authenticated"),
   ];
 };

packages/esignet-mock/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opencrvs/esignet-mock",
   "license": "MPL-2.0",
-  "version": "1.7.0-alpha.16",
+  "version": "1.7.0-alpha.17",
   "main": "index.js",
   "scripts": {
     "dev": "NODE_ENV=development tsx watch src/index.ts",

packages/mosip-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/mosip-api",
-  "version": "1.7.0-alpha.16",
+  "version": "1.7.0-alpha.17",
   "license": "MPL-2.0",
   "scripts": {
     "dev": "NODE_ENV=development tsx watch src/index.ts",

packages/mosip-api/src/routes/event-review.ts

@@ -1,16 +1,32 @@
 import { FastifyRequest, FastifyReply } from "fastify";
-import { getComposition, getInformantType } from "../types/fhir";
+import {
+  getComposition,
+  getInformantNationalId,
+  getInformantType,
+} from "../types/fhir";
 import { updateField } from "../opencrvs-api";
 
 type OpenCRVSRequest = FastifyRequest<{
   Body: fhir3.Bundle;
 }>;
 
+const stubValidNIDs = [
+  "1234567890",
+  "1210563847",
+  "1223948576",
+  "1238475062",
+  "1249583720",
+  "1256074839",
+  "1263849205",
+  "1275093846",
+  "1283749502",
+  "1295067384",
+];
 export const reviewEventHandler = async (
   request: OpenCRVSRequest,
   reply: FastifyReply,
 ) => {
-  const informantType = getInformantType(request.body);
+  const informantNationalID = getInformantNationalId(request.body);
   const { id: eventId } = getComposition(request.body);
 
   if (!request.headers.authorization) {
@@ -25,13 +41,20 @@ export const reviewEventHandler = async (
   }
 
   // Initial test of the verification, we will verify only other informants than mother and father
-  if (informantType !== "mother" && informantType !== "father") {
+  if (stubValidNIDs.includes(informantNationalID)) {
     await updateField(
       eventId,
       `birth.informant.informant-view-group.verified`,
       'verified',
       { headers: { Authorization: `Bearer ${token}` } },
     );
+  } else {
+    await updateField(
+      eventId,
+      `birth.informant.informant-view-group.verified`,
+      'failed',
+      { headers: { Authorization: `Bearer ${token}` } },
+    );
   }
 
   return reply.code(200).send({ success: true });

packages/mosip-api/src/types/fhir.ts

@@ -560,3 +560,24 @@ export function getInformantType(record: fhir3.Bundle) {
   return (personEntry?.resource as fhir3.RelatedPerson).relationship
     ?.coding?.[0].code;
 }
+
+function getInformantPatient(record: fhir3.Bundle) {
+  const compositionSection = findCompositionSection(
+    "informant-details",
+    getComposition(record),
+  );
+  if (!compositionSection) return undefined;
+  const personSectionEntry = compositionSection.entry![0];
+  const relatedPersonEntry = findEntryFromBundle(
+    record,
+    personSectionEntry.reference,
+  );
+  const reference = (relatedPersonEntry?.resource as fhir3.RelatedPerson)
+    .patient.reference;
+  return getFromBundleById(record, reference!.split("/")[1]).resource;
+}
+
+export function getInformantNationalId(record: fhir3.Bundle) {
+  const informantPatient = getInformantPatient(record);
+  return getPatientNationalId(informantPatient as fhir3.Patient);
+}

packages/mosip-mock/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/mosip-mock",
-  "version": "1.7.0-alpha.16",
+  "version": "1.7.0-alpha.17",
   "license": "MPL-2.0",
   "scripts": {
     "dev": "NODE_ENV=development tsx watch src/index.ts",