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

package/build/events.d.ts

@@ -1,4 +1,30 @@
 import type * as Hapi from "@hapi/hapi";
+interface VerificationStatus {
+    father: boolean;
+    mother: boolean;
+    informant: boolean;
+}
+/**
+ * Replaces event registration handler in country config
+ */
 export declare const mosipRegistrationHandler: ({ url }: {
     url: string;
 }) => (request: Hapi.Request, h: Hapi.ResponseToolkit) => Promise<Hapi.ResponseObject>;
+/**
+ * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
+ */
+export declare const mosipRegistrationForReviewHandler: ({ url }: {
+    url: string;
+}) => (request: Hapi.Request, h: Hapi.ResponseToolkit) => Promise<Hapi.ResponseObject>;
+/**
+ * Replaces `/events/{event}/actions/sent-for-approval` handler in country config
+ * Currently the same as `/events/{event}/actions/sent-notification-for-review`
+ */
+export declare const mosipRegistrationForApprovalHandler: ({ url }: {
+    url: string;
+}) => (request: Hapi.Request, h: Hapi.ResponseToolkit) => Promise<Hapi.ResponseObject>;
+export declare const verify: ({ url, request, }: {
+    url: string;
+    request: Hapi.Request;
+}) => Promise<Partial<VerificationStatus>>;
+export {};

package/build/events.js

