@rapidmx/web-client 0.14.1 → 0.16.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/README.md +373 -373
- package/apps/admin/branding/index.tsx +39 -39
- package/apps/admin/data-requests/index.tsx +482 -480
- package/apps/admin/domains/[uid].tsx +164 -163
- package/apps/admin/escrow-scopes/[uid].tsx +348 -348
- package/apps/admin/index.tsx +127 -124
- package/apps/admin/mailboxes/[uid].tsx +269 -224
- package/apps/admin/mailboxes/new/index.tsx +28 -28
- package/apps/admin/plugins/index.tsx +15 -15
- package/apps/admin/retention-policy/index.tsx +39 -39
- package/apps/admin/signing-certificates/index.tsx +343 -343
- package/apps/escrow/audit-log/index.tsx +196 -196
- package/apps/escrow/matters/[uid].tsx +621 -621
- package/apps/shared/appearance/AppearanceForm.tsx +9 -1
- package/apps/shared/auth/adminAccess.ts +99 -99
- package/apps/shared/calendar/bookingPlugin.ts +100 -0
- package/apps/shared/calendar/calendarLiveUpdates.ts +27 -0
- package/apps/shared/components/admin/layout/AdminShell.tsx +378 -346
- package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -0
- package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
- package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -0
- package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
- package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
- package/apps/shared/components/admin/settings/MailboxCreateForm.tsx +53 -4
- package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
- package/apps/shared/components/admin/settings/PluginsManager.tsx +64 -10
- package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
- package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
- package/apps/shared/components/admin/setup/SetupWizard.tsx +444 -444
- package/apps/shared/components/admin/usePagedList.tsx +129 -129
- package/apps/shared/components/calendar/AppointmentQuickForm.tsx +327 -0
- package/apps/shared/components/calendar/DescriptionEditor.tsx +274 -0
- package/apps/shared/components/calendar/EventDescriptionView.tsx +70 -0
- package/apps/shared/components/calendar/EventDetails.tsx +401 -0
- package/apps/shared/components/calendar/EventEditor.tsx +635 -0
- package/apps/shared/components/calendar/EventExpandedForm.tsx +210 -0
- package/apps/shared/components/calendar/EventFormParts.tsx +591 -0
- package/apps/shared/components/calendar/EventModal.tsx +206 -946
- package/apps/shared/components/calendar/EventQuickForm.tsx +116 -0
- package/apps/shared/components/calendar/EventShell.tsx +202 -0
- package/apps/shared/components/calendar/FindATime.tsx +379 -0
- package/apps/shared/components/calendar/GuestInput.tsx +100 -0
- package/apps/shared/components/calendar/LazyDescriptionEditor.tsx +70 -0
- package/apps/shared/components/calendar/MonthView.tsx +185 -173
- package/apps/shared/components/calendar/QuickCreateFaces.tsx +87 -0
- package/apps/shared/components/calendar/QuickCreateTabs.tsx +81 -0
- package/apps/shared/components/calendar/QuickFaceFrame.tsx +81 -0
- package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -222
- package/apps/shared/components/calendar/RequestChangeForm.tsx +240 -0
- package/apps/shared/components/calendar/SplitDayView.tsx +144 -143
- package/apps/shared/components/calendar/TaskQuickForm.tsx +289 -0
- package/apps/shared/components/calendar/TimeGridView.tsx +246 -244
- package/apps/shared/components/calendar/allDay.ts +124 -124
- package/apps/shared/components/calendar/eventDialogFields.ts +86 -0
- package/apps/shared/components/calendar/eventForm.ts +108 -0
- package/apps/shared/components/calendar/eventFormat.ts +210 -0
- package/apps/shared/components/calendar/findTimeGrid.ts +90 -0
- package/apps/shared/components/calendar/layout/CalendarShell.tsx +201 -200
- package/apps/shared/components/calendar/swipeNavigation.ts +14 -0
- package/apps/shared/components/contacts/ContactForm.tsx +383 -383
- package/apps/shared/components/contacts/ContactsSidebar.tsx +1 -1
- package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -98
- package/apps/shared/components/contacts/layout/ContactsShell.tsx +217 -216
- package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
- package/apps/shared/components/layout/AppShell.tsx +480 -480
- package/apps/shared/components/layout/FloatingActionButton.tsx +31 -0
- package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
- package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
- package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
- package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
- package/apps/shared/components/layout/UserMenu.tsx +439 -372
- package/apps/shared/components/mail/ConversationList.tsx +323 -271
- package/apps/shared/components/mail/ConversationThreadPane.tsx +130 -5
- package/apps/shared/components/mail/InviteCard.tsx +387 -0
- package/apps/shared/components/mail/MailSelectionBar.tsx +236 -227
- package/apps/shared/components/mail/MessageDetailPane.tsx +1559 -1537
- package/apps/shared/components/mail/SwipeRow.tsx +120 -0
- package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
- package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
- package/apps/shared/components/mail/compose/ComposeWindow.tsx +1681 -1673
- package/apps/shared/components/mail/compose/RecipientInput.tsx +54 -11
- package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
- package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
- package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
- package/apps/shared/components/mail/invite/InviteRowChip.tsx +104 -0
- package/apps/shared/components/mail/invite/InviteRsvpPopover.tsx +271 -0
- package/apps/shared/components/mail/invite/InviteTimeline.tsx +200 -0
- package/apps/shared/components/mail/invite/ProposeTimeForm.tsx +109 -0
- package/apps/shared/components/mail/invite/inviteFormat.ts +110 -0
- package/apps/shared/components/mail/invite/inviteStore.ts +114 -0
- package/apps/shared/components/mail/layout/FolderBadgeChip.tsx +21 -0
- package/apps/shared/components/mail/layout/MailShell.tsx +546 -490
- package/apps/shared/components/mail/layout/SidebarSection.tsx +66 -0
- package/apps/shared/components/mail/reading/PendingMessageCard.tsx +68 -0
- package/apps/shared/components/mail/verificationSeals.ts +125 -125
- package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
- package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
- package/apps/shared/components/settings/layout/SettingsShell.tsx +255 -253
- package/apps/shared/components/tasks/TasksSidebar.tsx +1 -1
- package/apps/shared/components/tasks/layout/TasksShell.tsx +218 -217
- package/apps/shared/gestures/useEnterSlide.ts +54 -0
- package/apps/shared/gestures/useSwipe.ts +114 -0
- package/apps/shared/gestures/useSwipeSlide.ts +113 -0
- package/apps/shared/gestures/useWheelPaging.ts +107 -0
- package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
- package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
- package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
- package/apps/shared/keyboard/dispatch.ts +124 -124
- package/apps/shared/keyboard/format.ts +89 -89
- package/apps/shared/keyboard/keymap.ts +114 -114
- package/apps/shared/keyboard/registry.ts +65 -65
- package/apps/shared/keyboard/targets.ts +79 -79
- package/apps/shared/mail/folderCounts.ts +17 -0
- package/apps/shared/mail/folderTree.ts +143 -143
- package/apps/shared/mail/listAllPages.ts +39 -39
- package/apps/shared/mail/newMailNotifications.ts +3 -15
- package/apps/shared/mail/outbox/outgoingReplies.ts +192 -0
- package/apps/shared/mail/outbox/sendJob.ts +19 -1
- package/apps/shared/mail/outbox/sendOutcomes.ts +13 -4
- package/apps/shared/mail/primaryMailbox.ts +71 -0
- package/apps/shared/mail/useCollapsedSections.ts +146 -0
- package/apps/shared/mail/useMailConnection.ts +205 -203
- package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
- package/apps/shared/mail/useMarkMessageRead.ts +47 -47
- package/apps/shared/mail/useNewMailNotifications.ts +2 -2
- package/apps/shared/navigation/AppRouter.tsx +300 -300
- package/apps/shared/navigation/routerContext.tsx +83 -83
- package/apps/shared/notifications/preferences.ts +36 -0
- package/apps/shared/notifications/store.ts +9 -0
- package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
- package/apps/shared/search/crossMailboxSearch.ts +169 -0
- package/apps/shared/search/localIndexBuilder.ts +481 -481
- package/apps/shared/signing/enrollmentStorage.ts +33 -33
- package/apps/shared/signing/enrollmentTracker.ts +385 -385
- package/apps/shared/signing/enrollmentView.ts +251 -251
- package/apps/shared/signing/useNow.ts +19 -19
- package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
- package/apps/shared/styles/app.css +396 -386
- package/apps/www/_routes.ts +1 -0
- package/apps/www/calendar/index.tsx +578 -469
- package/apps/www/contacts/[uid].tsx +109 -109
- package/apps/www/contacts/index.tsx +6 -0
- package/apps/www/index.tsx +2847 -2332
- package/apps/www/messages/[uid].tsx +135 -108
- package/apps/www/settings/auto-reply/index.tsx +133 -133
- package/apps/www/settings/encryption/index.tsx +1287 -1287
- package/apps/www/settings/filters/[uid].tsx +176 -176
- package/apps/www/settings/filters/index.tsx +102 -102
- package/apps/www/settings/filters/new/index.tsx +140 -140
- package/apps/www/settings/labels/index.tsx +204 -204
- package/apps/www/settings/privacy/index.tsx +492 -492
- package/apps/www/settings/profile/index.tsx +248 -0
- package/apps/www/settings/read-receipts/index.tsx +147 -147
- package/apps/www/settings/sharing/index.tsx +256 -256
- package/apps/www/settings/signatures/[uid].tsx +172 -172
- package/apps/www/settings/signatures/index.tsx +88 -88
- package/apps/www/settings/signatures/new/index.tsx +135 -135
- package/apps/www/tasks/index.tsx +649 -649
- package/dist/apps/admin/data-requests/index.js +1 -1
- package/dist/apps/admin/domains/[uid].js +4 -2
- package/dist/apps/admin/index.js +2 -1
- package/dist/apps/admin/mailboxes/[uid].js +12 -2
- package/dist/apps/shared/appearance/AppearanceForm.js +9 -1
- package/dist/apps/shared/calendar/bookingPlugin.d.ts +50 -0
- package/dist/apps/shared/calendar/bookingPlugin.js +57 -0
- package/dist/apps/shared/calendar/calendarLiveUpdates.d.ts +11 -0
- package/dist/apps/shared/calendar/calendarLiveUpdates.js +23 -0
- package/dist/apps/shared/components/admin/layout/AdminShell.d.ts +1 -1
- package/dist/apps/shared/components/admin/layout/AdminShell.js +7 -3
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.d.ts +35 -0
- package/dist/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.js +115 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.d.ts +16 -0
- package/dist/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.js +92 -0
- package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
- package/dist/apps/shared/components/admin/settings/MailboxCreateForm.js +28 -4
- package/dist/apps/shared/components/admin/settings/PluginsManager.js +40 -6
- package/dist/apps/shared/components/calendar/AppointmentQuickForm.d.ts +47 -0
- package/dist/apps/shared/components/calendar/AppointmentQuickForm.js +135 -0
- package/dist/apps/shared/components/calendar/DescriptionEditor.d.ts +26 -0
- package/dist/apps/shared/components/calendar/DescriptionEditor.js +192 -0
- package/dist/apps/shared/components/calendar/EventDescriptionView.d.ts +14 -0
- package/dist/apps/shared/components/calendar/EventDescriptionView.js +39 -0
- package/dist/apps/shared/components/calendar/EventDetails.d.ts +33 -0
- package/dist/apps/shared/components/calendar/EventDetails.js +137 -0
- package/dist/apps/shared/components/calendar/EventEditor.d.ts +59 -0
- package/dist/apps/shared/components/calendar/EventEditor.js +544 -0
- package/dist/apps/shared/components/calendar/EventExpandedForm.d.ts +14 -0
- package/dist/apps/shared/components/calendar/EventExpandedForm.js +44 -0
- package/dist/apps/shared/components/calendar/EventFormParts.d.ts +70 -0
- package/dist/apps/shared/components/calendar/EventFormParts.js +191 -0
- package/dist/apps/shared/components/calendar/EventModal.d.ts +26 -13
- package/dist/apps/shared/components/calendar/EventModal.js +57 -459
- package/dist/apps/shared/components/calendar/EventQuickForm.d.ts +18 -0
- package/dist/apps/shared/components/calendar/EventQuickForm.js +25 -0
- package/dist/apps/shared/components/calendar/EventShell.d.ts +64 -0
- package/dist/apps/shared/components/calendar/EventShell.js +134 -0
- package/dist/apps/shared/components/calendar/FindATime.d.ts +18 -0
- package/dist/apps/shared/components/calendar/FindATime.js +190 -0
- package/dist/apps/shared/components/calendar/GuestInput.d.ts +45 -0
- package/dist/apps/shared/components/calendar/GuestInput.js +30 -0
- package/dist/apps/shared/components/calendar/LazyDescriptionEditor.d.ts +8 -0
- package/dist/apps/shared/components/calendar/LazyDescriptionEditor.js +44 -0
- package/dist/apps/shared/components/calendar/MonthView.d.ts +5 -1
- package/dist/apps/shared/components/calendar/MonthView.js +11 -5
- package/dist/apps/shared/components/calendar/QuickCreateFaces.d.ts +30 -0
- package/dist/apps/shared/components/calendar/QuickCreateFaces.js +44 -0
- package/dist/apps/shared/components/calendar/QuickCreateTabs.d.ts +24 -0
- package/dist/apps/shared/components/calendar/QuickCreateTabs.js +46 -0
- package/dist/apps/shared/components/calendar/QuickFaceFrame.d.ts +25 -0
- package/dist/apps/shared/components/calendar/QuickFaceFrame.js +19 -0
- package/dist/apps/shared/components/calendar/RecurrenceEditor.d.ts +4 -1
- package/dist/apps/shared/components/calendar/RecurrenceEditor.js +2 -2
- package/dist/apps/shared/components/calendar/RequestChangeForm.d.ts +36 -0
- package/dist/apps/shared/components/calendar/RequestChangeForm.js +127 -0
- package/dist/apps/shared/components/calendar/SplitDayView.d.ts +3 -2
- package/dist/apps/shared/components/calendar/SplitDayView.js +3 -2
- package/dist/apps/shared/components/calendar/TaskQuickForm.d.ts +40 -0
- package/dist/apps/shared/components/calendar/TaskQuickForm.js +101 -0
- package/dist/apps/shared/components/calendar/TimeGridView.d.ts +4 -2
- package/dist/apps/shared/components/calendar/TimeGridView.js +3 -2
- package/dist/apps/shared/components/calendar/eventDialogFields.d.ts +28 -0
- package/dist/apps/shared/components/calendar/eventDialogFields.js +59 -0
- package/dist/apps/shared/components/calendar/eventForm.d.ts +98 -0
- package/dist/apps/shared/components/calendar/eventForm.js +1 -0
- package/dist/apps/shared/components/calendar/eventFormat.d.ts +80 -0
- package/dist/apps/shared/components/calendar/eventFormat.js +190 -0
- package/dist/apps/shared/components/calendar/findTimeGrid.d.ts +30 -0
- package/dist/apps/shared/components/calendar/findTimeGrid.js +83 -0
- package/dist/apps/shared/components/calendar/layout/CalendarShell.js +3 -2
- package/dist/apps/shared/components/calendar/swipeNavigation.d.ts +9 -0
- package/dist/apps/shared/components/calendar/swipeNavigation.js +8 -0
- package/dist/apps/shared/components/contacts/ContactsSidebar.js +1 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.d.ts +3 -1
- package/dist/apps/shared/components/contacts/ContactsToolbar.js +4 -2
- package/dist/apps/shared/components/contacts/layout/ContactsShell.js +4 -3
- package/dist/apps/shared/components/layout/FloatingActionButton.d.ts +13 -0
- package/dist/apps/shared/components/layout/FloatingActionButton.js +9 -0
- package/dist/apps/shared/components/layout/UserMenu.d.ts +14 -9
- package/dist/apps/shared/components/layout/UserMenu.js +74 -26
- package/dist/apps/shared/components/mail/ConversationList.d.ts +12 -1
- package/dist/apps/shared/components/mail/ConversationList.js +21 -4
- package/dist/apps/shared/components/mail/ConversationThreadPane.d.ts +4 -1
- package/dist/apps/shared/components/mail/ConversationThreadPane.js +127 -22
- package/dist/apps/shared/components/mail/InviteCard.d.ts +20 -0
- package/dist/apps/shared/components/mail/InviteCard.js +150 -0
- package/dist/apps/shared/components/mail/MailSelectionBar.d.ts +6 -1
- package/dist/apps/shared/components/mail/MailSelectionBar.js +3 -3
- package/dist/apps/shared/components/mail/MessageDetailPane.js +13 -2
- package/dist/apps/shared/components/mail/SwipeRow.d.ts +22 -0
- package/dist/apps/shared/components/mail/SwipeRow.js +71 -0
- package/dist/apps/shared/components/mail/compose/ComposeWindow.js +16 -7
- package/dist/apps/shared/components/mail/compose/RecipientInput.d.ts +21 -1
- package/dist/apps/shared/components/mail/compose/RecipientInput.js +18 -10
- package/dist/apps/shared/components/mail/invite/InviteRowChip.d.ts +23 -0
- package/dist/apps/shared/components/mail/invite/InviteRowChip.js +46 -0
- package/dist/apps/shared/components/mail/invite/InviteRsvpPopover.d.ts +20 -0
- package/dist/apps/shared/components/mail/invite/InviteRsvpPopover.js +141 -0
- package/dist/apps/shared/components/mail/invite/InviteTimeline.d.ts +27 -0
- package/dist/apps/shared/components/mail/invite/InviteTimeline.js +120 -0
- package/dist/apps/shared/components/mail/invite/ProposeTimeForm.d.ts +17 -0
- package/dist/apps/shared/components/mail/invite/ProposeTimeForm.js +45 -0
- package/dist/apps/shared/components/mail/invite/inviteFormat.d.ts +28 -0
- package/dist/apps/shared/components/mail/invite/inviteFormat.js +94 -0
- package/dist/apps/shared/components/mail/invite/inviteStore.d.ts +28 -0
- package/dist/apps/shared/components/mail/invite/inviteStore.js +95 -0
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.d.ts +6 -0
- package/dist/apps/shared/components/mail/layout/FolderBadgeChip.js +9 -0
- package/dist/apps/shared/components/mail/layout/MailShell.d.ts +10 -0
- package/dist/apps/shared/components/mail/layout/MailShell.js +76 -46
- package/dist/apps/shared/components/mail/layout/SidebarSection.d.ts +23 -0
- package/dist/apps/shared/components/mail/layout/SidebarSection.js +16 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.d.ts +14 -0
- package/dist/apps/shared/components/mail/reading/PendingMessageCard.js +16 -0
- package/dist/apps/shared/components/settings/layout/SettingsShell.js +7 -5
- package/dist/apps/shared/components/tasks/TasksSidebar.js +1 -1
- package/dist/apps/shared/components/tasks/layout/TasksShell.js +4 -3
- package/dist/apps/shared/gestures/useEnterSlide.d.ts +14 -0
- package/dist/apps/shared/gestures/useEnterSlide.js +47 -0
- package/dist/apps/shared/gestures/useSwipe.d.ts +45 -0
- package/dist/apps/shared/gestures/useSwipe.js +90 -0
- package/dist/apps/shared/gestures/useSwipeSlide.d.ts +40 -0
- package/dist/apps/shared/gestures/useSwipeSlide.js +95 -0
- package/dist/apps/shared/gestures/useWheelPaging.d.ts +32 -0
- package/dist/apps/shared/gestures/useWheelPaging.js +85 -0
- package/dist/apps/shared/mail/folderCounts.d.ts +10 -0
- package/dist/apps/shared/mail/folderCounts.js +12 -0
- package/dist/apps/shared/mail/newMailNotifications.d.ts +3 -8
- package/dist/apps/shared/mail/newMailNotifications.js +3 -12
- package/dist/apps/shared/mail/outbox/outgoingReplies.d.ts +80 -0
- package/dist/apps/shared/mail/outbox/outgoingReplies.js +131 -0
- package/dist/apps/shared/mail/outbox/sendJob.d.ts +5 -1
- package/dist/apps/shared/mail/outbox/sendJob.js +14 -1
- package/dist/apps/shared/mail/outbox/sendOutcomes.js +13 -4
- package/dist/apps/shared/mail/primaryMailbox.d.ts +29 -0
- package/dist/apps/shared/mail/primaryMailbox.js +61 -0
- package/dist/apps/shared/mail/useCollapsedSections.d.ts +32 -0
- package/dist/apps/shared/mail/useCollapsedSections.js +110 -0
- package/dist/apps/shared/mail/useMailConnection.js +3 -1
- package/dist/apps/shared/mail/useNewMailNotifications.js +3 -2
- package/dist/apps/shared/notifications/preferences.d.ts +13 -0
- package/dist/apps/shared/notifications/preferences.js +36 -0
- package/dist/apps/shared/notifications/store.d.ts +1 -0
- package/dist/apps/shared/notifications/store.js +7 -23
- package/dist/apps/shared/search/crossMailboxSearch.d.ts +72 -0
- package/dist/apps/shared/search/crossMailboxSearch.js +136 -0
- package/dist/apps/shared/styles/app.css +396 -386
- package/dist/apps/www/_routes.js +1 -0
- package/dist/apps/www/calendar/index.js +78 -7
- package/dist/apps/www/contacts/index.js +3 -1
- package/dist/apps/www/index.js +548 -210
- package/dist/apps/www/messages/[uid].js +13 -5
- package/dist/apps/www/settings/profile/index.d.ts +4 -0
- package/dist/apps/www/settings/profile/index.js +124 -0
- package/package.json +2 -2
|
@@ -1,300 +1,300 @@
|
|
|
1
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
-
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
-
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
-
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
-
/**
|
|
6
|
-
* The web client's client-side router: what lets Mail, Calendar, Contacts, Tasks and Settings replace one another - and a
|
|
7
|
-
* folder replace a folder - without a page load.
|
|
8
|
-
*
|
|
9
|
-
* `@rapidrest/react` has no router of its own: every page is a server-rendered document with its own hydration entry, and
|
|
10
|
-
* hydrates only the page component (never `_layout.tsx`). So the router is a component the pages render themselves - each
|
|
11
|
-
* page's default export is `routedPage(path, Page)` (see `apps/www/_routedPage.tsx`), which renders `AppRouter` with the page
|
|
12
|
-
* as its first content. The first load is unchanged: the server renders the same tree, the browser hydrates it.
|
|
13
|
-
*
|
|
14
|
-
* `AppRouter` keeps ONE `AppChrome` (the icon rail, header, user menu, impersonation banner, compose windows, unlock prompt,
|
|
15
|
-
* idle-key timer, sign-out listener) mounted and swaps only what is inside it. A page's own shell (`MailShell`,
|
|
16
|
-
* `CalendarShell`, ...) still renders `AppShell` as it always did; inside the frame that renders nothing but its children.
|
|
17
|
-
*
|
|
18
|
-
* Navigation:
|
|
19
|
-
*
|
|
20
|
-
* Every `<a href>` to a same-origin path in the route table is intercepted (plain left clicks only - not with a modifier key, not
|
|
21
|
-
* `target`/`download`, not a hash-only link, not one marked `data-full-reload`), so pages just write ordinary links and
|
|
22
|
-
* middle-click, "open in new tab" and copy-link keep working. Anything not in the table - the admin and escrow consoles, plugin
|
|
23
|
-
* pages, other sites - is left to the browser. `useNavigate()` does the same for code (`navigate("/contacts")`).
|
|
24
|
-
*
|
|
25
|
-
* Back and forward work (`popstate`), and the URL is always the real, shareable one (`?mailboxUid=&folderUid=` and all).
|
|
26
|
-
*
|
|
27
|
-
* A route's code is loaded (`route.load()`) before the URL and the page change, so the old page stays up meanwhile (the frame is
|
|
28
|
-
* `aria-busy`); a route that fails to load falls back to a real navigation, which also picks up a new deploy.
|
|
29
|
-
*
|
|
30
|
-
* The next page's code is fetched on hover, focus and pointer-down of a link to it, and for the app rail's pages when the browser
|
|
31
|
-
* is idle.
|
|
32
|
-
*
|
|
33
|
-
* After a page change the frame moves keyboard focus to the content region, scrolls to the top, sets `document.title` and
|
|
34
|
-
* announces the new page to screen readers.
|
|
35
|
-
*
|
|
36
|
-
* The props of every `apps/www` page are the same for all of them (`WwwRoute.fetchProps()`: the user, auth-server URL,
|
|
37
|
-
* branding, plugin navigation, impersonation) except `params`, which the router recomputes from the URL - so the props of the
|
|
38
|
-
* page that was loaded are what every later page gets.
|
|
39
|
-
*/
|
|
40
|
-
import React, { ComponentType, useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
41
|
-
import { AppChrome, type AppShellProps } from "../components/layout/AppShell.js";
|
|
42
|
-
import { AppFrameContext, AppFrameContextValue } from "./frameContext.js";
|
|
43
|
-
import { whenIdle, shouldSaveData } from "./idle.js";
|
|
44
|
-
import { RouteDefinition, RouteMatch, matchRoute } from "./routes.js";
|
|
45
|
-
import { NavigateFn, RouterContext, RouterContextValue, RouterLocation, UNKNOWN_LOCATION, readWindowLocation } from "./routerContext.js";
|
|
46
|
-
|
|
47
|
-
export { useLocation, useLocationSearch, useNavigate } from "./routerContext.js";
|
|
48
|
-
export type { NavigateFn, NavigateOptions, RouterLocation } from "./routerContext.js";
|
|
49
|
-
|
|
50
|
-
/** What `routedPage()` gives the router: the page component itself, without the router around it. */
|
|
51
|
-
export type RoutedPageComponent<P = any> = ComponentType<P> & { page: ComponentType<P> };
|
|
52
|
-
|
|
53
|
-
interface CurrentPage {
|
|
54
|
-
Page: ComponentType<any>;
|
|
55
|
-
/** The route template shown. */
|
|
56
|
-
routePath: string;
|
|
57
|
-
active: string;
|
|
58
|
-
params: Record<string, string>;
|
|
59
|
-
/** Changes with the pathname, so a different page (or the same page for a different `:uid`) mounts fresh, while a change
|
|
60
|
-
* of query string alone - a folder - keeps the page and its state. */
|
|
61
|
-
key: string;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export interface AppRouterProps {
|
|
65
|
-
routes: readonly RouteDefinition[];
|
|
66
|
-
/** The template of the route this document was rendered for. */
|
|
67
|
-
initialPath: string;
|
|
68
|
-
initialPage: ComponentType<any>;
|
|
69
|
-
/** The props the server rendered the page with. */
|
|
70
|
-
pageProps: Record<string, any>;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
function pickChromeProps(props: Record<string, any>): Omit<AppShellProps, "active"> {
|
|
74
|
-
const { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav, branding, appearance } = props;
|
|
75
|
-
return { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav, branding, appearance };
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/** The anchor a click/pointer event is on or in, if it is a link. */
|
|
79
|
-
function linkOf(event: Event): HTMLAnchorElement | null {
|
|
80
|
-
const target = event.target;
|
|
81
|
-
return target instanceof Element ? target.closest("a[href]") : null;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
/** The URL of a link the router may take over, `null` for one the browser must handle itself. */
|
|
85
|
-
function routerUrlOf(link: HTMLAnchorElement): URL | null {
|
|
86
|
-
if ((link.target && link.target !== "_self") || link.hasAttribute("download") || link.hasAttribute("data-full-reload")) {
|
|
87
|
-
return null;
|
|
88
|
-
}
|
|
89
|
-
const url = new URL(link.href, window.location.href);
|
|
90
|
-
if (url.origin !== window.location.origin) {
|
|
91
|
-
return null;
|
|
92
|
-
}
|
|
93
|
-
// A link that only moves within the page (`#section`) is the browser's own.
|
|
94
|
-
if (url.hash !== "" && url.pathname === window.location.pathname && url.search === window.location.search) {
|
|
95
|
-
return null;
|
|
96
|
-
}
|
|
97
|
-
return url;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
export default function AppRouter({ routes, initialPath, initialPage, pageProps }: AppRouterProps) {
|
|
101
|
-
const [current, setCurrent] = useState<CurrentPage>(() => ({
|
|
102
|
-
Page: initialPage,
|
|
103
|
-
routePath: initialPath,
|
|
104
|
-
active: routes.find((route) => route.path === initialPath)?.active ?? "mail",
|
|
105
|
-
params: pageProps.params ?? {},
|
|
106
|
-
key: "initial",
|
|
107
|
-
}));
|
|
108
|
-
const [location, setLocation] = useState<RouterLocation>(UNKNOWN_LOCATION);
|
|
109
|
-
const [pending, setPending] = useState(false);
|
|
110
|
-
const [takeovers, setTakeovers] = useState(0);
|
|
111
|
-
|
|
112
|
-
const currentRef = useRef(current);
|
|
113
|
-
currentRef.current = current;
|
|
114
|
-
/** Identifies the latest navigation; one that finds it changed while loading has been overtaken and does nothing. */
|
|
115
|
-
const navigationRef = useRef(0);
|
|
116
|
-
/** The page components loaded or loading, by route template - one request per page however many links are touched. */
|
|
117
|
-
const pagesRef = useRef(new Map<string, Promise<ComponentType<any>>>([[initialPath, Promise.resolve(initialPage)]]));
|
|
118
|
-
const routesRef = useRef(routes);
|
|
119
|
-
routesRef.current = routes;
|
|
120
|
-
|
|
121
|
-
/** Loads a route's page component (once). Rejects if its code can't be loaded - and then a later attempt tries again. */
|
|
122
|
-
const pageFor = useCallback((route: RouteDefinition): Promise<ComponentType<any>> => {
|
|
123
|
-
let loading = pagesRef.current.get(route.path);
|
|
124
|
-
if (!loading) {
|
|
125
|
-
loading = route.load().then((module) => {
|
|
126
|
-
const page = (module.default as Partial<RoutedPageComponent>).page;
|
|
127
|
-
if (!page) {
|
|
128
|
-
throw new Error(`The page for ${route.path} is not a routedPage().`);
|
|
129
|
-
}
|
|
130
|
-
return page;
|
|
131
|
-
});
|
|
132
|
-
pagesRef.current.set(route.path, loading);
|
|
133
|
-
loading.catch(() => pagesRef.current.delete(route.path));
|
|
134
|
-
}
|
|
135
|
-
return loading;
|
|
136
|
-
}, []);
|
|
137
|
-
|
|
138
|
-
/** The pathname of the page on screen (the address bar's, once a navigation has been committed). */
|
|
139
|
-
const shownPathRef = useRef<string | null>(null);
|
|
140
|
-
|
|
141
|
-
/**
|
|
142
|
-
* Shows `match` (loading its page first if it is a different page from the one on screen), calling `commit` - which puts
|
|
143
|
-
* the URL in the address bar - at the moment the new page replaces the old one. Resolves `false` when the page's code
|
|
144
|
-
* couldn't be loaded, and `true` otherwise, including when a newer navigation overtook this one while it loaded.
|
|
145
|
-
*/
|
|
146
|
-
const show = useCallback(
|
|
147
|
-
async (match: RouteMatch, target: RouterLocation, sequence: number, commit: () => void): Promise<boolean> => {
|
|
148
|
-
const pathChanged = target.pathname !== shownPathRef.current;
|
|
149
|
-
let Page = currentRef.current.Page;
|
|
150
|
-
if (pathChanged && match.route.path !== currentRef.current.routePath) {
|
|
151
|
-
try {
|
|
152
|
-
Page = await pageFor(match.route);
|
|
153
|
-
} catch {
|
|
154
|
-
return false;
|
|
155
|
-
}
|
|
156
|
-
}
|
|
157
|
-
if (sequence !== navigationRef.current) {
|
|
158
|
-
return true;
|
|
159
|
-
}
|
|
160
|
-
commit();
|
|
161
|
-
shownPathRef.current = target.pathname;
|
|
162
|
-
if (pathChanged) {
|
|
163
|
-
setCurrent({ Page, routePath: match.route.path, active: match.route.active, params: match.params, key: target.pathname });
|
|
164
|
-
}
|
|
165
|
-
setLocation(target);
|
|
166
|
-
return true;
|
|
167
|
-
},
|
|
168
|
-
[pageFor],
|
|
169
|
-
);
|
|
170
|
-
|
|
171
|
-
const navigate = useCallback<NavigateFn>(
|
|
172
|
-
(href, options = {}) => {
|
|
173
|
-
const url = new URL(href, window.location.href);
|
|
174
|
-
const leave = () => (options.replace ? window.location.replace(url.href) : (window.location.href = url.href));
|
|
175
|
-
const match = url.origin === window.location.origin ? matchRoute(routesRef.current, url.pathname) : undefined;
|
|
176
|
-
if (!match) {
|
|
177
|
-
leave();
|
|
178
|
-
return;
|
|
179
|
-
}
|
|
180
|
-
const target: RouterLocation = { pathname: url.pathname, search: url.search, hash: url.hash };
|
|
181
|
-
const now = readWindowLocation();
|
|
182
|
-
if (target.pathname === now.pathname && target.search === now.search && target.hash === now.hash) {
|
|
183
|
-
return;
|
|
184
|
-
}
|
|
185
|
-
const sequence = ++navigationRef.current;
|
|
186
|
-
setPending(true);
|
|
187
|
-
void show(match, target, sequence, () => {
|
|
188
|
-
window.history[options.replace ? "replaceState" : "pushState"](null, "", target.pathname + target.search + target.hash);
|
|
189
|
-
}).then((ok) => {
|
|
190
|
-
if (!ok) {
|
|
191
|
-
leave();
|
|
192
|
-
}
|
|
193
|
-
if (sequence === navigationRef.current) {
|
|
194
|
-
setPending(false);
|
|
195
|
-
}
|
|
196
|
-
});
|
|
197
|
-
},
|
|
198
|
-
[show],
|
|
199
|
-
);
|
|
200
|
-
|
|
201
|
-
// The browser's own location is read after the first render, never during it: the server can't know the query string.
|
|
202
|
-
useEffect(() => {
|
|
203
|
-
const here = readWindowLocation();
|
|
204
|
-
shownPathRef.current = here.pathname;
|
|
205
|
-
setLocation(here);
|
|
206
|
-
}, []);
|
|
207
|
-
|
|
208
|
-
// Back and forward.
|
|
209
|
-
useEffect(() => {
|
|
210
|
-
function handlePopState() {
|
|
211
|
-
const here = readWindowLocation();
|
|
212
|
-
const match = matchRoute(routesRef.current, here.pathname);
|
|
213
|
-
if (!match) {
|
|
214
|
-
window.location.reload();
|
|
215
|
-
return;
|
|
216
|
-
}
|
|
217
|
-
const sequence = ++navigationRef.current;
|
|
218
|
-
setPending(true);
|
|
219
|
-
void show(match, here, sequence, () => undefined).then((ok) => {
|
|
220
|
-
if (!ok) {
|
|
221
|
-
window.location.reload();
|
|
222
|
-
}
|
|
223
|
-
if (sequence === navigationRef.current) {
|
|
224
|
-
setPending(false);
|
|
225
|
-
}
|
|
226
|
-
});
|
|
227
|
-
}
|
|
228
|
-
window.addEventListener("popstate", handlePopState);
|
|
229
|
-
return () => window.removeEventListener("popstate", handlePopState);
|
|
230
|
-
}, [show]);
|
|
231
|
-
|
|
232
|
-
// Plain links, and fetching what they lead to before they are clicked.
|
|
233
|
-
useEffect(() => {
|
|
234
|
-
function handleClick(event: MouseEvent) {
|
|
235
|
-
if (event.defaultPrevented || event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) {
|
|
236
|
-
return;
|
|
237
|
-
}
|
|
238
|
-
const link = linkOf(event);
|
|
239
|
-
const url = link && routerUrlOf(link);
|
|
240
|
-
if (!url || !matchRoute(routesRef.current, url.pathname)) {
|
|
241
|
-
return;
|
|
242
|
-
}
|
|
243
|
-
event.preventDefault();
|
|
244
|
-
navigate(url.pathname + url.search + url.hash);
|
|
245
|
-
}
|
|
246
|
-
function handleIntent(event: Event) {
|
|
247
|
-
const link = linkOf(event);
|
|
248
|
-
const url = link && routerUrlOf(link);
|
|
249
|
-
const match = url && matchRoute(routesRef.current, url.pathname);
|
|
250
|
-
if (match) {
|
|
251
|
-
pageFor(match.route).catch(() => undefined);
|
|
252
|
-
}
|
|
253
|
-
}
|
|
254
|
-
document.addEventListener("click", handleClick);
|
|
255
|
-
document.addEventListener("pointerover", handleIntent);
|
|
256
|
-
document.addEventListener("pointerdown", handleIntent);
|
|
257
|
-
document.addEventListener("focusin", handleIntent);
|
|
258
|
-
return () => {
|
|
259
|
-
document.removeEventListener("click", handleClick);
|
|
260
|
-
document.removeEventListener("pointerover", handleIntent);
|
|
261
|
-
document.removeEventListener("pointerdown", handleIntent);
|
|
262
|
-
document.removeEventListener("focusin", handleIntent);
|
|
263
|
-
};
|
|
264
|
-
}, [navigate, pageFor]);
|
|
265
|
-
|
|
266
|
-
// The app rail's other pages, once the browser has nothing else to do - so that the likeliest next click is instant.
|
|
267
|
-
useEffect(() => {
|
|
268
|
-
if (shouldSaveData()) {
|
|
269
|
-
return;
|
|
270
|
-
}
|
|
271
|
-
const cancels = routesRef.current
|
|
272
|
-
.filter((route) => route.idlePrefetch)
|
|
273
|
-
.map((route) => whenIdle(() => void pageFor(route).catch(() => undefined)));
|
|
274
|
-
return () => cancels.forEach((cancel) => cancel());
|
|
275
|
-
}, [pageFor]);
|
|
276
|
-
|
|
277
|
-
const enterTakeover = useCallback(() => {
|
|
278
|
-
setTakeovers((n) => n + 1);
|
|
279
|
-
return () => setTakeovers((n) => n - 1);
|
|
280
|
-
}, []);
|
|
281
|
-
const frame = useMemo<AppFrameContextValue>(() => ({ enterTakeover }), [enterTakeover]);
|
|
282
|
-
const router = useMemo<RouterContextValue>(() => ({ location, navigate }), [location, navigate]);
|
|
283
|
-
|
|
284
|
-
const Page = current.Page;
|
|
285
|
-
return (
|
|
286
|
-
<RouterContext.Provider value={router}>
|
|
287
|
-
<AppFrameContext.Provider value={frame}>
|
|
288
|
-
<AppChrome
|
|
289
|
-
active={current.active}
|
|
290
|
-
routeKey={current.key}
|
|
291
|
-
busy={pending}
|
|
292
|
-
hideChrome={takeovers > 0}
|
|
293
|
-
{...pickChromeProps(pageProps)}
|
|
294
|
-
>
|
|
295
|
-
<Page key={current.key} {...pageProps} params={current.params} />
|
|
296
|
-
</AppChrome>
|
|
297
|
-
</AppFrameContext.Provider>
|
|
298
|
-
</RouterContext.Provider>
|
|
299
|
-
);
|
|
300
|
-
}
|
|
1
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
2
|
+
// Copyright (C) 2026 Jean-Philippe Steinmetz
|
|
3
|
+
// SPDX-License-Identifier: MPL-2.0
|
|
4
|
+
///////////////////////////////////////////////////////////////////////////////
|
|
5
|
+
/**
|
|
6
|
+
* The web client's client-side router: what lets Mail, Calendar, Contacts, Tasks and Settings replace one another - and a
|
|
7
|
+
* folder replace a folder - without a page load.
|
|
8
|
+
*
|
|
9
|
+
* `@rapidrest/react` has no router of its own: every page is a server-rendered document with its own hydration entry, and
|
|
10
|
+
* hydrates only the page component (never `_layout.tsx`). So the router is a component the pages render themselves - each
|
|
11
|
+
* page's default export is `routedPage(path, Page)` (see `apps/www/_routedPage.tsx`), which renders `AppRouter` with the page
|
|
12
|
+
* as its first content. The first load is unchanged: the server renders the same tree, the browser hydrates it.
|
|
13
|
+
*
|
|
14
|
+
* `AppRouter` keeps ONE `AppChrome` (the icon rail, header, user menu, impersonation banner, compose windows, unlock prompt,
|
|
15
|
+
* idle-key timer, sign-out listener) mounted and swaps only what is inside it. A page's own shell (`MailShell`,
|
|
16
|
+
* `CalendarShell`, ...) still renders `AppShell` as it always did; inside the frame that renders nothing but its children.
|
|
17
|
+
*
|
|
18
|
+
* Navigation:
|
|
19
|
+
*
|
|
20
|
+
* Every `<a href>` to a same-origin path in the route table is intercepted (plain left clicks only - not with a modifier key, not
|
|
21
|
+
* `target`/`download`, not a hash-only link, not one marked `data-full-reload`), so pages just write ordinary links and
|
|
22
|
+
* middle-click, "open in new tab" and copy-link keep working. Anything not in the table - the admin and escrow consoles, plugin
|
|
23
|
+
* pages, other sites - is left to the browser. `useNavigate()` does the same for code (`navigate("/contacts")`).
|
|
24
|
+
*
|
|
25
|
+
* Back and forward work (`popstate`), and the URL is always the real, shareable one (`?mailboxUid=&folderUid=` and all).
|
|
26
|
+
*
|
|
27
|
+
* A route's code is loaded (`route.load()`) before the URL and the page change, so the old page stays up meanwhile (the frame is
|
|
28
|
+
* `aria-busy`); a route that fails to load falls back to a real navigation, which also picks up a new deploy.
|
|
29
|
+
*
|
|
30
|
+
* The next page's code is fetched on hover, focus and pointer-down of a link to it, and for the app rail's pages when the browser
|
|
31
|
+
* is idle.
|
|
32
|
+
*
|
|
33
|
+
* After a page change the frame moves keyboard focus to the content region, scrolls to the top, sets `document.title` and
|
|
34
|
+
* announces the new page to screen readers.
|
|
35
|
+
*
|
|
36
|
+
* The props of every `apps/www` page are the same for all of them (`WwwRoute.fetchProps()`: the user, auth-server URL,
|
|
37
|
+
* branding, plugin navigation, impersonation) except `params`, which the router recomputes from the URL - so the props of the
|
|
38
|
+
* page that was loaded are what every later page gets.
|
|
39
|
+
*/
|
|
40
|
+
import React, { ComponentType, useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
41
|
+
import { AppChrome, type AppShellProps } from "../components/layout/AppShell.js";
|
|
42
|
+
import { AppFrameContext, AppFrameContextValue } from "./frameContext.js";
|
|
43
|
+
import { whenIdle, shouldSaveData } from "./idle.js";
|
|
44
|
+
import { RouteDefinition, RouteMatch, matchRoute } from "./routes.js";
|
|
45
|
+
import { NavigateFn, RouterContext, RouterContextValue, RouterLocation, UNKNOWN_LOCATION, readWindowLocation } from "./routerContext.js";
|
|
46
|
+
|
|
47
|
+
export { useLocation, useLocationSearch, useNavigate } from "./routerContext.js";
|
|
48
|
+
export type { NavigateFn, NavigateOptions, RouterLocation } from "./routerContext.js";
|
|
49
|
+
|
|
50
|
+
/** What `routedPage()` gives the router: the page component itself, without the router around it. */
|
|
51
|
+
export type RoutedPageComponent<P = any> = ComponentType<P> & { page: ComponentType<P> };
|
|
52
|
+
|
|
53
|
+
interface CurrentPage {
|
|
54
|
+
Page: ComponentType<any>;
|
|
55
|
+
/** The route template shown. */
|
|
56
|
+
routePath: string;
|
|
57
|
+
active: string;
|
|
58
|
+
params: Record<string, string>;
|
|
59
|
+
/** Changes with the pathname, so a different page (or the same page for a different `:uid`) mounts fresh, while a change
|
|
60
|
+
* of query string alone - a folder - keeps the page and its state. */
|
|
61
|
+
key: string;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface AppRouterProps {
|
|
65
|
+
routes: readonly RouteDefinition[];
|
|
66
|
+
/** The template of the route this document was rendered for. */
|
|
67
|
+
initialPath: string;
|
|
68
|
+
initialPage: ComponentType<any>;
|
|
69
|
+
/** The props the server rendered the page with. */
|
|
70
|
+
pageProps: Record<string, any>;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function pickChromeProps(props: Record<string, any>): Omit<AppShellProps, "active"> {
|
|
74
|
+
const { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav, branding, appearance } = props;
|
|
75
|
+
return { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav, branding, appearance };
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/** The anchor a click/pointer event is on or in, if it is a link. */
|
|
79
|
+
function linkOf(event: Event): HTMLAnchorElement | null {
|
|
80
|
+
const target = event.target;
|
|
81
|
+
return target instanceof Element ? target.closest("a[href]") : null;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** The URL of a link the router may take over, `null` for one the browser must handle itself. */
|
|
85
|
+
function routerUrlOf(link: HTMLAnchorElement): URL | null {
|
|
86
|
+
if ((link.target && link.target !== "_self") || link.hasAttribute("download") || link.hasAttribute("data-full-reload")) {
|
|
87
|
+
return null;
|
|
88
|
+
}
|
|
89
|
+
const url = new URL(link.href, window.location.href);
|
|
90
|
+
if (url.origin !== window.location.origin) {
|
|
91
|
+
return null;
|
|
92
|
+
}
|
|
93
|
+
// A link that only moves within the page (`#section`) is the browser's own.
|
|
94
|
+
if (url.hash !== "" && url.pathname === window.location.pathname && url.search === window.location.search) {
|
|
95
|
+
return null;
|
|
96
|
+
}
|
|
97
|
+
return url;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export default function AppRouter({ routes, initialPath, initialPage, pageProps }: AppRouterProps) {
|
|
101
|
+
const [current, setCurrent] = useState<CurrentPage>(() => ({
|
|
102
|
+
Page: initialPage,
|
|
103
|
+
routePath: initialPath,
|
|
104
|
+
active: routes.find((route) => route.path === initialPath)?.active ?? "mail",
|
|
105
|
+
params: pageProps.params ?? {},
|
|
106
|
+
key: "initial",
|
|
107
|
+
}));
|
|
108
|
+
const [location, setLocation] = useState<RouterLocation>(UNKNOWN_LOCATION);
|
|
109
|
+
const [pending, setPending] = useState(false);
|
|
110
|
+
const [takeovers, setTakeovers] = useState(0);
|
|
111
|
+
|
|
112
|
+
const currentRef = useRef(current);
|
|
113
|
+
currentRef.current = current;
|
|
114
|
+
/** Identifies the latest navigation; one that finds it changed while loading has been overtaken and does nothing. */
|
|
115
|
+
const navigationRef = useRef(0);
|
|
116
|
+
/** The page components loaded or loading, by route template - one request per page however many links are touched. */
|
|
117
|
+
const pagesRef = useRef(new Map<string, Promise<ComponentType<any>>>([[initialPath, Promise.resolve(initialPage)]]));
|
|
118
|
+
const routesRef = useRef(routes);
|
|
119
|
+
routesRef.current = routes;
|
|
120
|
+
|
|
121
|
+
/** Loads a route's page component (once). Rejects if its code can't be loaded - and then a later attempt tries again. */
|
|
122
|
+
const pageFor = useCallback((route: RouteDefinition): Promise<ComponentType<any>> => {
|
|
123
|
+
let loading = pagesRef.current.get(route.path);
|
|
124
|
+
if (!loading) {
|
|
125
|
+
loading = route.load().then((module) => {
|
|
126
|
+
const page = (module.default as Partial<RoutedPageComponent>).page;
|
|
127
|
+
if (!page) {
|
|
128
|
+
throw new Error(`The page for ${route.path} is not a routedPage().`);
|
|
129
|
+
}
|
|
130
|
+
return page;
|
|
131
|
+
});
|
|
132
|
+
pagesRef.current.set(route.path, loading);
|
|
133
|
+
loading.catch(() => pagesRef.current.delete(route.path));
|
|
134
|
+
}
|
|
135
|
+
return loading;
|
|
136
|
+
}, []);
|
|
137
|
+
|
|
138
|
+
/** The pathname of the page on screen (the address bar's, once a navigation has been committed). */
|
|
139
|
+
const shownPathRef = useRef<string | null>(null);
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Shows `match` (loading its page first if it is a different page from the one on screen), calling `commit` - which puts
|
|
143
|
+
* the URL in the address bar - at the moment the new page replaces the old one. Resolves `false` when the page's code
|
|
144
|
+
* couldn't be loaded, and `true` otherwise, including when a newer navigation overtook this one while it loaded.
|
|
145
|
+
*/
|
|
146
|
+
const show = useCallback(
|
|
147
|
+
async (match: RouteMatch, target: RouterLocation, sequence: number, commit: () => void): Promise<boolean> => {
|
|
148
|
+
const pathChanged = target.pathname !== shownPathRef.current;
|
|
149
|
+
let Page = currentRef.current.Page;
|
|
150
|
+
if (pathChanged && match.route.path !== currentRef.current.routePath) {
|
|
151
|
+
try {
|
|
152
|
+
Page = await pageFor(match.route);
|
|
153
|
+
} catch {
|
|
154
|
+
return false;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
if (sequence !== navigationRef.current) {
|
|
158
|
+
return true;
|
|
159
|
+
}
|
|
160
|
+
commit();
|
|
161
|
+
shownPathRef.current = target.pathname;
|
|
162
|
+
if (pathChanged) {
|
|
163
|
+
setCurrent({ Page, routePath: match.route.path, active: match.route.active, params: match.params, key: target.pathname });
|
|
164
|
+
}
|
|
165
|
+
setLocation(target);
|
|
166
|
+
return true;
|
|
167
|
+
},
|
|
168
|
+
[pageFor],
|
|
169
|
+
);
|
|
170
|
+
|
|
171
|
+
const navigate = useCallback<NavigateFn>(
|
|
172
|
+
(href, options = {}) => {
|
|
173
|
+
const url = new URL(href, window.location.href);
|
|
174
|
+
const leave = () => (options.replace ? window.location.replace(url.href) : (window.location.href = url.href));
|
|
175
|
+
const match = url.origin === window.location.origin ? matchRoute(routesRef.current, url.pathname) : undefined;
|
|
176
|
+
if (!match) {
|
|
177
|
+
leave();
|
|
178
|
+
return;
|
|
179
|
+
}
|
|
180
|
+
const target: RouterLocation = { pathname: url.pathname, search: url.search, hash: url.hash };
|
|
181
|
+
const now = readWindowLocation();
|
|
182
|
+
if (target.pathname === now.pathname && target.search === now.search && target.hash === now.hash) {
|
|
183
|
+
return;
|
|
184
|
+
}
|
|
185
|
+
const sequence = ++navigationRef.current;
|
|
186
|
+
setPending(true);
|
|
187
|
+
void show(match, target, sequence, () => {
|
|
188
|
+
window.history[options.replace ? "replaceState" : "pushState"](null, "", target.pathname + target.search + target.hash);
|
|
189
|
+
}).then((ok) => {
|
|
190
|
+
if (!ok) {
|
|
191
|
+
leave();
|
|
192
|
+
}
|
|
193
|
+
if (sequence === navigationRef.current) {
|
|
194
|
+
setPending(false);
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
},
|
|
198
|
+
[show],
|
|
199
|
+
);
|
|
200
|
+
|
|
201
|
+
// The browser's own location is read after the first render, never during it: the server can't know the query string.
|
|
202
|
+
useEffect(() => {
|
|
203
|
+
const here = readWindowLocation();
|
|
204
|
+
shownPathRef.current = here.pathname;
|
|
205
|
+
setLocation(here);
|
|
206
|
+
}, []);
|
|
207
|
+
|
|
208
|
+
// Back and forward.
|
|
209
|
+
useEffect(() => {
|
|
210
|
+
function handlePopState() {
|
|
211
|
+
const here = readWindowLocation();
|
|
212
|
+
const match = matchRoute(routesRef.current, here.pathname);
|
|
213
|
+
if (!match) {
|
|
214
|
+
window.location.reload();
|
|
215
|
+
return;
|
|
216
|
+
}
|
|
217
|
+
const sequence = ++navigationRef.current;
|
|
218
|
+
setPending(true);
|
|
219
|
+
void show(match, here, sequence, () => undefined).then((ok) => {
|
|
220
|
+
if (!ok) {
|
|
221
|
+
window.location.reload();
|
|
222
|
+
}
|
|
223
|
+
if (sequence === navigationRef.current) {
|
|
224
|
+
setPending(false);
|
|
225
|
+
}
|
|
226
|
+
});
|
|
227
|
+
}
|
|
228
|
+
window.addEventListener("popstate", handlePopState);
|
|
229
|
+
return () => window.removeEventListener("popstate", handlePopState);
|
|
230
|
+
}, [show]);
|
|
231
|
+
|
|
232
|
+
// Plain links, and fetching what they lead to before they are clicked.
|
|
233
|
+
useEffect(() => {
|
|
234
|
+
function handleClick(event: MouseEvent) {
|
|
235
|
+
if (event.defaultPrevented || event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) {
|
|
236
|
+
return;
|
|
237
|
+
}
|
|
238
|
+
const link = linkOf(event);
|
|
239
|
+
const url = link && routerUrlOf(link);
|
|
240
|
+
if (!url || !matchRoute(routesRef.current, url.pathname)) {
|
|
241
|
+
return;
|
|
242
|
+
}
|
|
243
|
+
event.preventDefault();
|
|
244
|
+
navigate(url.pathname + url.search + url.hash);
|
|
245
|
+
}
|
|
246
|
+
function handleIntent(event: Event) {
|
|
247
|
+
const link = linkOf(event);
|
|
248
|
+
const url = link && routerUrlOf(link);
|
|
249
|
+
const match = url && matchRoute(routesRef.current, url.pathname);
|
|
250
|
+
if (match) {
|
|
251
|
+
pageFor(match.route).catch(() => undefined);
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
document.addEventListener("click", handleClick);
|
|
255
|
+
document.addEventListener("pointerover", handleIntent);
|
|
256
|
+
document.addEventListener("pointerdown", handleIntent);
|
|
257
|
+
document.addEventListener("focusin", handleIntent);
|
|
258
|
+
return () => {
|
|
259
|
+
document.removeEventListener("click", handleClick);
|
|
260
|
+
document.removeEventListener("pointerover", handleIntent);
|
|
261
|
+
document.removeEventListener("pointerdown", handleIntent);
|
|
262
|
+
document.removeEventListener("focusin", handleIntent);
|
|
263
|
+
};
|
|
264
|
+
}, [navigate, pageFor]);
|
|
265
|
+
|
|
266
|
+
// The app rail's other pages, once the browser has nothing else to do - so that the likeliest next click is instant.
|
|
267
|
+
useEffect(() => {
|
|
268
|
+
if (shouldSaveData()) {
|
|
269
|
+
return;
|
|
270
|
+
}
|
|
271
|
+
const cancels = routesRef.current
|
|
272
|
+
.filter((route) => route.idlePrefetch)
|
|
273
|
+
.map((route) => whenIdle(() => void pageFor(route).catch(() => undefined)));
|
|
274
|
+
return () => cancels.forEach((cancel) => cancel());
|
|
275
|
+
}, [pageFor]);
|
|
276
|
+
|
|
277
|
+
const enterTakeover = useCallback(() => {
|
|
278
|
+
setTakeovers((n) => n + 1);
|
|
279
|
+
return () => setTakeovers((n) => n - 1);
|
|
280
|
+
}, []);
|
|
281
|
+
const frame = useMemo<AppFrameContextValue>(() => ({ enterTakeover }), [enterTakeover]);
|
|
282
|
+
const router = useMemo<RouterContextValue>(() => ({ location, navigate }), [location, navigate]);
|
|
283
|
+
|
|
284
|
+
const Page = current.Page;
|
|
285
|
+
return (
|
|
286
|
+
<RouterContext.Provider value={router}>
|
|
287
|
+
<AppFrameContext.Provider value={frame}>
|
|
288
|
+
<AppChrome
|
|
289
|
+
active={current.active}
|
|
290
|
+
routeKey={current.key}
|
|
291
|
+
busy={pending}
|
|
292
|
+
hideChrome={takeovers > 0}
|
|
293
|
+
{...pickChromeProps(pageProps)}
|
|
294
|
+
>
|
|
295
|
+
<Page key={current.key} {...pageProps} params={current.params} />
|
|
296
|
+
</AppChrome>
|
|
297
|
+
</AppFrameContext.Provider>
|
|
298
|
+
</RouterContext.Provider>
|
|
299
|
+
);
|
|
300
|
+
}
|