@opencrvs/mosip 1.7.0-alpha.21 → 1.7.0-alpha.23

package/build/forms.d.ts

@@ -142,8 +142,9 @@ interface ESignetConfig {
         fieldName: string;
         mosipAPIUserInfoUrl: string;
     };
+    loaderFieldName?: string;
 }
-export declare const verified: (event: string, sectionId: string, mapping: any) => {
+export declare const verified: (event: string, sectionId: string, mapping: any, esignetConfig?: ESignetConfig) => {
     name: string;
     fieldId: string;
     customQuestionMappingId: string;
@@ -160,13 +161,14 @@ export declare const verified: (event: string, sectionId: string, mapping: any)
     validator: never[];
     mapping: any;
 };
-export declare const idVerificationBanner: (event: string, sectionId: string, status: "verified" | "failed" | "authenticated") => {
+type VerificationStatus = "verified" | "failed" | "authenticated";
+export declare const idVerificationBanner: (event: string, sectionId: string, status: VerificationStatus) => {
     name: string;
     type: string;
     fieldId: string;
     hideInPreview: boolean;
     custom: boolean;
-    bannerType: "verified" | "failed" | "authenticated";
+    bannerType: VerificationStatus;
     idFieldName: string;
     label: {
         id: string;
@@ -178,12 +180,36 @@ export declare const idVerificationBanner: (event: string, sectionId: string, st
         expression: string;
     }[];
 };
+export declare function esignetLoaderField({ event, section, fieldName, esignetCallbackFieldName, }: {
+    event: "birth" | "death";
+    section: "informant" | "mother" | "father" | "spouse" | "deceased";
+    fieldName: string;
+    esignetCallbackFieldName: string;
+}): {
+    name: string;
+    type: string;
+    fieldId: string;
+    hideInPreview: boolean;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    loadingText: {
+        id: string;
+        defaultMessage: string;
+    };
+    conditionals: {
+        action: string;
+        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) => ({
+export declare const idReaderFields: (event: "birth" | "death", section: "informant" | "mother" | "father" | "spouse" | "deceased", qrConfig: QRConfig, esignetConfig: ESignetConfig | undefined, verifiedCustomFieldMapping: any, conditionals?: any[]) => any[];
+export declare const idVerificationFields: (event: string, sectionId: string, mapping: any, esignetConfig?: ESignetConfig) => ({
     name: string;
     fieldId: string;
     customQuestionMappingId: string;
@@ -205,7 +231,7 @@ export declare const idVerificationFields: (event: string, sectionId: string, ma
     fieldId: string;
     hideInPreview: boolean;
     custom: boolean;
-    bannerType: "verified" | "failed" | "authenticated";
+    bannerType: VerificationStatus;
     idFieldName: string;
     label: {
         id: string;

package/build/forms.js

@@ -1,7 +1,4 @@
 "use strict";
-// @TODO: Yet to be implemented! Placeholders for NPM publish.
-Object.defineProperty(exports, "__esModule", { value: true });
-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
@@ -12,6 +9,9 @@ exports.idVerificationFields = exports.idReaderFields = exports.getInitialValueF
  * ]
  * ```
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.idVerificationFields = exports.idReaderFields = exports.getInitialValueFromIDReader = exports.idVerificationBanner = exports.verified = exports.qr = exports.idReader = exports.esignetHidden = exports.esignetCallback = exports.popupButton = exports.esignet = void 0;
+exports.esignetLoaderField = esignetLoaderField;
 /**
  *
  * @description E-Signet REDIRECT button form definition.  Calls E-Signet /authorize (this field may not be supported in the latest release of OpenCRVS yet)
@@ -147,7 +147,7 @@ const qr = ({ validation }) => ({
     validation,
 });
 exports.qr = qr;
-const verified = (event, sectionId, mapping) => {
+const verified = (event, sectionId, mapping, esignetConfig) => {
     const fieldName = "verified";
     const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
     return {
@@ -160,10 +160,15 @@ const verified = (event, sectionId, mapping) => {
             id: "form.field.label.empty",
             defaultMessage: "",
         },
-        initialValue: {
-            dependsOn: ["idReader"],
-            expression: 'Boolean($form?.idReader)? "pending":""',
-        },
+        initialValue: esignetConfig
+            ? {
+                dependsOn: ["idReader", esignetConfig.callback.fieldName],
+                expression: `Boolean($form?.idReader)? "pending": Boolean($form?.${esignetConfig.callback.fieldName}?.data)? "authenticated": ""`,
+            }
+            : {
+                dependsOn: ["idReader"],
+                expression: 'Boolean($form?.idReader)? "pending":""',
+            },
         validator: [],
         mapping,
     };
@@ -197,6 +202,30 @@ const idVerificationBanner = (event, sectionId, status) => {
     };
 };
 exports.idVerificationBanner = idVerificationBanner;
+function esignetLoaderField({ event, section, fieldName, esignetCallbackFieldName, }) {
+    const fieldId = `${event}.${section}.${section}-view-group.${fieldName}`;
+    return {
+        name: fieldName,
+        type: "LOADER",
+        fieldId,
+        hideInPreview: true,
+        custom: true,
+        label: {
+            id: "form.field.label.idReader",
+            defaultMessage: "ID verification",
+        },
+        loadingText: {
+            id: "form.field.label.authenticating.nid",
+            defaultMessage: "Fetching the person's data from E-Signet",
+        },
+        conditionals: [
+            {
+                action: "hide",
+                expression: `!$form?.${esignetCallbackFieldName}?.loading`,
+            },
+        ],
+    };
+}
 const getInitialValueFromIDReader = (fieldNameInReader) => ({
     dependsOn: ["idReader", "esignetCallback"],
     expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
@@ -207,7 +236,7 @@ const idReaderFields = (event, section, qrConfig, esignetConfig, verifiedCustomF
     const fields = [
         (0, exports.idReader)(event, section, conditionals.concat({
             action: "hide",
-            expression: "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed'",
+            expression: "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed' || !!$form?.esignetCallback?.loading",
         }), readers),
     ];
     if (esignetConfig) {
@@ -217,6 +246,18 @@ const idReaderFields = (event, section, qrConfig, esignetConfig, verifiedCustomF
             mosipAPIUserInfoUrl: esignetConfig.callback.mosipAPIUserInfoUrl,
             openIdProviderClientId: esignetConfig.openIdProviderClientId,
         }));
+        if (esignetConfig.loaderFieldName) {
+            fields.push(esignetLoaderField({
+                event,
+                section,
+                fieldName: esignetConfig.loaderFieldName,
+                esignetCallbackFieldName: esignetConfig.callback.fieldName,
+            }));
+        }
+        return [
+            ...fields,
+            ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping, esignetConfig),
+        ];
     }
     return [
         ...fields,
@@ -224,9 +265,9 @@ const idReaderFields = (event, section, qrConfig, esignetConfig, verifiedCustomF
     ];
 };
 exports.idReaderFields = idReaderFields;
-const idVerificationFields = (event, sectionId, mapping) => {
+const idVerificationFields = (event, sectionId, mapping, esignetConfig) => {
     return [
-        (0, exports.verified)(event, sectionId, mapping),
+        (0, exports.verified)(event, sectionId, mapping, esignetConfig),
         (0, exports.idVerificationBanner)(event, sectionId, "verified"),
         (0, exports.idVerificationBanner)(event, sectionId, "failed"),
         (0, exports.idVerificationBanner)(event, sectionId, "authenticated"),

package/package.json

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

package/src/forms.ts

@@ -1,5 +1,3 @@
-// @TODO: Yet to be implemented! Placeholders for NPM publish.
-
 /**
  * E-Signet popup button and hidden field form definitions
  * @example
@@ -200,9 +198,15 @@ interface ESignetConfig {
     fieldName: string;
     mosipAPIUserInfoUrl: string;
   };
+  loaderFieldName?: string;
 }
 
-export const verified = (event: string, sectionId: string, mapping: any) => {
+export const verified = (
+  event: string,
+  sectionId: string,
+  mapping: any,
+  esignetConfig?: ESignetConfig,
+) => {
   const fieldName = "verified";
   const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
   return {
@@ -215,10 +219,15 @@ export const verified = (event: string, sectionId: string, mapping: any) => {
       id: "form.field.label.empty",
       defaultMessage: "",
     },
-    initialValue: {
-      dependsOn: ["idReader"],
-      expression: 'Boolean($form?.idReader)? "pending":""',
-    },
+    initialValue: esignetConfig
+      ? {
+          dependsOn: ["idReader", esignetConfig.callback.fieldName],
+          expression: `Boolean($form?.idReader)? "pending": Boolean($form?.${esignetConfig.callback.fieldName}?.data)? "authenticated": ""`,
+        }
+      : {
+          dependsOn: ["idReader"],
+          expression: 'Boolean($form?.idReader)? "pending":""',
+        },
     validator: [],
     mapping,
   };
@@ -228,10 +237,12 @@ function capitalize(str: string) {
   return str.charAt(0).toUpperCase() + str.slice(1);
 }
 
+type VerificationStatus = "verified" | "failed" | "authenticated";
+
 export const idVerificationBanner = (
   event: string,
   sectionId: string,
-  status: "verified" | "failed" | "authenticated",
+  status: VerificationStatus,
 ) => {
   const fieldName = "verified";
   const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
@@ -257,6 +268,41 @@ export const idVerificationBanner = (
   };
 };
 
+export function esignetLoaderField({
+  event,
+  section,
+  fieldName,
+  esignetCallbackFieldName,
+}: {
+  event: "birth" | "death";
+  section: "informant" | "mother" | "father" | "spouse" | "deceased";
+  fieldName: string;
+  esignetCallbackFieldName: string;
+}) {
+  const fieldId = `${event}.${section}.${section}-view-group.${fieldName}`;
+  return {
+    name: fieldName,
+    type: "LOADER",
+    fieldId,
+    hideInPreview: true,
+    custom: true,
+    label: {
+      id: "form.field.label.idReader",
+      defaultMessage: "ID verification",
+    },
+    loadingText: {
+      id: "form.field.label.authenticating.nid",
+      defaultMessage: "Fetching the person's data from E-Signet",
+    },
+    conditionals: [
+      {
+        action: "hide",
+        expression: `!$form?.${esignetCallbackFieldName}?.loading`,
+      },
+    ],
+  };
+}
+
 export const getInitialValueFromIDReader = (fieldNameInReader: string) => ({
   dependsOn: ["idReader", "esignetCallback"],
   expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
@@ -264,7 +310,7 @@ export const getInitialValueFromIDReader = (fieldNameInReader: string) => ({
 
 export const idReaderFields = (
   event: "birth" | "death",
-  section: "informant" | "mother" | "father",
+  section: "informant" | "mother" | "father" | "spouse" | "deceased",
   qrConfig: QRConfig,
   esignetConfig: ESignetConfig | undefined,
   verifiedCustomFieldMapping: any,
@@ -278,7 +324,7 @@ export const idReaderFields = (
       conditionals.concat({
         action: "hide",
         expression:
-          "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed'",
+          "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed' || !!$form?.esignetCallback?.loading",
       }),
       readers,
     ),
@@ -300,6 +346,25 @@ export const idReaderFields = (
         openIdProviderClientId: esignetConfig.openIdProviderClientId,
       }),
     );
+    if (esignetConfig.loaderFieldName) {
+      fields.push(
+        esignetLoaderField({
+          event,
+          section,
+          fieldName: esignetConfig.loaderFieldName,
+          esignetCallbackFieldName: esignetConfig.callback.fieldName,
+        }),
+      );
+    }
+    return [
+      ...fields,
+      ...idVerificationFields(
+        event,
+        section,
+        verifiedCustomFieldMapping,
+        esignetConfig,
+      ),
+    ];
   }
   return [
     ...fields,
@@ -310,9 +375,10 @@ export const idVerificationFields = (
   event: string,
   sectionId: string,
   mapping: any,
+  esignetConfig?: ESignetConfig,
 ) => {
   return [
-    verified(event, sectionId, mapping),
+    verified(event, sectionId, mapping, esignetConfig),
     idVerificationBanner(event, sectionId, "verified"),
     idVerificationBanner(event, sectionId, "failed"),
     idVerificationBanner(event, sectionId, "authenticated"),