@opencrvs/mosip 2.0.0 → 2.1.0-rc.65b5bdf

package/README.md

@@ -1,3 +1,11 @@
 # @opencrvs/mosip
 
-This package contains helpers to country-config for using the [OpenCRVS-MOSIP API](https://github.com/opencrvs/mosip).
+Helpers for wiring an OpenCRVS country configuration to the MOSIP integration
+API. Published to npm at core's version, and consumed by country configs as
+`@opencrvs/mosip` — see `packages/testland` for a worked example.
+
+The service these helpers talk to is [`packages/mosip-api`](../mosip-api), and
+the mock MOSIP and e-Signet servers used in development and e2e are
+[`packages/mosip-mock`](../mosip-mock) and
+[`packages/esignet-mock`](../esignet-mock). All three are deployed by the
+`charts/opencrvs-mosip` Helm chart.

package/build/api.d.ts

@@ -1,5 +1,5 @@
-import type { FieldValue } from "@opencrvs/toolkit/events";
-import { z } from "zod";
+import type { FieldValue } from '@opencrvs/toolkit/events';
+import { z } from 'zod';
 export declare const BirthRequestFieldsSchema: z.ZodObject<{
     birthCertificateNumber: z.ZodString;
     deathCertificateNumber: z.ZodOptional<z.ZodUndefined>;
@@ -92,5 +92,5 @@ export interface VerificationStatus {
 export declare const createMosipInteropClient: (url: string, authorizationHeader: string) => {
     register: (payload: MosipInteropPayload) => Promise<Record<string, unknown>>;
     updateBiographics: (payload: MosipCorrectionPayload) => Promise<Record<string, unknown>>;
-    verifyNid: (payload: VerifyNidPayload) => Promise<"verified" | "failed">;
+    verifyNid: (payload: VerifyNidPayload) => Promise<"failed" | "verified">;
 };

package/build/api.js

@@ -4,11 +4,11 @@ exports.createMosipInteropClient = exports.RegistrationEventResponseSchema = exp
 const zod_1 = require("zod");
 exports.BirthRequestFieldsSchema = zod_1.z.looseObject({
     birthCertificateNumber: zod_1.z.string(),
-    deathCertificateNumber: zod_1.z.undefined().optional(),
+    deathCertificateNumber: zod_1.z.undefined().optional()
 });
 exports.DeathRequestFieldsSchema = zod_1.z.looseObject({
     deathCertificateNumber: zod_1.z.string(),
-    birthCertificateNumber: zod_1.z.undefined().optional(),
+    birthCertificateNumber: zod_1.z.undefined().optional()
 });
 exports.CorrectionRequestFieldsSchema = zod_1.z.looseObject({
     VID: zod_1.z.string(),
@@ -17,12 +17,12 @@ exports.CorrectionRequestFieldsSchema = zod_1.z.looseObject({
     gender: zod_1.z.string().optional(),
     introducerInfoToken: zod_1.z.string().optional(),
     birthCertificateNumber: zod_1.z.undefined().optional(),
-    deathCertificateNumber: zod_1.z.undefined().optional(),
+    deathCertificateNumber: zod_1.z.undefined().optional()
 });
 exports.MosipNotificationSchema = zod_1.z.object({
     recipientFullName: zod_1.z.string(),
     recipientEmail: zod_1.z.string(),
-    recipientPhone: zod_1.z.string(),
+    recipientPhone: zod_1.z.string()
 });
 exports.MosipInteropPayloadSchema = zod_1.z.object({
     trackingId: zod_1.z.string(),
@@ -30,11 +30,11 @@ exports.MosipInteropPayloadSchema = zod_1.z.object({
     requestFields: zod_1.z.union([
         exports.BirthRequestFieldsSchema,
         exports.DeathRequestFieldsSchema,
-        exports.CorrectionRequestFieldsSchema,
+        exports.CorrectionRequestFieldsSchema
     ]),
     schemaJson: zod_1.z.string().optional(),
     metaInfo: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
-    audit: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+    audit: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())
 });
 exports.MosipCorrectionPayloadSchema = zod_1.z.object({
     trackingId: zod_1.z.string(),
@@ -44,11 +44,11 @@ exports.MosipCorrectionPayloadSchema = zod_1.z.object({
         fullName: zod_1.z.string().optional(),
         dateOfBirth: zod_1.z.string().optional(),
         gender: zod_1.z.string().optional(),
-        introducerInfoToken: zod_1.z.string().optional(),
+        introducerInfoToken: zod_1.z.string().optional()
     }),
     schemaJson: zod_1.z.string().optional(),
     metaInfo: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
-    audit: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+    audit: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())
 });
 const FieldValueSchema = zod_1.z.custom(() => true);
 exports.VerifyNidPayloadSchema = zod_1.z.object({
@@ -56,11 +56,11 @@ exports.VerifyNidPayloadSchema = zod_1.z.object({
     gender: FieldValueSchema.optional(),
     dob: FieldValueSchema,
     name: FieldValueSchema,
-    transactionId: zod_1.z.string().optional(),
+    transactionId: zod_1.z.string().optional()
 });
 exports.VerifyNidResponseSchema = zod_1.z.union([
-    zod_1.z.literal("verified"),
-    zod_1.z.literal("failed"),
+    zod_1.z.literal('verified'),
+    zod_1.z.literal('failed')
 ]);
 exports.RegistrationEventResponseSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
 async function fetchWithTimeout(input, init = {}, timeoutMs = 15000) {
@@ -69,7 +69,7 @@ async function fetchWithTimeout(input, init = {}, timeoutMs = 15000) {
     try {
         const response = await fetch(input, {
             ...init,
-            signal: controller.signal,
+            signal: controller.signal
         });
         return response;
     }
@@ -81,14 +81,14 @@ const createMosipInteropClient = (url, authorizationHeader) => {
     return {
         register: async (payload) => {
             const parsedPayload = exports.MosipInteropPayloadSchema.parse(payload);
-            const MOSIP_API_REGISTRATION_EVENT_URL = new URL("./events/registration", url).href;
+            const MOSIP_API_REGISTRATION_EVENT_URL = new URL('./events/registration', url).href;
             const response = await fetchWithTimeout(MOSIP_API_REGISTRATION_EVENT_URL, {
-                method: "POST",
+                method: 'POST',
                 body: JSON.stringify(parsedPayload),
                 headers: {
                     Authorization: authorizationHeader,
-                    "content-type": "application/json",
-                },
+                    'content-type': 'application/json'
+                }
             });
             if (!response.ok) {
                 throw new Error(`Failed to register event: ${await response.text()}`);
@@ -97,14 +97,14 @@ const createMosipInteropClient = (url, authorizationHeader) => {
         },
         updateBiographics: async (payload) => {
             const parsedPayload = exports.MosipCorrectionPayloadSchema.parse(payload);
-            const MOSIP_API_CORRECTION_EVENT_URL = new URL("./events/update-biographics", url).href;
+            const MOSIP_API_CORRECTION_EVENT_URL = new URL('./events/update-biographics', url).href;
             const response = await fetchWithTimeout(MOSIP_API_CORRECTION_EVENT_URL, {
-                method: "POST",
+                method: 'POST',
                 body: JSON.stringify(parsedPayload),
                 headers: {
                     Authorization: authorizationHeader,
-                    "content-type": "application/json",
-                },
+                    'content-type': 'application/json'
+                }
             });
             if (!response.ok) {
                 throw new Error(`Failed to update biographics: ${await response.text()}`);
@@ -113,20 +113,20 @@ const createMosipInteropClient = (url, authorizationHeader) => {
         },
         verifyNid: async (payload) => {
             const parsedPayload = exports.VerifyNidPayloadSchema.parse(payload);
-            const MOSIP_API_VERIFY_URL = new URL("./verify", url).href;
+            const MOSIP_API_VERIFY_URL = new URL('./verify', url).href;
             const response = await fetchWithTimeout(MOSIP_API_VERIFY_URL, {
-                method: "POST",
+                method: 'POST',
                 body: JSON.stringify(parsedPayload),
                 headers: {
                     Authorization: authorizationHeader,
-                    "content-type": "application/json",
-                },
+                    'content-type': 'application/json'
+                }
             });
             if (!response.ok) {
                 throw new Error(`Failed to verify: ${await response.text()}`);
             }
             return exports.VerifyNidResponseSchema.parse(await response.text());
-        },
+        }
     };
 };
 exports.createMosipInteropClient = createMosipInteropClient;

package/build/index.d.ts

@@ -1 +1 @@
-export * from "./api";
+export * from './api';

package/build/index.js

@@ -14,4 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
 __exportStar(require("./api"), exports);

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "2.0.0",
+  "version": "2.1.0-rc.65b5bdf",
+  "description": "Helpers for wiring an OpenCRVS country configuration to the MOSIP integration API",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/opencrvs/opencrvs-core.git"
+  },
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {
@@ -8,20 +13,30 @@
     "./api": "./build/api.js"
   },
   "typings": "build/index.d.ts",
+  "engines": {
+    "node": "22.x.x"
+  },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test:compilation": "tsc --noEmit"
   },
   "dependencies": {
-    "zod": "^4.1.12"
+    "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@opencrvs/toolkit": "1.9.12-rc.1b9bbf4",
+    "@opencrvs/toolkit": "workspace:*",
     "@types/hapi__hapi": "^20.0.0",
     "@types/node-fetch": "^2.6.11",
-    "node-fetch": "2.6.7",
-    "typescript": "^5.6.3"
+    "node-fetch": "2.6.7"
   },
   "peerDependencies": {
     "node-fetch": "2.6.7"
-  }
+  },
+  "keywords": [],
+  "author": "",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/opencrvs/opencrvs-core/issues"
+  },
+  "homepage": "https://github.com/opencrvs/opencrvs-core#readme"
 }

package/src/api.ts

@@ -1,15 +1,25 @@
-import type { FieldValue } from "@opencrvs/toolkit/events";
-import { z } from "zod";
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+import type { FieldValue } from '@opencrvs/toolkit/events'
+import { z } from 'zod'
 
 export const BirthRequestFieldsSchema = z.looseObject({
   birthCertificateNumber: z.string(),
-  deathCertificateNumber: z.undefined().optional(),
-});
+  deathCertificateNumber: z.undefined().optional()
+})
 
 export const DeathRequestFieldsSchema = z.looseObject({
   deathCertificateNumber: z.string(),
-  birthCertificateNumber: z.undefined().optional(),
-});
+  birthCertificateNumber: z.undefined().optional()
+})
 
 export const CorrectionRequestFieldsSchema = z.looseObject({
   VID: z.string(),
@@ -18,14 +28,14 @@ export const CorrectionRequestFieldsSchema = z.looseObject({
   gender: z.string().optional(),
   introducerInfoToken: z.string().optional(),
   birthCertificateNumber: z.undefined().optional(),
-  deathCertificateNumber: z.undefined().optional(),
-});
+  deathCertificateNumber: z.undefined().optional()
+})
 
 export const MosipNotificationSchema = z.object({
   recipientFullName: z.string(),
   recipientEmail: z.string(),
-  recipientPhone: z.string(),
-});
+  recipientPhone: z.string()
+})
 
 export const MosipInteropPayloadSchema = z.object({
   trackingId: z.string(),
@@ -33,12 +43,12 @@ export const MosipInteropPayloadSchema = z.object({
   requestFields: z.union([
     BirthRequestFieldsSchema,
     DeathRequestFieldsSchema,
-    CorrectionRequestFieldsSchema,
+    CorrectionRequestFieldsSchema
   ]),
   schemaJson: z.string().optional(),
   metaInfo: z.record(z.string(), z.unknown()),
-  audit: z.record(z.string(), z.unknown()),
-});
+  audit: z.record(z.string(), z.unknown())
+})
 
 export const MosipCorrectionPayloadSchema = z.object({
   trackingId: z.string(),
@@ -48,140 +58,141 @@ export const MosipCorrectionPayloadSchema = z.object({
     fullName: z.string().optional(),
     dateOfBirth: z.string().optional(),
     gender: z.string().optional(),
-    introducerInfoToken: z.string().optional(),
+    introducerInfoToken: z.string().optional()
   }),
   schemaJson: z.string().optional(),
   metaInfo: z.record(z.string(), z.unknown()),
-  audit: z.record(z.string(), z.unknown()),
-});
+  audit: z.record(z.string(), z.unknown())
+})
 
