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

package/src/core/api/types/identity/UserRoleScopeLocation.ts

@@ -0,0 +1,7 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+
+export interface UserRoleScopeLocation extends BaseOpenmrsData {
+  locationUuid: string;
+  locationName: string;
+  enableDescendants: boolean;
+}

package/src/core/api/types/identity/UserRoleScopeOperationType.ts

@@ -0,0 +1,6 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+
+export interface UserRoleScopeOperationType extends BaseOpenmrsData {
+  operationTypeUuid: string;
+  operationTypeName: string;
+}

package/src/core/api/types/stockItem/ImportResult.ts

@@ -0,0 +1,9 @@
+export interface ImportResult {
+  createdCount: number;
+  updatedCount: number;
+  uploadSessionId: string;
+  hasErrorFile: boolean;
+  success: boolean;
+  errors: string[];
+  notChangedCount: number;
+}

package/src/core/api/types/stockItem/StockBatch.ts

@@ -0,0 +1,8 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { StockItem } from "./StockItem";
+
+export interface StockBatch extends BaseOpenmrsData {
+  batchNo: string;
+  expiration: Date;
+  stockItem: StockItem;
+}

package/src/core/api/types/stockItem/StockBatchDTO.ts

@@ -0,0 +1,8 @@
+export interface StockBatchDTO {
+  uuid: string;
+  batchNo: string;
+  expiration: Date;
+  stockItemUuid: string;
+  quantity: string;
+  voided: boolean;
+}

package/src/core/api/types/stockItem/StockItem.ts

@@ -0,0 +1,63 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { Concept } from "../concept/Concept";
+import { Drug } from "../concept/Drug";
+import { RecordPermission } from "../RecordPermission";
+import { StockBatch } from "./StockBatch";
+import {
+  StockItemPackagingUOM,
+  StockItemPackagingUOMDTO,
+} from "./StockItemPackagingUOM";
+
+export interface StockItem extends BaseOpenmrsData {
+  concept: Concept;
+  drug: Drug;
+  hasExpiration: boolean;
+  stockBatches: StockBatch[];
+  stockItemPackagingUOMs: StockItemPackagingUOM[];
+}
+
+export interface StockItemDTO {
+  uuid: string | null | undefined;
+  isDrug: boolean | null | undefined;
+  drugUuid: string | null | undefined;
+  drugName: string | null | undefined;
+  conceptUuid: string | null | undefined;
+  commonName: string | null | undefined;
+  acronym: string | null | undefined;
+  conceptName: string | null | undefined;
+  hasExpiration: boolean | null | undefined;
+  preferredVendorUuid: string | null | undefined;
+  preferredVendorName: string | null | undefined;
+  purchasePrice: number | null | undefined;
+  purchasePriceUoMUuid: string | null | undefined;
+  purchasePriceUoMName: string | null | undefined;
+  dispensingUnitName: string | null | undefined;
+  dispensingUnitUuid: string | null | undefined;
+  dispensingUnitPackagingUoMUuid: string | null | undefined;
+  dispensingUnitPackagingUoMName: string | null | undefined;
+  defaultStockOperationsUoMUuid: string | null | undefined;
+  defaultStockOperationsUoMName: string | null | undefined;
+  reorderLevel: number | null | undefined;
+  reorderLevelUoMUuid: string | null | undefined;
+  reorderLevelUoMName: string | null | undefined;
+  dateCreated: Date | null | undefined;
+  creatorGivenName: string | null | undefined;
+  creatorFamilyName: string | null | undefined;
+  voided: boolean | null | undefined;
+  packagingUnits: StockItemPackagingUOMDTO[];
+  permission: RecordPermission;
+  categoryUuid: string | null | undefined;
+  categoryName: string | null | undefined;
+  expiryNotice: number | null | undefined;
+}
+
+export const LocationStockItemBatchNo = "LocationStockItemBatchNo";
+export const LocationStockItem = "LocationStockItem";
+export const StockItemOnly = "StockItemOnly";
+
+export const InventoryGroupByOptions = [
+  LocationStockItemBatchNo,
+  LocationStockItem,
+  StockItemOnly,
+] as const;
+export type InventoryGroupBy = (typeof InventoryGroupByOptions)[number];

