@opencrvs/mosip 1.9.1 → 2.0.0-rc.1

package/build/forms.d.ts

@@ -1,253 +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 declare const esignet: (esignetAuthUrl: string, openIdProviderClientId: string, openIdProviderClaims: string | undefined, 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;
-    }[];
-    mapping: {
-        mutation: {
-            operation: string;
-        };
-    };
-    options: {
-        url: string;
-        callback: {
-            params: {
-                state: string;
-            };
-            trigger: string;
-        };
-    };
-};
-export declare const popupButton: ({ url, }: {
-    url: string;
-}) => {
-    name: string;
-    type: string;
-    url: string;
-};
-/**
- *
- * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
- *
- */
-export declare const esignetCallback: ({ fieldName, mosipAPIUserInfoUrl, openIdProviderClientId, }: {
-    fieldName: string;
-    mosipAPIUserInfoUrl: string;
-    openIdProviderClientId: string;
-}) => {
-    name: string;
-    type: string;
-    custom: boolean;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    validator: never[];
-    hideInPreview: boolean;
-    mapping: {
-        mutation: {
-            operation: string;
-        };
-    };
-    options: {
-        url: string;
-        headers: {
-            "Content-type": string;
-        };
-        body: {
-            clientId: string;
-            redirectUri: string;
-        };
-        method: string;
-    };
-};
-export declare const esignetHidden: () => {
-    name: string;
-    type: string;
-};
-export declare const idReader: (event: string, sectionId: string, conditionals: any[], readers: any[], esignetCallbackFieldName?: string) => {
-    name: string;
-    customQuestionMappingId: string;
-    custom: boolean;
-    required: boolean;
-    type: string;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    hideInPreview: boolean;
-    initialValue: string | {
-        dependsOn: string[];
-        expression: string;
-    };
-    validator: never[];
-    conditionals: any[];
-    dividerLabel: {
-        id: string;
-        defaultMessage: string;
-    };
-    manualInputInstructionLabel: {
-        id: string;
-        defaultMessage: string;
-    };
-    mapping: {
-        mutation: {
-            operation: string;
-        };
-    };
-    readers: any[];
-};
-type MessageDescriptor = {
-    id: string;
-    defaultMessage: string;
-    description?: string;
-};
-interface QRValidation {
-    rule: Record<string, unknown>;
-    errorMessage: MessageDescriptor;
-}
-interface QRConfig {
-    validation: QRValidation;
-}
-export declare const qr: ({ validation }: QRConfig) => {
-    type: string;
-    validation: QRValidation;
-};
-interface ESignetConfig {
-    esignetAuthUrl: string;
-    openIdProviderClientId: string;
-    openIdProviderClaims: string | undefined;
-    fieldName: string;
-    callback: {
-        fieldName: string;
-        mosipAPIUserInfoUrl: string;
-    };
-    loaderFieldName?: string;
-}
-export declare const verified: (event: string, sectionId: string, mapping: any, esignetConfig?: ESignetConfig) => {
-    name: string;
-    fieldId: string;
-    customQuestionMappingId: string;
-    type: string;
-    custom: boolean;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    initialValue: {
-        dependsOn: string[];
-        expression: string;
-    };
-    validator: never[];
-    mapping: any;
-};
-type VerificationStatus = "verified" | "failed" | "authenticated" | "failedFetchIdDetails";
-export declare const idVerificationBanner: (event: string, sectionId: string, status: VerificationStatus, conditionals?: any[]) => {
-    name: string;
-    type: string;
-    fieldId: string;
-    hideInPreview: boolean;
-    custom: boolean;
-    bannerType: VerificationStatus;
-    idFieldName: string;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    validator: never[];
-    conditionals: any[];
-};
-export declare function esignetLoaderField({ event, section, fieldName, esignetCallbackFieldName, }: {
-    event: "birth" | "death";
-    section: "informant" | "mother" | "father" | "spouse" | "deceased";
-    fieldName: string;
-    esignetCallbackFieldName: string;
-}): {
-    name: string;
-    type: string;
-    fieldId: string;
-    hideInPreview: boolean;
-    custom: boolean;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    loadingText: {
-        id: string;
-        defaultMessage: string;
-    };
-    conditionals: {
-        action: string;
-        expression: string;
-    }[];
-};
-export declare const getInitialValueFromIDReader: (fieldNameInReader: string) => {
-    dependsOn: string[];
-    expression: string;
-};
-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 declare const idReaderFields: IDReaderParams;
-export declare const idVerificationFields: (event: string, sectionId: string, mapping: any, conditionals?: any[], esignetConfig?: ESignetConfig) => ({
-    name: string;
-    fieldId: string;
-    customQuestionMappingId: string;
-    type: string;
-    custom: boolean;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    initialValue: {
-        dependsOn: string[];
-        expression: string;
-    };
-    validator: never[];
-    mapping: any;
-} | {
-    name: string;
-    type: string;
-    fieldId: string;
-    hideInPreview: boolean;
-    custom: boolean;
-    bannerType: VerificationStatus;
-    idFieldName: string;
-    label: {
-        id: string;
-        defaultMessage: string;
-    };
-    validator: never[];
-    conditionals: any[];
-})[];
-export {};

