@opencrvs/mosip 1.7.0-alpha.9 → 1.8.0-beta.1

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.idPendingVerificationBanner = 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,184 +9,279 @@ exports.idVerificationFields = exports.idPendingVerificationBanner = exports.ver
  * ]
  * ```
  */
+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)
  *
  */
-const esignet = (event, sectionId, esignetAuthUrl, openIdProviderClientId, openIdProviderClaims = 'name,family_name,given_name,middle_name,birthdate,address', fieldName, callbackFieldName) => {
+const esignet = (esignetAuthUrl, openIdProviderClientId, openIdProviderClaims = "name,family_name,given_name,middle_name,birthdate,address", fieldName, callbackFieldName) => {
     const url = new URL(esignetAuthUrl);
-    url.searchParams.append('client_id', openIdProviderClientId || 'mock-client_id');
-    url.searchParams.append('response_type', 'code');
-    url.searchParams.append('scope', 'openid profile');
-    url.searchParams.append('acr_values', 'mosip:idp:acr:static-code');
-    url.searchParams.append('claims', openIdProviderClaims);
-    url.searchParams.append('state', 'fetch-on-mount');
-    url.searchParams.append('redirect_uri', '${window.location.origin}/drafts/${window.location.pathname.split("/")[2]}/events/${event}/${sectionId}/group/${sectionId}');
+    url.searchParams.append("client_id", openIdProviderClientId || "mock-client_id");
+    url.searchParams.append("response_type", "code");
+    url.searchParams.append("scope", "openid profile");
+    url.searchParams.append("acr_values", "mosip:idp:acr:static-code");
+    url.searchParams.append("claims", openIdProviderClaims);
+    url.searchParams.append("state", "fetch-on-mount");
+    url.searchParams.append("redirect_uri", "${window.location.href}");
     return {
         name: fieldName,
         validator: [],
         icon: {
-            desktop: 'Globe',
-            mobile: 'Fingerprint'
+            desktop: "Globe",
+            mobile: "Fingerprint",
         },
-        type: 'LINK_BUTTON',
+        type: "LINK_BUTTON",
         custom: true,
         label: {
-            id: 'views.idReader.label.eSignet',
-            defaultMessage: 'E-signet'
+            id: "views.idReader.label.eSignet",
+            defaultMessage: "E-signet",
         },
         hideInPreview: true,
         conditionals: [
             {
-                action: 'disable',
-                expression: '!!$form.redirectCallbackFetch'
-            }
+                action: "disable",
+                expression: "!!$form.redirectCallbackFetch",
+            },
         ],
+        mapping: {
+            mutation: {
+                operation: "ignoreFieldTransformer",
+            },
+        },
         options: {
             url: url.toString(),
             callback: {
                 params: {
-                    state: 'fetch-on-mount'
+                    state: "fetch-on-mount",
                 },
-                trigger: callbackFieldName
-            }
-        }
+                trigger: callbackFieldName,
+            },
+        },
     };
 };
 exports.esignet = esignet;
 const popupButton = ({ 
 /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
-url }) => {
+url, }) => {
     return {
-        name: 'INFORMANT_AUTHENTICATION_POPUP_BUTTON',
-        type: 'POPUP_BUTTON',
-        url
+        name: "INFORMANT_AUTHENTICATION_POPUP_BUTTON",
+        type: "POPUP_BUTTON",
+        url,
     };
 };
 exports.popupButton = popupButton;
 /**
  *
- * @description esignet callback button form definition.  Calls mosip-api/esignet-api /esignet/get-oidp-user-info (this field may not be supported in the latest release of OpenCRVS yet)
+ * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
  *
  */
-const esignetCallback = ({ fieldName, event, sectionId, getOIDPUserInfoUrl, openIdProviderClientId }) => ({
+const esignetCallback = ({ fieldName, mosipAPIUserInfoUrl, openIdProviderClientId, }) => ({
     name: fieldName,
-    type: 'HTTP',
+    type: "HTTP",
     custom: true,
     label: {
-        id: 'form.field.label.empty',
-        defaultMessage: ''
+        id: "form.field.label.empty",
+        defaultMessage: "",
     },
     validator: [],
+    hideInPreview: true,
+    mapping: {
+        mutation: {
+            operation: "ignoreFieldTransformer",
+        },
+    },
     options: {
-        getOIDPUserInfoUrl,
+        url: mosipAPIUserInfoUrl,
         headers: {
-            'Content-type': 'application/json'
+            "Content-type": "application/json",
         },
         body: {
             clientId: openIdProviderClientId,
-            redirectUri: '${window.location.origin}/drafts/${window.location.pathname.split("/")[2]}/events/${event}/${sectionId}/group/${sectionId}'
+            redirectUri: "${window.location.href}",
         },
-        method: 'POST'
-    }
+        method: "POST",
+    },
 });
 exports.esignetCallback = esignetCallback;
 const esignetHidden = () => {
     return {
-        name: 'INFORMANT_PSUT_TOKEN',
-        type: 'HIDDEN'
+        name: "INFORMANT_PSUT_TOKEN",
+        type: "HIDDEN",
     };
 };
 exports.esignetHidden = esignetHidden;
-/**
- *
- * @description QR reader type definition (this field may not be supported in the latest release of OpenCRVS yet)
- *
- */
 const idReader = (event, sectionId, conditionals, readers) => {
-    const fieldName = 'idReader';
+    const fieldName = "idReader";
     const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
     return {
         name: fieldName,
         customQuestionMappingId: fieldId,
         custom: true,
         required: false,
-        type: 'ID_READER',
+        type: "ID_READER",
         label: {
-            id: 'form.field.label.empty',
-            defaultMessage: ''
+            id: "form.field.label.idReader",
+            defaultMessage: "ID verification",
         },
         hideInPreview: true,
-        initialValue: '',
+        initialValue: "",
         validator: [],
         conditionals,
         dividerLabel: {
-            id: 'views.idReader.label.or',
-            defaultMessage: 'Or'
+            id: "views.idReader.label.or",
+            defaultMessage: "Or",
         },
         manualInputInstructionLabel: {
-            id: 'views.idReader.label.manualInput',
-            defaultMessage: 'Complete fields below'
+            id: "views.idReader.label.manualInput",
+            defaultMessage: "Complete fields below",
         },
-        readers
+        mapping: {
+            mutation: {
+                operation: "ignoreFieldTransformer",
+            },
+        },
+        readers,
     };
 };
 exports.idReader = idReader;
-const qr = () => ({
-    type: 'QR'
+const qr = ({ validation }) => ({
+    type: "QR",
+    validation,
 });
 exports.qr = qr;
-const verified = (event, sectionId) => {
-    const fieldName = 'verified';
+const verified = (event, sectionId, mapping, esignetConfig) => {
+    const fieldName = "verified";
     const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
     return {
-        name: 'verified',
+        name: "verified",
         fieldId,
         customQuestionMappingId: fieldId,
-        type: 'HIDDEN',
+        type: "HIDDEN",
         custom: true,
         label: {
-            id: 'messages.empty',
-            defaultMessage: ''
-        },
-        initialValue: {
-            dependsOn: ['idReader'],
-            expression: 'Boolean($form?.idReader)? "pending":""'
+            id: "form.field.label.empty",
+            defaultMessage: "",
         },
-        validator: []
+        initialValue: esignetConfig
+            ? {
+                dependsOn: ["idReader", esignetConfig.callback.fieldName],
+                expression: `Boolean($form?.idReader)? "pending"
+          : Boolean($form?.${esignetConfig.callback.fieldName}?.data)? "authenticated"
+          : Boolean($form?.${esignetConfig.callback.fieldName}?.error)? "failedFetchIdDetails"
+          : ""`,
+            }
+            : {
+                dependsOn: ["idReader"],
+                expression: 'Boolean($form?.idReader)? "pending":""',
+            },
+        validator: [],
+        mapping,
     };
 };
 exports.verified = verified;
-const idPendingVerificationBanner = (event, sectionId) => {
-    const fieldName = 'verified';
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+const idVerificationBanner = (event, sectionId, status, conditionals = []) => {
+    const fieldName = "verified";
     const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
     return {
-        name: 'idPending',
-        type: 'ID_VERIFICATION_BANNER',
+        name: `id${capitalize(status)}.`,
+        type: "ID_VERIFICATION_BANNER",
         fieldId,
         hideInPreview: true,
         custom: true,
-        bannerType: 'pending',
-        idFieldName: 'idReader',
+        bannerType: status,
+        idFieldName: status === "authenticated" || "failedFetchIdDetails"
+            ? "esignetCallback"
+            : "idReader",
         label: {
-            id: 'messages.empty',
-            defaultMessage: ''
+            id: "form.field.label.empty",
+            defaultMessage: "",
         },
         validator: [],
+        conditionals: conditionals.concat([
+            {
+                action: "hide",
+                expression: `$form?.verified !== "${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?.verified !== "pending"'
-            }
-        ]
+                action: "hide",
+                expression: `!$form?.${esignetCallbackFieldName}?.loading`,
+            },
+        ],
     };
