@kenyaemr/esm-admin-app 5.4.4-pre.41 → 5.4.4-pre.412

package/src/components/global-property/modal/delete-global-property-modal.test.tsx

@@ -0,0 +1,131 @@
+import React from 'react';
+import { render, screen, fireEvent, waitFor, act } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import DeleteGlobalPropertyModal from './delete-global-property-modal.component';
+
+const mockShowSnackbar = vi.fn();
+const mockDeleteGlobalProperty = vi.fn();
+
+vi.mock('react-i18next', () => ({
+  useTranslation: () => ({ t: (_key: string, fallback: string, opts?: Record<string, unknown>) => fallback }),
+}));
+
+vi.mock('@openmrs/esm-framework', () => ({
+  showSnackbar: (...args: unknown[]) => mockShowSnackbar(...args),
+}));
+
+vi.mock('../hooks/useGlobalProperty', () => ({
+  deleteGlobalProperty: (...args: unknown[]) => mockDeleteGlobalProperty(...args),
+}));
+
+describe('DeleteGlobalPropertyModal', () => {
+  const defaultProps = {
+    close: vi.fn(),
+    property: 'setting.example',
+    uuid: 'uuid-abc',
+    onDeleted: vi.fn(),
+  };
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('displays the modal heading', () => {
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    expect(screen.getByText('Delete global property')).toBeInTheDocument();
+  });
+
+  it('shows the property name in the confirmation message', () => {
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    expect(screen.getByText('Are you sure you want to delete the global property "{{property}}"?')).toBeInTheDocument();
+  });
+
+  it('shows a warning that the action cannot be undone', () => {
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    expect(screen.getByText('This action cannot be undone.')).toBeInTheDocument();
+  });
+
+  it('calls close when the Cancel button is clicked', () => {
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    fireEvent.click(screen.getByText('Cancel'));
+    expect(defaultProps.close).toHaveBeenCalledTimes(1);
+  });
+
+  it('does not call onDeleted when Cancel is clicked', () => {
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    fireEvent.click(screen.getByText('Cancel'));
+    expect(defaultProps.onDeleted).not.toHaveBeenCalled();
+  });
+
+  it('calls deleteGlobalProperty with the correct uuid when Delete is clicked', async () => {
+    mockDeleteGlobalProperty.mockResolvedValue(undefined);
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    fireEvent.click(screen.getByText('Delete'));
+    await waitFor(() => {
+      expect(mockDeleteGlobalProperty).toHaveBeenCalledWith('uuid-abc');
+    });
+  });
+
+  it('shows a success snackbar and closes the modal after successful deletion', async () => {
+    mockDeleteGlobalProperty.mockResolvedValue(undefined);
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    fireEvent.click(screen.getByText('Delete'));
+    await waitFor(() => {
+      expect(mockShowSnackbar).toHaveBeenCalledWith(expect.objectContaining({ kind: 'success' }));
+      expect(defaultProps.onDeleted).toHaveBeenCalledTimes(1);
+      expect(defaultProps.close).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  it('shows an error snackbar when deletion fails', async () => {
+    mockDeleteGlobalProperty.mockRejectedValue(new Error('Server error'));
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+    fireEvent.click(screen.getByText('Delete'));
+    await waitFor(() => {
+      expect(mockShowSnackbar).toHaveBeenCalledWith(expect.objectContaining({ kind: 'error' }));
+      expect(defaultProps.close).not.toHaveBeenCalled();
+      expect(defaultProps.onDeleted).not.toHaveBeenCalled();
+    });
+  });
+
+  it('disables both buttons while deletion is in progress', async () => {
+    let resolveDelete: () => void;
+    mockDeleteGlobalProperty.mockReturnValue(
+      new Promise<void>((res) => {
+        resolveDelete = res;
+      }),
+    );
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+
+    fireEvent.click(screen.getByText('Delete'));
+
+    await waitFor(() => {
+      expect(screen.getByText('Cancel')).toBeDisabled();
+    });
+
+    await act(async () => {
+      resolveDelete!();
+    });
+  });
+
+  it('shows a loading indicator while deletion is in progress', async () => {
+    let resolveDelete: () => void;
+    mockDeleteGlobalProperty.mockReturnValue(
+      new Promise<void>((res) => {
+        resolveDelete = res;
+      }),
+    );
+    render(<DeleteGlobalPropertyModal {...defaultProps} />);
+
+    fireEvent.click(screen.getByText('Delete'));
+
+    await waitFor(() => {
+      expect(screen.getByText('Deleting...')).toBeInTheDocument();
+    });
+
+    await act(async () => {
+      resolveDelete!();
+    });
+  });
+});

package/src/components/global-property/table/global-property-table.component.tsx

@@ -0,0 +1,249 @@
+import React, { useCallback, useMemo, useState } from 'react';
+import {
+  Button,
+  DataTable,
+  DataTableSkeleton,
+  Pagination,
+  Search,
+  Table,
+  TableBody,
+  TableCell,
+  TableHead,
+  TableHeader,
+  TableRow,
+  type DataTableHeader,
+} from '@carbon/react';
+import { Add, Edit, TrashCan } from '@carbon/react/icons';
+import { useTranslation } from 'react-i18next';
+import {
+  ErrorCard,
+  isDesktop,
+  launchWorkspace2,
+  showModal,
+  useDebounce,
+  useLayoutType,
+  usePaginationInfo,
+} from '@openmrs/esm-framework';
+
+import { useGlobalProperties } from '../hooks/useGlobalProperty';
+import styles from './global-property-table.scss';
+
+const DEFAULT_PAGE_SIZE = 10;
+const PAGE_SIZE_OPTIONS = [10, 20, 50, 100];
+
+type GlobalPropertyRow = {
+  id: string;
+  property: string;
+  value: string;
+};
+
+const GlobalPropertyTable: React.FC = () => {
+  const { t } = useTranslation();
+  const layoutType = useLayoutType();
+  const desktop = isDesktop(layoutType);
+
+  const [pageSize, setPageSize] = useState(DEFAULT_PAGE_SIZE);
+  const [searchTerm, setSearchTerm] = useState('');
+  const debouncedSearchTerm = useDebounce(searchTerm, 300);
+
+  const {
+    isLoading,
+    data: globalProperties = [],
+    error,
+    goTo,
+    currentPage,
+    totalCount,
+    mutate,
+  } = useGlobalProperties(pageSize, debouncedSearchTerm);
+
+  const { pageSizes } = usePaginationInfo(DEFAULT_PAGE_SIZE, totalCount, currentPage, globalProperties.length);
+
+  const headers: Array<DataTableHeader> = useMemo(
+    () => [
+      { key: 'property', header: t('property', 'Property') },
+      { key: 'value', header: t('value', 'Value') },
+    ],
+    [t],
+  );
+
+  const rows: Array<GlobalPropertyRow> = useMemo(
+    () =>
+      globalProperties.map((gp, idx) => ({
+        id: gp?.uuid ?? `gp-${idx}`,
+        property: gp?.property ?? '',
+        value: gp?.value ?? '',
+      })),
+    [globalProperties],
+  );
+
+  const handleSearchChange = useCallback(
+    (event: React.ChangeEvent<HTMLInputElement>) => {
+      setSearchTerm(event.target.value);
+      if (currentPage !== 1) {
+        goTo(1);
+      }
+    },
+    [currentPage, goTo],
+  );
+
+  const handlePaginationChange = useCallback(
+    ({ page, pageSize: newSize }: { page: number; pageSize: number }) => {
+      if (newSize !== pageSize) {
+        setPageSize(newSize);
+      }
+      goTo(page);
+    },
+    [pageSize, goTo],
+  );
+
+  const openWorkspace = useCallback(
+    (systemSetting?: (typeof globalProperties)[number]) => {
+      launchWorkspace2('global-property-workspace', {
+        systemSetting,
+        mutateGlobalProperty: mutate,
+      });
+    },
+    [globalProperties, mutate],
+  );
+
+  const handleEdit = useCallback(
+    (row: GlobalPropertyRow) => {
+      const systemSetting = globalProperties.find((gp) => gp.uuid === row.id);
+      openWorkspace(systemSetting);
+    },
+    [globalProperties, openWorkspace],
+  );
+
+  const handleDelete = useCallback(
+    (row: GlobalPropertyRow) => {
+      const dispose = showModal('delete-global-property-modal', {
+        close: () => dispose(),
+        property: row.property,
+        uuid: row.id,
+        onDeleted: () => mutate(),
+      });
+    },
+    [mutate],
+  );
+
+  const renderContent = () => {
+    if (isLoading) {
+      return (
+        <DataTableSkeleton
+          aria-label={t('globalProperties', 'Global properties')}
+          headers={headers}
+          showHeader
+          showToolbar
+        />
+      );
+    }
+
+    if (rows.length === 0) {
+      return (
+        <p className={styles.emptyState}>
+          {debouncedSearchTerm
+            ? t('noMatchingGlobalProperties', 'No global properties match your search')
+            : t('noGlobalProperties', 'No global properties to display')}
+        </p>
+      );
+    }
+
+    return (
+      <>
+        <DataTable useZebraStyles size={desktop ? 'sm' : 'md'} rows={rows} headers={headers}>
+          {({ rows: renderRows, headers: renderHeaders, getTableProps, getHeaderProps, getRowProps, getCellProps }) => (
+            <Table {...getTableProps()}>
+              <TableHead>
+                <TableRow>
+                  {renderHeaders.map((header) => (
+                    <TableHeader {...getHeaderProps({ header })}>{header.header}</TableHeader>
+                  ))}
+                  <TableHeader>
+                    <span className={styles.visuallyHidden}>{t('actions', 'Actions')}</span>
+                  </TableHeader>
+                </TableRow>
+              </TableHead>
+              <TableBody>
+                {renderRows.map((row) => {
+                  const sourceRow = rows.find((r) => r.id === row.id)!;
+                  return (
+                    <TableRow {...getRowProps({ row })}>
+                      {row.cells.map((cell) => (
+                        <TableCell {...getCellProps({ cell })}>{cell.value}</TableCell>
+                      ))}
+                      <TableCell className={styles.actionsCell}>
+                        <Button
+                          kind="ghost"
+                          size="sm"
+                          renderIcon={Edit}
+                          iconDescription={t('edit', 'Edit')}
+                          hasIconOnly
+                          onClick={() => handleEdit(sourceRow)}
+                        />
+                        <Button
+                          kind="danger--ghost"
+                          size="sm"
+                          renderIcon={TrashCan}
+                          iconDescription={t('delete', 'Delete')}
+                          hasIconOnly
+                          onClick={() => handleDelete(sourceRow)}
+                        />
+                      </TableCell>
+                    </TableRow>
+                  );
+                })}
+              </TableBody>
+            </Table>
+          )}
+        </DataTable>
+
+        <Pagination
+          itemsPerPageText={t('itemsPerPage', 'Items per page:')}
+          forwardText={t('nextPage', 'Next page')}
+          backwardText={t('previousPage', 'Previous page')}
+          itemRangeText={(min, max, total) =>
+            t('minMaxItems', '{{min}}-{{max}} of {{total}} items', { min, max, total })
+          }
+          pageRangeText={(_current, total) => t('pageRangeText', 'of {{count}} pages', { count: total })}
+          page={currentPage}
+          pageSize={pageSize}
+          pageSizes={pageSizes?.length > 0 ? pageSizes : PAGE_SIZE_OPTIONS}
+          totalItems={totalCount ?? 0}
+          onChange={handlePaginationChange}
+        />
+      </>
+    );
+  };
+
+  if (error) {
+    return (
+      <div className={styles.dataTableContainer}>
+        <ErrorCard error={error} headerTitle={t('globalPropertyError', 'Global property')} />
+      </div>
+    );
+  }
+
+  return (
+    <div className={styles.dataTableContainer}>
+      <div className={styles.tableHeaderSection}>
+        <Search
+          id="global-property-search"
+          labelText=""
+          placeholder={t('searchGlobalPropertiesByName', 'Search global property by name')}
+          closeButtonLabelText={t('clearSearchButton', 'Clear search button')}
+          size={desktop ? 'md' : 'lg'}
+          value={searchTerm}
+          onChange={handleSearchChange}
+          type="search"
+        />
+        <Button size={desktop ? 'md' : 'lg'} kind="ghost" renderIcon={Add} onClick={() => openWorkspace()}>
+          {t('addGlobalProperty', 'Add new global property')}
+        </Button>
+      </div>
+
+      {renderContent()}
+    </div>
+  );
+};
+
+export default GlobalPropertyTable;

package/src/components/global-property/table/global-property-table.scss

@@ -0,0 +1,34 @@
+@use '@carbon/layout';
+
+.dataTableContainer {
+  height: 100%;
+  margin: layout.$layout-01;
+}
+
+.tableHeaderSection {
+  display: flex;
+  align-items: center;
+}
+
+.actionsCell {
+  display: flex;
+  justify-content: flex-end;
+}
+
+.visuallyHidden {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  margin: -1px;
+  overflow: hidden;
+  clip: rect(0, 0, 0, 0);
+  white-space: nowrap;
+  border: 0;
+}
+
+.emptyState {
+  padding: 2rem;
+  text-align: center;
+  color: var(--cds-text-secondary);
+}

package/src/components/global-property/table/global-property-table.test.tsx

@@ -0,0 +1,198 @@
+import React from 'react';
+import { render, screen, fireEvent, waitFor } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { vi, describe, it, expect, beforeEach } from 'vitest';
+import GlobalPropertyTable from './global-property-table.component';
+
+const mockGoTo = vi.fn();
+const mockMutate = vi.fn();
+const mockLaunchWorkspace2 = vi.fn();
+const mockShowModal = vi.fn(() => vi.fn());
+
+vi.mock('react-i18next', () => ({
+  useTranslation: () => ({ t: (_key: string, fallback: string, opts?: Record<string, unknown>) => fallback }),
+}));
+
+vi.mock('@openmrs/esm-framework', () => ({
+  useLayoutType: vi.fn(() => 'desktop'),
+  isDesktop: vi.fn(() => true),
+  launchWorkspace2: (...args: unknown[]) => mockLaunchWorkspace2(...args),
+  showModal: (...args: unknown[]) => mockShowModal(...args),
+  useDebounce: vi.fn((val: string) => val),
+  usePaginationInfo: vi.fn(() => ({ pageSizes: [10, 20, 50] })),
+  ErrorCard: ({ headerTitle }: { headerTitle: string }) => <div data-testid="error-card">{headerTitle}</div>,
+}));
+
+vi.mock('@carbon/react', async (importOriginal) => {
+  const original = await importOriginal<typeof import('@carbon/react')>();
+  return {
+    ...original,
+    DataTable: ({
+      children,
+      rows,
+      headers,
+    }: {
+      children: (props: any) => React.ReactNode;
+      rows: any[];
+      headers: any[];
+    }) => {
+      if (typeof children === 'function') {
+        const renderRows = rows.map((row) => ({
+          ...row,
+          cells: headers.map((h) => ({
+            id: `${row.id}:${h.key}`,
+            value: row[h.key],
+            info: { header: h.key },
+          })),
+        }));
+        return children({
+          rows: renderRows,
+          headers,
+          getTableProps: () => ({}),
+          getHeaderProps: ({ header }: any) => ({ key: header.key }),
+          getRowProps: ({ row }: any) => ({ key: row.id }),
+          getCellProps: ({ cell }: any) => ({ key: cell.id }),
+        });
+      }
+      return children;
+    },
+    Button: ({ children, onClick, disabled, iconDescription, hasIconOnly, type }: any) => (
+      <button
+        onClick={onClick}
+        disabled={disabled}
+        aria-label={hasIconOnly ? iconDescription : undefined}
+        type={type || 'button'}>
+        {hasIconOnly ? null : children}
+      </button>
+    ),
+  };
+});
+
+vi.mock('../hooks/useGlobalProperty', () => ({
+  useGlobalProperties: vi.fn(),
+}));
+
+import { useGlobalProperties } from '../hooks/useGlobalProperty';
+
+const mockProperties = [
+  { uuid: 'uuid-1', property: 'setting.one', value: 'value1', description: 'First setting' },
+  { uuid: 'uuid-2', property: 'setting.two', value: 'value2', description: 'Second setting' },
+];
+
+function setupMock(overrides = {}) {
+  (useGlobalProperties as ReturnType<typeof vi.fn>).mockReturnValue({
+    isLoading: false,
+    data: mockProperties,
+    error: null,
+    goTo: mockGoTo,
+    currentPage: 1,
+    totalCount: 2,
+    mutate: mockMutate,
+    ...overrides,
+  });
+}
+
+describe('GlobalPropertyTable', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('shows a loading skeleton while data is loading', () => {
+    setupMock({ isLoading: true, data: [] });
+    render(<GlobalPropertyTable />);
+    expect(screen.getByRole('table')).toBeInTheDocument();
+  });
+
+  it('shows empty state message when no properties exist', () => {
+    setupMock({ data: [] });
+    render(<GlobalPropertyTable />);
+    expect(screen.getByText('No global properties to display')).toBeInTheDocument();
+  });
+
+  it('renders the table with property and value columns', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    expect(screen.getByText('Property')).toBeInTheDocument();
+    expect(screen.getByText('Value')).toBeInTheDocument();
+  });
+
+  it('renders all global property rows', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    expect(screen.getByText('setting.one')).toBeInTheDocument();
+    expect(screen.getByText('value1')).toBeInTheDocument();
+    expect(screen.getByText('setting.two')).toBeInTheDocument();
+    expect(screen.getByText('value2')).toBeInTheDocument();
+  });
+
+  it('opens the add workspace when "Add new global property" button is clicked', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    fireEvent.click(screen.getByText('Add new global property'));
+    expect(mockLaunchWorkspace2).toHaveBeenCalledWith(
+      'global-property-workspace',
+      expect.objectContaining({
+        systemSetting: undefined,
+        mutateGlobalProperty: mockMutate,
+      }),
+    );
+  });
+
+  it('opens the edit workspace with the correct property when edit is clicked', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    const editButtons = screen.getAllByRole('button', { name: 'Edit' });
+    fireEvent.click(editButtons[0]);
+    expect(mockLaunchWorkspace2).toHaveBeenCalledWith(
+      'global-property-workspace',
+      expect.objectContaining({
+        systemSetting: mockProperties[0],
+      }),
+    );
+  });
+
+  it('opens the delete modal with the correct property when delete is clicked', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    const deleteButtons = screen.getAllByRole('button', { name: 'Delete' });
+    fireEvent.click(deleteButtons[0]);
+    expect(mockShowModal).toHaveBeenCalledWith(
+      'delete-global-property-modal',
+      expect.objectContaining({
+        property: 'setting.one',
+        uuid: 'uuid-1',
+      }),
+    );
+  });
+
+  it('filters results and resets to page 1 when user types in the search box', async () => {
+    setupMock({ currentPage: 2 });
+    render(<GlobalPropertyTable />);
+    const searchInput = screen.getByPlaceholderText('Search global property by name');
+    fireEvent.change(searchInput, { target: { value: 'setting' } });
+    await waitFor(() => {
+      expect(mockGoTo).toHaveBeenCalledWith(1);
+    });
+  });
+
+  it('shows "no matching" message when search yields no results', () => {
+    setupMock({ data: [] });
+    render(<GlobalPropertyTable />);
+    const searchInput = screen.getByPlaceholderText('Search global property by name');
+    fireEvent.change(searchInput, { target: { value: 'nonexistent' } });
+    expect(screen.getByText('No global properties match your search')).toBeInTheDocument();
+  });
+
+  it('renders an error card when the hook returns an error', () => {
+    setupMock({ error: new Error('Network error'), data: [] });
+    render(<GlobalPropertyTable />);
+    expect(screen.getByTestId('error-card')).toBeInTheDocument();
+    expect(screen.getByText('Global property')).toBeInTheDocument();
+  });
+
+  it('renders a search input for filtering properties', () => {
+    setupMock();
+    render(<GlobalPropertyTable />);
+    expect(screen.getByPlaceholderText('Search global property by name')).toBeInTheDocument();
+  });
+});

