@openmrs/esm-billing-app 1.0.1-pre.14

package/src/modal/require-payment-modal.component.tsx

@@ -0,0 +1,81 @@
+import React from 'react';
+import { useTranslation } from 'react-i18next';
+import {
+  Button,
+  InlineLoading,
+  ModalBody,
+  ModalFooter,
+  ModalHeader,
+  StructuredListBody,
+  StructuredListCell,
+  StructuredListHead,
+  StructuredListRow,
+  StructuredListWrapper,
+} from '@carbon/react';
+import { useBills } from '../billing.resource';
+import { convertToCurrency } from '../helpers';
+import styles from './require-payment.scss';
+
+type RequirePaymentModalProps = {
+  closeModal: () => void;
+  patientUuid: string;
+};
+
+const RequirePaymentModal: React.FC<RequirePaymentModalProps> = ({ closeModal, patientUuid }) => {
+  const { t } = useTranslation();
+  const { bills, isLoading, error } = useBills(patientUuid);
+  const lineItems = bills.filter((bill) => bill.status !== 'PAID').flatMap((bill) => bill.lineItems);
+
+  return (
+    <div>
+      <ModalHeader closeModal={closeModal} title={t('patientBillingAlert', 'Patient Billing Alert')} />
+      <ModalBody>
+        <p className={styles.bodyShort02}>
+          {t(
+            'billPaymentRequiredMessage',
+            'The current patient has pending bill. Advice patient to settle bill before receiving services',
+          )}
+        </p>
+        {isLoading && (
+          <InlineLoading
+            status="active"
+            iconDescription="Loading"
+            description={t('inlineLoading', 'Loading bill items...')}
+          />
+        )}
+        <StructuredListWrapper isCondensed>
+          <StructuredListHead>
+            <StructuredListRow head>
+              <StructuredListCell head>{t('item', 'Item')}</StructuredListCell>
+              <StructuredListCell head>{t('quantity', 'Quantity')}</StructuredListCell>
+              <StructuredListCell head>{t('unitPrice', 'Unit price')}</StructuredListCell>
+              <StructuredListCell head>{t('total', 'Total')}</StructuredListCell>
+            </StructuredListRow>
+          </StructuredListHead>
+          <StructuredListBody>
+            {lineItems.map((lineItem) => {
+              return (
+                <StructuredListRow>
+                  <StructuredListCell>{lineItem.billableService || lineItem.item}</StructuredListCell>
+                  <StructuredListCell>{lineItem.quantity}</StructuredListCell>
+                  <StructuredListCell>{convertToCurrency(lineItem.price)}</StructuredListCell>
+                  <StructuredListCell>{convertToCurrency(lineItem.quantity * lineItem.price)}</StructuredListCell>
+                </StructuredListRow>
+              );
+            })}
+          </StructuredListBody>
+        </StructuredListWrapper>
+      </ModalBody>
+      <ModalFooter>
+        <Button kind="secondary" onClick={closeModal}>
+          {t('cancel', 'Cancel')}
+        </Button>
+        <Button kind="primary" onClick={closeModal}>
+          {t('ok', 'OK')}
+        </Button>
+      </ModalFooter>
+    </div>
+  );
+};
+
+export default RequirePaymentModal;

package/src/modal/require-payment.scss

@@ -0,0 +1,6 @@
+@use '@carbon/type';
+
+.bodyShort02 {
+  margin-bottom: 0.5rem;
+  @include type.type-style('body-compact-02');
+}

package/src/root.component.tsx

@@ -0,0 +1,19 @@
+import React from 'react';
+import { BrowserRouter, Route, Routes } from 'react-router-dom';
+import { BillingDashboard } from './billing-dashboard/billing-dashboard.component';
+import Invoice from './invoice/invoice.component';
+
+const RootComponent: React.FC = () => {
+  const baseName = window.getOpenmrsSpaBase() + 'home/billing';
+
+  return (
+    <BrowserRouter basename={baseName}>
+      <Routes>
+        <Route path="/" element={<BillingDashboard />} />
+        <Route path="/patient/:patientUuid/:billUuid" element={<Invoice />} />
+      </Routes>
+    </BrowserRouter>
+  );
+};
+
+export default RootComponent;

package/src/root.scss

