@olaboot/esm-form-engine-lib 4.1.0

package/dist/adapters/encounter-diagnosis-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encounter-diagnosis-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/encounter-diagnosis-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAEL,KAAK,qBAAqB,EAI3B,MAAM,UAAU,CAAC;AAMlB,eAAO,IAAI,oBAAoB,EAAE,MAAM,EAAO,CAAC;AAE/C,eAAO,MAAM,yBAAyB,EAAE,qBAyDvC,CAAC;AAuCF,wBAAgB,gCAAgC,CAAC,iBAAiB,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,WAKpG;AAED,wBAAgB,aAAa,CAAC,SAAS,EAAE,eAAe;;;EAEvD"}

package/dist/adapters/encounter-diagnosis-adapter.js

@@ -0,0 +1,89 @@
+import { gracefullySetSubmission } from "../utils/common-utils.js";
+import { isEmpty } from "../validators/form-validator.js";
+import { isTrue } from "../utils/boolean-utils.js";
+export let assignedDiagnosesIds = [];
+export const EncounterDiagnosisAdapter = {
+    transformFieldValue: function(field, value, context) {
+        if (field.meta.initialValue?.omrsObject && isEmpty(value)) {
+            return gracefullySetSubmission(field, undefined, voidDiagnosis(field.meta.initialValue.omrsObject));
+        }
+        if (!isEmpty(value)) {
+            const previousDiagnosis = field.meta.initialValue?.omrsObject;
+            if (hasPreviousDiagnosisValueChanged(previousDiagnosis, value)) {
+                return gracefullySetSubmission(field, editDiagnosis(value, field, previousDiagnosis, context.patient.id), undefined);
+            }
+        }
+        const newValue = constructNewDiagnosis(value, field, context.patient.id);
+        gracefullySetSubmission(field, newValue, null);
+        return newValue;
+    },
+    getInitialValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.domainObjectValue;
+        const matchedDiagnosis = encounter.diagnoses.find((diagnosis)=>diagnosis.formFieldPath === `rfe-forms-${field.id}`);
+        if (matchedDiagnosis) {
+            field.meta = {
+                ...field.meta || {},
+                initialValue: {
+                    omrsObject: matchedDiagnosis,
+                    refinedValue: matchedDiagnosis.diagnosis?.coded.uuid
+                }
+            };
+            if (!assignedDiagnosesIds.includes(matchedDiagnosis.diagnosis?.coded?.uuid)) {
+                assignedDiagnosesIds.push(matchedDiagnosis.diagnosis?.coded?.uuid);
+            }
+            return matchedDiagnosis.diagnosis?.coded.uuid;
+        }
+        return null;
+    },
+    getPreviousValue: function(field, sourceObject, context) {
+        return null;
+    },
+    getDisplayValue: (field, value)=>{
+        return field.questionOptions.answers?.find((option)=>option.concept == value)?.label || value;
+    },
+    tearDown: function() {
+        assignedDiagnosesIds = [];
+    }
+};
+const constructNewDiagnosis = (value, field, patientUuid)=>{
+    if (!value) {
+        return null;
+    }
+    return {
+        patient: patientUuid,
+        condition: null,
+        diagnosis: {
+            coded: value
+        },
+        certainty: isTrue(field.questionOptions?.diagnosis?.isConfirmed) ? 'CONFIRMED' : 'PROVISIONAL',
+        rank: field.questionOptions.diagnosis?.rank ?? 1,
+        formFieldPath: `rfe-forms-${field.id}`,
+        formFieldNamespace: 'rfe-forms'
+    };
+};
+function editDiagnosis(newEncounterDiagnosis, field, previousDiagnosis, patientUuid) {
+    return {
+        patient: patientUuid,
+        condition: null,
+        diagnosis: {
+            coded: newEncounterDiagnosis
+        },
+        certainty: isTrue(field.questionOptions?.diagnosis?.isConfirmed) ? 'CONFIRMED' : 'PROVISIONAL',
+        rank: field.questionOptions.diagnosis?.rank ?? 1,
+        formFieldPath: `rfe-forms-${field.id}`,
+        formFieldNamespace: 'rfe-forms',
+        uuid: previousDiagnosis.uuid
+    };
+}
+export function hasPreviousDiagnosisValueChanged(previousDiagnosis, newValue) {
+    if (isEmpty(previousDiagnosis)) {
+        return false;
+    }
+    return previousDiagnosis.value !== newValue;
+}
+export function voidDiagnosis(diagnosis) {
+    return {
+        uuid: diagnosis.uuid,
+        voided: true
+    };
+}

