@rapidmx/web-client 0.15.1 → 0.17.0

package/dist/apps/shared/navigation/routerContext.js

@@ -1,56 +0,0 @@
-///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2026 Jean-Philippe Steinmetz
-// SPDX-License-Identifier: MPL-2.0
-///////////////////////////////////////////////////////////////////////////////
-/**
- * What the client-side router (`AppRouter.tsx`) offers to the tree under it - the location and a way to navigate - and the hooks that read
- * it. Kept apart from the router itself so that the app frame (`AppShell`), which the router renders, can use `useNavigate()` without a
- * circular import. `AppRouter.tsx` re-exports everything here, so callers keep importing from there.
- */
-import { createContext, useContext, useEffect, useState } from "react";
-export const RouterContext = createContext(null);
-/** Before the browser's own location has been read (the server render and the first client render, which must match). */
-export const UNKNOWN_LOCATION = { pathname: "", search: "", hash: "" };
-export function readWindowLocation() {
-    const { pathname, search, hash } = window.location;
-    return { pathname, search, hash };
-}
-/** What `useNavigate()` does outside a router: an ordinary navigation, exactly as `window.location.href = href` always was. */
-function navigateWithBrowser(href, options = {}) {
-    if (options.replace) {
-        window.location.replace(href);
-    }
-    else {
-        window.location.href = href;
-    }
-}
-/**
- * The function to go somewhere with. `navigate("/calendar")` and `navigate("/?mailboxUid=a&folderUid=b")` change the page and
- * the URL without a page load when the router knows the route (Mail, Calendar, Contacts, Tasks, Settings and their subpages),
- * and load the page normally otherwise; outside the router it is always a normal navigation. Prefer a plain `<a href>` for
- * anything the user clicks - the router intercepts it, and it stays a real link - and this for what code decides (after a
- * save, a delete, a select). The returned function is stable across renders.
- */
-export function useNavigate() {
-    const router = useContext(RouterContext);
-    return router ? router.navigate : navigateWithBrowser;
-}
-/**
- * Where the app is now, as `{ pathname, search, hash }`, updating as the router navigates (folder changes are `search`
- * changes, not page changes). Empty until the browser's location has been read in an effect after the first render, so that
- * the server render and the first client render agree - read query parameters from it in an effect, not during render.
- */
-export function useLocation() {
-    const router = useContext(RouterContext);
-    const [own, setOwn] = useState(UNKNOWN_LOCATION);
-    useEffect(() => {
-        if (!router) {
-            setOwn(readWindowLocation());
-        }
-    }, [router]);
-    return router ? router.location : own;
-}
-/** `useLocation().search` - what the shells read `?mailboxUid=` and the like from. */
-export function useLocationSearch() {
-    return useLocation().search;
-}

package/dist/apps/shared/navigation/routes.d.ts

@@ -1,32 +0,0 @@
-import type { ComponentType } from "react";
-/**
- * One page the client-side router (`AppRouter`) can show without a page load. The table of them (`apps/www/_routes.ts`)
- * mirrors the files under `apps/www`: what isn't in it (the admin and escrow consoles, plugin pages, anything else) is
- * reached by a normal navigation.
- */
-export interface RouteDefinition {
-    /** The route template: literal segments and `:name` parameters, the same shape as the file path (`/messages/:uid`
-     * for `messages/[uid].tsx`). The first entry that matches a URL wins, so list literal routes before parameterized
-     * ones (`/settings/filters/new` before `/settings/filters/:uid`). */
-    path: string;
-    /** The app-rail entry (or `"settings"`) highlighted while this page shows - what the page's shell passes as `active`. */
-    active: string;
-    /**
-     * Loads the page's module, which must have a `routedPage()` component as its default export. Written as
-     * `() => import("./calendar/index.js")` so the bundler makes the page its own chunk; it is called the first time the
-     * page is shown or prefetched (pointer over or focus on a link to it, or when the browser is idle).
-     */
-    load: () => Promise<{
-        default: ComponentType<any>;
-    }>;
-    /** Downloaded when the browser is idle after the first page has loaded - the app rail's own pages, which are the
-     * likeliest next click. */
-    idlePrefetch?: boolean;
-}
-export interface RouteMatch {
-    route: RouteDefinition;
-    /** The values of the template's `:name` segments, decoded. */
-    params: Record<string, string>;
-}
-/** The first route in `routes` whose template matches `pathname`, with its parameters. */
-export declare function matchRoute(routes: readonly RouteDefinition[], pathname: string): RouteMatch | undefined;

package/dist/apps/shared/navigation/routes.js

@@ -1,37 +0,0 @@
-/** Splits a path into segments, ignoring a trailing slash: `/` and `""` have none. */
-function segmentsOf(path) {
-    return path.split("/").filter((segment) => segment !== "");
-}
-/** Matches `pathname` against one route template - `undefined` when it doesn't, or a parameter isn't valid percent-encoding. */
-function matchTemplate(template, pathname) {
-    const expected = segmentsOf(template);
-    const actual = segmentsOf(pathname);
-    if (expected.length !== actual.length) {
-        return undefined;
-    }
-    const params = {};
-    for (let i = 0; i < expected.length; i++) {
-        if (expected[i].startsWith(":")) {
-            try {
-                params[expected[i].slice(1)] = decodeURIComponent(actual[i]);
-            }
-            catch {
-                return undefined;
-            }
-        }
-        else if (expected[i] !== actual[i]) {
-            return undefined;
-        }
-    }
-    return params;
-}
-/** The first route in `routes` whose template matches `pathname`, with its parameters. */
-export function matchRoute(routes, pathname) {
-    for (const route of routes) {
-        const params = matchTemplate(route.path, pathname);
-        if (params) {
-            return { route, params };
-        }
-    }
-    return undefined;
-}

