@opencrvs/mosip 1.7.0-alpha.16 → 1.7.0-alpha.18

package/build/forms.d.ts

@@ -110,6 +110,11 @@ export declare const idReader: (event: string, sectionId: string, conditionals:
         id: string;
         defaultMessage: string;
     };
+    mapping: {
+        mutation: {
+            operation: string;
+        };
+    };
     readers: any[];
 };
 type MessageDescriptor = {
@@ -117,18 +122,27 @@ type MessageDescriptor = {
     defaultMessage: string;
     description?: string;
 };
-export declare const qr: ({ validation, }: {
-    validation: {
-        rule: Record<string, unknown>;
-        errorMessage: MessageDescriptor;
-    };
-}) => {
+interface QRValidation {
+    rule: Record<string, unknown>;
+    errorMessage: MessageDescriptor;
+}
+interface QRConfig {
+    validation: QRValidation;
+}
+export declare const qr: ({ validation }: QRConfig) => {
     type: string;
-    validation: {
-        rule: Record<string, unknown>;
-        errorMessage: MessageDescriptor;
-    };
+    validation: QRValidation;
 };
+interface ESignetConfig {
+    esignetAuthUrl: string;
+    openIdProviderClientId: string;
+    openIdProviderClaims: string | undefined;
+    fieldName: string;
+    callback: {
+        fieldName: string;
+        mosipAPIUserInfoUrl: string;
+    };
+}
 export declare const verified: (event: string, sectionId: string, mapping: any) => {
     name: string;
     fieldId: string;
@@ -146,13 +160,13 @@ export declare const verified: (event: string, sectionId: string, mapping: any)
     validator: never[];
     mapping: any;
 };
-export declare const idVerificationBanner: (event: string, sectionId: string, status: "pending" | "verified" | "failed") => {
+export declare const idVerificationBanner: (event: string, sectionId: string, status: "verified" | "failed" | "authenticated") => {
     name: string;
     type: string;
     fieldId: string;
     hideInPreview: boolean;
     custom: boolean;
-    bannerType: "pending" | "verified" | "failed";
+    bannerType: "verified" | "failed" | "authenticated";
     idFieldName: string;
     label: {
         id: string;
@@ -164,6 +178,11 @@ export declare const idVerificationBanner: (event: string, sectionId: string, st
         expression: string;
     }[];
 };
+export declare const getInitialValueFromIDReader: (fieldNameInReader: string) => {
+    dependsOn: string[];
+    expression: string;
+};
+export declare const idReaderFields: (event: "birth" | "death", section: "informant" | "mother" | "father", qrConfig: QRConfig, esignetConfig: ESignetConfig | undefined, verifiedCustomFieldMapping: any, conditionals?: any[]) => any[];
 export declare const idVerificationFields: (event: string, sectionId: string, mapping: any) => ({
     name: string;
     fieldId: string;
@@ -186,7 +205,7 @@ export declare const idVerificationFields: (event: string, sectionId: string, ma
     fieldId: string;
     hideInPreview: boolean;
     custom: boolean;
-    bannerType: "pending" | "verified" | "failed";
+    bannerType: "verified" | "failed" | "authenticated";
     idFieldName: string;
     label: {
         id: string;

package/build/forms.js

@@ -1,7 +1,7 @@
 "use strict";
 // @TODO: Yet to be implemented! Placeholders for NPM publish.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.idVerificationFields = exports.idVerificationBanner = exports.verified = exports.qr = exports.idReader = exports.esignetHidden = exports.esignetCallback = exports.popupButton = exports.esignet = void 0;
+exports.idVerificationFields = exports.idReaderFields = exports.getInitialValueFromIDReader = exports.idVerificationBanner = exports.verified = exports.qr = exports.idReader = exports.esignetHidden = exports.esignetCallback = exports.popupButton = exports.esignet = void 0;
 /**
  * E-Signet popup button and hidden field form definitions
  * @example
@@ -118,8 +118,8 @@ const idReader = (event, sectionId, conditionals, readers) => {
         required: false,
         type: "ID_READER",
         label: {
-            id: "form.field.label.empty",
-            defaultMessage: "",
+            id: "form.field.label.idReader",
+            defaultMessage: "ID verification",
         },
         hideInPreview: true,
         initialValue: "",
@@ -133,11 +133,16 @@ const idReader = (event, sectionId, conditionals, readers) => {
             id: "views.idReader.label.manualInput",
             defaultMessage: "Complete fields below",
         },
+        mapping: {
+            mutation: {
+                operation: "ignoreFieldTransformer",
+            },
+        },
         readers,
     };
 };
 exports.idReader = idReader;
-const qr = ({ validation, }) => ({
+const qr = ({ validation }) => ({
     type: "QR",
     validation,
 });
@@ -160,7 +165,7 @@ const verified = (event, sectionId, mapping) => {
             expression: 'Boolean($form?.idReader)? "pending":""',
         },
         validator: [],
-        mapping
+        mapping,
     };
 };
 exports.verified = verified;
@@ -192,12 +197,39 @@ const idVerificationBanner = (event, sectionId, status) => {
     };
 };
 exports.idVerificationBanner = idVerificationBanner;
+const getInitialValueFromIDReader = (fieldNameInReader) => ({
+    dependsOn: ["idReader", "esignetCallback"],
+    expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
+});
+exports.getInitialValueFromIDReader = getInitialValueFromIDReader;
+const idReaderFields = (event, section, qrConfig, esignetConfig, verifiedCustomFieldMapping, conditionals = []) => {
+    const readers = [(0, exports.qr)(qrConfig)];
+    const fields = [
+        (0, exports.idReader)(event, section, conditionals.concat({
+            action: "hide",
+            expression: "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed'",
+        }), readers),
+    ];
+    if (esignetConfig) {
+        readers.push((0, exports.esignet)(esignetConfig.esignetAuthUrl, esignetConfig.openIdProviderClientId, esignetConfig.openIdProviderClaims, esignetConfig.fieldName, esignetConfig.callback.fieldName));
+        fields.push((0, exports.esignetCallback)({
+            fieldName: esignetConfig.callback.fieldName,
+            mosipAPIUserInfoUrl: esignetConfig.callback.mosipAPIUserInfoUrl,
+            openIdProviderClientId: esignetConfig.openIdProviderClientId,
+        }));
+    }
+    return [
+        ...fields,
+        ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping),
+    ];
+};
+exports.idReaderFields = idReaderFields;
 const idVerificationFields = (event, sectionId, mapping) => {
     return [
         (0, exports.verified)(event, sectionId, mapping),
-        (0, exports.idVerificationBanner)(event, sectionId, "pending"),
         (0, exports.idVerificationBanner)(event, sectionId, "verified"),
         (0, exports.idVerificationBanner)(event, sectionId, "failed"),
+        (0, exports.idVerificationBanner)(event, sectionId, "authenticated"),
     ];
 };
 exports.idVerificationFields = idVerificationFields;

package/package.json

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

package/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"),
   ];
 };