package/dist/adapters/encounter-diagnosis-adapter.test.js

@@ -0,0 +1,217 @@
+import { EncounterDiagnosisAdapter } from "./encounter-diagnosis-adapter.js";
+const formContext = {
+    methods: null,
+    workspaceLayout: 'maximized',
+    isSubmitting: false,
+    patient: {
+        id: '833db896-c1f0-11eb-8529-0242ac130003'
+    },
+    formJson: null,
+    visit: null,
+    sessionMode: 'enter',
+    sessionDate: new Date(),
+    location: {
+        uuid: '41e6e516-c1f0-11eb-8529-0242ac130003'
+    },
+    currentProvider: null,
+    layoutType: 'small-desktop',
+    domainObjectValue: {
+        uuid: '873455da-3ec4-453c-b565-7c1fe35426be',
+        obs: [],
+        diagnoses: []
+    },
+    previousDomainObjectValue: null,
+    processor: null,
+    formFields: [],
+    formFieldAdapters: null,
+    formFieldValidators: null,
+    customDependencies: {
+        patientPrograms: []
+    },
+    deletedFields: [],
+    getFormField: jest.fn(),
+    addFormField: jest.fn(),
+    updateFormField: jest.fn(),
+    removeFormField: ()=>{},
+    addInvalidField: jest.fn(),
+    removeInvalidField: jest.fn(),
+    setInvalidFields: jest.fn(),
+    setForm: jest.fn(),
+    setDeletedFields: jest.fn()
+};
+const field = {
+    label: 'Test Diagnosis',
+    id: 'DiagNosIS',
+    type: 'diagnosis',
+    questionOptions: {
+        rendering: 'repeating',
+        diagnosis: {
+            rank: 1,
+            isConfirmed: false
+        },
+        datasource: {
+            name: 'problem_datasource',
+            config: {
+                class: [
+                    '8d4918b0-c2cc-11de-8d13-0010c6dffd0f',
+                    '8d492954-c2cc-11de-8d13-0010c6dffd0f',
+                    '8d492b2a-c2cc-11de-8d13-0010c6dffd0f'
+                ]
+            }
+        }
+    },
+    meta: {
+        submission: {
+            newValue: null
+        },
+        previousValue: null
+    },
+    validators: [
+        {
+            type: 'form_field'
+        },
+        {
+            type: 'default_value'
+        }
+    ],
+    isHidden: false,
+    isRequired: false,
+    isDisabled: false
+};
+const diagnoses = [
+    {
+        uuid: '8d975f9e-e9e6-452f-be7c-0e87c047f056',
+        diagnosis: {
+            coded: {
+                uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                display: 'Schistosoma Mansonii Infection',
+                links: []
+            }
+        },
+        condition: null,
+        encounter: {
+            uuid: '9a4b06bd-d655-414f-b9ce-69e940c337ce'
+        },
+        certainty: 'CONFIRMED',
+        rank: 1,
+        voided: false,
+        display: 'Schistosoma Mansonii Infection',
+        patient: {
+            uuid: '00affa97-0010-417c-87f5-de48362de915',
+            display: '1000VKV - Bett Tett'
+        },
+        formFieldNamespace: 'rfe-forms',
+        formFieldPath: 'rfe-forms-DiagNosIS_1',
+        links: [],
+        resourceVersion: '1.8'
+    },
+    {
+        uuid: 'b2d0e95b-d2f6-49d1-a477-acc7026edbd7',
+        diagnosis: {
+            coded: {
+                uuid: '137329AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                display: 'Infection due to Entamoeba Histolytica',
+                links: []
+            }
+        },
+        condition: null,
+        encounter: {
+            uuid: '9a4b06bd-d655-414f-b9ce-69e940c337ce'
+        },
+        certainty: 'PROVISIONAL',
+        rank: 1,
+        voided: false,
+        display: 'Infection due to Entamoeba Histolytica',
+        patient: {
+            uuid: '00affa97-0010-417c-87f5-de48362de915',
+            display: '1000VKV - Bett Tett'
+        },
+        formFieldNamespace: 'rfe-forms',
+        formFieldPath: 'rfe-forms-DiagNosIS',
+        links: [],
+        resourceVersion: '1.8'
+    }
+];
+describe('EncounterDiagnosisAdapter', ()=>{
+    it('should should handle submission of a diagnosis field', async ()=>{
+        const value = '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
+        EncounterDiagnosisAdapter.transformFieldValue(field, value, formContext);
+        expect(field.meta.submission.newValue).toEqual({
+            patient: '833db896-c1f0-11eb-8529-0242ac130003',
+            condition: null,
+            diagnosis: {
+                coded: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
+            },
+            certainty: 'PROVISIONAL',
+            rank: 1,
+            formFieldPath: 'rfe-forms-DiagNosIS',
+            formFieldNamespace: 'rfe-forms'
+        });
+    });
+    it('should get initial value for the diagnosis', async ()=>{
+        formContext.domainObjectValue.diagnoses.push(...diagnoses);
+        const diagnosis = await EncounterDiagnosisAdapter.getInitialValue(field, null, formContext);
+        expect(diagnosis).toEqual('137329AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA');
+    });
+    it('should return null for getPreviousValue', async ()=>{
+        const previousValue = await EncounterDiagnosisAdapter.getPreviousValue(field, null, formContext);
+        expect(previousValue).toBeNull();
+    });
+    it('should execute tearDown without issues', ()=>{
+        expect(()=>EncounterDiagnosisAdapter.tearDown()).not.toThrow();
+    });
+    it('should edit a diagnosis value', ()=>{
+        formContext.sessionMode = 'edit';
+        const value = '128138AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA';
+        field.meta = {
+            initialValue: {
+                omrsObject: {
+                    uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+                    diagnosis: {
+                        coded: {
+                            uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                            display: 'Schistosoma Mansonii Infection'
+                        }
+                    }
+                },
+                refinedValue: null
+            }
+        };
+        EncounterDiagnosisAdapter.transformFieldValue(field, value, formContext);
+        expect(field.meta.submission.newValue).toEqual({
+            patient: '833db896-c1f0-11eb-8529-0242ac130003',
+            condition: null,
+            diagnosis: {
+                coded: '128138AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
+            },
+            certainty: 'PROVISIONAL',
+            rank: 1,
+            formFieldPath: 'rfe-forms-DiagNosIS',
+            formFieldNamespace: 'rfe-forms',
+            uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f'
+        });
+        expect(field.meta.submission.voidedValue).toBe(undefined);
+    });
+    it('should void removed diagnosis in edit mode', ()=>{
+        formContext.sessionMode = 'edit';
+        field.meta = {
+            initialValue: {
+                omrsObject: {
+                    uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f',
+                    diagnosis: {
+                        coded: {
+                            uuid: '127133AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                            display: 'Schistosoma Mansonii Infection'
+                        }
+                    }
+                },
+                refinedValue: null
+            }
+        };
+        EncounterDiagnosisAdapter.transformFieldValue(field, null, formContext);
+        expect(field.meta.submission.voidedValue).toEqual({
+            voided: true,
+            uuid: '0e20bb67-5d7f-41e0-96a1-751efc21a96f'
+        });
+    });
+});