package/src/core/api/types/stockItem/StockItemInventory.ts

@@ -0,0 +1,10 @@
+export interface StockItemInventory {
+  partyUuid: string;
+  partyName: string;
+  stockItemUuid: string;
+  stockBatchUuid: string;
+  batchNumber: string;
+  quantity: number;
+  quantityUoM: string;
+  expiration: Date;
+}

package/src/core/api/types/stockItem/StockItemPackagingUOM.ts

@@ -0,0 +1,20 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { Concept } from "../concept/Concept";
+import { StockItem } from "./StockItem";
+
+export interface StockItemPackagingUOM extends BaseOpenmrsData {
+  factor: number;
+  packagingUom: Concept;
+  stockItem: StockItem;
+}
+
+export interface StockItemPackagingUOMDTO {
+  id?: string;
+  uuid?: string;
+  stockItemUuid?: string;
+  packagingUomName?: string;
+  packagingUomUuid?: string;
+  factor?: number | null;
+  isDefaultStockOperationsUoM?: boolean;
+  isDispensingUnit?: boolean;
+}

package/src/core/api/types/stockItem/StockItemTransaction.ts

@@ -0,0 +1,22 @@
+import { StockOperationStatus } from "../stockOperation/StockOperationStatus";
+
+export interface StockItemTransactionDTO {
+  uuid: string;
+  dateCreated: Date;
+  partyUuid: string;
+  partyName: string;
+  isPatientTransaction: boolean;
+  quantity: number;
+  stockBatchUuid: string;
+  stockBatchNo: string;
+  expiration: Date;
+  stockItemUuid: string;
+  stockOperationUuid: string;
+  stockOperationStatus: StockOperationStatus;
+  stockOperationNumber: string;
+  stockOperationTypeName: string;
+  stockItemPackagingUOMUuid: string;
+  packagingUomName: string;
+  operationSourcePartyName: string;
+  operationDestinationPartyName: string;
+}

package/src/core/api/types/stockItem/StockRule.ts

@@ -0,0 +1,28 @@
+import { RecordPermission } from "../RecordPermission";
+
+export interface StockRule {
+  id?: string;
+  uuid: string;
+  stockItemUuid: string;
+  name: string;
+  description: string;
+  locationUuid: string;
+  locationName: string;
+  quantity?: number | null;
+  stockItemPackagingUOMUuid: string;
+  packagingUomName: string;
+  enabled: boolean;
+  evaluationFrequency?: number | null;
+  lastEvaluation: Date;
+  nextEvaluation: Date;
+  lastActionDate: Date;
+  actionFrequency?: number | null;
+  alertRole?: string | null;
+  mailRole?: string | null;
+  permission: RecordPermission;
+  enableDescendants: boolean;
+  creatorGivenName?: string;
+  creatorFamilyName?: string;
+  dateCreated?: Date;
+  nextActionDate?: Date;
+}

package/src/core/api/types/stockOperation/LocationType.ts

@@ -0,0 +1,4 @@
+export const LocationTypeLocation = "Location";
+export const LocationTypeOther = "Other";
+export const LocationTypes = [LocationTypeLocation, LocationTypeOther] as const;
+export type LocationType = (typeof LocationTypes)[number];

package/src/core/api/types/stockOperation/StockOperation.ts

@@ -0,0 +1,36 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { Patient } from "../identity/Patient";
+import { OpenMRSLocation } from "../Location";
+import { User } from "../identity/User";
+import { StockOperationItem } from "./StockOperationItem";
+import { StockOperationStatus } from "./StockOperationStatus";
+import { StockOperationType } from "./StockOperationType";
+import { Concept } from "../concept/Concept";
+
+export interface StockOperation extends BaseOpenmrsData {
+  cancelReason: string;
+  cancelledBy: User;
+  cancelledDate: Date;
+  completedBy: User;
+  completedDate: Date;
+  destination: OpenMRSLocation;
+  externalReference: string;
+  location: OpenMRSLocation;
+  operationDate: Date;
+  locked: boolean;
+  operationNumber: string;
+  operationOrder: number;
+  patient: Patient;
+  remarks: string;
+  source: OpenMRSLocation;
+  sourceOther: string;
+  status: StockOperationStatus;
+  returnReason: string;
+  rejectionReason: string;
+  workflowId: number;
+  responsiblePerson: User;
+  responsiblePersonOther: string;
+  consignmentCategory: Concept;
+  stockOperationType: StockOperationType;
+  stockOperationItems: StockOperationItem[];
+}

