@judo/app-shell 0.1.0
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/LICENSE +277 -0
- package/README.md +186 -0
- package/dist/AppShell.d.ts +15 -0
- package/dist/AppShell.d.ts.map +1 -0
- package/dist/actors/ActorSelector.d.ts +8 -0
- package/dist/actors/ActorSelector.d.ts.map +1 -0
- package/dist/errors/AppErrorBoundary.d.ts +20 -0
- package/dist/errors/AppErrorBoundary.d.ts.map +1 -0
- package/dist/hooks/use-navigation-badge.d.ts +8 -0
- package/dist/hooks/use-navigation-badge.d.ts.map +1 -0
- package/dist/hooks/use-theme.d.ts +33 -0
- package/dist/hooks/use-theme.d.ts.map +1 -0
- package/dist/index.d.ts +38 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2068 -0
- package/dist/index.js.map +1 -0
- package/dist/layout/AppBar.d.ts +19 -0
- package/dist/layout/AppBar.d.ts.map +1 -0
- package/dist/layout/AppShellLayout.d.ts +14 -0
- package/dist/layout/AppShellLayout.d.ts.map +1 -0
- package/dist/layout/Breadcrumbs.d.ts +8 -0
- package/dist/layout/Breadcrumbs.d.ts.map +1 -0
- package/dist/layout/Footer.d.ts +9 -0
- package/dist/layout/Footer.d.ts.map +1 -0
- package/dist/layout/PageDialogHost.d.ts +9 -0
- package/dist/layout/PageDialogHost.d.ts.map +1 -0
- package/dist/layout/layout-constants.d.ts +8 -0
- package/dist/layout/layout-constants.d.ts.map +1 -0
- package/dist/locale/LocaleSwitcher.d.ts +16 -0
- package/dist/locale/LocaleSwitcher.d.ts.map +1 -0
- package/dist/navigation/HorizontalNavigation.d.ts +14 -0
- package/dist/navigation/HorizontalNavigation.d.ts.map +1 -0
- package/dist/navigation/HorizontalNavigationItem.d.ts +20 -0
- package/dist/navigation/HorizontalNavigationItem.d.ts.map +1 -0
- package/dist/navigation/NavigationDrawer.d.ts +13 -0
- package/dist/navigation/NavigationDrawer.d.ts.map +1 -0
- package/dist/navigation/NavigationItemRenderer.d.ts +19 -0
- package/dist/navigation/NavigationItemRenderer.d.ts.map +1 -0
- package/dist/navigation/dashboard-utils.d.ts +8 -0
- package/dist/navigation/dashboard-utils.d.ts.map +1 -0
- package/dist/navigation/navigation-utils.d.ts +41 -0
- package/dist/navigation/navigation-utils.d.ts.map +1 -0
- package/dist/navigation/use-menu-operation-dispatch.d.ts +26 -0
- package/dist/navigation/use-menu-operation-dispatch.d.ts.map +1 -0
- package/dist/routes/DefaultGuestPage.d.ts +10 -0
- package/dist/routes/DefaultGuestPage.d.ts.map +1 -0
- package/dist/routes/DefaultSettingsPage.d.ts +9 -0
- package/dist/routes/DefaultSettingsPage.d.ts.map +1 -0
- package/dist/routes/PageRoute.d.ts +13 -0
- package/dist/routes/PageRoute.d.ts.map +1 -0
- package/dist/routes/RedirectPage.d.ts +12 -0
- package/dist/routes/RedirectPage.d.ts.map +1 -0
- package/dist/routes/generate-routes.d.ts +24 -0
- package/dist/routes/generate-routes.d.ts.map +1 -0
- package/dist/runtime/DefaultErrorScreen.d.ts +11 -0
- package/dist/runtime/DefaultErrorScreen.d.ts.map +1 -0
- package/dist/runtime/DefaultLoadingScreen.d.ts +5 -0
- package/dist/runtime/DefaultLoadingScreen.d.ts.map +1 -0
- package/dist/runtime/JudoRuntime.d.ts +27 -0
- package/dist/runtime/JudoRuntime.d.ts.map +1 -0
- package/dist/runtime/PrincipalBridge.d.ts +14 -0
- package/dist/runtime/PrincipalBridge.d.ts.map +1 -0
- package/dist/runtime/index.d.ts +5 -0
- package/dist/runtime/index.d.ts.map +1 -0
- package/dist/runtime/types.d.ts +308 -0
- package/dist/runtime/types.d.ts.map +1 -0
- package/dist/theme/ThemeProvider.d.ts +21 -0
- package/dist/theme/ThemeProvider.d.ts.map +1 -0
- package/dist/theme/ThemeToggle.d.ts +11 -0
- package/dist/theme/ThemeToggle.d.ts.map +1 -0
- package/dist/theme/density.d.ts +19 -0
- package/dist/theme/density.d.ts.map +1 -0
- package/dist/theme/judo-theme-factory.d.ts +29 -0
- package/dist/theme/judo-theme-factory.d.ts.map +1 -0
- package/dist/theme/presets.d.ts +51 -0
- package/dist/theme/presets.d.ts.map +1 -0
- package/dist/user/DefaultHeroComponent.d.ts +11 -0
- package/dist/user/DefaultHeroComponent.d.ts.map +1 -0
- package/dist/user/UserMenu.d.ts +8 -0
- package/dist/user/UserMenu.d.ts.map +1 -0
- package/package.json +99 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
Eclipse Public License - v 2.0
|
|
2
|
+
|
|
3
|
+
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
|
|
4
|
+
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
|
|
5
|
+
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
|
|
6
|
+
|
|
7
|
+
1. DEFINITIONS
|
|
8
|
+
|
|
9
|
+
"Contribution" means:
|
|
10
|
+
|
|
11
|
+
a) in the case of the initial Contributor, the initial content
|
|
12
|
+
Distributed under this Agreement, and
|
|
13
|
+
|
|
14
|
+
b) in the case of each subsequent Contributor:
|
|
15
|
+
i) changes to the Program, and
|
|
16
|
+
ii) additions to the Program;
|
|
17
|
+
where such changes and/or additions to the Program originate from
|
|
18
|
+
and are Distributed by that particular Contributor. A Contribution
|
|
19
|
+
"originates" from a Contributor if it was added to the Program by
|
|
20
|
+
such Contributor itself or anyone acting on such Contributor's behalf.
|
|
21
|
+
Contributions do not include changes or additions to the Program that
|
|
22
|
+
are not Modified Works.
|
|
23
|
+
|
|
24
|
+
"Contributor" means any person or entity that Distributes the Program.
|
|
25
|
+
|
|
26
|
+
"Licensed Patents" mean patent claims licensable by a Contributor which
|
|
27
|
+
are necessarily infringed by the use or sale of its Contribution alone
|
|
28
|
+
or when combined with the Program.
|
|
29
|
+
|
|
30
|
+
"Program" means the Contributions Distributed in accordance with this
|
|
31
|
+
Agreement.
|
|
32
|
+
|
|
33
|
+
"Recipient" means anyone who receives the Program under this Agreement
|
|
34
|
+
or any Secondary License (as applicable), including Contributors.
|
|
35
|
+
|
|
36
|
+
"Derivative Works" shall mean any work, whether in Source Code or other
|
|
37
|
+
form, that is based on (or derived from) the Program and for which the
|
|
38
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
39
|
+
represent, as a whole, an original work of authorship.
|
|
40
|
+
|
|
41
|
+
"Modified Works" shall mean any work in Source Code or other form that
|
|
42
|
+
results from an addition to, deletion from, or modification of the
|
|
43
|
+
contents of the Program, including, for purposes of clarity any new file
|
|
44
|
+
in Source Code form that contains any contents of the Program. Modified
|
|
45
|
+
Works shall not include works that contain only declarations,
|
|
46
|
+
interfaces, types, classes, structures, or files of the Program solely
|
|
47
|
+
in each case in order to link to, bind by name, or subclass the Program
|
|
48
|
+
or Modified Works thereof.
|
|
49
|
+
|
|
50
|
+
"Distribute" means the acts of a) distributing or b) making available
|
|
51
|
+
in any manner that enables the transfer of a copy.
|
|
52
|
+
|
|
53
|
+
"Source Code" means the form of a Program preferred for making
|
|
54
|
+
modifications, including but not limited to software source code,
|
|
55
|
+
documentation source, and configuration files.
|
|
56
|
+
|
|
57
|
+
"Secondary License" means either the GNU General Public License,
|
|
58
|
+
Version 2.0, or any later versions of that license, including any
|
|
59
|
+
exceptions or additional permissions as identified by the initial
|
|
60
|
+
Contributor.
|
|
61
|
+
|
|
62
|
+
2. GRANT OF RIGHTS
|
|
63
|
+
|
|
64
|
+
a) Subject to the terms of this Agreement, each Contributor hereby
|
|
65
|
+
grants Recipient a non-exclusive, worldwide, royalty-free copyright
|
|
66
|
+
license to reproduce, prepare Derivative Works of, publicly display,
|
|
67
|
+
publicly perform, Distribute and sublicense the Contribution of such
|
|
68
|
+
Contributor, if any, and such Derivative Works.
|
|
69
|
+
|
|
70
|
+
b) Subject to the terms of this Agreement, each Contributor hereby
|
|
71
|
+
grants Recipient a non-exclusive, worldwide, royalty-free patent
|
|
72
|
+
license under Licensed Patents to make, use, sell, offer to sell,
|
|
73
|
+
import and otherwise transfer the Contribution of such Contributor,
|
|
74
|
+
if any, in Source Code or other form. This patent license shall
|
|
75
|
+
apply to the combination of the Contribution and the Program if, at
|
|
76
|
+
the time the Contribution is added by the Contributor, such addition
|
|
77
|
+
of the Contribution causes such combination to be covered by the
|
|
78
|
+
Licensed Patents. The patent license shall not apply to any other
|
|
79
|
+
combinations which include the Contribution. No hardware per se is
|
|
80
|
+
licensed hereunder.
|
|
81
|
+
|
|
82
|
+
c) Recipient understands that although each Contributor grants the
|
|
83
|
+
licenses to its Contributions set forth herein, no assurances are
|
|
84
|
+
provided by any Contributor that the Program does not infringe the
|
|
85
|
+
patent or other intellectual property rights of any other entity.
|
|
86
|
+
Each Contributor disclaims any liability to Recipient for claims
|
|
87
|
+
brought by any other entity based on infringement of intellectual
|
|
88
|
+
property rights or otherwise. As a condition to exercising the
|
|
89
|
+
rights and licenses granted hereunder, each Recipient hereby
|
|
90
|
+
assumes sole responsibility to secure any other intellectual
|
|
91
|
+
property rights needed, if any. For example, if a third party
|
|
92
|
+
patent license is required to allow Recipient to Distribute the
|
|
93
|
+
Program, it is Recipient's responsibility to acquire that license
|
|
94
|
+
before distributing the Program.
|
|
95
|
+
|
|
96
|
+
d) Each Contributor represents that to its knowledge it has
|
|
97
|
+
sufficient copyright rights in its Contribution, if any, to grant
|
|
98
|
+
the copyright license set forth in this Agreement.
|
|
99
|
+
|
|
100
|
+
e) Notwithstanding the terms of any Secondary License, no
|
|
101
|
+
Contributor makes additional grants to any Recipient (other than
|
|
102
|
+
those set forth in this Agreement) as a result of such Recipient's
|
|
103
|
+
receipt of the Program under the terms of a Secondary License
|
|
104
|
+
(if permitted under the terms of Section 3).
|
|
105
|
+
|
|
106
|
+
3. REQUIREMENTS
|
|
107
|
+
|
|
108
|
+
3.1 If a Contributor Distributes the Program in any form, then:
|
|
109
|
+
|
|
110
|
+
a) the Program must also be made available as Source Code, in
|
|
111
|
+
accordance with section 3.2, and the Contributor must accompany
|
|
112
|
+
the Program with a statement that the Source Code for the Program
|
|
113
|
+
is available under this Agreement, and informs Recipients how to
|
|
114
|
+
obtain it in a reasonable manner on or through a medium customarily
|
|
115
|
+
used for software exchange; and
|
|
116
|
+
|
|
117
|
+
b) the Contributor may Distribute the Program under a license
|
|
118
|
+
different than this Agreement, provided that such license:
|
|
119
|
+
i) effectively disclaims on behalf of all other Contributors all
|
|
120
|
+
warranties and conditions, express and implied, including
|
|
121
|
+
warranties or conditions of title and non-infringement, and
|
|
122
|
+
implied warranties or conditions of merchantability and fitness
|
|
123
|
+
for a particular purpose;
|
|
124
|
+
|
|
125
|
+
ii) effectively excludes on behalf of all other Contributors all
|
|
126
|
+
liability for damages, including direct, indirect, special,
|
|
127
|
+
incidental and consequential damages, such as lost profits;
|
|
128
|
+
|
|
129
|
+
iii) does not attempt to limit or alter the recipients' rights
|
|
130
|
+
in the Source Code under section 3.2; and
|
|
131
|
+
|
|
132
|
+
iv) requires any subsequent distribution of the Program by any
|
|
133
|
+
party to be under a license that satisfies the requirements
|
|
134
|
+
of this section 3.
|
|
135
|
+
|
|
136
|
+
3.2 When the Program is Distributed as Source Code:
|
|
137
|
+
|
|
138
|
+
a) it must be made available under this Agreement, or if the
|
|
139
|
+
Program (i) is combined with other material in a separate file or
|
|
140
|
+
files made available under a Secondary License, and (ii) the initial
|
|
141
|
+
Contributor attached to the Source Code the notice described in
|
|
142
|
+
Exhibit A of this Agreement, then the Program may be made available
|
|
143
|
+
under the terms of such Secondary Licenses, and
|
|
144
|
+
|
|
145
|
+
b) a copy of this Agreement must be included with each copy of
|
|
146
|
+
the Program.
|
|
147
|
+
|
|
148
|
+
3.3 Contributors may not remove or alter any copyright, patent,
|
|
149
|
+
trademark, attribution notices, disclaimers of warranty, or limitations
|
|
150
|
+
of liability ("notices") contained within the Program from any copy of
|
|
151
|
+
the Program which they Distribute, provided that Contributors may add
|
|
152
|
+
their own appropriate notices.
|
|
153
|
+
|
|
154
|
+
4. COMMERCIAL DISTRIBUTION
|
|
155
|
+
|
|
156
|
+
Commercial distributors of software may accept certain responsibilities
|
|
157
|
+
with respect to end users, business partners and the like. While this
|
|
158
|
+
license is intended to facilitate the commercial use of the Program,
|
|
159
|
+
the Contributor who includes the Program in a commercial product
|
|
160
|
+
offering should do so in a manner which does not create potential
|
|
161
|
+
liability for other Contributors. Therefore, if a Contributor includes
|
|
162
|
+
the Program in a commercial product offering, such Contributor
|
|
163
|
+
("Commercial Contributor") hereby agrees to defend and indemnify every
|
|
164
|
+
other Contributor ("Indemnified Contributor") against any losses,
|
|
165
|
+
damages and costs (collectively "Losses") arising from claims, lawsuits
|
|
166
|
+
and other legal actions brought by a third party against the Indemnified
|
|
167
|
+
Contributor to the extent caused by the acts or omissions of such
|
|
168
|
+
Commercial Contributor in connection with its distribution of the Program
|
|
169
|
+
in a commercial product offering. The obligations in this section do not
|
|
170
|
+
apply to any claims or Losses relating to any actual or alleged
|
|
171
|
+
intellectual property infringement. In order to qualify, an Indemnified
|
|
172
|
+
Contributor must: a) promptly notify the Commercial Contributor in
|
|
173
|
+
writing of such claim, and b) allow the Commercial Contributor to control,
|
|
174
|
+
and cooperate with the Commercial Contributor in, the defense and any
|
|
175
|
+
related settlement negotiations. The Indemnified Contributor may
|
|
176
|
+
participate in any such claim at its own expense.
|
|
177
|
+
|
|
178
|
+
For example, a Contributor might include the Program in a commercial
|
|
179
|
+
product offering, Product X. That Contributor is then a Commercial
|
|
180
|
+
Contributor. If that Commercial Contributor then makes performance
|
|
181
|
+
claims, or offers warranties related to Product X, those performance
|
|
182
|
+
claims and warranties are such Commercial Contributor's responsibility
|
|
183
|
+
alone. Under this section, the Commercial Contributor would have to
|
|
184
|
+
defend claims against the other Contributors related to those performance
|
|
185
|
+
claims and warranties, and if a court requires any other Contributor to
|
|
186
|
+
pay any damages as a result, the Commercial Contributor must pay
|
|
187
|
+
those damages.
|
|
188
|
+
|
|
189
|
+
5. NO WARRANTY
|
|
190
|
+
|
|
191
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
192
|
+
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
|
|
193
|
+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
|
|
194
|
+
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
|
|
195
|
+
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
|
|
196
|
+
PURPOSE. Each Recipient is solely responsible for determining the
|
|
197
|
+
appropriateness of using and distributing the Program and assumes all
|
|
198
|
+
risks associated with its exercise of rights under this Agreement,
|
|
199
|
+
including but not limited to the risks and costs of program errors,
|
|
200
|
+
compliance with applicable laws, damage to or loss of data, programs
|
|
201
|
+
or equipment, and unavailability or interruption of operations.
|
|
202
|
+
|
|
203
|
+
6. DISCLAIMER OF LIABILITY
|
|
204
|
+
|
|
205
|
+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
|
|
206
|
+
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
|
|
207
|
+
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
208
|
+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
|
|
209
|
+
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
210
|
+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
211
|
+
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
|
|
212
|
+
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
|
|
213
|
+
POSSIBILITY OF SUCH DAMAGES.
|
|
214
|
+
|
|
215
|
+
7. GENERAL
|
|
216
|
+
|
|
217
|
+
If any provision of this Agreement is invalid or unenforceable under
|
|
218
|
+
applicable law, it shall not affect the validity or enforceability of
|
|
219
|
+
the remainder of the terms of this Agreement, and without further
|
|
220
|
+
action by the parties hereto, such provision shall be reformed to the
|
|
221
|
+
minimum extent necessary to make such provision valid and enforceable.
|
|
222
|
+
|
|
223
|
+
If Recipient institutes patent litigation against any entity
|
|
224
|
+
(including a cross-claim or counterclaim in a lawsuit) alleging that the
|
|
225
|
+
Program itself (excluding combinations of the Program with other software
|
|
226
|
+
or hardware) infringes such Recipient's patent(s), then such Recipient's
|
|
227
|
+
rights granted under Section 2(b) shall terminate as of the date such
|
|
228
|
+
litigation is filed.
|
|
229
|
+
|
|
230
|
+
All Recipient's rights under this Agreement shall terminate if it
|
|
231
|
+
fails to comply with any of the material terms or conditions of this
|
|
232
|
+
Agreement and does not cure such failure in a reasonable period of
|
|
233
|
+
time after becoming aware of such noncompliance. If all Recipient's
|
|
234
|
+
rights under this Agreement terminate, Recipient agrees to cease use
|
|
235
|
+
and distribution of the Program as soon as reasonably practicable.
|
|
236
|
+
However, Recipient's obligations under this Agreement and any licenses
|
|
237
|
+
granted by Recipient relating to the Program shall continue and survive.
|
|
238
|
+
|
|
239
|
+
Everyone is permitted to copy and distribute copies of this Agreement,
|
|
240
|
+
but in order to avoid inconsistency the Agreement is copyrighted and
|
|
241
|
+
may only be modified in the following manner. The Agreement Steward
|
|
242
|
+
reserves the right to publish new versions (including revisions) of
|
|
243
|
+
this Agreement from time to time. No one other than the Agreement
|
|
244
|
+
Steward has the right to modify this Agreement. The Eclipse Foundation
|
|
245
|
+
is the initial Agreement Steward. The Eclipse Foundation may assign the
|
|
246
|
+
responsibility to serve as the Agreement Steward to a suitable separate
|
|
247
|
+
entity. Each new version of the Agreement will be given a distinguishing
|
|
248
|
+
version number. The Program (including Contributions) may always be
|
|
249
|
+
Distributed subject to the version of the Agreement under which it was
|
|
250
|
+
received. In addition, after a new version of the Agreement is published,
|
|
251
|
+
Contributor may elect to Distribute the Program (including its
|
|
252
|
+
Contributions) under the new version.
|
|
253
|
+
|
|
254
|
+
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
|
|
255
|
+
receives no rights or licenses to the intellectual property of any
|
|
256
|
+
Contributor under this Agreement, whether expressly, by implication,
|
|
257
|
+
estoppel or otherwise. All rights in the Program not expressly granted
|
|
258
|
+
under this Agreement are reserved. Nothing in this Agreement is intended
|
|
259
|
+
to be enforceable by any entity that is not a Contributor or Recipient.
|
|
260
|
+
No third-party beneficiary rights are created under this Agreement.
|
|
261
|
+
|
|
262
|
+
Exhibit A - Form of Secondary Licenses Notice
|
|
263
|
+
|
|
264
|
+
"This Source Code may also be made available under the following
|
|
265
|
+
Secondary Licenses when the conditions for such availability set forth
|
|
266
|
+
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
|
|
267
|
+
version(s), and exceptions or additional permissions here}."
|
|
268
|
+
|
|
269
|
+
Simply including a copy of this Agreement, including this Exhibit A
|
|
270
|
+
is not sufficient to license the Source Code under Secondary Licenses.
|
|
271
|
+
|
|
272
|
+
If it is not possible or desirable to put the notice in a particular
|
|
273
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
274
|
+
file in a relevant directory) where a recipient would be likely to
|
|
275
|
+
look for such a notice.
|
|
276
|
+
|
|
277
|
+
You may add additional accurate notices of copyright ownership.
|
package/README.md
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# @judo/app-shell
|
|
2
|
+
|
|
3
|
+
> Admin dashboard application shell with multi-level navigation, multi-actor support, theme management, and badge notifications
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
The Layer 5 (UI) entry point that orchestrates layout, routing, theming, navigation, user menu, actor switching, error boundaries, and the full runtime bootstrap. Supports both vertical (sidebar drawer) and horizontal (top bar) menu layouts, configurable via the `Application.defaultMenuLayout` model property or the `menuLayout` prop. Depends on nearly every other package in the monorepo.
|
|
8
|
+
|
|
9
|
+
## Architecture Layer
|
|
10
|
+
|
|
11
|
+
**Layer 5 (UI)** — the top-level shell consumed by `standalone` and application-level code.
|
|
12
|
+
|
|
13
|
+
## Dependencies
|
|
14
|
+
|
|
15
|
+
| Workspace | External (Peer) |
|
|
16
|
+
| -------------------- | -------------------------------------------------------------- |
|
|
17
|
+
| `@judo/actions` | `@emotion/react`, `@emotion/styled` |
|
|
18
|
+
| `@judo/auth` | `@mui/icons-material`, `@mui/material` |
|
|
19
|
+
| `@judo/components` | `@mui/x-data-grid-pro` (optional), `@mui/x-license` (optional) |
|
|
20
|
+
| `@judo/core` | `react`, `react-router` |
|
|
21
|
+
| `@judo/expressions` | |
|
|
22
|
+
| `@judo/feedback` | |
|
|
23
|
+
| `@judo/guards` | |
|
|
24
|
+
| `@judo/i18n` | |
|
|
25
|
+
| `@judo/model-api` | |
|
|
26
|
+
| `@judo/model-loader` | |
|
|
27
|
+
| `@judo/test-ids` | |
|
|
28
|
+
|
|
29
|
+
## File Structure
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
src/
|
|
33
|
+
├── index.ts # Public API barrel
|
|
34
|
+
├── AppShell.tsx # Main shell wrapper (ThemeProvider + AppErrorBoundary + AppShellLayout)
|
|
35
|
+
├── actors/
|
|
36
|
+
│ └── ActorSelector.tsx # Multi-actor dropdown with realm-change confirmation
|
|
37
|
+
├── errors/
|
|
38
|
+
│ └── AppErrorBoundary.tsx # Root class-based error boundary
|
|
39
|
+
├── hooks/
|
|
40
|
+
│ ├── use-navigation-badge.ts # Badge hook (stub — always returns null)
|
|
41
|
+
│ └── use-theme.ts # Singleton ThemeStore + useTheme hook + initializeThemeStore
|
|
42
|
+
├── layout/
|
|
43
|
+
│ ├── AppBar.tsx # Top app bar (menu toggle, logo, actor selector, locale, theme, hero)
|
|
44
|
+
│ ├── AppShellLayout.tsx # Main layout (drawer + bar + content + footer + dialog host)
|
|
45
|
+
│ ├── Breadcrumbs.tsx # Breadcrumb trail from NavigationContext page stack
|
|
46
|
+
│ ├── Footer.tsx # Application footer (model name or custom footerText)
|
|
47
|
+
│ ├── PageDialogHost.tsx # Dialog stack renderer (all mounted, only topmost interactive)
|
|
48
|
+
│ └── layout-constants.ts # Drawer width constants (DRAWER_WIDTH_EXPANDED/COLLAPSED)
|
|
49
|
+
├── locale/
|
|
50
|
+
│ └── LocaleSwitcher.tsx # AppBar locale dropdown (globe icon, 2+ locales required)
|
|
51
|
+
├── navigation/
|
|
52
|
+
│ ├── NavigationDrawer.tsx # Persistent sidebar drawer (vertical mode)
|
|
53
|
+
│ ├── NavigationItemRenderer.tsx # Recursive vertical menu item with badge/icon/tooltip
|
|
54
|
+
│ ├── HorizontalNavigation.tsx # Top-bar nav container (horizontal mode)
|
|
55
|
+
│ ├── HorizontalNavigationItem.tsx # Recursive horizontal nav item + cascading sub-menus
|
|
56
|
+
│ ├── navigation-utils.ts # Route generation, filtering, localStorage persistence
|
|
57
|
+
│ └── dashboard-utils.ts # Dashboard route resolution from navigation tree
|
|
58
|
+
├── routes/
|
|
59
|
+
│ ├── generate-routes.tsx # Route tree generation from Application model
|
|
60
|
+
│ ├── DefaultGuestPage.tsx # Built-in guest access page (sign-in CTA)
|
|
61
|
+
│ ├── DefaultSettingsPage.tsx # Built-in settings placeholder
|
|
62
|
+
│ ├── PageRoute.tsx # Single page route wrapper with transfer ID generation
|
|
63
|
+
│ └── RedirectPage.tsx # /_redirect route — renders customizable RedirectHandler
|
|
64
|
+
├── runtime/
|
|
65
|
+
│ ├── types.ts # All config/props/state types
|
|
66
|
+
│ ├── JudoRuntime.tsx # Zero-boilerplate bootstrap (includes inlined AuthBridge, AuthTokenSync, NavigationProviderBridge, ApplicationRoutes)
|
|
67
|
+
│ ├── PrincipalBridge.tsx # Wires PrincipalProvider with API client
|
|
68
|
+
│ ├── DefaultLoadingScreen.tsx # Loading spinner screen
|
|
69
|
+
│ ├── DefaultErrorScreen.tsx # Error + retry screen
|
|
70
|
+
│ └── index.ts # Runtime barrel exports
|
|
71
|
+
├── theme/
|
|
72
|
+
│ ├── ThemeProvider.tsx # MUI ThemeProvider wrapper (mode, colors, density, muiThemeOptions)
|
|
73
|
+
│ ├── ThemeToggle.tsx # Light → dark → system toggle button
|
|
74
|
+
│ └── density.ts # Density level theme options (compact/comfortable/standard)
|
|
75
|
+
└── user/
|
|
76
|
+
├── DefaultHeroComponent.tsx # Built-in authenticated hero (avatar, profile, settings, logout)
|
|
77
|
+
└── UserMenu.tsx # Legacy user avatar dropdown (separate from DefaultHeroComponent)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Exports Summary
|
|
81
|
+
|
|
82
|
+
### Runtime Bootstrap
|
|
83
|
+
|
|
84
|
+
| Export | Kind | Description |
|
|
85
|
+
| ---------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
86
|
+
| `JudoRuntime` | component | **Zero-boilerplate bootstrap.** Loads model via loader, creates registry, builds REST API client, wires full provider tree, and auto-generates routes. Shows loading/error screens during init. Supports retry. |
|
|
87
|
+
| `JudoRuntimeConfig` | interface | Aggregates: `model`, `auth`, `api`, `theme`, `features`, `i18n`, `router`, `muiProLicenseKey`, `menuLayout`. |
|
|
88
|
+
| `JudoRuntimeProps` | interface | Props for `JudoRuntime` — `config`, `modelSource`, `logo`, `appBarExtra`, `loadingComponent`, `errorComponent`, `children`, `customizations`. |
|
|
89
|
+
| `JudoRuntimeState` | interface | Internal state: `phase` (`initializing`/`loading`/`ready`/`error`) + `error`. |
|
|
90
|
+
| `ModelConfig` | interface | Model URL or async loader + which app to activate. |
|
|
91
|
+
| `AuthConfig` | interface | OIDC / skip-auth config. |
|
|
92
|
+
| `ApiConfig` | interface | REST API endpoint config (baseUrl, timeout, headers). |
|
|
93
|
+
| `ThemeConfig` | interface | Theme customization (defaultMode, colors, muiThemeOptions, density). |
|
|
94
|
+
| `FeaturesConfig` | interface | Feature flags (guards, forceShowTotalCountForLazyTables, headerFilters). |
|
|
95
|
+
| `I18nConfig` | interface | Locale config (locales, localeLoader, translationKeyMap, persistLocale). |
|
|
96
|
+
| `RouterConfig` | interface | Router type (browser/hash/memory) and basePath. |
|
|
97
|
+
| `DefaultLoadingScreen` | component | Full-viewport centered CircularProgress + "Loading application..." text. |
|
|
98
|
+
| `DefaultErrorScreen` | component | Full-viewport error display with optional retry button. |
|
|
99
|
+
| `DefaultGuestPage` | component | Built-in guest access page. Centered Paper with app title, instructional text, and "Sign In" button. Used as fallback when no custom `guestComponent` is set. Receives `GuestPageProps`. |
|
|
100
|
+
|
|
101
|
+
### Application Shell
|
|
102
|
+
|
|
103
|
+
| Export | Kind | Description |
|
|
104
|
+
| ------------------ | --------- | --------------------------------------------------------------------------------------------------------- |
|
|
105
|
+
| `AppShell` | component | Wraps children in `ThemeProvider` + `AppErrorBoundary` + `AppShellLayout`. Requires `ApplicationContext`. |
|
|
106
|
+
| `AppErrorBoundary` | component | Root React error boundary. Catches unhandled errors, displays error + "Refresh Page" button. |
|
|
107
|
+
|
|
108
|
+
### Layout
|
|
109
|
+
|
|
110
|
+
| Export | Kind | Description |
|
|
111
|
+
| ---------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
112
|
+
| `AppShellLayout` | component | Main dashboard layout. In **vertical** mode (default): drawer open/collapsed state + NavigationDrawer. In **horizontal** mode: no drawer, navigation embedded in AppBar. Includes Footer and PageDialogHost. Accepts optional `menuLayout` prop overriding model's `Application.defaultMenuLayout`. |
|
|
113
|
+
| `AppBar` | component | Fixed top bar with menu toggle (vertical only), logo/app name, ActorSelector, HorizontalNavigation (horizontal only), LocaleSwitcher, ThemeToggle, and DefaultHeroComponent (auth-required apps). Resolves profilePictureUrl and settings/profile navigation. |
|
|
114
|
+
| `Breadcrumbs` | component | Breadcrumb trail from NavigationContext page stack. Clickable entries navigate back. Uses `useModelLabel` and `usePageTitle` for translated labels. |
|
|
115
|
+
| `PageDialogHost` | component | Renders dialog stack from NavigationContext. All dialogs mounted simultaneously — non-topmost hidden via CSS. Each dialog is a `SinglePageDialog` with full provider tree (PageProvider, ValidationProvider, DispatchProvider, etc.). |
|
|
116
|
+
|
|
117
|
+
### Navigation
|
|
118
|
+
|
|
119
|
+
| Export | Kind | Description |
|
|
120
|
+
| ------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
121
|
+
| `NavigationDrawer` | component | Persistent MUI Drawer with collapse toggle, search filter, and recursive item list. Persists expanded state to localStorage. Applies menu customizer from customizations. **Vertical mode only.** |
|
|
122
|
+
| `NavigationItemRenderer` | component | Recursive vertical nav item with icon (via `IconRenderer`), badge, active-state highlighting, expand/collapse, tooltip when collapsed. Uses `useModelLabel` for translated labels. |
|
|
123
|
+
| `HorizontalNavigation` | component | Top-bar navigation container rendering items as a flex row of buttons. Applies menu customizer. No search. **Horizontal mode only.** |
|
|
124
|
+
| `HorizontalNavigationItem` | component | Recursive horizontal nav item. Top-level: toolbar `Button` with dropdown `Menu` for children. Nested: cascading `MenuItem` sub-menus via `HorizontalNavigationSubItem`. Supports N-deep nesting, badges, icons, active-state. |
|
|
125
|
+
| `filterNavigationItems(items, query)` | function | Recursively filters nav items by label/name matching (case-insensitive). |
|
|
126
|
+
| `getRouteForPage(pageRef)` | function | Generates a URL path from a `PageDefinition` (resolved or string reference). Uses container type for route suffix. |
|
|
127
|
+
| `getDashboardRoute(application)` | function | Finds the first `isDashboard` page referenced in navigation, returns its route. Falls back to `"/"`. |
|
|
128
|
+
|
|
129
|
+
### Routing
|
|
130
|
+
|
|
131
|
+
| Export | Kind | Description |
|
|
132
|
+
| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
133
|
+
| `generateRoutes(props)` | function | Generates a React Router route tree from `Application`. Adds dashboard route, maps each page to `PageRoute`, adds `/_redirect`, `/settings`, optional `customRoutes`, and 404 catch-all. Accepts `GenerateRoutesProps`. |
|
|
134
|
+
| `PageRoute` | component | Wraps a page in `PageProvider` + `PageActionOverridesProvider` + `VisualPropertiesProvider`. Generates stable transfer IDs for TABLE/VIEW pages. Extracts `signedIdentifier` from URL params. Renders `PageRenderer`. |
|
|
135
|
+
| `RedirectPage` | component | Rendered at `/_redirect`. Looks up `redirectHandler` from customizations and renders it; shows fallback message if none configured. |
|
|
136
|
+
| `DefaultSettingsPage` | component | Built-in placeholder settings page at `/settings`. Uses i18n for labels. Replaced when `CustomizationsConfig.settingsPage` is provided. |
|
|
137
|
+
|
|
138
|
+
### Locale
|
|
139
|
+
|
|
140
|
+
| Export | Kind | Description |
|
|
141
|
+
| ---------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
142
|
+
| `LocaleSwitcher` | component | Globe icon button + dropdown menu for switching locales. Only renders when 2+ locales configured. Uses `useLocaleOptional()` for safe fallback outside `I18nProvider`. Positioned before `ThemeToggle` in AppBar. |
|
|
143
|
+
|
|
144
|
+
### Theme
|
|
145
|
+
|
|
146
|
+
| Export | Kind | Description |
|
|
147
|
+
| ---------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
148
|
+
| `ThemeProvider` | component | Creates MUI theme from config (mode, colors, density, muiThemeOptions) and wraps children in `MuiThemeProvider` + `CssBaseline`. |
|
|
149
|
+
| `ThemeToggle` | component | IconButton cycling light → dark → system → light. Shows next-mode icon. |
|
|
150
|
+
| `useTheme()` | hook | Returns current theme config and setter. Backed by singleton `LocalThemeStore` via `useSyncExternalStore`. |
|
|
151
|
+
| `initializeThemeStore(config, useSystemPreference?)` | function | Called by `JudoRuntime` before rendering. Applies runtime config. Preserves user's saved localStorage preference. |
|
|
152
|
+
| `hasUserThemePreference()` | function | Returns `true` if user has saved a theme mode or system preference to localStorage. |
|
|
153
|
+
| `createDensityThemeOptions(density)` | function | Returns MUI `ThemeOptions` for the given `DensityLevel` (`compact`/`comfortable`/`standard`). Applied as base layer before `muiThemeOptions`. |
|
|
154
|
+
| `DensityLevel` | type | Union type: `"compact" \| "comfortable" \| "standard"`. |
|
|
155
|
+
|
|
156
|
+
### Actors & User
|
|
157
|
+
|
|
158
|
+
| Export | Kind | Description |
|
|
159
|
+
| ---------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
160
|
+
| `ActorSelector` | component | MUI Select dropdown for switching between applications/actors. Hidden when ≤1 app. Uses `useActorSwitch` for realm-change confirmation. Navigates to dashboard after switch. |
|
|
161
|
+
| `DefaultHeroComponent` | component | Built-in hero for authenticated actors. Avatar button + dropdown with user info, Profile (conditional on `profilePage`), Settings (always), and Log Out. Uses i18n for labels, supports `profilePictureUrl`. Rendered by `AppBar` when no custom `heroComponent` configured. |
|
|
162
|
+
| `UserMenu` | component | Standalone user avatar button + dropdown. Not used by `AppBar` (which uses `DefaultHeroComponent` instead). Kept for custom layouts. |
|
|
163
|
+
|
|
164
|
+
### Hooks
|
|
165
|
+
|
|
166
|
+
| Hook | Description |
|
|
167
|
+
| -------------------------- | -------------------------------------------------------------------------------- |
|
|
168
|
+
| `useTheme()` | Theme config access via `useSyncExternalStore` over singleton `LocalThemeStore`. |
|
|
169
|
+
| `useNavigationBadge(item)` | **Stub** — always returns `null`. Reserved for future badge service. |
|
|
170
|
+
|
|
171
|
+
## Key Patterns
|
|
172
|
+
|
|
173
|
+
- **Dual menu layout**: `AppShellLayout` reads `Application.defaultMenuLayout` from the model (or accepts `menuLayout` prop override). `VERTICAL` renders `NavigationDrawer` sidebar with search/collapse/expand. `HORIZONTAL` hides the drawer, hides the hamburger toggle, and embeds `HorizontalNavigation` inside the `AppBar` toolbar with cascading dropdown sub-menus. Both modes use the same `NavigationController` model and support N-deep menu trees.
|
|
174
|
+
- **Singleton external store for theme**: `LocalThemeStore` class with `subscribe`/`getSnapshot` avoids React context for theme state; supports OS preference via `matchMedia` and localStorage persistence
|
|
175
|
+
- **Provider tree composition**: `JudoRuntime` assembles the entire provider stack in fixed order (Customizations → Theme → Feedback → API → RuntimeConfig → MuiPro → Application → Expressions → I18n → Auth → Data → Router → Navigation → AppShellLayout)
|
|
176
|
+
- **Model-driven routing**: `generateRoutes` + `getRouteForPage` + `PageRoute` derive URL paths entirely from `PageDefinition` objects and their resolved containers (TABLE/FORM/VIEW)
|
|
177
|
+
- **Dialog-as-page**: `PageDialogHost` reads dialog state from `NavigationContext` and renders a full page inside a MUI Dialog with its own PageProvider, ValidationProvider, DispatchProvider, and SelectorSelectionProvider
|
|
178
|
+
- **Stable transfer IDs**: Both `PageRoute` and `PageDialogHost` generate deterministic transfer IDs (`page::`, `dialog::`, `transfer::`) to key data store entries
|
|
179
|
+
- **Class-based error boundary**: `AppErrorBoundary` uses React class component lifecycle since function components can't catch render errors
|
|
180
|
+
- **User preference preservation**: `initializeThemeStore` checks localStorage before applying runtime config, ensuring user's chosen mode is never overwritten
|
|
181
|
+
- **Multi-actor support with realm safety**: `ActorSelector` uses `useActorSwitch` for confirmation when switching between actors with different OIDC realms
|
|
182
|
+
- **Menu customizer**: Both `NavigationDrawer` and `HorizontalNavigation` apply the `menuCustomizer` function from `CustomizationsConfig` to transform navigation items before rendering
|
|
183
|
+
- **Hero component pattern**: `AppBar` renders `DefaultHeroComponent` for authenticated actors by default; apps can replace it via `CustomizationsConfig.heroComponent`. Both receive `HeroComponentProps`.
|
|
184
|
+
- **Density theming**: `createDensityThemeOptions` provides three preset density levels that adjust spacing, font sizes, and component sizes across the entire UI
|
|
185
|
+
- **Footer**: `AppShellLayout` includes a `Footer` component at the bottom that displays either custom `footerText` from `CustomizationsConfig` or a default `© {year} {modelName}` string
|
|
186
|
+
- **Lazy code splitting**: Container renderers are lazy-loaded via `React.lazy` in `PageRenderer`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
export interface AppShellProps {
|
|
3
|
+
/** Children rendered in main content area */
|
|
4
|
+
children: ReactNode;
|
|
5
|
+
/** Custom logo component */
|
|
6
|
+
logo?: ReactNode;
|
|
7
|
+
/** Additional app bar items */
|
|
8
|
+
appBarExtra?: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Main application shell providing admin dashboard layout.
|
|
12
|
+
* Requires ApplicationContext (model must be loaded).
|
|
13
|
+
*/
|
|
14
|
+
export declare function AppShell({ children, logo, appBarExtra }: AppShellProps): import("react/jsx-runtime").JSX.Element;
|
|
15
|
+
//# sourceMappingURL=AppShell.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AppShell.d.ts","sourceRoot":"","sources":["../src/AppShell.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKvC,MAAM,WAAW,aAAa;IAC7B,6CAA6C;IAC7C,QAAQ,EAAE,SAAS,CAAC;IACpB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,aAAa,2CAUtE"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface ActorSelectorProps {
|
|
2
|
+
className?: string;
|
|
3
|
+
}
|
|
4
|
+
/**
|
|
5
|
+
* Actor/application selector for multi-actor applications.
|
|
6
|
+
*/
|
|
7
|
+
export declare function ActorSelector({ className }: ActorSelectorProps): import("react/jsx-runtime").JSX.Element | null;
|
|
8
|
+
//# sourceMappingURL=ActorSelector.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ActorSelector.d.ts","sourceRoot":"","sources":["../../src/actors/ActorSelector.tsx"],"names":[],"mappings":"AASA,MAAM,WAAW,kBAAkB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,kBAAkB,kDA4F9D"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Component, ErrorInfo, ReactNode } from 'react';
|
|
2
|
+
export interface AppErrorBoundaryProps {
|
|
3
|
+
children: ReactNode;
|
|
4
|
+
}
|
|
5
|
+
interface AppErrorBoundaryState {
|
|
6
|
+
hasError: boolean;
|
|
7
|
+
error: Error | null;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Root error boundary for application-level errors.
|
|
11
|
+
* No retry - user must refresh page.
|
|
12
|
+
*/
|
|
13
|
+
export declare class AppErrorBoundary extends Component<AppErrorBoundaryProps, AppErrorBoundaryState> {
|
|
14
|
+
state: AppErrorBoundaryState;
|
|
15
|
+
static getDerivedStateFromError(error: Error): AppErrorBoundaryState;
|
|
16
|
+
componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
|
|
17
|
+
render(): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import('react').ReactPortal | import('react').ReactElement<unknown, string | import('react').JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
|
|
18
|
+
}
|
|
19
|
+
export {};
|
|
20
|
+
//# sourceMappingURL=AppErrorBoundary.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AppErrorBoundary.d.ts","sourceRoot":"","sources":["../../src/errors/AppErrorBoundary.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAElE,MAAM,WAAW,qBAAqB;IACrC,QAAQ,EAAE,SAAS,CAAC;CACpB;AAED,UAAU,qBAAqB;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,SAAS,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;IAC5F,KAAK,EAAE,qBAAqB,CAG1B;IAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,qBAAqB;IAIpE,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI;IAI3D,MAAM;CA0CN"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { BadgeInfo } from '@judo/model-api';
|
|
2
|
+
/**
|
|
3
|
+
* Hook to get badge info for a navigation item.
|
|
4
|
+
*
|
|
5
|
+
* Need to implement a new badge service provider pattern.
|
|
6
|
+
*/
|
|
7
|
+
export declare function useNavigationBadge(_itemId: string): BadgeInfo | null;
|
|
8
|
+
//# sourceMappingURL=use-navigation-badge.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-navigation-badge.d.ts","sourceRoot":"","sources":["../../src/hooks/use-navigation-badge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAEpE"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { ThemeConfig } from '@judo/model-api';
|
|
2
|
+
export declare function getInitialMode(): "light" | "dark";
|
|
3
|
+
/**
|
|
4
|
+
* Check if user has a saved theme preference (either mode or system preference)
|
|
5
|
+
*/
|
|
6
|
+
export declare function hasUserThemePreference(): boolean;
|
|
7
|
+
/**
|
|
8
|
+
* Initialize the theme store with runtime configuration.
|
|
9
|
+
* Should be called by JudoRuntime before rendering the app.
|
|
10
|
+
*
|
|
11
|
+
* IMPORTANT: If user has already saved a preference (in localStorage), this
|
|
12
|
+
* function will only apply non-mode properties (colors, muiThemeOptions).
|
|
13
|
+
* The user's saved mode preference is preserved.
|
|
14
|
+
*
|
|
15
|
+
* @param config - Theme configuration
|
|
16
|
+
* @param useSystemPreference - Whether to track OS/browser preference (when defaultMode is 'system')
|
|
17
|
+
*/
|
|
18
|
+
export declare function initializeThemeStore(config: Partial<ThemeConfig>, useSystemPreference?: boolean): void;
|
|
19
|
+
/**
|
|
20
|
+
* Reset the local theme store to initial state.
|
|
21
|
+
* Only exported for testing purposes.
|
|
22
|
+
*/
|
|
23
|
+
export declare function resetLocalThemeStore(): void;
|
|
24
|
+
/**
|
|
25
|
+
* Hook to get and set theme configuration.
|
|
26
|
+
*
|
|
27
|
+
* Currently using local store only.
|
|
28
|
+
*/
|
|
29
|
+
export declare function useTheme(): {
|
|
30
|
+
config: ThemeConfig;
|
|
31
|
+
setTheme: (update: Partial<ThemeConfig>) => void;
|
|
32
|
+
};
|
|
33
|
+
//# sourceMappingURL=use-theme.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-theme.d.ts","sourceRoot":"","sources":["../../src/hooks/use-theme.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAOnD,wBAAgB,cAAc,IAAI,OAAO,GAAG,MAAM,CASjD;AAiHD;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAGhD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,mBAAmB,UAAQ,GAAG,IAAI,CAapG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ;;uBAGe,OAAO,CAAC,WAAW,CAAC;EAK1D"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @judo/app-shell
|
|
3
|
+
*
|
|
4
|
+
* Admin dashboard application shell with multi-level navigation,
|
|
5
|
+
* multi-actor support, theme management, and badge notifications.
|
|
6
|
+
*/
|
|
7
|
+
export { JudoRuntime, DefaultLoadingScreen, DefaultErrorScreen, type JudoRuntimeConfig, type JudoRuntimeProps, type JudoRuntimeState, type ModelConfig, type AuthConfig, type ApiConfig, type ThemeConfig, type RouterConfig, type FeaturesConfig, type I18nConfig, } from './runtime';
|
|
8
|
+
export { AppShell, type AppShellProps } from './AppShell';
|
|
9
|
+
export { AppShellLayout, type AppShellLayoutProps } from './layout/AppShellLayout';
|
|
10
|
+
export { AppBar, type AppBarProps } from './layout/AppBar';
|
|
11
|
+
export { Breadcrumbs, type BreadcrumbsProps } from './layout/Breadcrumbs';
|
|
12
|
+
export { PageDialogHost } from './layout/PageDialogHost';
|
|
13
|
+
export { NavigationDrawer, type NavigationDrawerProps } from './navigation/NavigationDrawer';
|
|
14
|
+
export { NavigationItemRenderer, type NavigationItemRendererProps } from './navigation/NavigationItemRenderer';
|
|
15
|
+
export { HorizontalNavigation, type HorizontalNavigationProps } from './navigation/HorizontalNavigation';
|
|
16
|
+
export { HorizontalNavigationItem, type HorizontalNavigationItemProps } from './navigation/HorizontalNavigationItem';
|
|
17
|
+
export { filterNavigationItems, getRouteForPage, findActionForNavigationItem } from './navigation/navigation-utils';
|
|
18
|
+
export { getDashboardRoute } from './navigation/dashboard-utils';
|
|
19
|
+
export { useMenuOperationDispatch, type UseMenuOperationDispatchResult, } from './navigation/use-menu-operation-dispatch';
|
|
20
|
+
export { ActorSelector, type ActorSelectorProps } from './actors/ActorSelector';
|
|
21
|
+
export { LocaleSwitcher, type LocaleSwitcherProps } from './locale/LocaleSwitcher';
|
|
22
|
+
export { UserMenu, type UserMenuProps } from './user/UserMenu';
|
|
23
|
+
export { DefaultHeroComponent } from './user/DefaultHeroComponent';
|
|
24
|
+
export { ThemeProvider, type ThemeProviderProps } from './theme/ThemeProvider';
|
|
25
|
+
export { ThemeToggle, type ThemeToggleProps } from './theme/ThemeToggle';
|
|
26
|
+
export { createDensityThemeOptions, type DensityLevel } from './theme/density';
|
|
27
|
+
export { createJudoThemeOptions, type JudoThemeFactoryOptions } from './theme/judo-theme-factory';
|
|
28
|
+
export { themePresets, resolvePreset, type ThemePreset, type ThemePresetName } from './theme/presets';
|
|
29
|
+
export { initializeThemeStore, hasUserThemePreference } from './hooks/use-theme';
|
|
30
|
+
export { generateRoutes, type GenerateRoutesProps } from './routes/generate-routes';
|
|
31
|
+
export { PageRoute, type PageRouteProps } from './routes/PageRoute';
|
|
32
|
+
export { RedirectPage } from './routes/RedirectPage';
|
|
33
|
+
export { DefaultSettingsPage } from './routes/DefaultSettingsPage';
|
|
34
|
+
export { DefaultGuestPage } from './routes/DefaultGuestPage';
|
|
35
|
+
export { AppErrorBoundary, type AppErrorBoundaryProps } from './errors/AppErrorBoundary';
|
|
36
|
+
export { useNavigationBadge } from './hooks/use-navigation-badge';
|
|
37
|
+
export { useTheme } from './hooks/use-theme';
|
|
38
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACN,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,UAAU,GACf,MAAM,WAAW,CAAC;AAGnB,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAG1D,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,KAAK,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAC/G,OAAO,EAAE,oBAAoB,EAAE,KAAK,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AACzG,OAAO,EAAE,wBAAwB,EAAE,KAAK,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AACrH,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACpH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EACN,wBAAwB,EACxB,KAAK,8BAA8B,GACnC,MAAM,0CAA0C,CAAC;AAGlD,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAGhF,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAGnF,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAGnE,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,yBAAyB,EAAE,KAAK,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,KAAK,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACtG,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAGjF,OAAO,EAAE,cAAc,EAAE,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC"}
|