package/dist/adapters/encounter-location-adapter.d.ts

@@ -0,0 +1,3 @@
+import { type FormFieldValueAdapter } from '../types';
+export declare const EncounterLocationAdapter: FormFieldValueAdapter;
+//# sourceMappingURL=encounter-location-adapter.d.ts.map

package/dist/adapters/encounter-location-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encounter-location-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/encounter-location-adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,qBAAqB,EAE3B,MAAM,UAAU,CAAC;AAGlB,eAAO,MAAM,wBAAwB,EAAE,qBA4BtC,CAAC"}

package/dist/adapters/encounter-location-adapter.js

@@ -0,0 +1,25 @@
+import { gracefullySetSubmission } from "../utils/common-utils.js";
+export const EncounterLocationAdapter = {
+    transformFieldValue: function(field, value, context) {
+        gracefullySetSubmission(field, value, null);
+    },
+    getInitialValue: function(field, sourceObject, context) {
+        if (sourceObject && sourceObject['location']?.uuid) {
+            return sourceObject['location'].uuid;
+        }
+        return context.location.uuid;
+    },
+    getPreviousValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.previousDomainObjectValue;
+        return {
+            value: encounter?.location?.uuid,
+            display: encounter?.location?.name
+        };
+    },
+    getDisplayValue: function(field, value) {
+        return value;
+    },
+    tearDown: function() {
+        return;
+    }
+};

package/dist/adapters/encounter-provider-adapter.d.ts

