@openmrs/esm-form-engine-lib 3.0.0 → 3.0.1-pre.1652

package/src/processors/encounter/encounter-form-processor.ts

@@ -1,17 +1,5 @@
-import {
-  type FormField,
-  type FormPage,
-  type FormProcessorContextProps,
-  type FormSchema,
-  type FormSection,
-  type ValueAndDisplay,
-} from '../../types';
-import { usePatientPrograms } from '../../hooks/usePatientPrograms';
 import { useEffect, useState } from 'react';
-import { useEncounter } from '../../hooks/useEncounter';
-import { isEmpty } from '../../validators/form-validator';
-import { type FormContextProps } from '../../provider/form-provider';
-import { FormProcessor } from '../form-processor';
+import { type OpenmrsResource, showSnackbar, translateFrom } from '@openmrs/esm-framework';
 import {
   getMutableSessionProps,
   hydrateRepeatField,
@@ -23,23 +11,32 @@ import {
   savePatientIdentifiers,
   savePatientPrograms,
 } from './encounter-processor-helper';
-import { type OpenmrsResource, showSnackbar, translateFrom } from '@openmrs/esm-framework';
-import { moduleName } from '../../globals';
+import {
+  type FormField,
+  type FormPage,
+  type FormProcessorContextProps,
+  type FormSchema,
+  type FormSection,
+  type ValueAndDisplay,
+} from '../../types';
+import { evaluateAsyncExpression, type FormNode } from '../../utils/expression-runner';
 import { extractErrorMessagesFromResponse } from '../../utils/error-utils';
+import { extractObsValueAndDisplay } from '../../utils/form-helper';
+import { FormProcessor } from '../form-processor';
 import { getPreviousEncounter, saveEncounter } from '../../api';
-import { useEncounterRole } from '../../hooks/useEncounterRole';
-import { evaluateAsyncExpression, type FormNode } from '../../utils/expression-runner';
 import { hasRendering } from '../../utils/common-utils';
-import { extractObsValueAndDisplay } from '../../utils/form-helper';
+import { isEmpty } from '../../validators/form-validator';
+import { moduleName } from '../../globals';
+import { type FormContextProps } from '../../provider/form-provider';
+import { useEncounter } from '../../hooks/useEncounter';
+import { useEncounterRole } from '../../hooks/useEncounterRole';
+import { usePatientPrograms } from '../../hooks/usePatientPrograms';
 
 function useCustomHooks(context: Partial<FormProcessorContextProps>) {
   const [isLoading, setIsLoading] = useState(true);
   const { encounter, isLoading: isLoadingEncounter } = useEncounter(context.formJson);
   const { encounterRole, isLoading: isLoadingEncounterRole } = useEncounterRole();
-  const { isLoading: isLoadingPatientPrograms, patientPrograms } = usePatientPrograms(
-    context.patient?.id,
-    context.formJson,
-  );
+  const { isLoadingPatientPrograms, patientPrograms } = usePatientPrograms(context.patient?.id, context.formJson);
 
   useEffect(() => {
     setIsLoading(isLoadingPatientPrograms || isLoadingEncounter || isLoadingEncounterRole);

package/src/types/domain.ts

@@ -165,6 +165,10 @@ export interface PatientProgram extends OpenmrsResource {
   states?: Array<ProgramWorkflowState>;
 }
 
+export interface ProgramsFetchResponse {
+  results: Array<PatientProgram>;
+}
+
 export interface PatientProgramPayload {
   program?: string;
   uuid?: string;

package/src/types/schema.ts

@@ -84,6 +84,7 @@ export interface FormField {
   questionInfo?: string;
   historicalExpression?: string;
   constrainMaxWidth?: boolean;
+  hideSteppers?: boolean;
   /** @deprecated */
   inlineMultiCheckbox?: boolean;
   meta?: QuestionMetaProps;
@@ -143,6 +144,10 @@ export interface FormQuestionOptions {
    */
   max?: string;
   min?: string;
+  /**
+   * specifies the increment or decrement step for number field values
+   */
+  step?: number;
   /**
    * maxLength and maxLength are used to validate text field length
    */

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

@@ -171,7 +171,7 @@ describe('CommonExpressionHelpers', () => {
     it('should return the correct number of months on ART', () => {
       const artStartDate = new Date('2020-01-01');
       const today = new Date();
-      const monthsOnART = Math.floor((today.getTime() - artStartDate.getTime()) / (1000 * 60 * 60 * 24 * 30));
+      const monthsOnART = dayjs(today).diff(dayjs(artStartDate), 'months');
       expect(helpers.calcMonthsOnART(artStartDate)).toBe(monthsOnART);
     });
 

package/src/utils/common-expression-helpers.ts

@@ -118,19 +118,22 @@ export class CommonExpressionHelpers {
   };
 
   calcMonthsOnART = (artStartDate: Date) => {
-    if (artStartDate == null) return null;
+    if (artStartDate == null) {
+      return null;
+    }
 
     if (!(artStartDate instanceof Date)) {
       throw new Error('DateFormatException: value passed is not a valid date');
     }
 
-    let today = new Date();
-    let resultMonthsOnART: number;
-    let artInDays = Math.round((today.getTime() - artStartDate.getTime?.()) / 86400000);
-    if (artStartDate && artInDays >= 30) {
-      resultMonthsOnART = Math.floor(artInDays / 30);
+    const today = new Date();
+    const artInDays = Math.round((today.getTime() - artStartDate.getTime()) / 86400000);
+
+    if (artInDays < 30) {
+      return 0;
     }
-    return artStartDate ? resultMonthsOnART : null;
+
+    return dayjs(today).diff(artStartDate, 'month');
   };
 
   calcViralLoadStatus = (viralLoadCount: number) => {

package/translations/en.json

@@ -2,6 +2,7 @@
   "add": "Add",
   "addCameraImage": "Add camera image",
   "addFile": "Add files",
+  "blank": "Blank",
   "cameraCapture": "Camera capture",
   "cancel": "Cancel",
   "chooseAnOption": "Choose an option",
@@ -17,7 +18,7 @@
   "fileUploadDescriptionAny": "Upload any file type",
   "invalidWorkspaceName": "Invalid workspace name.",
   "invalidWorkspaceNameSubtitle": "Please provide a valid workspace name.",
-  "launchWorkspace": "",
+  "launchWorkspace": "Launch Workspace",
   "loading": "Loading",
   "notification": "Notification",
   "nullMandatoryField": "Please fill the required fields",
@@ -26,13 +27,12 @@
   "remove": "Remove",
   "required": "Required",
   "reuseValue": "Reuse value",
-  "revert": "Revert",
   "save": "Save",
   "search": "Search",
+  "searching": "Searching",
   "submitting": "Submitting",
   "time": "Time",
   "unspecified": "Unspecified",
-  "unspecifyAll": "Unspecify All",
   "upload": "Upload",
   "uploadedPhoto": "Uploaded photo",
   "uploadImage": "Upload image",

package/src/hooks/useClobData.tsx

@@ -1,21 +0,0 @@
-import { openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
-import { useMemo } from 'react';
-import { type FormSchema, type OpenmrsForm } from '../types';
-import useSWRImmutable from 'swr/immutable';
-
-export function useClobData(form: OpenmrsForm) {
-  const valueReferenceUuid = useMemo(
-    () => form?.resources?.find(({ name }) => name === 'JSON schema').valueReference,
-    [form],
-  );
-  const { data, error } = useSWRImmutable<{ data: FormSchema }, Error>(
-    valueReferenceUuid ? `${restBaseUrl}/clobdata/${valueReferenceUuid}` : null,
-    openmrsFetch,
-  );
-
-  return {
-    clobdata: data?.data,
-    clobdataError: error || null,
-    isLoadingClobData: (!data && !error) || false,
-  };
-}

package/src/hooks/useFieldValidationResults.ts

@@ -1,18 +0,0 @@
-import { useEffect, useState } from 'react';
-import { type FormField } from '../types';
-
-export function useFieldValidationResults(field: FormField) {
-  const [errors, setErrors] = useState([]);
-  const [warnings, setWarnings] = useState([]);
-
-  useEffect(() => {
-    if (field.meta?.submission?.errors) {
-      setErrors(field.meta.submission.errors);
-    }
-    if (field.meta?.submission?.warnings) {
-      setWarnings(field.meta.submission.warnings);
-    }
-  }, [field.meta?.submission]);
-
-  return { errors, warnings, setErrors, setWarnings };
-}

package/src/hooks/useFormsConfig.tsx

@@ -1,27 +0,0 @@
-import { useEffect, useState } from 'react';
-import get from 'lodash-es/get';
-import { getConfig } from '@openmrs/esm-framework';
-import { ConceptTrue, ConceptFalse } from '../constants';
-
-export interface FormsConfig {
-  conceptTrue: string;
-  conceptFalse: string;
-}
-const defaultOptions: FormsConfig = {
-  conceptTrue: ConceptTrue,
-  conceptFalse: ConceptFalse,
-};
-
-export function useFormsConfig(moduleName: string, configPath: string) {
-  const [config, setConfig] = useState<FormsConfig>(defaultOptions);
-
-  useEffect(() => {
-    if (moduleName && configPath) {
-      getConfig(moduleName).then((c) => {
-        setConfig({ config, ...get(c, configPath, config) });
-      });
-    }
-  }, [moduleName, configPath, config]);
-
-  return config;
-}

package/src/hooks/useRestMaxResultsCount.ts

@@ -1,5 +0,0 @@
-import useSystemSetting from './useSystemSetting';
-
-export default function useRestMaxResultsCount() {
-  return useSystemSetting('webservices.rest.maxResultsDefault');
-}

package/src/hooks/useSystemSetting.ts

@@ -1,36 +0,0 @@
-import { openmrsFetch, restBaseUrl, showSnackbar } from '@openmrs/esm-framework';
-import { useEffect } from 'react';
-import { useTranslation } from 'react-i18next';
-import useSWRImmutable from 'swr/immutable';
-
-export interface SystemSetting {
-  uuid: string;
-  property: string;
-  value: string;
-}
-
-export default function useSystemSetting(setting: string) {
-  const { t } = useTranslation();
-  const apiUrl = `${restBaseUrl}/systemsetting/${setting}?v=custom:(value)`;
-  const { data, error, isLoading } = useSWRImmutable<{ data: SystemSetting }, Error>(apiUrl, openmrsFetch);
-
-  useEffect(() => {
-    if (error) {
-      showSnackbar({
-        title: t('error', 'Error'),
-        subtitle: error?.message,
-        kind: 'error',
-        isLowContrast: false,
-      });
-    }
-  }, [error]);
-
-  return {
-    systemSetting: data?.data,
-    error: error,
-    isLoading: isLoading,
-    isValueUuid:
-      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(data?.data?.value) ||
-      /^[0-9a-f]{36}$/i.test(data?.data?.value),
-  };
-}

package/src/hooks/{useEncounterRole.tsx → useEncounterRole.ts}

@@ -1,5 +1,5 @@
-import { type OpenmrsResource, openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
 import useSWRImmutable from 'swr/immutable';
+import { type OpenmrsResource, openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
 
 export function useEncounterRole() {
   const { data, error, isLoading } = useSWRImmutable<{ data: { results: Array<OpenmrsResource> } }, Error>(

package/src/hooks/{useFormCollapse.tsx → useFormCollapse.ts}

@@ -1,5 +1,5 @@
-import type { FormExpanded, SessionMode } from '../types';
 import { useCallback, useEffect, useState } from 'react';
+import type { FormExpanded, SessionMode } from '../types';
 
 export function useFormCollapse(sessionMode: SessionMode) {
   const [isFormExpanded, setIsFormExpanded] = useState<FormExpanded>(undefined);