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

package/README.md

@@ -49,7 +49,7 @@ npm install @mui-toolpad-extended-tuni/calendar @mui-toolpad-extended-tuni/main
 
 ## API Configuration
 
-**Note**: The calendar package does not make direct API calls. It receives events through the EventBus system from other microservices (primarily the courses package). However, you can configure calendar endpoints if you plan to add direct API integration in the future.
+**Note**: The calendar package does not make direct API calls. It receives events through the EventBus system from other microservices (primarily the courses package). However, you can configure calendar endpoints via the `apiEndpoints` prop if you plan to add direct API integration in the future.
 
 ### Default Endpoints
 
@@ -61,6 +61,23 @@ If you need to configure calendar endpoints for future API integration:
 - `put: "api/calendar/:id/"` - PUT update event
 - `delete: "api/calendar/:id/"` - DELETE event
 
+### Customizing Endpoints
+
+```tsx
+import { CalendarMicroservice } from '@mui-toolpad-extended-tuni/calendar';
+import type { CalendarApiEndpoints } from '@mui-toolpad-extended-tuni/calendar';
+
+const calendarEndpoints: CalendarApiEndpoints = {
+  get: "https://api.example.com/v1/calendar",
+  getById: "https://api.example.com/v1/calendar/:id",
+  post: "https://api.example.com/v1/calendar",
+  put: "https://api.example.com/v1/calendar/:id",
+  delete: "https://api.example.com/v1/calendar/:id",
+};
+
+<CalendarMicroservice apiEndpoints={calendarEndpoints} />
+```
+
 **Current Implementation**: The calendar currently uses EventBus to receive events from other microservices. Direct API endpoints are reserved for future use.
 
 ## Usage
@@ -308,6 +325,9 @@ interface Event {
 - `createCalendarEvent` - Helper function to create calendar events
 - `getContrastColor` - Helper function to get contrasting text color
 
+### Hooks
+- `useCalendarApiConfig()` - Hook to access calendar API endpoint configuration (for future use)
+
 ### Types
 - `CalendarEvent` - Calendar event interface
 - `CalendarEventType` - Calendar event type enumeration

package/dist/CalendarMicroservice.d.ts

@@ -1,6 +1,9 @@
 import { default as React, ReactNode } from 'react';
-interface CalendarMicroserviceProps {
+import { CalendarApiEndpoints } from '@mui-toolpad-extended-tuni/core';
+export interface CalendarMicroserviceProps {
     children?: ReactNode;
+    /** API endpoint configuration for the calendar microservice (for future use) */
+    apiEndpoints?: CalendarApiEndpoints;
 }
 /**
  * CalendarMicroservice Component

package/dist/hooks/useCalendarApiConfig.d.ts

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