@opencrvs/mosip 1.7.0-alpha.1 → 1.7.0-alpha.3

package/README.md

@@ -0,0 +1,3 @@
+# @opencrvs/mosip
+
+This package contains helpers to country-config for using the [OpenCRVS-MOSIP API](https://github.com/opencrvs/mosip).

package/build/forms.d.ts

@@ -1,31 +1,121 @@
 /**
- * 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" })
+ * ]
+ * ```
  */
-export declare const popupButton: ({ url, }: {
+/**
+ *
+ * @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, 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: {
+                code: string;
+            };
+            trigger: string;
+        };
+    };
+};
+export declare const popupButton: ({ url }: {
     url: string;
 }) => {
     name: string;
     type: string;
     url: string;
 };
-export declare const hidden: () => {
+/**
+ *
+ * @description esignet callback button form definition.  Calls server/esignet-api /esignet/get-oidp-user-info (this field may not be supported in the latest release of OpenCRVS yet)
+ *
+ */
+export declare const esignetCallback: ({ fieldName, getOIDPUserInfoUrl, openIdProviderClientId }: {
+    fieldName: string;
+    getOIDPUserInfoUrl: string;
+    openIdProviderClientId: string;
+}) => {
+    name: string;
+    type: string;
+    custom: boolean;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    validator: never[];
+    options: {
+        getOIDPUserInfoUrl: string;
+        headers: {
+            'Content-type': string;
+        };
+        body: {
+            code: string;
+            clientId: string;
+            redirectUri: string;
+        };
+        method: string;
+    };
+};
+export declare const returnExpression: (fieldName: string) => {
+    dependsOn: string[];
+    expression: 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;
+    };
+    readers: any[];
+};
+export declare const qr: () => {
     type: string;
-}[];
+};

package/build/forms.js

@@ -1,37 +1,165 @@
 "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.qr = exports.idReader = exports.esignetHidden = exports.returnExpression = 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, 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 || 'mock-claims');
+    url.searchParams.append('state', 'trigger-onmount');
+    /*
+  
+    TODO: Understand from Tahmid about how to handle this:
+    
+    url.searchParams.append(
+      'redirect_uri',
+      `${window.location.origin}${OIDP_VERIFICATION_CALLBACK}`
+    )
+    const stateToBeSent: INidCallbackState = {
+      pathname: currentPathname,
+      declarationId: declarationId,
+      section: currentSection
+    }
+    url.searchParams.append('state', JSON.stringify(stateToBeSent))
+    */
+    window.location.href = url.toString();
+    return {
+        name: fieldName,
+        validator: [],
+        icon: {
+            desktop: 'Globe',
+            mobile: 'Fingerprint'
+        },
+        type: "REDIRECT",
+        custom: true,
+        label: {
+            id: 'views.idReader.label.eSignet',
+            defaultMessage: 'E-signet'
+        },
+        hideInPreview: true,
+        conditionals: [
+            {
+                action: "disable",
+                expression: "!!$form.redirectCallbackFetch",
+            },
+        ],
+        options: {
+            url: esignetAuthUrl,
+            callback: {
+                params: {
+                    code: "esignet-mock-code",
+                },
+                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;
-const hidden = () => {
+/**
+ *
+ * @description esignet callback button form definition.  Calls server/esignet-api /esignet/get-oidp-user-info (this field may not be supported in the latest release of OpenCRVS yet)
+ *
+ */
+const esignetCallback = ({ fieldName, getOIDPUserInfoUrl, openIdProviderClientId }) => ({
+    name: fieldName,
+    type: 'HTTP',
+    custom: true,
+    label: {
+        id: 'form.field.label.empty',
+        defaultMessage: ''
+    },
+    validator: [],
+    options: {
+        getOIDPUserInfoUrl,
+        headers: {
+            'Content-type': 'application/json'
+        },
+        body: {
+            code: "esignet-mock-code",
+            clientId: openIdProviderClientId,
+            redirectUri: ""
+        },
+        method: 'POST'
+    }
+});
+exports.esignetCallback = esignetCallback;
+const returnExpression = (fieldName) => {
     return {
-        name: "INFORMANT_PSUT_TOKEN",
-        type: "HIDDEN",
+        dependsOn: ["redirectCallbackFetch"],
+        expression: `$form.redirectCallbackFetch?.data?.${fieldName}`,
     };
 };
-exports.hidden = hidden;
+exports.returnExpression = returnExpression;
+const esignetHidden = () => {
+    return {
+        name: 'INFORMANT_PSUT_TOKEN',
+        type: '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.empty',
+            defaultMessage: ''
+        },
+        hideInPreview: true,
+        initialValue: '',
+        validator: [],
+        conditionals,
+        dividerLabel: {
+            id: 'views.idReader.label.or',
+            defaultMessage: 'Or'
+        },
+        manualInputInstructionLabel: {
+            id: 'views.idReader.label.manualInput',
+            defaultMessage: 'Complete fields below'
+        },
+        readers
+    };
+};
+exports.idReader = idReader;
+const qr = () => ({
+    type: 'QR'
+});
+exports.qr = qr;

package/package.json

@@ -1,20 +1,18 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.7.0-alpha.1",
+  "version": "1.7.0-alpha.3",
   "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",

package/src/forms.ts

@@ -1,42 +1,191 @@
-// @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, 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 || 'mock-claims')
+  url.searchParams.append('state', 'trigger-onmount')
+
+  /*
+
+  TODO: Understand from Tahmid about how to handle this:
+  
+  url.searchParams.append(
+    'redirect_uri',
+    `${window.location.origin}${OIDP_VERIFICATION_CALLBACK}`
+  )
+  const stateToBeSent: INidCallbackState = {
+    pathname: currentPathname,
+    declarationId: declarationId,
+    section: currentSection
+  }
+  url.searchParams.append('state', JSON.stringify(stateToBeSent))
+  */
+  window.location.href = url.toString()
+
+  return {
+    name: fieldName,
+    validator: [],
+    icon: {
+      desktop: 'Globe',
+      mobile: 'Fingerprint'
+    },
+    type: "REDIRECT",
+    custom: true,
+    label: {    
+      id: 'views.idReader.label.eSignet',
+      defaultMessage: 'E-signet'
+    },
+    hideInPreview: true,
+    conditionals: [
+      {
+        action: "disable",
+        expression: "!!$form.redirectCallbackFetch",
+      },
+    ],
+    options: {
+      url: esignetAuthUrl,
+      callback: {
+        params: {
+          code: "esignet-mock-code",
+        },      
+        trigger: callbackFieldName
+      },
+    },
+  };
+};
+
 export const popupButton = ({
   /** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
-  url,
+  url
 }: {
   url: string;
 }) => {
   return {
-    name: "INFORMANT_AUTHENTICATION_POPUP_BUTTON",
-    type: "POPUP_BUTTON",
-    url,
+    name: 'INFORMANT_AUTHENTICATION_POPUP_BUTTON',
+    type: 'POPUP_BUTTON',
+    url
+  };
+};
+
+/**
+ *
+ * @description esignet callback button form definition.  Calls server/esignet-api /esignet/get-oidp-user-info (this field may not be supported in the latest release of OpenCRVS yet)
+ *
+ */
+
+export const esignetCallback = ({
+  fieldName,
+  getOIDPUserInfoUrl,
+  openIdProviderClientId 
+}: {
+  fieldName: string;
+  getOIDPUserInfoUrl: string;
+  openIdProviderClientId: string;
+}) => ({
+  name: fieldName,
+  type: 'HTTP',
+  custom: true,
+  label: {
+    id: 'form.field.label.empty',
+    defaultMessage: ''
+  },
+  validator: [],
+  options: {
+    getOIDPUserInfoUrl,
+    headers: {
+      'Content-type': 'application/json'
+    },
+    body: {
+      code: "esignet-mock-code",
+      clientId: openIdProviderClientId,
+      redirectUri: ""
+    },
+    method: 'POST'
+  }
+});
+
+export const returnExpression = (fieldName: string) => {
+  return {
+    dependsOn: ["redirectCallbackFetch"],
+    expression: `$form.redirectCallbackFetch?.data?.${fieldName}`,
   };
 };
 
-export const hidden = () => {
+export const esignetHidden = () => {
   return {
-    name: "INFORMANT_PSUT_TOKEN",
-    type: "HIDDEN",
+    name: 'INFORMANT_PSUT_TOKEN',
+    type: '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.empty',
+      defaultMessage: ''
+    },
+    hideInPreview: true,
+    initialValue: '',
+    validator: [],
+    conditionals,
+    dividerLabel: {
+      id: 'views.idReader.label.or',
+      defaultMessage: 'Or'
+    },
+    manualInputInstructionLabel: {
+      id: 'views.idReader.label.manualInput',
+      defaultMessage: 'Complete fields below'
+    },
+    readers
+  };
+};
+
+export const qr = () => ({
+  type: 'QR'
+});
+
+
+