@mui-toolpad-extended-tuni/main 3.4.0 → 3.5.0

package/README.md

@@ -2,6 +2,12 @@
 
 Main package for MUI Toolpad Extended TUNI - provides ToolpadProvider, LMS components, and platform features.
 
+## Version 3.4.1
+
+**Bug Fixes:**
+- Fixed build issue where `useApiConfig` was incorrectly referenced (removed in v3.3.0). The package now correctly uses `useServiceApiConfig` and `useApiConfigContext` from core.
+- **Breaking Change**: Removed re-exports of `react-router-dom` components (`BrowserRouter`, `Routes`, `Route`, `Navigate`, `Outlet`, `Link`, hooks, etc.). Since `react-router-dom` is a peer dependency, import these directly from `react-router-dom` to avoid type mismatches and ensure compatibility with your React version.
+
 ## Installation
 
 ```bash
@@ -60,12 +66,16 @@ npm install @mui-toolpad-extended-tuni/users
 
 ```tsx
 import { BrowserRouter } from 'react-router-dom';
-import { ToolpadProvider } from '@mui-toolpad-extended-tuni/main';
+import { ToolpadProvider, Microservices } from '@mui-toolpad-extended-tuni/main';
 
 function App() {
   return (
     <BrowserRouter>
-      <ToolpadProvider>{/* Your application content */}</ToolpadProvider>
+      <ToolpadProvider>
+        <Microservices>
+          {/* Your application content */}
+        </Microservices>
+      </ToolpadProvider>
     </BrowserRouter>
   );
 }
@@ -82,8 +92,117 @@ import {
   Notifications,
   Dialogs,
 } from '@mui-toolpad-extended-tuni/main';
