@openmrs/esm-metadataexport-app 4.4.1-pre.684

package/src/domain-lookups/domain-lookups.resource.ts

@@ -0,0 +1,33 @@
+import useSWR from 'swr';
+import { type FetchResponse, openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
+import { type MetadataDomain } from '../types';
+
+export function useDomains() {
+  const apiUrl = `${restBaseUrl}/metadataexport/domains`;
+  const { data, error, isLoading, isValidating, mutate } = useSWR<FetchResponse<Array<MetadataDomain>>, Error>(
+    apiUrl,
+    openmrsFetch,
+  );
+
+  return {
+    domains: data?.data ?? [],
+    isLoading,
+    isValidating,
+    error,
+    mutate,
+  };
+}
+
+export function getDomains(): Promise<FetchResponse<Array<MetadataDomain>>> {
+  const apiUrl = `${restBaseUrl}/metadataexport/domains`;
+  return openmrsFetch(apiUrl);
+}
+
+/**
+ * Converts a domain identifier such as `ENCOUNTER_TYPES` into a human readable
+ * label such as `Encounter types`.
+ */
+export function formatDomainLabel(domain: MetadataDomain): string {
+  const text = domain.replace(/_/g, ' ').trim().toLowerCase();
+  return text.charAt(0).toUpperCase() + text.slice(1);
+}

package/src/index.ts

@@ -0,0 +1,28 @@
+import { getAsyncLifecycle, defineConfigSchema } from '@openmrs/esm-framework';
+import { configSchema } from './config-schema';
+import { moduleName } from './constants';
+
+const options = {
+  featureName: 'metadataexport',
+  moduleName,
+};
+
+export const importTranslation = require.context('../translations', false, /.json$/, 'lazy');
+
+export function startupApp() {
+  defineConfigSchema(moduleName, configSchema);
+}
+
+// Root component
+export const root = getAsyncLifecycle(() => import('./root.component'), options);
+
+// Extensions
+export const metadataExportCardLink = getAsyncLifecycle(() => import('./admin-card-link.component'), options);
+
+// Modals
+
+// Workspaces
+export const newPackageWorkspace = getAsyncLifecycle(
+  () => import('./components/new-package/new-package.workspace'),
+  options,
+);

package/src/packages/packages.resource.ts

@@ -0,0 +1,31 @@
+import useSWR from 'swr';
+import { type FetchResponse, openmrsFetch, restBaseUrl } from '@openmrs/esm-framework';
+import { type ExportPackage, type ExportPackageRequest } from '../types/index';
+
+export function useAllPackages(includeRetired = false) {
+  const apiUrl = `${restBaseUrl}/metadataexport/packages?includeRetired=${includeRetired}`;
+  const { data, error, isLoading, isValidating, mutate } = useSWR<FetchResponse<Array<ExportPackage>>, Error>(
+    apiUrl,
+    openmrsFetch,
+  );
+
+  return {
+    packages: data?.data ?? [],
+    isLoading,
+    isValidating,
+    error,
+    mutate,
+  };
+}
+
+export function createPackage(
+  payload: ExportPackageRequest,
+  abortController?: AbortController,
+): Promise<FetchResponse<ExportPackage>> {
+  return openmrsFetch<ExportPackage>(`${restBaseUrl}/metadataexport/packages`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: payload,
+    signal: abortController?.signal,
+  });
+}

package/src/root.component.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { BrowserRouter, Routes, Route } from 'react-router-dom';
+import Dashboard from './components/dashboard/home-dashboard.component';
+
+const Root: React.FC = () => (
+  <BrowserRouter basename={window.getOpenmrsSpaBase()}>
+    <Routes>
+      <Route path="metadataexport" element={<Dashboard />} />
+    </Routes>
+  </BrowserRouter>
+);
+
+export default Root;

package/src/root.scss

@@ -0,0 +1,5 @@
+@use '@carbon/layout';
+
+.container {
+  padding: layout.$spacing-05;
+}

package/src/root.test.tsx

@@ -0,0 +1,12 @@
+import React from 'react';
+import { describe, it, expect } from 'vitest';
+import { render, screen } from '@testing-library/react';
+import Root from './root.component';
+
+describe('Root', () => {
+  it('mounts the route shell without crashing', () => {
+    // No route matches the default jsdom URL, so the shell mounts but renders
+    // no route content; this asserts the wiring (BrowserRouter + Routes) works.
+    expect(() => render(<Root />)).not.toThrow();
+  });
+});

package/src/routes.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json.openmrs.org/routes.schema.json",
+  "backendDependencies": {
+    "metadataexport": ">=1.0.0-SNAPSHOT"
+  },
+  "pages": [
+    {
+      "route": "metadataexport",
+      "component": "root",
+      "online": true
+    }
+  ],
+  "extensions": [
+    {
+      "name": "metadata-export-card-link",
+      "slot": "system-admin-page-card-link-slot",
+      "component": "metadataExportCardLink",
+      "privileges": ["Get Metadata Export Packages"]
+    }
+  ],
+  "workspaces": [
+    {
+      "name": "new-package-workspace",
+      "component": "newPackageWorkspace",
+      "title": "New package",
+      "type": "form",
+      "canMaximize": true,
+      "width": "narrow"
+    }
+  ]
+}

package/src/types/index.ts

@@ -0,0 +1,41 @@
+export type MetadataDomain = string;
+
+export interface ExportPackageEntryDto {
+  domain: MetadataDomain;
+}
+
+export interface ExportPackageRequest {
+  name: string;
+  description: string;
+  entries: Array<ExportPackageEntryDto>;
+}
+
+export interface ExportPackageEntry {
+  domain: MetadataDomain;
+  itemUuids: Array<string>;
+}
+
+export type ExportBuildStatus = 'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED';
+
+export interface ExportPackageBuild {
+  uuid: string;
+  packageUuid: string;
+  version: number;
+  status: ExportBuildStatus;
+  dateCreated: number;
+  dateStarted: number | null;
+  dateCompleted: number | null;
+  errorMessage: string | null;
+  downloadUrl: string | null;
+  manifest: unknown | null;
+}
+
+export interface ExportPackage {
+  uuid: string;
+  name: string;
+  description: string;
+  retired: boolean;
+  dateCreated: number;
+  entries: Array<ExportPackageEntry>;
+  latestBuild: ExportPackageBuild | null;
+}

package/translations/en.json

@@ -0,0 +1,22 @@
+{
+  "allDomains": "All domains",
+  "cancel": "Cancel",
+  "createPackage": "Create package",
+  "creating": "Creating",
+  "description": "Description",
+  "descriptionPlaceholder": "Briefly describe what this package contains",
+  "domains": "Domains",
+  "errorLoadingDomains": "Error loading domains",
+  "managePackages": "Manage packages",
+  "metadataexport": "Metadata Export",
+  "newpackage": "New Package",
+  "packageCreated": "Package created",
+  "packageCreatedSubtitle": "{{name}} was created successfully",
+  "packageCreationFailed": "Failed to create package",
+  "packageName": "Package name",
+  "packageNamePlaceholder": "e.g. Core reference data",
+  "packages": "Packages",
+  "packages__lower": "packages",
+  "selectAll": "Select all",
+  "unexpectedError": "An unexpected error occurred"
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*", "../../tools/setup-tests.ts"],
+}

package/vitest.config.ts

@@ -0,0 +1,4 @@
+import { mergeConfig } from 'vitest/config';
+import sharedConfig from '../../tools/vitest.shared';
+
+export default mergeConfig(sharedConfig, {});