@opencrvs/mosip 1.8.0 → 1.9.0-alpha.2

package/build/api.d.ts

@@ -0,0 +1,39 @@
+import type { FieldValue } from "@opencrvs/toolkit/events";
+export interface BirthRequestFields extends Record<string, unknown> {
+    birthCertificateNumber: string;
+    deathCertificateNumber?: undefined;
+}
+export interface DeathRequestFields extends Record<string, unknown> {
+    deathCertificateNumber: string;
+    birthCertificateNumber?: undefined;
+}
+export interface MosipInteropPayload {
+    trackingId: string;
+    notification: {
+        recipientFullName: string;
+        recipientEmail: string;
+        recipientPhone: string;
+    };
+    requestFields: BirthRequestFields | DeathRequestFields;
+    metaInfo: Record<string, unknown>;
+    audit: Record<string, unknown>;
+}
+export interface VerifyNidPayload {
+    nid: FieldValue;
+    gender?: FieldValue;
+    dob: FieldValue;
+    name: FieldValue;
+    /** Adds logging of the auth status using this id to mosip-api */
+    transactionId?: string;
+}
+export interface VerificationStatus {
+    father: boolean;
+    mother: boolean;
+    informant: boolean;
+    deceased: boolean;
+    spouse: boolean;
+}
+export declare const createMosipInteropClient: (url: string, authorizationHeader: string) => {
+    register: (payload: MosipInteropPayload) => Promise<any>;
+    verifyNid: (payload: VerifyNidPayload) => Promise<"verified" | "failed">;
+};

