@openmrs/esm-form-engine-lib 2.1.0-pre.1402 → 2.1.0-pre.1409

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-form-engine-lib",
-  "version": "2.1.0-pre.1402",
+  "version": "2.1.0-pre.1409",
   "description": "React Form Engine for O3",
   "browser": "dist/openmrs-esm-form-engine-lib.js",
   "main": "src/index.ts",

package/src/adapters/obs-adapter.ts

@@ -8,8 +8,13 @@ import {
   type Attachment,
   type ValueAndDisplay,
 } from '../types';
-import { hasRendering, gracefullySetSubmission, clearSubmission, flattenObsList } from '../utils/common-utils';
-import { parseToLocalDateTime } from '../utils/form-helper';
+import {
+  hasRendering,
+  gracefullySetSubmission,
+  clearSubmission,
+  flattenObsList,
+  parseToLocalDateTime,
+} from '../utils/common-utils';
 import { type FormContextProps } from '../provider/form-provider';
 import { type FormFieldValueAdapter } from '../types';
 import { isEmpty } from '../validators/form-validator';

package/src/hooks/useInitialValues.test.ts

@@ -0,0 +1,76 @@
+import { act, renderHook, waitFor } from '@testing-library/react';
+
+import useInitialValues from './useInitialValues';
+import { type FormField } from '../types';
+
+export const mockFormFields: FormField[] = [
+  {
+    label: 'First Name',
+    type: 'text',
+    id: 'firstName',
+    questionOptions: {
+      rendering: 'text',
+    },
+    value: '',
+    isRequired: true,
+    validators: [{ required: true }],
+  },
+  {
+    label: 'Date of Birth',
+    type: 'date',
+    questionOptions: {
+      rendering: 'date',
+    },
+    datePickerFormat: 'both',
+    id: 'dob',
+    value: null,
+    isRequired: true,
+    validators: [{ required: true }],
+  },
+];
+
+describe('useInitialValues', () => {
+  let formProcessor;
+  let context;
+
+  beforeEach(() => {
+    formProcessor = {
+      getInitialValues: jest.fn(),
+    };
+    context = {
+      formFields: mockFormFields,
+      formFieldAdapters: { adapter1: {}, adapter2: {} },
+    };
+  });
+
+  it('should not call getInitialValues if context dependencies are not loaded', () => {
+    const { result } = renderHook(() => useInitialValues(formProcessor, true, context));
+
+    expect(result.current.isLoadingInitialValues).toBe(true);
+    expect(formProcessor.getInitialValues).not.toHaveBeenCalled();
+  });
+
+  it('should set error if getInitialValues rejects', async () => {
+    const mockError = new Error('Failed to fetch initial values');
+    formProcessor.getInitialValues.mockRejectedValue(mockError);
+
+    const { result } = await act(() => renderHook(() => useInitialValues(formProcessor, false, context)));
+
+    expect(result.current.error).toEqual(mockError);
+    expect(result.current.isLoadingInitialValues).toBe(false);
+  });
+
+  it('should set initial values when dependencies are loaded', async () => {
+    const mockInitialValues = { firstName: 'John Doe', dob: '1992-10-10' };
+    formProcessor.getInitialValues.mockResolvedValue(mockInitialValues);
+
+    const { result } = renderHook(() => useInitialValues(formProcessor, false, context));
+
+    await waitFor(() => expect(result.current.isLoadingInitialValues).toBe(true));
+
+    expect(formProcessor.getInitialValues).toHaveBeenCalledWith(context);
+    expect(result.current.initialValues).toEqual(mockInitialValues);
+    expect(result.current.isLoadingInitialValues).toBe(false);
+    expect(result.current.error).toBe(null);
+  });
+});

package/src/hooks/useInitialValues.ts

@@ -28,6 +28,7 @@ const useInitialValues = (
         .catch((error) => {
           console.error(error);
           setError(error);
+          setIsLoadingInitialValues(false);
         });
     }
   }, [formProcessor, isLoadingContextDependencies, context]);

package/src/types/index.ts

@@ -110,6 +110,19 @@ export interface PostSubmissionAction {
   ): void;
 }
 
+export interface FormFieldInputProps {
+  value: any;
+  field: FormField;
+  errors: ValidationResult[];
+  warnings: ValidationResult[];
+  /**
+   * Callback function to handle changes to the field value in the React Hook Form context.
+   *
+   * @param value - The new value of the field.
+   */
+  setFieldValue: (value: any) => void;
+}
+
 /**
  * Field validator
  */

package/src/types/schema.ts

@@ -1,6 +1,5 @@
 import { type OpenmrsResource } from '@openmrs/esm-framework';
 import { type OpenmrsEncounter } from './domain';
-import { type ValidationResult } from '..';
 
 export interface FormSchema {
   name: string;
@@ -88,19 +87,6 @@ export interface FormField {
   meta?: QuestionMetaProps;
 }
 
-export interface FormFieldInputProps {
-  value: any;
-  field: FormField;
-  errors: ValidationResult[];
-  warnings: ValidationResult[];
-  /**
-   * Callback function to handle changes to the field value in the React Hook Form context.
-   *
-   * @param value - The new value of the field.
-   */
-  setFieldValue: (value: any) => void;
-}
-
 export interface HideProps {
   hideWhenExpression: string;
 }

package/src/utils/common-utils.test.ts

@@ -1,4 +1,11 @@
-import { flattenObsList, hasRendering, clearSubmission, gracefullySetSubmission, hasSubmission } from './common-utils';
+import {
+  flattenObsList,
+  hasRendering,
+  clearSubmission,
+  gracefullySetSubmission,
+  hasSubmission,
+  parseToLocalDateTime,
+} from './common-utils';
 import { isEmpty } from '../validators/form-validator';
 import { type FormField, type OpenmrsObs } from '../types';
 import { obsList } from '__mocks__/forms/rfe-forms/obs-list-data';
@@ -134,3 +141,32 @@ describe('utils functions', () => {
     });
   });
 });
