@openmrs/esm-stock-management-app 1.0.1-pre.327

package/src/stock-operations/stock-print-reports/StockTransferDocument.tsx

@@ -0,0 +1,161 @@
+import {
+  CLOSE_PRINT_AFTER_PRINT,
+  STOCK_OPERATION_PRINT_DISABLE_COSTS,
+} from "../../constants";
+import {
+  GetHeaderSection,
+  GetPrintTemplate,
+} from "../../core/print/PrintTemplate";
+import { printDocument } from "../../core/print/printUtils";
+import { formatDisplayDate } from "../../core/utils/datetimeUtils";
+import { StockOperationPrintData } from "./StockOperationReport";
+
+export const FormatTransferDocument = async (
+  data: StockOperationPrintData
+): Promise<string> => {
+  const emptyRowCount: number = Math.max(0, 25 - (data?.items?.length ?? 0));
+  const headerSection = await GetHeaderSection();
+  return `
+    <div>
+        ${headerSection}
+        <div class="heading text center" style="text-transform: uppercase;font-size: 20pt;">
+            <b>Inventory Transfer</b>
+        </div>
+        <div class="heading-row text">
+            <span>Name of Health Unit: </span>
+            <b><span>${data?.organizationName ?? ""}</span></b>
+        </div>
+        <div class="heading-row text">
+            <table style="width:99%" border="0" cellspacing="0" cellpadding="0">
+                <tr>
+                    <td style="text-align: left;">
+                        <span>Transfer From: </span>
+                        <b><span>${data?.location ?? ""}</span></b>
+                    </td>
+                    <td style="text-align: right;">
+                        <span>Transfer#: </span>
+                        <b><span>${data?.operationNumber}</span></b>
+                    </td>
+                </tr>
+            </table>
+        </div>
+        <div class="heading-row text">
+            <table style="width:99%" border="0" cellspacing="0" cellpadding="0">
+                <tr>
+                    <td style="text-align: left;">
+                        <span>Transfer To: </span>
+                        <b><span>${data?.destination ?? ""}</span></b>
+                    </td>
+                    <td style="text-align: right;">                    
+                        <span>Date: </span>
+                        <b><span>${formatDisplayDate(
+                          data?.operationDate
+                        )}</span></b>
+                    </td>
+                </tr>
+            </table>
+        </div>
+        <table class="table-data" border="0" cellspacing="0" cellpadding="0">                     
+            <tr>
+                <th valign="middle" class="left" style="border-top:solid black 1.0pt;"><b>Item Code No.</b></th>
+                <th valign="middle" class="left" style="border-top:solid black 1.0pt;"><b>Item Description (name, formulation, strength)</b></th>
+                <th valign="middle" style="border-top:solid black 1.0pt;"><b>Batch No.</b></th>
+                <th valign="middle" style="border-top:solid black 1.0pt;"><b>Expiry</b></th>
+                <th valign="middle" style="border-top:solid black 1.0pt;"><b>Quantity</b></th>
+                <th valign="middle" style="border-top:solid black 1.0pt;"><b>Unit Cost</b></th>
+                <th valign="middle" style="border-top:solid black 1.0pt;"><b>Total Cost</b></th>
+            </tr>            
+            ${
+              data?.items
+                ? data?.items
+                    .map((p) => {
+                      return `
+                <tr class="data-row">
+                    <td valign="middle">${p.itemCode ?? ""}</td>
+                    <td valign="middle">${
+                      p.itemDescription ?? ""
+                    }</td>                    
+                    <td valign="middle" class="center">${
+                      p.batchNumber ?? ""
+                    }</td>                    
+                    <td valign="middle" class="center">${formatDisplayDate(
+                      p.expiryDate
+                    )}</td>                    
+                    <td valign="middle" class="center">${
+                      p.quantityRequired?.toLocaleString() ?? ""
+                    } ${p.quantityRequiredUoM ?? ""}</td>
+                    <td valign="middle" class="center">${
+                      STOCK_OPERATION_PRINT_DISABLE_COSTS
+                        ? ""
+                        : `${p.unitCost?.toLocaleString() ?? ""}${
+                            p.unitCostUoM ? `/${p.unitCostUoM}` : ""
+                          }`
+                    }</td>
+                    <td valign="middle" class="center">${
+                      STOCK_OPERATION_PRINT_DISABLE_COSTS
+                        ? ""
+                        : `${p.totalCost?.toLocaleString() ?? ""}`
+                    }</td>
+                </tr> 
+                `;
+                    })
+                    .join("")
+                : ""
+            }
+            ${
+              emptyRowCount > 0
+                ? Array(emptyRowCount)
+                    .fill(0)
+                    .map(
+                      (p) => `
+        <tr class="data-row">
+            <td valign="middle">&nbsp;</td>
+            <td valign="middle">&nbsp;</td>
+            <td valign="middle" class="center">&nbsp;</td>
+            <td valign="middle" class="center">&nbsp;</td>
+            <td valign="middle" class="center">&nbsp;</td>
+            <td valign="middle" class="center">&nbsp;</td>
+            <td valign="middle" class="center">&nbsp;</td>
+        </tr>`
+                    )
+                    .join("")
+                : ""
+            }    
+            <tr class="footer-field">
+                <td valign="middle" colspan="7" style="border:0;padding-top: 15pt;">
+                    Remarks:<br/>
+                    ${data?.remarks ?? ""}
+                </td>                
+            </tr>   
+            <tr class="footer-field">
+                <td valign="middle" colspan="4" style="border:0;padding-top: 15pt;">
+                    Prepared By:<br/>
+                    <b>${data?.responsiblePerson ?? ""}</b>
+                </td>
+                <td valign="middle" colspan="3" style="border:0;padding-top: 15pt;">
+                   Authorized By:<br/>
+                    &nbsp;
+                </td>
+            </tr>
+            <tr class="footer-field">
+                <td valign="middle" colspan="4" style="border:0;"><br/><br/>Signature</td>
+                <td valign="middle" colspan="3" style="border:0;"><br/><br/>Signature</td>
+            </tr>        
+        </table>        
+    </div>
+    `;
+};
+
+export const PrintTransferOutStockOperation = async (
+  data: StockOperationPrintData
+) => {
+  const printData = await FormatTransferDocument(data);
+  printDocument(
+    GetPrintTemplate(
+      printData,
+      data?.documentTitle,
+      true,
+      CLOSE_PRINT_AFTER_PRINT
+    )
+  );
+};

