@kenyaemr/esm-billing-app 5.4.2-pre.2135 → 5.4.2-pre.2138

package/src/bill-deposit/types/bill-deposit.types.ts

@@ -0,0 +1,61 @@
+import { type Patient } from '@openmrs/esm-framework';
+
+export interface BillDeposit {
+  uuid: string;
+  display: string;
+  patient: Patient;
+  amount: number;
+  depositType: string;
+  status: string;
+  referenceNumber: string;
+  description: string;
+  transactions: Array<BillDepositTransaction>;
+  dateCreated: string;
+  voided: boolean;
+  availableBalance: number;
+}
+
+export interface BillDepositTransaction {
+  uuid: string;
+  display: string;
+  amount: number;
+  transactionType: string;
+  dateCreated: string;
+  reason?: string;
+  voided: boolean;
+}
+
+export interface DepositFormData {
+  amount: number;
+  depositType: string;
+  referenceNumber: string;
+  description: string;
+  status: string;
+}
+
+export interface BillDepositWorkspaceProps {
+  patientUuid: string;
+  patient: Patient;
+}
+
+export interface CreateDepositPayload {
+  patient: string;
+  amount: number;
+  depositType: string;
+  referenceNumber: string;
+  description: string;
+  status: string;
+}
+
+export type FormattedDeposit = {
+  id: string;
+  depositType: string;
+  amount: number;
+  status: string;
+  dateCreated: string;
+  referenceNumber: string;
+  availableBalance: number;
+  patient: Patient;
+  description: string;
+  transactions: Array<BillDepositTransaction>;
+};

package/src/bill-deposit/utils/bill-deposit.utils.ts