package/src/core/api/types/stockOperation/StockOperationAction.ts

@@ -0,0 +1,24 @@
+export interface StopOperationAction {
+  name: StopOperationActionType;
+  reason?: string | null;
+  uuid: string;
+  lineItems?: StockOperationActionLineItem[];
+}
+
+export interface StockOperationActionLineItem {
+  uuid: string;
+  amount: number;
+  packagingUoMUuId: string;
+}
+
+export const StopOperationActionTypes = [
+  "SUBMIT",
+  "DISPATCH",
+  "APPROVE",
+  "RETURN",
+  "REJECT",
+  "COMPLETE",
+  "CANCEL",
+  "QUANTITY_RECEIVED",
+] as const;
+export type StopOperationActionType = (typeof StopOperationActionTypes)[number];

package/src/core/api/types/stockOperation/StockOperationDTO.ts

@@ -0,0 +1,64 @@
+import { RecordPermission } from "../RecordPermission";
+import { StockOperationItemDTO } from "./StockOperationItemDTO";
+import { StockOperationStatus } from "./StockOperationStatus";
+
+export interface StockOperationDTO {
+  uuid: string | null | undefined;
+  cancelReason: string | null | undefined;
+  cancelledBy: number;
+  cancelledByGivenName: string | null | undefined;
+  cancelledByFamilyName: string | null | undefined;
+  cancelledDate: Date;
+  completedBy: number;
+  completedByGivenName: string | null | undefined;
+  completedByFamilyName: string | null | undefined;
+  completedDate: Date;
+  destinationUuid: string | null | undefined;
+  destinationName: string | null | undefined;
+  externalReference: string | null | undefined;
+  atLocationUuid: string | null | undefined;
+  atLocationName: string | null | undefined;
+  operationDate: Date;
+  submitted: boolean;
+  submittedBy: string | null | undefined;
+  submittedByGivenName: string | null | undefined;
+  submittedByFamilyName: string | null | undefined;
+  locked: boolean;
+  operationNumber: string | null | undefined;
+  operationOrder: number;
+  remarks: string | null | undefined;
+  sourceUuid: string | null | undefined;
+  sourceName: string | null | undefined;
+  status: StockOperationStatus;
+  returnReason: string | null | undefined;
+  rejectionReason: string | null | undefined;
+  operationTypeUuid: string | null | undefined;
+  operationType: string | null | undefined;
+  operationTypeName: string | null | undefined;
+  responsiblePerson: number;
+  responsiblePersonUuid: string | null | undefined;
+  responsiblePersonGivenName: string | null | undefined;
+  responsiblePersonFamilyName: string | null | undefined;
+  responsiblePersonOther: string | null | undefined;
+  creator: number;
+  dateCreated: Date;
+  creatorGivenName: string | null | undefined;
+  creatorFamilyName: string | null | undefined;
+  permission: RecordPermission | null | undefined;
+  reasonUuid: string | null | undefined;
+  reasonName: string | null | undefined;
+  approvalRequired?: boolean | null | undefined;
+  stockOperationItems: StockOperationItemDTO[];
+
+  submittedDate: Date;
+  returnedByGivenName: string | null | undefined;
+  returnedByFamilyName: string | null | undefined;
+  returnedDate: Date;
+  rejectedByGivenName: string | null | undefined;
+  rejectedByFamilyName: string | null | undefined;
+  rejectedDate: Date;
+  dispatchedByGivenName: string | null | undefined;
+  dispatchedByFamilyName: string | null | undefined;
+  dispatchedDate: Date;
+  requisitionStockOperationUuid: string;
+}