package/src/components/global-property/workspace/global-property-form-schema.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+import type { TFunction } from 'i18next';
+
+export const createGlobalPropertyFormSchema = (t: TFunction) =>
+  z.object({
+    property: z.string().min(1, { message: t('gpPropertyNameRequired', 'Property name is required') }),
+    description: z.string().optional(),
+    datatypeClassname: z.string().optional(),
+    datatypeConfig: z.string().optional(),
+    preferredHandlerClassname: z.string().optional(),
+    handlerConfig: z.string().nullable().optional(),
+    value: z.string().min(1, { message: t('gpValueRequired', 'Value is required') }),
+  });
+
+export type GlobalPropertyFormType = z.infer<ReturnType<typeof createGlobalPropertyFormSchema>>;
+
+export const openmrsCustomDatatypes = [
+  'org.openmrs.customdatatype.datatype.BooleanDatatype',
+  'org.openmrs.customdatatype.datatype.DateDatatype',
+  'org.openmrs.customdatatype.datatype.DateTimeDatatype',
+  'org.openmrs.customdatatype.datatype.FloatDatatype',
+  'org.openmrs.customdatatype.datatype.FreeTextDatatype',
+  'org.openmrs.customdatatype.datatype.LongFreeTextDatatype',
+  'org.openmrs.customdatatype.datatype.RegexValidatedTextDatatype',
+  'org.openmrs.customdatatype.datatype.SpecifiedTextOptionsDatatype',
+  'org.openmrs.customdatatype.datatype.ConceptDatatype',
+  'org.openmrs.customdatatype.datatype.LocationDatatype',
+  'org.openmrs.customdatatype.datatype.ProgramDatatype',
+  'org.openmrs.customdatatype.datatype.ProviderDatatype',
+];
+
+export type OpenmrsCustomDatatype = (typeof openmrsCustomDatatypes)[number];

package/src/components/global-property/workspace/global-property.workspace.scss

@@ -0,0 +1,40 @@
+@use '@carbon/colors';
+@use '@carbon/layout';
+
+.form {
+  display: flex;
+  flex-direction: column;
+  justify-content: space-between;
+  height: 100%;
+}
+
+.formContainer {
+  margin: layout.$spacing-05;
+  display: flex;
+  flex-direction: column;
+  gap: layout.$spacing-05;
+  overflow-y: auto;
+}
+
+.tablet {
+  padding: layout.$spacing-06 layout.$spacing-05;
+  background-color: colors.$white;
+}
+
+.desktop {
+  padding: 0;
+
+  & button {
+    max-width: 50% !important;
+  }
+}
+
+.buttonContainer {
+  max-width: 50%;
+}
+
+.inlineLoading {
+  display: flex;
+  align-items: center;
+  gap: layout.$spacing-03;
+}