@@ -0,0 +1,94 @@
+import { openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
+import { type BillDeposit, type CreateDepositPayload } from '../types/bill-deposit.types';
+import { MAX_REFERENCE_NUMBER_COUNTER } from '../constants/bill-deposit.constants';
+
+/**
+ * Generates a unique reference number for bill deposits
+ * Format: [Location Initials][YYMMDD][HHMMSS][Counter]
+ * Example: RDK240315143022001 for "Railways Dispensary (Kisumu)"
+ */
+let counter = 0;
+
+export const generateReferenceNumber = (locationDisplay: string): string => {
+  // Extract location initials including parenthetical part
+  // e.g., "Railways Dispensary (Kisumu)" -> "RDK"
+  const locationInitials = locationDisplay
+    .replace(/[()]/g, '')
+    .split(' ')
+    .map((word) => word[0])
+    .join('')
+    .toUpperCase();
+
+  // Get current date and time in format YYMMDDHHMMSS
+  const now = new Date();
+  const dateTime = now.toISOString().slice(2, 19).replace(/[-:]/g, '');
+
+  // Generate unique code using counter
+  counter = (counter + 1) % MAX_REFERENCE_NUMBER_COUNTER;
+  const uniqueCode = counter.toString().padStart(3, '0');
+
+  return `${locationInitials}${dateTime}${uniqueCode}`;
+};
+
+/**
+ * Saves a new bill deposit
+ */
+export const saveDeposit = async (deposit: CreateDepositPayload | Partial<BillDeposit>, uuid?: string) => {
+  const url = `${restBaseUrl}/cashier/deposit` + (uuid ? `/${uuid}` : '');
+  return await openmrsFetch(url, {
+    method: 'POST',
+    body: deposit,
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  });
+};
+
+/**
+ * Deletes a bill deposit
+ */
+export const deleteDeposit = async (uuid: string) => {
+  const url = `${restBaseUrl}/cashier/deposit/${uuid}`;
+  return await openmrsFetch(url, {
+    method: 'DELETE',
+  });
+};
+
+/**
+ * Formats a deposit amount with currency symbol
+ */
+export const formatDepositAmount = (amount: number): string => {
+  return new Intl.NumberFormat('en-US', {
+    style: 'currency',
+    currency: 'KES',
+  }).format(amount);
+};
+
+/**
+ * Validates a deposit amount
+ */
+export const validateDepositAmount = (amount: number): boolean => {
+  return amount > 0 && amount <= 100000000; // Assuming max deposit is 100M
+};
+
+/**
+ * Add a bill deposit transaction
+ */
+export const addDepositTransaction = async (depositUuid: string, transaction: Record<string, string | number>) => {
+  const url = `${restBaseUrl}/cashier/deposit/${depositUuid}/transaction`;
+  return await openmrsFetch(url, {
+    method: 'POST',
+    body: JSON.stringify(transaction),
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  });
+};
+
+/**
+ * Reverses a bill deposit transaction
+ */
+export const reverseTransaction = async (depositUuid: string, transactionUuid: string) => {
+  const url = `${restBaseUrl}/cashier/deposit/${depositUuid}/transaction/${transactionUuid}`;
+  return await openmrsFetch(url, { method: 'DELETE' });
+};

package/src/index.ts

@@ -17,7 +17,8 @@ import rootComponent from './root.component';
 import BillingForm from './billing-form/billing-form.component';
 import BillingCheckInForm from './billing-form/billing-checkin-form.component';
 import BillHistory from './bill-history/bill-history.component';
-import BillDepositWorkspace from './billing-form/bill-deposit/bill-deposit.workspace';
+
+// Bill Deposit Components
 
 // Benefits Package Components
 import BenefitsPackage from './benefits-package/benefits-package.component';
@@ -66,6 +67,13 @@ import { CreatePaymentPoint } from './payment-points/create-payment-point.compon
 import { ClockIn } from './payment-points/payment-point/clock-in.modal';
 import { ClockOut } from './payment-points/payment-point/clock-out.modal';
 
+// Bill Deposit Components
+import BillDepositSearch from './bill-deposit/components/search/bill-deposit-search.component';
+import AddDepositWorkspace from './bill-deposit/components/forms/add-deposit.workspace';
+import DeleteDepositModal from './bill-deposit/components/modal/delete-deposit.modal';
+import ReverseTransactionModal from './bill-deposit/components/modal/reverse-transaction.modal';
+import DepositTransactionWorkspace from './bill-deposit/components/forms/deposit-transactions/deposit-transaction.workspace';
+
 // Translation
 export const importTranslation = require.context('../translations', false, /.json$/, 'lazy');
 
@@ -167,6 +175,14 @@ export const preAuthRequestsDashboardLink = getSyncLifecycle(
   options,
 );
 
+// Bill Deposit Links
+export const billDepositDashboardLink = getSyncLifecycle(
+  createLeftPanelLink({
+    name: 'bill-deposit',
+    title: 'Bill Deposit',
+  }),
+  options,
+);
 export const benefitsPackageDashboardLink = getSyncLifecycle(
   createDashboardLink({
     ...benefitsPackageDashboardMeta,
@@ -181,7 +197,6 @@ export const root = getSyncLifecycle(rootComponent, options);
 export const billingPatientSummary = getSyncLifecycle(BillHistory, options);
 export const billingCheckInForm = getSyncLifecycle(BillingCheckInForm, options);
 export const billingForm = getSyncLifecycle(BillingForm, options);
-export const billDepositWorkspace = getSyncLifecycle(BillDepositWorkspace, options);
 
 // Bill Manager Components
 export const deleteBillableServiceModal = getSyncLifecycle(DeleteBillableServiceModal, options);
@@ -232,6 +247,12 @@ export const bulkImportBillableServicesModal = getSyncLifecycle(BulkImportBillab
 export const claimsOverview = getSyncLifecycle(ClaimsManagementOverview, options);
 export const manageClaimRequestModal = getSyncLifecycle(ManageClaimRequest, options);
 
+// Bill Deposit Components
+export const billDepositSearch = getSyncLifecycle(BillDepositSearch, options);
+export const addDepositWorkspace = getSyncLifecycle(AddDepositWorkspace, options);
+export const deleteDepositModal = getSyncLifecycle(DeleteDepositModal, options);
+export const depositTransactionWorkspace = getSyncLifecycle(DepositTransactionWorkspace, options);
+export const reverseTransactionModal = getSyncLifecycle(ReverseTransactionModal, options);
 // App Startup
 export function startupApp() {
   defineConfigSchema(moduleName, configSchema);

package/src/past-patient-bills/patient-bills-dashboard/empty-patient-bill.component.tsx

@@ -2,23 +2,40 @@ import React from 'react';
 import { useTranslation } from 'react-i18next';
 import styles from './patient-bills-dashboard.scss';
 import { EmptySvg } from './empty-svg.component';
-
-type EmptyPatientBillProps = {
+import { Button } from '@carbon/react';
+import { Add } from '@carbon/react/icons';
+type BaseEmptyPatientBillProps = {
   title?: string;
   subTitle?: string;
 };
-const EmptyPatientBill: React.FC<EmptyPatientBillProps> = ({ title, subTitle }) => {
+
+type WithLaunchForm = BaseEmptyPatientBillProps & {
+  launchForm: () => void;
+  buttonText: string;
+};
+
+type WithoutLaunchForm = BaseEmptyPatientBillProps & {
+  launchForm?: never;
+  buttonText?: never;
+};
+
+type EmptyPatientBillProps = WithLaunchForm | WithoutLaunchForm;
+
+const EmptyPatientBill: React.FC<EmptyPatientBillProps> = ({ title, subTitle, launchForm, buttonText }) => {
   const { t } = useTranslation();
   return (
-    <>
-      <div className={styles.emptyStateContainer}>
-        <EmptySvg />
-        <p className={styles.title}>{title ?? t('searchForAPatient', 'Search for a patient')}</p>
-        <p className={styles.subTitle}>
-          {subTitle ?? t('enterAnIdNumberOrPatientName', 'Enter an ID number or patient name')}
-        </p>
-      </div>
-    </>
+    <div className={styles.emptyStateContainer}>
+      <EmptySvg />
+      <p className={styles.title}>{title ?? t('searchForAPatient', 'Search for a patient')}</p>
+      <p className={styles.subTitle}>
+        {subTitle ?? t('enterAnIdNumberOrPatientName', 'Enter an ID number or patient name')}
+      </p>
+      {launchForm && buttonText && (
+        <Button onClick={launchForm} kind="ghost" renderIcon={Add}>
+          {buttonText}
+        </Button>
+      )}
+    </div>
   );
 };
 

package/src/past-patient-bills/patient-bills-dashboard/patient-bills-dashboard.scss

@@ -24,6 +24,7 @@
   min-height: 300px;
   background-color: colors.$gray-10;
   row-gap: layout.$spacing-02;
+  border: 1px solid colors.$gray-20;
 
   & form {
     border: none;

package/src/root.component.tsx

@@ -13,6 +13,7 @@ import PaymentModeHome from './payment-modes/payment-mode-home.component';
 import { ClockInBoundary } from './payment-points/clock-in-boundary.component';
 import { PaymentPoint } from './payment-points/payment-point/payment-point.component';
 import { PaymentPoints } from './payment-points/payment-points.component';
+import BillDepositDashboard from './bill-deposit/components/dashboard/bill-deposit-dashboard.component';
 
 const RootComponent: React.FC = () => {
   const baseName = window.getOpenmrsSpaBase() + 'home/billing';
@@ -46,6 +47,7 @@ const RootComponent: React.FC = () => {
         <Route path="/charge-items" element={<ChargeItemsDashboard />} />
         <Route path="/payment-modes" element={<PaymentModeHome />} />
         <Route path="/billable-exemptions" element={<BillableExemptions />} />
+        <Route path="/bill-deposit" element={<BillDepositDashboard />} />
       </Routes>
     </BrowserRouter>
   );

package/src/routes.json

@@ -150,6 +150,11 @@
       "order": 0,
       "slot": "billing-dashboard-link-slot"
     },
+    {
+      "component": "billDepositDashboardLink",
+      "name": "bill-deposit-dashboard-link",
+      "slots": ["billing-dashboard-link-slot","billing-dashboard-group-nav-slot"]
+    },
     {
       "component": "paymentHistoryLink",
       "name": "payment-history-link",
@@ -284,9 +289,15 @@
       "type": "other-form"
     },
     {
-      "name": "bill-deposit-workspace",
-      "component": "billDepositWorkspace",
-      "title": "Bill Deposit Workspace",
+      "name": "add-deposit-workspace",
+      "component": "addDepositWorkspace",
+      "title": "Add Deposit",
+      "type": "other-form"
+    },
+    {
+      "name":"deposit-transaction-workspace",
+      "component": "depositTransactionWorkspace",
+      "title": "Deposit Transaction",
       "type": "other-form"
     }
   ],
@@ -322,6 +333,14 @@
     {
       "name": "create-bill-item-modal",
       "component": "createBillItemModal"
+    },
+    {
+      "name": "delete-deposit-modal",
+      "component": "deleteDepositModal"
+    },
+    {
+      "name": "reverse-transaction-modal",
+      "component": "reverseTransactionModal"
     }
   ]
 }

package/src/types/index.ts

@@ -85,6 +85,7 @@ export interface Patient {
   uuid: string;
   display: string;
   links: PatientLink[];
+  identifiers: Array<{ uuid: string; display: string }>;
 }
 
 interface AttributeType {

package/translations/en.json

@@ -77,6 +77,7 @@
   "create": "Create",
   "createClaimError": "Create Claim error",
   "created": "Created",
+  "createNewDeposit": "Create a new deposit for this patient",
   "creating": "Creating",
   "date": "Date of Claim",
   "dateCreated": "Date Created",
@@ -163,6 +164,7 @@
   "mpesaPayment": "MPESA Payment",
   "name": "Name",
   "navigateBack": "Navigate back",
+  "newDeposit": "New Deposit",
   "nextPage": "Next page",
   "no": "No",
   "noBenefitFound": "No benefit found",
@@ -171,6 +173,7 @@
   "noBillsFoundDescription": "No bills found for this patient",
   "noCashPoints": "No Cash Points",
   "noCashPointsConfigured": "There are no cash points configured for this location",
+  "noDepositsFound": "No deposits found",
   "noItemsSelected": "No items selected",
   "noMatchingBillsToDisplay": "No matching bills to display",
   "noMatchingItemsToDisplay": "No matching items to display",