@@ -0,0 +1,3 @@
+import { type FormFieldValueAdapter } from '../types';
+export declare const EncounterProviderAdapter: FormFieldValueAdapter;
+//# sourceMappingURL=encounter-provider-adapter.d.ts.map

package/dist/adapters/encounter-provider-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encounter-provider-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/encounter-provider-adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,qBAAqB,EAE3B,MAAM,UAAU,CAAC;AAGlB,eAAO,MAAM,wBAAwB,EAAE,qBA6BtC,CAAC"}

package/dist/adapters/encounter-provider-adapter.js

@@ -0,0 +1,34 @@
+import { gracefullySetSubmission } from "../utils/common-utils.js";
+export const EncounterProviderAdapter = {
+    transformFieldValue: function(field, value, context) {
+        gracefullySetSubmission(field, value, null);
+    },
+    getInitialValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.previousDomainObjectValue;
+        return getLatestProvider(encounter)?.uuid;
+    },
+    getPreviousValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.previousDomainObjectValue;
+        const provider = getLatestProvider(encounter);
+        return {
+            value: provider?.uuid,
+            display: provider?.name
+        };
+    },
+    getDisplayValue: function(field, value) {
+        if (value?.display) {
+            return value.display;
+        }
+        return value;
+    },
+    tearDown: function() {
+        return;
+    }
+};
+function getLatestProvider(encounter) {
+    if (encounter && encounter['encounterProviders']?.length) {
+        const lastProviderIndex = encounter['encounterProviders'].length - 1;
+        return encounter['encounterProviders'][lastProviderIndex].provider;
+    }
+    return null;
+}

package/dist/adapters/encounter-role-adapter.d.ts

@@ -0,0 +1,3 @@
+import { type FormFieldValueAdapter } from '../types';
+export declare const EncounterRoleAdapter: FormFieldValueAdapter;
+//# sourceMappingURL=encounter-role-adapter.d.ts.map

package/dist/adapters/encounter-role-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encounter-role-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/encounter-role-adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,qBAAqB,EAE3B,MAAM,UAAU,CAAC;AAGlB,eAAO,MAAM,oBAAoB,EAAE,qBAmClC,CAAC"}

package/dist/adapters/encounter-role-adapter.js

@@ -0,0 +1,40 @@
+import { gracefullySetSubmission } from "../utils/common-utils.js";
+export const EncounterRoleAdapter = {
+    transformFieldValue: function(field, value, context) {
+        gracefullySetSubmission(field, value, null);
+    },
+    getInitialValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.domainObjectValue;
+        if (encounter) {
+            return getLatestEncounterRole(encounter)?.uuid;
+        }
+        return context.customDependencies.defaultEncounterRole.uuid;
+    },
+    getPreviousValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.previousDomainObjectValue;
+        if (encounter) {
+            const role = getLatestEncounterRole(encounter);
+            return {
+                value: role?.uuid,
+                display: role?.name
+            };
+        }
+        return null;
+    },
+    getDisplayValue: function(field, value) {
+        if (value?.display) {
+            return value.display;
+        }
+        return value;
+    },
+    tearDown: function() {
+        return;
+    }
+};
+function getLatestEncounterRole(encounter) {
+    if (encounter && encounter['encounterProviders']?.length) {
+        const lastProviderIndex = encounter['encounterProviders'].length - 1;
+        return encounter['encounterProviders'][lastProviderIndex].encounterRole;
+    }
+    return null;
+}

package/dist/adapters/inline-date-adapter.d.ts

@@ -0,0 +1,3 @@
+import { type FormFieldValueAdapter } from '../types';
+export declare const InlineDateAdapter: FormFieldValueAdapter;
+//# sourceMappingURL=inline-date-adapter.d.ts.map

package/dist/adapters/inline-date-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inline-date-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/inline-date-adapter.ts"],"names":[],"mappings":"AAIA,OAAO,EAAkB,KAAK,qBAAqB,EAAkC,MAAM,UAAU,CAAC;AAItG,eAAO,MAAM,iBAAiB,EAAE,qBAkD/B,CAAC"}

package/dist/adapters/inline-date-adapter.js

