@rapidmx/web-client 0.9.0 → 0.10.0

package/apps/shared/mail/useMarkMessageRead.ts

@@ -0,0 +1,47 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { useEffect, useRef } from "react";
+import type { Message } from "@rapidmx/react-shared/mail/mailApi.js";
+import { useMailShell } from "../components/mail/layout/MailShell.js";
+import { setReadState } from "./messageReadState.js";
+
+/**
+ * Marks a message read when it is opened in a reading pane, through `setReadState()`: the row and the folder badge change at
+ * once. `onPatched` is handed each copy of the message as it changes (the optimistic one, then the server's, or the original
+ * again if the server refused).
+ *
+ * Replaces `@rapidmx/react-shared`'s `useMarkMessageRead`, which waits for the server before telling anyone and drops that
+ * answer if the message changes meanwhile - which the optimistic copy itself does. A message is asked for once each time it is
+ * opened: one the reader then marks unread stays unread while it is open, and one whose request failed is not retried in a loop
+ * (its own revert changes it again), only when it is opened again.
+ */
+export function useMarkMessageRead(message: Message | null, onPatched: (updated: Message, previous?: Message) => void): void {
+    const { trackMessageChange } = useMailShell();
+    const openUidRef = useRef<string | undefined>(undefined);
+    const requestedRef = useRef<Set<string>>(new Set());
+    const latestRef = useRef({ onPatched, trackMessageChange });
+    latestRef.current = { onPatched, trackMessageChange };
+
+    useEffect(() => {
+        if (message?.uid !== openUidRef.current) {
+            // Another message (or none) is open now: whatever was asked about the last one is over.
+            openUidRef.current = message?.uid;
+            requestedRef.current.clear();
+        }
+        if (!message || requestedRef.current.has(message.uid)) {
+            return;
+        }
+        // Every opening is asked about once - a message that is already read included, so that marking it unread while it is open (the
+        // keyboard's Ctrl+U) doesn't make this run again and read it straight back.
+        requestedRef.current.add(message.uid);
+        if (message.flags.read === true) {
+            return;
+        }
+        void setReadState(message, true, {
+            patch: (updated, previous) => latestRef.current.onPatched(updated, previous),
+            track: (previous, next) => latestRef.current.trackMessageChange(previous, next),
+        });
+    }, [message]);
+}

package/apps/shared/mail/useNewMailNotifications.ts