@@ -0,0 +1,30 @@
+@use '@carbon/type';
+@import '~@openmrs/esm-styleguide/src/vars';
+
+.productiveHeading01 {
+  @include type.type-style('heading-compact-01');
+}
+
+.productiveHeading02 {
+  @include type.type-style('heading-compact-02');
+}
+
+.bodyLong01 {
+  @include type.type-style('body-01');
+}
+
+.caption01 {
+  @include type.type-style('legal-01');
+}
+
+.bodyShort02 {
+  @include type.type-style('body-compact-02');
+}
+
+.text02 {
+  color: $text-02;
+}
+
+.text01 {
+  color: $ui-05;
+}

package/src/routes.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "https://json.openmrs.org/routes.schema.json",
+  "backendDependencies": {
+    "kenyaemr": "^18.2.0"
+  },
+  "pages": [
+    {
+      "component": "billableServicesHome",
+      "route":"billable-services"
+    }
+  ],
+  "extensions": [
+    {
+      "component": "billingDashboardLink",
+      "name": "billing-dashboard-link",
+      "slot": "homepage-dashboard-slot",
+      "meta": {
+        "name": "billing",
+        "title": "billing",
+        "slot": "billing-dashboard-slot"
+      }
+    },
+    {
+      "component": "root",
+      "name": "billing-dashboard-root",
+      "slot": "billing-dashboard-slot"
+    },
+    {
+      "name": "billing-patient-summary",
+      "component": "billingPatientSummary",
+      "slot": "patient-chart-billing-dashboard-slot",
+      "order": 10,
+      "meta": {
+        "columnSpan": 4
+      }
+    },
+    {
+      "name": "billing-summary-dashboard-link",
+      "component": "billingSummaryDashboardLink",
+      "slot": "patient-chart-dashboard-slot",
+      "order": 11,
+      "meta": {
+        "columns": 1,
+        "columnSpan": 1,
+        "slot": "patient-chart-billing-dashboard-slot",
+        "path": "Billing history"
+      }
+    },
+    {
+      "name": "billing-checkin-form",
+      "slot": "billing-checkin-slot",
+      "component": "billingCheckInForm"
+    },
+    {
+      "slot": "system-admin-page-card-link-slot",
+      "component": "billableServicesCardLink",
+      "name": "billable-services-admin-card-link"
+    },
+    {
+      "name": "billing-form",
+      "component": "billingForm"
+    },
+    {
+      "name": "require-billing-modal",
+      "component": "requirePaymentModal"
+    },
+    {
+      "name": "patient-banner-billing-tags",
+      "component": "visitAttributeTags",
+      "slot": "patient-banner-tags-slot",
+      "order": 2
+    },
+    {
+      "name": "billing-home-tiles-ext",
+      "slot": "billing-home-tiles-slot",
+      "component": "billingServicesTiles"
+    }
+  ]
+}

package/src/setup-tests.ts

@@ -0,0 +1,13 @@
+import '@testing-library/jest-dom';
+
+declare global {
+  interface Window {
+    openmrsBase: string;
+    spaBase: string;
+  }
+}
+
+window.openmrsBase = '/openmrs';
+window.spaBase = '/spa';
+window.getOpenmrsSpaBase = () => '/openmrs/spa/';
+window.HTMLElement.prototype.scrollIntoView = jest.fn();

package/src/types/index.ts

