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

package/README.md

@@ -10,10 +10,13 @@ This package contains shared dependencies used by all microservices in the MUI T
 npm install @mui-toolpad-extended-tuni/core
 ```
 
-## Peer Dependencies
+**Note**: This package is typically installed as a peer dependency of `@mui-toolpad-extended-tuni/main` or other extension packages. You usually don't need to install it directly unless you're using it standalone.
 
-This package requires the following peer dependencies:
+## Required Peer Dependencies
 
+This package requires the following peer dependencies to be installed:
+
+### React & UI Framework
 - `@emotion/react`: ^11.0.0
 - `@emotion/styled`: ^11.0.0
 - `@mui/icons-material`: ^7.0.0
@@ -25,6 +28,16 @@ This package requires the following peer dependencies:
 - `react-router-dom`: ^7.0.0
 - `zustand`: ^4.5.0
 
+### Installation Example
+
+```bash
+npm install @mui-toolpad-extended-tuni/core \
+  @emotion/react @emotion/styled \
+  @mui/icons-material @mui/material @mui/x-date-pickers \
+  @toolpad/core \
+  react react-dom react-router-dom zustand
+```
+
 ## Features
 
 ### Events

package/dist/API/ApiConfigContext.d.ts

@@ -0,0 +1,68 @@
+import { default as React, ReactNode } from 'react';
+import { ApiConfig, CoursesApiEndpoints, UsersApiEndpoints, CalendarApiEndpoints } from './types';
+/**
+ * Get the current API configuration from module-level store.
+ * This can be called from non-React contexts (e.g., network functions).
+ *
+ * @returns Current API configuration or null if not initialized
+ */
+export declare const getApiConfig: () => ApiConfigContextValue | null;
+/**
+ * API Configuration Context Value
+ * Provides merged endpoint configurations for all microservices.
+ */
+export interface ApiConfigContextValue {
+    /** Courses microservice endpoints (merged with defaults) */
+    courses: CoursesApiEndpoints;
+    /** Users microservice endpoints (merged with defaults) */
+    users: UsersApiEndpoints;
+    /** Calendar microservice endpoints (merged with defaults) */
+    calendar: CalendarApiEndpoints;
+    /** Base URL for API requests (from axios config) */
+    baseUrl: string;
+}
+/**
+ * Props for ApiConfigProvider component
+ */
+export interface ApiConfigProviderProps {
+    /** User-provided API configuration (optional) */
+    apiConfig?: ApiConfig;
+    /** Base URL for API requests (defaults to "/") */
+    baseUrl?: string;
+    /** Child components */
+    children: ReactNode;
+}
+/**
+ * ApiConfigProvider Component
+ *
+ * Provides API endpoint configuration to all child components.
+ * Merges user-provided configuration with default values for backward compatibility.
+ *
+ * @example
+ * ```tsx
+ * <ApiConfigProvider
+ *   apiConfig={{
+ *     courses: {
+ *       get: "https://api.example.com/courses",
+ *       post: "https://api.example.com/courses"
+ *     }
+ *   }}
+ * >
+ *   <YourApp />
+ * </ApiConfigProvider>
+ * ```
+ */
+export declare const ApiConfigProvider: React.FC<ApiConfigProviderProps>;
+/**
+ * Hook to access API configuration context.
+ *
+ * @returns API configuration context value
+ * @throws Error if used outside of ApiConfigProvider
+ *
+ * @example
+ * ```tsx
+ * const { courses, users } = useApiConfig();
+ * const endpoint = courses.get; // "api/courses/" or user-provided value
+ * ```
+ */
+export declare const useApiConfig: () => ApiConfigContextValue;

package/dist/API/types.d.ts

@@ -0,0 +1,53 @@
+/** @format */
+/**
+ * Standard CRUD API endpoints interface.
+ * All microservice endpoint configurations extend this base interface.
+ */
+export interface StandardApiEndpoints {
+    /** GET endpoint for retrieving a list of resources */
+    get?: string;
+    /** GET endpoint for retrieving a single resource by ID. Use :id placeholder for the ID */
+    getById?: string;
+    /** POST endpoint for creating a new resource */
+    post?: string;
+    /** PUT endpoint for updating an existing resource. Use :id placeholder for the ID */
+    put?: string;
+    /** DELETE endpoint for deleting a resource. Use :id placeholder for the ID */
+    delete?: string;
+}
+/**
+ * Courses microservice API endpoints configuration.
+ * Extends StandardApiEndpoints with course-specific endpoints.
+ */
+export interface CoursesApiEndpoints extends StandardApiEndpoints {
+    /** GET endpoint for retrieving a course by URL. Use :encodedUrl placeholder for base64-encoded URL */
+    getByUrl?: string;
+}
+/**
+ * Users microservice API endpoints configuration.
+ * Extends StandardApiEndpoints with user-specific endpoints.
+ */
+export interface UsersApiEndpoints extends StandardApiEndpoints {
+    /** GET endpoint for retrieving the current authenticated user */
+    getCurrent?: string;
+    /** POST endpoint for user logout */
+    logout?: string;
+}
+/**
+ * Calendar microservice API endpoints configuration.
+ * Extends StandardApiEndpoints with calendar-specific endpoints.
+ */
+export interface CalendarApiEndpoints extends StandardApiEndpoints {
+}
+/**
+ * Complete API configuration for all microservices.
+ * Each microservice can be configured independently.
+ */
+export interface ApiConfig {
+    /** Courses microservice endpoint configuration */
+    courses?: CoursesApiEndpoints;
+    /** Users microservice endpoint configuration */
+    users?: UsersApiEndpoints;
+    /** Calendar microservice endpoint configuration */
+    calendar?: CalendarApiEndpoints;
+}

package/dist/API/utils.d.ts

@@ -0,0 +1,34 @@
+import { StandardApiEndpoints, CoursesApiEndpoints, UsersApiEndpoints, CalendarApiEndpoints } from './types';
+/**
+ * Builds a complete URL from a base URL and endpoint path.
+ * Handles both absolute URLs and relative paths.
+ * Supports query parameters in endpoint strings.
+ *
+ * @param baseUrl - Base URL (e.g., "https://api.example.com" or "/")
+ * @param endpoint - Endpoint path (e.g., "api/courses/" or "api/courses/?encoded_url=:encodedUrl")
+ * @param params - Optional parameters to replace placeholders (e.g., { id: "123", encodedUrl: "base64string" })
+ * @returns Complete URL string
+ *
+ * @example
+ * buildUrl("/", "api/courses/:id", { id: "123" }) // "/api/courses/123"
+ * buildUrl("/", "api/courses/?encoded_url=:encodedUrl", { encodedUrl: "abc123" }) // "/api/courses/?encoded_url=abc123"
+ * buildUrl("https://api.example.com", "courses/:id", { id: "123" }) // "https://api.example.com/courses/123"
+ */
+export declare function buildUrl(baseUrl: string, endpoint: string, params?: Record<string, string | number>): string;
+/**
+ * Gets default endpoint values for a microservice.
+ * These match the current hardcoded values for backward compatibility.
+ *
+ * @param service - The microservice name
+ * @returns Default endpoint configuration
+ */
+export declare function getDefaultEndpoints(service: 'courses' | 'users' | 'calendar'): StandardApiEndpoints | CoursesApiEndpoints | UsersApiEndpoints | CalendarApiEndpoints;
+/**
+ * Merges user-provided endpoints with defaults.
+ * User endpoints take precedence over defaults.
+ *
+ * @param defaults - Default endpoint configuration
+ * @param userEndpoints - User-provided endpoint configuration (optional)
+ * @returns Merged endpoint configuration
+ */
+export declare function mergeEndpoints<T extends StandardApiEndpoints>(defaults: T, userEndpoints?: Partial<T>): T;