@@ -0,0 +1,163 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import type { Mailbox, Message } from "@rapidmx/react-shared/mail/mailApi.js";
+import type { MailboxFolders } from "../components/mail/layout/MailShell.js";
+import {
+    DesktopPermission,
+    NewMailNotice,
+    desktopPermission,
+    getDesktopOfferDismissed,
+    getNewMailPopupsEnabled,
+    noticeFor,
+    noticeSender,
+    ownAddressesOf,
+    requestDesktopPermission,
+    setDesktopOfferDismissed,
+    shouldAnnounce,
+} from "./newMailNotifications.js";
+
+/** The most pop-ups on screen at once; a new one pushes the oldest off. */
+export const MAX_TOASTS = 3;
+
+/** How long a pop-up stays before it goes by itself (while it is neither hovered nor focused, and the tab is in view). */
+export const TOAST_DURATION_MS = 8_000;
+
+/** At most this many desktop notifications in `DESKTOP_BURST_WINDOW_MS`: a flood of mail is a few notifications, not a hundred. */
+export const DESKTOP_BURST_LIMIT = 5;
+export const DESKTOP_BURST_WINDOW_MS = 30_000;
+
+/** How many announced message uids are remembered, so an event delivered twice is announced once. */
+const ANNOUNCED_LIMIT = 500;
+
+export interface NewMailNotifications {
+    /** The pop-ups on screen, oldest first. */
+    toasts: NewMailNotice[];
+    /** Takes one off the screen. */
+    dismiss(uid: string): void;
+    /** Whether the first pop-up should also offer to turn on desktop notifications: the browser can, has not been asked,
+     * and the user has not said "Not now". */
+    offerDesktop: boolean;
+    /** The offer's "Turn on desktop notifications": asks the browser. Must be called from a click. */
+    enableDesktop(): Promise<void>;
+    /** The offer's "Not now": remembered, so it is not made again. */
+    declineDesktop(): void;
+    /** Announces a message that just arrived - if it is worth it (see `shouldAnnounce()`) and pop-ups are on. Stable. */
+    announce(message: Message): void;
+}
+
+/** Whether the user is not looking at this tab: it is hidden, or another window has the focus. */
+function tabIsInBackground(): boolean {
+    return document.visibilityState === "hidden" || !document.hasFocus();
+}
+
+export interface UseNewMailNotificationsOptions {
+    mailboxes: Mailbox[];
+    mailboxFolders: MailboxFolders[];
+    /** Opens a message from a desktop notification's click. Defaults to a plain navigation. */
+    open?: (href: string) => void;
+}
+
+function defaultOpen(href: string): void {
+    window.location.href = href;
+}
+
+/**
+ * New-mail announcements: an in-app pop-up for each message that arrives (`MAX_TOASTS` at most on screen), and - while the tab
+ * is in the background and the user has allowed it - a desktop notification with the same content, one per message however
+ * many events name it. `announce()` is what `useMailLiveUpdates()`'s `onMessageCreated` calls; nothing else feeds it, so a
+ * page load, a list refetch and a reconnect never announce anything.
+ *
+ * Nothing is ever asked of the browser on load: permission is requested only by `enableDesktop()`, from the offer in the
+ * first pop-up, or from Settings. What the user answered is remembered in `localStorage` (see `newMailNotifications.ts`).
+ */
+export function useNewMailNotifications({ mailboxes, mailboxFolders, open = defaultOpen }: UseNewMailNotificationsOptions): NewMailNotifications {
+    const [toasts, setToasts] = useState<NewMailNotice[]>([]);
+    const [permission, setPermission] = useState<DesktopPermission>("unsupported");
+    const [offerDismissed, setOfferDismissed] = useState(true);
+    const folders = useMemo(() => mailboxFolders.flatMap((entry) => entry.folders), [mailboxFolders]);
+    const ownAddresses = useMemo(() => ownAddressesOf(mailboxes), [mailboxes]);
+    const latestRef = useRef({ folders, ownAddresses, open });
+    latestRef.current = { folders, ownAddresses, open };
+    const announcedRef = useRef<Set<string>>(new Set());
+    const desktopShownRef = useRef<number[]>([]);
+
+    // The browser's own state is only read on the client, after hydration, so the server and first client render agree.
+    useEffect(() => {
+        setPermission(desktopPermission());
+        setOfferDismissed(getDesktopOfferDismissed());
+    }, []);
+
+    const dismiss = useCallback((uid: string) => {
+        setToasts((previous) => previous.filter((toast) => toast.uid !== uid));
+    }, []);
+
+    const showDesktop = useCallback((notice: NewMailNotice) => {
+        const now = Date.now();
+        desktopShownRef.current = desktopShownRef.current.filter((at) => now - at < DESKTOP_BURST_WINDOW_MS);
+        if (desktopShownRef.current.length >= DESKTOP_BURST_LIMIT) {
+            return;
+        }
+        try {
+            const notification = new Notification(noticeSender(notice), {
+                body: [notice.subject, notice.preview].filter(Boolean).join("\n"),
+                // One per message: a duplicate (another tab of this app, a re-delivered event) replaces instead of stacking.
+                tag: notice.uid,
+            });
+            desktopShownRef.current.push(now);
+            notification.onclick = () => {
+                window.focus();
+                notification.close();
+                latestRef.current.open(notice.href);
+            };
+        } catch {
+            // Some browsers refuse `new Notification()` outright (a mobile one wanting a service worker): the pop-up is enough.
+        }
+    }, []);
+
+    const announce = useCallback(
+        (message: Message) => {
+            if (!getNewMailPopupsEnabled() || announcedRef.current.has(message.uid)) {
+                return;
+            }
+            const { folders: knownFolders, ownAddresses: own } = latestRef.current;
+            if (!shouldAnnounce(message, { folders: knownFolders, ownAddresses: own })) {
+                return;
+            }
+            announcedRef.current.add(message.uid);
+            if (announcedRef.current.size > ANNOUNCED_LIMIT) {
+                announcedRef.current.delete(announcedRef.current.values().next().value!);
+            }
+            const notice = noticeFor(message);
+            setToasts((previous) => [...previous.filter((toast) => toast.uid !== notice.uid), notice].slice(-MAX_TOASTS));
+            if (desktopPermission() === "granted" && tabIsInBackground()) {
+                showDesktop(notice);
+            }
+        },
+        [showDesktop],
+    );
+
+    const enableDesktop = useCallback(async () => {
+        const answer = await requestDesktopPermission();
+        setPermission(answer);
+        // Answered either way, so the offer goes: on granted it has done its job, on denied it can't be made again.
+        setDesktopOfferDismissed(true);
+        setOfferDismissed(true);
+    }, []);
+
+    const declineDesktop = useCallback(() => {
+        setDesktopOfferDismissed(true);
+        setOfferDismissed(true);
+    }, []);
+
+    return {
+        toasts,
+        dismiss,
+        offerDesktop: permission === "default" && !offerDismissed,
+        enableDesktop,
+        declineDesktop,
+        announce,
+    };
+}

