@palladium-ethiopia/esm-admin-app 5.4.2-pre.100

package/src/components/users/userManagementFormSchema.tsx

@@ -0,0 +1,179 @@
+import { useTranslation } from 'react-i18next';
+import { z } from 'zod';
+
+const PHONE_REGEX = /^\+?[\d\s\-()]+$/;
+const MIN_PHONE_DIGITS = 9;
+const MIN_USERNAME_LENGTH = 3;
+const MIN_PASSWORD_LENGTH = 8;
+
+const UserManagementFormSchema = (
+  existingUsernames: Array<string>,
+  isEdit?: boolean,
+  shouldValidatePhoneEmail = true,
+  isInitialValuesEmpty = true,
+) => {
+  const { t } = useTranslation();
+
+  const userManagementFormSchema = z
+    .object({
+      givenName: z.string().nonempty(t('givenNameRequired', 'Given name is required')),
+      middleName: z.string().optional(),
+      familyName: z.string().nonempty(t('familyNameRequired', 'Family name is required')),
+      gender: z.enum(['M', 'F'], {
+        errorMap: () => ({
+          message: t('genderRequired', 'Gender is required'),
+        }),
+      }),
+      phoneNumber: shouldValidatePhoneEmail
+        ? z
+            .string()
+            .optional()
+            .refine(
+              (val) => {
+                if (!val || val.trim() === '') {
+                  return true;
+                }
+                const digitsOnly = val.replace(/\D/g, '');
+                return PHONE_REGEX.test(val) && digitsOnly.length >= MIN_PHONE_DIGITS;
+              },
+              { message: t('invalidPhoneNumber', 'Invalid phone number') },
+            )
+        : z.string().optional(),
+      email: shouldValidatePhoneEmail
+        ? z
+            .string()
+            .optional()
+            .refine((val) => !val || val.trim() === '' || z.string().email().safeParse(val).success, {
+              message: t('invalidEmail', 'Invalid email address'),
+            })
+        : z.string().optional(),
+      providerIdentifiers: z.boolean().optional(),
+      username: z
+        .string()
+        .optional()
+        .transform((s) => s?.trim() ?? '')
+        .pipe(
+          z
+            .string()
+            .min(1, t('usernameRequired', 'Username is required'))
+            .min(
+              MIN_USERNAME_LENGTH,
+              t('usernameMinLength', 'Username must be at least {{count}} characters', {
+                count: MIN_USERNAME_LENGTH,
+              }),
+            )
+            .refine((value) => !existingUsernames.includes(value), {
+              message: t('usernameTaken', 'Username already exists'),
+            }),
+        ),
+      password: isInitialValuesEmpty
+        ? z
+            .string()
+            .optional()
+            .transform((s) => s?.trim() ?? '')
+            .pipe(
+              z
+                .string()
+                .min(1, t('passwordRequired', 'Password is required'))
+                .min(
+                  MIN_PASSWORD_LENGTH,
+                  t('passwordMinLength', 'Password must be at least {{count}} characters', {
+                    count: MIN_PASSWORD_LENGTH,
+                  }),
+                )
+                .refine((val) => /[a-z]/.test(val) && /[A-Z]/.test(val) && /[0-9]/.test(val), {
+                  message: t(
+                    'passwordCaseRequired',
+                    'Password must contain at least one lowercase letter, one uppercase letter, and one number.',
+                  ),
+                }),
+            )
+        : z
+            .string()
+            .optional()
+            .transform((s) => s?.trim() ?? ''),
+      confirmPassword: isInitialValuesEmpty
+        ? z
+            .string()
+            .optional()
+            .transform((s) => s?.trim() ?? '')
+            .pipe(z.string().min(1, t('confirmPasswordRequired', 'Please confirm your password')))
+        : z
+            .string()
+            .optional()
+            .transform((s) => s?.trim() ?? ''),
+      roles: z
+        .array(
+          z.object({
+            uuid: z.string().min(1, 'UUID is required'),
+            display: z.string().min(1, 'Role name is required'),
+            description: z.string().nullable().optional(),
+          }),
+        )
+        .optional(),
+      primaryRole: z.string().optional(),
+      systemId: z.string().optional(),
+      providerLicense: z.string().optional(),
+      licenseExpiryDate: z.date().optional(),
+      registrationNumber: z.string().optional(),
+      qualification: z.string().optional(),
+      nationalId: z.string().optional(),
+      passportNumber: z.string().optional(),
+      isEditProvider: z.boolean().optional(),
+      providerUniqueIdentifier: z.string().optional(),
+    })
+    .refine((data) => !isInitialValuesEmpty || data.password === data.confirmPassword, {
+      message: t('passwordsDoNotMatch', 'Passwords do not match'),
+      path: ['confirmPassword'],
+    })
+    .superRefine((data, ctx) => {
+      if (isInitialValuesEmpty) {
+        return;
+      }
+      const p = (data.password ?? '').trim();
+      const c = (data.confirmPassword ?? '').trim();
+      if (!p && !c) {
+        return;
+      }
+      if (!p) {
+        ctx.addIssue({ code: 'custom', message: t('passwordRequired', 'Password is required'), path: ['password'] });
+        return;
+      }
+      if (p.length < MIN_PASSWORD_LENGTH) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('passwordMinLength', 'Password must be at least {{count}} characters', {
+            count: MIN_PASSWORD_LENGTH,
+          }),
+          path: ['password'],
+        });
+      }
+      if (!/[a-z]/.test(p) || !/[A-Z]/.test(p) || !/[0-9]/.test(p)) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t(
+            'passwordCaseRequired',
+            'Password must contain at least one lowercase letter, one uppercase letter, and one number.',
+          ),
+          path: ['password'],
+        });
+      }
+      if (!c) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('confirmPasswordRequired', 'Please confirm your password'),
+          path: ['confirmPassword'],
+        });
+      } else if (p !== c) {
+        ctx.addIssue({
+          code: 'custom',
+          message: t('passwordsDoNotMatch', 'Passwords do not match'),
+          path: ['confirmPassword'],
+        });
+      }
+    });
+
+  return { userManagementFormSchema };
+};
+
+export default UserManagementFormSchema;