package/build/api.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMosipInteropClient = void 0;
+async function fetchWithTimeout(input, init = {}, timeoutMs = 15000) {
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), timeoutMs);
+    try {
+        const response = await fetch(input, {
+            ...init,
+            signal: controller.signal,
+        });
+        return response;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+const createMosipInteropClient = (url, authorizationHeader) => {
+    return {
+        register: async (payload) => {
+            const MOSIP_API_REGISTRATION_EVENT_URL = new URL("./events/registration", url).href;
+            const response = await fetchWithTimeout(MOSIP_API_REGISTRATION_EVENT_URL, {
+                method: "POST",
+                body: JSON.stringify(payload),
+                headers: {
+                    Authorization: authorizationHeader,
+                    "content-type": "application/json",
+                },
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to register event: ${await response.text()}`);
+            }
+            return response.json();
+        },
+        verifyNid: async (payload) => {
+            const MOSIP_API_VERIFY_URL = new URL("./verify", url).href;
+            const response = await fetchWithTimeout(MOSIP_API_VERIFY_URL, {
+                method: "POST",
+                body: JSON.stringify(payload),
+                headers: {
+                    Authorization: authorizationHeader,
+                    "content-type": "application/json",
+                },
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to register event: ${await response.text()}`);
+            }
+            return response.text();
+        },
+    };
+};
+exports.createMosipInteropClient = createMosipInteropClient;

package/build/events.d.ts

@@ -1,11 +1,8 @@
 import type * as Hapi from "@hapi/hapi";
 import { MOSIPPayload } from "./transform";
-interface VerificationStatus {
-    father: boolean;
-    mother: boolean;
-    informant: boolean;
-}
+import { VerificationStatus } from "./api";
 /**
+ * @deprecated
  * Replaces event registration handler in country config
  */
 export declare const mosipRegistrationHandler: ({ url, headers, payload, }: {
@@ -14,6 +11,7 @@ export declare const mosipRegistrationHandler: ({ url, headers, payload, }: {
     payload: MOSIPPayload;
 }) => (request: Hapi.Request, h: Hapi.ResponseToolkit) => Promise<Hapi.ResponseObject>;
 /**
+ * @deprecated
  * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
  */
 export declare const mosipRegistrationForReviewHandler: ({ url }: {
@@ -30,4 +28,3 @@ export declare const verify: ({ url, request, }: {
     url: string;
     request: Hapi.Request;
 }) => Promise<Partial<VerificationStatus>>;
-export {};

package/build/events.js

@@ -5,7 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.verify = exports.mosipRegistrationForApprovalHandler = exports.mosipRegistrationForReviewHandler = exports.mosipRegistrationHandler = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
+/*
+ * NOTE!
+ *
+ * This file is used in OpenCRVS pre-1.9 country-configs and registrations. You are looking for `api.ts` which caters for OpenCRVS 1.9+.
+ * This file can be removed in future versions.
+ */
 /**
+ * @deprecated
  * Replaces event registration handler in country config
  */
 const mosipRegistrationHandler = ({ url, headers, payload, }) => (async (request, h) => {
@@ -30,6 +37,7 @@ const mosipRegistrationHandler = ({ url, headers, payload, }) => (async (request
 });
 exports.mosipRegistrationHandler = mosipRegistrationHandler;
 /**
+ * @deprecated
  * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
  */
 const mosipRegistrationForReviewHandler = ({ url }) => (async (request, h) => {

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.8.0",
+  "version": "1.9.0-alpha.2",
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {
     ".": "./build/index.js",
     "./forms": "./build/forms.js",
-    "./events": "./build/events.js"
+    "./events": "./build/events.js",
+    "./api": "./build/api.js"
   },
   "typings": "build/index.d.ts",
   "scripts": {
@@ -14,6 +15,7 @@
   },
   "dependencies": {},
   "devDependencies": {
+    "@opencrvs/toolkit": "^1.8.1-rc.af15018",
     "@types/hapi__hapi": "^20.0.0",
     "@types/node-fetch": "^2.6.11",
     "node-fetch": "2.6.7",

package/src/api.ts

@@ -0,0 +1,109 @@
+import type { EventDocument, FieldValue } from "@opencrvs/toolkit/events";
+
+export interface BirthRequestFields extends Record<string, unknown> {
+  birthCertificateNumber: string;
+  deathCertificateNumber?: undefined;
+}
+
+export interface DeathRequestFields extends Record<string, unknown> {
+  deathCertificateNumber: string;
+  birthCertificateNumber?: undefined;
+}
+
+export interface MosipInteropPayload {
+  trackingId: string;
+  notification: {
+    recipientFullName: string;
+    recipientEmail: string;
+    recipientPhone: string;
+  };
+  requestFields: BirthRequestFields | DeathRequestFields;
+  metaInfo: Record<string, unknown>;
+  audit: Record<string, unknown>;
+}
+
+export interface VerifyNidPayload {
+  nid: FieldValue;
+  gender?: FieldValue;
+  dob: FieldValue;
+  name: FieldValue;
+  /** Adds logging of the auth status using this id to mosip-api */
+  transactionId?: string;
+}
+
+export interface VerificationStatus {
+  father: boolean;
+  mother: boolean;
+  informant: boolean;
+  deceased: boolean;
+  spouse: boolean;
+}
+
+async function fetchWithTimeout(
+  input: RequestInfo,
+  init: RequestInit = {},
+  timeoutMs = 15000,
+): Promise<Response> {
+  const controller = new AbortController();
+  const timeout = setTimeout(() => controller.abort(), timeoutMs);
+
+  try {
+    const response = await fetch(input, {
+      ...init,
+      signal: controller.signal,
+    });
+    return response;
+  } finally {
+    clearTimeout(timeout);
+  }
+}
+
+export const createMosipInteropClient = (
+  url: string,
+  authorizationHeader: string,
+) => {
+  return {
+    register: async (payload: MosipInteropPayload) => {
+      const MOSIP_API_REGISTRATION_EVENT_URL = new URL(
+        "./events/registration",
+        url,
+      ).href;
+
+      const response = await fetchWithTimeout(
+        MOSIP_API_REGISTRATION_EVENT_URL,
+        {
+          method: "POST",
+          body: JSON.stringify(payload),
+          headers: {
+            Authorization: authorizationHeader,
+            "content-type": "application/json",
+          },
+        },
+      );
+
+      if (!response.ok) {
+        throw new Error(`Failed to register event: ${await response.text()}`);
+      }
+
+      return response.json();
+    },
+    verifyNid: async (payload: VerifyNidPayload) => {
+      const MOSIP_API_VERIFY_URL = new URL("./verify", url).href;
+
+      const response = await fetchWithTimeout(MOSIP_API_VERIFY_URL, {
+        method: "POST",
+        body: JSON.stringify(payload),
+        headers: {
+          Authorization: authorizationHeader,
+          "content-type": "application/json",
+        },
+      });
+
+      if (!response.ok) {
+        throw new Error(`Failed to register event: ${await response.text()}`);
+      }
+
+      return response.text() as Promise<"verified" | "failed">;
+    },
+  };
+};

package/src/events.ts

@@ -1,14 +1,17 @@
 import type * as Hapi from "@hapi/hapi";
 import fetch from "node-fetch";
 import { MOSIPPayload } from "./transform";
+import { VerificationStatus } from "./api";
 
-interface VerificationStatus {
-  father: boolean;
-  mother: boolean;
-  informant: boolean;
-}
+/*
+ * NOTE!
+ *
+ * This file is used in OpenCRVS pre-1.9 country-configs and registrations. You are looking for `api.ts` which caters for OpenCRVS 1.9+.
+ * This file can be removed in future versions.
+ */
 
 /**
+ * @deprecated
  * Replaces event registration handler in country config
  */
 export const mosipRegistrationHandler = ({
@@ -48,6 +51,7 @@ export const mosipRegistrationHandler = ({
   }) satisfies Hapi.ServerRoute["handler"];
 
 /**
+ * @deprecated
  * Replaces `/events/{event}/actions/sent-notification-for-review` handler in country config
  */
 export const mosipRegistrationForReviewHandler = ({ url }: { url: string }) =>

package/tsconfig.json

@@ -1,11 +1,11 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "commonjs",
+    "module": "node16",
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
     "declaration": true,
     "outDir": "./build"
   }
-}
+}