package/apps/shared/mail/useUnreadTitle.ts

@@ -0,0 +1,42 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { useEffect } from "react";
+
+/** A count this hook put in front of the title, so it can be taken off again: `(3) `. */
+const TITLE_PREFIX = /^\(\d+\) /;
+
+/** `title` with `count` unread in front - `(3) Acme: Mail` - or as it is when there are none. */
+export function titleWithUnread(title: string, count: number): string {
+    const base = title.replace(TITLE_PREFIX, "");
+    return count > 0 ? `(${count > 99 ? "99+" : count}) ${base}` : base;
+}
+
+export interface UseUnreadTitleOptions {
+    /** Does nothing while false - for the one of two owners that isn't. Default true. */
+    enabled?: boolean;
+    /** Changes whenever something else has rewritten the title (the app frame sets it on every page change), so the count is put in front of
+     * the new one. */
+    resetKey?: unknown;
+}
+
+/**
+ * Keeps the browser tab's title in step with the unread count, as Outlook on the web does - `(3) Acme: Mail` - so mail that
+ * arrives while the tab is in the background can be seen from the tab strip. The count is put in front of whatever the title is
+ * (the page sets its own, from the branding) and taken off again when it drops to zero or the component goes away.
+ *
+ * Order matters when the same component also sets the title: declare this hook after the effect that does, so that on a change of `resetKey`
+ * the count is taken off the old title, the new title is written, and the count goes back in front of it.
+ */
+export function useUnreadTitle(count: number, { enabled = true, resetKey }: UseUnreadTitleOptions = {}): void {
+    useEffect(() => {
+        if (!enabled) {
+            return;
+        }
+        document.title = titleWithUnread(document.title, count);
+        return () => {
+            document.title = titleWithUnread(document.title, 0);
+        };
+    }, [count, enabled, resetKey]);
+}

package/apps/shared/navigation/AppRouter.tsx