package/src/config-schema.ts

@@ -0,0 +1,142 @@
+import { fhirBaseUrl, Type } from '@openmrs/esm-framework';
+import dayjs from 'dayjs';
+
+export const configSchema = {
+  providerNationalIdUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider national id',
+    _default: '3d152c97-2293-4a2b-802e-e0f1009b7b15',
+  },
+  passportNumberUuid: {
+    _type: Type.String,
+    _description: 'UUID for passport number identification for provider',
+    _default: '5b4b88e8-9db3-41e6-a175-5e39f2c8a9a5',
+  },
+  providerHieFhirReference: {
+    _type: Type.String,
+    _description: 'UUID for provider hie fhir reference',
+    _default: '67b94e8e-4d61-4810-b0f1-d86497f6e553',
+  },
+  qualificationUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider hie qualification',
+    _default: '43f99413-6e7f-4812-bc60-066bb1d43f94',
+  },
+  licenseBodyUuid: {
+    _type: Type.String,
+    _description: 'UUID for license body',
+    _default: 'ba18bb97-d17c-4640-80d2-58e7df90ca4c',
+  },
+  licenseNumberUuid: {
+    _type: Type.String,
+    _description: 'UUID for license number',
+    _default: 'bcaaa67b-cc72-4662-90c2-e1e992ceda66',
+  },
+  licenseExpiryDateUuid: {
+    _type: Type.String,
+    _description: 'UUID for license expiry date',
+    _default: '00539959-a1c7-4848-a5ed-8941e9d5e835',
+  },
+  phoneNumberUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider phone number',
+    _default: '37daed7f-1f4e-4e62-8e83-6048ade18a87',
+  },
+  providerAddressUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider address',
+    _default: '033ff604-ecf7-464f-b623-5b77c733667f',
+  },
+  personEmailAttributeUuid: {
+    _type: Type.String,
+    _description: 'UUID for person email attribute',
+    _default: 'b8d0b331-1d2d-4a9a-b741-1816f498bdb6',
+  },
+  personPhonenumberAttributeUuid: {
+    _type: Type.String,
+    _description: 'UUID for person phone number attribute',
+    _default: 'b2c38640-2603-4629-aebd-3b54f33f1e3a',
+  },
+  providerUniqueIdentifierAttributeTypeUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider unique identifier attribute type',
+    _default: 'dace9d99-9f29-4653-9eae-c05929f34a32',
+  },
+  providerExternalIdAttributeTypeUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider external id attribute type',
+    _default: 'bbdf67e8-c020-40ff-8ad6-74ba34893882',
+  },
+  providerIHRISIdentifierAttributeTypeUuid: {
+    _type: Type.String,
+    _description: 'UUID for provider IHRIS identifier attribute type',
+    _default: '5dd3eb8a-c901-4eab-bb32-a28493781aae',
+  },
+  identifierTypes: {
+    _type: Type.Array,
+    _elements: {
+      _type: Type.Object,
+      properties: {
+        key: { _type: Type.String },
+        name: { _type: Type.String },
+      },
+    },
+    _default: [
+      { key: 'National ID', name: 'National ID' },
+      { key: 'registration_number', name: 'Registration Number' },
+      { key: 'Passport', name: 'Passport Number' },
+    ],
+    _description: 'List of identifier types with unique keys for each.',
+  },
+  regulatorOptions: {
+    _type: Type.Array,
+    _elements: {
+      _type: Type.Object,
+      properties: {
+        key: { _type: Type.String },
+        name: { _type: Type.String },
+      },
+    },
+    _default: [
+      { key: 'Clinical Officers Council', name: 'Clinical Officers Council' },
+      { key: 'Pharmacy and Poisons Board', name: 'Pharmacy and Poisons Board' },
+      { key: 'Nursing Council', name: 'Nursing Council' },
+      { key: 'KMPDC', name: 'Kenya Medical Practitioners and Dentists Council (KMPDC)' },
+      {
+        key: 'Kenya Medical Laboratory Technicians & Technologists Board',
+        name: 'Kenya Medical Laboratory Technicians & Technologists Board',
+      },
+    ],
+    _description: 'List of regulator options with unique keys for each.',
+  },
+};
+
+export interface UserProperties {
+  loginAttempts: string;
+  lastViewedPatientIds: string;
+}
+
+export interface ConfigObject {
+  providerNationalIdUuid: string;
+  passportNumberUuid: string;
+  providerHieFhirReference: string;
+  providerUniqueIdentifierAttributeTypeUuid: string;
+  phoneNumberUuid: string;
+  providerAddressUuid: string;
+  qualificationUuid: string;
+  licenseBodyUuid: string;
+  licenseNumberUuid: string;
+  personEmailAttributeUuid: string;
+  personPhonenumberAttributeUuid: string;
+  licenseExpiryDateUuid: string;
+  providerExternalIdAttributeTypeUuid: string;
+  providerIHRISIdentifierAttributeTypeUuid: string;
+  identifierTypes: Array<{
+    key: string;
+    name: string;
+  }>;
+  regulatorOptions: Array<{
+    key: string;
+    name: string;
+  }>;
+}