+
+// Import router components and hooks directly from react-router-dom
+// (react-router-dom is a peer dependency, so import directly to avoid type mismatches)
+import { Routes, Route, Navigate, Outlet, useNavigate, useParams, Link } from 'react-router-dom';
+```
+
+## API Configuration
+
+Each microservice accepts its own `apiEndpoints` prop, allowing you to configure endpoints independently. This modular approach means you only configure endpoints for the microservices you actually use.
+
+### Basic Configuration
+
+Configure endpoints directly on each microservice component:
+
+```tsx
+import { CourseMicroservice } from '@mui-toolpad-extended-tuni/courses';
+import { UserMicroservice } from '@mui-toolpad-extended-tuni/users';
+import type { CoursesApiEndpoints, UsersApiEndpoints } from '@mui-toolpad-extended-tuni/core';
+
+const coursesEndpoints: CoursesApiEndpoints = {
+  get: "https://api.example.com/v1/courses",
+  getById: "https://api.example.com/v1/courses/:id",
+  post: "https://api.example.com/v1/courses",
+  put: "https://api.example.com/v1/courses/:id",
+  delete: "https://api.example.com/v1/courses/:id",
+};
+
+const usersEndpoints: UsersApiEndpoints = {
+  getCurrent: "https://api.example.com/v1/users/me",
+  get: "https://api.example.com/v1/users",
+  post: "https://api.example.com/v1/users",
+  put: "https://api.example.com/v1/users/:id",
+  delete: "https://api.example.com/v1/users/:id",
+  logout: "https://api.example.com/v1/auth/logout",
+};
+
+<ToolpadProvider>
+  <Microservices>
+    <CourseMicroservice apiEndpoints={coursesEndpoints}>
+      {/* Your course microservices */}
+    </CourseMicroservice>
+    <UserMicroservice apiEndpoints={usersEndpoints} />
+  </Microservices>
+</ToolpadProvider>
 ```
 
+### URL Format Guidelines
+
+You can use either:
+
+1. **Full URLs**: `"https://api.example.com/v1/courses"`
+   - Use when your API is on a different domain
+   - Supports both HTTP and HTTPS
+
+2. **Relative Paths**: `"api/courses/"` or `"/api/courses/"`
+   - Use when your API is on the same domain
+   - Relative paths are resolved against the base URL (defaults to `/`)
+
+### Placeholder Support
+
+Endpoints can include placeholders that are replaced at runtime:
+
+- `:id` - Replaced with the actual resource ID
+- `:courseId` - Replaced with course ID
+- `:encodedUrl` - Replaced with base64-encoded URL (for courses)
+
+**Example**:
+```tsx
+<CourseMicroservice apiEndpoints={{
+  getById: "api/courses/:id",  // :id will be replaced with actual course ID
+  put: "api/courses/:id/",     // Same placeholder support
+}}>
+  {/* Your course microservices */}
+</CourseMicroservice>
+```
+
+### Default Endpoints
+
+If no `apiEndpoints` prop is provided, each microservice uses its default endpoints. See each microservice's README for their default endpoint values.
+
+### Partial Configuration
+
+You can configure only the endpoints you need to customize. Unspecified endpoints will use defaults:
+
+```tsx
+<CourseMicroservice apiEndpoints={{
+  get: "https://custom-api.com/courses",  // Only override GET
+  // Other endpoints use defaults
+}}>
+  {/* Your course microservices */}
+</CourseMicroservice>
+```
+
+### Accessing Configuration
+
+Each microservice provides its own hook for accessing configuration. No need to know service keys:
+
+```tsx
+import { useCoursesApiConfig } from '@mui-toolpad-extended-tuni/courses';
+import { useUsersApiConfig } from '@mui-toolpad-extended-tuni/users';
+
+function MyComponent() {
+  const coursesConfig = useCoursesApiConfig();
+  const usersConfig = useUsersApiConfig();
+  const coursesEndpoint = coursesConfig?.get; // "api/courses/" or custom value
+  const usersEndpoint = usersConfig?.getCurrent; // "api/users/current/" or custom value
+}
+```
+
+Each microservice package exports its own hook - developers never need to know internal service keys!
+
 ## Features
 
 ### ToolpadProvider
@@ -121,7 +240,7 @@ If you're migrating from the deprecated `mui-toolpad-extended-tuni` package:
    ```json
    {
      "dependencies": {
-       "@mui-toolpad-extended-tuni/main": "^3.4.0"
+       "@mui-toolpad-extended-tuni/main": "^3.5.0"
      }
    }
    ```
@@ -129,12 +248,15 @@ If you're migrating from the deprecated `mui-toolpad-extended-tuni` package:
 2. Update all imports:
    ```typescript
    // Old (deprecated)
-   import { ToolpadProvider } from 'mui-toolpad-extended-tuni';
+   import { ToolpadProvider, BrowserRouter } from 'mui-toolpad-extended-tuni';
    
    // New
    import { ToolpadProvider } from '@mui-toolpad-extended-tuni/main';
+   import { BrowserRouter } from 'react-router-dom';
    ```
 
+**Note**: Router components (`BrowserRouter`, `Routes`, `Route`, `Navigate`, `Outlet`, etc.) and hooks (`useNavigate`, `useParams`, `useLocation`, etc.) should be imported directly from `react-router-dom`, not from `@mui-toolpad-extended-tuni/main`.
+
 ## License
 
 MIT

package/dist/ToolpadProvider.d.ts

@@ -1,5 +1,4 @@
 import { ReactNode } from 'react';
-import { ApiConfig } from '../../core/src';
 export interface LogoConfig {
     sidebarFooter?: {
         smallLogo?: string;
@@ -10,8 +9,6 @@ export interface LogoConfig {
 export interface ToolpadProviderProps {
     children?: ReactNode;
     logos?: LogoConfig;
-    /** API endpoint configuration for microservices. Each microservice can define its own endpoints. */
-    apiConfig?: ApiConfig;
 }
 export declare const useLogoContext: () => LogoConfig;
 /**