@@ -0,0 +1,300 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * The web client's client-side router: what lets Mail, Calendar, Contacts, Tasks and Settings replace one another - and a
+ * folder replace a folder - without a page load.
+ *
+ * `@rapidrest/react` has no router of its own: every page is a server-rendered document with its own hydration entry, and
+ * hydrates only the page component (never `_layout.tsx`). So the router is a component the pages render themselves - each
+ * page's default export is `routedPage(path, Page)` (see `apps/www/_routedPage.tsx`), which renders `AppRouter` with the page
+ * as its first content. The first load is unchanged: the server renders the same tree, the browser hydrates it.
+ *
+ * `AppRouter` keeps ONE `AppChrome` (the icon rail, header, user menu, impersonation banner, compose windows, unlock prompt,
+ * idle-key timer, sign-out listener) mounted and swaps only what is inside it. A page's own shell (`MailShell`,
+ * `CalendarShell`, ...) still renders `AppShell` as it always did; inside the frame that renders nothing but its children.
+ *
+ * Navigation:
+ *
+ * Every `<a href>` to a same-origin path in the route table is intercepted (plain left clicks only - not with a modifier key, not
+ * `target`/`download`, not a hash-only link, not one marked `data-full-reload`), so pages just write ordinary links and
+ * middle-click, "open in new tab" and copy-link keep working. Anything not in the table - the admin and escrow consoles, plugin
+ * pages, other sites - is left to the browser. `useNavigate()` does the same for code (`navigate("/contacts")`).
+ *
+ * Back and forward work (`popstate`), and the URL is always the real, shareable one (`?mailboxUid=&folderUid=` and all).
+ *
+ * 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
+ * `aria-busy`); a route that fails to load falls back to a real navigation, which also picks up a new deploy.
+ *
+ * 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
+ * is idle.
+ *
+ * After a page change the frame moves keyboard focus to the content region, scrolls to the top, sets `document.title` and
+ * announces the new page to screen readers.
+ *
+ * The props of every `apps/www` page are the same for all of them (`WwwRoute.fetchProps()`: the user, auth-server URL,
+ * branding, plugin navigation, impersonation) except `params`, which the router recomputes from the URL - so the props of the
+ * page that was loaded are what every later page gets.
+ */
+import React, { ComponentType, useCallback, useEffect, useMemo, useRef, useState } from "react";
+import { AppChrome, type AppShellProps } from "../components/layout/AppShell.js";
+import { AppFrameContext, AppFrameContextValue } from "./frameContext.js";
+import { whenIdle, shouldSaveData } from "./idle.js";
+import { RouteDefinition, RouteMatch, matchRoute } from "./routes.js";
+import { NavigateFn, RouterContext, RouterContextValue, RouterLocation, UNKNOWN_LOCATION, readWindowLocation } from "./routerContext.js";
+
+export { useLocation, useLocationSearch, useNavigate } from "./routerContext.js";
+export type { NavigateFn, NavigateOptions, RouterLocation } from "./routerContext.js";
+
+/** What `routedPage()` gives the router: the page component itself, without the router around it. */
+export type RoutedPageComponent<P = any> = ComponentType<P> & { page: ComponentType<P> };
+
+interface CurrentPage {
+    Page: ComponentType<any>;
+    /** The route template shown. */
+    routePath: string;
+    active: string;
+    params: Record<string, string>;
+    /** Changes with the pathname, so a different page (or the same page for a different `:uid`) mounts fresh, while a change
+     * of query string alone - a folder - keeps the page and its state. */
+    key: string;
+}
+
+export interface AppRouterProps {
+    routes: readonly RouteDefinition[];
+    /** The template of the route this document was rendered for. */
+    initialPath: string;
+    initialPage: ComponentType<any>;
+    /** The props the server rendered the page with. */
+    pageProps: Record<string, any>;
+}
+
+function pickChromeProps(props: Record<string, any>): Omit<AppShellProps, "active"> {
+    const { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav } = props;
+    return { userUid, authServerUrl, impersonating, impersonationBaseUrl, trusted, trustedRoles, pluginNav };
+}
+
+/** The anchor a click/pointer event is on or in, if it is a link. */
+function linkOf(event: Event): HTMLAnchorElement | null {
+    const target = event.target;
+    return target instanceof Element ? target.closest("a[href]") : null;
+}
+
+/** The URL of a link the router may take over, `null` for one the browser must handle itself. */
+function routerUrlOf(link: HTMLAnchorElement): URL | null {
+    if ((link.target && link.target !== "_self") || link.hasAttribute("download") || link.hasAttribute("data-full-reload")) {
+        return null;
+    }
+    const url = new URL(link.href, window.location.href);
+    if (url.origin !== window.location.origin) {
+        return null;
+    }
+    // A link that only moves within the page (`#section`) is the browser's own.
+    if (url.hash !== "" && url.pathname === window.location.pathname && url.search === window.location.search) {
+        return null;
+    }
+    return url;
+}
+
+export default function AppRouter({ routes, initialPath, initialPage, pageProps }: AppRouterProps) {
+    const [current, setCurrent] = useState<CurrentPage>(() => ({
+        Page: initialPage,
+        routePath: initialPath,
+        active: routes.find((route) => route.path === initialPath)?.active ?? "mail",
+        params: pageProps.params ?? {},
+        key: "initial",
+    }));
+    const [location, setLocation] = useState<RouterLocation>(UNKNOWN_LOCATION);
+    const [pending, setPending] = useState(false);
+    const [takeovers, setTakeovers] = useState(0);
+
+    const currentRef = useRef(current);
+    currentRef.current = current;
+    /** Identifies the latest navigation; one that finds it changed while loading has been overtaken and does nothing. */
+    const navigationRef = useRef(0);
+    /** The page components loaded or loading, by route template - one request per page however many links are touched. */
+    const pagesRef = useRef(new Map<string, Promise<ComponentType<any>>>([[initialPath, Promise.resolve(initialPage)]]));
+    const routesRef = useRef(routes);
+    routesRef.current = routes;
+
+    /** Loads a route's page component (once). Rejects if its code can't be loaded - and then a later attempt tries again. */
+    const pageFor = useCallback((route: RouteDefinition): Promise<ComponentType<any>> => {
+        let loading = pagesRef.current.get(route.path);
+        if (!loading) {
+            loading = route.load().then((module) => {
+                const page = (module.default as Partial<RoutedPageComponent>).page;
+                if (!page) {
+                    throw new Error(`The page for ${route.path} is not a routedPage().`);
+                }
+                return page;
+            });
+            pagesRef.current.set(route.path, loading);
+            loading.catch(() => pagesRef.current.delete(route.path));
+        }
+        return loading;
+    }, []);
+
+    /** The pathname of the page on screen (the address bar's, once a navigation has been committed). */
+    const shownPathRef = useRef<string | null>(null);
+
+    /**
+     * Shows `match` (loading its page first if it is a different page from the one on screen), calling `commit` - which puts
+     * the URL in the address bar - at the moment the new page replaces the old one. Resolves `false` when the page's code
+     * couldn't be loaded, and `true` otherwise, including when a newer navigation overtook this one while it loaded.
+     */
+    const show = useCallback(
+        async (match: RouteMatch, target: RouterLocation, sequence: number, commit: () => void): Promise<boolean> => {
+            const pathChanged = target.pathname !== shownPathRef.current;
+            let Page = currentRef.current.Page;
+            if (pathChanged && match.route.path !== currentRef.current.routePath) {
+                try {
+                    Page = await pageFor(match.route);
+                } catch {
+                    return false;
+                }
+            }
+            if (sequence !== navigationRef.current) {
+                return true;
+            }
+            commit();
+            shownPathRef.current = target.pathname;
+            if (pathChanged) {
+                setCurrent({ Page, routePath: match.route.path, active: match.route.active, params: match.params, key: target.pathname });
+            }
+            setLocation(target);
+            return true;
+        },
+        [pageFor],
+    );
+
+    const navigate = useCallback<NavigateFn>(
+        (href, options = {}) => {
+            const url = new URL(href, window.location.href);
+            const leave = () => (options.replace ? window.location.replace(url.href) : (window.location.href = url.href));
+            const match = url.origin === window.location.origin ? matchRoute(routesRef.current, url.pathname) : undefined;
+            if (!match) {
+                leave();
+                return;
+            }
+            const target: RouterLocation = { pathname: url.pathname, search: url.search, hash: url.hash };
+            const now = readWindowLocation();
+            if (target.pathname === now.pathname && target.search === now.search && target.hash === now.hash) {
+                return;
+            }
+            const sequence = ++navigationRef.current;
+            setPending(true);
+            void show(match, target, sequence, () => {
+                window.history[options.replace ? "replaceState" : "pushState"](null, "", target.pathname + target.search + target.hash);
+            }).then((ok) => {
+                if (!ok) {
+                    leave();
+                }
+                if (sequence === navigationRef.current) {
+                    setPending(false);
+                }
+            });
+        },
+        [show],
+    );
+
+    // The browser's own location is read after the first render, never during it: the server can't know the query string.
+    useEffect(() => {
+        const here = readWindowLocation();
+        shownPathRef.current = here.pathname;
+        setLocation(here);
+    }, []);
+
+    // Back and forward.
+    useEffect(() => {
+        function handlePopState() {
+            const here = readWindowLocation();
+            const match = matchRoute(routesRef.current, here.pathname);
+            if (!match) {
+                window.location.reload();
+                return;
+            }
+            const sequence = ++navigationRef.current;
+            setPending(true);
+            void show(match, here, sequence, () => undefined).then((ok) => {
+                if (!ok) {
+                    window.location.reload();
+                }
+                if (sequence === navigationRef.current) {
+                    setPending(false);
+                }
+            });
+        }
+        window.addEventListener("popstate", handlePopState);
+        return () => window.removeEventListener("popstate", handlePopState);
+    }, [show]);
+
+    // Plain links, and fetching what they lead to before they are clicked.
+    useEffect(() => {
+        function handleClick(event: MouseEvent) {
+            if (event.defaultPrevented || event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) {
+                return;
+            }
+            const link = linkOf(event);
+            const url = link && routerUrlOf(link);
+            if (!url || !matchRoute(routesRef.current, url.pathname)) {
+                return;
+            }
+            event.preventDefault();
+            navigate(url.pathname + url.search + url.hash);
+        }
+        function handleIntent(event: Event) {
+            const link = linkOf(event);
+            const url = link && routerUrlOf(link);
+            const match = url && matchRoute(routesRef.current, url.pathname);
+            if (match) {
+                pageFor(match.route).catch(() => undefined);
+            }
+        }
+        document.addEventListener("click", handleClick);
+        document.addEventListener("pointerover", handleIntent);
+        document.addEventListener("pointerdown", handleIntent);
+        document.addEventListener("focusin", handleIntent);
+        return () => {
+            document.removeEventListener("click", handleClick);
+            document.removeEventListener("pointerover", handleIntent);
+            document.removeEventListener("pointerdown", handleIntent);
+            document.removeEventListener("focusin", handleIntent);
+        };
+    }, [navigate, pageFor]);
+
+    // The app rail's other pages, once the browser has nothing else to do - so that the likeliest next click is instant.
+    useEffect(() => {
+        if (shouldSaveData()) {
+            return;
+        }
+        const cancels = routesRef.current
+            .filter((route) => route.idlePrefetch)
+            .map((route) => whenIdle(() => void pageFor(route).catch(() => undefined)));
+        return () => cancels.forEach((cancel) => cancel());
+    }, [pageFor]);
+
+    const enterTakeover = useCallback(() => {
+        setTakeovers((n) => n + 1);
+        return () => setTakeovers((n) => n - 1);
+    }, []);
+    const frame = useMemo<AppFrameContextValue>(() => ({ enterTakeover }), [enterTakeover]);
+    const router = useMemo<RouterContextValue>(() => ({ location, navigate }), [location, navigate]);
+
+    const Page = current.Page;
+    return (
+        <RouterContext.Provider value={router}>
+            <AppFrameContext.Provider value={frame}>
+                <AppChrome
+                    active={current.active}
+                    routeKey={current.key}
+                    busy={pending}
+                    hideChrome={takeovers > 0}
+                    {...pickChromeProps(pageProps)}
+                >
+                    <Page key={current.key} {...pageProps} params={current.params} />
+                </AppChrome>
+            </AppFrameContext.Provider>
+        </RouterContext.Provider>
+    );
+}