@@ -0,0 +1,167 @@
+export interface MappedBill {
+  uuid: string;
+  id: number;
+  patientUuid: string;
+  patientName: string;
+  cashPointUuid: string;
+  cashPointName: string;
+  cashPointLocation: string;
+  cashier: Provider;
+  receiptNumber: string;
+  status: string;
+  identifier: string;
+  dateCreated: string;
+  lineItems: Array<LineItem>;
+  billingService: string;
+  payments: Array<Payment>;
+  totalAmount?: number;
+  tenderedAmount?: number;
+  display?: string;
+}
+
+interface LocationLink {
+  rel: string;
+  uri: string;
+  resourceAlias: string;
+}
+
+interface Location {
+  uuid: string;
+  display: string;
+  links: LocationLink[];
+}
+
+interface CashPoint {
+  uuid: string;
+  name: string;
+  description: string;
+  retired: boolean;
+  location: Location;
+}
+
+interface ProviderLink {
+  rel: string;
+  uri: string;
+  resourceAlias: string;
+}
+
+interface Provider {
+  uuid: string;
+  display: string;
+  links: ProviderLink[];
+}
+
+export interface LineItem {
+  uuid: string;
+  display: string;
+  voided: boolean;
+  voidReason: string | null;
+  item: string;
+  billableService: string;
+  quantity: number;
+  price: number;
+  priceName: string;
+  priceUuid: string;
+  lineItemOrder: number;
+  resourceVersion: string;
+}
+
+interface PatientLink {
+  rel: string;
+  uri: string;
+  resourceAlias: string;
+}
+
+interface Patient {
+  uuid: string;
+  display: string;
+  links: PatientLink[];
+}
+
+interface AttributeType {
+  uuid: string;
+  name: string;
+  description: string;
+  retired: boolean;
+  attributeOrder: number;
+  format: string;
+  foreignKey: string | null;
+  regExp: string | null;
+  required: boolean;
+}
+
+interface Attribute {
+  uuid: string;
+  display: string;
+  voided: boolean;
+  voidReason: string | null;
+  value: string;
+  attributeType: AttributeType;
+  order: number;
+  valueName: string;
+  resourceVersion: string;
+}
+
+interface PaymentInstanceType {
+  uuid: string;
+  name: string;
+  description: string;
+  retired: boolean;
+}
+
+export interface Payment {
+  uuid: string;
+  instanceType: PaymentInstanceType;
+  attributes: Attribute[];
+  amount: number;
+  amountTendered: number;
+  dateCreated: number;
+  voided: boolean;
+  resourceVersion: string;
+}
+
+export interface PatientInvoice {
+  uuid: string;
+  display: string;
+  voided: boolean;
+  voidReason: string | null;
+  adjustedBy: any[];
+  billAdjusted: any;
+  cashPoint: CashPoint;
+  cashier: Provider;
+  dateCreated: string;
+  lineItems: LineItem[];
+  patient: Patient;
+  payments: Payment[];
+  receiptNumber: string;
+  status: string;
+  adjustmentReason: any;
+  id: number;
+  resourceVersion: string;
+}
+
+export interface PatientDetails {
+  name: string;
+  age: string;
+  gender: string;
+  city: string;
+  county: string;
+  subCounty: string;
+}
+
+export interface FacilityDetail {
+  uuid: string;
+  display: string;
+}
+
+export type ServiceConcept = {
+  concept: {
+    uuid: string;
+    display: string;
+  };
+  conceptName: {
+    uuid: string;
+    display: string;
+  };
+  display: string;
+};

package/test-helpers.tsx

@@ -0,0 +1,23 @@
+import React from 'react';
+import { SWRConfig } from 'swr';
+import { render, screen, waitForElementToBeRemoved } from '@testing-library/react';
+
+const swrWrapper = ({ children }) => {
+  return (
+    <SWRConfig
+      value={{
+        dedupingInterval: 0,
+        provider: () => new Map(),
+      }}>
+      {children}
+    </SWRConfig>
+  );
+};
+
+export const renderWithSwr = (ui, options?) => render(ui, { wrapper: swrWrapper, ...options });
+
+export function waitForLoadingToFinish() {
+  return waitForElementToBeRemoved(() => [...screen.queryAllByRole('progressbar')], {
+    timeout: 4000,
+  });
+}

package/translations/am.json