+
+describe('parseToLocalDateTime', () => {
+  it('should parse valid date string with time correctly', () => {
+    const dateString = '2023-06-27T14:30:00';
+    const expectedDate = new Date(2023, 5, 27, 14, 30, 0);
+    const parsedDate = parseToLocalDateTime(dateString);
+
+    expect(parsedDate).toEqual(expectedDate);
+  });
+
+  it('should parse valid date string without time correctly', () => {
+    const dateString = '2023-06-27';
+    const expectedDate = new Date(2023, 5, 27);
+    const parsedDate = parseToLocalDateTime(dateString);
+
+    // Set hours, minutes, and seconds to 0 since the input doesn't contain time
+    expectedDate.setHours(0, 0, 0, 0);
+
+    expect(parsedDate).toEqual(expectedDate);
+  });
+
+  it('should handle invalid date string format gracefully', () => {
+    const dateString = 'invalid-date-string';
+    const parsedDate = parseToLocalDateTime(dateString);
+
+    // Check if the parsedDate is an Invalid Date
+    expect(isNaN(parsedDate.getTime())).toBe(true);
+  });
+});

package/src/utils/common-utils.ts

@@ -1,3 +1,4 @@
+import dayjs from 'dayjs';
 import { type FormField, type OpenmrsObs, type RenderType } from '../types';
 import { isEmpty } from '../validators/form-validator';
 
@@ -53,3 +54,14 @@ export function hasSubmission(field: FormField) {
 export function isViewMode(sessionMode: string) {
   return sessionMode === 'view' || sessionMode === 'embedded-view';
 }
+
+export function parseToLocalDateTime(dateString: string): Date {
+  const dateObj = dayjs(dateString).toDate();
+  try {
+    const localTimeTokens = dateString.split('T')[1].split(':');
+    dateObj.setHours(parseInt(localTimeTokens[0]), parseInt(localTimeTokens[1]), 0);
+  } catch (e) {
+    console.error(e);
+  }
+  return dateObj;
+}

package/src/utils/form-helper.test.ts

@@ -2,7 +2,6 @@ import {
   findConceptByReference,
   evaluateConditionalAnswered,
   evaluateFieldReadonlyProp,
-  parseToLocalDateTime,
   evaluateDisabled,
 } from './form-helper';
 import { DefaultValueValidator } from '../validators/default-value-validator';
@@ -384,35 +383,6 @@ describe('Form Engine Helper', () => {
     });
   });
 
-  describe('parseToLocalDateTime', () => {
-    it('should parse valid date string with time correctly', () => {
-      const dateString = '2023-06-27T14:30:00';
-      const expectedDate = new Date(2023, 5, 27, 14, 30, 0);
-      const parsedDate = parseToLocalDateTime(dateString);
-
-      expect(parsedDate).toEqual(expectedDate);
-    });
-
-    it('should parse valid date string without time correctly', () => {
-      const dateString = '2023-06-27';
-      const expectedDate = new Date(2023, 5, 27);
-      const parsedDate = parseToLocalDateTime(dateString);
-
-      // Set hours, minutes, and seconds to 0 since the input doesn't contain time
-      expectedDate.setHours(0, 0, 0, 0);
-
-      expect(parsedDate).toEqual(expectedDate);
-    });
-
-    it('should handle invalid date string format gracefully', () => {
-      const dateString = 'invalid-date-string';
-      const parsedDate = parseToLocalDateTime(dateString);
-
-      // Check if the parsedDate is an Invalid Date
-      expect(isNaN(parsedDate.getTime())).toBe(true);
-    });
-  });
-
   describe('evaluateDisabled', () => {
     let mockExpressionRunnerFn;
     let node;

package/src/utils/form-helper.ts

@@ -1,4 +1,3 @@
-import dayjs from 'dayjs';
 import { type LayoutType } from '@openmrs/esm-framework';
 import { type FormField, type FormPage, type FormSection, type SessionMode } from '../types';
 import { isEmpty } from '../validators/form-validator';
@@ -58,17 +57,6 @@ export function findPagesWithErrors(pages: Set<FormPage>, errorFields: FormField
   return pagesWithErrors;
 }
 
-export function parseToLocalDateTime(dateString: string): Date {
-  const dateObj = dayjs(dateString).toDate();
-  try {
-    const localTimeTokens = dateString.split('T')[1].split(':');
-    dateObj.setHours(parseInt(localTimeTokens[0]), parseInt(localTimeTokens[1]), 0);
-  } catch (e) {
-    console.error(e);
-  }
-  return dateObj;
-}
-
 export function evalConditionalRequired(field: FormField, allFields: FormField[], formValues: Record<string, any>) {
   if (typeof field.required !== 'object') {
     return false;