All files / src/stock-operations/stock-operations-forms stock-operation-form.component.tsx

64.51% Statements 40/62
56.71% Branches 38/67
56.52% Functions 13/23
63.79% Lines 37/58

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297                                                                                                          3x       48x 48x 48x 28x   48x 48x 28x   48x 28x   48x 28x             48x   48x 48x   48x                                                                                       48x 48x   48x   1x                                             1x       48x 46x             11x                     6x                                                                                 48x   48x   28x             28x                       28x 224x 56x               48x 28x           28x                 48x                         135x                                
import { CircleDash } from '@carbon/react/icons';
import { zodResolver } from '@hookform/resolvers/zod';
import {
  parseDate,
  showSnackbar,
  useConfig,
  useSession,
  Workspace2,
  type Workspace2DefinitionProps,
} from '@openmrs/esm-framework';
import React, { useCallback, useEffect, useMemo, useState } from 'react';
import { type FieldError, FormProvider, useForm } from 'react-hook-form';
import { useTranslation } from 'react-i18next';
import { type ConfigObject } from '../../config-schema';
import { today } from '../../constants';
import { type StockOperationDTO } from '../../core/api/types/stockOperation/StockOperationDTO';
import {
  operationFromString,
  OperationType,
  type StockOperationType,
  StockOperationTypeIsStockIssue,
} from '../../core/api/types/stockOperation/StockOperationType';
import { type TabItem } from '../../core/components/tabs/types';
import { otherUser, pick } from '../../core/utils/utils';
import {
  type BaseStockOperationItemFormData,
  getStockOperationFormSchema,
  getStockOperationItemFormSchema,
  type StockOperationItemDtoSchema,
} from '../validation-schema';
import useOperationTypePermisions from './hooks/useOperationTypePermisions';
import BaseOperationDetailsFormStep from './steps/base-operation-details-form-step';
import ReceivedItems from './steps/received-items.component';
import StockOperationItemsFormStep from './steps/stock-operation-items-form-step.component';
import StockOperationSubmissionFormStep from './steps/stock-operation-submission-form-step.component';
import StockItemForm, { type StockItemFormProps } from './stock-item-form/stock-item-form.workspace';
import StockOperationStepper from './stock-operation-stepper/stock-operation-stepper.component';
import { useStockOperationAndItems } from '../stock-operations.resource';
 
/**
 * Props interface for the StockOperationForm component
 * @interface StockOperationFormProps
 * @property {StockOperationType} [stockOperationType] - The stock operation type being created or edited.
 * @property {StockOperationDTO} [stockOperation] - The stock operation data transfer object.
 * @property {string} [stockRequisitionUuid] - Requisition operation uuid used in stock issue stockOperation type
 * When undefined or null, the form will be in creation mode.
 */
interface StockOperationFormProps {
  stockOperation?: StockOperationDTO;
  stockOperationType: StockOperationType;
  stockRequisitionUuid?: string;
}
 