package/src/stock-operations/swr-revalidation.ts

@@ -0,0 +1,7 @@
+import { mutate } from "swr";
+
+export const handleMutate = (url: string) => {
+  mutate((key) => typeof key === "string" && key.startsWith(url), undefined, {
+    revalidate: true,
+  });
+};

package/src/stock-operations/users-selector/users-selector.component.tsx

@@ -0,0 +1,77 @@
+import React, { ReactNode } from "react";
+import { Control, Controller, FieldValues } from "react-hook-form";
+import { User } from "../../core/api/types/identity/User";
+import { ComboBox, InlineLoading } from "@carbon/react";
+import { useUsersHook } from "./users-selector.resource";
+import { useDebounce } from "../../core/hooks/debounce-hook";
+import { otherUser } from "../../core/utils/utils";
+
+interface UsersSelectorProps<T> {
+  placeholder?: string;
+  userUuid?: string;
+  onUserChanged?: (user: User) => void;
+  title?: string;
+  invalid?: boolean;
+  invalidText?: ReactNode;
+
+  // Control
+  controllerName: string;
+  name: string;
+  control: Control<FieldValues, T>;
+}
+
+const UsersSelector = <T,>(props: UsersSelectorProps<T>) => {
+  const { isLoading, userList, setSearchString } = useUsersHook();
+
+  const debouncedSearch = useDebounce((query: string) => {
+    setSearchString(query);
+  }, 1000);
+
+  if (userList) userList.push(otherUser);
+
+  return (
+    <div>
+      <Controller
+        name={props.controllerName}
+        control={props.control}
+        render={({ field: { onChange, ref } }) => (
+          <ComboBox
+            titleText={props.title}
+            name={props.name}
+            control={props.control}
+            controllerName={props.controllerName}
+            id={props.name}
+            size={"md"}
+            items={userList || []}
+            onChange={(data: { selectedItem: User }) => {
+              props.onUserChanged?.(data.selectedItem);
+              onChange(data.selectedItem?.uuid);
+            }}
+            initialSelectedItem={
+              userList?.find((p) => p.uuid === props.userUuid) ?? ""
+            }
+            itemToString={userName}
+            onInputChange={debouncedSearch}
+            placeholder={props.placeholder}
+            invalid={props.invalid}
+            invalidText={props.invalidText}
+            ref={ref}
+          />
+        )}
+      />
+      {isLoading && (
+        <InlineLoading
+          status="active"
+          iconDescription="Searching"
+          description="Searching..."
+        />
+      )}
+    </div>
+  );
+};
+
+function userName(item: User): string {
+  return item?.person?.display || "";
+}
+
+export default UsersSelector;

