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

package/README.md

@@ -41,11 +41,11 @@ npm install @mui-toolpad-extended-tuni/users @mui-toolpad-extended-tuni/main @mu
 
 ## 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:
 
 - `getCurrent: "api/users/current/"` - GET current authenticated user
 - `get: "api/users/"` - GET list of users
@@ -56,30 +56,35 @@ If no configuration is provided, the package uses these default endpoints:
 
 ### Customizing Endpoints
 
-Configure endpoints via `ToolpadProvider`:
+Configure endpoints directly on the `UserMicroservice` component:
 
 ```tsx
-import { ToolpadProvider } from '@mui-toolpad-extended-tuni/main';
+import { UserMicroservice } from '@mui-toolpad-extended-tuni/users';
 import type { UsersApiEndpoints } from '@mui-toolpad-extended-tuni/users';
 
-const apiConfig = {
-  users: {
-    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",
-  } as UsersApiEndpoints,
+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 apiConfig={apiConfig}>
-  {/* Your app */}
-</ToolpadProvider>
+<UserMicroservice apiEndpoints={usersEndpoints} />
 ```
 
 **Note**: You can use either full URLs or relative paths. 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
+<UserMicroservice apiEndpoints={{
+  getCurrent: "api/v2/users/me",  // Only override getCurrent endpoint
+  // Other endpoints use defaults
+}} />
+```
+
 ## Usage
 
 ### Basic Setup
@@ -425,6 +430,9 @@ type PlatformRole = "admin" | "developer" | "moderator" | "creator" | "user" | "
 - `deleteUser(userId: string)` - Delete user
 - `logoutUser()` - Logout current user
 
+### Hooks
+- `useUsersApiConfig()` - Hook to access users API endpoint configuration
+
 ### Configuration
 - `configureUserBus` - Configures UserBus with store methods (called automatically)
 

package/dist/UserMicroservice.d.ts

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

package/dist/hooks/useUsersApiConfig.d.ts

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