package/src/core/api/types/stockOperation/StockOperationItem.ts

@@ -0,0 +1,13 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { StockBatch } from "../stockItem/StockBatch";
+import { StockItem } from "../stockItem/StockItem";
+import { StockItemPackagingUOM } from "../stockItem/StockItemPackagingUOM";
+import { StockOperation } from "./StockOperation";
+
+export interface StockOperationItem extends BaseOpenmrsData {
+  quantity: number;
+  stockBatch: StockBatch;
+  stockItemPackagingUOM: StockItemPackagingUOM;
+  stockItem: StockItem;
+  stockOperation: StockOperation;
+}

package/src/core/api/types/stockOperation/StockOperationItemCost.ts

@@ -0,0 +1,14 @@
+export interface StockOperationItemCost {
+  uuid: string;
+  stockItemUuid: string;
+  stockItemPackagingUOMUuid: string;
+  stockItemPackagingUOMName: string;
+  stockBatchId: number;
+  stockBatchUuid: string;
+  batchNo: string;
+  quantity: number;
+  unitCost: number;
+  unitCostUOMUuid: string;
+  unitCostUOMName: string;
+  totalCost: number;
+}

package/src/core/api/types/stockOperation/StockOperationItemDTO.ts

@@ -0,0 +1,29 @@
+import { RecordPermission } from "../RecordPermission";
+import { StockItemPackagingUOMDTO } from "../stockItem/StockItemPackagingUOM";
+
+export interface StockOperationItemDTO {
+  itemIndex?: number;
+  id: string | null | undefined;
+  uuid: string | null | undefined;
+  stockItemUuid?: string | null | undefined;
+  stockItemName?: string | null | undefined;
+  stockItemPackagingUOMUuid?: string | null | undefined;
+  stockItemPackagingUOMName?: string | null | undefined;
+  stockBatchUuid?: string | null | undefined;
+  batchNo?: string | null | undefined;
+  expiration?: Date | null | undefined;
+  quantity?: number | null | undefined;
+  purchasePrice?: number | null | undefined;
+  permission?: RecordPermission | null | undefined;
+  edit?: boolean | null | undefined;
+  hasExpiration?: boolean;
+  packagingUnits?: StockItemPackagingUOMDTO[];
+  quantityReceived?: number | null | undefined;
+  quantityReceivedPackagingUOMName?: string | null | undefined;
+  quantityReceivedPackagingUOMUuid?: string | null | undefined;
+  quantityRequested?: number | null | undefined;
+  quantityRequestedPackagingUOMUuid?: string | null | undefined;
+  quantityRequestedPackagingUOMName?: string | null | undefined;
+  commonName?: string | null | undefined;
+  acronym?: string | null | undefined;
+}

package/src/core/api/types/stockOperation/StockOperationLinkDTO.ts

@@ -0,0 +1,13 @@
+export interface StockOperationLinkDTO {
+  uuid: string;
+  parentUuid: string;
+  parentOperationNumber: string;
+  parentOperationTypeName: string;
+  parentStatus: string;
+  parentVoided: boolean;
+  childUuid: string;
+  childOperationNumber: string;
+  childOperationTypeName: string;
+  childStatus: string;
+  childVoided: boolean;
+}

package/src/core/api/types/stockOperation/StockOperationStatus.ts

@@ -0,0 +1,18 @@
+export const StockOperationStatusSubmitted = "SUBMITTED";
+export const StockOperationStatusNew = "NEW";
+export const StockOperationStatusReturned = "RETURNED";
+export const StockOperationStatusCancelled = "CANCELLED";
+export const StockOperationStatusDispatched = "DISPATCHED";
+export const StockOperationStatusCompleted = "COMPLETED";
+export const StockOperationStatusRejected = "REJECTED";
+
+export const StockOperationStatusTypes = [
+  StockOperationStatusNew,
+  StockOperationStatusSubmitted,
+  StockOperationStatusDispatched,
+  StockOperationStatusCompleted,
+  StockOperationStatusReturned,
+  StockOperationStatusCancelled,
+  StockOperationStatusRejected,
+] as const;
+export type StockOperationStatus = (typeof StockOperationStatusTypes)[number];