package/src/constants.ts

@@ -0,0 +1,50 @@
+export const moduleName = '@palladium-ethiopia/esm-admin-app';
+export const etlBasePath = `${window.spaBase}`;
+
+export const today = () => {
+  const date = new Date();
+  return new Date(date.getFullYear(), date.getMonth(), date.getDate());
+};
+
+export const DATE_PICKER_CONTROL_FORMAT = 'd/m/Y';
+
+export const DATE_PICKER_FORMAT = 'DD/MM/YYYY';
+
+export const formatNewDate = (date: Date | null | undefined) => {
+  return date ? new Date(date) : '';
+};
+
+/**
+ * Represents the error response from the Health Care Worker Registry API
+ * when no valid credentials are provided or found.
+ * @constant {string}
+ */
+export const HWR_API_NO_CREDENTIALS = 'NO_API_CREDENNTIALS';
+/**
+ * Represents the error response from the Health Care Worker Registry API
+ * when when resource is not found
+ * @constant {string}
+ */
+export const RESOURCE_NOT_FOUND = 'RESOURCE_NOT_FOUND';
+/**
+ * Represents the error response from the Health Care Worker Registry API
+ * When Uknown error occures
+ * @constant {string}
+ */
+export const UNKNOWN = 'UNKNOWN';
+
+/**
+ * Represents the error response from the Health Care Worker Registry API
+ * when when prover with given identifier is not found
+ * @constant {string}
+ */
+export const PROVIDER_NOT_FOUND = 'PROVIDER_NOT_FOUND';
+export const ROLE_CATEGORIES = {
+  CORE_INVENTORY: 'Core Inventory Roles',
+};
+export const SECTIONS = {
+  LOGIN: 'login',
+  ROLES: 'roles',
+  DEMOGRAPHIC: 'demographic',
+  PROVIDER: 'provider',
+};

package/src/declarations.d.ts

@@ -0,0 +1,2 @@
+declare module '*.css';
+declare module '*.scss';

package/src/index.ts