package/src/stock-operations/users-selector/users-selector.resource.tsx

@@ -0,0 +1,47 @@
+import {
+  ConceptFilterCriteria,
+  UserFilterCriteria,
+  useUsers,
+} from "../../stock-lookups/stock-lookups.resource";
+import { useEffect, useState } from "react";
+import { ResourceRepresentation } from "../../core/api/api";
+
+export function useUsersHook(filter?: ConceptFilterCriteria) {
+  const [conceptFilter, setConceptFilter] = useState<UserFilterCriteria>(
+    filter || {
+      v: ResourceRepresentation.Default,
+      limit: 10,
+      startIndex: 0,
+    }
+  );
+
+  const {
+    items: { results: userList },
+    isLoading,
+  } = useUsers(conceptFilter);
+
+  const [searchString, setSearchString] = useState(null);
+
+  // Drug filter type
+  const [limit, setLimit] = useState(filter?.limit || 10);
+  const [representation, setRepresentation] = useState(
+    filter?.v || ResourceRepresentation.Default
+  );
+
+  useEffect(() => {
+    setConceptFilter({
+      startIndex: 0,
+      v: representation,
+      limit: limit,
+      q: searchString,
+    });
+  }, [searchString, limit, representation]);
+
+  return {
+    userList,
+    setLimit,
+    setRepresentation,
+    setSearchString,
+    isLoading,
+  };
+}

package/src/stock-operations/validation-schema.ts