-const FieldValueSchema = z.custom<FieldValue>(() => true);
+const FieldValueSchema = z.custom<FieldValue>(() => true)
 
 export const VerifyNidPayloadSchema = z.object({
   nid: FieldValueSchema,
   gender: FieldValueSchema.optional(),
   dob: FieldValueSchema,
   name: FieldValueSchema,
-  transactionId: z.string().optional(),
-});
+  transactionId: z.string().optional()
+})
 
 export const VerifyNidResponseSchema = z.union([
-  z.literal("verified"),
-  z.literal("failed"),
-]);
-
-export const RegistrationEventResponseSchema = z.record(
-  z.string(),
-  z.unknown(),
-);
-
-export type BirthRequestFields = z.infer<typeof BirthRequestFieldsSchema>;
-export type DeathRequestFields = z.infer<typeof DeathRequestFieldsSchema>;
-export type CorrectionRequestFields = z.infer<typeof CorrectionRequestFieldsSchema>;
-export type MosipInteropPayload = z.infer<typeof MosipInteropPayloadSchema>;
-export type MosipCorrectionPayload = z.infer<typeof MosipCorrectionPayloadSchema>;
-export type VerifyNidPayload = z.infer<typeof VerifyNidPayloadSchema>;
-export type VerifyNidResponse = z.infer<typeof VerifyNidResponseSchema>;
+  z.literal('verified'),
+  z.literal('failed')
+])
+
+export const RegistrationEventResponseSchema = z.record(z.string(), z.unknown())
+
+export type BirthRequestFields = z.infer<typeof BirthRequestFieldsSchema>
+export type DeathRequestFields = z.infer<typeof DeathRequestFieldsSchema>
+export type CorrectionRequestFields = z.infer<
+  typeof CorrectionRequestFieldsSchema
+>
+export type MosipInteropPayload = z.infer<typeof MosipInteropPayloadSchema>
+export type MosipCorrectionPayload = z.infer<
+  typeof MosipCorrectionPayloadSchema
+>
+export type VerifyNidPayload = z.infer<typeof VerifyNidPayloadSchema>
+export type VerifyNidResponse = z.infer<typeof VerifyNidResponseSchema>
 
 export interface VerificationStatus {
-  father: boolean;
-  mother: boolean;
-  informant: boolean;
-  deceased: boolean;
-  spouse: boolean;
+  father: boolean
+  mother: boolean
+  informant: boolean
+  deceased: boolean
+  spouse: boolean
 }
 
 async function fetchWithTimeout(
   input: RequestInfo,
   init: RequestInit = {},
-  timeoutMs = 15000,
+  timeoutMs = 15000
 ): Promise<Response> {
-  const controller = new AbortController();
-  const timeout = setTimeout(() => controller.abort(), timeoutMs);
+  const controller = new AbortController()
+  const timeout = setTimeout(() => controller.abort(), timeoutMs)
 
   try {
     const response = await fetch(input, {
       ...init,
-      signal: controller.signal,
-    });
-    return response;
+      signal: controller.signal
+    })
+    return response
   } finally {
-    clearTimeout(timeout);
+    clearTimeout(timeout)
   }
 }
 
 export const createMosipInteropClient = (
   url: string,
-  authorizationHeader: string,
+  authorizationHeader: string
 ) => {
   return {
     register: async (payload: MosipInteropPayload) => {
-      const parsedPayload = MosipInteropPayloadSchema.parse(payload);
+      const parsedPayload = MosipInteropPayloadSchema.parse(payload)
       const MOSIP_API_REGISTRATION_EVENT_URL = new URL(
-        "./events/registration",
-        url,
-      ).href;
+        './events/registration',
+        url
+      ).href
 
       const response = await fetchWithTimeout(
         MOSIP_API_REGISTRATION_EVENT_URL,
         {
-          method: "POST",
+          method: 'POST',
           body: JSON.stringify(parsedPayload),
           headers: {
             Authorization: authorizationHeader,
-            "content-type": "application/json",
-          },
-        },
-      );
+            'content-type': 'application/json'
+          }
+        }
+      )
 
       if (!response.ok) {
-        throw new Error(`Failed to register event: ${await response.text()}`);
+        throw new Error(`Failed to register event: ${await response.text()}`)
       }
 
