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

package/src/events.ts

@@ -1,105 +0,0 @@
-import type * as Hapi from "@hapi/hapi";
-import fetch from "node-fetch";
-import { MOSIPPayload } from "./transform";
-import { VerificationStatus } from "./api";
-
-/*
- * 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 = ({
-  url,
-  headers,
-  payload,
-}: {
-  url: string;
-  headers: Record<string, string>;
-  payload: MOSIPPayload;
-}) =>
-  (async (request: Hapi.Request, h: Hapi.ResponseToolkit) => {
-    const MOSIP_API_REGISTRATION_EVENT_URL = new URL(
-      "./events/registration",
-      url,
-    );
-
-    const response = await fetch(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);
-  }) satisfies Hapi.ServerRoute["handler"];
-
-/**
- * @deprecated
- * 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,455 +0,0 @@
-/**
- * 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",
-      },
-    ],
-    mapping: {
-      mutation: {
-        operation: "ignoreFieldTransformer",
-      },
-    },
-    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,
-}: {
-  url: string;
-}) => {
-  return {
-    name: "INFORMANT_AUTHENTICATION_POPUP_BUTTON",
-    type: "POPUP_BUTTON",
-    url,
-  };
-};
-
-/**
- *
- * @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,
-  mapping: {
-    mutation: {
-      operation: "ignoreFieldTransformer",
-    },
-  },
-  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",
-  };
-};
-
-export const idReader = (
-  event: string,
-  sectionId: string,
-  conditionals: any[],
-  readers: any[],
-  /** E-Signet callback field name */
-  esignetCallbackFieldName?: string,
-) => {
-  const fieldName: string = "idReader";
-  const fieldId: string = `${event}.${sectionId}.${sectionId}-view-group.${fieldName}`;
-  const initialValue = esignetCallbackFieldName
-    ? {
-        dependsOn: [esignetCallbackFieldName],
-        expression: "''",
-      }
-    : "";
-  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;
-  };
-  loaderFieldName?: string;
-}
-
-export const verified = (
-  event: string,
-  sectionId: string,
-  mapping: any,
-  esignetConfig?: ESignetConfig,
-) => {
-  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: esignetConfig
-      ? {
-          dependsOn: ["idReader", esignetConfig.callback.fieldName],
-          expression: `Boolean($form?.idReader)? "pending"
-          : Boolean($form?.${esignetConfig.callback.fieldName}?.data)? "authenticated"
-          : Boolean($form?.${esignetConfig.callback.fieldName}?.error)? "failedFetchIdDetails"
-          : ""`,
-        }
-      : {
-          dependsOn: ["idReader"],
-          expression: 'Boolean($form?.idReader)? "pending":""',
-        },
-    validator: [],
-    mapping,
-  };
-};
-
-function capitalize(str: string) {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}
-
-type VerificationStatus =
-  | "verified"
-  | "failed"
-  | "authenticated"
-  | "failedFetchIdDetails";
-
-export const idVerificationBanner = (
-  event: string,
-  sectionId: string,
-  status: VerificationStatus,
-  conditionals: any[] = [],
-) => {
-  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:
-      status === "authenticated" || "failedFetchIdDetails"
-        ? "esignetCallback"
-        : "idReader",
-    label: {
-      id: "form.field.label.empty",
-      defaultMessage: "",
-    },
-    validator: [],
-    conditionals: conditionals.concat([
-      {
-        action: "hide",
-        expression: `$form?.verified !== "${status}"`,
-      },
-    ]),
-  };
-};
-
-export function esignetLoaderField({
-  event,
-  section,
-  fieldName,
-  esignetCallbackFieldName,
-}: {
-  event: "birth" | "death";
-  section: "informant" | "mother" | "father" | "spouse" | "deceased";
-  fieldName: string;
-  esignetCallbackFieldName: string;
-}) {
-  const fieldId = `${event}.${section}.${section}-view-group.${fieldName}`;
-  return {
-    name: fieldName,
-    type: "LOADER",
-    fieldId,
-    hideInPreview: true,
-    custom: true,
-    label: {
-      id: "form.field.label.idReader",
-      defaultMessage: "ID verification",
-    },
-    loadingText: {
-      id: "form.field.label.authenticating.nid",
-      defaultMessage: "Fetching the person's data from E-Signet",
-    },
-    conditionals: [
-      {
-        action: "hide",
-        expression: `!$form?.${esignetCallbackFieldName}?.loading`,
-      },
-    ],
-  };
-}
-
-export const getInitialValueFromIDReader = (fieldNameInReader: string) => ({
-  dependsOn: ["idReader", "esignetCallback"],
-  expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
-});
-
-// Define a type def so that a country implementor cannot
-// provide both QR and E-Signet config undefined at the same time
-type IDReaderParams = {
-  (
-    event: "birth" | "death",
-    section: "informant" | "mother" | "father" | "spouse" | "deceased",
-    qrConfig: QRConfig,
-    esignetConfig: ESignetConfig,
-    verifiedCustomFieldMapping: any,
-    conditionals?: any[],
-  ): any[];
-  (
-    event: "birth" | "death",
-    section: "informant" | "mother" | "father" | "spouse" | "deceased",
-    qrConfig: QRConfig,
-    esignetConfig: undefined,
-    verifiedCustomFieldMapping: any,
-    conditionals?: any[],
-  ): any[];
-  (
-    event: "birth" | "death",
-    section: "informant" | "mother" | "father" | "spouse" | "deceased",
-    qrConfig: undefined,
-    esignetConfig: ESignetConfig,
-    verifiedCustomFieldMapping: any,
-    conditionals?: any[],
-  ): any[];
-};
-
-export const idReaderFields: IDReaderParams = (
-  event: "birth" | "death",
-  section: "informant" | "mother" | "father" | "spouse" | "deceased",
-  qrConfig: QRConfig | undefined,
-  esignetConfig: ESignetConfig | undefined,
-  verifiedCustomFieldMapping: any,
-  conditionals: any[] = [],
-) => {
-  const readers: any[] = [];
-  if (qrConfig) {
-    readers.push(qr(qrConfig));
-  }
-  const fields: any[] = [
-    idReader(
-      event,
-      section,
-      conditionals.concat({
-        action: "hide",
-        expression:
-          "$form?.verified === 'verified' || $form?.verified === 'authenticated' || $form?.verified === 'failed' || $form?.verified === 'failedFetchIdDetails' || !!$form?.esignetCallback?.loading",
-      }),
-      readers,
-      esignetConfig?.callback.fieldName,
-    ),
-  ];
-  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,
-      }),
-    );
-    if (esignetConfig.loaderFieldName) {
-      fields.push(
-        esignetLoaderField({
-          event,
-          section,
-          fieldName: esignetConfig.loaderFieldName,
-          esignetCallbackFieldName: esignetConfig.callback.fieldName,
-        }),
-      );
-    }
-    return [
-      ...fields,
-      ...idVerificationFields(
-        event,
-        section,
-        verifiedCustomFieldMapping,
-        conditionals,
-        esignetConfig,
-      ),
-    ];
-  }
-  return [
-    ...fields,
-    ...idVerificationFields(
-      event,
-      section,
-      verifiedCustomFieldMapping,
-      conditionals,
-    ),
-  ];
-};
-export const idVerificationFields = (
-  event: string,
-  sectionId: string,
-  mapping: any,
-  conditionals: any[] = [],
-  esignetConfig?: ESignetConfig,
-) => {
-  return [
-    verified(event, sectionId, mapping, esignetConfig),
-    idVerificationBanner(event, sectionId, "verified", conditionals),
-    idVerificationBanner(event, sectionId, "failed", conditionals),
-    idVerificationBanner(event, sectionId, "authenticated", conditionals),
-    idVerificationBanner(
-      event,
-      sectionId,
-      "failedFetchIdDetails",
-      conditionals,
-    ),
-  ];
-};