package/apps/shared/navigation/appHrefs.ts

@@ -0,0 +1,23 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+
+/** Where each of the four rail apps lives - what the icon rail links to and what the keyboard's "Go to ..." shortcuts navigate to. */
+export const APP_HREFS = {
+    mail: "/",
+    calendar: "/calendar",
+    contacts: "/contacts",
+    tasks: "/tasks",
+} as const;
+
+/**
+ * Settings is reached from the account menu, not the rail. It links straight to the first settings section, the only one that always
+ * exists - repoint this at a real `/settings` landing page once there is one.
+ */
+export const SETTINGS_HREF = "/settings/auto-reply";
+
+/** Whether `pathname` is a page of Settings (any section), which is what "already there" means for it. */
+export function isSettingsPath(pathname: string): boolean {
+    return pathname === "/settings" || pathname.startsWith("/settings/");
+}

package/apps/shared/navigation/frameContext.tsx

@@ -0,0 +1,35 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import React, { PropsWithChildren, createContext, useContext, useLayoutEffect } from "react";
+
+/**
+ * What the persistent app frame (`AppRouter`'s one mounted `AppShell` chrome) offers to what is rendered inside it. `null`
+ * outside a frame - a page not shown by the router (an admin page, a plugin page, a test) renders its own chrome.
+ */
+export interface AppFrameContextValue {
+    /** Hides the frame's chrome (icon rail, header, footer) until the returned function is called - see `FrameTakeover`. */
+    enterTakeover: () => () => void;
+}
+
+export const AppFrameContext = createContext<AppFrameContextValue | null>(null);
+
+/** `true` inside the persistent app frame. */
+export function useInAppFrame(): boolean {
+    return useContext(AppFrameContext) !== null;
+}
+
+/**
+ * Wraps a screen that takes over the whole window - first-time key setup, "your mailbox is being set up" - which used to
+ * replace the page's shell entirely. Inside the persistent frame the shell can't be replaced (it stays mounted), so the frame
+ * hides its chrome for as long as this is mounted instead (and gives the screen the full width); outside a frame it renders its children as they are. A layout effect, so the chrome
+ * is gone before the screen is first painted.
+ */
+export function FrameTakeover({ children }: PropsWithChildren) {
+    const frame = useContext(AppFrameContext);
+    useLayoutEffect(() => frame?.enterTakeover(), [frame]);
+    // The frame puts a page in `#app-content`, a flex row: a full-window screen there would shrink to its content and sit at the left
+    // edge instead of centring, so inside the frame it is given the whole row, as a block its own root fills.
+    return frame ? <div className="flex-1 min-w-0">{children}</div> : <>{children}</>;
+}