-      return RegistrationEventResponseSchema.parse(await response.json());
+      return RegistrationEventResponseSchema.parse(await response.json())
     },
     updateBiographics: async (payload: MosipCorrectionPayload) => {
-      const parsedPayload = MosipCorrectionPayloadSchema.parse(payload);
+      const parsedPayload = MosipCorrectionPayloadSchema.parse(payload)
       const MOSIP_API_CORRECTION_EVENT_URL = new URL(
-        "./events/update-biographics",
-        url,
-      ).href;
+        './events/update-biographics',
+        url
+      ).href
 
       const response = await fetchWithTimeout(MOSIP_API_CORRECTION_EVENT_URL, {
-        method: "POST",
+        method: 'POST',
         body: JSON.stringify(parsedPayload),
         headers: {
           Authorization: authorizationHeader,
-          "content-type": "application/json",
-        },
-      });
+          'content-type': 'application/json'
+        }
+      })
 
       if (!response.ok) {
         throw new Error(
-          `Failed to update biographics: ${await response.text()}`,
-        );
+          `Failed to update biographics: ${await response.text()}`
+        )
       }
 
-      return RegistrationEventResponseSchema.parse(await response.json());
+      return RegistrationEventResponseSchema.parse(await response.json())
     },
     verifyNid: async (payload: VerifyNidPayload) => {
-      const parsedPayload = VerifyNidPayloadSchema.parse(payload);
-      const MOSIP_API_VERIFY_URL = new URL("./verify", url).href;
+      const parsedPayload = VerifyNidPayloadSchema.parse(payload)
+      const MOSIP_API_VERIFY_URL = new URL('./verify', url).href
 
       const response = await fetchWithTimeout(MOSIP_API_VERIFY_URL, {
-        method: "POST",
+        method: 'POST',
         body: JSON.stringify(parsedPayload),
         headers: {
           Authorization: authorizationHeader,
-          "content-type": "application/json",
-        },
-      });
+          'content-type': 'application/json'
+        }
+      })
 
       if (!response.ok) {
-        throw new Error(`Failed to verify: ${await response.text()}`);
+        throw new Error(`Failed to verify: ${await response.text()}`)
       }
 
-      return VerifyNidResponseSchema.parse(await response.text());
-    },
-  };
-};
+      return VerifyNidResponseSchema.parse(await response.text())
+    }
+  }
+}

package/src/index.ts

@@ -1 +1,11 @@
-export * from "./api";
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * OpenCRVS is also distributed under the terms of the Civil Registration
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
+ *
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
+ */
+export * from './api'

package/tsconfig.json

@@ -6,6 +6,8 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "declaration": true,
-    "outDir": "./build"
-  }
-}
+    "outDir": "./build",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*.ts"]
+}