@@ -0,0 +1,195 @@
+import { z } from "zod";
+import { StockOperationStatusTypes } from "../core/api/types/stockOperation/StockOperationStatus";
+import { OperationType } from "../core/api/types/stockOperation/StockOperationType";
+
+export const stockItemPackagingUOMDTOSchema = z.object({
+  id: z.string().nullish(),
+  uuid: z.string().nullish(),
+  stockItemUuid: z.string().nullish(),
+  packagingUomName: z.string().nullish(),
+  packagingUomUuid: z.string().nullish(),
+  factor: z.number().nullish(),
+  isDefaultStockOperationsUoM: z.boolean().nullish(),
+  isDispensingUnit: z.boolean().nullish(),
+});
+
+export type StockItemPackagingUOMDTOFormData = z.infer<
+  typeof stockItemPackagingUOMDTOSchema
+>;
+
+export const recordPermissionSchema = z.object({
+  canView: z.boolean(),
+  canEdit: z.boolean(),
+  canApprove: z.boolean().nullish(),
+  canReceiveItems: z.boolean().nullish(),
+  canDisplayReceivedItems: z.boolean().nullish(),
+  isRequisitionAndCanIssueStock: z.boolean().nullish(),
+  canUpdateBatchInformation: z.boolean().nullish(),
+});
+
+export type RecordPermissionFormData = z.infer<typeof recordPermissionSchema>;
+
+export const stockOperationItemSchema = z.object({
+  itemIndex: z.number().nullish(),
+  id: z.string().nullish(),
+  uuid: z.string().nullish(),
+  stockItemUuid: z.string().nullish(),
+  stockItemName: z.string().nullish(),
+  stockItemPackagingUOMUuid: z.string().nullish(),
+  stockItemPackagingUOMName: z.string().nullish(),
+  stockBatchUuid: z.string().nullish(),
+  batchNo: z.string().nullish(),
+  expiration: z.coerce.date().nullish(),
+  quantity: z.number().nullish(),
+  purchasePrice: z.number().nullish(),
+  permission: recordPermissionSchema.nullish(),
+  edit: z.boolean().nullish(),
+  hasExpiration: z.boolean().nullish(),
+  packagingUnits: stockItemPackagingUOMDTOSchema.array(),
+  quantityReceived: z.number().nullish(),
+  quantityReceivedPackagingUOMName: z.string().nullish(),
+  quantityReceivedPackagingUOMUuid: z.string().nullish(),
+  quantityRequested: z.number().nullish(),
+  quantityRequestedPackagingUOMUuid: z.string().nullish(),
+  quantityRequestedPackagingUOMName: z.string().nullish(),
+  commonName: z.string().nullish(),
+  acronym: z.string().nullish(),
+});
+
+export type StockOperationItemFormData = z.infer<
+  typeof stockOperationItemSchema
+>;
+
+export const stockOperationSchema = z.object({
+  uuid: z.string().nullish(),
+  cancelReason: z.string().nullish(),
+  cancelledBy: z.coerce.number(),
+  cancelledByGivenName: z.string().nullish(),
+  cancelledByFamilyName: z.string().nullish(),
+  cancelledDate: z.coerce.date(),
+  completedBy: z.coerce.number(),
+  completedByGivenName: z.string().nullish(),
+  completedByFamilyName: z.string().nullish(),
+  completedDate: z.coerce.date(),
+  destinationUuid: z.string().nullish(),
+  destinationName: z.string().nullish(),
+  externalReference: z.string().nullish(),
+  atLocationUuid: z.string().nullish(),
+  atLocationName: z.string().nullish(),
+  operationDate: z.coerce.date(),
+  submitted: z.boolean(),
+  submittedBy: z.string().nullish(),
+  submittedByGivenName: z.string().nullish(),
+  submittedByFamilyName: z.string().nullish(),
+  locked: z.boolean(),
+  operationNumber: z.string().nullish(),
+  operationOrder: z.coerce.number(),
+  remarks: z.string().nullish(),
+  sourceUuid: z.string().nullish(),
+  sourceName: z.string().nullish(),
+  status: z.enum(StockOperationStatusTypes),
+  returnReason: z.string().nullish(),
+  rejectionReason: z.string().nullish(),
+  operationTypeUuid: z.string().nullish(),
+  operationType: z.string().nullish(),
+  operationTypeName: z.string().nullish(),
+  responsiblePerson: z.coerce.number(),
+  responsiblePersonUuid: z.string().nullish(),
+  responsiblePersonGivenName: z.string().nullish(),
+  responsiblePersonFamilyName: z.string().nullish(),
+  responsiblePersonOther: z.string().nullish(),
+  creator: z.coerce.number(),
+  dateCreated: z.coerce.date(),
+  creatorGivenName: z.string().nullish(),
+  creatorFamilyName: z.string().nullish(),
+  permission: recordPermissionSchema.nullish(),
+  reasonUuid: z.string().nullish(),
+  reasonName: z.string().nullish(),
+  approvalRequired: z.boolean().nullish(),
+  stockOperationItems: stockOperationItemSchema.array(),
+
+  submittedDate: z.coerce.date(),
+  returnedByGivenName: z.string().nullish(),
+  returnedByFamilyName: z.string().nullish(),
+  returnedDate: z.coerce.date(),
+  rejectedByGivenName: z.string().nullish(),
+  rejectedByFamilyName: z.string().nullish(),
+  rejectedDate: z.coerce.date(),
+  dispatchedByGivenName: z.string().nullish(),
+  dispatchedByFamilyName: z.string().nullish(),
+  dispatchedDate: z.coerce.date(),
+  requisitionStockOperationUuid: z.string(),
+});
+
+export const stockOperationItemDtoSchema = z.object({
+  operationDate: z.coerce.date(),
+  sourceUuid: z.string({ required_error: "Location Required" }).min(1, {
+    message: "Location Required",
+  }),
+  destinationUuid: z.string({ required_error: "Location Required" }).min(1, {
+    message: "Location Required",
+  }),
+  reasonUuid: z.string({ required_error: "Reason Required" }).min(1, {
+    message: "Reason Required",
+  }),
+  responsiblePersonUuid: z
+    .string({
+      required_error: "Responsible Person Required",
+    })
+    .min(1, {
+      message: "Responsible Person Required",
+    }),
+  responsiblePersonOther: z.string().nullish(),
+  remarks: z.string().nullish(),
+});
+
+export type StockOperationItemDtoSchema = z.infer<
+  typeof stockOperationItemDtoSchema
+>;
+
+export type StockOperationFormData = z.infer<typeof stockOperationSchema>;
+
+export const operationSchema = (operation: OperationType): z.Schema => {
+  switch (operation) {
+    case OperationType.OPENING_STOCK_OPERATION_TYPE:
+      return stockOperationItemDtoSchema.omit({
+        destinationUuid: true,
+        reasonUuid: true,
+      });
+    case OperationType.STOCK_TAKE_OPERATION_TYPE:
+    case OperationType.ADJUSTMENT_OPERATION_TYPE:
+    case OperationType.DISPOSED_OPERATION_TYPE:
+      return stockOperationItemDtoSchema.omit({ destinationUuid: true });
+    case OperationType.TRANSFER_OUT_OPERATION_TYPE:
+    case OperationType.STOCK_ISSUE_OPERATION_TYPE:
+      return stockOperationItemDtoSchema.omit({ reasonUuid: true }).merge(
+        z.object({
+          destinationUuid: z
+            .string({ required_error: "Destination Required" })
+            .min(1, {
+              message: "Destination Required",
+            }),
+          requisitionStockOperationUuid: z.string({
+            required_error: "Requisition stock uuid required",
+          }),
+        })
+      );
+    case OperationType.RETURN_OPERATION_TYPE:
+    case OperationType.REQUISITION_OPERATION_TYPE:
+      return stockOperationItemDtoSchema.omit({ reasonUuid: true }).merge(
+        z.object({
+          sourceUuid: z.string({ required_error: "Source Required" }).min(1, {
+            message: "Source Required",
+          }),
+        })
+      );
+    case OperationType.RECEIPT_OPERATION_TYPE:
+      return stockOperationItemDtoSchema.omit({ reasonUuid: true }).merge(
+        z.object({
+          sourceUuid: z.string({ required_error: "Source Required" }).min(1, {
+            message: "Source Required",
+          }),
+        })
+      );
+  }
+};