package/apps/shared/navigation/idle.ts

@@ -0,0 +1,45 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+
+/** How long an idle callback may be held back on a busy page before it runs anyway. */
+export const IDLE_TIMEOUT_MS = 3_000;
+
+/** The delay used where the browser has no `requestIdleCallback` (Safari). */
+export const IDLE_FALLBACK_DELAY_MS = 200;
+
+/**
+ * Runs `callback` once the page has finished loading (the window `load` event, which waits for every script and image the page
+ * asked for) and the browser has nothing better to do (`requestIdleCallback`), or shortly after where there is no such thing.
+ * For work that only makes later things faster - fetching a code chunk, warming a cache - and must never compete with what
+ * the user is waiting for. Returns a function that cancels it if it hasn't run yet.
+ */
+export function whenIdle(callback: () => void): () => void {
+    let cancelIdle: () => void = () => undefined;
+    function schedule() {
+        if (typeof window.requestIdleCallback === "function") {
+            const handle = window.requestIdleCallback(callback, { timeout: IDLE_TIMEOUT_MS });
+            cancelIdle = () => window.cancelIdleCallback(handle);
+        } else {
+            const timer = setTimeout(callback, IDLE_FALLBACK_DELAY_MS);
+            cancelIdle = () => clearTimeout(timer);
+        }
+    }
+    if (document.readyState === "complete") {
+        schedule();
+    } else {
+        window.addEventListener("load", schedule, { once: true });
+    }
+    return () => {
+        window.removeEventListener("load", schedule);
+        cancelIdle();
+    };
+}
+
+/** `true` when the user has asked the browser to save data (or is on a very slow connection): work that only speculates
+ * about what will be needed - prefetching - should not run then. */
+export function shouldSaveData(): boolean {
+    const connection = (navigator as Navigator & { connection?: { saveData?: boolean; effectiveType?: string } }).connection;
+    return connection?.saveData === true || connection?.effectiveType === "slow-2g" || connection?.effectiveType === "2g";
+}