+}
+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' || $form?.verified === 'failedFetchIdDetails' || !!$form?.esignetCallback?.loading",
+        }), 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,
+        }));
+        if (esignetConfig.loaderFieldName) {
+            fields.push(esignetLoaderField({
+                event,
+                section,
+                fieldName: esignetConfig.loaderFieldName,
+                esignetCallbackFieldName: esignetConfig.callback.fieldName,
+            }));
+        }
+        return [
+            ...fields,
+            ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping, conditionals, esignetConfig),
+        ];
+    }
+    return [
+        ...fields,
+        ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping, conditionals),
+    ];
 };
-exports.idPendingVerificationBanner = idPendingVerificationBanner;
-const idVerificationFields = (event, sectionId) => {
+exports.idReaderFields = idReaderFields;
+const idVerificationFields = (event, sectionId, mapping, conditionals = [], esignetConfig) => {
     return [
-        (0, exports.verified)(event, sectionId),
-        (0, exports.idPendingVerificationBanner)(event, sectionId)
+        (0, exports.verified)(event, sectionId, mapping, esignetConfig),
+        (0, exports.idVerificationBanner)(event, sectionId, "verified", conditionals),
+        (0, exports.idVerificationBanner)(event, sectionId, "failed", conditionals),
+        (0, exports.idVerificationBanner)(event, sectionId, "authenticated", conditionals),
+        (0, exports.idVerificationBanner)(event, sectionId, "failedFetchIdDetails", conditionals),
     ];
 };
 exports.idVerificationFields = idVerificationFields;

package/build/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./forms";
 export * from "./events";
+export * from "./transform";

package/build/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./forms"), exports);
 __exportStar(require("./events"), exports);
+__exportStar(require("./transform"), exports);

package/build/transform.d.ts

@@ -0,0 +1,69 @@
+type IdentityInfo = {
+    value: string;
+    language: string;
+};
+export interface MOSIPPayload {
+    compositionId: string;
+    trackingId: string;
+    notification: {
+        recipientFullName: string;
+        recipientEmail: string;
+        recipientPhone: string;
+    };
+    requestFields: {
+        fullName: string;
+        dateOfBirth: string;
+        gender: string;
+        guardianOrParentName: string;
+        nationalIdNumber: string;
+        passportNumber: string;
+        drivingLicenseNumber: string;
+        deceasedStatus: boolean;
+        residenceStatus: string;
+        vid: string;
+        email: string;
+        phone: string;
+        guardianOrParentBirthCertificateNumber: string;
+        birthCertificateNumber: string;
+        addressLine1: string;
+        addressLine2: string;
+        addressLine3: string;
+        district: string;
+        village: string;
+        birthRegistrationCertificate: string;
+        passportId: string;
+        nationalId: string;
+        drivingLicenseId: string;
+        addressProof: string;
+        selectedHandles: string;
+        UIN: string;
+        deathDeclared: string;
+        dateOfDeath: string;
+    };
+    audit: {
+        uuid: string;
+        createdAt: string;
+        eventId: string;
+        eventName: string;
+        eventType: string;
+        hostName: string;
+        hostIp: string;
+        applicationId: string;
+        applicationName: string;
+        sessionUserId: string;
+        sessionUserName: string;
+        id: string;
+        idType: string;
+        createdBy: string;
+        moduleName: string;
+        moduleId: string;
+        description: string;
+        actionTimeStamp: string;
+    };
+}
+type Resolver<T> = (bundle: fhir3.Bundle) => T;
+type ResolverMap<T> = {
+    [K in keyof T]?: T[K] extends IdentityInfo[] | string | boolean | number ? Resolver<T[K]> : ResolverMap<T[K]>;
+};
+export declare function fhirBundleToMOSIPPayload(bundle: fhir3.Bundle, resolverMap: ResolverMap<MOSIPPayload>): MOSIPPayload;
+export {};

package/build/transform.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fhirBundleToMOSIPPayload = fhirBundleToMOSIPPayload;
+function fhirBundleToMOSIPPayload(bundle, resolverMap) {
+    const assignResolvers = (resolvers) => {
+        const result = {};
+        for (const key in resolvers) {
+            const resolver = resolvers[key];
+            if (typeof resolver === "function") {
+                result[key] = resolver(bundle);
+            }
+            else if (resolver && typeof resolver === "object") {
+                result[key] = assignResolvers(resolver);
+            }
+        }
+        return result;
+    };
+    return assignResolvers(resolverMap);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.7.0-alpha.9",
+  "version": "1.8.0-beta.1",
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {
@@ -16,9 +16,10 @@
   "devDependencies": {
     "@types/hapi__hapi": "^20.0.0",
     "@types/node-fetch": "^2.6.11",
+    "node-fetch": "2.6.7",
     "typescript": "^5.6.3"
   },
   "peerDependencies": {
-    "node-fetch": "^3.3.2"
+    "node-fetch": "2.6.7"
   }
 }

package/src/events.ts

@@ -1,20 +1,44 @@
 import type * as Hapi from "@hapi/hapi";
 import fetch from "node-fetch";
+import { MOSIPPayload } from "./transform";
 
-export const mosipRegistrationHandler = ({ url }: { url: string }) =>
+interface VerificationStatus {
+  father: boolean;
+  mother: boolean;
+  informant: boolean;
+}
+
+/**
+ * Replaces event registration handler in country config
+ */
+export const mosipRegistrationHandler = ({
+  url,
+  headers,
+  payload,
+}: {
+  url: string;
+  headers: Record<string, string>;
+  payload: MOSIPPayload;
+}) =>
   (async (request: Hapi.Request, h: Hapi.ResponseToolkit) => {
-    const OPENCRVS_MOSIP_GATEWAY_URL = new URL("./webhooks/opencrvs", url);
+    const MOSIP_API_REGISTRATION_EVENT_URL = new URL(
+      "./events/registration",
+      url,
+    );
 
-    const response = await fetch(OPENCRVS_MOSIP_GATEWAY_URL, {
+    const response = await fetch(MOSIP_API_REGISTRATION_EVENT_URL, {
       method: "POST",
-      body: JSON.stringify(request.payload),
-      headers: request.headers,
+      body: JSON.stringify(payload),
+      headers: {
+        ...headers,
+        "content-type": "application/json",
+      },
     });
 
     if (!response.ok) {
       return h
         .response({
-          error: "OpenCRVS-MOSIP gateway did not return a 200",
+          error: "OpenCRVS-MOSIP event registration route did not return a 200",
           response: await response.text(),
         })
         .code(500);
@@ -22,3 +46,56 @@ export const mosipRegistrationHandler = ({ url }: { url: string }) =>
 
     return h.response({ success: true }).code(200);
   }) satisfies Hapi.ServerRoute["handler"];
+
+/**
+ * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
+ */
+export const mosipRegistrationForReviewHandler = ({ url }: { url: string }) =>
+  (async (request: Hapi.Request, h: Hapi.ResponseToolkit) => {
+    // Corresponds to `packages/mosip-api` /events/review -route
+    let response;
+    try {
+      response = await verify({ url, request });
+    } catch (error) {
+      return h
+        .response({
+          error: "OpenCRVS-MOSIP event review route did not return a 200",
+          response: error instanceof Error ? error.message : "Unknown error",
+        })
+        .code(500);
+    }
+
+    return h.response(response).code(200);
+  }) satisfies Hapi.ServerRoute["handler"];
+
+/**
+ * Replaces `/events/{event}/actions/sent-for-approval` handler in country config
+ * Currently the same as `/events/{event}/actions/sent-notification-for-review`
+ */
+export const mosipRegistrationForApprovalHandler =
+  mosipRegistrationForReviewHandler;
+
+export const verify = async ({
+  url,
+  request,
+}: {
+  url: string;
+  request: Hapi.Request;
+}): Promise<Partial<VerificationStatus>> => {
+  const MOSIP_API_REVIEW_EVENT_URL = new URL("./events/review", url);
+
+  const response = await fetch(MOSIP_API_REVIEW_EVENT_URL, {
+    method: "POST",
+    body: JSON.stringify(request.payload),
+    headers: {
+      ...request.headers,
+      "content-type": "application/json",
+    },
+  });
+
+  if (!response.ok) {
+    throw new Error(await response.text());
+  }
+
+  return (await response.json()) satisfies Partial<VerificationStatus>;
+};