@mui-toolpad-extended-tuni/calendar 3.0.0 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,29 +5,48 @@ Calendar microservice extension for MUI Toolpad Extended TUNI. This package prov
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
- npm install @mui-toolpad-extended-tuni/calendar
8
+ npm install @mui-toolpad-extended-tuni/calendar @mui-toolpad-extended-tuni/main @mui-toolpad-extended-tuni/core
9
9
  ```
10
10
 
11
- **Note**: This package requires `mui-toolpad-extended-tuni@^3.0.0` as a peer dependency.
11
+ **Important**: You must also install `@mui-toolpad-extended-tuni/main` and `@mui-toolpad-extended-tuni/core` as they are required peer dependencies.
12
12
 
13
- ## Peer Dependencies
13
+ ## Required Peer Dependencies
14
14
 
15
- - `mui-toolpad-extended-tuni@^3.0.0`
15
+ This package requires the following peer dependencies to be installed:
16
+
17
+ ### Required Packages
18
+ - **`@mui-toolpad-extended-tuni/main`**: ^3.3.0 - **MUST be installed separately**
19
+ - **`@mui-toolpad-extended-tuni/core`**: ^3.1.0 - **MUST be installed separately** (also required by main)
20
+
21
+ ### React & UI Framework
16
22
  - `react@^19.0.0`
17
23
  - `react-dom@^19.0.0`
18
24
  - `react-router-dom@^7.0.0`
19
25
  - `@mui/material@^7.0.0`
20
26
  - `@mui/icons-material@^7.0.0`
21
27
  - `@mui/x-date-pickers@^7.0.0`
28
+ - `@emotion/react@^11.0.0`
29
+ - `@emotion/styled@^11.0.0`
30
+
31
+ ### Calendar Dependencies
22
32
  - `@fullcalendar/core@^6.0.0`
23
33
  - `@fullcalendar/daygrid@^6.0.0`
24
34
  - `@fullcalendar/interaction@^6.0.0`
25
35
  - `@fullcalendar/react@^6.0.0`
26
36
  - `@fullcalendar/timegrid@^6.0.0`
27
- - `@emotion/react@^11.0.0`
28
- - `@emotion/styled@^11.0.0`
29
37
  - `luxon@^3.0.0`
30
38
 
39
+ ### Installation Example
40
+
41
+ ```bash
42
+ npm install @mui-toolpad-extended-tuni/calendar @mui-toolpad-extended-tuni/main @mui-toolpad-extended-tuni/core \
43
+ react react-dom react-router-dom \
44
+ @mui/material @mui/icons-material @mui/x-date-pickers \
45
+ @emotion/react @emotion/styled \
46
+ @fullcalendar/core @fullcalendar/daygrid @fullcalendar/interaction @fullcalendar/react @fullcalendar/timegrid \
47
+ luxon
48
+ ```
49
+
31
50
  ## Usage
32
51
 
33
52
  ### Basic Setup
@@ -36,18 +55,18 @@ The calendar microservice automatically registers itself when imported:
36
55
 
37
56
  ```tsx
38
57
  import { BrowserRouter } from 'react-router-dom';
39
- import { LMSProvider, Microservices } from 'mui-toolpad-extended-tuni';
58
+ import { ToolpadProvider, Microservices } from 'mui-toolpad-extended-tuni';
40
59
  import { CalendarMicroservice } from '@mui-toolpad-extended-tuni/calendar';
41
60
 
42
61
  function App() {
43
62
  return (
44
63
  <BrowserRouter>
45
- <LMSProvider>
64
+ <ToolpadProvider>
46
65
  <Microservices>
47
66
  <CalendarMicroservice />
48
67
  {/* Other microservices */}
49
68
  </Microservices>
50
- </LMSProvider>
69
+ </ToolpadProvider>
51
70
  </BrowserRouter>
52
71
  );
53
72
  }
@@ -134,14 +153,14 @@ Simply include both microservices - the integration happens automatically:
134
153
 
135
154
  ```tsx
136
155
  import { BrowserRouter } from 'react-router-dom';
137
- import { LMSProvider, Microservices } from 'mui-toolpad-extended-tuni';
156
+ import { ToolpadProvider, Microservices } from 'mui-toolpad-extended-tuni';
138
157
  import { CourseMicroservice } from '@mui-toolpad-extended-tuni/courses';
139
158
  import { CalendarMicroservice } from '@mui-toolpad-extended-tuni/calendar';
140
159
 
141
160
  function App() {
142
161
  return (
143
162
  <BrowserRouter>
144
- <LMSProvider>
163
+ <ToolpadProvider>
145
164
  <Microservices>
146
165
  {/* CourseEventPublisher automatically publishes course events */}
147
166
  <CourseMicroservice />
@@ -149,7 +168,7 @@ function App() {
149
168
  {/* CalendarEventAggregator automatically subscribes and displays events */}
150
169
  <CalendarMicroservice />
151
170
  </Microservices>
152
- </LMSProvider>
171
+ </ToolpadProvider>
153
172
  </BrowserRouter>
154
173
  );
155
174
  }
@@ -15,7 +15,7 @@ interface CalendarMicroserviceProps {
15
15
  * Calendar receives events from EventBus, not directly from Courses.
16
16
  * Courses publishes events via CourseEventPublisher, Calendar subscribes via CalendarEventAggregator.
17
17
  *
18
- * This component should be used in App.tsx, not LMSProvider.tsx, to maintain
18
+ * This component should be used in App.tsx, not ToolpadProvider.tsx, to maintain
19
19
  * proper separation of concerns and avoid tight coupling.
20
20
  *
21
21
  * @example