@@ -0,0 +1,107 @@
+{
+  "actions": "Actions",
+  "addBillableServices": "Add Billable Services",
+  "addNewBillableService": "Add new billable service",
+  "addNewService": "Add new service",
+  "addPaymentOptions": "Add payment option",
+  "amount": "Amount",
+  "amountToWaiveAriaLabel": "Enter amount to waive",
+  "amountToWaiveHelper": "Specify the amount to be deducted from the bill",
+  "amountToWaiveLabel": "Amount to Waive",
+  "billableService": "Billable service",
+  "billableServices": "Billable Services",
+  "billedItems": "Billed Items",
+  "billedTo": "Billed to",
+  "billErrorService": "Bill service error",
+  "billing": "Billing",
+  "billItem": "Bill item",
+  "billItems": "Bill Items",
+  "billList": "Bill list",
+  "billMetrics": "Bill metrics",
+  "billName": " {{billName}} ",
+  "billPayment": "Bill payment",
+  "billPaymentRequiredMessage": "The current patient has pending bill. Advice patient to settle bill before receiving services",
+  "billServicesManagement": "Bill services management",
+  "billsList": "Bill list",
+  "billTotal": "Bill total",
+  "billWaiver": "Bill waiver",
+  "billWaiverError": "Bill waiver failed {{error}}",
+  "billWaiverSuccess": "Bill waiver successful",
+  "cancel": "Cancel",
+  "checkFilters": "Check the filters above",
+  "discard": "Discard",
+  "discount": "Discount",
+  "drug": "Drug",
+  "enterAmount": "Enter amount",
+  "enterConcept": "Associated concept",
+  "enterReferenceNumber": "Enter ref. number",
+  "errorLoadingBillServices": "Error loading bill services",
+  "errorLoadingPaymentModes": "Payment modes error",
+  "filterBy": "Filter by",
+  "filterTable": "Filter table",
+  "home": "Home",
+  "identifier": "Identifier",
+  "inlineLoading": "Loading bill items...",
+  "insuranceScheme": "Insurance scheme",
+  "invalidWaiverAmount": "Invalid waiver amount",
+  "invoice": "Invoice",
+  "invoiceError": "Invoice error",
+  "item": "Item",
+  "itemsToBeBilled": "Items to be billed",
+  "launchBillForm": "Launch bill form",
+  "lineItems": "Line items",
+  "loading": "Loading data...",
+  "loadingBillingServices": "Loading billing services...",
+  "loadingDescription": "Loading",
+  "manageBillableServices": "Manage billable services",
+  "name": "Name",
+  "nextPage": "Next page",
+  "noBilltoDisplay": "There are no bills to display for this patient",
+  "noMatchingBillsToDisplay": "No matching bills to display",
+  "noMatchingItemsToDisplay": "No matching items to display",
+  "noMatchingServicesToDisplay": "No matching services to display",
+  "nonDrug": "Non drug",
+  "noResultsFor": "No results for",
+  "noServicesToDisplay": "There are no services to display",
+  "ok": "OK",
+  "patientBillingAlert": "Patient Billing Alert",
+  "patientBills": "Patient bill",
+  "patientBillsDescription": "List of patient bills",
+  "patientCategory": "Patient category",
+  "paymentDetails": "Payment Details",
+  "paymentMethod": "Payment method",
+  "paymentMethods": "Payment methods",
+  "paymentMode": "Payment Mode",
+  "payments": "Payments",
+  "policyNumber": "Policy number",
+  "postWaiver": "Post waiver",
+  "previousPage": "Previous page",
+  "prices": "Prices",
+  "printBill": "Print bill",
+  "printReceipt": "Print receipt",
+  "processPayment": "Process Payment",
+  "quantity": "Quantity",
+  "referenceNumber": "Reference number",
+  "save": "Save",
+  "searchConcepts": "Search associated concept",
+  "searching": "Searching",
+  "searchThisTable": "Search this table",
+  "selectBillableService": "Select a billable service...",
+  "selectCategory": "Select category",
+  "selectPaymentMethod": "Select payment method",
+  "sellingAmount": "Enter selling price",
+  "sellingPrice": "Selling Price",
+  "serviceMetrics": "Service Metrics",
+  "serviceName": "Service Name",
+  "serviceShortName": "Short Name",
+  "servicesList": "Services list",
+  "serviceType": "Service Type",
+  "shortName": "Short Name",
+  "status": "Service Status",
+  "total": "Total",
+  "totalAmount": "Total Amount",
+  "totalTendered": "Total Tendered",
+  "unitPrice": "Unit price",
+  "visitTime": "Visit time",
+  "waiverForm": "Waiver form"
+}

package/translations/en.json

