@mui-toolpad-extended-tuni/courses 3.1.0 → 3.2.0

package/README.md

@@ -42,11 +42,11 @@ npm install @mui-toolpad-extended-tuni/courses @mui-toolpad-extended-tuni/main @
 
 ## API Configuration
 
-This package uses configurable API endpoints. You can customize all endpoints via the `apiConfig` prop in `ToolpadProvider`.
+This package uses configurable API endpoints. Each microservice accepts its own `apiEndpoints` prop, allowing you to configure endpoints independently for only the services you use.
 
 ### Default Endpoints
 
-If no configuration is provided, the package uses these default endpoints:
+If no `apiEndpoints` prop is provided, the package uses these default endpoints:
 
 - `get: "api/courses/"` - GET list of courses
 - `getById: "api/courses/:id"` - GET course by ID (use `:id` placeholder)
@@ -57,30 +57,39 @@ If no configuration is provided, the package uses these default endpoints:
 
 ### Customizing Endpoints
 
-Configure endpoints via `ToolpadProvider`:
+Configure endpoints directly on the `CourseMicroservice` component:
 
 ```tsx
-import { ToolpadProvider } from '@mui-toolpad-extended-tuni/main';
+import { CourseMicroservice } from '@mui-toolpad-extended-tuni/courses';
 import type { CoursesApiEndpoints } from '@mui-toolpad-extended-tuni/courses';
 
-const apiConfig = {
-  courses: {
-    get: "https://api.example.com/v1/courses",
-    getById: "https://api.example.com/v1/courses/:id",
-    getByUrl: "https://api.example.com/v1/courses?url=:encodedUrl",
-    post: "https://api.example.com/v1/courses",
-    put: "https://api.example.com/v1/courses/:id",
-    delete: "https://api.example.com/v1/courses/:id",
-  } as CoursesApiEndpoints,
+const coursesEndpoints: CoursesApiEndpoints = {
+  get: "https://api.example.com/v1/courses",
+  getById: "https://api.example.com/v1/courses/:id",
+  getByUrl: "https://api.example.com/v1/courses?url=:encodedUrl",
+  post: "https://api.example.com/v1/courses",
+  put: "https://api.example.com/v1/courses/:id",
+  delete: "https://api.example.com/v1/courses/:id",
 };
 
-<ToolpadProvider apiConfig={apiConfig}>
-  {/* Your app */}
-</ToolpadProvider>
+<CourseMicroservice apiEndpoints={coursesEndpoints}>
+  {/* Your course microservices */}
+</CourseMicroservice>
 ```
 
 **Note**: You can use either full URLs (`https://api.example.com/courses`) or relative paths (`api/courses/`). Placeholders like `:id` will be replaced with actual values at runtime.
 
+**Partial Configuration**: You can configure only the endpoints you need to customize. Unspecified endpoints will use defaults:
+
+```tsx
+<CourseMicroservice apiEndpoints={{
+  get: "api/v2/courses",  // Only override GET endpoint
+  // Other endpoints use defaults
+}}>
+  {/* Your course microservices */}
+</CourseMicroservice>
+```
+
 ## Usage
 
 ### Basic Setup
@@ -682,6 +691,7 @@ type courseRelationType = "prerequisite" | "recommended" | "parallel" |
 
 ### Hooks
 - `useCourseMicroserviceRegistration` - Hook for registering custom course microservices (must be used within `CourseMicroservice` context)
+- `useCoursesApiConfig` - Hook to access courses API endpoint configuration
 
 ### Store
 - `useCourseStore` - Zustand store for course management

package/dist/CourseMicroservice.d.ts

@@ -1,6 +1,9 @@
 import { default as React, ReactNode } from 'react';
-interface CourseMicroserviceProps {
+import { CoursesApiEndpoints } from '@mui-toolpad-extended-tuni/core';
+export interface CourseMicroserviceProps {
     children?: ReactNode;
+    /** API endpoint configuration for the courses microservice */
+    apiEndpoints?: CoursesApiEndpoints;
 }
 /**
  * CourseMicroservice Component

package/dist/hooks/useCoursesApiConfig.d.ts

@@ -0,0 +1,15 @@
+import { CoursesApiEndpoints } from '@mui-toolpad-extended-tuni/core';
+/**
+ * Hook to access courses API configuration.
+ * Returns the courses endpoint configuration merged with defaults.
+ *
+ * @returns Courses API endpoints configuration, or undefined if not registered
+ * @throws Error if used outside of ApiConfigProvider
+ *
+ * @example
+ * ```tsx
+ * const coursesConfig = useCoursesApiConfig();
+ * const endpoint = coursesConfig?.get; // "api/courses/" or custom value
+ * ```
+ */
+export declare const useCoursesApiConfig: () => CoursesApiEndpoints | undefined;