const StockOperationForm: React.FC<Workspace2DefinitionProps<StockOperationFormProps>> = ({
  workspaceProps,
  closeWorkspace,
}) => {
  const { stockOperation, stockOperationType, stockRequisitionUuid } = workspaceProps ?? {};
  const { t } = useTranslation();
  const operationType = useMemo(() => {
    return operationFromString(stockOperationType.operationType);
  }, [stockOperationType]);
  const operationTypePermision = useOperationTypePermisions(stockOperationType);
  const stockOperationItemFormSchema = useMemo(() => {
    return getStockOperationItemFormSchema(operationType);
  }, [operationType]);
  const formschema = useMemo(() => {
    return getStockOperationFormSchema(operationType);
  }, [operationType]);
  const showReceivedItems = useMemo(() => {
    return (
      (StockOperationTypeIsStockIssue(stockOperation?.operationType as OperationType) ||
        stockOperation?.permission?.canDisplayReceivedItems) &&
      (stockOperation.status === 'DISPATCHED' || stockOperation.status === 'COMPLETED')
    );
  }, [stockOperation]);
  const {
    user: { uuid: defaultLoggedUserUuid },
  } = useSession();
  const { autoPopulateResponsiblePerson } = useConfig<ConfigObject>();
  const { error, items: _stockOperation, isLoading } = useStockOperationAndItems(stockRequisitionUuid);
 
  const form = useForm<StockOperationItemDtoSchema>({
    defaultValues: {
      responsiblePersonUuid:
        stockOperation?.responsiblePersonUuid ?? // if person uuid exist, make it default
        (stockOperation?.responsiblePersonOther ? otherUser.uuid : undefined) ?? // if other resp person exist, default other user uuid
        (autoPopulateResponsiblePerson ? defaultLoggedUserUuid : undefined), //Else default login user if configured
      operationDate: stockOperation?.operationDate ? parseDate(String(stockOperation.operationDate)) : today(),
      remarks: stockOperation?.remarks ?? '',
 
      operationTypeUuid: stockOperation?.operationTypeUuid ?? stockOperationType?.uuid,
      reasonUuid: stockOperation?.reasonUuid ?? '',
      responsiblePersonOther: stockOperation?.responsiblePersonOther ?? '',
      stockOperationItems:
        stockOperation?.stockOperationItems?.map((item) =>
          pick(
            { ...item, expiration: item.expiration ? parseDate(String(item.expiration)) : undefined },
            stockOperationItemFormSchema.keyof().options,
          ),
        ) ?? [],
      sourceUuid: stockOperation?.sourceUuid ?? '',
      destinationUuid: stockOperation?.destinationUuid ?? '',
    },
    mode: 'all',
    values: stockRequisitionUuid
      ? {
          sourceUuid: _stockOperation?.destinationUuid,
          destinationUuid: _stockOperation?.sourceUuid,
          operationTypeUuid: stockOperationType?.uuid,
          stockOperationItems: (_stockOperation?.stockOperationItems && _stockOperation.stockOperationItems.length > 0
            ? _stockOperation.stockOperationItems.map((item) =>
                pick(
                  { ...item, expiration: item?.expiration ? parseDate(String(item.expiration)) : undefined },
                  stockOperationItemFormSchema.keyof().options,
                ),
              )
            : []) as [BaseStockOperationItemFormData, ...BaseStockOperationItemFormData[]],
          requisitionStockOperationUuid: stockRequisitionUuid,
          responsiblePersonUuid: _stockOperation?.responsiblePersonUuid,
          responsiblePersonOther: _stockOperation?.responsiblePersonOther,
          operationDate: _stockOperation?.operationDate ? parseDate(String(_stockOperation.operationDate)) : today(),
        }
      : undefined,
    resolver: zodResolver(formschema),
  });
  const [renderItemForm, setRenderItemForm] = useState(false);
  const [itemsFormProps, setItemFormProps] = useState<StockItemFormProps>();
 
  const handleLaunchStockItem = useCallback(
    (stockOperationItem?: BaseStockOperationItemFormData) => {
      setItemFormProps({
        stockOperationType,
        stockOperationItem,
        onSave: (data) => {
          const items = (form.getValues('stockOperationItems') ?? []) as BaseStockOperationItemFormData[];
          const index = items.findIndex((i) => i.uuid === data.uuid);
          if (index === -1) {
            items.push(data);
          } else {
            items[index] = data;
          }
          form.setValue(
            'stockOperationItems',
            items as [BaseStockOperationItemFormData, ...BaseStockOperationItemFormData[]],
          );
          setRenderItemForm(false);
          setItemFormProps(undefined);
        },
        onBack: () => {
          setRenderItemForm(false);
          setItemFormProps(undefined);
        },
      });
      setRenderItemForm(true);
    },
    [stockOperationType, form, setItemFormProps, setRenderItemForm],
  );
  const steps: TabItem[] = useMemo(() => {
    return [
      {
        name: stockOperation ? `${stockOperationType?.name} Details` : `${stockOperationType?.name} Details`,
        component: (
          <BaseOperationDetailsFormStep
            stockOperation={stockOperation}
            stockOperationType={stockOperationType}
            onNext={() => setSelectedIndex(1)}
          />
        ),
        disabled: !stockOperation,
      },
      {
        name: t('stockItems', 'Stock items'),
        component: (
          <StockOperationItemsFormStep
            stockOperation={stockOperation}
            stockOperationType={stockOperationType}
            onNext={() => setSelectedIndex(2)}
            onPrevious={() => setSelectedIndex(0)}
            onLaunchItemsForm={handleLaunchStockItem}
          />
        ),
        disabled: !stockOperation,
      },
      {
        name: operationTypePermision?.requiresDispatchAcknowledgement ? 'Submit/Dispatch' : 'Submit/Complete',
        component: (
          <StockOperationSubmissionFormStep
            stockOperation={stockOperation}
            stockOperationType={stockOperationType}
            onPrevious={() => setSelectedIndex(1)}
            onNext={showReceivedItems ? () => setSelectedIndex(3) : undefined}
            dismissWorkspace={closeWorkspace}
          />
        ),
        disabled: !stockOperation,
      },
    ].concat(
      showReceivedItems
        ? [
            {
              name: t('receivedItems', 'Received Items'),
              component: <ReceivedItems stockOperation={stockOperation} onPrevious={() => setSelectedIndex(2)} />,
              disabled: !stockOperation,
            },
          ]
        : [],
    ) as TabItem[];
  }, [
    stockOperation,
    stockOperationType,
    t,
    operationTypePermision,
    showReceivedItems,
    handleLaunchStockItem,
    closeWorkspace,
  ]);
 
  const [selectedIndex, setSelectedIndex] = useState(0);
 
  useEffect(() => {
    // Display fields errors for stock operation items and operation type uuid
    Object.entries(form.formState.errors ?? {}).forEach(([key, val]) => {
      if (['stockOperationItems', 'operationTypeUuid'].includes(key)) {
        showSnackbar({ kind: 'error', title: key, subtitle: (val as FieldError)?.message });
      }
    });
 
    // Navigate to step where the error is
    const fieldSteps = [
      [
        'responsiblePersonUuid',
        'operationDate',
        'remarks',
        'sourceUuid',
        'destinationUuid',
        'reasonUuid',
        'responsiblePersonOther',
      ],
      ['stockOperationItems'],
    ];
    for (let step = 0; step < fieldSteps.length; step++) {
      const hasError = fieldSteps[step].some((field) => field in form.formState.errors);
      Iif (hasError) {
        setSelectedIndex(step);
        break;
      }
    }
  }, [form.formState.errors]);
 
  // Stock issue errors (while fetching related requisitio or if no supplied requisition)
  useEffect(() => {
    if (operationType === OperationType.STOCK_ISSUE_OPERATION_TYPE && !stockRequisitionUuid)
      showSnackbar({
        kind: 'error',
        title: t('stockIssueError', 'StockIssue error'),
        subtitle: t('relatedStockRequisitionRequired', 'Related stock requisition Required'),
      });
    Iif (error) {
      showSnackbar({
        kind: 'error',
        title: t('stockIssueError', 'StockIssue error'),
        subtitle: error?.message,
      });
    }
  }, [stockRequisitionUuid, error, t, operationType]);
 
  return (
    <Workspace2
      title={
        stockOperation
          ? t('editOperationTitle', 'Edit {{operationType}}', { operationType: stockOperation.operationTypeName })
          : t('newOperationTitle', 'New: {{operationName}}', { operationName: stockOperationType?.name })
      }
    >
      <FormProvider {...form}>
        {renderItemForm ? (
          <StockItemForm {...itemsFormProps} />
        ) : (
          <StockOperationStepper
            steps={steps.map((tab, index) => ({
              title: tab.name,
              component: tab.component,
              disabled: tab.disabled,
              icon: <CircleDash />,
            }))}
            selectedIndex={selectedIndex}
            onChange={setSelectedIndex}
          />
        )}
      </FormProvider>
    </Workspace2>
  );
};
 
export default StockOperationForm;