package/src/core/api/types/stockOperation/StockOperationType.ts

@@ -0,0 +1,162 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { LocationType } from "./LocationType";
+
+export interface StockOperationType extends BaseOpenmrsData {
+  name: string;
+  description: string;
+  operationType: string;
+  hasSource: boolean;
+  sourceType: LocationType;
+  hasDestination: boolean;
+  destinationType: LocationType;
+  hasRecipient: boolean;
+  recipientRequired: boolean;
+  availableWhenReserved: boolean;
+  allowExpiredBatchNumbers: boolean;
+  stockOperationTypeLocationScopes: StockOperationTypeLocationScope[];
+}
+
+export interface StockOperationTypeLocationScope {
+  uuid: string;
+  locationTag: string;
+  isSource: string;
+  isDestination: string;
+}
+
+export enum OperationType {
+  TRANSFER_OUT_OPERATION_TYPE = "transferout",
+  DISPOSED_OPERATION_TYPE = "disposed",
+  STOCK_ISSUE_OPERATION_TYPE = "stockissue",
+  STOCK_TAKE_OPERATION_TYPE = "stocktake",
+  REQUISITION_OPERATION_TYPE = "requisition",
+  OPENING_STOCK_OPERATION_TYPE = "initial",
+  RECEIPT_OPERATION_TYPE = "receipt",
+  RETURN_OPERATION_TYPE = "return",
+  ADJUSTMENT_OPERATION_TYPE = "adjustment",
+}
+
+export function operationFromString(str: string): OperationType | undefined {
+  str = str.toLowerCase();
+  if (str === OperationType.TRANSFER_OUT_OPERATION_TYPE)
+    return OperationType.TRANSFER_OUT_OPERATION_TYPE;
+  if (str === OperationType.DISPOSED_OPERATION_TYPE)
+    return OperationType.DISPOSED_OPERATION_TYPE;
+  if (str === OperationType.STOCK_ISSUE_OPERATION_TYPE)
+    return OperationType.STOCK_ISSUE_OPERATION_TYPE;
+  if (str === OperationType.STOCK_TAKE_OPERATION_TYPE)
+    return OperationType.STOCK_TAKE_OPERATION_TYPE;
+  if (str === OperationType.REQUISITION_OPERATION_TYPE)
+    return OperationType.REQUISITION_OPERATION_TYPE;
+  if (str === OperationType.RECEIPT_OPERATION_TYPE)
+    return OperationType.RECEIPT_OPERATION_TYPE;
+  if (str === OperationType.RETURN_OPERATION_TYPE)
+    return OperationType.RETURN_OPERATION_TYPE;
+  if (str === OperationType.ADJUSTMENT_OPERATION_TYPE)
+    return OperationType.ADJUSTMENT_OPERATION_TYPE;
+  if (str === OperationType.OPENING_STOCK_OPERATION_TYPE)
+    return OperationType.OPENING_STOCK_OPERATION_TYPE;
+}
+
+export const StockOperationTypeRequiresStockAdjustmentReason = (
+  operationType: OperationType
+) => {
+  return (
+    operationType === OperationType.ADJUSTMENT_OPERATION_TYPE ||
+    operationType === OperationType.STOCK_TAKE_OPERATION_TYPE ||
+    operationType === OperationType.DISPOSED_OPERATION_TYPE
+  );
+};
+
+export const StockOperationTypeIsNegativeQtyAllowed = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.ADJUSTMENT_OPERATION_TYPE;
+};
+
+export const StockOperationTypeRequiresBatchUuid = (
+  operationType: OperationType
+) => {
+  return (
+    !StockOperationTypeRequiresActualBatchInformation(operationType) &&
+    operationType !== OperationType.REQUISITION_OPERATION_TYPE
+  );
+};
+
+export const StockOperationTypeRequiresActualBatchInformation = (
+  operationType: OperationType
+) => {
+  return (
+    operationType === OperationType.RECEIPT_OPERATION_TYPE ||
+    operationType === OperationType.OPENING_STOCK_OPERATION_TYPE
+  );
+};
+
+export const StockOperationTypeIsQuantityOptional = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.REQUISITION_OPERATION_TYPE;
+};
+
+export const StockOperationTypeCanCapturePurchasePrice = (
+  operationType: OperationType
+) => {
+  return (
+    operationType === OperationType.RECEIPT_OPERATION_TYPE ||
+    operationType === OperationType.OPENING_STOCK_OPERATION_TYPE
+  );
+};
+
+export const StockOperationTypeCanBeRelatedToRequisition = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.STOCK_ISSUE_OPERATION_TYPE;
+};
+
+export const StockOperationTypeRequiresDispatchAcknowledgement = (
+  operationType: OperationType
+) => {
+  return (
+    operationType === OperationType.STOCK_ISSUE_OPERATION_TYPE ||
+    operationType === OperationType.RETURN_OPERATION_TYPE
+  );
+};
+
+export const StockOperationTypeHasPrint = (operationType: OperationType) => {
+  return (
+    operationType === OperationType.STOCK_ISSUE_OPERATION_TYPE ||
+    StockOperationTypeIsRequistion(operationType) ||
+    StockOperationTypeIsReceipt(operationType) ||
+    StockOperationTypeIsTransferOut(operationType)
+  );
+};
+
+export const StockOperationTypeIsRequistion = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.REQUISITION_OPERATION_TYPE;
+};
+
+export const StockOperationTypeIsReceipt = (operationType: OperationType) => {
+  return operationType === OperationType.RECEIPT_OPERATION_TYPE;
+};
+
+export const StockOperationTypeIsTransferOut = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.TRANSFER_OUT_OPERATION_TYPE;
+};
+
+export const StockOperationTypeIsStockIssue = (
+  operationType: OperationType
+) => {
+  return operationType === OperationType.STOCK_ISSUE_OPERATION_TYPE;
+};
+
+export const StockOperationPrintHasItemCosts = (
+  operationType: OperationType
+) => {
+  return (
+    StockOperationTypeIsStockIssue(operationType) ||
+    StockOperationTypeIsTransferOut(operationType)
+  );
+};