package/build/forms.js

@@ -1,298 +0,0 @@
-"use strict";
-/**
- * E-Signet popup button and hidden field form definitions
- * @example
- * ```
- * [
- *   // ...other fields
- *   ...esignet({ url: "https://opencrvs-mosip-gateway.farajaland.opencrvs.org" })
- * ]
- * ```
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.idVerificationFields = exports.idReaderFields = exports.getInitialValueFromIDReader = exports.idVerificationBanner = exports.verified = exports.qr = exports.idReader = exports.esignetHidden = exports.esignetCallback = exports.popupButton = exports.esignet = void 0;
-exports.esignetLoaderField = esignetLoaderField;
-/**
- *
- * @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 = "name,family_name,given_name,middle_name,birthdate,address", 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);
-    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,
-            },
-        },
-    };
-};
-exports.esignet = esignet;
-const popupButton = ({ 
-/** URL to OpenCRVS-MOSIP gateway (e.g. https://opencrvs-mosip-gateway.farajaland.opencrvs.org) */
-url, }) => {
-    return {
-        name: "INFORMANT_AUTHENTICATION_POPUP_BUTTON",
-        type: "POPUP_BUTTON",
-        url,
-    };
-};
-exports.popupButton = popupButton;
-/**
- *
- * @description esignet callback button form definition.  Calls https://mosip-api.{{hostname}}/esignet/get-oidp-user-info
- *
- */
-const esignetCallback = ({ fieldName, mosipAPIUserInfoUrl, openIdProviderClientId, }) => ({
-    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",
-    },
-});
-exports.esignetCallback = esignetCallback;
-const esignetHidden = () => {
-    return {
-        name: "INFORMANT_PSUT_TOKEN",
-        type: "HIDDEN",
-    };
-};
-exports.esignetHidden = esignetHidden;
-const idReader = (event, sectionId, conditionals, readers, 
-/** E-Signet callback field name */
-esignetCallbackFieldName) => {
-    const fieldName = "idReader";
-    const fieldId = `${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,
-    };
-};
-exports.idReader = idReader;
-const qr = ({ validation }) => ({
-    type: "QR",
-    validation,
-});
-exports.qr = qr;
-const verified = (event, sectionId, mapping, 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,
-    };
-};
-exports.verified = verified;
-function capitalize(str) {
-    return str.charAt(0).toUpperCase() + str.slice(1);
-}
-const idVerificationBanner = (event, sectionId, status, conditionals = []) => {
-    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}"`,
-            },
-        ]),
-    };
-};
-exports.idVerificationBanner = idVerificationBanner;
-function esignetLoaderField({ event, section, fieldName, esignetCallbackFieldName, }) {
-    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`,
-            },
-        ],
-    };
-}
-const getInitialValueFromIDReader = (fieldNameInReader) => ({
-    dependsOn: ["idReader", "esignetCallback"],
-    expression: `$form?.idReader?.${fieldNameInReader} || $form?.esignetCallback?.data?.${fieldNameInReader} || ""`,
-});
-exports.getInitialValueFromIDReader = getInitialValueFromIDReader;
-const idReaderFields = (event, section, qrConfig, esignetConfig, verifiedCustomFieldMapping, conditionals = []) => {
-    const readers = [];
-    if (qrConfig) {
-        readers.push((0, exports.qr)(qrConfig));
-    }
-    const fields = [
-        (0, exports.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((0, exports.esignet)(esignetConfig.esignetAuthUrl, esignetConfig.openIdProviderClientId, esignetConfig.openIdProviderClaims, esignetConfig.fieldName, esignetConfig.callback.fieldName));
-        fields.push((0, exports.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,
-            ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping, conditionals, esignetConfig),
-        ];
-    }
-    return [
-        ...fields,
-        ...(0, exports.idVerificationFields)(event, section, verifiedCustomFieldMapping, conditionals),
-    ];
-};
-exports.idReaderFields = idReaderFields;
-const idVerificationFields = (event, sectionId, mapping, conditionals = [], esignetConfig) => {
-    return [
-        (0, exports.verified)(event, sectionId, mapping, esignetConfig),
-        (0, exports.idVerificationBanner)(event, sectionId, "verified", conditionals),
-        (0, exports.idVerificationBanner)(event, sectionId, "failed", conditionals),
-        (0, exports.idVerificationBanner)(event, sectionId, "authenticated", conditionals),
-        (0, exports.idVerificationBanner)(event, sectionId, "failedFetchIdDetails", conditionals),
-    ];
-};
-exports.idVerificationFields = idVerificationFields;

package/build/transform.d.ts

@@ -1,77 +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 declare function fhirBundleToMOSIPPayload(bundle: fhir3.Bundle, resolverMap: ResolverMap<MOSIPPayload>): MOSIPPayload;
-export {};

package/build/transform.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fhirBundleToMOSIPPayload = fhirBundleToMOSIPPayload;
-function fhirBundleToMOSIPPayload(bundle, resolverMap) {
-    const assignResolvers = (resolvers) => {
-        const result = {};
-        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);
-            }
-        }
-        return result;
-    };
-    return assignResolvers(resolverMap);
-}