@@ -0,0 +1,56 @@
+import { formatDate, parseDate, toOmrsIsoString } from "@openmrs/esm-framework";
+import { isNewSubmissionEffective } from "./obs-comment-adapter.js";
+import { isEmpty } from "../validators/form-validator.js";
+import { hasSubmission } from "../utils/common-utils.js";
+import { editObs } from "./obs-adapter.js";
+export const InlineDateAdapter = {
+    transformFieldValue: function(field, value, context) {
+        const targetField = context.getFormField(field.meta.targetField);
+        const targetFieldCurrentValue = context.methods.getValues(targetField.id);
+        const dateString = value instanceof Date ? toOmrsIsoString(value) : value;
+        if (targetField.meta.submission?.newValue) {
+            if (isEmpty(dateString) && !isNewSubmissionEffective(targetField, targetFieldCurrentValue)) {
+                // clear submission
+                targetField.meta.submission.newValue = null;
+            } else {
+                targetField.meta.submission.newValue.obsDatetime = dateString;
+            }
+        } else if (!hasSubmission(targetField) && targetField.meta.initialValue?.omrsObject) {
+            if (isEmpty(value) && isEmpty(targetField.meta.initialValue.omrsObject?.obsDatetime)) {
+                return null;
+            }
+            // generate submission
+            const newSubmission = editObs(targetField, targetFieldCurrentValue);
+            targetField.meta.submission = {
+                newValue: {
+                    ...newSubmission,
+                    obsDatetime: dateString
+                }
+            };
+        }
+    },
+    getInitialValue: function(field, sourceObject, context) {
+        const encounter = sourceObject ?? context.domainObjectValue;
+        if (encounter) {
+            const targetFieldId = field.id.split('_inline_date')[0];
+            const targetField = context.formFields.find((field)=>field.id === targetFieldId);
+            const targetFieldInitialObs = targetField?.meta.initialValue?.omrsObject;
+            if (targetFieldInitialObs?.obsDatetime) {
+                return parseDate(targetFieldInitialObs.obsDatetime);
+            }
+        }
+        return null;
+    },
+    getPreviousValue: function(field, sourceObject, context) {
+        return null;
+    },
+    getDisplayValue: function(field, value) {
+        if (value) {
+            return formatDate(value);
+        }
+        return null;
+    },
+    tearDown: function() {
+        return;
+    }
+};

package/dist/adapters/obs-adapter.d.ts

@@ -0,0 +1,29 @@
+import { type OpenmrsObs, type FormField, type FormFieldValueAdapter } from '../types';
+export declare let assignedObsIds: string[];
+export declare const ObsAdapter: FormFieldValueAdapter;
+export declare function constructObs(field: FormField, value: any): Partial<OpenmrsObs>;
+export declare function voidObs(obs: OpenmrsObs): {
+    uuid: string;
+    voided: boolean;
+};
+export declare function editObs(field: FormField, newValue: any): {
+    uuid: string;
+    value: any;
+    formFieldNamespace: string;
+    formFieldPath: string;
+};
+export declare function hasPreviousObsValueChanged(field: FormField, newValue: any): boolean;
+/**
+ * Retrieves a list of observations from a given `obsList` that correspond to the specified field.
+ *
+ * Notes:
+ * If the query by field-path returns an empty list, the function falls back to querying
+ * by concept and uses `claimedObsIds` to exclude already assigned observations.
+ *
+ * When the field belongs to an obsGroup (i.e. `field.meta.groupId` is set), the concept
+ * fallback is scoped to observations that are members of the matching parent obsGroup.
+ * This prevents child obs from one obsGroup from being incorrectly assigned to fields
+ * in a different obsGroup that happens to share the same concept.
+ */
+export declare function findObsByFormField(obsList: Array<OpenmrsObs>, claimedObsIds: string[], field: FormField): OpenmrsObs[];
+//# sourceMappingURL=obs-adapter.d.ts.map

package/dist/adapters/obs-adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"obs-adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/obs-adapter.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,UAAU,EACf,KAAK,SAAS,EAGd,KAAK,qBAAqB,EAC3B,MAAM,UAAU,CAAC;AAclB,eAAO,IAAI,cAAc,EAAE,MAAM,EAAO,CAAC;AAEzC,eAAO,MAAM,UAAU,EAAE,qBAyExB,CAAC;AAkDF,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,CAgB9E;AAED,wBAAgB,OAAO,CAAC,GAAG,EAAE,UAAU;;;EAEtC;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG;;;;;EAWtD;AAkBD,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,WAkBzE;AA+CD;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,EAC1B,aAAa,EAAE,MAAM,EAAE,EACvB,KAAK,EAAE,SAAS,GACf,UAAU,EAAE,CA2Cd"}