@@ -0,0 +1,107 @@
+{
+  "actions": "Actions",
+  "addBillableServices": "Add Billable Services",
+  "addNewBillableService": "Add new billable service",
+  "addNewService": "Add new service",
+  "addPaymentOptions": "Add payment option",
+  "amount": "Amount",
+  "amountToWaiveAriaLabel": "Enter amount to waive",
+  "amountToWaiveHelper": "Specify the amount to be deducted from the bill",
+  "amountToWaiveLabel": "Amount to Waive",
+  "billableService": "Billable service",
+  "billableServices": "Billable Services",
+  "billedItems": "Billed Items",
+  "billedTo": "Billed to",
+  "billErrorService": "Bill service error",
+  "billing": "Billing",
+  "billItem": "Bill item",
+  "billItems": "Bill Items",
+  "billList": "Bill list",
+  "billMetrics": "Bill metrics",
+  "billName": " {{billName}} ",
+  "billPayment": "Bill payment",
+  "billPaymentRequiredMessage": "The current patient has pending bill. Advice patient to settle bill before receiving services",
+  "billServicesManagement": "Bill services management",
+  "billsList": "Bill list",
+  "billTotal": "Bill total",
+  "billWaiver": "Bill waiver",
+  "billWaiverError": "Bill waiver failed {{error}}",
+  "billWaiverSuccess": "Bill waiver successful",
+  "cancel": "Cancel",
+  "checkFilters": "Check the filters above",
+  "discard": "Discard",
+  "discount": "Discount",
+  "drug": "Drug",
+  "enterAmount": "Enter amount",
+  "enterConcept": "Associated concept",
+  "enterReferenceNumber": "Enter ref. number",
+  "errorLoadingBillServices": "Error loading bill services",
+  "errorLoadingPaymentModes": "Payment modes error",
+  "filterBy": "Filter by",
+  "filterTable": "Filter table",
+  "home": "Home",
+  "identifier": "Identifier",
+  "inlineLoading": "Loading bill items...",
+  "insuranceScheme": "Insurance scheme",
+  "invalidWaiverAmount": "Invalid waiver amount",
+  "invoice": "Invoice",
+  "invoiceError": "Invoice error",
+  "item": "Item",
+  "itemsToBeBilled": "Items to be billed",
+  "launchBillForm": "Launch bill form",
+  "lineItems": "Line items",
+  "loading": "Loading data...",
+  "loadingBillingServices": "Loading billing services...",
+  "loadingDescription": "Loading",
+  "manageBillableServices": "Manage billable services",
+  "name": "Name",
+  "nextPage": "Next page",
+  "noBilltoDisplay": "There are no bills to display for this patient",
+  "noMatchingBillsToDisplay": "No matching bills to display",
+  "noMatchingItemsToDisplay": "No matching items to display",
+  "noMatchingServicesToDisplay": "No matching services to display",
+  "nonDrug": "Non drug",
+  "noResultsFor": "No results for",
+  "noServicesToDisplay": "There are no services to display",
+  "ok": "OK",
+  "patientBillingAlert": "Patient Billing Alert",
+  "patientBills": "Patient bill",
+  "patientBillsDescription": "List of patient bills",
+  "patientCategory": "Patient category",
+  "paymentDetails": "Payment Details",
+  "paymentMethod": "Payment method",
+  "paymentMethods": "Payment methods",
+  "paymentMode": "Payment Mode",
+  "payments": "Payments",
+  "policyNumber": "Policy number",
+  "postWaiver": "Post waiver",
+  "previousPage": "Previous page",
+  "prices": "Prices",
+  "printBill": "Print bill",
+  "printReceipt": "Print receipt",
+  "processPayment": "Process Payment",
+  "quantity": "Quantity",
+  "referenceNumber": "Reference number",
+  "save": "Save",
+  "searchConcepts": "Search associated concept",
+  "searching": "Searching",
+  "searchThisTable": "Search this table",
+  "selectBillableService": "Select a billable service...",
+  "selectCategory": "Select category",
+  "selectPaymentMethod": "Select payment method",
+  "sellingAmount": "Enter selling price",
+  "sellingPrice": "Selling Price",
+  "serviceMetrics": "Service Metrics",
+  "serviceName": "Service Name",
+  "serviceShortName": "Short Name",
+  "servicesList": "Services list",
+  "serviceType": "Service Type",
+  "shortName": "Short Name",
+  "status": "Service Status",
+  "total": "Total",
+  "totalAmount": "Total Amount",
+  "totalTendered": "Total Tendered",
+  "unitPrice": "Unit price",
+  "visitTime": "Visit time",
+  "waiverForm": "Waiver form"
+}