@@ -0,0 +1,55 @@
+import { defineConfigSchema, getSyncLifecycle } from '@openmrs/esm-framework';
+import { configSchema } from './config-schema';
+import { moduleName } from './constants';
+import OperationConfirmation from './components/confirm-modal/confirmation-operation-modal.component';
+import Root from './root.component';
+import ManageUserWorkspace from './components/users/manage-users/user-management.workspace';
+import { createLeftPanelLink } from './left-pannel-link.component';
+import HWRConfirmModal from './components/modal/hwr-confirmation.modal';
+import HWREmptyModal from './components/modal/hwr-empty.modal.component';
+import UserRoleScopeWorkspace from './components/users/manage-users/manage-user-role-scope/user-role-scope-workspace/user-role-scope.workspace';
+import HWRSyncModal from './components/modal/hwr-sync.modal';
+import AddLocationWorkspace from './components/locations/forms/add-location/add-location.workspace';
+import SearchLocationWorkspace from './components/locations/forms/search-location/search-location.workspace';
+import ProviderBannerTag from './components/provider-banner/provider-banner.component';
+
+const options = {
+  featureName: 'esm-admin-app',
+  moduleName,
+};
+
+export const importTranslation = require.context('../translations', false, /.json$/, 'lazy');
+
+export const root = getSyncLifecycle(Root, options);
+
+export function startupApp() {
+  defineConfigSchema(moduleName, configSchema);
+}
+
+export const operationConfirmationModal = getSyncLifecycle(OperationConfirmation, options);
+export const manageUserWorkspace = getSyncLifecycle(ManageUserWorkspace, options);
+export const userRoleScopeWorkspace = getSyncLifecycle(UserRoleScopeWorkspace, options);
+
+export const userManagementLeftPannelLink = getSyncLifecycle(
+  createLeftPanelLink({ title: 'Manage Users', name: 'user-management' }),
+  options,
+);
+
+export const locationsLeftPanelLink = getSyncLifecycle(
+  createLeftPanelLink({ title: 'Locations', name: 'locations' }),
+  options,
+);
+export const facilitySetupLeftPanelLink = getSyncLifecycle(
+  createLeftPanelLink({ title: 'Facility Details', name: 'facility-setup' }),
+  options,
+);
+
+export const hwrConfirmationModal = getSyncLifecycle(HWRConfirmModal, options);
+export const hwrEmptyModal = getSyncLifecycle(HWREmptyModal, options);
+export const hwrSyncModal = getSyncLifecycle(HWRSyncModal, options);
+
+export const addLocation = getSyncLifecycle(AddLocationWorkspace, options);
+export const searchLocationWorkspace = getSyncLifecycle(SearchLocationWorkspace, options);
+
+// t('providerBanner', 'Provider banner')
+export const providerBanner = getSyncLifecycle(ProviderBannerTag, options);

package/src/left-pannel-link.component.tsx

@@ -0,0 +1,40 @@
+import React, { useMemo } from 'react';
+import last from 'lodash-es/last';
+import { BrowserRouter, useLocation } from 'react-router-dom';
+import { ConfigurableLink } from '@openmrs/esm-framework';
+
+export interface LinkConfig {
+  name: string;
+  title: string;
+}
+
+function LinkExtension({ config }: { config: LinkConfig }) {
+  const { name, title } = config;
+  const location = useLocation();
+
+  let urlSegment = useMemo(() => decodeURIComponent(last(location.pathname.split('/'))), [location.pathname]);
+
+  const isUUID = (value) => {
+    const regex = /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/;
+    return regex.test(value);
+  };
+
+  if (isUUID(urlSegment)) {
+    urlSegment = 'user-management';
+  }
+
+  return (
+    <ConfigurableLink
+      to={`${window.getOpenmrsSpaBase()}admin${name && name !== 'admin' ? `/${name}` : ''}`}
+      className={`cds--side-nav__link ${name === urlSegment && 'active-left-nav-link'}`}>
+      {title}
+    </ConfigurableLink>
+  );
+}
+
+export const createLeftPanelLink = (config: LinkConfig) => () =>
+  (
+    <BrowserRouter>
+      <LinkExtension config={config} />
+    </BrowserRouter>
+  );

package/src/root.component.tsx