package/src/stock-reports/ReportType.ts

@@ -0,0 +1,63 @@
+export enum ReportParameter {
+  Date = "Date",
+  StartDate = "StartDate",
+  EndDate = "EndDate",
+  StockItemCategory = "StockItemCategory",
+  Location = "Location",
+  ChildLocations = "ChildLocations",
+  StockSource = "StockSource",
+  StockSourceDestination = "StockSourceDestination",
+  InventoryGroupBy = "InventoryGroupBy",
+  MaxReorderLevelRatio = "MaxReorderLevelRatio",
+  Patient = "Patient",
+  StockItem = "StockItem",
+  Limit = "Limit",
+  MostLeastMoving = "MostLeastMoving",
+  Fullfillment = "Fullfillment",
+}
+
+export const getParamDefaultLimit = (
+  reportSystemName: string | undefined | null
+) => {
+  return isForecastReport(reportSystemName) ? 4 : reportSystemName ? 20 : null;
+};
+
+export const isForecastReport = (
+  reportSystemName: string | undefined | null
+) => {
+  return (
+    reportSystemName === "STOCK_FORECAST_REPORT" ||
+    reportSystemName === "STOCK_EXPIRY_FORECAST_REPORT"
+  );
+};
+
+export const getReportLimitLabel = (
+  reportSystemName: string | undefined | null
+) => {
+  return isForecastReport(reportSystemName)
+    ? "stockmanagement.report.edit.months"
+    : "stockmanagement.report.edit.limit";
+};
+
+export const getReportStartDateLabel = (
+  reportSystemName: string | undefined | null
+) => {
+  return isForecastReport(reportSystemName)
+    ? "stockmanagement.report.edit.historicalstartdate"
+    : "stockmanagement.report.edit.startdate";
+};
+
+export const getReportEndDateLabel = (
+  reportSystemName: string | undefined | null
+) => {
+  return isForecastReport(reportSystemName)
+    ? "stockmanagement.report.edit.historicalenddate"
+    : "stockmanagement.report.edit.enddate";
+};
+
+export interface ReportType {
+  order: number;
+  name: string;
+  systemName: string;
+  parameters: ReportParameter[];
+}

package/src/stock-settings/stock-settings.component.tsx

@@ -0,0 +1,11 @@
+import React from "react";
+
+function StockSettings() {
+  return (
+    <div style={{ margin: "5px" }}>
+      <span>Coming Soon...</span>
+    </div>
+  );
+}
+
+export default StockSettings;

package/src/stock-sources/add-stock-source-button.component.tsx

@@ -0,0 +1,21 @@
+import { Button } from "@carbon/react";
+import React, { useCallback } from "react";
+import { useTranslation } from "react-i18next";
+import { launchOverlay } from "../core/components/overlay/hook";
+import StockSourcesAddOrUpdate from "./add-stock-sources/add-stock-sources.component";
+
+const AddStockSourceActionButton: React.FC = () => {
+  const { t } = useTranslation();
+
+  const handleClick = useCallback(() => {
+    launchOverlay("Add Stock Source", <StockSourcesAddOrUpdate />);
+  }, []);
+
+  return (
+    <Button onClick={handleClick} size="md" kind="primary">
+      {t("stockmanagement.addnewsource", "Add New Source")}
+    </Button>
+  );
+};
+
+export default AddStockSourceActionButton;