package/src/transform.ts

@@ -1,100 +0,0 @@
-type IdentityInfo = { value: string; language: string };
-
-export interface MOSIPPayload {
-  compositionId: string;
-  trackingId: string;
-  notification: {
-    recipientFullName: string;
-    recipientEmail: string;
-    recipientPhone: string;
-  };
-  requestFields: {
-    fullName: string;
-    dateOfBirth: string;
-    gender: string;
-    guardianOrParentName: string;
-    nationalIdNumber: string;
-    passportNumber: string;
-    drivingLicenseNumber: string;
-    deceasedStatus: boolean;
-    residenceStatus: string;
-    vid: string;
-    email: string;
-    phone: string;
-    guardianOrParentBirthCertificateNumber: string;
-    deathCertificateNumber: string;
-    birthCertificateNumber: string;
-    addressLine1: string;
-    addressLine2: string;
-    addressLine3: string;
-    district: string;
-    village: string;
-    birthRegistrationCertificate: string;
-    passportId: string;
-    nationalId: string;
-    drivingLicenseId: string;
-    addressProof: string;
-    selectedHandles: string;
-    UIN: string;
-    deathDeclared: string;
-    dateOfDeath: string;
-  };
-  metaInfo: {
-    metaData: string;
-    registrationId: string;
-    operationsData: string;
-    capturedRegisteredDevices: string;
-    creationDate: string;
-  };
-  audit: {
-    uuid: string;
-    createdAt: string;
-    eventId: string;
-    eventName: string;
-    eventType: string;
-    hostName: string;
-    hostIp: string;
-    applicationId: string;
-    applicationName: string;
-    sessionUserId: string;
-    sessionUserName: string;
-    id: string;
-    idType: string;
-    createdBy: string;
-    moduleName: string;
-    moduleId: string;
-    description: string;
-    actionTimeStamp: string;
-  };
-}
-
-type Resolver<T> = (bundle: fhir3.Bundle) => T;
-
-type ResolverMap<T> = {
-  [K in keyof T]?: T[K] extends IdentityInfo[] | string | boolean | number
-    ? Resolver<T[K]>
-    : ResolverMap<T[K]>;
-};
-
-export function fhirBundleToMOSIPPayload(
-  bundle: fhir3.Bundle,
-  resolverMap: ResolverMap<MOSIPPayload>,
-): MOSIPPayload {
-  const assignResolvers = <T extends object>(resolvers: ResolverMap<T>): T => {
-    const result = {} as T;
-
-    for (const key in resolvers) {
-      const resolver = resolvers[key];
-
-      if (typeof resolver === "function") {
-        result[key] = resolver(bundle);
-      } else if (resolver && typeof resolver === "object") {
-        result[key] = assignResolvers(resolver) as T[Extract<keyof T, string>];
-      }
-    }
-
-    return result;
-  };
-
-  return assignResolvers(resolverMap);
-}