@@ -3,19 +3,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mosipRegistrationHandler = void 0;
+exports.verify = exports.mosipRegistrationForApprovalHandler = exports.mosipRegistrationForReviewHandler = exports.mosipRegistrationHandler = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
+/**
+ * Replaces event registration handler in country config
+ */
 const mosipRegistrationHandler = ({ url }) => (async (request, h) => {
-    const OPENCRVS_MOSIP_GATEWAY_URL = new URL("./webhooks/opencrvs", url);
-    const response = await (0, node_fetch_1.default)(OPENCRVS_MOSIP_GATEWAY_URL, {
+    const MOSIP_API_REGISTRATION_EVENT_URL = new URL("./events/registration", url);
+    const response = await (0, node_fetch_1.default)(MOSIP_API_REGISTRATION_EVENT_URL, {
         method: "POST",
         body: JSON.stringify(request.payload),
-        headers: request.headers,
+        headers: {
+            ...request.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);
@@ -23,3 +29,44 @@ const mosipRegistrationHandler = ({ url }) => (async (request, h) => {
     return h.response({ success: true }).code(200);
 });
 exports.mosipRegistrationHandler = mosipRegistrationHandler;
+/**
+ * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
+ */
+const mosipRegistrationForReviewHandler = ({ url }) => (async (request, h) => {
+    // Corresponds to `packages/mosip-api` /events/review -route
+    let response;
+    try {
+        response = await (0, exports.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);
+});
+exports.mosipRegistrationForReviewHandler = mosipRegistrationForReviewHandler;
+/**
+ * Replaces `/events/{event}/actions/sent-for-approval` handler in country config
+ * Currently the same as `/events/{event}/actions/sent-notification-for-review`
+ */
+exports.mosipRegistrationForApprovalHandler = exports.mosipRegistrationForReviewHandler;
+const verify = async ({ url, request, }) => {
+    const MOSIP_API_REVIEW_EVENT_URL = new URL("./events/review", url);
+    const response = await (0, node_fetch_1.default)(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());
+};
+exports.verify = verify;

package/build/forms.d.ts

@@ -1,6 +1,46 @@
 /**
- * E-Signet popup button form definition
+ * E-Signet popup button and hidden field form definitions
+ * @example
+ * ```
+ * [
+ *   // ...other fields
+ *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
+ * ]
+ * ```
  */
+/**
+ *
+ * @description E-Signet REDIRECT button form definition.  Calls E-Signet /authorize (this field may not be supported in the latest release of OpenCRVS yet)
+ *
+ */
+export declare const esignet: (esignetAuthUrl: string, openIdProviderClientId: string, openIdProviderClaims: string | undefined, fieldName: string, callbackFieldName: string) => {
+    name: string;
+    validator: never[];
+    icon: {
+        desktop: string;
+        mobile: string;
+    };
+    type: string;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    hideInPreview: boolean;
+    conditionals: {
+        action: string;
+        expression: string;
+    }[];
+    options: {
+        url: string;
+        callback: {
+            params: {
+                state: string;
+            };
+            trigger: string;
+        };
+    };
+};
 export declare const popupButton: ({ url, }: {
     url: string;
 }) => {
@@ -8,24 +48,173 @@ export declare const popupButton: ({ url, }: {
     type: string;
     url: string;
 };
-export declare const hidden: () => {
+/**
+ *
+ * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
+ *
+ */
+export declare const esignetCallback: ({ fieldName, mosipAPIUserInfoUrl, openIdProviderClientId, }: {
+    fieldName: string;
+    mosipAPIUserInfoUrl: string;
+    openIdProviderClientId: string;
+}) => {
+    name: string;
+    type: string;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    validator: never[];
+    hideInPreview: boolean;
+    options: {
+        url: string;
+        headers: {
+            "Content-type": string;
+        };
+        body: {
+            clientId: string;
+            redirectUri: string;
+        };
+        method: string;
+    };
+};
+export declare const esignetHidden: () => {
     name: string;
     type: string;
 };
 /**
- * E-Signet popup button and hidden field form definitions
- * @example
- * ```
- * [
- *   // ...other fields
- *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
- * ]
- * ```
+ *
+ * @description QR reader type definition (this field may not be supported in the latest release of OpenCRVS yet)
+ *
  */
-export declare const esignet: ({ url, }: {
-    /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
-    url: string;
-}) => {
+export declare const idReader: (event: string, sectionId: string, conditionals: any[], readers: any[]) => {
+    name: string;
+    customQuestionMappingId: string;
+    custom: boolean;
+    required: boolean;
+    type: string;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    hideInPreview: boolean;
+    initialValue: string;
+    validator: never[];
+    conditionals: any[];
+    dividerLabel: {
+        id: string;
+        defaultMessage: string;
+    };
+    manualInputInstructionLabel: {
+        id: string;
+        defaultMessage: string;
+    };
+    mapping: {
+        mutation: {
+            operation: string;
+        };
+    };
+    readers: any[];
+};
+type MessageDescriptor = {
+    id: string;
+    defaultMessage: string;
+    description?: string;
+};
+interface QRValidation {
+    rule: Record<string, unknown>;
+    errorMessage: MessageDescriptor;
+}
+interface QRConfig {
+    validation: QRValidation;
+}
+export declare const qr: ({ validation }: QRConfig) => {
+    type: string;
+    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;
+    customQuestionMappingId: string;
+    type: string;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    initialValue: {
+        dependsOn: string[];
+        expression: string;
+    };
+    validator: never[];
+    mapping: any;
+};
+export declare const idVerificationBanner: (event: string, sectionId: string, status: "verified" | "failed" | "authenticated") => {
+    name: string;
+    type: string;
+    fieldId: string;
+    hideInPreview: boolean;
+    custom: boolean;
+    bannerType: "verified" | "failed" | "authenticated";
+    idFieldName: string;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    validator: never[];
+    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) => ({
+    name: string;
+    fieldId: string;
+    customQuestionMappingId: string;
+    type: string;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    initialValue: {
+        dependsOn: string[];
+        expression: string;
+    };
+    validator: never[];
+    mapping: any;
+} | {
     name: string;
     type: string;
-}[];
+    fieldId: string;
+    hideInPreview: boolean;
+    custom: boolean;
+    bannerType: "verified" | "failed" | "authenticated";
+    idFieldName: string;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    validator: never[];
+    conditionals: {
+        action: string;
+        expression: string;
+    }[];
+})[];
+export {};

package/build/forms.js

@@ -1,11 +1,63 @@
 "use strict";
-// @TODO: we could start building these definitions to core tbh
-// @TODO: add renovate or something to listen for core updates and create a PRs, then we get an error message if we have broken this
+// @TODO: Yet to be implemented! Placeholders for NPM publish.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.esignet = exports.hidden = exports.popupButton = 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 form definition
+ * E-Signet popup button and hidden field form definitions
+ * @example
+ * ```
+ * [
+ *   // ...other fields
+ *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
+ * ]
+ * ```
+ */
+/**
+ *
+ * @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 = (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.href}");
+    return {
+        name: fieldName,
+        validator: [],
+        icon: {
+            desktop: "Globe",
+            mobile: "Fingerprint",
+        },
+        type: "LINK_BUTTON",
+        custom: true,
+        label: {
+            id: "views.idReader.label.eSignet",
+            defaultMessage: "E-signet",
+        },
+        hideInPreview: true,
+        conditionals: [
+            {
+                action: "disable",
+                expression: "!!$form.redirectCallbackFetch",
+            },
+        ],
+        options: {
+            url: url.toString(),
+            callback: {
+                params: {
+                    state: "fetch-on-mount",
+                },
+                trigger: callbackFieldName,
+            },
+        },
+    };
+};
+exports.esignet = esignet;
 const popupButton = ({ 
 /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
 url, }) => {
@@ -16,22 +68,168 @@ url, }) => {
     };
 };
 exports.popupButton = popupButton;
-const hidden = () => {
+/**
+ *
+ * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
+ *
+ */
+const esignetCallback = ({ fieldName, mosipAPIUserInfoUrl, openIdProviderClientId, }) => ({
+    name: fieldName,
+    type: "HTTP",
+    custom: true,
+    label: {
+        id: "form.field.label.empty",
+        defaultMessage: "",
+    },
+    validator: [],
+    hideInPreview: true,
+    options: {
+        url: mosipAPIUserInfoUrl,
+        headers: {
+            "Content-type": "application/json",
+        },
+        body: {
+            clientId: openIdProviderClientId,
+            redirectUri: "${window.location.href}",
+        },
+        method: "POST",
+    },
+});
+exports.esignetCallback = esignetCallback;
+const esignetHidden = () => {
     return {
         name: "INFORMANT_PSUT_TOKEN",
         type: "HIDDEN",
     };
 };
-exports.hidden = hidden;
+exports.esignetHidden = esignetHidden;
 /**
- * E-Signet popup button and hidden field form definitions
- * @example
- * ```
- * [
- *   // ...other fields
- *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
- * ]
- * ```
+ *
+ * @description QR reader type definition (this field may not be supported in the latest release of OpenCRVS yet)
+ *
  */
-const esignet = ({ url, }) => [(0, exports.popupButton)({ url }), (0, exports.hidden)()];
-exports.esignet = esignet;
+const idReader = (event, sectionId, conditionals, readers) => {
+    const fieldName = "idReader";
+    const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
+    return {
+        name: fieldName,
+        customQuestionMappingId: fieldId,
+        custom: true,
+        required: false,
+        type: "ID_READER",
+        label: {
+            id: "form.field.label.idReader",
+            defaultMessage: "ID verification",
+        },
+        hideInPreview: true,
+        initialValue: "",
+        validator: [],
+        conditionals,
+        dividerLabel: {
+            id: "views.idReader.label.or",
+            defaultMessage: "Or",
+        },
+        manualInputInstructionLabel: {
+            id: "views.idReader.label.manualInput",
+            defaultMessage: "Complete fields below",
+        },
+        mapping: {
+            mutation: {
+                operation: "ignoreFieldTransformer",
+            },
+        },
+        readers,
+    };
+};
+exports.idReader = idReader;
+const qr = ({ validation }) => ({
+    type: "QR",
+    validation,
+});
+exports.qr = qr;
+const verified = (event, sectionId, mapping) => {
+    const fieldName = "verified";
+    const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
+    return {
+        name: "verified",
+        fieldId,
+        customQuestionMappingId: fieldId,
+        type: "HIDDEN",
+        custom: true,
+        label: {
+            id: "form.field.label.empty",
+            defaultMessage: "",
+        },
+        initialValue: {
+            dependsOn: ["idReader"],
+            expression: 'Boolean($form?.idReader)? "pending":""',
+        },
+        validator: [],
+        mapping,
+    };
+};
+exports.verified = verified;
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+const idVerificationBanner = (event, sectionId, status) => {
+    const fieldName = "verified";
+    const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
+    return {
+        name: `id${capitalize(status)}.`,
+        type: "ID_VERIFICATION_BANNER",
+        fieldId,
+        hideInPreview: true,
+        custom: true,
+        bannerType: status,
+        idFieldName: "idReader",
+        label: {
+            id: "form.field.label.empty",
+            defaultMessage: "",
+        },
+        validator: [],
+        conditionals: [
+            {
+                action: "hide",
+                expression: `$form?.verified !== "${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, "verified"),
+        (0, exports.idVerificationBanner)(event, sectionId, "failed"),
+        (0, exports.idVerificationBanner)(event, sectionId, "authenticated"),
+    ];
+};
+exports.idVerificationFields = idVerificationFields;

package/package.json

@@ -1,26 +1,25 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.7.0-alpha.2",
+  "version": "1.7.0-alpha.21",
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {
     ".": "./build/index.js",
-    "./form-definitions": "./build/form-definitions.js",
+    "./forms": "./build/forms.js",
     "./events": "./build/events.js"
   },
   "typings": "build/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
-  "dependencies": {
-    "@hapi/hapi": "^20.0.1"
-  },
+  "dependencies": {},
   "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,35 @@
 import type * as Hapi from "@hapi/hapi";
 import fetch from "node-fetch";
 
+interface VerificationStatus {
+  father: boolean;
+  mother: boolean;
+  informant: boolean;
+}
+
+/**
+ * Replaces event registration handler in country config
+ */
 export const mosipRegistrationHandler = ({ url }: { url: string }) =>
   (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,
+      headers: {
+        ...request.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 +37,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>;
+};

package/src/forms.ts

@@ -1,9 +1,73 @@
-// @TODO: we could start building these definitions to core tbh
-// @TODO: add renovate or something to listen for core updates and create a PRs, then we get an error message if we have broken this
+// @TODO: Yet to be implemented! Placeholders for NPM publish.
 
 /**
- * E-Signet popup button form definition
+ * E-Signet popup button and hidden field form definitions
+ * @example
+ * ```
+ * [
+ *   // ...other fields
+ *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
+ * ]
+ * ```
  */
+
+/**
+ *
+ * @description E-Signet REDIRECT button form definition.  Calls E-Signet /authorize (this field may not be supported in the latest release of OpenCRVS yet)
+ *
+ */
+export const esignet = (
+  esignetAuthUrl: string,
+  openIdProviderClientId: string,
+  openIdProviderClaims: string = "name,family_name,given_name,middle_name,birthdate,address",
+  fieldName: string,
+  callbackFieldName: string,
+) => {
+  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.href}");
+
+  return {
+    name: fieldName,
+    validator: [],
+    icon: {
+      desktop: "Globe",
+      mobile: "Fingerprint",
+    },
+    type: "LINK_BUTTON",
+    custom: true,
+    label: {
+      id: "views.idReader.label.eSignet",
+      defaultMessage: "E-signet",
+    },
+    hideInPreview: true,
+    conditionals: [
+      {
+        action: "disable",
+        expression: "!!$form.redirectCallbackFetch",
+      },
+    ],
+    options: {
+      url: url.toString(),
+      callback: {
+        params: {
+          state: "fetch-on-mount",
+        },
+        trigger: callbackFieldName,
+      },
+    },
+  };
+};
+
 export const popupButton = ({
   /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
   url,
@@ -17,7 +81,45 @@ export const popupButton = ({
   };
 };
 
-export const hidden = () => {
+/**
+ *
+ * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
+ *
+ */
+
+export const esignetCallback = ({
+  fieldName,
+  mosipAPIUserInfoUrl,
+  openIdProviderClientId,
+}: {
+  fieldName: string;
+  mosipAPIUserInfoUrl: string;
+  openIdProviderClientId: string;
+}) => ({
+  name: fieldName,
+  type: "HTTP",
+  custom: true,
+  label: {
+    id: "form.field.label.empty",
+    defaultMessage: "",
+  },
+  validator: [],
+  hideInPreview: true,
+  options: {
+    url: mosipAPIUserInfoUrl,
+    headers: {
+      "Content-type": "application/json",
+    },
+    body: {
+      clientId: openIdProviderClientId,
+      redirectUri: "${window.location.href}",
+    },
+
+    method: "POST",
+  },
+});
+
+export const esignetHidden = () => {
   return {
     name: "INFORMANT_PSUT_TOKEN",
     type: "HIDDEN",
@@ -25,18 +127,194 @@ export const hidden = () => {
 };
 
 /**
- * E-Signet popup button and hidden field form definitions
- * @example
- * ```
- * [
- *   // ...other fields
- *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
- * ]
- * ```
+ *
+ * @description QR reader type definition (this field may not be supported in the latest release of OpenCRVS yet)
+ *
  */
-export const esignet = ({
-  url,
-}: {
-  /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
-  url: string;
-}) => [popupButton({ url }), hidden()];
+
+export const idReader = (
+  event: string,
+  sectionId: string,
+  conditionals: any[],
+  readers: any[],
+) => {
+  const fieldName: string = "idReader";
+  const fieldId: string = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
+  return {
+    name: fieldName,
+    customQuestionMappingId: fieldId,
+    custom: true,
+    required: false,
+    type: "ID_READER",
+    label: {
+      id: "form.field.label.idReader",
+      defaultMessage: "ID verification",
+    },
+    hideInPreview: true,
+    initialValue: "",
+    validator: [],
+    conditionals,
+    dividerLabel: {
+      id: "views.idReader.label.or",
+      defaultMessage: "Or",
+    },
+    manualInputInstructionLabel: {
+      id: "views.idReader.label.manualInput",
+      defaultMessage: "Complete fields below",
+    },
+    mapping: {
+      mutation: {
+        operation: "ignoreFieldTransformer",
+      },
+    },
+    readers,
+  };
+};
+
+type MessageDescriptor = {
+  id: string;
+  defaultMessage: string;
+  description?: string;
+};
+
+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}`;
+  return {
+    name: "verified",
+    fieldId,
+    customQuestionMappingId: fieldId,
+    type: "HIDDEN",
+    custom: true,
+    label: {
+      id: "form.field.label.empty",
+      defaultMessage: "",
+    },
+    initialValue: {
+      dependsOn: ["idReader"],
+      expression: 'Boolean($form?.idReader)? "pending":""',
+    },
+    validator: [],
+    mapping,
+  };
+};
+
+function capitalize(str: string) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+
+export const idVerificationBanner = (
+  event: string,
+  sectionId: string,
+  status: "verified" | "failed" | "authenticated",
+) => {
+  const fieldName = "verified";
+  const fieldId = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
+  return {
+    name: `id${capitalize(status)}.`,
+    type: "ID_VERIFICATION_BANNER",
+    fieldId,
+    hideInPreview: true,
+    custom: true,
+    bannerType: status,
+    idFieldName: "idReader",
+    label: {
+      id: "form.field.label.empty",
+      defaultMessage: "",
+    },
+    validator: [],
+    conditionals: [
+      {
+        action: "hide",
+        expression: `$form?.verified !== "${status}"`,
+      },
+    ],
+  };
+};
+
+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, "verified"),
+    idVerificationBanner(event, sectionId, "failed"),
+    idVerificationBanner(event, sectionId, "authenticated"),
+  ];
+};

package/tsconfig.json

@@ -8,4 +8,4 @@
     "declaration": true,
     "outDir": "./build"
   }
-}
+}