package/dist/apps/www/_routedPage.d.ts

@@ -1,12 +0,0 @@
-import { ComponentType } from "react";
-import { RoutedPageComponent } from "../shared/navigation/AppRouter.js";
-/**
- * Makes a `www` page the entry of the client-side router: the page's default export is `routedPage("/its/route", Page)`.
- * `@rapidrest/react` server-renders and hydrates exactly that component, so what it renders - the router, with the persistent
- * app frame (`AppChrome`) and `Page` inside it - is the whole client tree, and later pages replace `Page` without a page load.
- * `path` is the page's route template, the same as its entry in `_routes.ts`.
- *
- * The result carries the plain `Page` as `.page`, which is what the router shows when it loads this module for a navigation
- * (rendering the wrapped default export there would nest a second router).
- */
-export declare function routedPage<P extends object>(path: string, Page: ComponentType<P>): RoutedPageComponent<P>;

package/dist/apps/www/_routedPage.js

@@ -1,19 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import AppRouter from "../shared/navigation/AppRouter.js";
-import { wwwRoutes } from "./_routes.js";
-/**
- * Makes a `www` page the entry of the client-side router: the page's default export is `routedPage("/its/route", Page)`.
- * `@rapidrest/react` server-renders and hydrates exactly that component, so what it renders - the router, with the persistent
- * app frame (`AppChrome`) and `Page` inside it - is the whole client tree, and later pages replace `Page` without a page load.
- * `path` is the page's route template, the same as its entry in `_routes.ts`.
- *
- * The result carries the plain `Page` as `.page`, which is what the router shows when it loads this module for a navigation
- * (rendering the wrapped default export there would nest a second router).
- */
-export function routedPage(path, Page) {
-    function RoutedPage(props) {
-        return _jsx(AppRouter, { routes: wwwRoutes, initialPath: path, initialPage: Page, pageProps: props });
-    }
-    RoutedPage.page = Page;
-    return RoutedPage;
-}

package/dist/apps/www/_routes.d.ts

@@ -1,11 +0,0 @@
-import type { RouteDefinition } from "../shared/navigation/routes.js";
-/**
- * Every `apps/www` page the client-side router can show without a page load (see `apps/shared/navigation/AppRouter.tsx`), in
- * the order they are matched: literal routes before the parameterized ones that would also match them. Each page loads with a
- * dynamic `import()`, which is what makes it a chunk of its own - only the page a document was rendered for is in its first
- * JavaScript. Keep it in step with the files under `apps/www`; a page missing from here still works, it is just reached with a
- * page load. (The file starts with `_` so `@rapidrest/react` doesn't treat it as a page.)
- *
- * The four app-rail pages are `idlePrefetch`ed: downloaded when the browser is idle after the first page has loaded.
- */
-export declare const wwwRoutes: readonly RouteDefinition[];

package/dist/apps/www/_routes.js

@@ -1,31 +0,0 @@
-/**
- * Every `apps/www` page the client-side router can show without a page load (see `apps/shared/navigation/AppRouter.tsx`), in
- * the order they are matched: literal routes before the parameterized ones that would also match them. Each page loads with a
- * dynamic `import()`, which is what makes it a chunk of its own - only the page a document was rendered for is in its first
- * JavaScript. Keep it in step with the files under `apps/www`; a page missing from here still works, it is just reached with a
- * page load. (The file starts with `_` so `@rapidrest/react` doesn't treat it as a page.)
- *
- * The four app-rail pages are `idlePrefetch`ed: downloaded when the browser is idle after the first page has loaded.
- */
-export const wwwRoutes = [
-    { path: "/", active: "mail", load: () => import("./index.js"), idlePrefetch: true },
-    { path: "/messages/:uid", active: "mail", load: () => import("./messages/[uid].js") },
-    { path: "/calendar", active: "calendar", load: () => import("./calendar/index.js"), idlePrefetch: true },
-    { path: "/contacts", active: "contacts", load: () => import("./contacts/index.js"), idlePrefetch: true },
-    { path: "/contacts/:uid", active: "contacts", load: () => import("./contacts/[uid].js") },
-    { path: "/tasks", active: "tasks", load: () => import("./tasks/index.js"), idlePrefetch: true },
-    { path: "/settings/appearance", active: "settings", load: () => import("./settings/appearance/index.js") },
-    { path: "/settings/auto-reply", active: "settings", load: () => import("./settings/auto-reply/index.js") },
-    { path: "/settings/encryption", active: "settings", load: () => import("./settings/encryption/index.js") },
-    { path: "/settings/filters", active: "settings", load: () => import("./settings/filters/index.js") },
-    { path: "/settings/filters/new", active: "settings", load: () => import("./settings/filters/new/index.js") },
-    { path: "/settings/filters/:uid", active: "settings", load: () => import("./settings/filters/[uid].js") },
-    { path: "/settings/labels", active: "settings", load: () => import("./settings/labels/index.js") },
-    { path: "/settings/privacy", active: "settings", load: () => import("./settings/privacy/index.js") },
-    { path: "/settings/profile", active: "settings", load: () => import("./settings/profile/index.js") },
-    { path: "/settings/read-receipts", active: "settings", load: () => import("./settings/read-receipts/index.js") },
-    { path: "/settings/sharing", active: "settings", load: () => import("./settings/sharing/index.js") },
-    { path: "/settings/signatures", active: "settings", load: () => import("./settings/signatures/index.js") },
-    { path: "/settings/signatures/new", active: "settings", load: () => import("./settings/signatures/new/index.js") },
-    { path: "/settings/signatures/:uid", active: "settings", load: () => import("./settings/signatures/[uid].js") },
-];