package/src/core/api/types/stockOperation/StockSource.ts

@@ -0,0 +1,8 @@
+import { BaseOpenmrsData } from "../BaseOpenmrsData";
+import { Concept } from "../concept/Concept";
+
+export interface StockSource extends BaseOpenmrsData {
+  name: string;
+  acronym: string;
+  sourceType: Concept | undefined;
+}

package/src/core/components/carbon/controlled-combo-box/controlled-combo-box.component.tsx

@@ -0,0 +1,37 @@
+import React from "react";
+import { Control, Controller, FieldValues } from "react-hook-form";
+import { ComboBox } from "@carbon/react";
+
+interface ControlledComboBoxProps<T> {
+  controllerName: string;
+  name: string;
+  control: Control<FieldValues, T>;
+  onChange?: (e: { selectedItem: never }) => void;
+}
+
+const ControlledComboBox = <T,>(props: ControlledComboBoxProps<T>) => {
+  return (
+    <Controller
+      name={props.controllerName}
+      control={props.control}
+      render={({ field: { onChange, value, ref } }) => (
+        <ComboBox
+          {...props}
+          onChange={(e: { selectedItem: never }) => {
+            onChange(e);
+
+            // Fire prop change
+            if (props.onChange) {
+              props.onChange(e);
+            }
+          }}
+          id={props.name}
+          ref={ref}
+          value={value}
+        />
+      )}
+    />
+  );
+};
+
+export default ControlledComboBox;

package/src/core/components/carbon/controlled-combo-box/controlled-combo-box.test.tsx

@@ -0,0 +1,8 @@
+import { cleanup } from "@testing-library/react";
+
+describe("Test the controlled combo box", () => {
+  afterEach(cleanup);
+  it(`renders without dying`, () => {
+    // render(<ControlledComboBox />);
+  });
+});