@@ -0,0 +1,39 @@
+import React, { useEffect } from 'react';
+import { BrowserRouter, Route, Routes } from 'react-router-dom';
+import { setLeftNav, unsetLeftNav, WorkspaceContainer } from '@openmrs/esm-framework';
+import styles from './root.scss';
+import LeftPanel from './components/side-menu/left-pannel.component';
+import UserManagentLandingPage from './components/users/manage-users/manage-user.component';
+import EtlAdminDashboard from './components/dashboard/etl-dashboard.component';
+import FacilitySetup from './components/facility-setup/facility-setup.component';
+import HomeComponent from './components/locations/home/home-locations.component';
+
+const Root: React.FC = () => {
+  const spaBasePath = window.spaBase;
+  const adminBasename = window.getOpenmrsSpaBase() + 'admin';
+
+  useEffect(() => {
+    setLeftNav({
+      name: 'admin-left-panel-slot',
+      basePath: spaBasePath,
+    });
+    return () => unsetLeftNav('admin-left-panel-slot');
+  }, [spaBasePath]);
+
+  return (
+    <BrowserRouter basename={adminBasename}>
+      <LeftPanel />
+      <main className={styles.container}>
+        <Routes>
+          <Route path="/" element={<UserManagentLandingPage />} />
+          <Route path="/user-management" element={<UserManagentLandingPage />} />
+          <Route path="/etl-administration" element={<EtlAdminDashboard />} />
+          <Route path="/facility-setup" element={<FacilitySetup />} />
+          <Route path="/locations" element={<HomeComponent />} />
+        </Routes>
+      </main>
+    </BrowserRouter>
+  );
+};
+
+export default Root;

package/src/root.scss

@@ -0,0 +1,12 @@
+@use '@carbon/layout';
+@use '@carbon/type';
+@use '@carbon/colors';
+
+.container {
+  background-color: colors.$white-0;
+  height: calc(100vh - layout.$spacing-09);
+}
+
+:global(.omrs-breakpoint-gt-tablet) .container {
+  margin-left: var(--omrs-sidenav-width);
+}

package/src/routes.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "https://json.openmrs.org/routes.schema.json",
+  "backendDependencies": {
+    "kenyaemrCharts": "^1.6.7"
+  },
+  "extensions": [
+    {
+      "component": "adminLeftPanelLink",
+      "name": "admin-left-panel-link",
+      "slot": "admin-left-panel-slot"
+    },
+    {
+      "component": "userManagementLeftPannelLink",
+      "name": "user-management-left-panel-link",
+      "slot": "admin-left-panel-slot"
+    }, 
+    {
+      "component": "locationsLeftPanelLink",
+      "name": "locations-left-panel-link",
+      "slot": "admin-left-panel-slot"
+    },
+    {
+      "component": "facilitySetupLeftPanelLink",
+      "name": "facility-setup-left-panel-link",
+      "slot": "admin-left-panel-slot"
+    },
+    {
+      "component": "providerBanner",
+      "name": "provider-banner",
+      "slot": "provider-banner-info-slot",
+      "order":1
+    }
+  ],
+  "workspaces": [
+    {
+      "name": "manage-user-workspace",
+      "component": "manageUserWorkspace",
+      "title": "Manage User Workspace",
+      "type": "other-form",
+      "canMaximize": true,
+      "width": "extra-wide"
+    },
+    {
+      "name": "user-role-scope-workspace",
+      "component": "userRoleScopeWorkspace",
+      "title": "User Rple Scope Workspace",
+      "type": "other-form",
+       "canMaximize": true,
+      "width": "extra-wide"
+    },
+    {
+      "name": "add-location-workspace",
+      "title": "Add Location",
+      "component": "addLocation",
+      "type": "workspace"
+    },
+    {
+      "name": "search-location-workspace",
+      "title": "Search Location",
+      "component": "searchLocationWorkspace",
+      "type": "workspace"
+    },
+    {
+      "name": "hwr-sync-workspace",
+      "title": "HWR Sync Workspace",
+      "component": "hwrSyncWorkspace",
+      "type": "other-form"
+    },
+    {
+      "name": "hwr-sync-modal",
+      "title": "HWR Sync Modal",
+      "component": "hwrSyncModal",
+      "type": "modal"
+    }
+  ],
+  "modals": [
+    {
+      "component": "operationConfirmationModal",
+      "name": "operation-confirmation-modal"
+    },
+    {
+      "component": "hwrConfirmationModal",
+      "name": "hwr-confirmation-modal"
+    },
+    {
+      "component": "hwrEmptyModal",
+      "name": "hwr-empty-modal"
+    },
+     {
+      "component": "hwrSyncModal",
+      "name": "hwr-syncing-modal"
+    }
+  ],
+  "pages": [
+    {
+      "component": "root",
+      "route": "admin"
+    }
+  ]
+}

package/src/setup-tests.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';