@opencrvs/mosip 1.9.2-mock.1 → 2.0.0-rc.2

package/build/api.d.ts

@@ -1,31 +1,50 @@
 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;
-}
+import { z } from "zod";
+export declare const BirthRequestFieldsSchema: z.ZodObject<{
+    birthCertificateNumber: z.ZodString;
+    deathCertificateNumber: z.ZodOptional<z.ZodUndefined>;
+}, z.core.$loose>;
+export declare const DeathRequestFieldsSchema: z.ZodObject<{
+    deathCertificateNumber: z.ZodString;
+    birthCertificateNumber: z.ZodOptional<z.ZodUndefined>;
+}, z.core.$loose>;
+export declare const MosipNotificationSchema: z.ZodObject<{
+    recipientFullName: z.ZodString;
+    recipientEmail: z.ZodString;
+    recipientPhone: z.ZodString;
+}, z.core.$strip>;
+export declare const MosipInteropPayloadSchema: z.ZodObject<{
+    trackingId: z.ZodString;
+    notification: z.ZodObject<{
+        recipientFullName: z.ZodString;
+        recipientEmail: z.ZodString;
+        recipientPhone: z.ZodString;
+    }, z.core.$strip>;
+    requestFields: z.ZodUnion<readonly [z.ZodObject<{
+        birthCertificateNumber: z.ZodString;
+        deathCertificateNumber: z.ZodOptional<z.ZodUndefined>;
+    }, z.core.$loose>, z.ZodObject<{
+        deathCertificateNumber: z.ZodString;
+        birthCertificateNumber: z.ZodOptional<z.ZodUndefined>;
+    }, z.core.$loose>]>;
+    schemaJson: z.ZodOptional<z.ZodString>;
+    metaInfo: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    audit: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export declare const VerifyNidPayloadSchema: z.ZodObject<{
+    nid: z.ZodCustom<FieldValue, FieldValue>;
+    gender: z.ZodOptional<z.ZodCustom<FieldValue, FieldValue>>;
+    dob: z.ZodCustom<FieldValue, FieldValue>;
+    name: z.ZodCustom<FieldValue, FieldValue>;
+    transactionId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const VerifyNidResponseSchema: z.ZodUnion<readonly [z.ZodLiteral<"verified">, z.ZodLiteral<"failed">]>;
+export declare const RegistrationEventResponseSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type BirthRequestFields = z.infer<typeof BirthRequestFieldsSchema>;
+export type DeathRequestFields = z.infer<typeof DeathRequestFieldsSchema>;
+export type MosipInteropPayload = z.infer<typeof MosipInteropPayloadSchema>;
+export type VerifyNidPayload = z.infer<typeof VerifyNidPayloadSchema>;
+export type VerifyNidResponse = z.infer<typeof VerifyNidResponseSchema>;
 export interface VerificationStatus {
     father: boolean;
     mother: boolean;
@@ -34,6 +53,6 @@ export interface VerificationStatus {
     spouse: boolean;
 }
 export declare const createMosipInteropClient: (url: string, authorizationHeader: string) => {
-    register: (payload: MosipInteropPayload) => Promise<any>;
-    verifyNid: (payload: VerifyNidPayload) => Promise<"verified" | "failed">;
+    register: (payload: MosipInteropPayload) => Promise<Record<string, unknown>>;
+    verifyNid: (payload: VerifyNidPayload) => Promise<"failed" | "verified">;
 };

package/build/api.js

@@ -1,6 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMosipInteropClient = void 0;
+exports.createMosipInteropClient = exports.RegistrationEventResponseSchema = exports.VerifyNidResponseSchema = exports.VerifyNidPayloadSchema = exports.MosipInteropPayloadSchema = exports.MosipNotificationSchema = exports.DeathRequestFieldsSchema = exports.BirthRequestFieldsSchema = void 0;
+const zod_1 = require("zod");
+exports.BirthRequestFieldsSchema = zod_1.z.looseObject({
+    birthCertificateNumber: zod_1.z.string(),
+    deathCertificateNumber: zod_1.z.undefined().optional(),
+});
+exports.DeathRequestFieldsSchema = zod_1.z.looseObject({
+    deathCertificateNumber: zod_1.z.string(),
+    birthCertificateNumber: 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(),
+});
+exports.MosipInteropPayloadSchema = zod_1.z.object({
+    trackingId: zod_1.z.string(),
+    notification: exports.MosipNotificationSchema,
+    requestFields: zod_1.z.union([exports.BirthRequestFieldsSchema, exports.DeathRequestFieldsSchema]),
+    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()),
+});
+const FieldValueSchema = zod_1.z.custom(() => true);
+exports.VerifyNidPayloadSchema = zod_1.z.object({
+    nid: FieldValueSchema,
+    gender: FieldValueSchema.optional(),
+    dob: FieldValueSchema,
+    name: FieldValueSchema,
+    transactionId: zod_1.z.string().optional(),
+});
+exports.VerifyNidResponseSchema = zod_1.z.union([
+    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) {
     const controller = new AbortController();
     const timeout = setTimeout(() => controller.abort(), timeoutMs);
@@ -18,10 +53,11 @@ async function fetchWithTimeout(input, init = {}, timeoutMs = 15000) {
 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 response = await fetchWithTimeout(MOSIP_API_REGISTRATION_EVENT_URL, {
                 method: "POST",
-                body: JSON.stringify(payload),
+                body: JSON.stringify(parsedPayload),
                 headers: {
                     Authorization: authorizationHeader,
                     "content-type": "application/json",
@@ -30,13 +66,14 @@ const createMosipInteropClient = (url, authorizationHeader) => {
             if (!response.ok) {
                 throw new Error(`Failed to register event: ${await response.text()}`);
             }
-            return response.json();
+            return exports.RegistrationEventResponseSchema.parse(await response.json());
         },
         verifyNid: async (payload) => {
+            const parsedPayload = exports.VerifyNidPayloadSchema.parse(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),
+                body: JSON.stringify(parsedPayload),
                 headers: {
                     Authorization: authorizationHeader,
                     "content-type": "application/json",
@@ -45,7 +82,7 @@ const createMosipInteropClient = (url, authorizationHeader) => {
             if (!response.ok) {
                 throw new Error(`Failed to verify: ${await response.text()}`);
             }
-            return response.text();
+            return exports.VerifyNidResponseSchema.parse(await response.text());
         },
     };
 };

package/build/index.d.ts

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

package/build/index.js

@@ -14,6 +14,4 @@ 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 });
-__exportStar(require("./forms"), exports);
-__exportStar(require("./events"), exports);
-__exportStar(require("./transform"), exports);
+__exportStar(require("./api"), exports);

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@opencrvs/mosip",
-  "version": "1.9.2-mock.1",
+  "version": "2.0.0-rc.2",
   "license": "MPL-2.0",
   "main": "./build/index.js",
   "exports": {
     ".": "./build/index.js",
-    "./forms": "./build/forms.js",
-    "./events": "./build/events.js",
     "./api": "./build/api.js"
   },
   "typings": "build/index.d.ts",
   "scripts": {
     "build": "tsc"
   },
-  "dependencies": {},
+  "dependencies": {
+    "zod": "^4.1.12"
+  },
   "devDependencies": {
-    "@opencrvs/toolkit": "1.8.1-rc.62f6aec",
+    "@opencrvs/toolkit": "1.9.10-rc.9afdb31",
     "@types/hapi__hapi": "^20.0.0",
     "@types/node-fetch": "^2.6.11",
     "node-fetch": "2.6.7",

package/src/api.ts

@@ -1,35 +1,56 @@
-import type { EventDocument, FieldValue } from "@opencrvs/toolkit/events";
+import type { FieldValue } from "@opencrvs/toolkit/events";
+import { z } from "zod";
 
-export interface BirthRequestFields extends Record<string, unknown> {
-  birthCertificateNumber: string;
-  deathCertificateNumber?: undefined;
-}
+export const BirthRequestFieldsSchema = z.looseObject({
+  birthCertificateNumber: z.string(),
+  deathCertificateNumber: z.undefined().optional(),
+});
 
-export interface DeathRequestFields extends Record<string, unknown> {
-  deathCertificateNumber: string;
-  birthCertificateNumber?: undefined;
-}
+export const DeathRequestFieldsSchema = z.looseObject({
+  deathCertificateNumber: z.string(),
+  birthCertificateNumber: z.undefined().optional(),
+});
 
-export interface MosipInteropPayload {
-  trackingId: string;
-  notification: {
-    recipientFullName: string;
-    recipientEmail: string;
-    recipientPhone: string;
-  };
-  requestFields: BirthRequestFields | DeathRequestFields;
-  metaInfo: Record<string, unknown>;
-  audit: Record<string, unknown>;
-}
+export const MosipNotificationSchema = z.object({
+  recipientFullName: z.string(),
+  recipientEmail: z.string(),
+  recipientPhone: z.string(),
+});
 
-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 const MosipInteropPayloadSchema = z.object({
+  trackingId: z.string(),
+  notification: MosipNotificationSchema,
+  requestFields: z.union([BirthRequestFieldsSchema, DeathRequestFieldsSchema]),
+  schemaJson: z.string().optional(),
+  metaInfo: z.record(z.string(), z.unknown()),
+  audit: z.record(z.string(), z.unknown()),
+});
+
+const FieldValueSchema = z.custom<FieldValue>(() => true);
+
+export const VerifyNidPayloadSchema = z.object({
+  nid: FieldValueSchema,
+  gender: FieldValueSchema.optional(),
+  dob: FieldValueSchema,
+  name: FieldValueSchema,
+  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 MosipInteropPayload = z.infer<typeof MosipInteropPayloadSchema>;
+export type VerifyNidPayload = z.infer<typeof VerifyNidPayloadSchema>;
+export type VerifyNidResponse = z.infer<typeof VerifyNidResponseSchema>;
 
 export interface VerificationStatus {
   father: boolean;
@@ -64,6 +85,7 @@ export const createMosipInteropClient = (
 ) => {
   return {
     register: async (payload: MosipInteropPayload) => {
+      const parsedPayload = MosipInteropPayloadSchema.parse(payload);
       const MOSIP_API_REGISTRATION_EVENT_URL = new URL(
         "./events/registration",
         url,
@@ -73,7 +95,7 @@ export const createMosipInteropClient = (
         MOSIP_API_REGISTRATION_EVENT_URL,
         {
           method: "POST",
-          body: JSON.stringify(payload),
+          body: JSON.stringify(parsedPayload),
           headers: {
             Authorization: authorizationHeader,
             "content-type": "application/json",
@@ -85,14 +107,15 @@ export const createMosipInteropClient = (
         throw new Error(`Failed to register event: ${await response.text()}`);
       }
 
-      return 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 response = await fetchWithTimeout(MOSIP_API_VERIFY_URL, {
         method: "POST",
-        body: JSON.stringify(payload),
+        body: JSON.stringify(parsedPayload),
         headers: {
           Authorization: authorizationHeader,
           "content-type": "application/json",
@@ -103,7 +126,7 @@ export const createMosipInteropClient = (
         throw new Error(`Failed to verify: ${await response.text()}`);
       }
 
-      return response.text() as Promise<"verified" | "failed">;
+      return VerifyNidResponseSchema.parse(await response.text());
     },
   };
 };

package/src/index.ts

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

package/build/events.d.ts

@@ -1,30 +0,0 @@
-import type * as Hapi from "@hapi/hapi";
-import { MOSIPPayload } from "./transform";
-import { VerificationStatus } from "./api";
-/**
- * @deprecated
- * Replaces event registration handler in country config
- */
-export declare const mosipRegistrationHandler: ({ url, headers, payload, }: {
-    url: string;
-    headers: Record<string, string>;
-    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 }: {
-    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>>;

package/build/events.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": 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) => {
-    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(payload),
-        headers: {
-            ...headers,
-            "content-type": "application/json",
-        },
-    });
-    if (!response.ok) {
-        return h
-            .response({
-            error: "OpenCRVS-MOSIP event registration route did not return a 200",
-            response: await response.text(),
-        })
-            .code(500);
-    }
-    return h.response({ success: true }).code(200);
-});
-exports.mosipRegistrationHandler = mosipRegistrationHandler;
-/**
- * @deprecated
- * 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;